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

# Consultar Documento OCR

> Consulte um documento OCR e os dados extraídos dele

## Path Params

<ParamField path="id" type="string" required>
  Identificador do documento, retornado no envio.

  **Exemplo**: `123e4567-e89b-12d3-a456-426614174000`
</ParamField>

## Response

Além dos campos descritos em [Consultar Documento](/plataforma/documentoscopia/api/get-document-by-id), a resposta traz os documentos extraídos pelo OCR.

<ResponseField name="docs" type="array">
  Documentos identificados na extração. Permanece vazio enquanto a extração não é concluída.
</ResponseField>

<ResponseField name="docs[].docName" type="string">
  Nome do documento extraído.

  **Exemplo**: `CNH`
</ResponseField>

<ResponseField name="docs[].docId" type="integer">
  Identificador do documento no processamento.

  **Exemplo**: `262740`
</ResponseField>

<ResponseField name="docs[].docType" type="string">
  Tipo do documento identificado.

  **Exemplo**: `cnh`
</ResponseField>

<ResponseField name="docs[].type" type="string">
  Classificação atribuída ao documento na extração.

  **Exemplo**: `identificacao`
</ResponseField>

<ResponseField name="docs[].keys" type="array">
  Campos extraídos do documento.
</ResponseField>

<ResponseField name="docs[].keys[].keyAlias" type="string">
  Identificador do campo extraído.

  **Exemplo**: `nome`
</ResponseField>

<ResponseField name="docs[].keys[].keyName" type="string">
  Nome do campo extraído.

  **Exemplo**: `Nome`
</ResponseField>

<ResponseField name="docs[].keys[].value" type="string">
  Valor lido no documento.

  **Exemplo**: `JOAO DA SILVA`
</ResponseField>

<ResponseExample>
  ```json 200 theme={"theme":"catppuccin-latte"}
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174001",
    "projectId": "123e4567-e89b-12d3-a456-426614174002",
    "productId": "123e4567-e89b-12d3-a456-426614174003",
    "cpf": "12345678909",
    "status": "COMPLETED",
    "type": "ocr",
    "createdAt": "2026-06-01T12:00:00.000Z",
    "updatedAt": "2026-06-01T12:02:00.000Z",
    "sentAt": "2026-06-01T12:00:01.000Z",
    "sentToBackofficeAt": "2026-06-01T12:00:02.000Z",
    "finishedAt": "2026-06-01T12:02:00.000Z",
    "errorMessage": null,
    "errorCode": null,
    "backofficeBatchId": "229462",
    "requestId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
    "name": "JOAO DA SILVA",
    "workflowPresetAlias": "ocr_auto_2min",
    "result": null,
    "docs": [
      {
        "docName": "CNH",
        "docId": 262740,
        "docType": "cnh",
        "type": "identificacao",
        "keys": [
          {
            "keyAlias": "nome",
            "keyName": "Nome",
            "value": "JOAO DA SILVA"
          },
          {
            "keyAlias": "cpf",
            "keyName": "CPF",
            "value": "12345678909"
          }
        ]
      }
    ]
  }
  ```

  ```json 404 theme={"theme":"catppuccin-latte"}
  {
    "error": "NOT_FOUND",
    "message": "Document not found",
    "requestId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
    "timestamp": "2026-06-01T12:00:00.000Z"
  }
  ```

  ```json 500 theme={"theme":"catppuccin-latte"}
  {
    "error": "INTERNAL_ERROR",
    "message": "Failed to retrieve document",
    "requestId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
    "timestamp": "2026-06-01T12:00:00.000Z"
  }
  ```
</ResponseExample>