Skip to main content
GET
/
workflows
/
{workflowId}
/
document-types
Get Document Types By WorkflowId
curl --request GET \
  --url https://api.urtentic.com/api/v1/workflows/{workflowId}/document-types
[
  {
    "name": "DRIVERS_LICENSE",
    "label": "Driver's License",
    "sides": [
      "FRONT",
      "BACK"
    ],
    "subTypes": [
      {
        "countryName": "United States",
        "countryCode": "US",
        "countryFlag": "🇺🇸",
        "region": "North America"
      }
    ]
  }
]

Path Parameters

​
workflowId
string<uuid>
required

Unique identifier of the workflow. This is the ID of the verification workflow you've configured in the Urtentic Dashboard.

Query Parameters

​
countryCode
string
required

ISO 3166-1 alpha-2 country code to filter document types. Only document types available for the specified country will be returned.

​
step
integer
required

Workflow step index. This corresponds to the step in your multi-step verification workflow where document selection occurs.

Required range: x >= 0

Response

List of configured document types

​
name
string

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"

​
label
string

Human-readable name of the document type

Example:

"International Passport"

​
sides
enum<string>[]

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"]
​
subTypes
object[]

List of country-specific subtypes for this document. Different countries may have different document formats or requirements for the same document type.

Example:
[]