Pending Requirements

The Pending Requirements mechanism indicates which questionnaires or actions are still required from the client to continue the onboarding process.

Receiving Pending Requirements (Webhook)

The preferred way to handle pending requirements is through webhooks. When new requirements are generated, the system sends a POST request to the registered webhook endpoint.

View Webhook Payload

{
    "notification_id": "a9b83048-32ec-40fd-b188-850725a0e519",
    "created_at": "2024-10-29T12:15:42Z",
    "owner_id": "8e9b9a45-6212-4a77-bb43-4b8d123a5e42",
    "owner_type": "person",
    "external_id": "client_id_123",
    "notification_type": "requirementsQuestionnaire",
    "details": {
        "pending_questionnaire_ids": [
            "fedad589-623e-4823-a465-06f6b035fa31",
            "6970d188-f005-479c-b5a5-cd2cf8c8776d"
        ],
        "reason": "onboarding"
    }
}

Reason Values

The reason indicates which process requires the questionnaires:

Reason	Requested during
onboarding	KYC/KYB Onboarding.
onboarding_edd	The EDD loop of an onboarding risk assessment.
additional_data	Additional information requested by compliance.
adhoc_edd	Ad Hoc EDD.
request_for_information	Request for Information.
posof_level_upgrade	Proof of Source of Funds level upgrades.
retail_derivatives_qualified_retail	The Qualified Retail derivatives entitlement.
retail_derivatives_prof_by_request	The Professional By Request derivatives entitlement.

Fetching Pending Requirements (Polling)

If webhook integration is not available, you can periodically poll the API.

Endpoints:

• GET /persons/{person_id}/pending_requirements
• GET /individuals/{individual_id}/pending_requirements

No corporate variant

A GET /corporates/{corporate_id}/pending_requirements endpoint is not currently available. For KYB Onboarding, track requirements via the requirementsQuestionnaire webhooks, or list the corporate's questionnaires via GET /corporates/{corporate_id}/questionnaires.

View Example Request

curl -X GET "https://<kyc_domain>/api/v1/persons/8e9b9a45-6212-4a77-bb43-4b8d123a5e42/pending_requirements" \
  -H "Authorization: Bearer <token>"

View Example Response

[
  {
    "reason": "onboarding",
    "pending_questionnaire_ids": [
      "3cb3bdae-96eb-4097-9cc1-01c4fcf911ca",
      "3ee23043-75dc-40f2-8ec0-2be8c9f623cf"
    ]
  }
]

Flow Diagram