Get Addresses#
Description
Returns a list of Addresses on your account.
Request#
HTTP Method: GET
URI Path: /v3/addresses
URI Query Parameters:
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
filter[<filter_name>] |
|
Optional |
|
include |
|
Optional |
|
sort |
|
Optional |
Includes:
Value |
Description |
|---|---|
country |
|
proofs |
|
proofs.proof_type |
|
identity |
|
identity.country |
|
identity.proofs |
|
identity.proofs.proof_type |
|
identity.permanent_documents |
|
identity.permanent_documents.template |
|
area |
|
city |
Filters:
Filter Name |
Type |
Allow Blank |
Allow Array |
Filters by: |
|---|---|---|---|---|
city_name |
|
Yes |
No |
The |
city_name_contains |
|
Yes |
No |
The |
postal_code |
|
Yes |
No |
The |
postal_code_contains |
|
Yes |
No |
The |
address |
|
Yes |
No |
The |
address_contains |
|
Yes |
No |
The |
description |
|
Yes |
No |
The |
description_contains |
|
Yes |
No |
The |
identity.id |
|
Yes |
Yes |
The |
country.id |
|
Yes |
Yes |
The |
area.id |
|
Yes |
Yes |
The |
city.id |
|
Yes |
Yes |
The |
Sorting:
Value |
Sorts by: |
|---|---|
city_name |
The |
postal_code |
The |
address |
The |
description |
The |
Sparse Fieldsets:
Value |
Returns: |
|---|---|
city_name |
The |
postal_code |
The |
address |
The |
description |
The |
created_at |
The |
verified |
The |
Examples#
http
1GET /v3/addresses HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
curl
1curl -i -X GET https://api.didww.com/v3/addresses -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
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 },
16 "relationships": {
17 "identity": {
18 "links": {
19 "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/identity",
20 "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/identity"
21 }
22 },
23 "country": {
24 "links": {
25 "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/country",
26 "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/country"
27 }
28 },
29 "proofs": {
30 "links": {
31 "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/proofs",
32 "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/proofs"
33 }
34 },
35 "area": {
36 "links": {
37 "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/area",
38 "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/area"
39 }
40 },
41 "city": {
42 "links": {
43 "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/city",
44 "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/city"
45 }
46 }
47 }
48 },
49 {
50 "id": "f3f18701-356b-43dc-8a96-82d07af415cf",
51 "type": "addresses",
52 "attributes": {
53 "city_name": "Galway",
54 "postal_code": "Galway 17",
55 "address": "Street 15",
56 "description": "Headquarters",
57 "created_at": "2020-09-22T11:57:05.524Z"
58 },
59 "relationships": {
60 "identity": {
61 "links": {
62 "self": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/identity",
63 "related": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/identity"
64 }
65 },
66 "country": {
67 "links": {
68 "self": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/country",
69 "related": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/country"
70 }
71 },
72 "proofs": {
73 "links": {
74 "self": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/proofs",
75 "related": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/proofs"
76 }
77 },
78 "area": {
79 "links": {
80 "self": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/area",
81 "related": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/area"
82 }
83 },
84 "city": {
85 "links": {
86 "self": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/city",
87 "related": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/city"
88 }
89 }
90 }
91 },
92 {
93 "id": "54c92d8e-f135-4b55-ac48-748d44437509",
94 "type": "addresses",
95 "attributes": {
96 "city_name": "Dublin",
97 "postal_code": "Dublin 8",
98 "address": "10/13 Thomas Street",
99 "description": "My Business Address",
100 "created_at": "2020-09-14T07:29:41.413Z"
101 },
102 "relationships": {
103 "identity": {
104 "links": {
105 "self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/identity",
106 "related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/identity"
107 }
108 },
109 "country": {
110 "links": {
111 "self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/country",
112 "related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/country"
113 }
114 },
115 "proofs": {
116 "links": {
117 "self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/proofs",
118 "related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/proofs"
119 }
120 },
121 "area": {
122 "links": {
123 "self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/area",
124 "related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/area"
125 }
126 },
127 "city": {
128 "links": {
129 "self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/city",
130 "related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/city"
131 }
132 }
133 }
134 }
135 ],
136 "meta": {
137 "total_records": 3,
138 "api_version": "2021-12-15"
139 },
140 "links": {
141 "first": "https://sandbox-api.didww.com/v3/addresses?page%5Bnumber%5D=1&page%5Bsize%5D=50",
142 "last": "https://sandbox-api.didww.com/v3/addresses?page%5Bnumber%5D=1&page%5Bsize%5D=50"
143 }
144 }
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
5Api-Key: [API 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 "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
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 },
16 "relationships": {
17 "identity": {"links": {
18 "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/identity",
19 "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/identity"
20 }},
21 "country": {"links": {
22 "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/country",
23 "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/country"
24 }},
25 "proofs": {"links": {
26 "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/proofs",
27 "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/proofs"
28 }},
29 "area": {"links": {
30 "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/area",
31 "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/area"
32 }},
33 "city": {"links": {
34 "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/city",
35 "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/city"
36 }}
37 }
38 }],
39 "meta": {
40 "total_records": 1,
41 "api_version": "2021-12-15"
42 },
43 "links": {
44 "first": "https://api.didww.com/v3/addresses?filter%5Bcountry.id%5D=38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f&page%5Bnumber%5D=1&page%5Bsize%5D=50",
45 "last": "https://api.didww.com/v3/addresses?filter%5Bcountry.id%5D=38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f&page%5Bnumber%5D=1&page%5Bsize%5D=50"
46 }
47 }
http
1GET /v3/addresses?include=country HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
curl
1curl -i -X GET 'https://api.didww.com/v3/addresses?include=country' -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
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 },
16 "relationships": {
17 "identity": {"links": {
18 "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/identity",
19 "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/identity"
20 }},
21 "country": {
22 "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 "data": {
27 "type": "countries",
28 "id": "38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f"
29 }
30 },
31 "proofs": {"links": {
32 "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/proofs",
33 "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/proofs"
34 }},
35 "area": {"links": {
36 "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/area",
37 "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/area"
38 }},
39 "city": {"links": {
40 "self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/city",
41 "related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/city"
42 }}
43 }
44 }],
45 "included": [ {
46 "id": "38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f",
47 "type": "countries",
48 "attributes": {
49 "name": "Germany",
50 "prefix": "49",
51 "iso": "DE"
52 },
53 "relationships": {"regions": {"links": {
54 "self": "https://api.didww.com/v3/countries/38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f/relationships/regions",
55 "related": "https://api.didww.com/v3/countries/38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f/regions"
56 }}}
57 }],
58 "meta": {
59 "total_records": 1,
60 "api_version": "2021-12-15"
61 },
62 "links": {
63 "first": "https://api.didww.com/v3/addresses?include=country&page%5Bnumber%5D=1&page%5Bsize%5D=50",
64 "last": "https://api.didww.com/v3/addresses?include=country&page%5Bnumber%5D=1&page%5Bsize%5D=50"
65 }
66 }
Other Responses#
Code |
Success |
Description |
|---|---|---|
401 |
No |