Getting Started

This page will help you get started with Identity Verification via the Snappt Enterprise API

Identity Verification

Enabling Identity Verification

To start using the Identity Verification flow with your Snappt properties, the feature needs to be enabled on the property using the POST /properties/{propertyId}/identity-verification endpoint.

Create an Identity Verification Session

In order to create an ID Verification session, a partner generates an Identity upload link via the POST /id-verification/generate-identity-upload-link endpoint

• When you create an identity upload link, the Snappt Enterprise API returns a short-lived identityUploadLink that provides unique link to single identity upload session.

Track the session by storing the idVerificationId that is returned in the payload. This will be the applicant's id on look up.

A partner can also pass through their own important data by attaching their custom object as metadata in the body of the above endpoint. This metadata object will persist through to the IDV_REPORT_READY payload

Setting up a Redirect Url

Additionally, if a partner would like to redirect an applicant to a url once the ID Verification session is complete, a redirectUrl should be passed as a parameter. If the redirectUrl is not provided, then the user will remain on the completion page once finished with the session.

🚧

This upload link is single use and expires after 72 hours from creation

Checking for the IDV Report Ready Status

There are two ways you can check for the results of the application.

• Using the idVerificationId generated from above, you can check your report status via GET /id-verification/applicants/{idVerificationId}

OR

• You can implement a webhook and wait for the IDV_REPORT_READY webhook event to be sent. You can read more about it here

📘

Identity Verification applicants and Fraud Detection applicants do not share id's and are not linked

Obtaining a Report

The PDF report linked from the identity verification API will contain the verdict that determines if the identity documents are fraudulent or clean.

• Use the GET /id-verification/applicants/{idVerificationId}/report endpoint to download the PDF report.
• Using the PUT /properties/{propertyId}/identity-verification/settings endpoint, a partner can customize an Identity Verification report on a per property basis and attach the selfie or document from the Identity Verification session to the PDF report.