Search
K
Policy Transactions

IdentifierChangeRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:91f72a12-db2d-4254-93a8-e4c9c6c98588

caseIdstring

Zinnia Live Case ID

Example:CA0000007389

effectiveDatestring(date)required

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

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2022-01-01

identifiersAny Of
arrayrequired

Array of identifiers for this party

PassportIdentifierobject
Show Child Parameters
Example

IdentifierType

string

Type of identifier document

Allowed values:PASSPORTSTATE_IDDRIVERS_LICENSESSNITINALIEN_REGISTRATIONEXTERNAL_PARTY_IDENTIFIER

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