Skip to main content

Update a contract

PUT 
/contracts/:contract_id

Updates a contract

Request​

Path Parameters

    contract_id stringrequired

    Contract ID

Body

required

Contract data

    agent_id string

    Unique identifier for the agent

    applicant

    object

    oneOf

    additional_details object

    Additional details that do not have a specific field to store it.

    address

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    city string

    City name

    country string

    Country name

    floor string

    Floor number

    postal_code string

    Postal code

    province string

    Province

    state string

    State

    street

    object

    name string
    number string
    type string
    birth_date date-time

    Person's date of birth

    contact

    object

    emails

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • phone_numbers

    object[]

  • Array [

    • area_code string

    Country phone number prefix

    type string

    Phone number type

    value string

    Phone number

  • ]

    • social_media

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • documents

    object[]

    Array of identification documents

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • first_name string

    Person's first/given name

    language LanguageEnum (string)

    Possible values: [aar, abk, afr, aka, amh, ara, arg, asm, ava, ave, aym, aze, bak, bam, bel, ben, bih, bis, bod, bos, bre, bul, cat, ces, cha, che, chu, chv, cor, cos, cre, cym, dan, deu, div, dzo, ell, eng, epo, est, eus, ewe, fao, fas, fij, fin, fra, fry, ful, gla, gle, glg, glv, grn, guj, hat, hau, heb, her, hin, hmo, hrv, hun, hye, ibo, ido, iii, iku, ile, ina, ind, isl, ita, jav, jpn, kal, kan, kas, kat, kau, kaz, khm, kik, kir, kom, kon, kor, kua, kur, lao, lat, lav, lim, lin, lit, ltz, lub, lug, mah, mal, mar, mkd, mlg, mlt, mon, mri, msa, mya, nau, nav, nbl, nde, ndo, nep, nld, nno, nob, nor, nya, oci, oji, ori, orm, oss, pan, pli, pol, por, pus, que, roh, ron, run, rus, sag, san, sin, slo, slv, sme, smo, sna, snd, som, sot, spa, srd, srp, ssw, sun, swa, swe, tam, tel, tgk, tha, tib, tir, ton, tsn, tso, tuk, tur, twi, uig, ukr, urd, uzb, ven, vie, vol, wln, wol, xho, yid, yor, zha, zul, aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, dv, dz, ee, el, en, eo, es, et, eu, fa, ff, fi, fj, fo, fr, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh, zu]

    Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes

    last_name string

    Person's last/family name

    middle_name string

    Person's middle name

    nationality CountryEnum (string)

    Possible values: [ABW, AFG, AGO, AIA, ALA, ALB, AND, ARE, ARG, ARM, ASM, ATA, ATF, ATG, AUS, AUT, AZE, BDI, BEL, BEN, BES, BFA, BGD, BGR, BHR, BHS, BIH, BLM, BLR, BLZ, BMU, BOL, BRA, BRB, BRN, BTN, BVT, BWA, CAF, CAN, CCK, CHE, CHL, CHN, CIV, CMR, COD, COG, COK, COL, COM, CPV, CRI, CUB, CUW, CXR, CYM, CYP, CZE, DEU, DJI, DMA, DNK, DOM, DZA, ECU, EGY, ERI, ESH, ESP, EST, ETH, FIN, FJI, FLK, FRA, FRO, FSM, GAB, GBR, GEO, GGY, GHA, GIB, GIN, GLP, GMB, GNB, GNQ, GRC, GRD, GRL, GTM, GUF, GUM, GUY, HKG, HMD, HND, HRV, HTI, HUN, IDN, IMN, IND, IOT, IRL, IRN, IRQ, ISL, ISR, ITA, JAM, JEY, JOR, JPN, KAZ, KEN, KGZ, KHM, KIR, KNA, KOR, KWT, LAO, LBN, LBR, LBY, LCA, LIE, LKA, LSO, LTU, LUX, LVA, MAC, MAF, MAR, MCO, MDA, MDG, MDV, MEX, MHL, MKD, MLI, MLT, MMR, MNE, MNG, MNP, MOZ, MRT, MSR, MTQ, MUS, MWI, MYS, MYT, NAM, NCL, NER, NFK, NGA, NIC, NIU, NLD, NOR, NPL, NRU, NZL, OMN, PAK, PAN, PCN, PER, PHL, PLW, PNG, POL, PRI, PRK, PRT, PRY, PSE, PYF, QAT, REU, ROU, RUS, RWA, SAU, SDN, SEN, SGP, SGS, SHN, SJM, SLB, SLE, SLV, SMR, SOM, SPM, SRB, SSD, STP, SUR, SVK, SVN, SWE, SWZ, SXM, SYC, SYR, TCA, TCD, TGO, THA, TJK, TKL, TKM, TLS, TON, TTO, TUN, TUR, TUV, TWN, TZA, UGA, UKR, UMI, URY, USA, UZB, VAT, VCT, VEN, VGB, VIR, VNM, VUT, WLF, WSM, YEM, ZAF, ZMB, ZWE, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW]

    Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes)

    sex SexEnum (string)

    Possible values: [Not known, Male, Female, Not applicable]

    Sex Enum (ISO/IEC 5218)

    title TitleEnum (string)

    Possible values: [Mr, Mrs, Sir, Miss, Not known]

    Title Enum

    artifacts

    object[]

  • Array [

    • artifact_id string

    Unique identifier for the artifact

    description string

    Detailed description of what the artifact represents

    name string

    Display name of the artifact

    type string

    Possible values: [MEDIA, PDF, LINK]

    Type of artifact - can be media file, PDF document or URL link

    value string

    The actual content/URL/file path of the artifact

  • ]

    • custom_fields object

    Additional custom fields specific to the implementation

    end_date date-time

    End date of the contract period

    external_references

    object[]

    List of external document references

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • market string

    Market identifier

    partner

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    branch string

    Branch name. Could be used to identify call-center or store that start the policy process.

    brand string

    Brand name

    client_id string

    Client id generated by bolttech

    name string

    Partner name

    payment

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    amount string

    Payment amount in decimal format

    currency_code string

    ISO 4217 currency code

    invoice_number string

    Unique invoice identifier

    locale string

    Language and region code in ISO format

    payer

    object

    oneOf

    additional_details object

    Additional details that do not have a specific field to store it.

    address

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    city string

    City name

    country string

    Country name

    floor string

    Floor number

    postal_code string

    Postal code

    province string

    Province

    state string

    State

    street

    object

    name string
    number string
    type string
    birth_date date-time

    Person's date of birth

    contact

    object

    emails

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • phone_numbers

    object[]

  • Array [

    • area_code string

    Country phone number prefix

    type string

    Phone number type

    value string

    Phone number

  • ]

    • social_media

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • documents

    object[]

    Array of identification documents

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • first_name string

    Person's first/given name

    language LanguageEnum (string)

    Possible values: [aar, abk, afr, aka, amh, ara, arg, asm, ava, ave, aym, aze, bak, bam, bel, ben, bih, bis, bod, bos, bre, bul, cat, ces, cha, che, chu, chv, cor, cos, cre, cym, dan, deu, div, dzo, ell, eng, epo, est, eus, ewe, fao, fas, fij, fin, fra, fry, ful, gla, gle, glg, glv, grn, guj, hat, hau, heb, her, hin, hmo, hrv, hun, hye, ibo, ido, iii, iku, ile, ina, ind, isl, ita, jav, jpn, kal, kan, kas, kat, kau, kaz, khm, kik, kir, kom, kon, kor, kua, kur, lao, lat, lav, lim, lin, lit, ltz, lub, lug, mah, mal, mar, mkd, mlg, mlt, mon, mri, msa, mya, nau, nav, nbl, nde, ndo, nep, nld, nno, nob, nor, nya, oci, oji, ori, orm, oss, pan, pli, pol, por, pus, que, roh, ron, run, rus, sag, san, sin, slo, slv, sme, smo, sna, snd, som, sot, spa, srd, srp, ssw, sun, swa, swe, tam, tel, tgk, tha, tib, tir, ton, tsn, tso, tuk, tur, twi, uig, ukr, urd, uzb, ven, vie, vol, wln, wol, xho, yid, yor, zha, zul, aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, dv, dz, ee, el, en, eo, es, et, eu, fa, ff, fi, fj, fo, fr, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh, zu]

    Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes

    last_name string

    Person's last/family name

    middle_name string

    Person's middle name

    nationality CountryEnum (string)

    Possible values: [ABW, AFG, AGO, AIA, ALA, ALB, AND, ARE, ARG, ARM, ASM, ATA, ATF, ATG, AUS, AUT, AZE, BDI, BEL, BEN, BES, BFA, BGD, BGR, BHR, BHS, BIH, BLM, BLR, BLZ, BMU, BOL, BRA, BRB, BRN, BTN, BVT, BWA, CAF, CAN, CCK, CHE, CHL, CHN, CIV, CMR, COD, COG, COK, COL, COM, CPV, CRI, CUB, CUW, CXR, CYM, CYP, CZE, DEU, DJI, DMA, DNK, DOM, DZA, ECU, EGY, ERI, ESH, ESP, EST, ETH, FIN, FJI, FLK, FRA, FRO, FSM, GAB, GBR, GEO, GGY, GHA, GIB, GIN, GLP, GMB, GNB, GNQ, GRC, GRD, GRL, GTM, GUF, GUM, GUY, HKG, HMD, HND, HRV, HTI, HUN, IDN, IMN, IND, IOT, IRL, IRN, IRQ, ISL, ISR, ITA, JAM, JEY, JOR, JPN, KAZ, KEN, KGZ, KHM, KIR, KNA, KOR, KWT, LAO, LBN, LBR, LBY, LCA, LIE, LKA, LSO, LTU, LUX, LVA, MAC, MAF, MAR, MCO, MDA, MDG, MDV, MEX, MHL, MKD, MLI, MLT, MMR, MNE, MNG, MNP, MOZ, MRT, MSR, MTQ, MUS, MWI, MYS, MYT, NAM, NCL, NER, NFK, NGA, NIC, NIU, NLD, NOR, NPL, NRU, NZL, OMN, PAK, PAN, PCN, PER, PHL, PLW, PNG, POL, PRI, PRK, PRT, PRY, PSE, PYF, QAT, REU, ROU, RUS, RWA, SAU, SDN, SEN, SGP, SGS, SHN, SJM, SLB, SLE, SLV, SMR, SOM, SPM, SRB, SSD, STP, SUR, SVK, SVN, SWE, SWZ, SXM, SYC, SYR, TCA, TCD, TGO, THA, TJK, TKL, TKM, TLS, TON, TTO, TUN, TUR, TUV, TWN, TZA, UGA, UKR, UMI, URY, USA, UZB, VAT, VCT, VEN, VGB, VIR, VNM, VUT, WLF, WSM, YEM, ZAF, ZMB, ZWE, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW]

    Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes)

    sex SexEnum (string)

    Possible values: [Not known, Male, Female, Not applicable]

    Sex Enum (ISO/IEC 5218)

    title TitleEnum (string)

    Possible values: [Mr, Mrs, Sir, Miss, Not known]

    Title Enum

    payment_account string

    Account identifier used for payment

    payment_id string

    Unique payment identifier

    payment_method string

    Method used for payment (credit card, bank transfer, etc)

    product_name string

    Name of the product being paid for

    recurrence RecurrenceEnum (string)

    Possible values: [Annual, Bimonthly, Daily, Extraordinary, Four Monthly, Monthly, One Time, Quarterly, Semiannual, Weekly]

    Recurrence Enum

    recurring_id string

    Identifier for recurring payment series

    scope_id uuid

    Identifier linking payment to business context

    status string

    Current status of the payment

    source string

    Possible values: [b2b, b2b2c, b2c, d2c]

    Business model source of the contract

    start_date date-time

    utms

    object

    campaign string

    The name of the specific marketing campaign

    content string

    Used to differentiate ads or links that point to the same URL

    medium string

    The marketing medium used (e.g. cpc, banner, email)

    source string

    The referrer source (e.g. google, newsletter)

    term string

    Identifies paid search keywords

    transaction string

    Unique identifier for the marketing transaction

    policies

    object[]

  • Array [

    • cancellation

    object

    details string
    reason ReasonEnum (string)

    Possible values: [Cancellation Agreement, Claim, Error, Lack Of Documentation, Loss Experience, Non Payment, Reason Not Available, Replacement, Risk Termination, Transfer, None Of The Above]

    Cancellation reason

    dates

    object

    current_effective date-time
    expiration date-time
    initial_effective date-time
    issue_date date-time
    situation_date date-time

    insured

    object[]

  • Array [

    • additional_details object

    Additional details that do not have a specific field to store it.

    beneficiary

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    address

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    city string

    City name

    country string

    Country name

    floor string

    Floor number

    postal_code string

    Postal code

    province string

    Province

    state string

    State

    street

    object

    name string
    number string
    type string
    birth_date date-time

    Person's date of birth

    contact

    object

    emails

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • phone_numbers

    object[]

  • Array [

    • area_code string

    Country phone number prefix

    type string

    Phone number type

    value string

    Phone number

  • ]

    • social_media

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • documents

    object[]

    Array of identification documents

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • first_name string

    Person's first/given name

    language LanguageEnum (string)

    Possible values: [aar, abk, afr, aka, amh, ara, arg, asm, ava, ave, aym, aze, bak, bam, bel, ben, bih, bis, bod, bos, bre, bul, cat, ces, cha, che, chu, chv, cor, cos, cre, cym, dan, deu, div, dzo, ell, eng, epo, est, eus, ewe, fao, fas, fij, fin, fra, fry, ful, gla, gle, glg, glv, grn, guj, hat, hau, heb, her, hin, hmo, hrv, hun, hye, ibo, ido, iii, iku, ile, ina, ind, isl, ita, jav, jpn, kal, kan, kas, kat, kau, kaz, khm, kik, kir, kom, kon, kor, kua, kur, lao, lat, lav, lim, lin, lit, ltz, lub, lug, mah, mal, mar, mkd, mlg, mlt, mon, mri, msa, mya, nau, nav, nbl, nde, ndo, nep, nld, nno, nob, nor, nya, oci, oji, ori, orm, oss, pan, pli, pol, por, pus, que, roh, ron, run, rus, sag, san, sin, slo, slv, sme, smo, sna, snd, som, sot, spa, srd, srp, ssw, sun, swa, swe, tam, tel, tgk, tha, tib, tir, ton, tsn, tso, tuk, tur, twi, uig, ukr, urd, uzb, ven, vie, vol, wln, wol, xho, yid, yor, zha, zul, aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, dv, dz, ee, el, en, eo, es, et, eu, fa, ff, fi, fj, fo, fr, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh, zu]

    Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes

    last_name string

    Person's last/family name

    middle_name string

    Person's middle name

    nationality CountryEnum (string)

    Possible values: [ABW, AFG, AGO, AIA, ALA, ALB, AND, ARE, ARG, ARM, ASM, ATA, ATF, ATG, AUS, AUT, AZE, BDI, BEL, BEN, BES, BFA, BGD, BGR, BHR, BHS, BIH, BLM, BLR, BLZ, BMU, BOL, BRA, BRB, BRN, BTN, BVT, BWA, CAF, CAN, CCK, CHE, CHL, CHN, CIV, CMR, COD, COG, COK, COL, COM, CPV, CRI, CUB, CUW, CXR, CYM, CYP, CZE, DEU, DJI, DMA, DNK, DOM, DZA, ECU, EGY, ERI, ESH, ESP, EST, ETH, FIN, FJI, FLK, FRA, FRO, FSM, GAB, GBR, GEO, GGY, GHA, GIB, GIN, GLP, GMB, GNB, GNQ, GRC, GRD, GRL, GTM, GUF, GUM, GUY, HKG, HMD, HND, HRV, HTI, HUN, IDN, IMN, IND, IOT, IRL, IRN, IRQ, ISL, ISR, ITA, JAM, JEY, JOR, JPN, KAZ, KEN, KGZ, KHM, KIR, KNA, KOR, KWT, LAO, LBN, LBR, LBY, LCA, LIE, LKA, LSO, LTU, LUX, LVA, MAC, MAF, MAR, MCO, MDA, MDG, MDV, MEX, MHL, MKD, MLI, MLT, MMR, MNE, MNG, MNP, MOZ, MRT, MSR, MTQ, MUS, MWI, MYS, MYT, NAM, NCL, NER, NFK, NGA, NIC, NIU, NLD, NOR, NPL, NRU, NZL, OMN, PAK, PAN, PCN, PER, PHL, PLW, PNG, POL, PRI, PRK, PRT, PRY, PSE, PYF, QAT, REU, ROU, RUS, RWA, SAU, SDN, SEN, SGP, SGS, SHN, SJM, SLB, SLE, SLV, SMR, SOM, SPM, SRB, SSD, STP, SUR, SVK, SVN, SWE, SWZ, SXM, SYC, SYR, TCA, TCD, TGO, THA, TJK, TKL, TKM, TLS, TON, TTO, TUN, TUR, TUV, TWN, TZA, UGA, UKR, UMI, URY, USA, UZB, VAT, VCT, VEN, VGB, VIR, VNM, VUT, WLF, WSM, YEM, ZAF, ZMB, ZWE, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW]

    Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes)

    sex SexEnum (string)

    Possible values: [Not known, Male, Female, Not applicable]

    Sex Enum (ISO/IEC 5218)

    title TitleEnum (string)

    Possible values: [Mr, Mrs, Sir, Miss, Not known]

    Title Enum

    relationship string

    Relationship to the applicant

    info

    object

    oneOf

    drivers

    object[]

  • Array [

    • class DriverClassEnum (string)

    Possible values: [Usual, Occasional]

    Driver class enum

    info

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    address

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    city string

    City name

    country string

    Country name

    floor string

    Floor number

    postal_code string

    Postal code

    province string

    Province

    state string

    State

    street

    object

    name string
    number string
    type string
    birth_date date-time

    Person's date of birth

    contact

    object

    emails

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • phone_numbers

    object[]

  • Array [

    • area_code string

    Country phone number prefix

    type string

    Phone number type

    value string

    Phone number

  • ]

    • social_media

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • documents

    object[]

    Array of identification documents

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • first_name string

    Person's first/given name

    language LanguageEnum (string)

    Possible values: [aar, abk, afr, aka, amh, ara, arg, asm, ava, ave, aym, aze, bak, bam, bel, ben, bih, bis, bod, bos, bre, bul, cat, ces, cha, che, chu, chv, cor, cos, cre, cym, dan, deu, div, dzo, ell, eng, epo, est, eus, ewe, fao, fas, fij, fin, fra, fry, ful, gla, gle, glg, glv, grn, guj, hat, hau, heb, her, hin, hmo, hrv, hun, hye, ibo, ido, iii, iku, ile, ina, ind, isl, ita, jav, jpn, kal, kan, kas, kat, kau, kaz, khm, kik, kir, kom, kon, kor, kua, kur, lao, lat, lav, lim, lin, lit, ltz, lub, lug, mah, mal, mar, mkd, mlg, mlt, mon, mri, msa, mya, nau, nav, nbl, nde, ndo, nep, nld, nno, nob, nor, nya, oci, oji, ori, orm, oss, pan, pli, pol, por, pus, que, roh, ron, run, rus, sag, san, sin, slo, slv, sme, smo, sna, snd, som, sot, spa, srd, srp, ssw, sun, swa, swe, tam, tel, tgk, tha, tib, tir, ton, tsn, tso, tuk, tur, twi, uig, ukr, urd, uzb, ven, vie, vol, wln, wol, xho, yid, yor, zha, zul, aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, dv, dz, ee, el, en, eo, es, et, eu, fa, ff, fi, fj, fo, fr, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh, zu]

    Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes

    last_name string

    Person's last/family name

    middle_name string

    Person's middle name

    nationality CountryEnum (string)

    Possible values: [ABW, AFG, AGO, AIA, ALA, ALB, AND, ARE, ARG, ARM, ASM, ATA, ATF, ATG, AUS, AUT, AZE, BDI, BEL, BEN, BES, BFA, BGD, BGR, BHR, BHS, BIH, BLM, BLR, BLZ, BMU, BOL, BRA, BRB, BRN, BTN, BVT, BWA, CAF, CAN, CCK, CHE, CHL, CHN, CIV, CMR, COD, COG, COK, COL, COM, CPV, CRI, CUB, CUW, CXR, CYM, CYP, CZE, DEU, DJI, DMA, DNK, DOM, DZA, ECU, EGY, ERI, ESH, ESP, EST, ETH, FIN, FJI, FLK, FRA, FRO, FSM, GAB, GBR, GEO, GGY, GHA, GIB, GIN, GLP, GMB, GNB, GNQ, GRC, GRD, GRL, GTM, GUF, GUM, GUY, HKG, HMD, HND, HRV, HTI, HUN, IDN, IMN, IND, IOT, IRL, IRN, IRQ, ISL, ISR, ITA, JAM, JEY, JOR, JPN, KAZ, KEN, KGZ, KHM, KIR, KNA, KOR, KWT, LAO, LBN, LBR, LBY, LCA, LIE, LKA, LSO, LTU, LUX, LVA, MAC, MAF, MAR, MCO, MDA, MDG, MDV, MEX, MHL, MKD, MLI, MLT, MMR, MNE, MNG, MNP, MOZ, MRT, MSR, MTQ, MUS, MWI, MYS, MYT, NAM, NCL, NER, NFK, NGA, NIC, NIU, NLD, NOR, NPL, NRU, NZL, OMN, PAK, PAN, PCN, PER, PHL, PLW, PNG, POL, PRI, PRK, PRT, PRY, PSE, PYF, QAT, REU, ROU, RUS, RWA, SAU, SDN, SEN, SGP, SGS, SHN, SJM, SLB, SLE, SLV, SMR, SOM, SPM, SRB, SSD, STP, SUR, SVK, SVN, SWE, SWZ, SXM, SYC, SYR, TCA, TCD, TGO, THA, TJK, TKL, TKM, TLS, TON, TTO, TUN, TUR, TUV, TWN, TZA, UGA, UKR, UMI, URY, USA, UZB, VAT, VCT, VEN, VGB, VIR, VNM, VUT, WLF, WSM, YEM, ZAF, ZMB, ZWE, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW]

    Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes)

    sex SexEnum (string)

    Possible values: [Not known, Male, Female, Not applicable]

    Sex Enum (ISO/IEC 5218)

    title TitleEnum (string)

    Possible values: [Mr, Mrs, Sir, Miss, Not known]

    Title Enum

    license_date date-time

    Date when the driver's license was issued

    license_type LicenseTypeEnum (string)[]

    Possible values: [AM, A1, A2, A, B, BTP, BE, C1, C1E, C, CE, D1, D1E, D, DE]

    Types of vehicles the driver is licensed to operate

  • ]

    • owner

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    address

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    city string

    City name

    country string

    Country name

    floor string

    Floor number

    postal_code string

    Postal code

    province string

    Province

    state string

    State

    street

    object

    name string
    number string
    type string
    birth_date date-time

    Person's date of birth

    contact

    object

    emails

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • phone_numbers

    object[]

  • Array [

    • area_code string

    Country phone number prefix

    type string

    Phone number type

    value string

    Phone number

  • ]

    • social_media

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • documents

    object[]

    Array of identification documents

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • first_name string

    Person's first/given name

    language LanguageEnum (string)

    Possible values: [aar, abk, afr, aka, amh, ara, arg, asm, ava, ave, aym, aze, bak, bam, bel, ben, bih, bis, bod, bos, bre, bul, cat, ces, cha, che, chu, chv, cor, cos, cre, cym, dan, deu, div, dzo, ell, eng, epo, est, eus, ewe, fao, fas, fij, fin, fra, fry, ful, gla, gle, glg, glv, grn, guj, hat, hau, heb, her, hin, hmo, hrv, hun, hye, ibo, ido, iii, iku, ile, ina, ind, isl, ita, jav, jpn, kal, kan, kas, kat, kau, kaz, khm, kik, kir, kom, kon, kor, kua, kur, lao, lat, lav, lim, lin, lit, ltz, lub, lug, mah, mal, mar, mkd, mlg, mlt, mon, mri, msa, mya, nau, nav, nbl, nde, ndo, nep, nld, nno, nob, nor, nya, oci, oji, ori, orm, oss, pan, pli, pol, por, pus, que, roh, ron, run, rus, sag, san, sin, slo, slv, sme, smo, sna, snd, som, sot, spa, srd, srp, ssw, sun, swa, swe, tam, tel, tgk, tha, tib, tir, ton, tsn, tso, tuk, tur, twi, uig, ukr, urd, uzb, ven, vie, vol, wln, wol, xho, yid, yor, zha, zul, aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, dv, dz, ee, el, en, eo, es, et, eu, fa, ff, fi, fj, fo, fr, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh, zu]

    Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes

    last_name string

    Person's last/family name

    middle_name string

    Person's middle name

    nationality CountryEnum (string)

    Possible values: [ABW, AFG, AGO, AIA, ALA, ALB, AND, ARE, ARG, ARM, ASM, ATA, ATF, ATG, AUS, AUT, AZE, BDI, BEL, BEN, BES, BFA, BGD, BGR, BHR, BHS, BIH, BLM, BLR, BLZ, BMU, BOL, BRA, BRB, BRN, BTN, BVT, BWA, CAF, CAN, CCK, CHE, CHL, CHN, CIV, CMR, COD, COG, COK, COL, COM, CPV, CRI, CUB, CUW, CXR, CYM, CYP, CZE, DEU, DJI, DMA, DNK, DOM, DZA, ECU, EGY, ERI, ESH, ESP, EST, ETH, FIN, FJI, FLK, FRA, FRO, FSM, GAB, GBR, GEO, GGY, GHA, GIB, GIN, GLP, GMB, GNB, GNQ, GRC, GRD, GRL, GTM, GUF, GUM, GUY, HKG, HMD, HND, HRV, HTI, HUN, IDN, IMN, IND, IOT, IRL, IRN, IRQ, ISL, ISR, ITA, JAM, JEY, JOR, JPN, KAZ, KEN, KGZ, KHM, KIR, KNA, KOR, KWT, LAO, LBN, LBR, LBY, LCA, LIE, LKA, LSO, LTU, LUX, LVA, MAC, MAF, MAR, MCO, MDA, MDG, MDV, MEX, MHL, MKD, MLI, MLT, MMR, MNE, MNG, MNP, MOZ, MRT, MSR, MTQ, MUS, MWI, MYS, MYT, NAM, NCL, NER, NFK, NGA, NIC, NIU, NLD, NOR, NPL, NRU, NZL, OMN, PAK, PAN, PCN, PER, PHL, PLW, PNG, POL, PRI, PRK, PRT, PRY, PSE, PYF, QAT, REU, ROU, RUS, RWA, SAU, SDN, SEN, SGP, SGS, SHN, SJM, SLB, SLE, SLV, SMR, SOM, SPM, SRB, SSD, STP, SUR, SVK, SVN, SWE, SWZ, SXM, SYC, SYR, TCA, TCD, TGO, THA, TJK, TKL, TKM, TLS, TON, TTO, TUN, TUR, TUV, TWN, TZA, UGA, UKR, UMI, URY, USA, UZB, VAT, VCT, VEN, VGB, VIR, VNM, VUT, WLF, WSM, YEM, ZAF, ZMB, ZWE, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW]

    Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes)

    sex SexEnum (string)

    Possible values: [Not known, Male, Female, Not applicable]

    Sex Enum (ISO/IEC 5218)

    title TitleEnum (string)

    Possible values: [Mr, Mrs, Sir, Miss, Not known]

    Title Enum

    vehicle

    object

    accessories

    object[]

  • Array [

    • description string

    Description of the vehicle accessory or add-on feature

    value float

    Cost or value of the accessory in base currency

  • ]

    • additional_details object

    Additional details that do not have a specific field to store it.

    brand string

    The manufacturer brand name of the vehicle

    category VehicleCategoryEnum (string)

    Possible values: [CA, MO, TU]

    Vehicle category enum

    class VehicleClassEnum (string)

    Possible values: [Bus, Car, Motorcycle, Other, Quad, Tractor, Truck, Van]

    Vehicle class enum

    color string

    The exterior color of the vehicle

    cylinder_capacity string

    The engine cylinder capacity in cc

    description string

    General description of the vehicle

    displacement number

    Engine displacement in liters

    doors number

    Number of doors on the vehicle

    fuel string

    Type of fuel used by the vehicle

    horsepower number

    Engine power measured in horsepower

    length number

    Vehicle length in meters

    model string

    The specific model name of the vehicle

    price number

    The price of the vehicle in base currency

    registration string

    Vehicle registration/license plate number

    registration_date date-time

    Date when the vehicle was first registered

    seats integer

    Number of seats in the vehicle

    transmission string

    Type of transmission system

    use VehicleUseEnum (string)

    Possible values: [AL, CL, EM, OS, PA, SP, NI]

    Vehicle use enum

    version string

    Specific version or trim level of the model

    weight number

    Vehicle weight in kilograms

    year integer

    Manufacturing year of the vehicle

    questionnaire

    object

    answer string

    User's response to the question

    answer_code string

    Unique code identifying the answer

    answer_type string

    Type of answer expected (e.g. text, boolean, number)

    description string

    Additional details about the question

    param_code string

    Parameter code used for internal processing

    question string

    The actual question text presented to the user

    sub_answer array
    type InsuredTypeEnum (string)

    Possible values: [car, property, person, company, device, cyber, health, travel, pet]

    Insured type enum

  • ]

    • movements

    object[]

  • Array [

    • date date-time

    dates

    object

    current_effective date-time
    expiration date-time
    initial_effective date-time
    issue_date date-time
    situation_date date-time
    description string
    details string
    movement_id string
    order string
    situation SituationMovementEnum (string)

    Possible values: [Pending, Accepted, Rejected]

    Situation movement enum

    type MovementTypeEnum (string)

    Possible values: [Cancellation of chargeback, Cancellation, Billing, Refund, Refund Settlement, Issuance, Chargeback payment, Settlement, Risk Addition, Risk Removal, Insured Beneficiary Change, Coverage Change, Risk Change, Policyholder Change, Capital Reduction, Coverage Reduction, Effective Date Entry, Decennial Policy Coverage Entry, Capital Increase, Coverage Increase, Temporary Policy Coverage Extension, Regularization, Rehabilitation, Negotiable Policy Renewal, None Of The Above, Payment Method Change]

    Movement type enum

  • ]

    • period PolicyPeriodEnum (string)

    Possible values: [Decennial, Negotiable, Renewable, Temporary, Temporary With Extension, One Time, Duration Not Available]

    Policy period enum

    policy_id string

    price

    object

    amount float

    commission

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    apply_over_taxes boolean
    commission_value float
    description string
    type string

    Possible values: [FIXED, PERCENTAGE]

    value string
    rate number

    Tax rate

    currency_code CurrencyCodeEnum (string)

    Possible values: [AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW]

    Currency codes Enum

    discount

    object[]

  • Array [

    • additional_details object

    Additional details that do not have a specific field to store it.

    apply_over_taxes boolean
    commission_value float
    description string
    type string

    Possible values: [FIXED, PERCENTAGE]

    value string
    rate number

    Tax rate

  • ]

    • premium

    object

    net float
    total float

    taxes

    object[]

  • Array [

    • description string

    Human readable description of the tax

    type string

    Type/category of the tax being applied

    value float

    Numeric value of the amount

    rate number

    Tax rate

  • ]

    • product

    object

    internal_id string

    Unique internal identifier for the product

    internal_products array
    metadata object

    Additional metadata associated with the product

    name string

    Name of the product

    price

    object

    amount float

    commission

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    apply_over_taxes boolean
    commission_value float
    description string
    type string

    Possible values: [FIXED, PERCENTAGE]

    value string
    rate number

    Tax rate

    currency_code CurrencyCodeEnum (string)

    Possible values: [AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW]

    Currency codes Enum

    discount

    object[]

  • Array [

    • additional_details object

    Additional details that do not have a specific field to store it.

    apply_over_taxes boolean
    commission_value float
    description string
    type string

    Possible values: [FIXED, PERCENTAGE]

    value string
    rate number

    Tax rate

  • ]

    • premium

    object

    net float
    total float

    taxes

    object[]

  • Array [

    • description string

    Human readable description of the tax

    type string

    Type/category of the tax being applied

    value float

    Numeric value of the amount

    rate number

    Tax rate

  • ]

    • product_id string

    General product identifier

    product_package string

    Package identifier that the product belongs to

    provider string

    Provider identifier for the product

    score number

    Product rating or score value

    provider string
    status StatusPolicyEnum (string)

    Possible values: [Active, Canceled, Draft, Error, Expired, Pending, Reconnect, Suspended, Terminated, Withdraw]

    Status policy enum

    type PolicyTypeEnum (string)

    Possible values: [Cancellation, Collective Policy Pre Portfolio, Draft, New Production, Portfolio, Supplement]

    Policy type enum

    valid_from date-time
    valid_until date-time

  • ]

    • status StatusContractEnum (string)

    Possible values: [Canceled, Draft, Expired, Finished, In_progress, Pending, Suspended]

    Contract status Enum

