Customers

Get address requirements for a country

Whether an address in country carries a state / region and a postal code, so a form can be shaped and validated before the profile is submitted. Values reflect the country's national address format: required must be sent, optional is accepted but never blocks, and absent means the country's format has no such field — omit it rather than sending an empty string. Requirements are country-scoped, not org-scoped, so the response is identical for every caller — this endpoint needs no authentication.

get/v0/customers/address-requirements

Request

  • Base URL
    https://orchestration.seismic.systems/api
  • Auth
    none declared

Query parameters

countrystring required

ISO-3166-1 alpha-2 country the address sits in (e.g. SG). Case-insensitive.

Response

The country's address field requirements.

countrystring required

Echo of the query, normalized to uppercase.

postal_code'required' | 'optional' | 'absent' required

Whether a country's national address format includes a field, and if so whether an address is deliverable without it. absent means the country's format has no such field — omit it rather than sending an empty string.

state'required' | 'optional' | 'absent' required

Whether a country's national address format includes a field, and if so whether an address is deliverable without it. absent means the country's format has no such field — omit it rather than sending an empty string.

Changes

No recorded changes to this operation across all 1 revision of this API.