identifyDocument

Identify document type from an image

POST/api/identify

Automatically identify the document type from a provided list of options.

Supported file formats:

image/jpeg (JPEG)
image/png (PNG)
image/gif (GIF)
image/bmp (BMP)
image/webp (WebP)
application/pdf (PDF)

Size limits:

Maximum file size: 100MB
URL download timeout: 30 seconds

Request methods:

multipart/form-data: Direct file upload
application/json with base64: Base64-encoded image
application/json with URL: Image URL for automatic download

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Bearer token for API authentication

In: header

Request Body

image*string

Image file to identify (see supported formats)

document_type_code_options*string

JSON array of document type codes to consider (e.g., '["INVOICE", "RECEIPT"]')

document_metadata?object

Additional document metadata as JSON string (optional)

Response Body

`application/json`

curl -X POST "https://app.docutray.com/api/identify" \  -H "Content-Type: application/json" \  -d '{    "image_base64": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAAA==",    "document_type_code_options": [      "invoice",      "receipt"    ]  }'

{
  "document_type": {
    "code": "invoice",
    "name": "Invoice",
    "confidence": 0.95
  },
  "alternatives": [
    {
      "code": "invoice",
      "name": "Invoice",
      "confidence": 0.95
    },
    {
      "code": "receipt",
      "name": "Receipt",
      "confidence": 0.05
    }
  ]
}

{
  "message": "Validation error",
  "errors": [
    "string"
  ]
}

{
  "error": "Invalid API key"
}

{
  "message": "You do not have permission to use the following document types: invoice, receipt"
}

{
  "message": "Error accessing URL: 404 Not Found"
}

{
  "message": "URL download timeout (30000ms)"
}

{
  "message": "File exceeds maximum allowed size (100MB)"
}

{
  "message": "Unsupported Content-Type. Use multipart/form-data or application/json."
}

{
  "error": "Rate limit exceeded",
  "limitType": "minute",
  "limit": 0,
  "remaining": 0,
  "resetTime": 0,
  "retryAfter": 0
}

{
  "message": "Internal server error: Failed to process image"
}

identifyDocument

Identify document type from an image

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

408application/json

413application/json

415application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`