curl --request POST \
--url https://api.urtentic.com/api/v1/verifications \
--header 'Content-Type: application/json' \
--data '
{
"flowId": "40f85c69-b27a-46e8-9115-691401acb5df",
"metadata": {
"email": "user@example.com",
"reference": "USER123",
"customerId": "CUST-456",
"deviceId": "D-789012"
}
}
'import requests
url = "https://api.urtentic.com/api/v1/verifications"
payload = {
"flowId": "40f85c69-b27a-46e8-9115-691401acb5df",
"metadata": {
"email": "user@example.com",
"reference": "USER123",
"customerId": "CUST-456",
"deviceId": "D-789012"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
flowId: '40f85c69-b27a-46e8-9115-691401acb5df',
metadata: {
email: 'user@example.com',
reference: 'USER123',
customerId: 'CUST-456',
deviceId: 'D-789012'
}
})
};
fetch('https://api.urtentic.com/api/v1/verifications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.urtentic.com/api/v1/verifications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'flowId' => '40f85c69-b27a-46e8-9115-691401acb5df',
'metadata' => [
'email' => 'user@example.com',
'reference' => 'USER123',
'customerId' => 'CUST-456',
'deviceId' => 'D-789012'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.urtentic.com/api/v1/verifications"
payload := strings.NewReader("{\n \"flowId\": \"40f85c69-b27a-46e8-9115-691401acb5df\",\n \"metadata\": {\n \"email\": \"user@example.com\",\n \"reference\": \"USER123\",\n \"customerId\": \"CUST-456\",\n \"deviceId\": \"D-789012\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.urtentic.com/api/v1/verifications")
.header("Content-Type", "application/json")
.body("{\n \"flowId\": \"40f85c69-b27a-46e8-9115-691401acb5df\",\n \"metadata\": {\n \"email\": \"user@example.com\",\n \"reference\": \"USER123\",\n \"customerId\": \"CUST-456\",\n \"deviceId\": \"D-789012\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.urtentic.com/api/v1/verifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"flowId\": \"40f85c69-b27a-46e8-9115-691401acb5df\",\n \"metadata\": {\n \"email\": \"user@example.com\",\n \"reference\": \"USER123\",\n \"customerId\": \"CUST-456\",\n \"deviceId\": \"D-789012\"\n }\n}"
response = http.request(request)
puts response.read_body{
"metadata": {
"email": "user@example.com",
"reference": "USER123"
},
"flowId": "40f85c69-b27a-46e8-9115-691401acb5df",
"identityId": "32a5b2d6-7c9e-4815-a599-fd03d6b34c53",
"verificationId": "85c94e71-6e3f-4a19-b15c-781d8a876542",
"ipAddress": "192.168.1.1",
"inputs": [
{
"fieldName": "SELFIE_VIDEO",
"description": "A short video of your face for liveness detection",
"group": 1,
"fieldType": "FILE",
"optional": false
},
{
"fieldName": "DOCUMENT_TYPE",
"description": "Select your ID document type",
"group": 2,
"fieldType": "DROPDOWN",
"data": {
"options": [
"PASSPORT",
"DRIVERS_LICENSE",
"NATIONAL_ID"
]
},
"optional": false
}
],
"settings": [
{
"id": 123,
"createdAt": "2023-06-15T14:30:00Z",
"updatedAt": "2023-06-15T14:30:00Z",
"value": "true",
"fieldName": "GALLERY_RESTRICTION",
"type": "BOOLEAN"
}
]
}{
"error": "INVALID_WORKFLOW",
"message": "The specified workflow ID is invalid or not found"
}{
"error": "INVALID_API_KEY",
"message": "The provided API key is invalid or expired"
}{
"error": "INSUFFICIENT_PERMISSIONS",
"message": "Your API key does not have permission to create verifications"
}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
curl --request POST \
--url https://api.urtentic.com/api/v1/verifications \
--header 'Content-Type: application/json' \
--data '
{
"flowId": "40f85c69-b27a-46e8-9115-691401acb5df",
"metadata": {
"email": "user@example.com",
"reference": "USER123",
"customerId": "CUST-456",
"deviceId": "D-789012"
}
}
'import requests
url = "https://api.urtentic.com/api/v1/verifications"
payload = {
"flowId": "40f85c69-b27a-46e8-9115-691401acb5df",
"metadata": {
"email": "user@example.com",
"reference": "USER123",
"customerId": "CUST-456",
"deviceId": "D-789012"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
flowId: '40f85c69-b27a-46e8-9115-691401acb5df',
metadata: {
email: 'user@example.com',
reference: 'USER123',
customerId: 'CUST-456',
deviceId: 'D-789012'
}
})
};
fetch('https://api.urtentic.com/api/v1/verifications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.urtentic.com/api/v1/verifications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'flowId' => '40f85c69-b27a-46e8-9115-691401acb5df',
'metadata' => [
'email' => 'user@example.com',
'reference' => 'USER123',
'customerId' => 'CUST-456',
'deviceId' => 'D-789012'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.urtentic.com/api/v1/verifications"
payload := strings.NewReader("{\n \"flowId\": \"40f85c69-b27a-46e8-9115-691401acb5df\",\n \"metadata\": {\n \"email\": \"user@example.com\",\n \"reference\": \"USER123\",\n \"customerId\": \"CUST-456\",\n \"deviceId\": \"D-789012\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.urtentic.com/api/v1/verifications")
.header("Content-Type", "application/json")
.body("{\n \"flowId\": \"40f85c69-b27a-46e8-9115-691401acb5df\",\n \"metadata\": {\n \"email\": \"user@example.com\",\n \"reference\": \"USER123\",\n \"customerId\": \"CUST-456\",\n \"deviceId\": \"D-789012\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.urtentic.com/api/v1/verifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"flowId\": \"40f85c69-b27a-46e8-9115-691401acb5df\",\n \"metadata\": {\n \"email\": \"user@example.com\",\n \"reference\": \"USER123\",\n \"customerId\": \"CUST-456\",\n \"deviceId\": \"D-789012\"\n }\n}"
response = http.request(request)
puts response.read_body{
"metadata": {
"email": "user@example.com",
"reference": "USER123"
},
"flowId": "40f85c69-b27a-46e8-9115-691401acb5df",
"identityId": "32a5b2d6-7c9e-4815-a599-fd03d6b34c53",
"verificationId": "85c94e71-6e3f-4a19-b15c-781d8a876542",
"ipAddress": "192.168.1.1",
"inputs": [
{
"fieldName": "SELFIE_VIDEO",
"description": "A short video of your face for liveness detection",
"group": 1,
"fieldType": "FILE",
"optional": false
},
{
"fieldName": "DOCUMENT_TYPE",
"description": "Select your ID document type",
"group": 2,
"fieldType": "DROPDOWN",
"data": {
"options": [
"PASSPORT",
"DRIVERS_LICENSE",
"NATIONAL_ID"
]
},
"optional": false
}
],
"settings": [
{
"id": 123,
"createdAt": "2023-06-15T14:30:00Z",
"updatedAt": "2023-06-15T14:30:00Z",
"value": "true",
"fieldName": "GALLERY_RESTRICTION",
"type": "BOOLEAN"
}
]
}{
"error": "INVALID_WORKFLOW",
"message": "The specified workflow ID is invalid or not found"
}{
"error": "INVALID_API_KEY",
"message": "The provided API key is invalid or expired"
}{
"error": "INSUFFICIENT_PERMISSIONS",
"message": "Your API key does not have permission to create verifications"
}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)
{ "email": "user@example.com", "reference": "USER123", "customerId": "CUST-456", "deviceId": "D-789012" }
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
Show child attributes
Show child attributes
{ "email": "user@example.com", "reference": "USER123" }
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
Show child attributes
Show child attributes
[ { "fieldName": "SELFIE_VIDEO", "description": "A short video of your face for liveness detection", "group": 1, "fieldType": "FILE", "optional": false }, { "fieldName": "DOCUMENT_TYPE", "description": "Select your ID document type", "group": 2, "fieldType": "DROPDOWN", "data": { "options": [ "PASSPORT", "DRIVERS_LICENSE", "NATIONAL_ID" ] }, "optional": false } ]
List of configuration settings for the verification
Show child attributes
Show child attributes
[ { "id": 123, "createdAt": "2023-06-15T14:30:00Z", "updatedAt": "2023-06-15T14:30:00Z", "value": "true", "fieldName": "GALLERY_RESTRICTION", "type": "BOOLEAN" } ]