Sending Invites

Step 1: Create an authentication token

To get started with sending invites to your applicants, you first need to create an authentication token to make API requests.

Step 2: Create an applicant group

Once you have a token, you can then start sending invites to your applicants by creating an applicant group with the applicant information and their corresponding verifications that they are required to complete. This will automatically send invites to each applicant via email and text message, depending on whether the phone number was passed to Payscore.

In our production environment, we will validate whether the applicants' emails are valid and exist to prevent typos. If the email does not exist, you will receive a 400 Bad Request. An example of the error response can be seen in the Response examples here.

Reminders are automatically sent to each applicant after 12 or 24 hours, with a maximum of 3 reminders. These settings can be configured in your portal.

Step 3: Listen for webhooks

After the invite is sent, you can listen to our webhooks to get status updates on the verification and whether the report is ready or not.

Step 4: Fetch the report

Once the applicant's verification is completed, you can fetch the report in either PDF or in JSON format.