Add background verification report for staff member

Adding a Background Verification (BGV) report for all In-scope staff members is mandatory to meet people management-related compliance requirements.

🚧

The Sprinto Developer API is in beta

• Endpoints may change as we add more functionality.

The following API code template shows how you can upload a BGV report for any active staff member on your Sprinto account. You'll need the following details to complete this task:

• Staff members' email address
• BGV report
• Verification completion date.

Refer to the below API call to make the following mutation

mutation UploadBackgroundVerificationReport($email: String!, $verificationCompletedOn: DateTime!, $verificationReportFile: Upload!) {
  uploadBackgroundVerificationReport(email: $email, verificationCompletedOn: $verificationCompletedOn, verificationReportFile: $verificationReportFile) {
    message
  }
}

{
  "data": {
    "uploadBackgroundVerificationReport": {
      "message": "BGV report is added for the staff"
    }
  }
}

Try yourself: United States: Europe: India

The API call starts with the root typeMutation followed up with operation name uploadBackgroundVerificationReport that defines the API call as a writing data call for uploading a BGV report against a staff member.

The arguments email, verificationCompletedOn, and verificationReportFile is used with assigned argument types String, DateTime, and Upload, respectively, and needs you to enter the value as a valid staff member's email address, verification completion date, and BGV report for the arguments.

📘

Create file uploading tag on API Playground: United States: Europe: India.

• On variables section, enter the key verificationReportfile and then click Select files to attach the report for upload.

The response field message is selected to give a success message on call execution.

Following are the response fields you can select for the following API call:

Below is the list of response codes and response messages you can get from the server for your executed API call: