Getting Started

To start using the Snappt Enterprise API you need to request for an API key. Once you have an API key, you can use the API to manage properties and applicants, configure webhooks, view application results, and build your own document submission flow.

Creating and Submitting an Application

The following steps are required to submit documents to the Snappt Enterprise API and verify their authenticity. At a high level, you need to:

Create an application session using your API key.
Update the applicant's personal information, such as their first and last name and the unit they're applying for, to their application.
Upload the applicant's documents by uploading them to the session one-by-one.
Submit the application.

When you create an application session, the Snappt Enterprise API returns a short-lived Session Token that provides read/write access to a single application session. You can pass this token to your client-side JavaScript as necessary to implement your document upload portal. Session tokens expire after 24 hours or upon application submission.

Checking for the Report Ready Status

Once you submit an application, you'll receive an applicant ID in the response body. There are two ways you can check for the results of the application.

You can poll the Applicant endpoint using your API Key to check for the report status.

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

Obtaining a Report

The PDF report linked from the applicant API will contain all the information about the application and the verdict that determines if the documents are fraudulent or clean.

Use the PDF report endpoint to download the PDF report.