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>] |
|
No |
|
include |
|
No |
|
sort |
|
No |
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 |
Fielding:
Value |
Returns: |
---|---|
city_name |
The |
postal_code |
The |
address |
The |
description |
The |
created_at |
The |
verified |
The |
Examples
GET /v3/addresses HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
curl -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"
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0",
"type": "addresses",
"attributes": {
"city_name": "Antwerp",
"postal_code": "4641PA",
"address": "49th Ave",
"description": "Address of Rise Industries",
"created_at": "2020-09-16T10:23:07.846Z"
},
"relationships": {
"identity": {
"links": {
"self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/identity",
"related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/identity"
}
},
"country": {
"links": {
"self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/country",
"related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/country"
}
},
"proofs": {
"links": {
"self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/proofs",
"related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/proofs"
}
},
"area": {
"links": {
"self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/area",
"related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/area"
}
},
"city": {
"links": {
"self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/city",
"related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/city"
}
}
}
},
{
"id": "f3f18701-356b-43dc-8a96-82d07af415cf",
"type": "addresses",
"attributes": {
"city_name": "Galway",
"postal_code": "Galway 17",
"address": "Street 15",
"description": "Headquarters",
"created_at": "2020-09-22T11:57:05.524Z"
},
"relationships": {
"identity": {
"links": {
"self": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/identity",
"related": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/identity"
}
},
"country": {
"links": {
"self": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/country",
"related": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/country"
}
},
"proofs": {
"links": {
"self": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/proofs",
"related": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/proofs"
}
},
"area": {
"links": {
"self": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/area",
"related": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/area"
}
},
"city": {
"links": {
"self": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/relationships/city",
"related": "https://sandbox-api.didww.com/v3/addresses/f3f18701-356b-43dc-8a96-82d07af415cf/city"
}
}
}
},
{
"id": "54c92d8e-f135-4b55-ac48-748d44437509",
"type": "addresses",
"attributes": {
"city_name": "Dublin",
"postal_code": "Dublin 8",
"address": "10/13 Thomas Street",
"description": "My Business Address",
"created_at": "2020-09-14T07:29:41.413Z"
},
"relationships": {
"identity": {
"links": {
"self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/identity",
"related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/identity"
}
},
"country": {
"links": {
"self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/country",
"related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/country"
}
},
"proofs": {
"links": {
"self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/proofs",
"related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/proofs"
}
},
"area": {
"links": {
"self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/area",
"related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/area"
}
},
"city": {
"links": {
"self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/city",
"related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/city"
}
}
}
}
],
"meta": {
"total_records": 3,
"api_version": "2022-05-10"
},
"links": {
"first": "https://sandbox-api.didww.com/v3/addresses?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"last": "https://sandbox-api.didww.com/v3/addresses?page%5Bnumber%5D=1&page%5Bsize%5D=50"
}
}
GET /v3/addresses?filter%5Bcountry.id%5D=38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
curl -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"
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [ {
"id": "6f73fecd-6a7b-4440-93d7-41e0000baee0",
"type": "addresses",
"attributes": {
"city_name": "Berlin",
"postal_code": "13089",
"address": "Leopoldstraße 38, Berlin Heinersdorf,Berlin",
"description": "none",
"created_at": "2021-06-08T08:38:25.433Z",
"verified": false
},
"relationships": {
"identity": {"links": {
"self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/identity",
"related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/identity"
}},
"country": {"links": {
"self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/country",
"related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/country"
}},
"proofs": {"links": {
"self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/proofs",
"related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/proofs"
}},
"area": {"links": {
"self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/area",
"related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/area"
}},
"city": {"links": {
"self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/city",
"related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/city"
}}
}
}],
"meta": {
"total_records": 1,
"api_version": "2022-05-10"
},
"links": {
"first": "https://api.didww.com/v3/addresses?filter%5Bcountry.id%5D=38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f&page%5Bnumber%5D=1&page%5Bsize%5D=50",
"last": "https://api.didww.com/v3/addresses?filter%5Bcountry.id%5D=38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f&page%5Bnumber%5D=1&page%5Bsize%5D=50"
}
}
GET /v3/addresses?include=country HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
curl -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"
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [ {
"id": "6f73fecd-6a7b-4440-93d7-41e0000baee0",
"type": "addresses",
"attributes": {
"city_name": "Berlin",
"postal_code": "13089",
"address": "Leopoldstraße 38, Berlin Heinersdorf,Berlin",
"description": "none",
"created_at": "2021-06-08T08:38:25.433Z",
"verified": false
},
"relationships": {
"identity": {"links": {
"self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/identity",
"related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/identity"
}},
"country": {
"links": {
"self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/country",
"related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/country"
},
"data": {
"type": "countries",
"id": "38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f"
}
},
"proofs": {"links": {
"self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/proofs",
"related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/proofs"
}},
"area": {"links": {
"self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/area",
"related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/area"
}},
"city": {"links": {
"self": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/relationships/city",
"related": "https://api.didww.com/v3/addresses/6f73fecd-6a7b-4440-93d7-41e0000baee0/city"
}}
}
}],
"included": [ {
"id": "38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f",
"type": "countries",
"attributes": {
"name": "Germany",
"prefix": "49",
"iso": "DE"
},
"relationships": {"regions": {"links": {
"self": "https://api.didww.com/v3/countries/38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f/relationships/regions",
"related": "https://api.didww.com/v3/countries/38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f/regions"
}}}
}],
"meta": {
"total_records": 1,
"api_version": "2022-05-10"
},
"links": {
"first": "https://api.didww.com/v3/addresses?include=country&page%5Bnumber%5D=1&page%5Bsize%5D=50",
"last": "https://api.didww.com/v3/addresses?include=country&page%5Bnumber%5D=1&page%5Bsize%5D=50"
}
}
Other Responses
Code |
Success |
Description |
---|---|---|
401 |
No |