Get KYC Statement

accountIdstring

The cardholder account id.

partnerAccountIdstring

The partner account id that is affiliated with the cardholder.

createdAtstring

Timestamp of KYC statement creation.

createdBystring

The Immersve Resource Name (IRN) that created the resource.

idempotencyKeystring

A client-supplied identifier that helps support idempotency for safely retrying requests without submitting the same statement twice (e.g. after a transient failure). This should change for each different version of the KYC statement you submit.

claimsobject[]

A list of claims about the cardholder's identity.

Items

Any of

claimTypestring
Allowed values:DOB
The type of claim.
attributesobject
The attributes that support the DOB claim.
- dateOfBirthstringrequired
  The cardholder's date of birth formatted as YYYY-MM-DD

claimTypestring
Allowed values:FULL_NAME
The type of claim.
attributesobject
The attributes that support the FULL_NAME claim.
- honorificstring
  Title used to address the cardholder.
- givenNamestring
  Primary name.
- middleNamestring
  Other name(s).
- familyNamestring
  Family name or surname.

claimTypestring
Allowed values:ADDRESS
The type of claim.
attributesobject
The attributes that support the address claim.
One of
addressTypestring
Allowed values:RESIDENTIAL
The type of address.
unitNumberstring
The unit number.
streetNumberstring
Street number. Generally a number but can also be alphanumeric.
streetNamestring
Street name.
streetTypestring
Street type. e.g. Road, St, Avenue, Circuit.
townstring
The town/village/suburb/city.
suburbstring
The suburb in the town/city. Only use this if you require a suburb AND a town/city, otherwise, just use the "town" parameter.
statestring
The state. Use local abbreviations such as VIC (Victoria) or TX (Texas).
regionstring
The county, province, or cantonment.
postalCodestring
Postal code.
countrystringrequired
The ISO 3166-2 Country code of the country the address is in.

evidenceobject[]

A list of evidence supporting the claimed identity. At least one piece of evidence is required.

Items

Any of

evidenceTypestringrequired
Allowed values:PASSPORT
The type of evidence.
documentIdstringrequired
The passport number.
countrystringrequired
ISO 3166-1 alpha-2 country code of the country that issued the document. See Supported Regions.
expirystringrequired
The passport expiry formatted as YYYY-MM-DD.

evidenceTypestringrequired
Allowed values:DRIVERS_LICENSE
The type of evidence.
documentIdstringrequired
The license number.
countrystringrequired
ISO 3166-1 alpha-2 country code of the country that issued the document. See Supported Regions.
regionstring
Where appropriate, the state or region that issued the document, in the format provided by the issuer. e.g. for Australia a Victorian Drivers license, this would be 'VIC'. For other countries no value is required.
versionstring
The driver's license card number or version. This field is required for New Zealand and Australia. For other countries this field is optional.
expirystring
The driver's license expiry formatted as YYYY-MM-DD.

evidenceTypestringrequired
Allowed values:NATIONAL_ID
The type of evidence.
documentIdstringrequired
The national id number.
countrystringrequired
ISO 3166-1 alpha-2 country code of the country that issued the document. See Supported Regions.
paternalFamilyNamestring
The paternal family name of the cardholder. This field is optional and only applicable for MX.
maternalFamilyNamestring
The maternal family name of the cardholder. This field is optional and only applicable for MX.
expirystring
The national id expiry formatted as YYYY-MM-DD.

evidenceTypestringrequired
Allowed values:RESIDENCE_PERMIT
The type of evidence.
documentIdstringrequired
The residence permit number.
countrystringrequired
ISO 3166-1 alpha-2 country code of the country that issued the document. See Supported Regions.
expirystring
The residence permit expiry formatted as YYYY-MM-DD.

regionstring

An Alpha2 (ISO-3166-1) country code representing the country in which the user is being verified.

Get KYC Statement

Request

Path Parameters

Response

Body application/json

Body application/json