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 |
|
Number type the requirement applies to. Read-only. Possible values: |
identity_type |
|
Identity type, possible values: |
personal_area_level |
|
Required location proof for Personal Identity. Possible values: |
business_area_level |
|
Required location proof for Business Identity. Possible values: |
address_area_level |
|
Required location proof for Address. Possible values: |
restriction_message |
|
The message with requirements for specific Country/Area. |
personal_proof_qty |
|
The quantity of proof documents required for Personal Identity. |
business_proof_qty |
|
The quantity of proof documents required for Business Identity. |
address_proof_qty |
|
The quantity of proof documents required for Address. |
personal_mandatory_fields |
|
Identity fields that must be filled in for a Personal Identity. Possible values: |
business_mandatory_fields |
|
Identity fields that must be filled in for a Business Identity. Possible values: |
service_description_required |
|
If Service description is required. Possible values: True/False. |
Relationships#
Name |
Type |
Description |
|---|---|---|
country |
to-one |
|
personal_permanent_document |
to-one |
|
business_permanent_document |
to-one |
|
personal_onetime_document |
to-one |
|
business_onetime_document |
to-one |
|
personal_proof_types |
to-many |
|
business_proof_types |
to-many |
|
address_proof_types |
to-many |