Get KYC Statement

GET 
/api/accounts/:cardholderAccountId/partner-kyc-statement

Retrieve the KYC statement for the cardholder if it exists.

Request

Path Parameters

cardholderAccountId stringrequired
ID of the cardholder account.
Example: 65a7e8ef0d230d0a6bf755e07d39eb02

Responses

200

application/json

Schema

Schema

accountId string

The cardholder account id.

partnerAccountId string

The partner account id that is affiliated with the cardholder.

createdAt string

Timestamp of KYC statement creation.

createdBy string

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

idempotencyKey string

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.

claims

object[]

A list of claims about the cardholder's identity.

Array [

anyOf

DOB

claimType enum

Possible values: [DOB]

The type of claim.

attributes

object

The attributes that support the DOB claim.

dateOfBirth stringrequired

The cardholder's date of birth formatted as YYYY-MM-DD

FULL_NAME

claimType enum

Possible values: [FULL_NAME]

The type of claim.

attributes

object

The attributes that support the FULL_NAME claim.

honorific string

Title used to address the cardholder.

givenName string

Primary name.

middleName string

Other name(s).

familyName string

Family name or surname.

ADDRESS

claimType enum

Possible values: [ADDRESS]

The type of claim.

attributes

object

The attributes that support the address claim.

oneOf

StructuredAddress

addressType string

Possible values: [RESIDENTIAL]

The type of address.

unitNumber string

The unit number.

streetNumber string

Street number. Generally a number but can also be alphanumeric.

streetName string

Street name.

streetType string

Street type. e.g. Road, St, Avenue, Circuit.

town string

The town/village/suburb/city.

suburb string

The suburb in the town/city. Only use this if you require a suburb AND a town/city, otherwise, just use the "town" parameter.

state string

The state. Use local abbreviations such as VIC (Victoria) or TX (Texas).

region string

The county, province, or cantonment.

postalCode string

Postal code.

country stringrequired

The ISO 3166-2 Country code of the country the address is in.

UnstructuredAddress

addressType string

Possible values: [RESIDENTIAL]

The type of address.

fullAddress stringrequired

An address written as a single string. i.e. not an address that is structured into individual components (e.g. unit number, street number, street name, etc.) This is useful when the address cannot be provided in a structured way. We recommend using a structured address whenever possible as correct parsing is not guaranteed.

country stringrequired

The ISO 3166-2 Country code of the country the address is in.

]

evidence

object[]

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

Array [

anyOf

passport

evidenceType stringrequired

Possible values: [PASSPORT]

The type of evidence.

documentId stringrequired

The passport number.

country stringrequired

Possible values: [NZ, AU]

The country that issued the document.

expiry stringrequired

The passport expiry formatted as YYYY-MM-DD.

drivers-license

evidenceType stringrequired

Possible values: [DRIVERS_LICENSE]

The type of evidence.

documentId stringrequired

The license number.

country stringrequired

Possible values: [NZ, AU]

The country that issued the document.

region string

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 New Zealand no value is required.

version stringrequired

The driver's license card number or version

]

region string

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

Example (from schema)

{
  "idempotencyKey": "(random key that is unique for each request)",
  "region": "NZ",
  "claims": [
    {
      "claimType": "FULL_NAME",
      "attributes": {
        "givenName": "Jason",
        "middleName": "James",
        "honorific": "Mr",
        "familyName": "Anderson"
      }
    },
    {
      "claimType": "ADDRESS",
      "attributes": {
        "addressType": "RESIDENTIAL",
        "country": "NZ",
        "streetNumber": "73",
        "streetName": "Great Southern",
        "streetType": "ROAD",
        "suburb": "Auckland CBD",
        "town": "Auckland",
        "region": "Auckland",
        "state": "AKL",
        "postalCode": "6140"
      }
    },
    {
      "claimType": "DOB",
      "attributes": {
        "dateOfBirth": "1962-05-09"
      }
    }
  ],
  "evidence": [
    {
      "evidenceType": "DRIVERS_LICENSE",
      "documentId": "80513",
      "country": "AU",
      "region": "VIC",
      "version": "P0001975"
    }
  ]
}

403

Subject is not allowed to perform the action with the reason stated in the errorCode

FORBIDDEN Resource does not exist or there are no sufficient permissions to perform the action.

KYC_STATEMENT_DOES_NOT_EXIST Partner has not submitted any KYC statements

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}

Loading...