Submit Partner KYC Statement
Submit a KYC statement about the cardholder.
Path Parameters
- cardholderAccountId string required
ID of the cardholder account.
Example: 65a7e8ef0d230d0a6bf755e07d39eb02
- application/json
Request Body required
- idempotencyKey string
A client-supplied identifier that prevents duplicate creation.
claims object[]
A list of claims about the cardholder's identity.
Array [claimType stringPossible values: [
FULL_NAME
,DOB
,ADDRESS
]The type of claim.
attributes object
The attributes that support the claim.
- oneOf
- FULL_NAME
- DOB
- ADDRESS
givenName stringPrimary name.
middleName stringOther name(s).
familyName stringFamily name or surname.
honorific stringTitle used to address the cardholder.
dateOfBirth string requiredThe cardholder's date of birth formatted as YYYY-MM-DD
addressType stringPossible values: [
RESIDENTIAL
]The type of address.
unitNumber stringThe unit number.
streetNumber stringStreet number. Generally a number but can also be alphanumeric.
streetName stringStreet name.
streetType stringStreet type. e.g. Road, St, Avenue, Circuit.
town stringThe town/village/suburb/city.
suburb stringThe suburb in the town/city. Only use this if you require a suburb AND a town/city, otherwise, just use the "town" parameter.
state stringThe state. Use local abbreviations such as VIC (Victoria) or TX (Texas).
region stringThe county, province, or cantonment.
postalCode stringPostal code.
country string requiredPossible 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 requiredPossible values: [
PASSPORT
,DRIVERS_LICENSE
]The type of evidence.
documentId string requiredThe passport number or the license number.
country string requiredPossible values: [
NZL
]The country that issued the document.
expiry stringThe passport expiry formatted as YYYY-MM-DD. Required for PASSPORT.
version stringThe driver's license version. Required for DRIVERS_LICENSE.
]
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
- object
{}
Request parameters are invalid
- application/json
- Schema
- Example (from schema)
Schema
- statusCode integer required
- statusName string required
- errorCode string required
- errors string[]
{
"statusCode": 400,
"statusName": "Bad Request",
"errorCode": "BAD_REQUEST",
"errors": [
"Expected string, received number"
]
}
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_STATEMENTS_NOT_ALLOWED Partner is not configured to submit 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"
}