Supported Regions & NumberTypes
| Region | Country | Generate URL numberType | Get Result numberTypeInfo.numberType | Notes |
|---|---|---|---|---|
| NGA | Nigeria | BVN | NG_BVN | Non-Doc |
| NGA | Nigeria | NIN | NG_NIN | Non-Doc |
| IDN | Indonesia | NIK | ID_NIK | Non-Doc |
| BRA | Brazil | CPF | BR_CPF | Non-Doc |
| ARG | Argentina | DNI | AR_DNI | Non-Doc |
| ZAF | South Africa | SAID | ZA_SAID | Non-Doc |
| PHL | Philippines | PCN | PH_PCN | Non-Doc |
| THA | Thailand | THAIEID | TH_THAIEID | ThaID app authorization |
Non-Doc field rules and response examples: DocDatabaseDetail, Get Result API.
These flows use the Non-Document Verification product (NON_DOCUMENT_VERIFICATION, solution code 07). Thailand ThaID uses app authorization and does not require ADVANCE.AI liveness capture.
Input fields by numberType
Which Generate URL API input fields are required, per numberType.
| numberType | numberValue | fullName | gender |
|---|---|---|---|
| BVN | Optional | — | — |
| NIN | Optional | — | — |
| NIK | Optional | Required | — |
| CPF | Optional | Optional | — |
| DNI | Optional | — | Required when numberValue is provided¹ |
| SAID | Required | — | — |
| PCN | Optional² | — | — |
| THAIEID | — | — | — |
— not applicable for that type. Optional = if omitted, the user fills it in on the H5 frontend.
¹ DNI: gender must be sent together with numberValue. If numberValue is omitted, the user provides both numberValue and gender on the H5 frontend.
² PCN: accepts either numberValue or prefilled personal information. For personal information, firstName, lastName, and birthday are required together; middleName and suffix are optional. If both numberValue and personal information are sent, numberValue is used. See Philippines PCN prefill.
For THAIEID, the user authorizes access in the ThaID app. No number or personal information prefill is required. Use the optional scope parameter in Generate URL API to select the requested attributes.
numberValue length by numberType
numberValue length is validated per numberType. A number whose length does not match returns Number is invalid format on Generate URL API (or INVALID_FORMAT on Get Result API). For PCN, Generate URL returns the same message with code = PARAMETER_ERROR.
| numberType | numberValue length |
|---|---|
| BVN | 11 |
| NIN | 11 |
| NIK | 16 |
| CPF | 11 |
| DNI | 7 or 8 |
| SAID | 13 |
| PCN | 16 digits, or 6–7 characters³ |
| THAIEID | Not applicable |
Health Status API numberType mapping
Health Status API uses different numberType query values than Generate URL.
Health Status API numberType | Generate URL numberType | Region |
|---|---|---|
| NG_BVN | BVN | NGA |
| NG_NIN | NIN | NGA |
| ID_NIK | NIK | IDN |
| BR_CPF | CPF | BRA |
| AR_DNI | DNI | ARG |
| ZA_SAID | SAID | ZAF |
| PH_PCN | PCN | PHL |
Updated 1 day ago
