Get KYC document data
Returns the list of documents a customer has uploaded, with metadata for each one.
Path Parameters
UUID of the customer
Responses
| Status | Description |
|---|---|
200 |
Uploaded documents retrieved |
400 |
Invalid request |
404 |
Customer or document data not found |
500 |
Internal processing error while retrieving documents |
200 response
ID of the customer the documents belong to
Stored documents with their metadata
Unique identifier for the stored document
Document type as stored by the verification provider
Document side
Document identification number
Issuing country (ISO 3166-1 alpha-3)
Document issue date (YYYY-MM-DD)
Document expiration date (YYYY-MM-DD)
Whether a front-side image is stored
Whether a back-side image is stored
Original filename supplied at upload
Number of stored documents
Error information if the request failed
{
"data": {
"customer_id": "42ad0adb-e134-4345-b4be-98e5021b0da8",
"documents": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"IDType": "PASSPORT",
"IDSubType": "FRONT_SIDE",
"IDNumber": "A12345678",
"IssuingCountry": "NGA",
"IssuedDate": "2020-01-01",
"ExpiryDate": "2030-01-01",
"has_front_image": true,
"has_back_image": false,
"OriginalFilename": "passport_front.jpg"
}
],
"count": 1
},
"error": null
}
400 response
Always null for error responses
Human-readable error message
{
"data": null,
"error": {
"code": "INVALID_REQUEST",
"message": "invalid customer_id format"
}
}
404 response
Always null for error responses
Human-readable error message
{
"data": null,
"error": {
"code": "CUSTOMER_NOT_FOUND",
"message": "Customer not found. Please verify the customer exists in our system."
}
}
{
"data": null,
"error": {
"code": "KYC_NOT_FOUND",
"message": "no KYC document data found for customer"
}
}
500 response
Always null for error responses
Human-readable error message
{
"data": null,
"error": {
"code": "KYC_PROCESSING_ERROR",
"message": "failed to retrieve KYC document data"
}
}
Authorization
- ApiKeyAuth