Search
K
New Business - Life

PaymentAddress

object
addressTypestring

Type of address

Allowed values:RESIDENCEBUSINESSPOBOXSEASONALSECONDARYMAILING

Example:RESIDENCE

addressLine1string

Primary address line

Example:123 Main St

addressLine2string

Secondary address line (optional)

Example:Apt 4B

addressLine3string

Third address line (optional)

Example:Apt 4B

citystring

City name

Example:San Francisco

statestring

Abbreviated names for states

Allowed values:ALAKAZARASAAAEAPCACOCTDCDEFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTMPNENVNHNJNMNYNCNDOHOKORPAPRRISCSDTNTXUTUMVTVAVIWAWVWIWY

Example:CA

zipCodestring

ZIP code (5 digits)

Match pattern:^\d{5}?$

Example:94105

zipCodeExtstring

ZIP code extension

Example:4465

countrystring

Allowed values:USAFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRHRCUCWCYCZCIDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUMUYUZVUVEVNVGVIWFEHYEZMZWAX

Example:US

Example

PaymentAddressPatch

object
addressTypestring

Type of address

Allowed values:RESIDENCEBUSINESSPOBOXSEASONALSECONDARYMAILING

Example:RESIDENCE

addressLine1string

Primary address line

Example:123 Main St

addressLine2string

Secondary address line (optional)

Example:Apt 4B

addressLine3string

Third address line (optional)

Example:Apt 4B

citystring

City name

Example:San Francisco

statestring

Abbreviated names for states

Allowed values:ALAKAZARASAAAEAPCACOCTDCDEFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTMPNENVNHNJNMNYNCNDOHOKORPAPRRISCSDTNTXUTUMVTVAVIWAWVWIWY

Example:CA

zipCodestring

ZIP code (5 digits)

Match pattern:^\d{5}?$

Example:94105

zipCodeExtstring

ZIP code extension

Example:4465

countrystring

Allowed values:USAFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRHRCUCWCYCZCIDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUMUYUZVUVEVNVGVIWFEHYEZMZWAX

Example:US

Example

Contact

object
phoneNumbersarray[object]
Show Child Parameters
emailsarray[object]
Show Child Parameters
preferredContactMethodstring

Allowed values:EMAILPHONEMAIL

Example:EMAIL

Example

ContactPatch

object
phoneNumbersarray[object]
Show Child Parameters
emailsarray[object]
Show Child Parameters
preferredContactMethodstring

Allowed values:EMAILPHONEMAIL

Example:EMAIL

Example

PhoneNumber

object
idstring(uuid)required

Unique identifier for the phone

Example:123e4567-e89b-12d3-a456-426614174000

typestringrequired

Allowed values:MOBILEHOMEBUSINESSCLAIMCENTERCUSTOMERSERVICECORPORATEOFFICEFAXUNKNOWNOTHER

Example:MOBILE

countryCodestringrequired

Allowed values:1933552131-6843762441-2646721-2685437429761439941-2429738801-246375325012291-441975591387267552466733592262578552372381-345236235568653615726924324268250622538553357420452531-7671-8091-829670593 20503240291372251500298679358335946892622412209954923335044302991-4735901-6715022242455925096723950485236354916298964353972391-8768196272546868508296599685637196126623121842337035285338926126560960223356692596222230269526913733779761-6642122589526467497731599687645052272346836721-6704796892680970507675595516364483511-7871-939974 26240772502901-8691-7585081-78468537823996638122124823265421386677252275003494249597472684641963886992255662286906761-868216909931-64968825638097144124659899867841858841-2841-340681212967243260263

areaCodestring

Example:123

dialNumberstringrequired

Example:12345, 1234567890

extensionstring

Example:1234

bestTimestring

Best time

Example:Morning

timezonestring

Timezone for the entered phone details

Example:EST

Example