Get Sandbox Keys
API Reference

Add Customer Address

post
https://api.cloud.mbanq.com/v1/v1/client//addresses

Enhance a customer's profile by associating precise geographical data with their identity. This endpoint allows for the addition of multiple address types—including primary, business, postal, and tax residences—ensuring your records remain accurate for correspondence, compliance, and localized service delivery. By maintaining up-to-date physical touchpoints, you strengthen the integrity of the customer profile throughout its lifecycle.

Note: Standardized country, state, and type codes are required for address creation. Please refer to the Address Template for a comprehensive list of supported values.

Path Params
integer
required
Defaults to 123

The customer Id associated with this address.
Example: 123

Query Params
integer
enum
required
Defaults to 31

The type of the address. The value is fetched from the API Get Code Value with code name ADDRESS_TYPE.
The accepted values for type are:

  1. 31 - PRIMARY
  2. 32 - BUSINESS
  3. 33 - POSTAL
  4. 34 - TAX

Pattern: '^(31|32|33|34)$'
Example: 31

Allowed:
Body Params
string
required
length ≤ 35
Defaults to 456 Oak Avenue

Address Line 1 for the customer. Validation is enforced.
Address Line 1 format as defined in the ADDRESS field configuration regex patterns
When invalid address validation is enabled, this field cannot contain:

  • P.O. Box addresses (P.O. Box, PO Box, POB, etc.)
  • Post Office Box variations
  • Box numbers
  • Call box references
  • GPO box references

Configuration: address-line1-invalid-regex
Example: 456 Oak Avenue

string
length ≤ 35

Supplemental address information such as an apartment, suite, or unit number.

string
length ≤ 255

Additional address information such as a landmark or building name.

string
required
[a-zA-Z- ]+
Defaults to San Francisco

The city where the address is located.

Validation: Must match the pattern [a-zA-Z- ]+.

integer
required
^\d+$
Defaults to 546

The unique identifier for the state or province.

This value is obtained via the Get Code Values API using the code name STATE.

Validation: Enforced.
Pattern: ^\d+$

string
required
Defaults to CA

The ISO code for the state or province.

This value must exist in the code value name STATE and should belong to the specified country.
If both stateId and stateISOCode are provided, the system prioritizes stateISOCode.

Pattern: ^[A-Z0-9\-]+$

integer
required
^\d+$
Defaults to 284

The unique identifier for the country.

This value is obtained via the Get Code Values API using the code name COUNTRY.

Validation: Enforced.
Pattern: ^\d+$

string
required
Defaults to US

The ISO code for the country.

This value must exist in the code value name COUNTRY.
If both countryId and countryISOCode are provided, the system prioritizes countryISOCode.

Pattern: ^[A-Z]{2,3}$

string
required
length ≤ 255
^[a-zA-Z0-9\s-]{3,10}$
Defaults to 94103

The postal or zip code for the address.

Common Aliases:

  • ZIP CODE: Primarily used in the US (e.g., 94103, 90210-1234).
  • POST CODE: Used in the UK, Canada, and many other countries (e.g., SW1W 0NY, K1A 0A6).

Validation is enforced based on the country:

  • US: NNNNN or NNNNN-NNNN (e.g., 12345 or 12345-6789)
  • Canada: ANA NAN (e.g., K1A 0A6)
  • UK: AAN NAA, AANN NAA, ANA NAA, AN NAA (e.g., SW1A 1AA)
  • Other countries: Minimum 4 characters

Pattern: ^[a-zA-Z0-9\s-]{3,10}$

boolean
required

Indicates whether this is an active address for the customer.

Validation: Enforced.

Headers
string
required

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

Responses

Updated 16 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 16 days ago

Did this page help you?