# Get Addresses

Returns a list of Addresses on your account.

## Request

HTTP Method: `GET`

URI Path: `/v3/addresses`

Note

For all returned data attributes, see [Address Object](address-object.html).

### URI Query Parameters

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| include | `string` | No | [Inclusion](../../../specification/includes.html#api-includes) |
| filter[<filter\_name>] | `string` | No | [Filtering](../../../specification/filtering.html#api-filters) |
| fields[addresses] | `string` | No | [Sparse fieldsets](../../../specification/sparse-fieldsets.html#api-sparse-fieldsets) |
| sort | `string` | No | [Sorting](../../../specification/sorting.html#api-sorting) |
| page[number] | `integer` | No | [Page number](../../../specification/pagination.html#api-pagination). |
| page[size] | `integer` | No | [Page size](../../../specification/pagination.html#api-pagination). Pagination defaults to `50` records per page. The maximum is `100`. |

### Includes

| Value | Description |
| --- | --- |
| country | [Country Object](../../coverage-resources/countries/country-object.html#country-object-v35) |
| proofs | [Proofs Object](../proofs/proofs-object.html#proofs-object-v35) |
| proofs.proof\_type | [Proof Types Object](../proof-types/proof-types-object.html#proof-types-object-v35) |
| identity | [Identities Object](../identities/identity-object.html#identity-object-v35) |
| identity.country | [Country Object](../../coverage-resources/countries/country-object.html#country-object-v35) |
| identity.proofs | [Proofs Object](../proofs/proofs-object.html#proofs-object-v35) |
| identity.proofs.proof\_type | [Proof Types Object](../proof-types/proof-types-object.html#proof-types-object-v35) |
| identity.permanent\_documents | [Permanent Documents Object](../permanent-documents/permanent-documents-object.html#permanent-documents-object-v35) |
| identity.permanent\_documents.template | [Supporting Document Template Object](../supporting-document-templates/supporting-document-templates-object.html#supporting-document-templates-object-v35) |
| area | [Area Object](../areas/area-object.html#area-object-v35) |
| city | [City Object](../../coverage-resources/city/city-object.html#city-object-v35) |

### Filters

| Filter Name | Type | Allow Blank | Allow Array | Filters by: |
| --- | --- | --- | --- | --- |
| id | `string` | No | Yes | The `id` field. |
| city\_name | `string` | Yes | No | The `city_name` field. |
| city\_name\_contains | `string` | Yes | No | The `city_name_contains` field. |
| postal\_code | `string` | Yes | No | The `postal_code` field. |
| postal\_code\_contains | `string` | Yes | No | The `postal_code_contains` field. |
| address | `string` | Yes | No | The `address` field. |
| address\_contains | `string` | Yes | No | The `address_contains` field. |
| description | `string` | Yes | No | The `description` field. |
| description\_contains | `string` | Yes | No | The `description_contains` field. |
| external\_reference\_id | `string` | No | No | The `external_reference_id` field. |
| identity.id | `string` | Yes | Yes | The `identity.id` field. |
| identity.external\_reference\_id | `string` | Yes | No | The `identity.external_reference_id` field. |
| country.id | `string` | Yes | Yes | The `country.id` field. |
| area.id | `string` | Yes | Yes | The `area.id` field. |
| city.id | `string` | Yes | Yes | The `city.id` field. |

### Sorting

| Value | Sorts by: |
| --- | --- |
| city\_name | The `city_name` field. |
| postal\_code | The `postal_code` field. |
| address | The `address` field. |
| description | The `description` field. |
| created\_at | The `created_at` field. |
| verified | The `verified` field. |
| external\_reference\_id | The `external_reference_id` field. |

## Examples

Simple RequestFilter by country.id (i.e. Germany)Include country

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/addresses HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]
```

curl

```
1curl -i -X GET https://api.didww.com/v3/addresses -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"
```

response

```
  1HTTP/1.1 200 OK
  2Content-Type: application/vnd.api+json
  3
  4{
  5  "data": [
  6    {
  7      "id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0",
  8      "type": "addresses",
  9      "attributes": {
 10        "city_name": "Antwerp",
 11        "postal_code": "4641PA",
 12        "address": "49th Ave",
 13        "description": "Address of Rise Industries",
 14        "created_at": "2020-09-16T10:23:07.846Z",
 15        "verified": false,
 16        "external_reference_id": null
 17      },
 18      "relationships": {
 19        "identity": {
 20          "links": {
 21            "self": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/identity",
 22            "related": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/identity"
 23          }
 24        },
 25        "country": {
 26          "links": {
 27            "self": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/country",
 28            "related": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/country"
 29          }
 30        },
 31        "proofs": {
 32          "links": {
 33            "self": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/proofs",
 34            "related": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/proofs"
 35          }
 36        },
 37        "area": {
 38          "links": {
 39            "self": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/area",
 40            "related": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/area"
 41          }
 42        },
 43        "city": {
 44          "links": {
 45            "self": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/city",
 46            "related": "https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/city"
 47          }
 48        }
 49      }
 50    },
 51    {
 52      "id": "f3f18701-356b-43dc-8a96-82d07af415cf",
 53      "type": "addresses",
 54      "attributes": {
 55        "city_name": "Galway",
 56        "postal_code": "Galway 17",
 57        "address": "Street 15",
 58        "description": "Headquarters",
 59        "created_at": "2020-09-22T11:57:05.524Z",
 60        "verified": false,
 61        "external_reference_id": null
 62      },
 63      "relationships": {
 64        "identity": {
 65          "links": {
 66            "self": "https://api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/identity",
 67            "related": "https://api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/identity"
 68          }
 69        },
 70        "country": {
 71          "links": {
 72            "self": "https://api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/country",
 73            "related": "https://api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/country"
 74          }
 75        },
 76        "proofs": {
 77          "links": {
 78            "self": "https://api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/proofs",
 79            "related": "https://api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/proofs"
 80          }
 81        },
 82        "area": {
 83          "links": {
 84            "self": "https://api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/area",
 85            "related": "https://api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/area"
 86          }
 87        },
 88        "city": {
 89          "links": {
 90            "self": "https://api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/city",
 91            "related": "https://api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/city"
 92          }
 93        }
 94      }
 95    },
 96    {
 97      "id": "54c92d8e-f135-4b55-ac48-748d44437509",
 98      "type": "addresses",
 99      "attributes": {
100        "city_name": "Dublin",
101        "postal_code": "Dublin 8",
102        "address": "10/13 Thomas Street",
103        "description": "My Business Address",
104        "created_at": "2020-09-14T07:29:41.413Z",
105        "verified": false,
106        "external_reference_id": null
107      },
108      "relationships": {
109        "identity": {
110          "links": {
111            "self": "https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/identity",
112            "related": "https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/identity"
113          }
114        },
115        "country": {
116          "links": {
117            "self": "https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/country",
118            "related": "https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/country"
119          }
120        },
121        "proofs": {
122          "links": {
123            "self": "https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/proofs",
124            "related": "https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/proofs"
125          }
126        },
127        "area": {
128          "links": {
129            "self": "https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/area",
130            "related": "https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/area"
131          }
132        },
133        "city": {
134          "links": {
135            "self": "https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/city",
136            "related": "https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/city"
137          }
138        }
139      }
140    }
141  ],
142  "meta": {
143    "total_records": 3,
144    "api_version": "2026-11-19"
145  },
146  "links": {
147    "first": "https://api.didww.com/v3/addresses?page%5Bnumber%5D=1&page%5Bsize%5D=50",
148    "last": "https://api.didww.com/v3/addresses?page%5Bnumber%5D=1&page%5Bsize%5D=50"
149  }
150}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/addresses?filter%5Bcountry.id%5D=38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]
```

curl

```
1curl -i -X GET 'https://api.didww.com/v3/addresses?filter%5Bcountry.id%5D=38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f' -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"
```

response

```
 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4    {
 5       "data": [   {
 6          "id": "6f73fecd-6a7b-4440-93d7-41e0000baee0",
 7          "type": "addresses",
 8          "attributes":       {
 9             "city_name": "Berlin",
10             "postal_code": "13089",
11             "address": "LeopoldstraÃŸe 38, Berlin Heinersdorf,Berlin",
12             "description": "none",
13             "created_at": "2021-06-08T08:38:25.433Z",
14             "verified": false,
15             "external_reference_id": null
16          },
17          "relationships":       {
18             "identity": {"links":          {
19                "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/identity",
20                "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/identity"
21             }},
22             "country": {"links":          {
23                "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/country",
24                "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/country"
25             }},
26             "proofs": {"links":          {
27                "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/proofs",
28                "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/proofs"
29             }},
30             "area": {"links":          {
31                "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/area",
32                "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/area"
33             }},
34             "city": {"links":          {
35                "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/city",
36                "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/city"
37             }}
38          }
39       }],
40       "meta":    {
41          "total_records": 1,
42          "api_version": "2026-11-19"
43       },
44       "links":    {
45          "first": "https://api.didww.com/v3/addresses?filter%5Bcountry.id%5D=38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f&page%5Bnumber%5D=1&page%5Bsize%5D=50",
46          "last": "https://api.didww.com/v3/addresses?filter%5Bcountry.id%5D=38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f&page%5Bnumber%5D=1&page%5Bsize%5D=50"
47       }
48    }
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/addresses?include=country HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]
```

curl

```
1curl -i -X GET 'https://api.didww.com/v3/addresses?include=country' -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"
```

response

```
 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4    {
 5       "data": [   {
 6          "id": "6f73fecd-6a7b-4440-93d7-41e0000baee0",
 7          "type": "addresses",
 8          "attributes":       {
 9             "city_name": "Berlin",
10             "postal_code": "13089",
11             "address": "LeopoldstraÃŸe 38, Berlin Heinersdorf,Berlin",
12             "description": "none",
13             "created_at": "2021-06-08T08:38:25.433Z",
14             "verified": false,
15             "external_reference_id": null
16          },
17          "relationships":       {
18             "identity": {"links":          {
19                "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/identity",
20                "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/identity"
21             }},
22             "country":          {
23                "links":             {
24                   "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/country",
25                   "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/country"
26                },
27                "data":             {
28                   "type": "countries",
29                   "id": "38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f"
30                }
31             },
32             "proofs": {"links":          {
33                "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/proofs",
34                "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/proofs"
35             }},
36             "area": {"links":          {
37                "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/area",
38                "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/area"
39             }},
40             "city": {"links":          {
41                "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/city",
42                "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/city"
43             }}
44          }
45       }],
46       "included": [   {
47          "id": "38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f",
48          "type": "countries",
49          "attributes":       {
50             "name": "Germany",
51             "prefix": "49",
52             "iso": "DE"
53          },
54          "relationships": {"regions": {"links":       {
55             "self": "https://api.didww.com/v3/countries/38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f/relationships/regions",
56             "related": "https://api.didww.com/v3/countries/38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f/regions"
57          }}}
58       }],
59       "meta":    {
60          "total_records": 1,
61          "api_version": "2026-11-19"
62       },
63       "links":    {
64          "first": "https://api.didww.com/v3/addresses?include=country&page%5Bnumber%5D=1&page%5Bsize%5D=50",
65          "last": "https://api.didww.com/v3/addresses?include=country&page%5Bnumber%5D=1&page%5Bsize%5D=50"
66       }
67    }
```

[[DIDWW-API-EXAMPLE-END]]

## Other Responses

| Code | Success | Description |
| --- | --- | --- |
| 400 | No | [Bad Request](../../../specification/errors/index.html#api-bad-request). Malformed request: unknown filter, bad pagination or bad sort field. |
| 401 | No | [Unauthorized](../../authentication.html#authentication-v35) |
| 429 | No | The request budget of the account for the current window is spent (`too_many_requests`). `Retry-After` gives the number of seconds to wait. |
