BAbanqzinc
Shareholder Documents

Upload a document for a shareholder. Requires multipart/form-data with fields: file (binary) and documentType (string)

Changed on

Upload a document for a shareholder. Requires multipart/form-data with fields: file (binary) and documentType (string)

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

Request

Path parameters

merchantIdstring uuid required

The unique identifier of the merchant

Example:123e4567-e89b-12d3-a456-426614174000
shareholderIdstring uuid required

The unique identifier of the shareholder

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

Request body multipart/form-data

filestring binary required

The document file to upload (PDF, JPG, PNG, DOC, or DOCX)

documentType'PROOF_OF_ADDRESS' required

Valid document types for shareholder documents

Example request

{
  "documentType": "PROOF_OF_ADDRESS"
}

Response

Created

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"
  }
}

Changes