An onboarding case is stored in the registration object. This page explains the different statuses of the registration object.

List of statuses

A registration can have the following statuses:

Status in portal	Technical label	Next Status	Function
Incomplete	INCOMPLETE	COMPLETE REJECTED	The onboarding case is still being provided with information.
Complete	COMPLETE	INCOMPLETE REJECTED DONE	Information has been collected.
Done	DONE	INCOMPLETE COMPLETE ACCEPTED REJECTED	All relevant processes have been done and onboarding case is ready to be reviewed.
Accepted	ACCEPTED	MIGRATED DONE	Onboarding case is accepted, next step will be moving to Client File. (migration)
Rejected	REJECTED	DELETED DONE	Onboarding case is rejected, next step will be deletion.
Client	MIGRATED	none	Onboarding case has been moved to Client File.
Deleted	DELETED	none	Onboarding case has been deleted.

Notification "Onboarding - Status Change"

In the administration menu "Access management" > "Notifications", you can add a notification "Onboarding - Status changed". This notification will send a notification in case of a status change.

Note: Creation of onboarding case is not included. For this you can use the event type "New registration created".

The status changes that you can be notified about are:

INCOMPLETE
COMPLETE
DONE
ACCEPTED
REJECTED

Example excerpt of the event data as sent out by the webhook:

{
    "event": {
      "name": [
        "CHANGED_STATUS_REGISTRATION"
      ],
      "description": "Status of registration was changed"
    },
    [...]
    "data": {
      "status": "COMPLETE",
      [...]
      "nextStatus": [
        "INCOMPLETE",
        "REJECTED",
        "DONE"
      ],
      [...]
}

When deciding a valid status to transition the registration to, you can use the object data.nextStatus.

Other status objects

Within the registration object, there are other status objects, such as the CDD status and the survey status.

For example a new registration object may have the following data:

{
      "status": "INCOMPLETE",
      "survey": {
        "status": {
          "code": 0,
          "status": "NOT_STARTED"
        }
      },
      "CDD": {
        "status": "NOT_CHECKED",
        "results": null
      },
      "agent_id": null
    }

Registration Status

Contents

List of statuses

Notification "Onboarding - Status Change"

Other status objects