Get Address
GET https://{{host}}/v3/addresses/:id
Returns a single Address in the account.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
include | null | Comma-separated values of include parameter. | |
The response will include a top-level object relationships with associated data under the appropriate resource key. | |||
| Details in Inclusion of Related Resources Article. |
Allowed values:
country - Country Object
proofs - Proof Object
proofs.proof_type - Proof Type Object
identity - Identity Object
identity.country - Country Object
identity.proofs - Proof Object
identity.proofs.proof_type - Proof Type Object
identity.permanent_documents - Permanent Document Object
identity.permanent_documents.template - Supporting Document Template Object
area - Area Object
city - City Object |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
Content-Type | string | ||
Api-Key | string |
RESPONSES
status: OK
{"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},"relationships":{"identity":{"links":{"self":"https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/identity","related":"https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/identity"}},"country":{"links":{"self":"https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/country","related":"https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/country"}},"proofs":{"links":{"self":"https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/proofs","related":"https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/proofs"}},"area":{"links":{"self":"https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/area","related":"https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/area"}},"city":{"links":{"self":"https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/relationships/city","related":"https://api.didww.com/v3/addresses/54c92d8e-f135-4b55-ac48-748d44437509/city"}}}},"meta":{"api_version":"2021-04-19"}}