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.

URI Query Parameters#

Name

Type

Is Required?

Description

include

string

No

Inclusion

filter[<filter_name>]

string

No

Filtering

fields[addresses]

string

No

Sparse fieldsets

sort

string

No

Sorting

page[number]

integer

No

Page number.

page[size]

integer

No

Page size. Pagination defaults to 50 records per page. The maximum is 100.

Includes#

Value

Description

country

Country Object

proofs

Proofs Object

proofs.proof_type

Proof Types Object

identity

Identities Object

identity.country

Country Object

identity.proofs

Proofs Object

identity.proofs.proof_type

Proof Types Object

identity.permanent_documents

Permanent Documents Object

identity.permanent_documents.template

Supporting Document Template Object

area

Area Object

city

City Object

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#

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}

Other Responses#

Code

Success

Description

400

No

Bad Request. Malformed request: unknown filter, bad pagination or bad sort field.

401

No

Unauthorized

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.