Get Client Template

get https://api.cloud.mbanq.com/v1/clients/template

Use this API to retrieve a template containing the default values, options, and configurations required for creating or updating a client.

This template provides various options such as available offices, staff members, saving products, client types, gender classifications, legal forms, and address-related details.

Response

Response body

object

activationDate

array of integers

The activation date of the entity in [YYYY, MM, DD] format.
Example: [2025, 2, 28]

activationDate

isStaff

boolean

Indicates if the entity is a staff member.
Example: false

skipAvs

boolean

Indicates whether Address Verification System (AVS) should be skipped.
Example: false

officeId

integer

The unique identifier of the office.
Example: 1

officeOptions

array of objects

officeOptions

object

integer

The unique identifier of the office.
Example: 1

name

string

The name of the office.
Example: "Head Office"

nameDecorated

string

The formatted or decorated name of the office.
Example: "Head Office"

staffOptions

array of objects

staffOptions

object

integer

The unique identifier of the staff member.
Example: 2

firstname

string

The first name of the staff member.
Example: "ad"

lastname

string

The last name of the staff member.
Example: "ad"

displayName

string

The full display name of the staff member.
Example: "ad,ad"

officeId

integer

The identifier of the office where the staff is assigned.
Example: 1

officeName

string

The name of the office where the staff is assigned.
Example: "Head Office"

isLoanOfficer

boolean

Indicates if the staff member is a loan officer.
Example: true

isActive

boolean

Indicates if the staff member is active.
Example: true

joiningDate

array of integers

The joining date of the staff member in [YYYY, MM, DD] format.
Example: [2023, 3, 1]

joiningDate

savingProductOptions

array of objects

savingProductOptions

object

integer

The unique identifier of the savings product.
Example: 1

name

string

The name of the savings product.
Example: "Ultra save"

withdrawalFeeForTransfers

boolean

Indicates if withdrawal fees apply for transfers.
Example: false

allowOverdraft

boolean

Indicates if overdraft is allowed on the savings product.
Example: false

enforceMinRequiredBalance

boolean

Indicates if a minimum required balance is enforced.
Example: false

withHoldTax

boolean

Indicates if tax withholding is enabled.
Example: false

genderOptions

array of objects

genderOptions

object

integer

The unique identifier for the gender option.
Example: 634

name

string

The name of the gender option.
Example: "Male"

clientTypeOptions

array of objects

Required only for UBO clients of an entity, such as CEOs, Directors, and CFOs.

clientTypeOptions

object

integer

The unique identifier for the client type.
Example: 5013

name

string

The name of the client type.
Example: "CEO"

clientClassificationOptions

array of objects

clientClassificationOptions

object

integer

The unique identifier for the client classification.
Example: 5086

name

string

The name of the client classification.
Example: "Default"

clientOccupationOptions

array of objects

clientOccupationOptions

object

integer

The unique identifier for the occupation.
Example: 10013

name

string

The name of the occupation.
Example: "Sales Executive"

clientLegalFormOptions

array of objects

clientLegalFormOptions

object

integer

The unique identifier for the legal form.
Example: 1

code

string

The code representing the legal form.
Example: "legalFormType.person"

value

string

The value of the legal form.
Example: "PERSON"

familyMemberOptions

object

relationshipIdOptions

array of objects

relationshipIdOptions

object

integer

The unique identifier for the relationship type.
Example: 299

name

string

The name of the relationship type.
Example: "Spouse"

address

object

countryIdOptions

array of objects

countryIdOptions

object

integer

The unique identifier for the country.
Example: 284

name

string

The name of the country.
Example: "United States"

identifier

string

The ISO country code.
Example: "US"

stateProvinceIdOptions

array of objects

stateProvinceIdOptions

object

integer

The unique identifier for the state or province.
Example: 600

name

string

The name of the state or province.
Example: "Mérida"

addressTypeIdOptions

array of objects

addressTypeIdOptions

object

integer

The unique identifier for the address type.
Example: 32

name

string

The name of the address type.
Example: "BUSINESS"

isAddressEnabled

boolean

Indicates if the address functionality is enabled.
Example: true

mobileNumberFormat

array of objects

mobileNumberFormat

object

name

string

The name of the mobile number validation rule.
Example: "mobile-number-regex"

enabled

boolean

Indicates if the validation rule is enabled.
Example: true

value

string

The regex pattern for mobile number validation.
Example: "^\\d{1,12}$"

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.cloud.mbanq.com/v1/clients/template \
3
     --header 'accept: application/json' \
4
     --header 'tenantId: z01j3e71zd6zkq908vyf5861a8'

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

application/json

200The Clients template is retrieved successfully.