Using our API with the Document Upload Portal Links
We have created an option for our partners to use the API in conjunction with our document upload portal.
In order to link your applicant's sessions in the Document Upload Portal through the Snappt API, you must follow the following steps:
-
Create or Get a Snappt property using your API key
- Create a property via the POST /properties endpoint or if the property already exists, retrieve your property data via the GET /properties/{propertyId} endpoint.
- Store the property
id
value from your property's response payload
-
Send an applicant link via email
- Using your property
id
, call the endpoint POST /properties/{propertyId}/send-document-upload-email to send an email with a link the Snappt Document Upload Portal.- Store the
applicantDetailId
from your response payload to keep track of the applicant through this process
- Store the
- If you are sending a second email to an applicant and want to link the applicant's sessions then pass the
applicantIdentifier
that you stored from the response body of your first email attempt
- Using your property
-
Receive document report for applicant
- If you have set up a webhook, wait for the
REPORT READY
webhook event to be sent. For more information on payload structure, please reference this document. - If no webhook has been setup then you can poll the applicants for your properties via the GET /applicants endpoint and check for the applicant
status
to change fromPENDING
toREADY
- If you have set up a webhook, wait for the
-
Associate multiple applicants
- Check the
applicantDetailId
in the response payloads of theREPORT_READY
webhook or the GET /applicants response body
- Check the
-
Download the applicant report
- Using
applicantId
from theREPORT_READY
webhook payload, download the PDF report via the GET applicants/{applicantId}/report endpoint. - Alternatively, if you are polling the GET /applicants endpoint, use the
id
value returned (this is theapplicantId
) to download the PDF report.
- Using
Please see this code example for more information on the process of linking applicant's data across multiple sessions.
Updated 9 months ago