Create Customer Identifier

post

https://api.cloud.mbanq.com/v1/clients/{clientId}/identifiers

Formalize customer identity by registering critical identification metadata within the system. This API enables the association of unique identifiers—such as Passports, Driver’s Licenses, and National IDs—with a specific customer record. By establishing these verified links, you create a secure and traceable audit trail essential for regulatory compliance and high-trust banking operations.

For a list of supported document types (e.g., Driver's License, Passport), retrieve the relevant codes from the Get Code Value endpoint using the Customer Identifier-PERSON category.

Path Params

clientId

integer

required

Defaults to 15

The associated Customer Id. Example: 15

Body Params

documentTypeId

string

required

Defaults to 647

Type of the identification document. E.g. Driver's License, Passport. All the documentTypeId values can be fetched from the API Get Code Value with code name Customer Identifier-PERSON. In the said API response, check the name which is treated type of document and the ID is used as documentTypeId Pattern: '^\d+$' Example: 647

documentKey

string

required

Defaults to 1234567

A number/string that uniquely identifies a particular document. E.g A Driver's License number for a driving license. Pattern: '^\d+$' Example: 1234567

status

string

required

Defaults to Active

The status of Client Identifier. Indicates whether the client identifier is active. Example: Active

issuedDate

string

required

The issued date of the client identifier document.
Pattern: 'XXX' Example: 8 February 2028 Note: This is optional for SSN.

description

string

Any user comments to be associated with the Client Identifier. Example: Document has been verified

issuedBy

string

The entity/authority that issued the client identifier. Example: DMV

expiryDate

string

The Expiry date of the client identifier document. Pattern: 'XXX' Example: 15 August 2028

nationality

string

The nationality of the client. To get the list of available nationalities, use the API Get Code Value with code name COUNTRY. Pattern: 633 Example: 633

locale

string

The locale of the client. 'en' will be passed as default. Pattern: 'XX' Example: en

dateFormat

string

If the fields 'expiryDate is passed, then this parameter is mandatory. It specifies the dateformat, that's being used. Pattern: 'XXX' Example: dd MMMM yyyy

Headers

tenantId

string

required

Defaults to z01j3e71zd6zkq908vyf5861a8

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

Responses

200The customer identifier is created successfully.

400The request failed validation. Common causes include a missing document type, blank document key, or a duplicate identifier already on file.

401Authentication credentials were missing or incorrect.

403The authenticated user does not have permission to create client identifiers.

404The request fails if the customer Id is incorrect.