---
title: "Get Address Requirements"
method: GET
path: "/v1/address-requirements"
tags: ["address"]
---

# Get Address Requirements

`GET /v1/address-requirements`

Returns the list of fields required to create a valid address. Use this as a starting point to discover required fields.

The response contains 4 required top-level fields:
- `country` (select field with list of values)
- `city` (text field)
- `postCode` (text field)
- `firstLine` (text field)

If a field has `refreshRequirementsOnChange: true`, call the POST endpoint with that field's value to discover additional required fields.

For a step-by-step walkthrough, see the [Address Requirements guide](/guides/developer/api-guides/address-requirements).

## Headers

- `X-External-Correlation-Id` string, uuid

## Response `200`

OK - Successfully retrieved address requirements.

- object[]
  - `type` string — Always "address".
  - `fields` object[] — List of fields required for the address.
    - `name` string — Display name of the field.
    - `group` object[]
      - `key` string — Key name to include in the JSON request.
      - `type` 'text' | 'select' — Display type of field.
      - `refreshRequirementsOnChange` boolean — If true, call POST address-requirements when this field value changes to discover additional required fields.
      - `required` boolean — Indicates if the field is mandatory.
      - `displayFormat` string, nullable — Display format pattern.
      - `example` string — Example value to help users understand what to input.
      - `minLength` integer, nullable — Minimum valid length of field value.
      - `maxLength` integer, nullable — Maximum valid length of field value.
      - `validationRegexp` string, nullable — Regexp validation pattern.
      - `validationAsync` string, nullable — Deprecated. This validation will instead be performed when submitting the request.
      - `valuesAllowed` object[] — List of allowed values (for select fields).
        - `key` string — Value key to use in the request.
        - `name` string — Display name for the value.

## Other responses

- `429` — Rate limit exceeded. Retry after the number of seconds specified in the `Retry-After` header.

---

[API](https://skmtc.net/wise/apis/platform-api.md) · [All operations](https://skmtc.net/wise/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wise/platform-api/revisions/4907a1d269ab/schema)