Search
K
Policy

IriPartyPhone

object
startDatestring(date)

Date the phone record becomes effective.

Example:2026-03-06

endDatestring(date)

Date the phone record ends.

Example:2027-03-06

phoneTypestring

Classification of the phone number.

Allowed values:MOBILEHOMEBUSINESSCLAIMCENTERCUSTOMERSERVICECORPORATEOFFICEFAXUNKNOWNOTHER

countryCodestringrequired

Country code of the phone.

Match pattern:^\+?[0-9]{1,3}$

Example:+1

areaCodestringrequired

Area code of the phone.

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

Example:704

dialNumberstringrequired

Dial number of the phone.

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

Example:5550123

extensionstring

Dial-in extension for the phone.

Match pattern:^[A-Za-z0-9-]{1,10}$

Example:123

bestTimestring

Best time to contact the party via phone.

Allowed values:MORNINGAFTERNOONEVENINGANYTIME

timezonestring

Timezone for the entered phone details.

Match pattern:^[A-Za-z_]+/[A-Za-z_]+(?:/[A-Za-z_]+)?$

Example:America/New_York

isPreferredboolean

Whether this is the preferred phone number.

Example:true

phoneIdstring

Record identifier for the phone.

Match pattern:^[A-Za-z0-9._-]{1,100}$

Example:PH001

Example

IriEmailType

string

Type or category of the email address.

Allowed values:PERSONALBUSINESSCUSTOMERSERVICEOTHER

IriPartyEmail

object
startDatestring(date)

Date the email record becomes effective.

Example:2026-03-06

endDatestring(date)

Date the email record ends.

Example:2027-03-06

emailTypestring

Type or category of the email address.

Allowed values:PERSONALBUSINESSCUSTOMERSERVICEOTHER

emailAddressstring(email)required

Email address of the party.

Match pattern:^[^@\s]+@[^@\s]+\.[^@\s]+$

Example:john.public@example.com

isPreferredboolean

Whether this is the preferred email address.

Example:true

emailIdstring

Record identifier for the email.

Match pattern:^[A-Za-z0-9._-]{1,100}$

Example:EM001

Example

IriIdentificationType

string

Type of identification.

Allowed values:PASSPORTSTATEPHOTOIDDRIVERLICENSENUMBERSSNTINEXTERNALEINOTHER

IriPartyIdentification

object
identificationIdstring

Identifier for the identification record.

Match pattern:^[A-Za-z0-9._-]{1,100}$

Example:IDE-875

startDatestring(date)required

Date the identification record becomes effective.

Example:2026-03-06

endDatestring(date)required

Date the identification record ends.

Example:2028-03-06

identificationTypestring

Type of identification.

Allowed values:PASSPORTSTATEPHOTOIDDRIVERLICENSENUMBERSSNTINEXTERNALEINOTHER

identificationKeystring

Identification key.

Match pattern:^[A-Za-z0-9._-]{1,100}$

Example:US-PPT

identificationValuestring

Identification value.

<= 100 characters

Example:999888777

identificationDescriptionstring

Description of the identifier.

<= 255 characters

Example:US Passport

issueStatestring

State that issued the identification.

Match pattern:^[A-Z]{2}$

Example:NC

issueCountrystring

Country that issued the identification.

Match pattern:^[A-Z]{2}$

Example:US

Example