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 |
|
Yes |
Unique ID identifier of the Address Requirement. |
include |
|
No |
Includes#
Value |
Description |
|---|---|
country |
|
did_group_type |
|
personal_permanent_document |
|
business_permanent_document |
|
personal_onetime_document |
|
business_onetime_document |
|
personal_proof_types |
|
business_proof_types |
|
address_proof_types |
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
5Api-Key: [API 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 "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": "d210e6e4-1716-4342-b04c-7a6ef6feb171",
7 "type": "address_requirements",
8 "attributes": {
9 "identity_type": "business",
10 "personal_area_level": null,
11 "business_area_level": "world_wide",
12 "address_area_level": "area",
13 "personal_proof_qty": 0,
14 "business_proof_qty": 1,
15 "address_proof_qty": 1,
16 "personal_mandatory_fields": null,
17 "business_mandatory_fields": null,
18 "service_description_required": true,
19 "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."
20 },
21 "relationships": {
22 "country": {
23 "links": {
24 "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/country",
25 "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/country"
26 }
27 },
28 "did_group_type": {
29 "links": {
30 "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/did_group_type",
31 "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/did_group_type"
32 }
33 },
34 "personal_permanent_document": {
35 "links": {
36 "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_permanent_document",
37 "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_permanent_document"
38 }
39 },
40 "business_permanent_document": {
41 "links": {
42 "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_permanent_document",
43 "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_permanent_document"
44 }
45 },
46 "personal_onetime_document": {
47 "links": {
48 "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_onetime_document",
49 "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_onetime_document"
50 }
51 },
52 "business_onetime_document": {
53 "links": {
54 "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_onetime_document",
55 "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_onetime_document"
56 }
57 },
58 "personal_proof_types": {
59 "links": {
60 "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_proof_types",
61 "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_proof_types"
62 }
63 },
64 "business_proof_types": {
65 "links": {
66 "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_proof_types",
67 "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_proof_types"
68 }
69 },
70 "address_proof_types": {
71 "links": {
72 "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/address_proof_types",
73 "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/address_proof_types"
74 }
75 }
76 }
77 },
78 "meta": {
79 "api_version": "2026-04-16"
80 }
81}
Other Responses#
Code |
Success |
Description |
|---|---|---|
401 |
No |