Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In the Namirial Onboarding process, identification requests can transition through various statuses, each representing a specific stage in the lifecycle of the request.
There are three types of statuses: STATUS_UPDATE, STATUS_UPDATE_STEP and STATUS_UPDATE_ACTOR.
To manage the webhooks all the details are available in this page: Webhook configuration.

Below is a list of the STATUS_UPDATE type statuses:

...


The STATUS_UPDATE statues are related to the status of the request, below an example:

Code Block
{

...


 "id": "dd11fc7d-c48b-407c-867c-121407d9e304",

...


 "type": "STATUS_UPDATE",

...


 "createdAt": "2024-12-02T21:17:44.276957577Z",

...


 "request": {

...


    "requestId": "48502a4e-3256-41a8-b119-fb5fa2d25514",

...


    "requestTypeId": "69efb67a-cf6d-42a7-8f9b-eb707887dee8",

...


    "status": "RUNNING"

...


 }

...


}


The STATUS_UPDATE_ACTOR is a status type useful for the multi-actor workflows and is triggered by Namirial Onboarding when a specific actor starts Its workflow. Below an example.

Code Block
{

...


 "id": "ead25182-793a-47bd-9fa9-db93e36b6a35",

...


 "type": "STATUS_UPDATE_ACTOR",

...


 "createdAt": "2024-12-02T21:17:50.152882204Z",

...


 "request": {

...


    "requestId": "48502a4e-3256-41a8-b119-fb5fa2d25514",

...


    "requestTypeId": "69efb67a-cf6d-42a7-8f9b-eb707887dee8",

...


    "status": "RUNNING",

...


    "actor": "userToIdentify"

...


 }

...


}


The STATUS_UPDATE_STEP are related to a specific action done by an actor inside a step of a request, below an example.

Code Block
{

...


 "id": "7ec43889-53d8-45c0-9fc9-8c606d0cb393",

...


 "type": "STATUS_UPDATE_STEP",

...


 "createdAt": "2024-12-02T21:17:50.163164068Z",

...


 "request": {

...


    "requestId": "48502a4e-3256-41a8-b119-fb5fa2d25514",

...


    "requestTypeId": "69efb67a-cf6d-42a7-8f9b-eb707887dee8",

...


    "status": "RUNNING",

...


    "actor": "userToIdentify",

...


    "stepName": "termsAndConditions",

...


    "stepId": "/termsAndConditions",

...


    "stepStatus": "ACTIVE"

...


 }

...


}

The STATUS_UPDATE_STEP event above reports that the "actor": "userToIdentify" is now "ACTIVE" in the step of the process "termsAndConditions";
possible stepStatus values: ACTIVE, DONE.

...