API Guide
Log In
API Guide

Organisation statuses

Learn about organisation statuses

Organisation onboarding statuses

An Onboarding is a user journey to connect their bank account to Crezco system to enable making payments.

These onboarding updates can be identified by webhook events with a type of OrganisationOnboarding

Organisation onboarding webhooks events have the following statuses:

  • Initiated: The onboarding process has begun
  • Authentication: The user has successfully authenticated to Crezco
  • BankSelected: The user has selected a bank and been redirected to that bank's authorisation flow
  • Complete: The onboarding process has concluded successfully
Onboarding status diagram

Onboarding status diagram

Example organisation onboarding event

{
  "eventId": "9b319b78-bdc8-4970-a175-5cac83afd3fa",
  "type": "OrganisationOnboarding",
  "id": "1d7ae118-611c-4f50-a01a-e80a3ece3716",
  "parentType": null,
  "parentId": null,
  "status": "Complete",
  "timestamp": "2024-06-28T14:47:41.3051867Z",
  "organisationId": "1d7ae118-611c-4f50-a01a-e80a3ece3716",
  "partnerClientId": "crezdemo_1719586044",
  "partnerEntityId": null,
  "parentPartnerEntityId": null,
  "payload": null,
  "version": "2025-01-31"
}

Verifications

A Verification is an Organisation's journey to undergo enhanced compliance checks that unlock extra features such as international payments.

  • 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
Verification status diagram

Verification status diagram



Bank Accounts

A Bank Account can be connected to an Organisation in order to make payments from it.

  • Active - The system holds a valid consent to access this bank account
  • Disconnected - The consent has expired or been revoked
Bank Account status diagram

Bank Account status diagram