List KYC Documents
Retrieves all KYC documents associated with a merchant account.
Authentication required (User JWT).
GET /api/merchants/:merchantId/kyc
Path Parameters
| Parameter | Type | Description |
|---|---|---|
merchantId | String | The ID of the parent merchant. |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
status | String | No | Filter by document status (PENDING, APPROVED, REJECTED). If not provided, returns all documents. |
Response 200 OK
Returns an array of KYC document records.
[
{
"id": "uuid-kyc-doc-123",
"merchantId": "uuid-merchant-456",
"uploadedByUserId": "uuid-user-789",
"documentType": "CAC_CERTIFICATE",
"fileUrl": "/uploads/documentFile-randomhex.pdf",
"fileName": "cac_certificate.pdf",
"status": "PENDING",
"rejectionReason": null,
"createdAt": "2023-10-27T14:00:00.000Z",
"updatedAt": "2023-10-27T14:00:00.000Z"
},
{
"id": "uuid-kyc-doc-456",
"merchantId": "uuid-merchant-456",
"uploadedByUserId": "uuid-user-789",
"documentType": "UTILITY_BILL",
"fileUrl": "/uploads/documentFile-randomhex2.pdf",
"fileName": "utility_bill.pdf",
"status": "APPROVED",
"rejectionReason": null,
"createdAt": "2023-10-26T10:30:00.000Z",
"updatedAt": "2023-10-28T09:15:00.000Z"
}
]
Errors
401 Unauthorized: Invalid or missing JWT.403 Forbidden: User does not have permission to access this merchant's KYC documents.404 Not Found: Merchant not found.500 Internal Server Error