Get Supported Document Types
curl --request GET \
--url https://api.urtentic.com/api/v1/workflows/supported-document-typesimport requests
url = "https://api.urtentic.com/api/v1/workflows/supported-document-types"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.urtentic.com/api/v1/workflows/supported-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/supported-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/supported-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/supported-document-types")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.urtentic.com/api/v1/workflows/supported-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": "PASSPORT",
"label": "International Passport",
"sides": [
"FRONT"
],
"subTypes": []
},
{
"name": "DRIVERS_LICENSE",
"label": "Driver's License",
"sides": [
"FRONT",
"BACK"
],
"subTypes": []
},
{
"name": "NATIONAL_ID",
"label": "National ID Card",
"sides": [
"FRONT",
"BACK"
],
"subTypes": []
}
]Workflows
Get Supported Document Types
Retrieves all supported document types for identity verification. This endpoint returns a list of document types that can be used in verification workflows, including their labels and which sides (front/back) are required.
Use Cases
- Populating document type selection dropdowns in your application
- Determining which document types are available for verification
- Checking which sides need to be captured for each document type
Notes
- This endpoint doesnβt require authentication
- The response includes all globally supported document types
- For country-specific document types, use the
/workflows/{workflowId}/document-typesendpoint
GET
/
workflows
/
supported-document-types
Get Supported Document Types
curl --request GET \
--url https://api.urtentic.com/api/v1/workflows/supported-document-typesimport requests
url = "https://api.urtentic.com/api/v1/workflows/supported-document-types"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.urtentic.com/api/v1/workflows/supported-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/supported-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/supported-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/supported-document-types")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.urtentic.com/api/v1/workflows/supported-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": "PASSPORT",
"label": "International Passport",
"sides": [
"FRONT"
],
"subTypes": []
},
{
"name": "DRIVERS_LICENSE",
"label": "Driver's License",
"sides": [
"FRONT",
"BACK"
],
"subTypes": []
},
{
"name": "NATIONAL_ID",
"label": "National ID Card",
"sides": [
"FRONT",
"BACK"
],
"subTypes": []
}
]Response
200 - application/json
List of supported 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
Example:
"PASSPORT"
Human-readable name of the document type
Example:
"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).
Available options:
FRONT, BACK Example:
["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
Example:
[]