# 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](address-requirement-object.html).

### URI Query Parameters

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| id | `string` | Yes | Unique ID identifier of the Address Requirement. |
| include | `string` | No | [Inclusion](../../../specification/includes.html#api-includes) |

### Includes

| Value | Description |
| --- | --- |
| country | [Country Object](../../coverage-resources/countries/country-object.html#country-object-v34) |
| did\_group\_type | [DID Group Type Object](../../coverage-resources/did-group-type/did-group-type-object.html#did-group-type-object-v34) |
| personal\_permanent\_document | [Supporting Document Template Object](../supporting-document-templates/supporting-document-templates-object.html#supporting-document-templates-object-v34) |
| business\_permanent\_document | [Supporting Document Template Object](../supporting-document-templates/supporting-document-templates-object.html#supporting-document-templates-object-v34) |
| personal\_onetime\_document | [Supporting Document Template Object](../supporting-document-templates/supporting-document-templates-object.html#supporting-document-templates-object-v34) |
| business\_onetime\_document | [Supporting Document Template Object](../supporting-document-templates/supporting-document-templates-object.html#supporting-document-templates-object-v34) |
| personal\_proof\_types | [Proof Type Object](../proof-types/proof-types-object.html#proof-types-object-v34) |
| business\_proof\_types | [Proof Type Object](../proof-types/proof-types-object.html#proof-types-object-v34) |
| address\_proof\_types | [Proof Type Object](../proof-types/proof-types-object.html#proof-types-object-v34) |

## Example

[[DIDWW-API-EXAMPLE-START]]

http

```
GET /v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171 HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
```

curl

```
curl -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

```
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "id": "d210e6e4-1716-4342-b04c-7a6ef6feb171",
        "type": "address_requirements",
        "attributes": {
            "identity_type": "business",
            "personal_area_level": null,
            "business_area_level": "world_wide",
            "address_area_level": "area",
            "personal_proof_qty": 0,
            "business_proof_qty": 1,
            "address_proof_qty": 1,
            "personal_mandatory_fields": null,
            "business_mandatory_fields": null,
            "service_description_required": true,
            "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."
        },
        "relationships": {
            "country": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/country",
                    "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/country"
                }
            },
            "did_group_type": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/did_group_type",
                    "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/did_group_type"
                }
            },
            "personal_permanent_document": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_permanent_document",
                    "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_permanent_document"
                }
            },
            "business_permanent_document": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_permanent_document",
                    "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_permanent_document"
                }
            },
            "personal_onetime_document": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_onetime_document",
                    "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_onetime_document"
                }
            },
            "business_onetime_document": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_onetime_document",
                    "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_onetime_document"
                }
            },
            "personal_proof_types": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/personal_proof_types",
                    "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/personal_proof_types"
                }
            },
            "business_proof_types": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/business_proof_types",
                    "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/business_proof_types"
                }
            },
            "address_proof_types": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/address_proof_types",
                    "related": "https://sandbox-api.didww.com/v3/address_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/address_proof_types"
                }
            }
        }
    },
    "meta": {
        "api_version": "2026-04-16"
    }
}
```

[[DIDWW-API-EXAMPLE-END]]

## Other Responses

| Code | Success | Description |
| --- | --- | --- |
| 401 | No | [Unauthorized](../../../configuration.html#api-key) |

On this page