Serviceability - Postal Codes

Use this endpoint to get a list of postal codes for which accounts can be created.



Do not create any kind of account if the postal code is not serviceable.

Response Object

The table below lists the various parameters in the serviceability.postal_code object.

idstringUnique identifier of the serviceability request in the ZWITCH database.

Example: ser_SMw9PfTmeusaza2dyO7tQbCMW

Supported characters:
  • A-Z
  • a-z
  • 0-9
  • _
objectstringAPI object that is returned.

Possible value: serviceability.postal_code
purposestringReason you are checking if a postal code is serviceable.

Possible values:
  • savings_account
  • current_account
postal_codestringPostal code for which you want to the serviceability status.

Has to be 6 digits.

Example: 560005

Supported characters:
  • 0-9
is_serviceablebooleanServiceability status of a postal code.

Possible values:
  • true: The postal code is serviceable.
  • false: The postal code is not serviceable.
is_sandboxbooleanMode in which the API was triggered.

Possible values:
  • true: API was triggered in sandbox mode
  • false: API was triggered in live mode
created_atintegerUnix timestamp when the request was received by ZWITCH.

Example: 1656417101
Click Try It! to start a request and see the response here!