# Address Requirement Object

Address requirement object attributes. The JSON:API resource type is `address_requirements`.

## Attributes

| Name | Type | Description |
| --- | --- | --- |
| 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`. |
| business\_area\_level | `string` | Required location proof for Business Identity. Possible values: `world_wide`, `country`. |
| 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]` | Mandatory fields for Personal Identity. |
| business\_mandatory\_fields | `array[string]` | Mandatory fields for Business Identity. |
| 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-v34) |
| did\_group\_type | to-one | [DID Group Type Object](../../coverage-resources/did-group-type/did-group-type-object.html#did-group-type-object-v34) |
| personal\_permanent\_document | to-one | [Supporting Document Template Object](../supporting-document-templates/supporting-document-templates-object.html#supporting-document-templates-object-v34) |
| business\_permanent\_document | to-one | [Supporting Document Template Object](../supporting-document-templates/supporting-document-templates-object.html#supporting-document-templates-object-v34) |
| personal\_onetime\_document | to-one | [Supporting Document Template Object](../supporting-document-templates/supporting-document-templates-object.html#supporting-document-templates-object-v34) |
| business\_onetime\_document | to-one | [Supporting Document Template Object](../supporting-document-templates/supporting-document-templates-object.html#supporting-document-templates-object-v34) |
| personal\_proof\_types | to-many | [Proof Type Object](../proof-types/proof-types-object.html#proof-types-object-v34) |
| business\_proof\_types | to-many | [Proof Type Object](../proof-types/proof-types-object.html#proof-types-object-v34) |
| address\_proof\_types | to-many | [Proof Type Object](../proof-types/proof-types-object.html#proof-types-object-v34) |

On this page
