Check the Validity of a National ID.
GET {{baseUrl}}/national_ids/:national_id/validity?country_code=NZ
With this API call, you can check whether a National ID format is correct and the value exists in SWIFT's list of National IDs; you need to provide the National ID, and either a country code, or an indication to which scheme this National ID belongs.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
country_code | string | The 2-character ISO 3166-1 country code of the country that issued the National ID (mandatory, when scheme parameter is not provided) | |
scheme | string | The scheme (a synonym for the National ID type) under which the National ID is defined (mandatory, when country_code parameter is not provided); it maps all possible National ID types (id_type, national_id_type, iso_clc_type) |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"national_id":"50070010","id_type":"DE-BLZ8","national_id_type":"BLZ","iso_clc_type":"DEBLZ","validity":"valid"}