Verify events

Crezco tracks the verification state of an organisation using clear and actionable statuses. These webhooks can be used to notify your system about each significant state change. Verification event statuses include:

NotStarted: The Organisation has not begun any verification
InProgress: The Organisation has begun verification and it is not yet complete
Completed: The verification has concluded successfully; check the organisation's available feature set for changes
Failed: The verification has failed; check the organisation to see if they are permitted to retry verification

For Failed verification webhook events, the payload includes a property canRetry indicating if the organisation can restart the verification process (true) or not (false).

Example webhook for Completed verification:

{
  "eventId": "7d13e347-2b07-4e52-85b6-4f5d6b5f20ff",
  "type": "Verification",
  "id": "f51390b7-f258-46d3-9827-d7feb731953b",
  "status": "Completed",
  "timestamp": "2024-06-28T13:32:12.1082924Z",
  "organisationId": "f51390b7-f258-46d3-9827-d7feb731953b",
  "partnerClientId": "FXtest22",
  "payload": null,
  "version": "2024-06-30"
}

Example webhook for Failed verification:

{
  "eventId": "2897f3c6-ac11-4d09-af3e-f3924263947f",
  "type": "Verification",
  "id": "3302ac1b-661c-4775-8fd7-74a40e14f959",
  "status": "Failed",
  "timestamp": "2024-08-13T13:20:44.3685869Z",
  "organisationId": "3302ac1b-661c-4775-8fd7-74a40e14f959",
  "partnerClientId": "crezdemo_1723554696",
  "payload": {
    "canRetry": false
  },
  "version": "2024-06-30"
}

These statuses allow your system to respond appropriately and guide users effectively through the verification journey. For detailed webhook event structures and integration guidance, please refer to our Webhooks documentation.

Failed verifications

When a verification attempt has failed, you can determine this state by either:

Listening for a webhook event with status Failed
Calling the endpoint GET /organisations/{organisationId} and inspecting the response property verification.status

If the verifiable property is true, the organisation is eligible to initiate or retry the verification process. If verifiable is false, the organisation cannot currently retry verification, and further action may be required by contacting support or addressing specific compliance requirements.