[Backend] Get Report
1. User State
Alice classifies the status of each Onboarding based on the steps required in the SDK initialization. Below you can find each status and its meaning.
| State | Description |
|---|---|
| NOT STARTED | The user was created in our backend but did not initialize the SDK. |
| IN PROGRESS | User has initialized SDK but has not completed all required Steps |
| TO REVIEW | The user has completed all the required steps but you have not made a decision on whether to accept or reject the Onboarding. |
| ACCEPTED | The Onboarding user has been accepted. This can be done manually from the control panel or by using the following endpoint |
| REJECTED | The Onboarding user was Rejected. This can be done manually from the control panel or by using the following endpoint |
The following Endpoint allows you to change the USER STATE through our API
2. When request the Report
Once the user has completed all the requested steps it's the time to retrieve the Report by requesting it to our API. How to Get the Report
There is two ways to know if the user has completed the process.
2.1 SDK Callback
Our SDK indicates that the user has completed the process using a specific callback in the SDK, we recommend using this callback as a trigger to request the Report to our API.
2.2 Webhooks
Webhooks allow you to notify external services when certain events occur. You can configure the Webhook to notify your system when a user has completed the process.
Warning
In order to use Webhooks please contact with our support team.
3 Get Report
To check the result of the analysis performed by Alice it is necessary to request and review the Report.