The representativeRequiredFields query returns the necessary fields for an owner or Ultimate Beneficial Owner (UBO) of an entity.
# createRepresentative Mutation Reference Guide
This document provides descriptions for all the fields used in the `createRepresentative` mutation,
including how to handle multi-dimensional arrays for documents.
## Query
```graphql
mutation createRepresentative (
$entity_id: UUID
$representative: RepresentativeInput
) {
createRepresentative (
entity_id: $entity_id
representative: $representative
)
}
Variables
country
| Field | Type | Description |
|---|---|---|
| country | ISO3166_1 | The country the representative resides. |
Documents Field
documents
The documents field is a multi-dimensional array where each collection in the array represents a complete set of documents required for identity verification. Each document set is an array of document objects, and each document object contains the following fields:
| Field | Type | Description |
|---|---|---|
| enum | String | The type of document (e.g., passport). |
| type | String | The purpose of the document (e.g., identity_verification). |
Example Structure
Below is an example structure for the documents field:
"documents": [
[
{
"enum": "passport",
"type": "identity_verification"
}
],
[
{
"enum": "front_drivers_license",
"type": "identity_verification"
},
{
"enum": "back_drivers_license",
"type": "identity_verification"
}
],
[
{
"enum": "front_permanent_residence_card",
"type": "identity_verification"
},
{
"enum": "back_permanent_residence_card",
"type": "identity_verification"
}
],
[
{
"enum": "front_national_state_id",
"type": "identity_verification"
},
{
"enum": "back_national_state_id",
"type": "identity_verification"
}
]
]
Each inner array represents a complete set of documents that can be used for identity verification.
The representative can provide any one of these sets.
One Representative will need to be designated as the signer for the entity
The requirements are based on the residential country of the representative
To designate a representative assign the representative as "is_signer": true
For the countries available for onboarding representatives view here
Representatives with citizenship in a high risk designated country will require special approval.