Upload Subclient Documents

Request

Path Params

clientId

string

required

Client's ID

id

string

required

SubClient's ID

Body Params multipart/form-data

documentType

enum<string>

required

The type of document (must be one of the predefined document types)

Allowed values:

REGISTRATION_CERTIFICATE PROOF_OF_ADDRESS SHAREHOLDING_STRUCTURE_CHART RECENT_BANK BUSINESS_LICENSE ARTICLE_OF_ASSOCIATION CERTIFICATE_OF_INCORPORATION LIST_OF_DIRECTORS LIST_OF_SHAREHOLDERS TAX_REGISTRATION SOURCE_OF_WEALTH AML_CERTIFICATE WOLFSBERG_QUESTIONNAIRE IDCARD ID PASSPORT VISA FUND_SOURCE RESIDENCE_PERMIT PROOF_OF_ADDRESS OTHER RECENT_BANK PROFESSIONAL_CERTIFICATE ESTATE_PROOF AML_REPORT AML_CERTIFICATE ID_VERIFICATION_REPORT LIVENESS_CHECK_VIDEO INDIVIDUAL_PROOF_BUNDLE FACE_PHOTO NIN VOTERS_CARD DRIVER_LICENSE DRIVERS_LICENSE

businessUserId

string

optional

The ID of the business user associated with this document

issueDate

string

optional

The date the document was issued

expiryDate

string

optional

The date the document expires

file

required

The file being uploaded. Supported files are PDF, JPEG, PNG, JPG, XLSX, DOCX.

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api-gateway-uat.mmacs.io/platform/client-service/api/v1/clients//sub-clients//upload-kyc' \
--form 'documentType=""' \
--form 'businessUserId=""' \
--form 'issueDate=""' \
--form 'expiryDate=""' \
--form 'file=@""'

Responses

🟢200OK

application/json

success response

Body

DocumentOutputData type

id

number

optional

The id of the client

entityId

string

optional

The entity ID of the client (nanoid)

createdAt

string

optional

The date the entity was created

updatedAt

string

optional

The last date the entity was updated

createdBy

string

optional

The email of the user who created the entity

updatedBy

string

optional

The email of the user who last updated the entity

isDeleted

string

optional

Check if the entity has been deleted (soft delete)

documentType

string

optional

The type of document

uploadedFiles

array[string]

optional

The urls of the uploaded files

issueDate

string

optional

The issue date of the document

expiryDate

string

optional

The expiry date of the document

documentNumber

string

optional

The number of the document

approvalStatus

string

optional

The document approval status

mimeType

string

optional

The mime type of the document

parentType

enum<string>

optional

Allowed values:

clientsubclientshareholder

Example

{
  "id": 0,
  "entityId": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "isDeleted": "string",
  "documentType": "string",
  "uploadedFiles": [
    "string"
  ],
  "issueDate": "string",
  "expiryDate": "string",
  "documentNumber": "string",
  "approvalStatus": "string",
  "mimeType": "string",
  "parentType": "client"
}

🟠400Bad Request

🟠401Unauthorized