# 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](../../coverage-resources/countries/country-object.html#country-object-v35) |
| personal\_permanent\_document | to-one | [Supporting Document Template Object](../supporting-document-templates/supporting-document-templates-object.html#supporting-document-templates-object-v35) |
| business\_permanent\_document | to-one | [Supporting Document Template Object](../supporting-document-templates/supporting-document-templates-object.html#supporting-document-templates-object-v35) |
| personal\_onetime\_document | to-one | [Supporting Document Template Object](../supporting-document-templates/supporting-document-templates-object.html#supporting-document-templates-object-v35) |
| business\_onetime\_document | to-one | [Supporting Document Template Object](../supporting-document-templates/supporting-document-templates-object.html#supporting-document-templates-object-v35) |
| personal\_proof\_types | to-many | [Proof Type Object](../proof-types/proof-types-object.html#proof-types-object-v35) |
| business\_proof\_types | to-many | [Proof Type Object](../proof-types/proof-types-object.html#proof-types-object-v35) |
| address\_proof\_types | to-many | [Proof Type Object](../proof-types/proof-types-object.html#proof-types-object-v35) |
