post https://api.zwitch.io/v1/serviceability/postal-code
Use this endpoint to get a list of postal codes for which accounts can be created.
Note:
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.
| Parameters | Type | Description |
|---|---|---|
| id | string | Unique identifier of the serviceability request in the ZWITCH database. Example: ser_SMw9PfTmeusaza2dyO7tQbCMWSupported characters:
|
| object | string | API object that is returned. Possible value: serviceability.postal_code |
| purpose | string | Reason you are checking if a postal code is serviceable. Possible values:
|
| postal_code | string | Postal code for which you want to the serviceability status. Has to be 6 digits. Example: 560005Supported characters:
|
| is_serviceable | boolean | Serviceability status of a postal code. Possible values:
|
| is_sandbox | boolean | Mode in which the API was triggered. Possible values:
|
| created_at | integer | Unix timestamp when the request was received by ZWITCH. Example: 1656417101 |