Integration Process
This guide helps you integrate the end-user sign-up flow with Instnt Accept. Complete integration using various SDKs provided or by calling the provided REST API endpoints.
We recommend using the SDK of your choice for the integration process as they internally handle the API calls.
The documentation for each SDK is available in the GitHub repository Readme file.
The following SDKs with their usage documentation in the GitHub repository are available for you to choose from:
Prerequisites
- Sign-up to the Instnt dashboard and create a workflow for customer onboarding with the verifications you require. For more information, see the Quick Start Guide.
- A Workflow ID is available once you create the workflow in our dashboard. This Workflow ID is essential for the integration process as the ID is required to pass in various API calls. Store this ID in an accessible place.
Note: Workflow ID is referred to as workflow_id in the API calls.
API Integration
To complete the customer sign-up process, you need to invoke the API or event of an SDK for the various features according to the workflow you have created in Instnt Dashboard.
1. Begin Transaction
The first step in the integration of the sign-up process is to create a transaction and obtain an Instnt transaction id (instnttxnid).The Instnt transaction id acts as a correlation id throughout the sign-up session.
For any subsequent invocation of the Instnt API for the same sign-up session, you need to include this instnttxnid.
You can obtain the id in the response payload when you invoke the API or initialize the function in an SDK as below:
Suppose you are using one of the Instnt SDKs and calling the wrapper functions of the SDK instead of invoking Instnt APIs. In that case, SDK automatically sets the instnttxnid to the request before making an API invocation.
Note: Skip to step 4 if your workflow does not require document verification or OTP.
2. Document Verification
The document verification feature is only available if your customer onboarding workflows require document verification and if you have enabled Document Verification in the Instnt Dashboard Business Rules Configuration section for your customer sign-up workflow. For more information, see Document Verification.
The next step in the sign-up flow is to upload the documents for verification. Upload and verify government-issued identification documents such as Driver's Licenses, passports, and more. Document uploading is a multi-step process when using our API. When using the SDK, follow the respective SDK documentation to integrate the document verification in your sign-up workflow.
Our API's first step is to initialize the camera to capture each document image. The capture includes the front and back of the driver's license. The same initialization can be complete capture of the selfie image. The API requires to be invoked for each document. Whereas with our SDK, a single wrapper function covers both the API invocations.
Step 1: To obtain a pre-signed URL, invoke the endpoint or event of a SDK below:
Step 2: Invoke the pre-signed URL to upload the document in base64 encoded format.
Note: In the SDK the above two steps are bundled in just one function.
Step 3: After all of the documents are uploaded, initiate Document Verification by invoking the following endpoint.
3. One Time Password (OTP) Request and Verification
OTP request and verification features are only available if your customer onboarding workflows require OTP verification. You can enable OTP requests in the Instnt Dashboard Business Rules Configuration section for your customer sign-up workflow.
The OTP request and verification are the next steps in the end-user sign-up flow.
Step 1: To initiate an OTP request, invoke the end-point or an event of an SDK below:
The request format for the request is as listed:
{
"phoneNumber" : "+150849489",
"isVerify": false
}Step 2: To initiate a verified OTP request, invoke the endpoint or event of an SDK below.
The request format for the request is as listed:
{ "phoneNumber" : "+15084948925","isVerify": true
"otpCode" : "607766",
}
4. Submit Workflow
The last step in the sign-up process is to submit the user information. Then a final decision to accept, review, or reject returns based on the submitted user info.
Step 1: Invoke the following endpoint or event of a SDK-
If you are use Instnt API (Instead of Instnt SDKs) to submit data– make sure to call instnt.getToken() of Instnt SDK and pass the return data from this method as part of the submit payload.
If you use one of our SDKs to submit data, the SDK takes care of it.
Step 2: To check the status of the transaction invoke the following endpoint or event of a SDK-