Integration Flows

There are two approaches to launching the Intellicheck capture experience for a simple, low-code integration:

• Sending a Text to the Applicant. In this scenario, you want the applicant to start the process from a text. You include the send_link parameter in the /start endpoint request.
• Redirecting the Applicant from an App or Website. In this scenario, you want the applicant to start the process from your app or website. You include the return_capture_url parameter in the /start endpoint request.

👍

In both cases, you make a single API call to the /start endpoint.

Sending a Text to the Applicant

In this scenario, the applicant receives a text. The text includes a link that takes the applicant to our capture pages. After the applicant completes the capture steps, Intellicheck posts the processed results back to the client.

Here's a rundown of end-to-end validation that starts with a text:

1. The client makes a /sart API call that includes the send_link parameter with the applicant phone number.
2. Intellicheck returns a transaction_id for the transaction in the response.
3. Intellicheck sends a text to the applicant. The message body includes a unique URL for the applicant’s verification session.
4. The applicant selects the link to launch our capture pages.
5. The applicant completes the capture process, for example, by taking a picture of the front of the document (ocr_scan), scanning the barcode on the back (idcheck), and optionally taking a selfie (selfie).
6. Intellicheck processes the captured ID elements and posts the validation results back to the client results endpoint with the transaction_id.
7. Optionally, the client can provide a status endpoint for Intellicheck to post user journey updates to monitor the applicant’s state through the capture pages. This post back includes the transaction_id and indicates actions the applicant has taken during the capture process.

📘

Document Type Descriptions explains the types of documents we validate. Signal Descriptions describes the validation checks we perform.

Redirecting the Applicant from an App or Website

In this scenario, the applicant is redirected from the client app or website to Intellicheck capture pages. There is no text. We detect the applicant's browser type. If it's a PC browser, then we give the applicant a QR code to scan with their phone. If it's a mobile browser, then we skip the QR code and take the applicant directly to our capture pages. Either way, the process starts with a browser redirect. After the applicant completes the capture steps, Intellicheck posts the processed results back to the client.

Here's a rundown of end-to-end validation that starts with a redirect:

1. The client makes a /start API call that includes a true return_capture_url boolean value and an optional redirect_url to handle the following:
   • Redirect the applicant browser from the final capture step back to the client website or app.
2. Intellicheck returns a transaction_id for the transaction in the response.
3. Intellicheck returns the capture_url, which is a unique URL for the capture session.
4. The applicant browser is redirected to our capture pages.
5. The applicant completes the capture process, for example, by taking a picture of the front of the document (ocr_scan), scanning the barcode on the back (idcheck), and optionally taking a selfie (selfie).
6. Intellicheck processes the captured ID elements and posts the validation results back to the client results endpoint with the transaction_id.
7. Optionally, the client can provide a status endpoint for Intellicheck to post user journey updates to monitor the applicant’s state through the capture pages. This post back includes the transaction_id and indicates actions the applicant has taken during the capture process.
8. Upon completion of the steps, the applicant is redirected back to the client website or app.