Fetch Acceptable IDs
Endpoint
GET {{}}/v1/accounts/documentsDescription
This endpoint is used to fetch acceptable IDs for individuals requesting for an account and shareholders attributed to corporate accounts.
The endpoint allows filtering through various parameters;
By countryShort: this enables users to retrieve acceptable IDs for specific countries. To achieve this, include a "countryShort" query parameter in your API request.
Example:
GET {{base_url}}/v1/documents?countryShort=UKThe above request will return a response for acceptable IDs for the United Kingdom. View JSON response.
By type: this enables users to filter countries by document types such as id and poa. To use this filter, include a "type" query parameter in your API request.
Examples:
GET {{base_url}}/v1/documents?type=idThe above request will return a response for all countries and their accepted ID documents only. View JSON response.
Acceptable Document Types (Identifiers)
The list of acceptable document types (identifiers) are:
ID
passport
identityCard
drivingLicense
residencePermit
POA
utilityBill
bankStatement
Important: These keys are case-sensitive (camel case) and must be used exactly as shown above in API requests.
List of Countries and their Acceptable IDs'
United Kingdom (GBP)
UK
Yes
No
Yes
Yes
Europe (EUR)
France
FR
Yes
Yes
Yes
Yes
Germany
DE
Yes
Yes
Yes
Yes
Italy
IT
Yes
Yes
Yes
Yes
Spain
ES
Yes
Yes
Yes
Yes
Africa
Nigeria (NGN)
NG
Yes
Yes
Yes
No
Benin (XOF)
BJ
Yes
Yes
No
Yes
Mali (XOF)
ML
Yes
Yes
No
No
Togo (XOF)
TG
Yes
Yes
Yes
No
Cote d'Ivoire (XOF)
CI
Yes
Yes
Yes
No
America
United States of America (USD)
US
Yes
Yes
Yes
No
Proof of Address (POA) Accepted Documents
Individual
Yes
Yes
Corporate
Yes
Yes
Responses
On success of any request, the API will return a JSON object containing the details of the acceptable IDs.
{
"status": true,
"message": "Country Documents",
"data": [
{
"id": "b362187b-47aa-41ff-8978-73d5893ea5fa",
"country": "Nigeria",
"countryShort": "NG",
"createdAt": "2024-07-25T12:59:48.540Z",
"acceptedIDDocuments": {
"passport": true,
"identityCard": true,
"drivingLicense": true,
"residencePermit": false
},
"acceptedPOADocuments": {
"utilityBill": true,
"bankStatement": true
}
},
{
"id": "b2547d05-f533-4241-a814-ecd3bbddd851",
"country": "United Kingdom (GBP)",
"countryShort": "UK",
"createdAt": "2024-08-16T10:31:02.843Z",
"acceptedIDDocuments": {
"passport": true,
"identityCard": false,
"drivingLicense": true,
"residencePermit": true
},
"acceptedPOADocuments": {
"utilityBill": true,
"bankStatement": true
}
},
{
"id": "2a1e13a7-96e9-4a22-aa6b-3868100a33fa",
"country": "France",
"countryShort": "FR",
"createdAt": "2024-08-16T10:32:19.261Z",
"acceptedIDDocuments": {
"passport": true,
"identityCard": true,
"drivingLicense": true,
"residencePermit": true
},
"acceptedPOADocuments": {
"utilityBill": true,
"bankStatement": true
}
},
{
"id": "bfdafa95-61e5-4b57-843f-104c378145a1",
"country": "Germany",
"countryShort": "DE",
"createdAt": "2024-08-16T10:32:40.192Z",
"acceptedIDDocuments": {
"passport": true,
"identityCard": true,
"drivingLicense": true,
"residencePermit": true
},
"acceptedPOADocuments": {
"utilityBill": true,
"bankStatement": true
}
},
{
"id": "1bb6071b-7934-4958-8deb-8598ef6b6ea9",
"country": "Italy",
"countryShort": "IT",
"createdAt": "2024-08-16T10:33:00.833Z",
"acceptedIDDocuments": {
"passport": true,
"identityCard": true,
"drivingLicense": true,
"residencePermit": true
},
"acceptedPOADocuments": {
"utilityBill": true,
"bankStatement": true
}
},
{
"id": "48142897-a6c4-4559-bf49-9e7e9690fbed",
"country": "Spain",
"countryShort": "ES",
"createdAt": "2024-08-16T10:33:34.855Z",
"acceptedIDDocuments": {
"passport": true,
"identityCard": true,
"drivingLicense": true,
"residencePermit": true
},
"acceptedPOADocuments": {
"utilityBill": true,
"bankStatement": true
}
},
{
"id": "014f3d4b-0d6f-474b-9385-891d372d2d54",
"country": "Benin (XOF)",
"countryShort": "BJ",
"createdAt": "2024-08-16T10:34:54.708Z",
"acceptedIDDocuments": {
"passport": true,
"identityCard": true,
"drivingLicense": false,
"residencePermit": true
},
"acceptedPOADocuments": {
"utilityBill": true,
"bankStatement": true
}
},
{
"id": "7272af4a-3be8-4fe2-b500-1229ceb5b2d5",
"country": "Mali (XOF)",
"countryShort": "ML",
"createdAt": "2024-08-16T10:35:19.262Z",
"acceptedIDDocuments": {
"passport": true,
"identityCard": true,
"drivingLicense": false,
"residencePermit": false
},
"acceptedPOADocuments": {
"utilityBill": true,
"bankStatement": true
}
},
{
"id": "6d89a00e-bac0-4ef7-97bc-898212a7d1df",
"country": "Togo (XOF)",
"countryShort": "TG",
"createdAt": "2024-08-16T10:35:40.266Z",
"acceptedIDDocuments": {
"passport": true,
"identityCard": true,
"drivingLicense": true,
"residencePermit": false
},
"acceptedPOADocuments": {
"utilityBill": true,
"bankStatement": true
}
},
{
"id": "4d28475f-4d5f-4515-a27d-c6d1be4f25f9",
"country": "Cote d'Ivoire (XOF)",
"countryShort": "CI",
"createdAt": "2024-08-16T10:36:03.251Z",
"acceptedIDDocuments": {
"passport": true,
"identityCard": true,
"drivingLicense": true,
"residencePermit": false
},
"acceptedPOADocuments": {
"utilityBill": true,
"bankStatement": true
}
},
{
"id": "69362fd2-9e23-4c66-a4f3-5a19bce5998d",
"country": "United States of America (USD)",
"countryShort": "US",
"createdAt": "2024-08-16T10:36:30.071Z",
"acceptedIDDocuments": {
"passport": true,
"identityCard": true,
"drivingLicense": true,
"residencePermit": false
},
"acceptedPOADocuments": {
"utilityBill": true,
"bankStatement": true
}
}
],
"code": 200
}Filter by countryShort = NG:
{
"status": true,
"message": "Country Documents",
"data": [
{
"id": "b362187b-47aa-41ff-8978-73d5893ea5fa",
"country": "Nigeria",
"countryShort": "NG",
"createdAt": "2024-07-25T12:59:48.540Z",
"acceptedIDDocuments": {
"passport": true,
"identityCard": true,
"drivingLicense": true,
"residencePermit": false
},
"acceptedPOADocuments": {
"utilityBill": true,
"bankStatement": true
}
}
],
"code": 200
}Filter by type = id:
This returns only the accepted ID documents for all countries. The example below shows a JSON response with an additional filter for country short "NG"
{
"status": true,
"message": "Country Documents",
"data": [
{
"id": "b362187b-47aa-41ff-8978-73d5893ea5fa",
"country": "Nigeria",
"countryShort": "NG",
"createdAt": "2024-07-25T12:59:48.540Z",
"acceptedIDDocuments": {
"passport": true,
"identityCard": true,
"drivingLicense": true,
"residencePermit": false
}
}
],
"code": 200
}Filter by type = poa:
This returns only the accepted POA documents for all countries. The example below shows a JSON response with an additional filter for country short "NG"
{
"status": true,
"message": "Country Documents",
"data": [
{
"id": "b362187b-47aa-41ff-8978-73d5893ea5fa",
"country": "Nigeria",
"countryShort": "NG",
"createdAt": "2024-07-25T12:59:48.540Z",
"acceptedPOADocuments": {
"utilityBill": true,
"bankStatement": true
}
}
],
"code": 200
}Last updated