Get Address

Returns a single Address in the 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

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

GET /v3/addresses/0083c7f2-b030-491f-91b3-54597967ca38 HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

curl

curl -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

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "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",
            "verified": false,
            "external_reference_id": null
        },
        "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": {
        "api_version": "2026-04-16"
    }
}

Other Responses

Code

Success

Description

404

No

Not Found

401

No

Unauthorized