Skip to main content

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
{
    "id": "a9b83048-32ec-40fd-b188-850725a0e519",
    "owner_id": "8e9b9a45-6212-4a77-bb43-4b8d123a5e42",
    "owner_type": "person",
    "timestamp": "2024-10-29T12:15:42Z",
    "type": "requirementsQuestionnaire",
    "details": {
        "pending_questionnaire_ids": [
            "fedad589-623e-4823-a465-06f6b035fa31",
            "6970d188-f005-479c-b5a5-cd2cf8c8776d"
        ],
        "reason": "Questionnaires required for onboarding process"
    }
}

Fetching Pending Requirements (Polling)​

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

Endpoints:

  • GET /persons/{person_id}/pending_requirements
  • GET /corporates/{corporate_id}/pending_requirements
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": "Questionnaires are required for onboarding process",
    "pending_questionnaire_ids": [
      "3cb3bdae-96eb-4097-9cc1-01c4fcf911ca",
      "3ee23043-75dc-40f2-8ec0-2be8c9f623cf"
    ]
  }
]

Flow Diagram​