Search
K
Policy Transactions

MultiplePhone

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”).If provided by the user, the system will apply an end date to the phone number, ensuring that a new phone number is not generated.

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

Example:2022-01-01

phoneTypestringrequired

Phone type

Allowed values:MOBILEHOMEBUSINESSCLAIMCENTERCUSTOMERSERVICECORPORATEOFFICEFAXOTHER

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

Example:1

areaCodestring

Area code

Example:785

dialNumberstringrequired

Dial number

Example:32653, 9134561234

extensionstring

Extension

Example:1234

bestTimestring

Best time

Example:Morning

timezonestring

Timezone for the entered phone details

Example:EST

preferredPhoneIndicatorbooleanrequired

Preferred email indicator

Example:true

Example
{
  "startDate": "2022-01-01",
  "endDate": "2022-01-01",
  "phoneType": "MOBILE",
  "countryCode": "1",
  "areaCode": "785",
  "dialNumber": "32653, 9134561234",
  "extension": "1234",
  "bestTime": "Morning",
  "timezone": "EST",
  "preferredPhoneIndicator": true
}

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
{
  "correlationId": "91f72a12-db2d-4254-93a8-e4c9c6c98588",
  "caseId": "CA0000007389",
  "effectiveDate": "2022-01-01",
  "identifiers": [
    {
      "startDate": "2022-01-01",
      "endDate": "2022-01-01",
      "type": "PASSPORT",
      "value": "123456",
      "description": "identifier description",
      "source": "source system",
      "issueDate": "2022-01-01",
      "expirationDate": "2022-01-01",
      "status": "ACTIVE",
      "countryOfIssue": "US"
    }
  ]
}

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
"ACTIVE"

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
{
  "startDate": "2022-01-01",
  "endDate": "2022-01-01",
  "type": "PASSPORT",
  "value": "123456",
  "description": "identifier description",
  "source": "source system"
}