Skip to main content
The generateVerificationToken mutation creates a verification token for an active Fidel80 workflow.

Authentication

This mutation requires a valid Fidel80 API key.

Mutation

Example variables

Required fields

workflowId

The ID of the active workflow to use for the verification. The workflow must belong to the authenticated organization.

workflowVersionId

The ID of the workflow version to use. The version must belong to the selected workflow.

Optional fields

Supported optional inputs include:
  • applicantFirstName
  • applicantLastName
  • applicantEmail
  • applicantPhone
  • profileId
  • metadata
  • expiresInHours

Successful response

A successful request returns a tokenString. Example:
Use the returned token to construct the applicant verification URL:

Validation performed by Fidel80

Before generating a token, Fidel80 verifies that:
  • the request is authenticated,
  • the authenticated user belongs to an organization,
  • the selected workflow belongs to that organization,
  • the workflow is active,
  • the selected workflow version belongs to the workflow,
  • applicable subscription and usage limits permit the verification.
If a profileId is provided, that profile must also belong to the authenticated organization.