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

string

No

Inclusion

filter[<filter_name>]

string

No

Filtering

fields[address_requirements]

string

No

Sparse fieldsets

sort

string

No

Sorting

page[number]

integer

No

Page number.

page[size]

integer

No

Page size. Pagination defaults to 50 records per page. The maximum is 100.

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

Filters#

Filter Name

Type

Allow Blank

Allow Array

Filters by:

id

string

No

Yes

Address requirement id field.

country.id

string

Yes

Yes

The country.id field.

number_type

string

No

Yes

Address requirement number_type field. Accepted values: local, national, mobile, toll_free, shared_cost, global.

Sorting#

Value

Sorts by:

address_proof_qty

The address_proof_qty field.

business_proof_qty

The business_proof_qty field.

personal_proof_qty

The personal_proof_qty field.

restriction_message

The restriction_message field.

service_description_required

The service_description_required field.

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.

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}

Other Responses#

Code

Success

Description

400

No

Bad Request. Malformed request: unknown filter, bad pagination or bad sort field.

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.