Skip to main content
GET
/
workflows
/
supported-document-types
Get Supported Document Types
curl --request GET \
  --url https://api.urtentic.com/api/v1/workflows/supported-document-types
[
  {
    "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

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:
[]