Search
K
Policy Transactions

IdentifierStatus

string

Status of the identifier document

Allowed values:ACTIVEEXPIREDSUSPENDEDREVOKEDPENDING

Example

Identifier

object
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

Example

ExternalIdentifier

object
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

GovernmentIssuedIdentifier

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

Example

PassportIdentifier

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

countryOfIssuestringrequired

Abbreviated names for countries

Allowed values:USCARUEGZAGRNLBEFRESHUITROCHATGBDKSENOPLDEPEMXCUARBRCLCOVEMYAUIDPHNZSGTHJPVNCNTRINPKAFLKIRMADZTNLYGMSNMRMLGNBFNETGBJMULRSLGHNGCFTDCMCVSTGQGABSAOBBAXSDRWETSODJKETZUGBIMZZMMGREZWNAMWLSBWAGKMGWCDVGSHAWFOGLKYGIPTLUIEISALMTCYFIBGGGLTLVEEMDAMBYADSMUAHRSIBAMKXKCZSKLIBMGDFKBZGTSVHNNICRPMHTPRVIGSSXBQGPBOGYECGFPYMQSRUYANTCBLMFMSGUAQBNNRPGTOSBVUFJWFCKNUASKINCTVPFMPPWMHFMSSLCDMVCDOHKMOKHLATTKNJMBDTWMMKRKPLBJOSYIQKWSAYEOMAEILBHQABTNPTJTMAZGEUZAIPACIERKZKGCCMNBVSCIOWSTLTFYTPNSJTKUMEHMVCXNFCWCGMCVASZPSJEIMRSMEHM

Example