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

# Get the OCR result of a document

> **Who can call it:** Any signed-in member of the workspace.

Full text and per-page results. For the extracted fields use `GET /v1/cases/{case_id}/fields`.

**Auth:** dashboard session (`Authorization: Bearer <access token>`). Not available with a partner API key.



## OpenAPI

````yaml /openapi-console.json get /v1/documents/{document_id}/result
openapi: 3.1.0
info:
  title: Sahl Console API
  version: 0.1.0
  description: >-
    **Used by the Sahl console. Not available with partner API keys. Contact
    Sahl if you need programmatic access.**


    These are the routes the Sahl console calls with a signed-in user's session.
    They are documented so that a developer or a workspace admin can see what
    the console does, with the real request and response models. They are
    **not** part of the [Partner API](/api-reference/introduction): an API key
    is refused here (401), there is no try-it, and the shapes can change with
    the console.


    Authentication: `Authorization: Bearer <access token>`, the JWT the console
    gets from `POST /v1/auth/login` (30 minutes; renewed with `POST
    /v1/auth/refresh`, refresh token valid 7 days). There is no cookie. The role
    of the user is read from the user's record on every call, not from the
    token. Every call is scoped to the workspace of the user.


    Common answers: 401 (no or bad session), 403 `Insufficient permissions`
    (role), 422 (validation), 429 (100 requests per minute and IP). Error bodies
    have the same three shapes as the Partner API: see [Errors](/errors).
servers:
  - url: https://app.sahlfinancial.com/api
    description: Console host. Same host as the Partner API.
security:
  - dashboardSession: []
tags:
  - name: Bank connections
    description: Simulated in the Sandbox; 409 `bank_connect_unavailable` elsewhere.
  - name: Cases
    description: Client files that group documents, a score and a decision.
  - name: Documents
    description: Upload, status, result and download.
  - name: Webhooks
    description: Manage the endpoints that receive events.
  - name: API keys
    description: Create, rotate and revoke the keys used with the Partner API.
  - name: Scoring policies
    description: Weights and thresholds of the credit score.
  - name: Flows
    description: Verification flows (graphs) and their simulation.
paths:
  /v1/documents/{document_id}/result:
    get:
      tags:
        - Documents
      summary: Get the OCR result of a document
      description: >-
        **Who can call it:** Any signed-in member of the workspace.


        Full text and per-page results. For the extracted fields use `GET
        /v1/cases/{case_id}/fields`.


        **Auth:** dashboard session (`Authorization: Bearer <access token>`).
        Not available with a partner API key.
      operationId: getDocumentResult
      parameters:
        - name: document_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Document Id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentResultResponse'
              example:
                document_id: a8f1c3e5-6b2d-4974-8e0a-1d5c7b9f3e26
                status: completed
                document_type: payslip
                page_count: 1
                confidence_overall: 0.96
                raw_text: BULLETIN DE PAIE ...
                pages: []
        '401':
          description: No session, expired token, ended session or inactive account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail: Invalid or expired token
        '403':
          description: >-
            The role is not allowed, MFA enrolment is pending, or the
            environment is refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail: Insufficient permissions
        '404':
          description: Unknown document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail: Document not found
        '422':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail:
                  - type: missing
                    loc:
                      - body
                      - bank_code
                    msg: Field required
                    input: {}
        '429':
          description: >-
            More than 100 requests per minute from one IP address. The body has
            no `detail`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
              example:
                code: rate_limit_exceeded
                message: Too many requests. Please slow down.
          headers:
            Retry-After:
              schema:
                type: integer
              description: Seconds to wait.
components:
  schemas:
    DocumentResultResponse:
      properties:
        document_id:
          type: string
          format: uuid
        status:
          type: string
        document_type:
          anyOf:
            - type: string
            - type: 'null'
        page_count:
          anyOf:
            - type: integer
            - type: 'null'
        confidence_overall:
          anyOf:
            - type: number
            - type: 'null'
        raw_text:
          type: string
        pages:
          items:
            $ref: '#/components/schemas/OcrPageResult'
          type: array
      type: object
      required:
        - document_id
        - status
        - document_type
        - page_count
        - confidence_overall
        - raw_text
        - pages
      description: Full document result including OCR text and metadata.
    Error:
      type: object
      description: >-
        FastAPI error body. `detail` is a string, a list (422), or an object
        with `code` and `message` (extra keys possible).
      properties:
        detail:
          oneOf:
            - type: string
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: object
              additionalProperties: true
              properties:
                code:
                  type: string
                message:
                  type: string
      required:
        - detail
    RateLimitError:
      type: object
      description: Top-level `code` and `message`, no `detail`.
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
    OcrPageResult:
      properties:
        page_number:
          type: integer
        raw_text:
          anyOf:
            - type: string
            - type: 'null'
        words_json:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
        lines_json:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
        language_detected:
          anyOf:
            - type: string
            - type: 'null'
        confidence_avg:
          anyOf:
            - type: number
            - type: 'null'
        model_version:
          anyOf:
            - type: string
            - type: 'null'
        processing_time_ms:
          anyOf:
            - type: integer
            - type: 'null'
      type: object
      required:
        - page_number
        - raw_text
        - words_json
        - lines_json
        - language_detected
        - confidence_avg
        - model_version
        - processing_time_ms
  securitySchemes:
    dashboardSession:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        The access token (JWT) of a signed-in console user, from `POST
        /v1/auth/login`. It lasts 30 minutes. It is not an API key: a partner
        API key is refused here. There is no cookie.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.