Search
K
New Business - Life

EinIdentifierPatch

typestring

Type of identifier document

Allowed values:PASSPORTSTATEPHOTOIDDRIVERLICENSENUMBERSSNTINEINEXTERNALOTHER

valuestring

Value of the identifier

Example:123456789

descriptionstring

Additional description or notes about this identifier

Example:identifier description

sourcestring

Source system or organization that issued this identifier

Example:State of California

issueYearstring

Year when the EIN was issued

Match pattern:^\d{4}$

Example:2015

Example

EinIdentifierResponse

typestring

Type of identifier document

Allowed values:PASSPORTSTATEPHOTOIDDRIVERLICENSENUMBERSSNTINEINEXTERNALOTHER

valuestring

Value of the identifier

Example:123456789

descriptionstring

Additional description or notes about this identifier

Example:identifier description

sourcestring

Source system or organization that issued this identifier

Example:State of California

issueYearstring

Year when the EIN was issued

Match pattern:^\d{4}$

Example:2015

Example

AlienRegistrationIdentifier

typestringrequired

Type of identifier document

Allowed values:PASSPORTSTATEPHOTOIDDRIVERLICENSENUMBERSSNTINEINEXTERNALOTHER

valuestringrequired

Value of the identifier

Example:123456789

descriptionstring

Additional description or notes about this identifier

Example:Passport number

sourcestring

Source system or organization that issued this identifier

Example:State of California

issueDatestring(date)

Date (with pattern “yyyy-mm-dd”)

Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Example:2015-08-15

expirationDatestring(date)

Date (with pattern “yyyy-mm-dd”)

Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Example:2025-08-15

statusstring

Status of the identifier document

Allowed values:ACTIVEEXPIREDSUSPENDEDREVOKEDPENDING

Example:ACTIVE

countryOfOriginstringrequired

Allowed values:USAFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRHRCUCWCYCZCIDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUMUYUZVUVEVNVGVIWFEHYEZMZWAX

Example:US

categorystringrequired

Immigration category or classification

Example:H-1B

Example

AlienRegistrationIdentifierPatch

typestring

Type of identifier document

Allowed values:PASSPORTSTATEPHOTOIDDRIVERLICENSENUMBERSSNTINEINEXTERNALOTHER

valuestring

Value of the identifier

Example:123456789

descriptionstring

Additional description or notes about this identifier

Example:identifier description

sourcestring

Source system or organization that issued this identifier

Example:State of California

issueDatestring(date)

Date (with pattern “yyyy-mm-dd”)

Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Example:2015-08-15

expirationDatestring(date)

Date (with pattern “yyyy-mm-dd”)

Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Example:2025-08-15

statusstring

Status of the identifier document

Allowed values:ACTIVEEXPIREDSUSPENDEDREVOKEDPENDING

Example:ACTIVE

countryOfOriginstring

Allowed values:USAFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRHRCUCWCYCZCIDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUMUYUZVUVEVNVGVIWFEHYEZMZWAX

Example:US

categorystring

Immigration category or classification

Example:H-1B

Example

AlienRegistrationIdentifierResponse

typestring

Type of identifier document

Allowed values:PASSPORTSTATEPHOTOIDDRIVERLICENSENUMBERSSNTINEINEXTERNALOTHER

valuestring

Value of the identifier

Example:123456789

descriptionstring

Additional description or notes about this identifier

Example:identifier description

sourcestring

Source system or organization that issued this identifier

Example:State of California

issueDatestring(date)

Date (with pattern “yyyy-mm-dd”)

Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Example:2015-08-15

expirationDatestring(date)

Date (with pattern “yyyy-mm-dd”)

Match pattern:^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Example:2025-08-15

statusstring

Status of the identifier document

Allowed values:ACTIVEEXPIREDSUSPENDEDREVOKEDPENDING

Example:ACTIVE

countryOfOriginstring

Allowed values:USAFALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCDCGCKCRHRCUCWCYCZCIDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQAMKRORURWREBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUMUYUZVUVEVNVGVIWFEHYEZMZWAX

Example:US

categorystring

Immigration category or classification

Example:H-1B

Example