v1

latestOpenAPI 3.1.02026-07-132363652.9 MB

Shareholder Documents

List all documents for a shareholder (metadata only)

get/api/v1/merchants/{merchantId}/shareholders/{shareholderId}/documents

Path parameters

merchantIdstring uuid required

The unique identifier of the merchant

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

The unique identifier of the merchant

shareholderIdstring uuid required

The unique identifier of the shareholder

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

The unique identifier of the shareholder

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "documentType": "PROOF_OF_ADDRESS",
      "fileName": "proof_of_address.pdf",
      "uploadedAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}