Get Person Customer Template

Accelerate the person customer creation process by retrieving a dynamic configuration blueprint. This foundational template provides all available options—including office locations, staff assignments, products, and personal classifications—ensuring your application captures precisely the data required by your specific institution. By utilizing these pre-defined options, you ensure valid data entry and a seamless transition from registration to activation.

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

How to Use Template Option IDs in Create Person Customer

The response from this API contains multiple *Options arrays (e.g., genderOptions, officeOptions, clientTypeOptions). Each option object includes an id field. These id values must be passed as the corresponding field values in the Create Person Customer request payload.

Template Option ArrayPick the id fromUse as field in Create Customer
officeOptionsofficeOptions[].idofficeId
genderOptionsgenderOptions[].idgenderId
clientTypeOptionsclientTypeOptions[].idclientTypes[]
clientClassificationOptionsclientClassificationOptions[].idclientClassificationId
clientOccupationOptionsclientOccupationOptions[].idoccupationId
nationalityOptionsnationalityOptions[].idnationalityId
address.countryIdOptionsaddress.countryIdOptions[].idaddress[].countryId
address.stateProvinceIdOptionsaddress.stateProvinceIdOptions[].idaddress[].stateProvinceId
address.addressTypeIdOptionsaddress.addressTypeIdOptions[].idaddress[].addressTypeId

Example: If the template returns genderOptions with [{ "id": 634, "name": "Male" }, { "id": 635, "name": "Female" }], then to create a male person customer, pass "genderId": 634 in the Create Person Customer request body.

Query Params
integer

Restrict the template data to a specific office. When omitted, the authenticated user's office is used.

string

Alters the template payload for specific workflows.

  • statusOptions returns only the list of customer status values.
  • Omit the parameter to receive the standard customer creation template.
boolean

When set to true, the staff and related lookups are restricted to the office identified by officeId. Defaults to false.

Headers
string
required
Defaults to z01j3e71zd6zkq908vyf5861a8

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

Response

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