Countries specific schemas
For the country and document type combinations we handle specifically, we define a country specific schema: the exact set of fields that document carries, on top of the base fields every document shares.
These schemas tell you which fields to send and which fields you get back:
- What you get back from Document Analysis: when you send
countryandtypeto Analyze a document image (v2), theparsedDataobject of the response contains exactly the fields of that combination's schema. Combinations without a country specific schema fall back to a generic extraction, with free-form keys. - What you send for enhanced verification: the
customerDataobject of Process session data accepts the fields documented for that country and document combination. Verification behavior depends on the document type. - Programmatic access: Get Customer Data Schema returns the same schema for a given
country_isoanddocument_type.
Base fields
Every schema also includes the base fields of CustomerDataDto: country, documentType, firstName and lastName.
EU passports
Passports issued by European Union member states share a single schema, CustomerDataEuPassport, listed under EU below. A member state with a dedicated passport schema (listed under its own country code) uses that one instead.
For the exact list of countries and document types handled specifically, see Get Available Countries & Documents. For every combination the API accepts, including the generic ones, see the Document Support Matrix.
Available schemas
| Country | Document type | Schema |
|---|---|---|
| 🇧🇧 Barbados (BB) | passport | CustomerDataBbPassport |
| 🇧🇸 Bahamas (BS) | driving-license | CustomerDataBsDrivingLicense |
| 🇧🇸 Bahamas (BS) | passport | CustomerDataBsPassport |
| 🇨🇦 Canada (CA) | passport | CustomerDataCaPassport |
| 🇨🇩 Democratic Republic of the Congo (CD) | driving-license | CustomerDataCdDrivingLicense |
| 🇨🇩 Democratic Republic of the Congo (CD) | id-card | CustomerDataCdIdCard |
| 🇨🇩 Democratic Republic of the Congo (CD) | passport | CustomerDataCdPassport |
| 🇨🇩 Democratic Republic of the Congo (CD) | voting-card | CustomerDataCdVotingCard |
| 🇩🇴 Dominican Republic (DO) | passport | CustomerDataDoPassport |
| 🇪🇺 European Union (EU) | passport | CustomerDataEuPassport |
| 🇭🇹 Haiti (HT) | passport | CustomerDataHtPassport |
| 🇯🇲 Jamaica (JM) | passport | CustomerDataJmPassport |
| 🇰🇪 Kenya (KE) | alien-id | CustomerDataKeAlienId |
| 🇰🇪 Kenya (KE) | foreigner-certificate | CustomerDataKeForeignerCertificate |
| 🇰🇪 Kenya (KE) | id-card | CustomerDataKeIdCard |
| 🇰🇪 Kenya (KE) | ke-kra-pin | CustomerDataKeKeKraPin |
| 🇰🇪 Kenya (KE) | passport | CustomerDataKePassport |
| 🇰🇪 Kenya (KE) | refugee-id | CustomerDataKeRefugeeId |
| 🇳🇬 Nigeria (NG) | digital-id-card | CustomerDataNgDigitalIdCard |
| 🇳🇬 Nigeria (NG) | driving-license | CustomerDataNgDrivingLicense |
| 🇳🇬 Nigeria (NG) | id-card | CustomerDataNgIdCard |
| 🇳🇬 Nigeria (NG) | nin-card | CustomerDataNgNinCard |
| 🇳🇬 Nigeria (NG) | nin-digital-slip | CustomerDataNgNinDigitalSlip |
| 🇳🇬 Nigeria (NG) | nin-slip | CustomerDataNgNinSlip |
| 🇳🇬 Nigeria (NG) | passport | CustomerDataNgPassport |
| 🇳🇬 Nigeria (NG) | voting-card | CustomerDataNgVotingCard |
| 🇵🇭 Philippines (PH) | passport | CustomerDataPhPassport |
| 🇷🇴 Romania (RO) | electronic-id-card | CustomerDataRoElectronicIdCard |
| 🇷🇴 Romania (RO) | id-card | CustomerDataRoIdCard |
| 🇷🇴 Romania (RO) | passport | CustomerDataRoPassport |
| 🇹🇹 Trinidad and Tobago (TT) | passport | CustomerDataTtPassport |
| 🇺🇬 Uganda (UG) | driving-license | CustomerDataUgDrivingLicense |
| 🇺🇬 Uganda (UG) | id-card | CustomerDataUgIdCard |
| 🇺🇬 Uganda (UG) | passport | CustomerDataUgPassport |
| 🇺🇬 Uganda (UG) | refugee-id | CustomerDataUgRefugeeId |
| 🇺🇸 United States (US) | passport | CustomerDataUsPassport |
| 🇿🇦 South Africa (ZA) | driving-license | CustomerDataZaDrivingLicense |
| 🇿🇦 South Africa (ZA) | id-book | CustomerDataZaIdBook |
| 🇿🇦 South Africa (ZA) | id-card | CustomerDataZaIdCard |
| 🇿🇦 South Africa (ZA) | passport | CustomerDataZaPassport |
| 🇿🇲 Zambia (ZM) | driving-license | CustomerDataZmDrivingLicense |