Get Address Requirement#

Returns a single address requirement.

Request#

HTTP Method: GET

URI Path: /v3/address_requirements/{id}

Note

For all returned data attributes, see Address Requirement Object.

URI Query Parameters#

Name

Type

Is Required?

Description

id

string

Yes

Unique ID identifier of the Address Requirement.

include

string

No

Inclusion

fields[address_requirements]

string

No

Sparse fieldsets

Includes#

Value

Description

country

Country Object

personal_permanent_document

Supporting Document Template Object

business_permanent_document

Supporting Document Template Object

personal_onetime_document

Supporting Document Template Object

business_onetime_document

Supporting Document Template Object

personal_proof_types

Proof Type Object

business_proof_types

Proof Type Object

address_proof_types

Proof Type Object

Example#

http

1GET /v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171 HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]

curl

1curl -i -X GET https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171 -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5    "data": {
 6        "id": "d210e6e4-1716-4342-b04c-7a6ef6feb171",
 7        "type": "address_requirements",
 8        "attributes": {
 9            "number_type": "local",
10            "identity_type": "business",
11            "personal_area_level": null,
12            "business_area_level": "world_wide",
13            "address_area_level": "area",
14            "personal_proof_qty": 0,
15            "business_proof_qty": 1,
16            "address_proof_qty": 1,
17            "personal_mandatory_fields": [],
18            "business_mandatory_fields": [],
19            "service_description_required": true,
20            "restriction_message": "Ireland Local DID registration requirements:\r\n\r\n1. Name, business name and contact phone number.\r\n2. Current address in Ireland, must be from the same area in Ireland as DID ordered (street, building number, postal code, city).\r\n\r\nDID number will not be activated until full registration details are provided and approved."
21        },
22        "relationships": {
23            "country": {
24                "links": {
25                    "self": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/country",
26                    "related": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/country"
27                }
28            },
29            "personal_permanent_document": {
30                "links": {
31                    "self": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_permanent_document",
32                    "related": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_permanent_document"
33                }
34            },
35            "business_permanent_document": {
36                "links": {
37                    "self": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_permanent_document",
38                    "related": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_permanent_document"
39                }
40            },
41            "personal_onetime_document": {
42                "links": {
43                    "self": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_onetime_document",
44                    "related": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_onetime_document"
45                }
46            },
47            "business_onetime_document": {
48                "links": {
49                    "self": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_onetime_document",
50                    "related": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_onetime_document"
51                }
52            },
53            "personal_proof_types": {
54                "links": {
55                    "self": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_proof_types",
56                    "related": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_proof_types"
57                }
58            },
59            "business_proof_types": {
60                "links": {
61                    "self": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_proof_types",
62                    "related": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_proof_types"
63                }
64            },
65            "address_proof_types": {
66                "links": {
67                    "self": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/address_proof_types",
68                    "related": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/address_proof_types"
69                }
70            }
71        }
72    },
73    "meta": {
74        "api_version": "2026-11-19"
75    }
76}

Other Responses#

Code

Success

Description

404

No

Not Found. No address requirement with that id.

401

No

Unauthorized

429

No

The request budget of the account for the current window is spent (too_many_requests). Retry-After gives the number of seconds to wait.