Emergency Requirement Object#

Emergency requirement object attributes. The JSON:API resource type is emergency_requirements.

Note

In version 2026-11-19, the number_type attribute replaces the did_group_type relationship. Requests that include did_group_type, filter by did_group_type.id, or request did_group_type in sparse fieldsets return 400 Bad Request.

Attributes#

Name

Type

Description

number_type

string

Number type the requirement applies to. Read-only. Possible values: local, national, mobile, toll_free, shared_cost, global.

identity_type

string

Identity type required for emergency registration. Possible values: personal, business, any.

address_area_level

string

Required location proof level for Address. Possible values: country, area, city.

personal_area_level

string

Required location proof level for Personal Identity. Possible values: world_wide, country. Can be null.

business_area_level

string

Required location proof level for Business Identity. Possible values: world_wide, country. Can be null.

address_mandatory_fields

array[string]

Fields that must be filled in for the Address. Possible value: area. Empty when none are mandatory.

personal_mandatory_fields

array[string]

Fields that must be filled in for a Personal Identity. Possible values: birth_date, country, id_number, personal_tax_id, contact_email. Empty when none are mandatory.

business_mandatory_fields

array[string]

Fields that must be filled in for a Business Identity. Possible values: id_number, tax_id, country, company_reg_number, personal_tax_id, contact_email, birth_date. tax_id is the Identity vat_id attribute. Empty when none are mandatory.

estimate_setup_time

string

Estimated time to activate the emergency calling service.

requirement_restriction_message

string

Additional restriction message for a specific country or number type. Can be null.

Meta Attributes#

Name

Type

Description

setup_price

string

One-time setup price for the emergency calling service, as a decimal string. Always 0.0 when priced: activation is not charged on this API. Can be null when no matching emergency plan rate exists.

monthly_price

string

Monthly price from the customer’s matching emergency plan rate, as a decimal string. Can be null when no matching rate exists.

Relationships#

Name

Type

Description

country

to-one

Country Object