Responses​

Successful operation

Schema

    agent_id string

    Unique identifier for the agent

    applicant

    object

    oneOf

    additional_details object

    Additional details that do not have a specific field to store it.

    address

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    city string

    City name

    country string

    Country name

    floor string

    Floor number

    postal_code string

    Postal code

    province string

    Province

    state string

    State

    street

    object

    name string
    number string
    type string
    birth_date date-time

    Person's date of birth

    contact

    object

    emails

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • phone_numbers

    object[]

  • Array [

    • area_code string

    Country phone number prefix

    type string

    Phone number type

    value string

    Phone number

  • ]

    • social_media

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • customer_id string

    Unique identifier for the customer

    documents

    object[]

    Array of identification documents

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • first_name string

    Person's first/given name

    language LanguageEnum (string)

    Possible values: [aar, abk, afr, aka, amh, ara, arg, asm, ava, ave, aym, aze, bak, bam, bel, ben, bih, bis, bod, bos, bre, bul, cat, ces, cha, che, chu, chv, cor, cos, cre, cym, dan, deu, div, dzo, ell, eng, epo, est, eus, ewe, fao, fas, fij, fin, fra, fry, ful, gla, gle, glg, glv, grn, guj, hat, hau, heb, her, hin, hmo, hrv, hun, hye, ibo, ido, iii, iku, ile, ina, ind, isl, ita, jav, jpn, kal, kan, kas, kat, kau, kaz, khm, kik, kir, kom, kon, kor, kua, kur, lao, lat, lav, lim, lin, lit, ltz, lub, lug, mah, mal, mar, mkd, mlg, mlt, mon, mri, msa, mya, nau, nav, nbl, nde, ndo, nep, nld, nno, nob, nor, nya, oci, oji, ori, orm, oss, pan, pli, pol, por, pus, que, roh, ron, run, rus, sag, san, sin, slo, slv, sme, smo, sna, snd, som, sot, spa, srd, srp, ssw, sun, swa, swe, tam, tel, tgk, tha, tib, tir, ton, tsn, tso, tuk, tur, twi, uig, ukr, urd, uzb, ven, vie, vol, wln, wol, xho, yid, yor, zha, zul, aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, dv, dz, ee, el, en, eo, es, et, eu, fa, ff, fi, fj, fo, fr, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh, zu]

    Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes

    last_name string

    Person's last/family name

    middle_name string

    Person's middle name

    nationality CountryEnum (string)

    Possible values: [ABW, AFG, AGO, AIA, ALA, ALB, AND, ARE, ARG, ARM, ASM, ATA, ATF, ATG, AUS, AUT, AZE, BDI, BEL, BEN, BES, BFA, BGD, BGR, BHR, BHS, BIH, BLM, BLR, BLZ, BMU, BOL, BRA, BRB, BRN, BTN, BVT, BWA, CAF, CAN, CCK, CHE, CHL, CHN, CIV, CMR, COD, COG, COK, COL, COM, CPV, CRI, CUB, CUW, CXR, CYM, CYP, CZE, DEU, DJI, DMA, DNK, DOM, DZA, ECU, EGY, ERI, ESH, ESP, EST, ETH, FIN, FJI, FLK, FRA, FRO, FSM, GAB, GBR, GEO, GGY, GHA, GIB, GIN, GLP, GMB, GNB, GNQ, GRC, GRD, GRL, GTM, GUF, GUM, GUY, HKG, HMD, HND, HRV, HTI, HUN, IDN, IMN, IND, IOT, IRL, IRN, IRQ, ISL, ISR, ITA, JAM, JEY, JOR, JPN, KAZ, KEN, KGZ, KHM, KIR, KNA, KOR, KWT, LAO, LBN, LBR, LBY, LCA, LIE, LKA, LSO, LTU, LUX, LVA, MAC, MAF, MAR, MCO, MDA, MDG, MDV, MEX, MHL, MKD, MLI, MLT, MMR, MNE, MNG, MNP, MOZ, MRT, MSR, MTQ, MUS, MWI, MYS, MYT, NAM, NCL, NER, NFK, NGA, NIC, NIU, NLD, NOR, NPL, NRU, NZL, OMN, PAK, PAN, PCN, PER, PHL, PLW, PNG, POL, PRI, PRK, PRT, PRY, PSE, PYF, QAT, REU, ROU, RUS, RWA, SAU, SDN, SEN, SGP, SGS, SHN, SJM, SLB, SLE, SLV, SMR, SOM, SPM, SRB, SSD, STP, SUR, SVK, SVN, SWE, SWZ, SXM, SYC, SYR, TCA, TCD, TGO, THA, TJK, TKL, TKM, TLS, TON, TTO, TUN, TUR, TUV, TWN, TZA, UGA, UKR, UMI, URY, USA, UZB, VAT, VCT, VEN, VGB, VIR, VNM, VUT, WLF, WSM, YEM, ZAF, ZMB, ZWE, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW]

    Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes)

    sex SexEnum (string)

    Possible values: [Not known, Male, Female, Not applicable]

    Sex Enum (ISO/IEC 5218)

    title TitleEnum (string)

    Possible values: [Mr, Mrs, Sir, Miss, Not known]

    Title Enum

    user_id string

    Unique system identifier for the user

    artifacts

    object[]

  • Array [

    • artifact_id string

    Unique identifier for the artifact

    description string

    Detailed description of what the artifact represents

    name string

    Display name of the artifact

    type string

    Possible values: [MEDIA, PDF, LINK]

    Type of artifact - can be media file, PDF document or URL link

    value string

    The actual content/URL/file path of the artifact

  • ]

    • consentments

    object[]

    List of consent records given by the applicant, synced with external validation entity, for example OneTrust.

  • Array [

    • name string
    receipt string
    status string

    Possible values: [confirmed, withdrawn, notgiven]

  • ]

    • created_at date-time

    Timestamp when the record was created

    custom_fields object

    Additional custom fields specific to the implementation

    deleted_at date-time

    Timestamp when the record was deleted (if applicable)

    end_date date-time

    End date of the contract period

    end_flow_source string

    Source system where the flow ended

    external_references

    object[]

    List of external document references

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • final_price

    object

    Final calculated price details

    amount float

    commission

    object

    currency_value CurrencyCodeEnum (string)

    Possible values: [AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW]

    Currency codes Enum

    description string
    of_type string
    value float

    discount

    object[]

  • Array [

    • currency_value CurrencyCodeEnum (string)

    Possible values: [AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW]

    Currency codes Enum

    description string
    of_type string
    value float

  • ]

    • premium

    object

    net float
    total float

    taxes

    object[]

  • Array [

    • currency_value CurrencyCodeEnum (string)

    Possible values: [AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW]

    Currency codes Enum

    description string
    of_type string
    value float

  • ]

    • vouchers_applied string[]

    logs

    object

    contract_id string
    level string
    message string
    metadata object
    policy_id string
    sale_id string
    timestamp date-time
    market string

    Market identifier

    partner

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    branch string

    Branch name. Could be used to identify call-center or store that start the policy process.

    brand string

    Brand name

    client_id string

    Client id generated by bolttech

    name string

    Partner name

    partner_id string

    Partner id generated by bolttech

    payment

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    amount string

    Payment amount in decimal format

    currency_code string

    ISO 4217 currency code

    invoice_number string

    Unique invoice identifier

    locale string

    Language and region code in ISO format

    payer

    object

    oneOf

    additional_details object

    Additional details that do not have a specific field to store it.

    address

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    city string

    City name

    country string

    Country name

    floor string

    Floor number

    postal_code string

    Postal code

    province string

    Province

    state string

    State

    street

    object

    name string
    number string
    type string
    birth_date date-time

    Person's date of birth

    contact

    object

    emails

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • phone_numbers

    object[]

  • Array [

    • area_code string

    Country phone number prefix

    type string

    Phone number type

    value string

    Phone number

  • ]

    • social_media

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • customer_id string

    Unique identifier for the customer

    documents

    object[]

    Array of identification documents

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • first_name string

    Person's first/given name

    language LanguageEnum (string)

    Possible values: [aar, abk, afr, aka, amh, ara, arg, asm, ava, ave, aym, aze, bak, bam, bel, ben, bih, bis, bod, bos, bre, bul, cat, ces, cha, che, chu, chv, cor, cos, cre, cym, dan, deu, div, dzo, ell, eng, epo, est, eus, ewe, fao, fas, fij, fin, fra, fry, ful, gla, gle, glg, glv, grn, guj, hat, hau, heb, her, hin, hmo, hrv, hun, hye, ibo, ido, iii, iku, ile, ina, ind, isl, ita, jav, jpn, kal, kan, kas, kat, kau, kaz, khm, kik, kir, kom, kon, kor, kua, kur, lao, lat, lav, lim, lin, lit, ltz, lub, lug, mah, mal, mar, mkd, mlg, mlt, mon, mri, msa, mya, nau, nav, nbl, nde, ndo, nep, nld, nno, nob, nor, nya, oci, oji, ori, orm, oss, pan, pli, pol, por, pus, que, roh, ron, run, rus, sag, san, sin, slo, slv, sme, smo, sna, snd, som, sot, spa, srd, srp, ssw, sun, swa, swe, tam, tel, tgk, tha, tib, tir, ton, tsn, tso, tuk, tur, twi, uig, ukr, urd, uzb, ven, vie, vol, wln, wol, xho, yid, yor, zha, zul, aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, dv, dz, ee, el, en, eo, es, et, eu, fa, ff, fi, fj, fo, fr, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh, zu]

    Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes

    last_name string

    Person's last/family name

    middle_name string

    Person's middle name

    nationality CountryEnum (string)

    Possible values: [ABW, AFG, AGO, AIA, ALA, ALB, AND, ARE, ARG, ARM, ASM, ATA, ATF, ATG, AUS, AUT, AZE, BDI, BEL, BEN, BES, BFA, BGD, BGR, BHR, BHS, BIH, BLM, BLR, BLZ, BMU, BOL, BRA, BRB, BRN, BTN, BVT, BWA, CAF, CAN, CCK, CHE, CHL, CHN, CIV, CMR, COD, COG, COK, COL, COM, CPV, CRI, CUB, CUW, CXR, CYM, CYP, CZE, DEU, DJI, DMA, DNK, DOM, DZA, ECU, EGY, ERI, ESH, ESP, EST, ETH, FIN, FJI, FLK, FRA, FRO, FSM, GAB, GBR, GEO, GGY, GHA, GIB, GIN, GLP, GMB, GNB, GNQ, GRC, GRD, GRL, GTM, GUF, GUM, GUY, HKG, HMD, HND, HRV, HTI, HUN, IDN, IMN, IND, IOT, IRL, IRN, IRQ, ISL, ISR, ITA, JAM, JEY, JOR, JPN, KAZ, KEN, KGZ, KHM, KIR, KNA, KOR, KWT, LAO, LBN, LBR, LBY, LCA, LIE, LKA, LSO, LTU, LUX, LVA, MAC, MAF, MAR, MCO, MDA, MDG, MDV, MEX, MHL, MKD, MLI, MLT, MMR, MNE, MNG, MNP, MOZ, MRT, MSR, MTQ, MUS, MWI, MYS, MYT, NAM, NCL, NER, NFK, NGA, NIC, NIU, NLD, NOR, NPL, NRU, NZL, OMN, PAK, PAN, PCN, PER, PHL, PLW, PNG, POL, PRI, PRK, PRT, PRY, PSE, PYF, QAT, REU, ROU, RUS, RWA, SAU, SDN, SEN, SGP, SGS, SHN, SJM, SLB, SLE, SLV, SMR, SOM, SPM, SRB, SSD, STP, SUR, SVK, SVN, SWE, SWZ, SXM, SYC, SYR, TCA, TCD, TGO, THA, TJK, TKL, TKM, TLS, TON, TTO, TUN, TUR, TUV, TWN, TZA, UGA, UKR, UMI, URY, USA, UZB, VAT, VCT, VEN, VGB, VIR, VNM, VUT, WLF, WSM, YEM, ZAF, ZMB, ZWE, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW]

    Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes)

    sex SexEnum (string)

    Possible values: [Not known, Male, Female, Not applicable]

    Sex Enum (ISO/IEC 5218)

    title TitleEnum (string)

    Possible values: [Mr, Mrs, Sir, Miss, Not known]

    Title Enum

    user_id string

    Unique system identifier for the user

    payment_account string

    Account identifier used for payment

    payment_id string

    Unique payment identifier

    payment_method string

    Method used for payment (credit card, bank transfer, etc)

    product_name string

    Name of the product being paid for

    recurrence RecurrenceEnum (string)

    Possible values: [Annual, Bimonthly, Daily, Extraordinary, Four Monthly, Monthly, One Time, Quarterly, Semiannual, Weekly]

    Recurrence Enum

    recurring_id string

    Identifier for recurring payment series

    scope_id uuid

    Identifier linking payment to business context

    status string

    Current status of the payment

    source string

    Possible values: [b2b, b2b2c, b2c, d2c]

    Business model source of the contract

    start_date date-time
    start_flow_source string

    Source system where the flow started

    updated_at date-time

    Timestamp when the record was last updated

    utms

    object

    campaign string

    The name of the specific marketing campaign

    content string

    Used to differentiate ads or links that point to the same URL

    medium string

    The marketing medium used (e.g. cpc, banner, email)

    source string

    The referrer source (e.g. google, newsletter)

    term string

    Identifies paid search keywords

    transaction string

    Unique identifier for the marketing transaction

    contract_id string

    policies

    object[]

  • Array [

    • cancellation

    object

    canceled_at date-time
    details string
    reason ReasonEnum (string)

    Possible values: [Cancellation Agreement, Claim, Error, Lack Of Documentation, Loss Experience, Non Payment, Reason Not Available, Replacement, Risk Termination, Transfer, None Of The Above]

    Cancellation reason

    dates

    object

    current_effective date-time
    expiration date-time
    initial_effective date-time
    issue_date date-time
    situation_date date-time

    insured

    object[]

  • Array [

    • additional_details object

    Additional details that do not have a specific field to store it.

    beneficiary

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    address

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    city string

    City name

    country string

    Country name

    floor string

    Floor number

    postal_code string

    Postal code

    province string

    Province

    state string

    State

    street

    object

    name string
    number string
    type string
    birth_date date-time

    Person's date of birth

    contact

    object

    emails

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • phone_numbers

    object[]

  • Array [

    • area_code string

    Country phone number prefix

    type string

    Phone number type

    value string

    Phone number

  • ]

    • social_media

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • customer_id string

    Unique identifier for the customer

    documents

    object[]

    Array of identification documents

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • first_name string

    Person's first/given name

    language LanguageEnum (string)

    Possible values: [aar, abk, afr, aka, amh, ara, arg, asm, ava, ave, aym, aze, bak, bam, bel, ben, bih, bis, bod, bos, bre, bul, cat, ces, cha, che, chu, chv, cor, cos, cre, cym, dan, deu, div, dzo, ell, eng, epo, est, eus, ewe, fao, fas, fij, fin, fra, fry, ful, gla, gle, glg, glv, grn, guj, hat, hau, heb, her, hin, hmo, hrv, hun, hye, ibo, ido, iii, iku, ile, ina, ind, isl, ita, jav, jpn, kal, kan, kas, kat, kau, kaz, khm, kik, kir, kom, kon, kor, kua, kur, lao, lat, lav, lim, lin, lit, ltz, lub, lug, mah, mal, mar, mkd, mlg, mlt, mon, mri, msa, mya, nau, nav, nbl, nde, ndo, nep, nld, nno, nob, nor, nya, oci, oji, ori, orm, oss, pan, pli, pol, por, pus, que, roh, ron, run, rus, sag, san, sin, slo, slv, sme, smo, sna, snd, som, sot, spa, srd, srp, ssw, sun, swa, swe, tam, tel, tgk, tha, tib, tir, ton, tsn, tso, tuk, tur, twi, uig, ukr, urd, uzb, ven, vie, vol, wln, wol, xho, yid, yor, zha, zul, aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, dv, dz, ee, el, en, eo, es, et, eu, fa, ff, fi, fj, fo, fr, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh, zu]

    Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes

    last_name string

    Person's last/family name

    middle_name string

    Person's middle name

    nationality CountryEnum (string)

    Possible values: [ABW, AFG, AGO, AIA, ALA, ALB, AND, ARE, ARG, ARM, ASM, ATA, ATF, ATG, AUS, AUT, AZE, BDI, BEL, BEN, BES, BFA, BGD, BGR, BHR, BHS, BIH, BLM, BLR, BLZ, BMU, BOL, BRA, BRB, BRN, BTN, BVT, BWA, CAF, CAN, CCK, CHE, CHL, CHN, CIV, CMR, COD, COG, COK, COL, COM, CPV, CRI, CUB, CUW, CXR, CYM, CYP, CZE, DEU, DJI, DMA, DNK, DOM, DZA, ECU, EGY, ERI, ESH, ESP, EST, ETH, FIN, FJI, FLK, FRA, FRO, FSM, GAB, GBR, GEO, GGY, GHA, GIB, GIN, GLP, GMB, GNB, GNQ, GRC, GRD, GRL, GTM, GUF, GUM, GUY, HKG, HMD, HND, HRV, HTI, HUN, IDN, IMN, IND, IOT, IRL, IRN, IRQ, ISL, ISR, ITA, JAM, JEY, JOR, JPN, KAZ, KEN, KGZ, KHM, KIR, KNA, KOR, KWT, LAO, LBN, LBR, LBY, LCA, LIE, LKA, LSO, LTU, LUX, LVA, MAC, MAF, MAR, MCO, MDA, MDG, MDV, MEX, MHL, MKD, MLI, MLT, MMR, MNE, MNG, MNP, MOZ, MRT, MSR, MTQ, MUS, MWI, MYS, MYT, NAM, NCL, NER, NFK, NGA, NIC, NIU, NLD, NOR, NPL, NRU, NZL, OMN, PAK, PAN, PCN, PER, PHL, PLW, PNG, POL, PRI, PRK, PRT, PRY, PSE, PYF, QAT, REU, ROU, RUS, RWA, SAU, SDN, SEN, SGP, SGS, SHN, SJM, SLB, SLE, SLV, SMR, SOM, SPM, SRB, SSD, STP, SUR, SVK, SVN, SWE, SWZ, SXM, SYC, SYR, TCA, TCD, TGO, THA, TJK, TKL, TKM, TLS, TON, TTO, TUN, TUR, TUV, TWN, TZA, UGA, UKR, UMI, URY, USA, UZB, VAT, VCT, VEN, VGB, VIR, VNM, VUT, WLF, WSM, YEM, ZAF, ZMB, ZWE, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW]

    Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes)

    sex SexEnum (string)

    Possible values: [Not known, Male, Female, Not applicable]

    Sex Enum (ISO/IEC 5218)

    title TitleEnum (string)

    Possible values: [Mr, Mrs, Sir, Miss, Not known]

    Title Enum

    user_id string

    Unique system identifier for the user

    relationship string

    Relationship to the applicant

    info

    object

    oneOf

    drivers

    object[]

  • Array [

    • class DriverClassEnum (string)

    Possible values: [Usual, Occasional]

    Driver class enum

    info

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    address

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    city string

    City name

    country string

    Country name

    floor string

    Floor number

    postal_code string

    Postal code

    province string

    Province

    state string

    State

    street

    object

    name string
    number string
    type string
    birth_date date-time

    Person's date of birth

    contact

    object

    emails

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • phone_numbers

    object[]

  • Array [

    • area_code string

    Country phone number prefix

    type string

    Phone number type

    value string

    Phone number

  • ]

    • social_media

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • customer_id string

    Unique identifier for the customer

    documents

    object[]

    Array of identification documents

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • first_name string

    Person's first/given name

    language LanguageEnum (string)

    Possible values: [aar, abk, afr, aka, amh, ara, arg, asm, ava, ave, aym, aze, bak, bam, bel, ben, bih, bis, bod, bos, bre, bul, cat, ces, cha, che, chu, chv, cor, cos, cre, cym, dan, deu, div, dzo, ell, eng, epo, est, eus, ewe, fao, fas, fij, fin, fra, fry, ful, gla, gle, glg, glv, grn, guj, hat, hau, heb, her, hin, hmo, hrv, hun, hye, ibo, ido, iii, iku, ile, ina, ind, isl, ita, jav, jpn, kal, kan, kas, kat, kau, kaz, khm, kik, kir, kom, kon, kor, kua, kur, lao, lat, lav, lim, lin, lit, ltz, lub, lug, mah, mal, mar, mkd, mlg, mlt, mon, mri, msa, mya, nau, nav, nbl, nde, ndo, nep, nld, nno, nob, nor, nya, oci, oji, ori, orm, oss, pan, pli, pol, por, pus, que, roh, ron, run, rus, sag, san, sin, slo, slv, sme, smo, sna, snd, som, sot, spa, srd, srp, ssw, sun, swa, swe, tam, tel, tgk, tha, tib, tir, ton, tsn, tso, tuk, tur, twi, uig, ukr, urd, uzb, ven, vie, vol, wln, wol, xho, yid, yor, zha, zul, aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, dv, dz, ee, el, en, eo, es, et, eu, fa, ff, fi, fj, fo, fr, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh, zu]

    Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes

    last_name string

    Person's last/family name

    middle_name string

    Person's middle name

    nationality CountryEnum (string)

    Possible values: [ABW, AFG, AGO, AIA, ALA, ALB, AND, ARE, ARG, ARM, ASM, ATA, ATF, ATG, AUS, AUT, AZE, BDI, BEL, BEN, BES, BFA, BGD, BGR, BHR, BHS, BIH, BLM, BLR, BLZ, BMU, BOL, BRA, BRB, BRN, BTN, BVT, BWA, CAF, CAN, CCK, CHE, CHL, CHN, CIV, CMR, COD, COG, COK, COL, COM, CPV, CRI, CUB, CUW, CXR, CYM, CYP, CZE, DEU, DJI, DMA, DNK, DOM, DZA, ECU, EGY, ERI, ESH, ESP, EST, ETH, FIN, FJI, FLK, FRA, FRO, FSM, GAB, GBR, GEO, GGY, GHA, GIB, GIN, GLP, GMB, GNB, GNQ, GRC, GRD, GRL, GTM, GUF, GUM, GUY, HKG, HMD, HND, HRV, HTI, HUN, IDN, IMN, IND, IOT, IRL, IRN, IRQ, ISL, ISR, ITA, JAM, JEY, JOR, JPN, KAZ, KEN, KGZ, KHM, KIR, KNA, KOR, KWT, LAO, LBN, LBR, LBY, LCA, LIE, LKA, LSO, LTU, LUX, LVA, MAC, MAF, MAR, MCO, MDA, MDG, MDV, MEX, MHL, MKD, MLI, MLT, MMR, MNE, MNG, MNP, MOZ, MRT, MSR, MTQ, MUS, MWI, MYS, MYT, NAM, NCL, NER, NFK, NGA, NIC, NIU, NLD, NOR, NPL, NRU, NZL, OMN, PAK, PAN, PCN, PER, PHL, PLW, PNG, POL, PRI, PRK, PRT, PRY, PSE, PYF, QAT, REU, ROU, RUS, RWA, SAU, SDN, SEN, SGP, SGS, SHN, SJM, SLB, SLE, SLV, SMR, SOM, SPM, SRB, SSD, STP, SUR, SVK, SVN, SWE, SWZ, SXM, SYC, SYR, TCA, TCD, TGO, THA, TJK, TKL, TKM, TLS, TON, TTO, TUN, TUR, TUV, TWN, TZA, UGA, UKR, UMI, URY, USA, UZB, VAT, VCT, VEN, VGB, VIR, VNM, VUT, WLF, WSM, YEM, ZAF, ZMB, ZWE, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW]

    Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes)

    sex SexEnum (string)

    Possible values: [Not known, Male, Female, Not applicable]

    Sex Enum (ISO/IEC 5218)

    title TitleEnum (string)

    Possible values: [Mr, Mrs, Sir, Miss, Not known]

    Title Enum

    user_id string

    Unique system identifier for the user

    license_date date-time

    Date when the driver's license was issued

    license_type LicenseTypeEnum (string)[]

    Possible values: [AM, A1, A2, A, B, BTP, BE, C1, C1E, C, CE, D1, D1E, D, DE]

    Types of vehicles the driver is licensed to operate

  • ]

    • owner

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    address

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    city string

    City name

    country string

    Country name

    floor string

    Floor number

    postal_code string

    Postal code

    province string

    Province

    state string

    State

    street

    object

    name string
    number string
    type string
    birth_date date-time

    Person's date of birth

    contact

    object

    emails

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • phone_numbers

    object[]

  • Array [

    • area_code string

    Country phone number prefix

    type string

    Phone number type

    value string

    Phone number

  • ]

    • social_media

    object[]

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • customer_id string

    Unique identifier for the customer

    documents

    object[]

    Array of identification documents

  • Array [

    • type string

    Document type

    value string

    Document value

  • ]

    • first_name string

    Person's first/given name

    language LanguageEnum (string)

    Possible values: [aar, abk, afr, aka, amh, ara, arg, asm, ava, ave, aym, aze, bak, bam, bel, ben, bih, bis, bod, bos, bre, bul, cat, ces, cha, che, chu, chv, cor, cos, cre, cym, dan, deu, div, dzo, ell, eng, epo, est, eus, ewe, fao, fas, fij, fin, fra, fry, ful, gla, gle, glg, glv, grn, guj, hat, hau, heb, her, hin, hmo, hrv, hun, hye, ibo, ido, iii, iku, ile, ina, ind, isl, ita, jav, jpn, kal, kan, kas, kat, kau, kaz, khm, kik, kir, kom, kon, kor, kua, kur, lao, lat, lav, lim, lin, lit, ltz, lub, lug, mah, mal, mar, mkd, mlg, mlt, mon, mri, msa, mya, nau, nav, nbl, nde, ndo, nep, nld, nno, nob, nor, nya, oci, oji, ori, orm, oss, pan, pli, pol, por, pus, que, roh, ron, run, rus, sag, san, sin, slo, slv, sme, smo, sna, snd, som, sot, spa, srd, srp, ssw, sun, swa, swe, tam, tel, tgk, tha, tib, tir, ton, tsn, tso, tuk, tur, twi, uig, ukr, urd, uzb, ven, vie, vol, wln, wol, xho, yid, yor, zha, zul, aa, ab, ae, af, ak, am, an, ar, as, av, ay, az, ba, be, bg, bh, bi, bm, bn, bo, br, bs, ca, ce, ch, co, cr, cs, cu, cv, cy, da, de, dv, dz, ee, el, en, eo, es, et, eu, fa, ff, fi, fj, fo, fr, fy, ga, gd, gl, gn, gu, gv, ha, he, hi, ho, hr, ht, hu, hy, hz, ia, id, ie, ig, ii, ik, io, is, it, iu, ja, jv, ka, kg, ki, kj, kk, kl, km, kn, ko, kr, ks, ku, kv, kw, ky, la, lb, lg, li, ln, lo, lt, lu, lv, mg, mh, mi, mk, ml, mn, mr, ms, mt, my, na, nb, nd, ne, ng, nl, nn, no, nr, nv, ny, oc, oj, om, or, os, pa, pi, pl, ps, pt, qu, rm, rn, ro, ru, rw, sa, sc, sd, se, sg, si, sk, sl, sm, sn, so, sq, sr, ss, st, su, sv, sw, ta, te, tg, th, ti, tk, tl, tn, to, tr, ts, tt, tw, ty, ug, uk, ur, uz, ve, vi, vo, wa, wo, xh, yi, yo, za, zh, zu]

    Language Enum (ISO 63903 Alpha-3 and Alpha-2 codes

    last_name string

    Person's last/family name

    middle_name string

    Person's middle name

    nationality CountryEnum (string)

    Possible values: [ABW, AFG, AGO, AIA, ALA, ALB, AND, ARE, ARG, ARM, ASM, ATA, ATF, ATG, AUS, AUT, AZE, BDI, BEL, BEN, BES, BFA, BGD, BGR, BHR, BHS, BIH, BLM, BLR, BLZ, BMU, BOL, BRA, BRB, BRN, BTN, BVT, BWA, CAF, CAN, CCK, CHE, CHL, CHN, CIV, CMR, COD, COG, COK, COL, COM, CPV, CRI, CUB, CUW, CXR, CYM, CYP, CZE, DEU, DJI, DMA, DNK, DOM, DZA, ECU, EGY, ERI, ESH, ESP, EST, ETH, FIN, FJI, FLK, FRA, FRO, FSM, GAB, GBR, GEO, GGY, GHA, GIB, GIN, GLP, GMB, GNB, GNQ, GRC, GRD, GRL, GTM, GUF, GUM, GUY, HKG, HMD, HND, HRV, HTI, HUN, IDN, IMN, IND, IOT, IRL, IRN, IRQ, ISL, ISR, ITA, JAM, JEY, JOR, JPN, KAZ, KEN, KGZ, KHM, KIR, KNA, KOR, KWT, LAO, LBN, LBR, LBY, LCA, LIE, LKA, LSO, LTU, LUX, LVA, MAC, MAF, MAR, MCO, MDA, MDG, MDV, MEX, MHL, MKD, MLI, MLT, MMR, MNE, MNG, MNP, MOZ, MRT, MSR, MTQ, MUS, MWI, MYS, MYT, NAM, NCL, NER, NFK, NGA, NIC, NIU, NLD, NOR, NPL, NRU, NZL, OMN, PAK, PAN, PCN, PER, PHL, PLW, PNG, POL, PRI, PRK, PRT, PRY, PSE, PYF, QAT, REU, ROU, RUS, RWA, SAU, SDN, SEN, SGP, SGS, SHN, SJM, SLB, SLE, SLV, SMR, SOM, SPM, SRB, SSD, STP, SUR, SVK, SVN, SWE, SWZ, SXM, SYC, SYR, TCA, TCD, TGO, THA, TJK, TKL, TKM, TLS, TON, TTO, TUN, TUR, TUV, TWN, TZA, UGA, UKR, UMI, URY, USA, UZB, VAT, VCT, VEN, VGB, VIR, VNM, VUT, WLF, WSM, YEM, ZAF, ZMB, ZWE, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW]

    Country Code (ISO 3166 - Alpha-3 and Alpha-2 codes)

    sex SexEnum (string)

    Possible values: [Not known, Male, Female, Not applicable]

    Sex Enum (ISO/IEC 5218)

    title TitleEnum (string)

    Possible values: [Mr, Mrs, Sir, Miss, Not known]

    Title Enum

    user_id string

    Unique system identifier for the user

    vehicle

    object

    accessories

    object[]

  • Array [

    • description string

    Description of the vehicle accessory or add-on feature

    value float

    Cost or value of the accessory in base currency

  • ]

    • additional_details object

    Additional details that do not have a specific field to store it.

    brand string

    The manufacturer brand name of the vehicle

    category VehicleCategoryEnum (string)

    Possible values: [CA, MO, TU]

    Vehicle category enum

    class VehicleClassEnum (string)

    Possible values: [Bus, Car, Motorcycle, Other, Quad, Tractor, Truck, Van]

    Vehicle class enum

    color string

    The exterior color of the vehicle

    cylinder_capacity string

    The engine cylinder capacity in cc

    description string

    General description of the vehicle

    displacement number

    Engine displacement in liters

    doors number

    Number of doors on the vehicle

    fuel string

    Type of fuel used by the vehicle

    horsepower number

    Engine power measured in horsepower

    length number

    Vehicle length in meters

    model string

    The specific model name of the vehicle

    price number

    The price of the vehicle in base currency

    registration string

    Vehicle registration/license plate number

    registration_date date-time

    Date when the vehicle was first registered

    seats integer

    Number of seats in the vehicle

    transmission string

    Type of transmission system

    use VehicleUseEnum (string)

    Possible values: [AL, CL, EM, OS, PA, SP, NI]

    Vehicle use enum

    version string

    Specific version or trim level of the model

    weight number

    Vehicle weight in kilograms

    year integer

    Manufacturing year of the vehicle

    questionnaire

    object

    answer string

    User's response to the question

    answer_code string

    Unique code identifying the answer

    answer_type string

    Type of answer expected (e.g. text, boolean, number)

    description string

    Additional details about the question

    param_code string

    Parameter code used for internal processing

    question string

    The actual question text presented to the user

    sub_answer array
    type InsuredTypeEnum (string)

    Possible values: [car, property, person, company, device, cyber, health, travel, pet]

    Insured type enum

  • ]

    • movements

    object[]

  • Array [

    • date date-time

    dates

    object

    current_effective date-time
    expiration date-time
    initial_effective date-time
    issue_date date-time
    situation_date date-time
    description string
    details string
    movement_id string
    order string
    situation SituationMovementEnum (string)

    Possible values: [Pending, Accepted, Rejected]

    Situation movement enum

    type MovementTypeEnum (string)

    Possible values: [Cancellation of chargeback, Cancellation, Billing, Refund, Refund Settlement, Issuance, Chargeback payment, Settlement, Risk Addition, Risk Removal, Insured Beneficiary Change, Coverage Change, Risk Change, Policyholder Change, Capital Reduction, Coverage Reduction, Effective Date Entry, Decennial Policy Coverage Entry, Capital Increase, Coverage Increase, Temporary Policy Coverage Extension, Regularization, Rehabilitation, Negotiable Policy Renewal, None Of The Above, Payment Method Change]

    Movement type enum

  • ]

    • period PolicyPeriodEnum (string)

    Possible values: [Decennial, Negotiable, Renewable, Temporary, Temporary With Extension, One Time, Duration Not Available]

    Policy period enum

    policy_id string

    price

    object

    amount float

    commission

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    apply_over_taxes boolean
    commission_value float
    description string
    type string

    Possible values: [FIXED, PERCENTAGE]

    value string
    rate number

    Tax rate

    currency_code CurrencyCodeEnum (string)

    Possible values: [AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW]

    Currency codes Enum

    discount

    object[]

  • Array [

    • additional_details object

    Additional details that do not have a specific field to store it.

    apply_over_taxes boolean
    commission_value float
    description string
    type string

    Possible values: [FIXED, PERCENTAGE]

    value string
    rate number

    Tax rate

  • ]

    • premium

    object

    net float
    total float

    taxes

    object[]

  • Array [

    • description string

    Human readable description of the tax

    type string

    Type/category of the tax being applied

    value float

    Numeric value of the amount

    rate number

    Tax rate

  • ]

    • product

    object

    internal_id string

    Unique internal identifier for the product

    internal_products array
    metadata object

    Additional metadata associated with the product

    name string

    Name of the product

    price

    object

    amount float

    commission

    object

    additional_details object

    Additional details that do not have a specific field to store it.

    apply_over_taxes boolean
    commission_value float
    description string
    type string

    Possible values: [FIXED, PERCENTAGE]

    value string
    rate number

    Tax rate

    currency_code CurrencyCodeEnum (string)

    Possible values: [AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMW]

    Currency codes Enum

    discount

    object[]

  • Array [

    • additional_details object

    Additional details that do not have a specific field to store it.

    apply_over_taxes boolean
    commission_value float
    description string
    type string

    Possible values: [FIXED, PERCENTAGE]

    value string
    rate number

    Tax rate

  • ]

    • premium

    object

    net float
    total float

    taxes

    object[]

  • Array [

    • description string

    Human readable description of the tax

    type string

    Type/category of the tax being applied

    value float

    Numeric value of the amount

    rate number

    Tax rate

  • ]

    • product_id string

    General product identifier

    product_package string

    Package identifier that the product belongs to

    product_status string

    Current status of the product

    provider string

    Provider identifier for the product

    score number

    Product rating or score value

    provider string
    status StatusPolicyEnum (string)

    Possible values: [Active, Canceled, Draft, Error, Expired, Pending, Reconnect, Suspended, Terminated, Withdraw]

    Status policy enum

    type PolicyTypeEnum (string)

    Possible values: [Cancellation, Collective Policy Pre Portfolio, Draft, New Production, Portfolio, Supplement]

    Policy type enum

    valid_from date-time
    valid_until date-time

  • ]

    • status StatusContractEnum (string)

    Possible values: [Canceled, Draft, Expired, Finished, In_progress, Pending, Suspended]

    Contract status Enum

Loading...