KYC Requirement

An object returned as part of the KYC Review object, which includes information about a required evidence, its state, and any additional information that might be required.

keystring

The name of the KYC requirement. A single KYC Requirement should appear in the requirements list at most once.

Example:"ID_DOCUMENT"

statestring

The state of the KYC requirement.

NOT_PROVIDED — the information is pending. Either the Hosted KYC flow or KYC Requirement Submit endpoint should be used to fulfil the requirement.
IN_REVIEW — the required information has been retrieved and the KYC requirement is being reviewed. No action is needed.
VERIFIED — the required information has been received and verified on our side. No action is needed.

Enum:"NOT_PROVIDED""IN_REVIEW""VERIFIED"

Example:"NOT_PROVIDED"

apiCollectionSupportedboolean

Indicates if the requirement can be provided via the KYC Requirement Submit endpoint. If false, the requirement should be provided via the Hosted KYC flow.

Example:true

additionalRequirementsArray of objects or null

List of additional submissions that are needed to fulfill this requirement. These can appear when the originally submitted evidence is a wrong document, wrong format, incomplete or otherwise insufficient. Only provided if not empty.

versionsArray of objects

Conditional: Only present when apiCollectionSupported is true. Lists the available versions and their validity.

{
  "key": "ID_DOCUMENT",
  "state": "NOT_PROVIDED",
  "apiCollectionSupported": true,
  "additionalRequirements": [
    {
      "additionalRequirementId": "8b789c45-60ae-475d-b667-c8714db9a6a4",
      "key": "DOCUMENT_OR_WRITTEN_ANSWER",
      "state": "NOT_PROVIDED",
      "reasons": { … },
      "attributes": { … }
    }
  ],
  "versions": [
    {
      "version": "v1",
      "validUntil": "2026-06-30"
    }
  ]
}