KYC verification of individuals (NZL)
Use this API call to perform KYC verification of individuals.
Parameters
Name | Type | Description |
---|---|---|
country | string | 3 letter country ISO |
firstName | string - letters only | |
middleName | string - letters only | |
lastName | string - letters only | |
gender | string | male/female |
dateOfBirth | string | DD/MM/YYYY |
unitNumber | string or null* | |
streetNumber | string | |
streetName | string | |
streetType | string or null* | Street types |
suburb | string | |
postcode | string | |
email | string |
ID documents
Submitting ID documents is optional. You can use ID documents as a verification source to improve the likelihood of a successful verification.
Driver licence
Name | Type | Description |
---|---|---|
driversLicenceNumber | string | |
driversLicenceVersionNumber | string | 3 characters |
driversLicenceImageFront | string | base64 Data URI (JPG/PNG/PDF) |
driversLicenceImageBack | string | base64 Data URI (JPG/PNG/PDF) |
Passport
Name | Type | Description |
---|---|---|
passportNumber | string | Including any letters |
passportCountryOfIssue | string | 3 letter country ISO |
passportDocumentExpiry | string | DD/MM/YYYY |
passportImage | string | base64 Data URI (JPG/PNG/PDF) |
Note
Base64 encoded uploads must be submitted as a Data URI (with data format prefix). Example PDF format:
data:application/pdf;base64,JVBERi0xLjUKJYCBgoMKMSAwIG9i...