Upload Business Customer Document

post

https://api.cloud.mbanq.com/v1/v1/clients/{business_clientId}/documents

Streamline the collection of supporting documentation with this secure upload gateway. From proof of residence to financial statements, this endpoint allows for the direct attachment of essential files to a customer's master profile. By centralizing these assets, you create a robust, accessible repository for compliance audits and relationship management, ensuring all requisite paperwork is electronically captured and securely stored. Validations are automatically performed to confirm compliance with supported file formats, sizes, and document types.

Path Params

business_clientId

integer

required

Defaults to 15

The associated Customer Id.
Example: 15

Body Params

name

string

required

Defaults to Age Proof

The name of the document being uploaded. This indicates the type of document, such as "Age Proof" or "Identity Proof".
Example: Age Proof

file

required

The file to upload, which should be in one of the supported formats (PDF, JPEG, JPG, PNG). Ensure the file meets the specified format requirements.
Example: Uploading an image file in PNG format, "Screenshot (1).png".

documentType

integer

required

Defaults to 5488

The unique identifier representing the document type.
All the documentTypeId values can be fetched from the API Get Code Value with code name Customer Identifier-PERSON.
Example: 5488

description

string

A brief description of the document being uploaded. This helps clarify the document's purpose or category.
Example:Age Proof doc

type

string

Specifies the type of content being uploaded, such as "file" for file uploads. It is used to categorize the data.
Example: file

userId

string

The unique identifier of the user associated with the document upload. This is used to link the document to the correct user profile.
Example: 46896

Headers

tenantId

string

required

The ID of your banking instance visible in the MBANQ Console.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Document uploaded successfully

400The request failed validation. Common causes include a missing file, unsupported file format, missing document name, or missing documentType.

401Authentication credentials were missing or incorrect.

403The authenticated user does not have permission to upload client documents.

404The request fails if the client Id is incorrect.