curl --request GET \
--url https://api.urtentic.com/api/v1/workflows/{workflowId}/document-typesimport requests
url = "https://api.urtentic.com/api/v1/workflows/{workflowId}/document-types"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.urtentic.com/api/v1/workflows/{workflowId}/document-types', 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/workflows/{workflowId}/document-types",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.urtentic.com/api/v1/workflows/{workflowId}/document-types"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.urtentic.com/api/v1/workflows/{workflowId}/document-types")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.urtentic.com/api/v1/workflows/{workflowId}/document-types")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body[
{
"name": "DRIVERS_LICENSE",
"label": "Driver's License",
"sides": [
"FRONT",
"BACK"
],
"subTypes": [
{
"countryName": "United States",
"countryCode": "US",
"countryFlag": "πΊπΈ",
"region": "North America"
}
]
}
]{
"error": "INVALID_COUNTRY_CODE",
"message": "The country code 'XX' is not valid"
}{
"error": "WORKFLOW_NOT_FOUND",
"message": "The specified workflow could not be found"
}Get Document Types By WorkflowId
Retrieves document types configured for a specific workflow, country, and step. This endpoint returns a filtered list of document types based on the workflow configuration and the specified country.
Use Cases
- Displaying available document types for a specific country
- Showing country-specific document subtypes
- Adapting your UI based on the document requirements for a country
Notes
- This endpoint doesnβt require authentication
- The response is filtered based on workflow configuration
- Only document types supported for the specified country are returned
- The step parameter allows targeting a specific verification step
curl --request GET \
--url https://api.urtentic.com/api/v1/workflows/{workflowId}/document-typesimport requests
url = "https://api.urtentic.com/api/v1/workflows/{workflowId}/document-types"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.urtentic.com/api/v1/workflows/{workflowId}/document-types', 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/workflows/{workflowId}/document-types",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.urtentic.com/api/v1/workflows/{workflowId}/document-types"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.urtentic.com/api/v1/workflows/{workflowId}/document-types")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.urtentic.com/api/v1/workflows/{workflowId}/document-types")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body[
{
"name": "DRIVERS_LICENSE",
"label": "Driver's License",
"sides": [
"FRONT",
"BACK"
],
"subTypes": [
{
"countryName": "United States",
"countryCode": "US",
"countryFlag": "πΊπΈ",
"region": "North America"
}
]
}
]{
"error": "INVALID_COUNTRY_CODE",
"message": "The country code 'XX' is not valid"
}{
"error": "WORKFLOW_NOT_FOUND",
"message": "The specified workflow could not be found"
}Path Parameters
Unique identifier of the workflow. This is the ID of the verification workflow you've configured in the Urtentic Dashboard.
Query Parameters
ISO 3166-1 alpha-2 country code to filter document types. Only document types available for the specified country will be returned.
Workflow step index. This corresponds to the step in your multi-step verification workflow where document selection occurs.
x >= 0Response
List of configured document types
Internal identifier for the document type. Common document types:
- PASSPORT: International passport
- DRIVERS_LICENSE: Driver's license
- NATIONAL_ID: National ID card
- RESIDENCE_PERMIT: Residence permit
- VOTER_ID: Voter identification card
"PASSPORT"
Human-readable name of the document type
"International Passport"
List of required document sides/pages. Some documents require only the front side (like passports), while others require both front and back sides (like driver's licenses).
FRONT, BACK ["FRONT"]
List of country-specific subtypes for this document. Different countries may have different document formats or requirements for the same document type.
Show child attributes
Show child attributes
[]