Integration Guide

Integration Guide

API Setup

To start using the Mobbscan API, follow these steps:

1. Register with Mobbscan: To use the Mobbscan API, you need to register on the Mobbscan platform and obtain access credentials (API Key and Secret). Contact the Mobbscan support team for this.

2. API Configuration: After obtaining the access credentials, configure the API in your system by setting up the base URL for the Mobbscan API in your system.

3. Webhook Setup (optional): To receive notifications about changes in the onboarding process status, you must configure a webhook in your system. Set up the webhook URL in your system. See more

Onboarding process

The onboarding process consists of the following steps:

1. Creating an onboarding process: To begin an onboarding process, send a request to the Mobbscan API with the process configuration. The API will generate a unique identifier for the onboarding process. See more

2. Redirecting to the onboarding process: After the onboarding process is created, redirect the user to the URL generated by the Mobbscan API to complete the process. This can be done by redirecting to the URL or embedding an iframe in the integrator's application.

3. Onboarding process validation (optional): Once the user completes the onboarding process, the integrator will perform a series of automatic validations if configured, or the process will be pending review by an agent. Based on these validations, the integrator can accept, reject, or request a manual review of the process. See more

4. Accepting or rejecting the onboarding process: After performing the validations, the integrator can accept or reject the onboarding process. If rejected, the rejection reason must be provided. The integrator can do this via the API or an agent if the process was sent for manual review.

5. Notification of status change: The Mobbscan API will send a notification to the webhook configured in the integrator's system about the status change of the onboarding process. The integrator must define the endpoint for the webhook and share the URL with the Mobbscan team to configure it in the system. See more

6. Retrieving onboarding process information: To get detailed information about an onboarding process, make a request to the Mobbscan API with the unique identifier of the onboarding process. See more

7. Retrieving onboarding process evidence: To retrieve evidence of an onboarding process, make a request to the Mobbscan API with the unique identifier of the onboarding process. Evidence can include:

   • Images generated during the onboarding process.
   • Videos made during the onboarding process.
   • PDF containing information about the onboarding process.
   • Zip with all the evidence of the onboarding process.