Overview

This endpoint allows the submission of employment details for an individual. When the manual verification flag is turned off, this API returns instant results.

The manual verification flag is used to enable/disable a manual verification fallback in case the instant API check fails.

How does manual verification work?

The manual verification fallback is triggered when the employerName fails instant verification.

This could be either because the submitted data did not match the data we could access, or if no data was found for employerName.

Request Body

When the manual verification flag is turned off

The required fields include:

employerName
jobTitle
startDate
currentlyEmployed
manualVerification.

Submission won't proceed without these fields.

When the manual verification flag is turned on

If manualVerification is set to true, additional details for manual verification must be provided under the property manualVerificationDetails.

These include:

employerAddress
employerAddressCity
employerAddressState
employerAddressCountry
supervisorName
supervisorContactInfo

Other parameters

In the parameters, 1 represents true and 0 represents false. For instance, setting currentlyEmployed to 1 indicates that the user will be considered as an active employee and vice-versa.

200success

400Bad Request

401unauthorized Request