# Address checks

The check of an order's delivery address and the decisions taken on it

Section: api. Audience: public. Updated: 2026-10-10.

---
The check of an order's delivery address and the decisions taken on it.

1 operation, generated from the [OpenAPI file](/openapi/horizon-api.yaml). Authentication and the base URL are described in the [API overview](/api/).

## <span class="nh-method nh-method-get" id="address_checks_orders_retrieve">GET</span> `/api/address-checks/orders/{id}/`

Retrieve an order's address check

Operation ID `address_checks_orders_retrieve`. Authentication: `ApiKeyAuth`.

#### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | integer | Yes |  |

#### Responses

| Status | Description | Body |
| --- | --- | --- |
| `200` |  | [`AddressCheck`](#schema-AddressCheck) (`application/json`) |

#### Example

```bash
curl "https://api.horizonlogistics.eu/api/address-checks/orders/{id}/" \
  -H "Authorization: Api-Key $HORIZON_API_KEY"
```

## Schemas

The objects the operations above send and receive. Fields of a nested object are listed under their parent (`address.city`, `lines[].sku`); a nested named object links to its own entry.

### <span class="nh-anchor" id="schema-AddressCheck">AddressCheck</span>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `effective` | [`CheckedAddress`](#schema-CheckedAddress) | Yes |  |
| `order_id` | integer | Yes |  |
| `enabled` | boolean | Yes | Address checks are switched on for the account. |
| `current` | boolean | Yes | The latest check is of the order's address as it is now. |
| `record` | any, nullable | Yes | The latest check, or null when the address was never checked. Its `input_hash` identifies the address checked. |
| `summary` | [`AddressCheckSummary`](#schema-AddressCheckSummary), nullable | Yes |  |
| `effective_source` | string (enum) | Yes | Where the address the carrier gets comes from.; `original` - original; `corrected` - corrected; `accepted` - accepted; `kept` - kept; `edited` - edited. One of: `original`, `corrected`, `accepted`, `kept`, `edited`. |
| `actions` | [`AddressCheckActions`](#schema-AddressCheckActions) | Yes | The decisions available now. |
| `has_label` | boolean | Yes |  |
| `automation_held` | boolean | Yes | An automatic label waits for a decision on the address. |

### <span class="nh-anchor" id="schema-AddressCheckActions">AddressCheckActions</span>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `accept` | boolean | Yes |  |
| `keep` | boolean | Yes |  |
| `reset` | boolean | Yes |  |
| `recheck` | boolean | Yes |  |

### <span class="nh-anchor" id="schema-AddressCheckSummary">AddressCheckSummary</span>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `status` | string (enum) | Yes | `valid` - valid; `corrected` - corrected; `needs_review` - needs_review; `invalid` - invalid; `unchecked` - unchecked; `confirmed` - confirmed. |
| `blocking` | boolean | Yes | The check holds the order's label. |
| `reason_codes` | array of string | Yes |  |
| `has_suggestion` | boolean | Yes |  |
| `resolution` | string, nullable | Yes | The decision taken on the address, if any. |
| `checked_at` | string (date-time), nullable | Yes |  |
| `stale` | boolean | Yes | The address changed since it was checked. |
| `depth` | string | Yes |  |
| `shippable` | boolean | Yes |  |

### <span class="nh-anchor" id="schema-CheckedAddress">CheckedAddress</span>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `recipient_name` | string | Yes |  |
| `company` | string | Yes |  |
| `address1` | string | Yes |  |
| `address2` | string | Yes |  |
| `city` | string | Yes |  |
| `postal_code` | string | Yes |  |
| `province_code` | string | Yes |  |
| `province_name` | string | Yes |  |
| `country` | string | Yes |  |
| `phone` | string | Yes |  |