Add evidence for workflow check

Use the Sprinto Developer API to upload evidence files for a workflow check and update its evidence status.

This cookbook explains how to upload evidence for a workflow check configured in your Sprinto account using the Sprinto Developer API.

Uploading evidence allows you to satisfy control requirements linked to workflow checks and move them towards compliance. This process involves two steps:

  1. Retrieve the workflow check UUID.

  2. Upload evidence for the selected workflow check.

Both steps are performed using GraphQL operations.


Before you begin

Ensure that you have:

  • A valid API key

  • Access to the Sprinto API Playground (if using the playground)

  • At least one active workflow check

  • An evidence file to upload

  • The evidence record date


API status

The Sprinto Developer API is currently in beta.

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


Step 1: Get the workflow check UUID

To upload evidence, you first need the UUID (pk) of the workflow check.

Query workflow checks

Use the following query to retrieve workflow checks from your Sprinto account.

Try yourself: United States: Europe: India

Copy the pk value of the workflow check for which you want to upload evidence.

Pagination note

If the required workflow check is not returned:

  • Use the after argument with the cursor value from the previous response.

  • Refer to the Pagination documentation for details.


Step 2: Upload evidence for the workflow check

Once you have the workflow check UUID, use the following mutation to upload evidence.


Mutation: uploadWorkflowCheckEvidence

Input arguments

Argument
Type
Required
Description

workflowCheckPk

UUID

Yes

UUID of the workflow check

evidenceRecordDate

DateTime

Yes

Date the evidence was recorded (YYYY-MM-DD)

evidenceFile

Upload

Yes

Evidence file to upload


Example mutation

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 evidenceFile.

  2. Select Choose files and upload the evidence file from your computer.

  3. Ensure the file key matches the mutation argument name exactly.


Supported file formats

The following file formats are supported for evidence uploads:

  • .doc, .docx, .dotx

  • .xls, .xlsx

  • .pdf

  • .zip, .tar

  • .odt, .ods

Uploading unsupported file formats results in an error.


Response codes and errors

The following response codes may be returned for this operation:

Status code
Status
Message
Reason

200

Success

Evidence uploaded for this check.

The evidence was uploaded successfully.

200

Error

Incorrect check ID, evidence cannot be uploaded.

The workflow check UUID is invalid.

200

Error

The check is in review, so evidence cannot be uploaded.

Evidence can be uploaded only after review is completed.

200

Error

Unable to upload this file format.

The uploaded file format is not supported.

401

Unauthorized

Invalid or expired API token.

The API key is invalid or disabled.

429

Too many requests

Too many requests. Please try again later.

The API rate limit has been exceeded.


Next steps

After uploading evidence for a workflow check, you can:

  • Monitor evidence status using workflow check queries

  • Upload additional evidence after reviews are completed

  • Automate evidence uploads for recurring checks

Last updated