Skip to main content
Version: Canary 🚧

KYC fields

Use these exact names in the items of /api/v1/blockchain/verified, in fields / optionalFields of /api/v2/kyc/qrcode, and when you select fields for a package. Names are upper case and case-sensitive.

Native language vs. English

Fields with the _EN suffix are in English. Their counterparts without _EN are in the user's native language. Request both if you need both. For users whose native language is English, the two are identical.

Identity documents​

Each document type offers the same set of fields:

FieldID cardPassportResidence permitDriver license
NameIDCARD_NAMEPASSPORT_NAMERESIDENCE_PERMIT_NAMEDRIVER_LICENSE_NAME
Name (English)IDCARD_NAME_ENPASSPORT_NAME_ENRESIDENCE_PERMIT_NAME_ENDRIVER_LICENSE_NAME_EN
Date of birthIDCARD_DOBPASSPORT_DOBRESIDENCE_PERMIT_DOBDRIVER_LICENSE_DOB
Place of birthIDCARD_PLACE_OF_BIRTHPASSPORT_PLACE_OF_BIRTHRESIDENCE_PERMIT_PLACE_OF_BIRTHDRIVER_LICENSE_PLACE_OF_BIRTH
NationalityIDCARD_NATIONALITYPASSPORT_NATIONALITYRESIDENCE_PERMIT_NATIONALITYDRIVER_LICENSE_NATIONALITY
SexIDCARD_SEXPASSPORT_SEXRESIDENCE_PERMIT_SEXDRIVER_LICENSE_SEX
CountryIDCARD_COUNTRYPASSPORT_COUNTRYRESIDENCE_PERMIT_COUNTRYDRIVER_LICENSE_COUNTRY
Document numberIDCARD_DOCUMENT_NUMBERPASSPORT_DOCUMENT_NUMBERRESIDENCE_PERMIT_DOCUMENT_NUMBERDRIVER_LICENSE_DOCUMENT_NUMBER
Issue dateIDCARD_ISSUE_DATEPASSPORT_ISSUE_DATERESIDENCE_PERMIT_ISSUE_DATEDRIVER_LICENSE_ISSUE_DATE
Expiry dateIDCARD_EXPIRY_DATEPASSPORT_EXPIRY_DATERESIDENCE_PERMIT_EXPIRY_DATEDRIVER_LICENSE_EXPIRY_DATE
Document imageIDCARD_DOCUMENT_IMAGEPASSPORT_DOCUMENT_IMAGERESIDENCE_PERMIT_DOCUMENT_IMAGEDRIVER_LICENSE_DOCUMENT_IMAGE
Face imageIDCARD_FACE_IMAGEPASSPORT_FACE_IMAGERESIDENCE_PERMIT_FACE_IMAGEDRIVER_LICENSE_FACE_IMAGE
Additional imageIDCARD_ADDITIONAL_IMAGEPASSPORT_ADDITIONAL_IMAGERESIDENCE_PERMIT_ADDITIONAL_IMAGEDRIVER_LICENSE_ADDITIONAL_IMAGE
AML checkIDCARD_AML_CHECKPASSPORT_AML_CHECKRESIDENCE_PERMIT_AML_CHECKDRIVER_LICENSE_AML_CHECK
AML detailIDCARD_AML_DETAILPASSPORT_AML_DETAILRESIDENCE_PERMIT_AML_DETAILDRIVER_LICENSE_AML_DETAIL
NoteIDCARD_NOTEPASSPORT_NOTERESIDENCE_PERMIT_NOTEDRIVER_LICENSE_NOTE

Address​

FieldDescription
ADDRESS_NAME, ADDRESS_NAME_ENName on the proof of address
ADDRESS_ISSUE_DATE, ADDRESS_EXPIRY_DATEValidity of the proof of address
ADDRESS_STREET, ADDRESS_STREET_ENStreet
ADDRESS_STREET2, ADDRESS_STREET2_ENStreet, second line
ADDRESS_DIVISION, ADDRESS_DIVISION_ENState / province / division
ADDRESS_CITY, ADDRESS_CITY_ENCity
ADDRESS_ZIP_CODEPostal code
ADDRESS_COUNTRYCountry
ADDRESS_DOCUMENT_IMAGEImage of the proof-of-address document
ADDRESS_NOTENote

Contact​

FieldDescription
EMAILVerified email address
PHONEVerified phone number

External wallets​

FieldNetwork
EXTERNAL_WALLET_BTCBitcoin
EXTERNAL_WALLET_ETHEthereum
EXTERNAL_WALLET_LTCLitecoin
EXTERNAL_WALLET_BNBBNB Chain
EXTERNAL_WALLET_POLPolygon
EXTERNAL_WALLET_SOLSolana

Parent fields​

A parent field stands for the same attribute on any document. The order accepts whichever of the listed fields the user has verified.

Parent fieldResolves to one of
NAME_PARENT_FIELDIDCARD_NAME, PASSPORT_NAME, RESIDENCE_PERMIT_NAME, DRIVER_LICENSE_NAME, ADDRESS_NAME
NAME_EN_PARENT_FIELDIDCARD_NAME_EN, PASSPORT_NAME_EN, RESIDENCE_PERMIT_NAME_EN, DRIVER_LICENSE_NAME_EN, ADDRESS_NAME_EN
DOB_PARENT_FIELDIDCARD_DOB, PASSPORT_DOB, RESIDENCE_PERMIT_DOB, DRIVER_LICENSE_DOB
SEX_PARENT_FIELDIDCARD_SEX, PASSPORT_SEX, RESIDENCE_PERMIT_SEX, DRIVER_LICENSE_SEX
FACE_IMAGE_PARENT_FIELDIDCARD_FACE_IMAGE, PASSPORT_FACE_IMAGE, RESIDENCE_PERMIT_FACE_IMAGE, DRIVER_LICENSE_FACE_IMAGE

The delivered data names the concrete field that was used, for example PASSPORT_DOB.