Understanding webhooks

Upon the creation of a new request, the system sends a webhook containing the following information:

Webhook content upon voucher creation

The webhook sent upon voucher creation contains the following fields:

• id: unique identifier of the notification sent via webhook.

• type: type of event generated (e.g. request_created).

• createdAt: date and time of notification sending (ISO 8601 format).

• requestId: unique identifier of the request generated upon voucher creation.

• requestTypeId: identifier of the type of onboarding flow used (e.g. identification & signature, SPID, etc.), specific to the customer's environment.

• status: status associated with the notified event.

Once the request is created, the onboarding status immediately transitions from Created to Running, indicating the actual start of the process by the end user.

Monitoring the status and steps of the flow

Following the initiation of the request, the system provides an indication of the current step reached by the end user within the onboarding flow.

The overall status remains set to Running for the entire duration of the process, while the stepName field varies dynamically based on the specific phase in which the user is located.

For example, in the case of the standard flow, the first step is represented by the reading and acceptance of the Terms and Conditions (T&C) of the Namirial Onboarding (NOB) product, which is notified through the corresponding value in the stepName field.

Start of the identification process

Once the user has accepted the Terms and Conditions, the flow continues with the initiation of the recognition process, for example through the ID Self form. At this stage, a new webhook notification is sent containing:

• stepName: set to Identification, indicating that the user has reached the identification phase.

• stepStatus: indicates that the identification process has been started, but not yet completed.

This information allows the client to monitor the user's entry into the recognition phase, clearly distinguishing it from its completion.

Completion of the identification process

At the end of the identification procedure, the system sends an additional notification via webhook.

In this case:

• stepName remains set as Identification,

• while stepStatus takes the value Done, indicating that the identification process has been completed.

This information allows the client to detect the user's transition beyond the identification phase and to proceed with the subsequent steps outlined in the flow.

Start of the signing process

Following the completion of the identification process, if it is expected and in the absence of blocking errors in recognizing the type of identity document, the signing process of the document configured during the request creation phase is automatically initiated.

The system then sends a new webhook with the following information:

• status: remains set to Running, indicating that the flow is still ongoing;

• stepName: populated with Signature, indicating the start of the signing phase;

• stepStatus: takes the value Active, which signals the activation of the signing process by the user.

This notification allows the client to detect the user's entry into the document signing phase.

Completion of the signature process

At the end of the signing phase, the system sends a new webhook notification confirming the completion of the Signature step.

In particular, the message will contain:

• stepName: Signature

• stepStatus: Done, indicating that the signing process has been successfully completed by the user.

This notification allows the client to identify the conclusion of the subscription phase and to proceed with any subsequent activities.

Completion Event and Access to the Thank You Page

The user's arrival at the Thank You Page generates the sending of a dedicated event via webhook, signaling the visible conclusion of the onboarding flow.

This event allows the client to track the completion of the process and to trigger any post-processing actions or confirmation communications.

Process Completion Status

At the successful completion of the entire onboarding process, the webhook will send an event with the status set to Completed, indicating that the procedure has concluded successfully.

This notification allows the client to confirm the definitive conclusion of the flow and to proceed with the subsequent planned activities.

Request Rejection

In the event that the process produces a validation error or is reviewed by a back-office operator and the latter rejects it, the system will send a KO event via webhook. Below is an example of the payload received:

Gli status possibili in caso di KO sono: EXPIRED, FAILED, USER_CANCELLED, OPERATOR_CANCELLED