Skip to main content
The Extract OCR and NLP data endpoint uses the same response envelope for both processing types:
The structure of data.json_text depends on the case-sensitive type supplied in the request.

OCR results

For type: "OCR", json_text is an array of detected document blocks. Blocks can represent a page, line, word, or another detected element. Properties vary by BlockType.
Common OCR block properties include:
  • BlockType: The detected element type, such as PAGE, LINE, or WORD.
  • Text: Recognized text for textual blocks.
  • Confidence: Recognition confidence returned by the OCR service.
  • Geometry: Normalized bounding-box and polygon coordinates.
  • Id: Unique identifier for the block.
  • Relationships: Links to related blocks, such as a page’s child elements.
  • Page: One-based page number containing the block.

NLP results

For type: "NLP", json_text is an object containing processing metadata and structured values extracted from the fax.
The result object can contain document classification, patient information, sender and recipient details, insurance information, metadata, and other document-specific fields. Fields without a detected value may be empty or null.
The examples on this page are intentionally shortened. Use the response schema to integrate defensively because extracted fields depend on the document and processing type.