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 |
Non-Doc field rules and response examples: DocDatabaseDetail, Get Result API.
Input fields by numberType
Which Generate URL API input fields are required, per numberType.
| numberType | numberValue | fullName | gender |
|---|---|---|---|
| BVN | Optional | Optional | — |
| NIN | Optional | Optional | — |
| NIK | Optional | Required | — |
| CPF | Optional | Optional | — |
| DNI | Optional | — | Required when numberValue is provided¹ |
| SAID | Required | — | — |
— 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.
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).
| numberType | numberValue length (digits) |
|---|---|
| BVN | 11 |
| NIN | 11 |
| NIK | 16 |
| CPF | 11 |
| DNI | 7 or 8 |
| SAID | 13 |
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 |