Retrieve Partner KYC Statement

Retrieve the KYC statement for the cardholder if it exists.

Path Parameters

• cardholderAccountId string required

  ID of the cardholder account.

  Example: 65a7e8ef0d230d0a6bf755e07d39eb02

Responses

• 200
• 403

---

application/json

• Schema
• Example (from 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 prevents duplicate creation.

• claims object[]

  A list of claims about the cardholder's identity.

  Array [

  claimType string

  Possible values: [FULL_NAME, DOB, ADDRESS]

  The type of claim.

  attributes object

  The attributes that support the claim.

  oneOf

  • FULL_NAME
  • DOB
  • ADDRESS

  ---

  givenName string

  Primary name.

  middleName string

  Other name(s).

  familyName string

  Family name or surname.

  honorific string

  Title used to address the cardholder.

  dateOfBirth string required

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

  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 string required

  Possible values: [NZL]

  Country code.

• ]

evidence object[]

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

Array [

evidenceType string required

Possible values: [PASSPORT, DRIVERS_LICENSE]

The type of evidence.

documentId string required

The passport number or the license number.

country string required

Possible values: [NZL]

The country that issued the document.

expiry string

The passport expiry formatted as YYYY-MM-DD. Required for PASSPORT.

version string

The driver's license version. Required for DRIVERS_LICENSE.

]

{
  "accountId": "225d85e65495722bf6517ea0ba0d6f56",
  "partnerAccountId": "314d85e65495722bf6517ea0ba0d4lp3",
  "createdAt": "2022-11-16T03:13:18.142Z",
  "createdBy": "irn:314d85e65495722bf6517ea0ba0d4lp3:api-key:SLOs3U38hdhfEqwF1JKpTw",
  "idempotencyKey": "21ede8ef0d230d0a6bf755e07d39la54",
  "claims": [
    {
      "claimType": "FULL_NAME",
      "attributes": {
        "givenName": "John",
        "middleName": "Foo Bar",
        "familyName": "Doe",
        "honorific": "Mr"
      }
    }
  ],
  "evidence": [
    {
      "evidenceType": "DRIVERS_LICENSE",
      "documentId": "DS230475",
      "country": "NZL",
      "expiry": "2024-10-12",
      "version": "978"
    }
  ]
}

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
• Example (from schema)

---

Schema

• statusCode integer required
• statusName string required
• errorCode string required
• reason string

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