representativeRequiredFields

The representativeRequiredFields query returns the necessary fields for an owner or Ultimate Beneficial Owner (UBO) of an entity. This query response provides descriptions for all the fields used in the createRepresentative mutation, including how to handle multi-dimensional arrays for documents.

Variables

FieldTypeDescriptionRequired
countryISO3166_1The country the representative resides.true
platform_idUUIDUUID assigned to the platform to which the entity of the representative will belong.false (required after June 15th 2026)

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. I.E. Inner brackets mean “all of these are required together (AND).” Outer brackets mean “choose one of these sets (OR).”

Each document set is an array of document objects, and each document object contains the following fields:

FieldTypeDescription
enumStringThe type of document (e.g., passport).
typeStringThe 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.

Compliance Onboarding


These requirements may be modified at any time as directed by compliance.

Query Params
string
Defaults to {}
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json