UiPath · JSON Structure

Document Understanding Digitization Request Structure

Request payload for digitizing a document

Type: object Properties: 3 Required: 1
AutomationRobotic Process AutomationRPAArtificial IntelligenceDocument ProcessingEnterprise AutomationOrchestrationTesting

DigitizationRequest is a JSON Structure definition published by UiPath, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

documentId contentType documentBase64

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/uipath/refs/heads/main/json-structure/document-understanding-digitization-request-structure.json",
  "name": "DigitizationRequest",
  "description": "Request payload for digitizing a document",
  "type": "object",
  "required": [
    "documentId"
  ],
  "properties": {
    "documentId": {
      "type": "string",
      "description": "Reference identifier for the document. This can be a file path or a document reference key used by UiPath activities.",
      "example": "abc123"
    },
    "contentType": {
      "type": "string",
      "enum": [
        "image/jpeg",
        "image/png",
        "application/pdf",
        "image/tiff"
      ],
      "description": "MIME type of the document being submitted",
      "example": "image/jpeg"
    },
    "documentBase64": {
      "type": "string",
      "description": "Base64-encoded document content when submitting inline",
      "example": "example-value"
    }
  }
}