Address Requirement Object#

Address requirement object attributes. The JSON:API resource type is address_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, possible values: any, business or personal.

personal_area_level

string

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

business_area_level

string

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

address_area_level

string

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

restriction_message

string

The message with requirements for specific Country/Area.

personal_proof_qty

integer

The quantity of proof documents required for Personal Identity.

business_proof_qty

integer

The quantity of proof documents required for Business Identity.

address_proof_qty

integer

The quantity of proof documents required for Address.

personal_mandatory_fields

array[string]

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

business_mandatory_fields

array[string]

Identity 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. tax_id is the Identity vat_id attribute. Empty when none are mandatory, never null.

service_description_required

boolean

If Service description is required. Possible values: True/False.

Relationships#

Name

Type

Description

country

to-one

Country Object

personal_permanent_document

to-one

Supporting Document Template Object

business_permanent_document

to-one

Supporting Document Template Object

personal_onetime_document

to-one

Supporting Document Template Object

business_onetime_document

to-one

Supporting Document Template Object

personal_proof_types

to-many

Proof Type Object

business_proof_types

to-many

Proof Type Object

address_proof_types

to-many

Proof Type Object