Using our API with the Document Upload Portal Links

In order to link your applicant's sessions in the Document Upload Portal through the Snappt API, you must follow the following steps:

1. Create or Get a Snappt property using your API key

   1. Create a property via the POST /properties endpoint or if the property already exists, retrieve your property data via the GET /properties/{propertyId} endpoint.
   2. Store the property id value from your property's response payload

2. Send an applicant link via email

   1. 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.
      1. Store the applicantDetailId from your response payload to keep track of the applicant through this process
   2. 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

3. Receive document report for applicant

   1. 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.
   2. 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 from PENDING to READY

4. Associate multiple applicants

   1. Check the applicantDetailId in the response payloads of the REPORT_READY webhook or the GET /applicants response body

5. Download the applicant report

   1. Using applicantId from the REPORT_READY webhook payload, download the PDF report via the GET applicants/{applicantId}/report endpoint.
   2. Alternatively, if you are polling the GET /applicants endpoint, use the id value returned (this is the applicantId) to download the PDF report.

Please see this code example for more information on the process of linking applicant's data across multiple sessions.