Get Sandbox Keys
API Reference

Update Business Customer

put
https://api.cloud.mbanq.com/v1/clients/

Keep business profiles current by updating organizational and incorporation intelligence. This API enables seamless modification of entity attributes, including structural data, registration details, and contact configurations, ensuring the corporate record accurately reflects the entity's latest legal and operational state.

Note: Data integrity is maintained via status-based validation rules enforced during the update process.

Path Params
integer
required
Defaults to 123

The associated customer Id.

Body Params
integer

The associated legal form Id. It's used to create either a Retail or a Corporate Customer. Accepted Values are :

  1. 1 - Person
  2. 2 - Entity
    Pattern: '^(1|2)$'
    Example: 1
string

A unique identifier that links the customer created by the third-party system to the customer generated within our system.
Pattern: '^\d+$'
Example: '12345'

string
length ≤ 100
^[a-zA-Z'-\u00C0-\u017F\s]*$

Full Name of the customer.
Required when the legal form is an entity (legalFormId is 2).
Allowed Characters:
Alphanumeric: a-z, A-Z, 0-9
Special characters: apostrophe ', hyphen -
Accented characters: UTF-8 standard supported (é, ñ, ü, etc.)
Pattern: '^[a-zA-Z''-\u00C0-\u017F\s]*$'
Example: 'Business Name'

string

The mobile country code. Validation is enforced.
Pattern: 'XXX'
Example: '+1'

string

The mobile number of the customer. Validation is enforced.
Pattern: '^\d+$'
Example: '8598055021'

string

The email address of the customer. Email Format Validation is enforced.
Pattern: '^\S+@\S+.\S+$'
Example: '[email protected]'

clientNonPersonDetails
object

Additional details required when creating an Entity Customer (legalFormId = 2).

clientTypes
array of integers

A list of customer type identifiers associated with the customer.
Each ID represents a specific customer classification.
The value is fetched from the API Get Code Value with code name ClientType.

clientTypes
integer

The customer classification Id. If the customer needs to be associated to any existing classification, then the classification id needs to be passed.
The value is fetched from the API Get Code Value with code name ClientClassification-ENTITY.
Pattern: '^\d+$'
Example: 12345

string

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

string

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

Headers
string
required

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

Responses

Updated 15 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 15 days ago

Did this page help you?