Search
K
Policy

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

IriPartyTaxWithholdingParty

object
typestringrequired

Type of party.

Allowed values:individualentity

firstNamestring

First name of the individual party.

>= 1 characters<= 100 characters

Example:John

middleNamestring

Middle name of the individual party.

>= 1 characters<= 100 characters

Example:Q

lastNamestring

Last name of the individual party.

>= 1 characters<= 100 characters

Example:Public

namestring

Entity name of the party.

>= 1 characters<= 100 characters

Example:Public Family Trust

taxIdstringrequired

Tax identification number for the party.

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

>= 9 characters<= 9 characters

Example:123456789

Example