Add background verification report for staff member

This cookbook explains how to upload a background verification (BGV) report for a staff member using the Sprinto Developer API.

Uploading a BGV report is mandatory for in-scope staff members to meet people-management and compliance requirements in Sprinto.

This operation is performed using a GraphQL mutation.

Before you begin

Ensure that you have:

• A valid API key
• Access to the Sprinto API Playground (if using the playground)
• The email address of the staff member
• The BGV report file
• The verification completion date

The staff member must be active and in-scope. If these conditions are not met, the API returns an error.

API status

The Sprinto Developer API is currently in beta.

• Endpoints and schema fields may change as new functionality is introduced.

Mutation: uploadBackgroundVerificationReport

This mutation uploads a BGV report for a staff member and records the date on which verification was completed.

Input arguments

Example mutation

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

Try yourself: United States: Europe: India

Uploading files in the API Playground

When using the Sprinto API Playground:

1. In the Variables section, add the key verificationReportFile.
2. Select Choose files and attach the BGV report.
3. Ensure the file key matches the mutation argument name exactly.

Supported file formats

The following file formats are supported for BGV uploads:

• .text, .txt
• .doc, .docx, .dotx, .odt
• .pdf
• .zip
• .xls, .xlsx

Uploading unsupported file formats results in an error.

Response fields

Response codes and errors

The following response codes may be returned for this mutation:

Next steps

After uploading a BGV report, you can:

• Verify staff compliance status using queries
• Upload additional evidence for workflow checks
• Automate BGV uploads as part of onboarding workflows