v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Merchant Documents

List all documents for a merchant (metadata only)

List all documents for a merchant (metadata only)

get/api/v1/merchants/{id}/documents

Path parameters

idstring uuid required

The unique identifier of the merchant

Example:123e4567-e89b-12d3-a456-426614174000

The unique identifier of the merchant

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "documentType": "certificate_of_incorporation",
      "fileName": "certificate.pdf",
      "uploadedAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "documentType": "business_proof_of_address",
      "fileName": "utility_bill.pdf",
      "uploadedAt": "2024-01-16T14:20:00.000Z"
    },
    {
      "id": "770e8400-e29b-41d4-a716-446655440002",
      "documentType": "memorandum_and_articles",
      "fileName": "memorandum.pdf",
      "uploadedAt": "2024-01-17T09:15:00.000Z"
    }
  ]
}