Search
K
Policy Transactions

DriversLicenseIdentifier

startDatestring(date)required

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

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

Example:2022-01-01

endDatestring(date)

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

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

Example:2022-01-01

typestringrequired

Type of identifier document

Allowed values:PASSPORTSTATE_IDDRIVERS_LICENSESSNITINALIEN_REGISTRATIONEXTERNAL_PARTY_IDENTIFIER

valuestringrequired

Value of the identifier

Example:123456

descriptionstring

Additional description or notes about this identifier

Example:identifier description

sourcestring

Source system or organization that issued this identifier

Example:source system

issueDatestring(date)

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

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

Example:2022-01-01

expirationDatestring(date)

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

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

Example:2022-01-01

statusstring

Status of the identifier document

Allowed values:ACTIVEEXPIREDSUSPENDEDREVOKEDPENDING

Example:ACTIVE

jurisdictionstringrequired

Abbreviated names for states

Allowed values:ALAKAZARCACOCTDCDEFLGAHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDOHOKORPARISCSDTNTXUTVTVAWAWVWIWY

Example:AL

restrictionsarray[string]

List of license restrictions

Example

SsnIdentifier

startDatestring(date)required

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

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

Example:2022-01-01

endDatestring(date)

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

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

Example:2022-01-01

typestringrequired

Type of identifier document

Allowed values:PASSPORTSTATE_IDDRIVERS_LICENSESSNITINALIEN_REGISTRATIONEXTERNAL_PARTY_IDENTIFIER

valuestringrequired

Value of the identifier

Example:123456

descriptionstring

Additional description or notes about this identifier

Example:identifier description

sourcestring

Source system or organization that issued this identifier

Example:source system

lastFourOnlyboolean

Indicates if only the last four digits are provided

Example

ItinIdentifier

startDatestring(date)required

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

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

Example:2022-01-01

endDatestring(date)

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

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

Example:2022-01-01

typestringrequired

Type of identifier document

Allowed values:PASSPORTSTATE_IDDRIVERS_LICENSESSNITINALIEN_REGISTRATIONEXTERNAL_PARTY_IDENTIFIER

valuestringrequired

Value of the identifier

Example:123456

descriptionstring

Additional description or notes about this identifier

Example:identifier description

sourcestring

Source system or organization that issued this identifier

Example:source system

issueYearstring

Year when the ITIN was issued

Match pattern:^\d{4}$

Example

AlienRegistrationIdentifier

startDatestring(date)required

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

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

Example:2022-01-01

endDatestring(date)

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

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

Example:2022-01-01

typestringrequired

Type of identifier document

Allowed values:PASSPORTSTATE_IDDRIVERS_LICENSESSNITINALIEN_REGISTRATIONEXTERNAL_PARTY_IDENTIFIER

valuestringrequired

Value of the identifier

Example:123456

descriptionstring

Additional description or notes about this identifier

Example:identifier description

sourcestring

Source system or organization that issued this identifier

Example:source system

issueDatestring(date)

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

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

Example:2022-01-01

expirationDatestring(date)

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

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

Example:2022-01-01

statusstring

Status of the identifier document

Allowed values:ACTIVEEXPIREDSUSPENDEDREVOKEDPENDING

Example:ACTIVE

countryOfOriginstringrequired

Abbreviated names for countries

Allowed values:USCARUEGZAGRNLBEFRESHUITROCHATGBDKSENOPLDEPEMXCUARBRCLCOVEMYAUIDPHNZSGTHJPVNCNTRINPKAFLKIRMADZTNLYGMSNMRMLGNBFNETGBJMULRSLGHNGCFTDCMCVSTGQGABSAOBBAXSDRWETSODJKETZUGBIMZZMMGREZWNAMWLSBWAGKMGWCDVGSHAWFOGLKYGIPTLUIEISALMTCYFIBGGGLTLVEEMDAMBYADSMUAHRSIBAMKXKCZSKLIBMGDFKBZGTSVHNNICRPMHTPRVIGSSXBQGPBOGYECGFPYMQSRUYANTCBLMFMSGUAQBNNRPGTOSBVUFJWFCKNUASKINCTVPFMPPWMHFMSSLCDMVCDOHKMOKHLATTKNJMBDTWMMKRKPLBJOSYIQKWSAYEOMAEILBHQABTNPTJTMAZGEUZAIPACIERKZKGCCMNBVSCIOWSTLTFYTPNSJTKUMEHMVCXNFCWCGMCVASZPSJEIMRSMEHM

categorystringrequired

Immigration category or classification

Example

ExternalPartyIdentifier

startDatestring(date)required

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

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

Example:2022-01-01

endDatestring(date)

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

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

Example:2022-01-01

typestringrequired

Type of identifier document

Allowed values:PASSPORTSTATE_IDDRIVERS_LICENSESSNITINALIEN_REGISTRATIONEXTERNAL_PARTY_IDENTIFIER

keystringrequired

name of the identifier document

Example:ecn

valuestringrequired

Value of the identifier

Example:123456

descriptionstring

Additional description or notes about this identifier

Example:identifier description

sourcestring

Source system or organization that issued this identifier

Example:source system

Example