/applicants/backgroundcheckresult

post

https://partners.apploi.com/applicants/backgroundcheckresult

Endpoint for updating background check results for a candidate. This endpoint allows the submission of background check results for a specific applicant.

Note: Every incoming request to the API must contain an API key. The request must include the applicant's ID and the background check result details in JSON format.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

applicant_id

integer

required

The ID of the job application for which the associated candidate's background check was processed. This is the application ID in the Apploi system. This can be retrieved from the id field in the object returned from the GET response of the /applicants endpoint.

decision

string

The decision about the candidate based on the results of the background check. This can be retrieved from the background check provider. Providing this information is not required to make a successful request.

error_message

string

The error message that was returned by the background check provider if the background check was unsuccessful. This can be retrieved from the background check provider. Either one of the report_url or the error_message field is required for a request to this endpoint to complete successfully. In the case of a successful background check, the report_url field should be provided. In the case of an unsuccessful background check, the error_message field should be provided.

package_id

string

The package ID of the background check order. This can be retrieved from the background check provider. Providing this information is not required to make a successful request.

report_url

string

The URL of the background check report. This can be retrieved from the background check provider. Either one of the report_url or the error_message field is required for a request to this endpoint to complete successfully. In the case of a successful background check, the report_url field should be provided. In the case of an unsuccessful background check, the error_message field should be provided.

Headers

_authorization

string

required

Responses

400

400 response

200200 response