> ## Documentation Index
> Fetch the complete documentation index at: https://docs.urtentic.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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




## OpenAPI

````yaml /api-reference/openapi.yml get /workflows/{workflowId}/document-types
openapi: 3.0.0
info:
  title: Urtentic API
  version: '1.0'
  description: >
    # Introduction

    The Urtentic API provides comprehensive identity verification and workflow
    management capabilities. 

    It enables organizations to create customized verification workflows,
    perform identity checks, 

    and manage verification processes with features including liveness
    detection, 

    location intelligence, and document verification.


    ## Authentication

    All authenticated endpoints require two headers:

    - `Authorization: Bearer {API_KEY}` - Your API key

    - `X-CLIENT-ID: {CLIENT_ID}` - Your client ID


    API credentials can be generated from your Urtentic Dashboard under Settings
    > API Keys.


    ## Webhook Notifications

    Configure webhook URLs in your Urtentic Dashboard to receive real-time
    notifications

    about verification status changes. Webhooks include the verification ID and
    current status,

    allowing your system to react to verification completions or failures.


    ## Key Features

    - User and organization management

    - Customizable verification workflows

    - Multiple verification processes (Liveness, Location, Document, Watchlist
    Check, Email)

    - Analytics and reporting

    - Webhook notifications for verification results
  contact:
    name: Urtentic Support Team
    email: support@urtentic.com
    url: https://urtentic.com/support
  termsOfService: https://urtentic.com/terms
  license:
    name: Urtentic License
    url: https://urtentic.com/license
servers:
  - url: https://api.urtentic.com/api/v1
    description: Urtentic API
security: []
tags:
  - name: Identity
    description: >
      Management of verified identity data, including retrieval and validation
      of identity information.


      Endpoints in this category allow you to:

      - Retrieve verified identity details

      - Check identity verification status

      - Update identity information

      - Link identities across verification sessions
  - name: Processes
    description: >
      Configuration and management of individual verification process types that
      can be used in workflows.


      The Urtentic platform supports these verification processes:

      - **Document Verification**: OCR and authenticity checks for identity
      documents

      - **Liveness Detection**: Confirms a person is physically present and not
      using photos/videos

      - **Location Intelligence**: Verifies geographic location and environments

      - **Email Verification**: Validates email ownership through OTP

      - **Watchlist Check**: Screens identities against compliance databases
  - name: Verification
    description: >
      Core verification operations including starting verifications, submitting
      verification data, and retrieving results.


      Key operations include:

      - Starting new verification sessions

      - Submitting identity data for verification

      - Retrieving verification results

      - Validating inputs before submission

      - Tracking verification status
  - name: Webhook
    description: >
      Configuration and management of webhook endpoints for receiving real-time
      event notifications.


      The webhook system allows you to:

      - Receive real-time notifications about verification status changes

      - Configure multiple webhook endpoints for different environments

      - Specify which events trigger notifications

      - Verify webhook signature to ensure authenticity

      - Track webhook delivery and retry failed deliveries
  - name: Workflow
    description: >
      Creation and management of verification workflows, combining multiple
      verification processes into customized sequences.


      Workflows allow you to:

      - Define multi-step verification sequences

      - Configure country-specific document requirements

      - Set custom verification rules and thresholds

      - Create specialized flows for different use cases

      - Manage verification process order and dependencies
paths:
  /workflows/{workflowId}/document-types:
    parameters:
      - name: workflowId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: >
          Unique identifier of the workflow.

          This is the ID of the verification workflow you've configured in the
          Urtentic Dashboard.
        example: 40f85c69-b27a-46e8-9115-691401acb5df
      - name: countryCode
        in: query
        required: true
        schema:
          type: string
        description: >
          ISO 3166-1 alpha-2 country code to filter document types.

          Only document types available for the specified country will be
          returned.
        example: US
      - name: step
        in: query
        required: true
        schema:
          type: integer
          minimum: 0
        description: |
          Workflow step index. This corresponds to the step in your multi-step
          verification workflow where document selection occurs.
        example: 0
    get:
      tags:
        - Workflow
      summary: Get Document Types By WorkflowId
      description: >
        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
      operationId: get-workflow-document-types
      responses:
        '200':
          description: List of configured document types
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DocumentType'
              examples:
                response:
                  value:
                    - name: DRIVERS_LICENSE
                      label: Driver's License
                      sides:
                        - FRONT
                        - BACK
                      subTypes:
                        - countryName: United States
                          countryCode: US
                          countryFlag: 🇺🇸
                          region: North America
        '400':
          description: Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
              examples:
                invalid_country:
                  value:
                    error: INVALID_COUNTRY_CODE
                    message: The country code 'XX' is not valid
        '404':
          description: Workflow not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
              examples:
                workflow_not_found:
                  value:
                    error: WORKFLOW_NOT_FOUND
                    message: The specified workflow could not be found
      security: []
components:
  schemas:
    DocumentType:
      type: object
      description: |
        Information about a supported identity document type. This schema
        defines the properties and structure of document types that can
        be used for verification.
      properties:
        name:
          type: string
          description: |
            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:
          type: string
          description: Human-readable name of the document type
          example: International Passport
        sides:
          type: array
          description: |
            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).
          items:
            type: string
            enum:
              - FRONT
              - BACK
          example:
            - FRONT
        subTypes:
          type: array
          description: |
            List of country-specific subtypes for this document.
            Different countries may have different document formats
            or requirements for the same document type.
          items:
            $ref: '#/components/schemas/SubDocumentType'
          example: []
      example:
        name: PASSPORT
        label: International Passport
        sides:
          - FRONT
        subTypes: []
    SubDocumentType:
      type: object
      description: |
        Country-specific document type information. This provides
        details for documents that vary in format or requirements
        based on the issuing country.
      properties:
        countryName:
          type: string
          description: Name of the country
          example: Nigeria
        countryCode:
          type: string
          description: ISO 3166-1 alpha-2 country code
          example: NG
        countryFlag:
          type: string
          description: Country flag representation (emoji or URL)
          example: 🇳🇬
        region:
          type: string
          description: Geographic region of the country
          example: Africa
        documentTypes:
          type: array
          description: List of document types available for this country
          items:
            $ref: '#/components/schemas/DocumentType'
          default: []
          example: []
      example:
        countryName: Nigeria
        countryCode: NG
        countryFlag: 🇳🇬
        region: Africa
        documentTypes: []

````