# Address

The `Address` object represents a physical address associated with an entity. Addresses come in two formats depending on the source registry.

## Fields

### Metadata

| Field            | Type   | Description                               |
| ---------------- | ------ | ----------------------------------------- |
| `_addressFormat` | string | `raw` or `ISO20022`                       |
| `_addressType`   | string | See [Address Types](#address-types) below |

{% tabs %}
{% tab title="Raw Format" %}
Used when `_addressFormat` is `raw`:

| Field          | Type   | Description                         |
| -------------- | ------ | ----------------------------------- |
| `addressLine1` | string | Primary street address              |
| `addressLine2` | string | Secondary address line              |
| `building`     | string | Building name                       |
| `careOf`       | string | Care of / attention line            |
| `country`      | string | Country name or ISO code            |
| `fullAddress`  | string | Complete address as a single string |
| `locality`     | string | City or town                        |
| `poBox`        | string | PO Box number                       |
| `postcode`     | string | Postal / ZIP code                   |
| `region`       | string | Region or province                  |
| `state`        | string | State                               |
| {% endtab %}   |        |                                     |

{% tab title="ISO 20022 Format" %}
Used when `_addressFormat` is `ISO20022` (structured international format):

| Field         | Type   | Description          |
| ------------- | ------ | -------------------- |
| `dept`        | string | Department           |
| `subDept`     | string | Sub-department       |
| `strtNm`      | string | Street name          |
| `bldgNb`      | string | Building number      |
| `bldgNm`      | string | Building name        |
| `flr`         | string | Floor                |
| `pstBx`       | string | Post box             |
| `room`        | string | Room                 |
| `pstCd`       | string | Postal code          |
| `twnNm`       | string | Town name            |
| `twnLctnNm`   | string | Town location name   |
| `dstrctNm`    | string | District name        |
| `ctrySubDvsn` | string | Country sub-division |
| `ctry`        | string | Country (ISO code)   |
| {% endtab %}  |        |                      |
| {% endtabs %} |        |                      |

## Address Types

| Value                         | Description                                        |
| ----------------------------- | -------------------------------------------------- |
| `Registered Address`          | Official registered address                        |
| `Headquarters Address`        | Head office address                                |
| `Principal Place of Business` | Principal operating address                        |
| `Fiscal Address`              | Tax/fiscal address                                 |
| `Correspondence Address`      | Mailing address                                    |
| `Residential Address`         | Personal residential address (for natural persons) |

## Example

```json
{
  "_addressFormat": "raw",
  "_addressType": "Registered Address",
  "addressLine1": "7 Westferry Circus",
  "locality": "London",
  "postcode": "E14 4HD",
  "country": "GB"
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://equinoxe-systems.gitbook.io/revolutio-api/data-models/address.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.