Get details of a National ID.
GET {{baseUrl}}/national_ids/:national_id?country_code=NZ
For a given National ID, you can retrieve the details of that National ID, that is the bank name or business name, and the address. You must provide either a country code, or an indication to which scheme the 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) | |
only_local_language | boolean | Whether fields must be returned in local language |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"national_ids":[{"national_id":"043000300","id_type":"AS-ABA9","national_id_type":"ABA","iso_clc_type":"USABA","office_type":"DB","name":"Federal Reserve Bank of Cleveland","department":"Pittsburgh","unstructured_address":{"address_line_1":"ONE OXFORD CTR","address_line_2":"301 GRANT ST, STE 3000","address_line_3":"PITTSBURGH PA 15219, US"},"structured_address":{"street_name":"GRANT ST","building_number":"301","building_name":"ONE OXFORD CTR","post_box":"PO BOX 867","room":"STE 3000","post_code":"15219","town_name":"PITTSBURGH","country_subdivision_name":"PENNSYLVANIA","country_subdivision_code":"PA","country_code":"US","country_name":"UNITED STATES OF AMERICA"},"utc_offset":"-05:00"}]}