Get Address Requirements#
Returns the list of address requirements.
Request#
HTTP Method: GET
URI Path: /v3/address_requirements
Note
For all returned data attributes, see Address Requirement Object.
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
include |
|
No |
|
filter[<filter_name>] |
|
No |
|
fields[address_requirements] |
|
No |
|
sort |
|
No |
|
page[number] |
|
No |
|
page[size] |
|
No |
Page size. Pagination defaults to |
Includes#
Value |
Description |
|---|---|
country |
|
personal_permanent_document |
|
business_permanent_document |
|
personal_onetime_document |
|
business_onetime_document |
|
personal_proof_types |
|
business_proof_types |
|
address_proof_types |
Filters#
Filter Name |
Type |
Allow Blank |
Allow Array |
Filters by: |
|---|---|---|---|---|
id |
|
No |
Yes |
Address requirement |
country.id |
|
Yes |
Yes |
The |
number_type |
|
No |
Yes |
Address requirement |
Sorting#
Value |
Sorts by: |
|---|---|
address_proof_qty |
The |
business_proof_qty |
The |
personal_proof_qty |
The |
restriction_message |
The |
service_description_required |
The |
Available Mandatory Fields#
Important
The personal_mandatory_fields and business_mandatory_fields arrays in the response may contain a selection of the fields listed below, depending on the specific requirement. An array is empty when none are mandatory, never null.
Value |
Description |
|---|---|
birth_date |
The user’s date of birth. |
country |
The user’s country of tax residence. |
birth_country |
The user’s country of birth. |
id_number |
The user’s national identification number. |
personal_tax_id |
The user’s personal tax identification number. |
contact_email |
The user’s contact email address. |
Value |
Description |
|---|---|
id_number |
The national ID number of the company’s legal representative. |
tax_id |
The company’s Value Added Tax (VAT) identification number. Supply it as the Identity |
country |
The country where the company is registered. |
company_reg_number |
The company’s official registration number. |
personal_tax_id |
The personal tax ID of the company’s legal representative. |
contact_email |
The contact email of the company’s representative. |
Example#
http
1GET /v3/address_requirements 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 -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 {
7 "id": "3f3be6a6-a513-4509-bd9b-945e599e16f5",
8 "type": "address_requirements",
9 "attributes": {
10 "number_type": "local",
11 "identity_type": "any",
12 "personal_area_level": "world_wide",
13 "business_area_level": "world_wide",
14 "address_area_level": "area",
15 "personal_proof_qty": 0,
16 "business_proof_qty": 0,
17 "address_proof_qty": 0,
18 "personal_mandatory_fields": [],
19 "business_mandatory_fields": [],
20 "service_description_required": true,
21 "restriction_message": "Restriction message"
22 },
23 "relationships": {
24 "country": {
25 "links": {
26 "self": "https://api.didww.com/v3/address_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/country",
27 "related": "https://api.didww.com/v3/address_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/country"
28 }
29 },
30 "personal_permanent_document": {
31 "links": {
32 "self": "https://api.didww.com/v3/address_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/personal_permanent_document",
33 "related": "https://api.didww.com/v3/address_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/personal_permanent_document"
34 }
35 },
36 "business_permanent_document": {
37 "links": {
38 "self": "https://api.didww.com/v3/address_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/business_permanent_document",
39 "related": "https://api.didww.com/v3/address_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/business_permanent_document"
40 }
41 },
42 "personal_onetime_document": {
43 "links": {
44 "self": "https://api.didww.com/v3/address_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/personal_onetime_document",
45 "related": "https://api.didww.com/v3/address_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/personal_onetime_document"
46 }
47 },
48 "business_onetime_document": {
49 "links": {
50 "self": "https://api.didww.com/v3/address_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/business_onetime_document",
51 "related": "https://api.didww.com/v3/address_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/business_onetime_document"
52 }
53 },
54 "personal_proof_types": {
55 "links": {
56 "self": "https://api.didww.com/v3/address_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/personal_proof_types",
57 "related": "https://api.didww.com/v3/address_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/personal_proof_types"
58 }
59 },
60 "business_proof_types": {
61 "links": {
62 "self": "https://api.didww.com/v3/address_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/business_proof_types",
63 "related": "https://api.didww.com/v3/address_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/business_proof_types"
64 }
65 },
66 "address_proof_types": {
67 "links": {
68 "self": "https://api.didww.com/v3/address_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/address_proof_types",
69 "related": "https://api.didww.com/v3/address_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/address_proof_types"
70 }
71 }
72 }
73 },
74 {
75 "id": "d210e6e4-1716-4342-b04c-7a6ef6feb171",
76 "type": "address_requirements",
77 "attributes": {
78 "number_type": "local",
79 "identity_type": "business",
80 "personal_area_level": null,
81 "business_area_level": "world_wide",
82 "address_area_level": "area",
83 "personal_proof_qty": 0,
84 "business_proof_qty": 1,
85 "address_proof_qty": 1,
86 "personal_mandatory_fields": [],
87 "business_mandatory_fields": [],
88 "service_description_required": true,
89 "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."
90 },
91 "relationships": {
92 "country": {
93 "links": {
94 "self": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/country",
95 "related": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/country"
96 }
97 },
98 "personal_permanent_document": {
99 "links": {
100 "self": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_permanent_document",
101 "related": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_permanent_document"
102 }
103 },
104 "business_permanent_document": {
105 "links": {
106 "self": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_permanent_document",
107 "related": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_permanent_document"
108 }
109 },
110 "personal_onetime_document": {
111 "links": {
112 "self": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_onetime_document",
113 "related": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_onetime_document"
114 }
115 },
116 "business_onetime_document": {
117 "links": {
118 "self": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_onetime_document",
119 "related": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_onetime_document"
120 }
121 },
122 "personal_proof_types": {
123 "links": {
124 "self": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_proof_types",
125 "related": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_proof_types"
126 }
127 },
128 "business_proof_types": {
129 "links": {
130 "self": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_proof_types",
131 "related": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_proof_types"
132 }
133 },
134 "address_proof_types": {
135 "links": {
136 "self": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/address_proof_types",
137 "related": "https://api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/address_proof_types"
138 }
139 }
140 }
141 }
142 ],
143 "meta": {
144 "total_records": 2,
145 "api_version": "2026-11-19"
146 },
147 "links": {
148 "first": "https://api.didww.com/v3/address_requirements?page%5Bnumber%5D=1&page%5Bsize%5D=50",
149 "last": "https://api.didww.com/v3/address_requirements?page%5Bnumber%5D=1&page%5Bsize%5D=50"
150 }
151}
http
1GET /v3/address_requirements?filter%5Bcountry.id%5D=38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f 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?filter%5Bcountry.id%5D=38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f' -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 {
7 "id": "3553253a-99eb-4303-a16a-6b1042d3f147",
8 "type": "address_requirements",
9 "attributes": {
10 "number_type": "national",
11 "identity_type": "any",
12 "personal_area_level": "world_wide",
13 "business_area_level": "country",
14 "address_area_level": "country",
15 "personal_proof_qty": 1,
16 "business_proof_qty": 1,
17 "address_proof_qty": 1,
18 "personal_mandatory_fields": [],
19 "business_mandatory_fields": ["country"],
20 "service_description_required": false,
21 "restriction_message": "German National DID End User registration requirements:<br>\r\nFor <b>personal identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Passport or ID copy\r\n* Germany registration form<br>\r\nFor <b>business identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Company name\r\n* German company incorporation certificate copy\r\n* Germany registration form<br>\r\nFor <b>address<\/b> verification:\r\n* Address in Germany (street, building number, postal code, city and country)\r\n* A copy of a utility bill (less than 6 months old)<br>\r\nThe number provided online is a <b>demo<\/b>. An active number will be provided when the registration process is complete.<br>\r\nTo activate the DID number(s) please create an identity and address bundle matching the requirements and assign it to the DID number(s) for approval.<br>\r\nWe reserve the right in our sole discretion to request additional information at any stage of the registration process.<br>\r\n"
22 },
23 "relationships": {
24 "country": {"links": {
25 "self": "https://api.didww.com/v3/address_requirements/3553253a-99eb-4303-a16a-6b1042d3f147/relationships/country",
26 "related": "https://api.didww.com/v3/address_requirements/3553253a-99eb-4303-a16a-6b1042d3f147/country"
27 }},
28 "personal_permanent_document": {"links": {
29 "self": "https://api.didww.com/v3/address_requirements/3553253a-99eb-4303-a16a-6b1042d3f147/relationships/personal_permanent_document",
30 "related": "https://api.didww.com/v3/address_requirements/3553253a-99eb-4303-a16a-6b1042d3f147/personal_permanent_document"
31 }},
32 "business_permanent_document": {"links": {
33 "self": "https://api.didww.com/v3/address_requirements/3553253a-99eb-4303-a16a-6b1042d3f147/relationships/business_permanent_document",
34 "related": "https://api.didww.com/v3/address_requirements/3553253a-99eb-4303-a16a-6b1042d3f147/business_permanent_document"
35 }},
36 "personal_onetime_document": {"links": {
37 "self": "https://api.didww.com/v3/address_requirements/3553253a-99eb-4303-a16a-6b1042d3f147/relationships/personal_onetime_document",
38 "related": "https://api.didww.com/v3/address_requirements/3553253a-99eb-4303-a16a-6b1042d3f147/personal_onetime_document"
39 }},
40 "business_onetime_document": {"links": {
41 "self": "https://api.didww.com/v3/address_requirements/3553253a-99eb-4303-a16a-6b1042d3f147/relationships/business_onetime_document",
42 "related": "https://api.didww.com/v3/address_requirements/3553253a-99eb-4303-a16a-6b1042d3f147/business_onetime_document"
43 }},
44 "personal_proof_types": {"links": {
45 "self": "https://api.didww.com/v3/address_requirements/3553253a-99eb-4303-a16a-6b1042d3f147/relationships/personal_proof_types",
46 "related": "https://api.didww.com/v3/address_requirements/3553253a-99eb-4303-a16a-6b1042d3f147/personal_proof_types"
47 }},
48 "business_proof_types": {"links": {
49 "self": "https://api.didww.com/v3/address_requirements/3553253a-99eb-4303-a16a-6b1042d3f147/relationships/business_proof_types",
50 "related": "https://api.didww.com/v3/address_requirements/3553253a-99eb-4303-a16a-6b1042d3f147/business_proof_types"
51 }},
52 "address_proof_types": {"links": {
53 "self": "https://api.didww.com/v3/address_requirements/3553253a-99eb-4303-a16a-6b1042d3f147/relationships/address_proof_types",
54 "related": "https://api.didww.com/v3/address_requirements/3553253a-99eb-4303-a16a-6b1042d3f147/address_proof_types"
55 }}
56 }
57 },
58 {
59 "id": "229310cf-21c1-41f0-9cfb-c4ea133304d5",
60 "type": "address_requirements",
61 "attributes": {
62 "number_type": "local",
63 "identity_type": "any",
64 "personal_area_level": "world_wide",
65 "business_area_level": "country",
66 "address_area_level": "city",
67 "personal_proof_qty": 1,
68 "business_proof_qty": 1,
69 "address_proof_qty": 1,
70 "personal_mandatory_fields": [],
71 "business_mandatory_fields": ["country"],
72 "service_description_required": false,
73 "restriction_message": "German Local DID End User registration requirements:<br>\r\nFor <b>personal identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Passport or ID copy\r\n* Germany registration form<br>\r\nFor <b>business identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Company name\r\n* German company incorporation certificate copy\r\n* Germany registration form<br>\r\nFor <b>address<\/b> verification:\r\n* Address matching the DID area code (street, building number, postal code, city and country)\r\n* A copy of a utility bill (less than 6 months old)<br>\r\nThe number provided online is a <b>demo<\/b>. An active number will be provided when the registration process is complete.<br>\r\nTo activate the DID number(s) please create an identity and address bundle matching the requirements and assign it to the DID number(s) for approval.<br>\r\nWe reserve the right in our sole discretion to request additional information at any stage of the registration process.<br>\r\n"
74 },
75 "relationships": {
76 "country": {"links": {
77 "self": "https://api.didww.com/v3/address_requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/relationships/country",
78 "related": "https://api.didww.com/v3/address_requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/country"
79 }},
80 "personal_permanent_document": {"links": {
81 "self": "https://api.didww.com/v3/address_requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/relationships/personal_permanent_document",
82 "related": "https://api.didww.com/v3/address_requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/personal_permanent_document"
83 }},
84 "business_permanent_document": {"links": {
85 "self": "https://api.didww.com/v3/address_requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/relationships/business_permanent_document",
86 "related": "https://api.didww.com/v3/address_requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/business_permanent_document"
87 }},
88 "personal_onetime_document": {"links": {
89 "self": "https://api.didww.com/v3/address_requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/relationships/personal_onetime_document",
90 "related": "https://api.didww.com/v3/address_requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/personal_onetime_document"
91 }},
92 "business_onetime_document": {"links": {
93 "self": "https://api.didww.com/v3/address_requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/relationships/business_onetime_document",
94 "related": "https://api.didww.com/v3/address_requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/business_onetime_document"
95 }},
96 "personal_proof_types": {"links": {
97 "self": "https://api.didww.com/v3/address_requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/relationships/personal_proof_types",
98 "related": "https://api.didww.com/v3/address_requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/personal_proof_types"
99 }},
100 "business_proof_types": {"links": {
101 "self": "https://api.didww.com/v3/address_requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/relationships/business_proof_types",
102 "related": "https://api.didww.com/v3/address_requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/business_proof_types"
103 }},
104 "address_proof_types": {"links": {
105 "self": "https://api.didww.com/v3/address_requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/relationships/address_proof_types",
106 "related": "https://api.didww.com/v3/address_requirements/229310cf-21c1-41f0-9cfb-c4ea133304d5/address_proof_types"
107 }}
108 }
109 }
110 ],
111 "meta": {
112 "total_records": 2,
113 "api_version": "2026-11-19"
114 },
115 "links": {
116 "first": "https://api.didww.com/v3/address_requirements?filter%5Bcountry.id%5D=38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f&page%5Bnumber%5D=1&page%5Bsize%5D=50",
117 "last": "https://api.didww.com/v3/address_requirements?filter%5Bcountry.id%5D=38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f&page%5Bnumber%5D=1&page%5Bsize%5D=50"
118 }
119}
http
1GET /v3/address_requirements?filter%5Bnumber_type%5D=shared_cost 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?filter%5Bnumber_type%5D=shared_cost' -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 {
7 "id": "5558cecd-cf91-4189-ad77-0f21518eb0d9",
8 "type": "address_requirements",
9 "attributes": {
10 "number_type": "shared_cost",
11 "identity_type": "any",
12 "personal_area_level": "world_wide",
13 "business_area_level": "world_wide",
14 "address_area_level": "world_wide",
15 "personal_proof_qty": 0,
16 "business_proof_qty": 0,
17 "address_proof_qty": 0,
18 "personal_mandatory_fields": [],
19 "business_mandatory_fields": [],
20 "service_description_required": false,
21 "restriction_message": "Australian Shared Cost DID End User registration requirements:<br>\r\nFor <b>personal identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number<br>\r\nFor <b>business identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Company name<br>\r\nFor <b>address<\/b> verification:\r\n* Address worldwide (street, building number, postal code, city and country)<br>\r\nTo activate the DID number(s) please create an identity and address bundle matching the requirements and assign it to the DID number(s) for approval.<br>\r\nWe reserve the right in our sole discretion to request additional information at any stage of the registration process.<br>\r\n"
22 },
23 "relationships": {
24 "country": {"links": {
25 "self": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/country",
26 "related": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/country"
27 }},
28 "personal_permanent_document": {"links": {
29 "self": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/personal_permanent_document",
30 "related": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/personal_permanent_document"
31 }},
32 "business_permanent_document": {"links": {
33 "self": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/business_permanent_document",
34 "related": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/business_permanent_document"
35 }},
36 "personal_onetime_document": {"links": {
37 "self": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/personal_onetime_document",
38 "related": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/personal_onetime_document"
39 }},
40 "business_onetime_document": {"links": {
41 "self": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/business_onetime_document",
42 "related": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/business_onetime_document"
43 }},
44 "personal_proof_types": {"links": {
45 "self": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/personal_proof_types",
46 "related": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/personal_proof_types"
47 }},
48 "business_proof_types": {"links": {
49 "self": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/business_proof_types",
50 "related": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/business_proof_types"
51 }},
52 "address_proof_types": {"links": {
53 "self": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/address_proof_types",
54 "related": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/address_proof_types"
55 }}
56 }
57 },
58 {
59 "id": "469d5cb4-baf6-4639-a500-f3bd04e89861",
60 "type": "address_requirements",
61 "attributes": {
62 "number_type": "shared_cost",
63 "identity_type": "business",
64 "personal_area_level": null,
65 "business_area_level": "world_wide",
66 "address_area_level": "world_wide",
67 "personal_proof_qty": 0,
68 "business_proof_qty": 2,
69 "address_proof_qty": 2,
70 "personal_mandatory_fields": [],
71 "business_mandatory_fields": ["id_number"],
72 "service_description_required": true,
73 "restriction_message": "Chinese Shared Cost DID End User registration requirements:<br>\r\nFor <b>business identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Passport\r\n* Company name\r\n* Company incorporation certificate copy<br>\r\nFor <b>address<\/b> verification:\r\n* Address worldwide (street, building number, postal code, city and country)\r\n* 2 copies of utility bills (less than 6 months old)<br>\r\nAdditional information:\r\n* Service usage description<br>\r\nTo activate the DID number(s) please create an identity and address bundle matching the requirements and assign it to the DID number(s) for approval.<br>\r\nWe reserve the right in our sole discretion to request additional information at any stage of the registration process.<br>\r\n"
74 },
75 "relationships": {
76 "country": {"links": {
77 "self": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/country",
78 "related": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/country"
79 }},
80 "personal_permanent_document": {"links": {
81 "self": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/personal_permanent_document",
82 "related": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/personal_permanent_document"
83 }},
84 "business_permanent_document": {"links": {
85 "self": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/business_permanent_document",
86 "related": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/business_permanent_document"
87 }},
88 "personal_onetime_document": {"links": {
89 "self": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/personal_onetime_document",
90 "related": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/personal_onetime_document"
91 }},
92 "business_onetime_document": {"links": {
93 "self": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/business_onetime_document",
94 "related": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/business_onetime_document"
95 }},
96 "personal_proof_types": {"links": {
97 "self": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/personal_proof_types",
98 "related": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/personal_proof_types"
99 }},
100 "business_proof_types": {"links": {
101 "self": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/business_proof_types",
102 "related": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/business_proof_types"
103 }},
104 "address_proof_types": {"links": {
105 "self": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/address_proof_types",
106 "related": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/address_proof_types"
107 }}
108 }
109 }
110 ],
111 "meta": {
112 "total_records": 2,
113 "api_version": "2026-11-19"
114 },
115 "links": {
116 "first": "https://api.didww.com/v3/address_requirements?filter%5Bnumber_type%5D=shared_cost&page%5Bnumber%5D=1&page%5Bsize%5D=50",
117 "last": "https://api.didww.com/v3/address_requirements?filter%5Bnumber_type%5D=shared_cost&page%5Bnumber%5D=1&page%5Bsize%5D=50"
118 }
119}
http
1GET /v3/address_requirements?filter%5Bnumber_type%5D=shared_cost&include=country 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?filter%5Bnumber_type%5D=shared_cost&include=country' -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 {
7 "id": "5558cecd-cf91-4189-ad77-0f21518eb0d9",
8 "type": "address_requirements",
9 "attributes": {
10 "number_type": "shared_cost",
11 "identity_type": "any",
12 "personal_area_level": "world_wide",
13 "business_area_level": "world_wide",
14 "address_area_level": "world_wide",
15 "personal_proof_qty": 0,
16 "business_proof_qty": 0,
17 "address_proof_qty": 0,
18 "personal_mandatory_fields": [],
19 "business_mandatory_fields": [],
20 "service_description_required": false,
21 "restriction_message": "Australian Shared Cost DID End User registration requirements:<br>\r\nFor <b>personal identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number<br>\r\nFor <b>business identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Company name<br>\r\nFor <b>address<\/b> verification:\r\n* Address worldwide (street, building number, postal code, city and country)<br>\r\nTo activate the DID number(s) please create an identity and address bundle matching the requirements and assign it to the DID number(s) for approval.<br>\r\nWe reserve the right in our sole discretion to request additional information at any stage of the registration process.<br>\r\n"
22 },
23 "relationships": {
24 "country": {
25 "links": {
26 "self": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/country",
27 "related": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/country"
28 },
29 "data": {
30 "type": "countries",
31 "id": "afeb1a21-abb4-4983-8712-7ab44950fc16"
32 }
33 },
34 "personal_permanent_document": {"links": {
35 "self": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/personal_permanent_document",
36 "related": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/personal_permanent_document"
37 }},
38 "business_permanent_document": {"links": {
39 "self": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/business_permanent_document",
40 "related": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/business_permanent_document"
41 }},
42 "personal_onetime_document": {"links": {
43 "self": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/personal_onetime_document",
44 "related": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/personal_onetime_document"
45 }},
46 "business_onetime_document": {"links": {
47 "self": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/business_onetime_document",
48 "related": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/business_onetime_document"
49 }},
50 "personal_proof_types": {"links": {
51 "self": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/personal_proof_types",
52 "related": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/personal_proof_types"
53 }},
54 "business_proof_types": {"links": {
55 "self": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/business_proof_types",
56 "related": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/business_proof_types"
57 }},
58 "address_proof_types": {"links": {
59 "self": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/relationships/address_proof_types",
60 "related": "https://api.didww.com/v3/address_requirements/5558cecd-cf91-4189-ad77-0f21518eb0d9/address_proof_types"
61 }}
62 }
63 },
64 {
65 "id": "469d5cb4-baf6-4639-a500-f3bd04e89861",
66 "type": "address_requirements",
67 "attributes": {
68 "number_type": "shared_cost",
69 "identity_type": "business",
70 "personal_area_level": null,
71 "business_area_level": "world_wide",
72 "address_area_level": "world_wide",
73 "personal_proof_qty": 0,
74 "business_proof_qty": 2,
75 "address_proof_qty": 2,
76 "personal_mandatory_fields": [],
77 "business_mandatory_fields": ["id_number"],
78 "service_description_required": true,
79 "restriction_message": "Chinese Shared Cost DID End User registration requirements:<br>\r\nFor <b>business identity<\/b> verification:\r\n* Name, last name\r\n* Contact phone number\r\n* Passport\r\n* Company name\r\n* Company incorporation certificate copy<br>\r\nFor <b>address<\/b> verification:\r\n* Address worldwide (street, building number, postal code, city and country)\r\n* 2 copies of utility bills (less than 6 months old)<br>\r\nAdditional information:\r\n* Service usage description<br>\r\nTo activate the DID number(s) please create an identity and address bundle matching the requirements and assign it to the DID number(s) for approval.<br>\r\nWe reserve the right in our sole discretion to request additional information at any stage of the registration process.<br>\r\n"
80 },
81 "relationships": {
82 "country": {
83 "links": {
84 "self": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/country",
85 "related": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/country"
86 },
87 "data": {
88 "type": "countries",
89 "id": "7006e60d-d2c7-4479-94ad-b954038e6dde"
90 }
91 },
92 "personal_permanent_document": {"links": {
93 "self": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/personal_permanent_document",
94 "related": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/personal_permanent_document"
95 }},
96 "business_permanent_document": {"links": {
97 "self": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/business_permanent_document",
98 "related": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/business_permanent_document"
99 }},
100 "personal_onetime_document": {"links": {
101 "self": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/personal_onetime_document",
102 "related": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/personal_onetime_document"
103 }},
104 "business_onetime_document": {"links": {
105 "self": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/business_onetime_document",
106 "related": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/business_onetime_document"
107 }},
108 "personal_proof_types": {"links": {
109 "self": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/personal_proof_types",
110 "related": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/personal_proof_types"
111 }},
112 "business_proof_types": {"links": {
113 "self": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/business_proof_types",
114 "related": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/business_proof_types"
115 }},
116 "address_proof_types": {"links": {
117 "self": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/relationships/address_proof_types",
118 "related": "https://api.didww.com/v3/address_requirements/469d5cb4-baf6-4639-a500-f3bd04e89861/address_proof_types"
119 }}
120 }
121 }
122 ],
123 "included": [
124 {
125 "id": "afeb1a21-abb4-4983-8712-7ab44950fc16",
126 "type": "countries",
127 "attributes": {
128 "name": "Australia",
129 "prefix": "61",
130 "iso": "AU"
131 },
132 "relationships": {"regions": {"links": {
133 "self": "https://api.didww.com/v3/countries/afeb1a21-abb4-4983-8712-7ab44950fc16/relationships/regions",
134 "related": "https://api.didww.com/v3/countries/afeb1a21-abb4-4983-8712-7ab44950fc16/regions"
135 }}}
136 },
137 {
138 "id": "7006e60d-d2c7-4479-94ad-b954038e6dde",
139 "type": "countries",
140 "attributes": {
141 "name": "China",
142 "prefix": "86",
143 "iso": "CN"
144 },
145 "relationships": {"regions": {"links": {
146 "self": "https://api.didww.com/v3/countries/7006e60d-d2c7-4479-94ad-b954038e6dde/relationships/regions",
147 "related": "https://api.didww.com/v3/countries/7006e60d-d2c7-4479-94ad-b954038e6dde/regions"
148 }}}
149 }
150 ],
151 "meta": {
152 "total_records": 2,
153 "api_version": "2026-11-19"
154 },
155 "links": {
156 "first": "https://api.didww.com/v3/address_requirements?filter%5Bnumber_type%5D=shared_cost&include=country&page%5Bnumber%5D=1&page%5Bsize%5D=50",
157 "last": "https://api.didww.com/v3/address_requirements?filter%5Bnumber_type%5D=shared_cost&include=country&page%5Bnumber%5D=1&page%5Bsize%5D=50"
158 }
159}
Other Responses#
Code |
Success |
Description |
|---|---|---|
400 |
No |
Bad Request. Malformed request: unknown filter, bad pagination or bad sort field. |
401 |
No |
|
429 |
No |
The request budget of the account for the current window is spent ( |