Get Sandbox Keys
API Reference

Update Person Customer

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

Ensure individual customer records remain accurate and up-to-date by refining their essential profiles. This endpoint facilitates the modification of core attributes, including personal details and contact information, allowing for granular adjustments or broad profile refreshes.

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
string
length ≤ 100
^[a-zA-Z'-\u00C0-\u017F\s]*$
Defaults to John

The first name of the customer.
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: 'John'

string
Defaults to Edward

The middle name of the customer.
Pattern: '^[a-zA-Z]+$'
Example: 'Edward'

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

The last name of the customer.
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: 'Doe'

integer

Identifier for the legal form of the customer.
Example: 1

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
boolean

Indicates whether the customer is a staff member.
Example: false

integer

Staff ID of the employee (if the customer is staff).
Example: 2001

boolean

Indicates whether the user opted for MLA (Military Lending Act) status.
Example: true

boolean

Indicates current MLA (Military Lending Act) status.
Example: false

integer

The gender identifier of the customer.
To retrieve the complete and valid list of gender code values,
please use the API Get Code Value with code name Gender, which returns all
gender options with their corresponding IDs.
Example values:

  1. 634 - Male
  2. 635 - Female
  3. 636 - Diverse

Pattern: '^(634|635|636)$'
Example: 634

integer

Identifier for the customer's occupation.The occupation represents the account holder's profession, job title, or primary field of work, offering insights into their employment status and industry.
To get the list of available occupations, please use the API Get Code Value with code name Occupation
Pattern: '^\d+$'
Example: 10013

string
length ≤ 50

The preferred or informal name of the customer.
This can be used for display purposes or casual correspondence.
Example: 'jack'

integer

Identifier for the customer's nationality.
To get the list of available nationalities, use the API Get Code Value with code name COUNTRY.
Pattern: '^\d+$'
Example: 284

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]'

string

To map the customer created at your end to the clientId created at our end.
Pattern: '^\d+$'
Example: '12345'

integer

The customer classification Id. If the customer needs to be associated to any existing classification, then the classification id needs to be passed.
To get the list of classification Id, use the API Get Code Value with code name ClientClassification-PERSON.
Pattern: '^\d+$'
Example: 12345

string

The date of birth. The date format should be as per the format mentioned in the dateFormat parameter.
Pattern: 'XXX'
Example: '20 February 1999'

string

Locale used for date and number formatting.
Example: 'en'

string

If the fields 'dateOfBirth is passed, then this parameter is mandatory. It specifies the dateformat, 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 3 months 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 3 months ago

Did this page help you?