Get Emergency Requirements

Returns the list of emergency requirements.

Request

HTTP Method: GET

URI Path: /v3/emergency_requirements

Note

For all returned data attributes, see Emergency Requirement Object.

URI Query Parameters

Name

Type

Is Required?

Description

include

string

No

Inclusion

filter[<filter_name>]

string

No

Filtering

fields[emergency_requirements]

string

No

Sparse fieldsets

Includes

Value

Description

country

Country Object

did_group_type

DID Group Type Object

Filters

Filter Name

Type

Allow Blank

Allow Array

Filters by:

id

string

No

Yes

The Emergency Requirement id field.

country.id

string

No

No

The country.id field.

did_group_type.id

string

No

No

The did_group_type.id field.

Examples

http

GET /v3/emergency_requirements 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/emergency_requirements -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": "3f3be6a6-a513-4509-bd9b-945e599e16f5",
            "type": "emergency_requirements",
            "attributes": {
                "identity_type": "Any",
                "address_area_level": "country",
                "personal_area_level": "world_wide",
                "business_area_level": "world_wide",
                "address_mandatory_fields": [],
                "personal_mandatory_fields": [],
                "business_mandatory_fields": [],
                "estimate_setup_time": "1-2 business days",
                "requirement_restriction_message": null
            },
            "relationships": {
                "country": {
                    "links": {
                        "self": "https://api.didww.com/v3/emergency_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/country",
                        "related": "https://api.didww.com/v3/emergency_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/country"
                    }
                },
                "did_group_type": {
                    "links": {
                        "self": "https://api.didww.com/v3/emergency_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/relationships/did_group_type",
                        "related": "https://api.didww.com/v3/emergency_requirements/3f3be6a6-a513-4509-bd9b-945e599e16f5/did_group_type"
                    }
                }
            },
            "meta": {
                "setup_price": "0.00",
                "monthly_price": "2.50"
            }
        },
        {
            "id": "d210e6e4-1716-4342-b04c-7a6ef6feb171",
            "type": "emergency_requirements",
            "attributes": {
                "identity_type": "personal",
                "address_area_level": "city",
                "personal_area_level": "country",
                "business_area_level": null,
                "address_mandatory_fields": ["State/Province/Region"],
                "personal_mandatory_fields": ["Birth Date", "Contact email"],
                "business_mandatory_fields": [],
                "estimate_setup_time": "1-2 business days",
                "requirement_restriction_message": "USA Local DID emergency registration requirements:\r\n\r\n1. Name, last name and contact phone number.\r\n2. Current address must be from the same city as the DID ordered (street, building number, postal code, city).\r\n\r\nEmergency calling will not be activated until full registration details are provided and approved."
            },
            "relationships": {
                "country": {
                    "links": {
                        "self": "https://api.didww.com/v3/emergency_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/country",
                        "related": "https://api.didww.com/v3/emergency_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/country"
                    }
                },
                "did_group_type": {
                    "links": {
                        "self": "https://api.didww.com/v3/emergency_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/relationships/did_group_type",
                        "related": "https://api.didww.com/v3/emergency_requirements/d210e6e4-1716-4342-b04c-7a6ef6feb171/did_group_type"
                    }
                }
            },
            "meta": {
                "setup_price": null,
                "monthly_price": null
            }
        }
    ],
    "meta": {
        "total_records": 2,
        "api_version": "2026-04-16"
    },
    "links": {
        "first": "https://api.didww.com/v3/emergency_requirements?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "last": "https://api.didww.com/v3/emergency_requirements?page%5Bnumber%5D=1&page%5Bsize%5D=50"
    }
}

Other Responses

Code

Success

Description

400

No

Invalid resource. Example detail: emergency_requirements are not supported in 2022-05-10 DIDWW API version.

401

No

Unauthorized

403

No

Forbidden. Example detail: Emergency plan is not assigned to the Customer.