Get Address#

Returns a single Address in the account.

Request#

HTTP Method: GET

URI Path: /v3/addresses/

URI Query Parameters#

Name

Type

Is Required?

Description

id

string

Yes

Unique ID identifier of the Addresses.

include

string

No

Inclusion.

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

Proofs Object

identity.permanent_documents

Permanent Documents Object

identity.permanent_documents.template

Supporting Document Template Object

area

Area Object

city

City Object

Examples#

http

1GET /v3/addresses/0083c7f2-b030-491f-91b3-54597967ca38 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/0083c7f2-b030-491f-91b3-54597967ca38 -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": "54c92d8e-f135-4b55-ac48-748d44437509",
 7        "type": "addresses",
 8        "attributes": {
 9            "city_name": "Dublin",
10            "postal_code": "Dublin 8",
11            "address": "10/13 Thomas Street",
12            "description": "My Business Address",
13            "created_at": "2020-09-14T07:29:41.413Z"
14        },
15        "relationships": {
16            "identity": {
17                "links": {
18                    "self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/identity",
19                    "related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/identity"
20                }
21            },
22            "country": {
23                "links": {
24                    "self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/country",
25                    "related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/country"
26                }
27            },
28            "proofs": {
29                "links": {
30                    "self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/proofs",
31                    "related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/proofs"
32                }
33            },
34            "area": {
35              "links": {
36                "self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/area",
37                "related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/area"
38              }
39            },
40            "city": {
41              "links": {
42                "self": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/city",
43                "related": "https://sandbox-api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/city"
44              }
45            }
46        }
47    },
48    "meta": {
49        "api_version": "2022-05-10"
50    }
51}

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized