post https://api-v3-uat.tanda.africa/kyx/v1/organizations//consumers//documents
Creates a new document for a consumer in your organization.
Upload consumer document
This endpoint allows an organization to upload a required document for a specific consumer (e.g., national ID, passport, or driver’s license). The document is associated with the consumer’s record in the Tanda WaaS platform and is used for verification and compliance checks.
Parameters:
organizationId
(path): Organization's unique identifierconsumerId
(path): Consumer's unique identifier
Request Body (multipart/form-data)
Parameter | Description | Mandatory |
---|---|---|
type | The document type, retrievable from Fetch Consumer Document Types (e.g., KE.NationalID ). | Yes |
front | The front-facing image of the document (e.g., the front side of a National ID). | Yes |
back | The back-facing image of the document (e.g., the back side of a National ID). | Yes |
Sample Response
{
"id": "7171ace2-86e0-46d7-b969-f31a3e77f1ef",
"number": null,
"status": "Unverified",
"datetimeCreated": "2025-09-12T05:48:24.000Z",
"lastModified": "2025-09-12T05:48:24.000Z",
"expiry": null,
"type": {
"id": "KE.NationalID",
"name": "National ID"
},
"files": [
{
"id": "0e82edef-7c23-4f24-a27d-bc339d0dc83f",
"contentType": "image/png",
"name": "Screenshot from 2025-09-12 07-44-54.png",
"side": "Front",
"datetimeCreated": "2025-09-12T05:48:24.000Z",
"lastModified": "2025-09-12T05:48:24.000Z"
},
{
"id": "ed946b21-a9dd-4bef-9610-7a4670abadad",
"contentType": "image/png",
"name": "Screenshot from 2025-09-12 07-44-54.png",
"side": "Back",
"datetimeCreated": "2025-09-12T05:48:24.000Z",
"lastModified": "2025-09-12T05:48:24.000Z"
}
]
}