Veryfi · Schema

Error

API error response

AIDocument ProcessingFinanceInvoicesOCRReceiptsTax Forms

Properties

Name Type Description
status integer HTTP status code
error string Error type
message string Human-readable error message
View JSON Schema on GitHub

JSON Schema

veryfi-error-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Error",
  "title": "Error",
  "type": "object",
  "description": "API error response",
  "properties": {
    "status": {
      "type": "integer",
      "description": "HTTP status code"
    },
    "error": {
      "type": "string",
      "description": "Error type"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}