Start verification
Initiates a new verification process using a specified workflow. The API key must have sufficient permissions to start verifications. Metadata can be included to track custom information throughout the verification process.
Use Cases
- Starting a new user verification process
- Creating a verification session for your application
- Configuring a verification flow with custom metadata
Notes
- This endpoint requires an API key with verification creation permissions
- The flowId must correspond to a workflow configured in your Urtentic account
- Metadata fields are optional but recommended for tracking and correlation
- The response includes all required input fields and settings for the verification
Body
Request to start a new verification process. This initiates a verification workflow for a user and returns the verification configuration.
ID of the workflow to be executed
"40f85c69-b27a-46e8-9115-691401acb5df"
Additional data to be associated with the verification. This information is stored with the verification record and can be used for tracking, correlation, or custom business logic.
Common metadata fields:
- reference: Your internal reference ID
- email: User's email address
- userId: Your system's user identifier
- deviceId: Device identifier
- ipAddress: User's IP address (automatically captured if not provided)
- redirectUrl: URL to redirect users after verification (if using redirect flows)
Response
Verification started successfully
Response returned when starting a new verification. This contains all the information needed to guide the user through the verification process.
Additional metadata associated with the verification
Unique identifier of the workflow being used
"40f85c69-b27a-46e8-9115-691401acb5df"
Unique identifier for the identity being verified
"32a5b2d6-7c9e-4815-a599-fd03d6b34c53"
Unique identifier for this verification attempt
"85c94e71-6e3f-4a19-b15c-781d8a876542"
IP address from which the verification was initiated
"192.168.1.1"
List of required input fields for the verification
List of configuration settings for the verification