Consultar documento

Este endpoint retorna os detalhes de um documento especificado pelo identificador.

GET /Document/{id}

Este endpoint retorna os detalhes de um documento especificado pelo identificador.

Autenticação

Autenticação obrigatória. Envie sua chave de API de usuário no header X-API-Key.

Parâmetros

Nome	Local	Tipo	Obrigatório	Descrição	Restrições
`id`	`path`	`integer · int32`	Sim	—	—

Corpo da requisição

Esta operação não recebe corpo de requisição.

Exemplo de requisição

curl --request GET \
  --url 'https://api.zild.ai/Document/{id}' \
  --header 'X-API-Key: YOUR_USER_API_KEY'

Respostas

Status	Descrição	Corpo da resposta
`200`	Sucesso ao retornar o documento	`application/json` · `DocumentCreateResponseDto`

Exemplo de resposta (200):

{
  "id": 0,
  "title": "string",
  "description": "string",
  "extractedText": "string",
  "analysisText": "string",
  "fileUrl": "string",
  "documentStatusId": 0,
  "documentType": 0,
  "createdAt": "2026-09-22T18:00:00Z",
  "analizedAt": "2026-09-22T18:00:00Z",
  "documentChecklistId": 0,
  "private": true
}

Modelos de dados

DocumentCreateResponseDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`integer · int32`	Não	—	—
`title`	`string`	Não	—	aceita null
`description`	`string`	Não	—	aceita null
`extractedText`	`string`	Não	—	aceita null
`analysisText`	`string`	Não	—	aceita null
`fileUrl`	`string`	Não	—	aceita null
`documentStatusId`	`integer · int32`	Não	—	—
`documentType`	`DocumentType`	Não	—	—
`createdAt`	`string · date-time`	Não	—	aceita null
`analizedAt`	`string · date-time`	Não	—	aceita null
`documentChecklistId`	`integer · int32`	Não	—	—
`private`	`boolean`	Não	—	—

DocumentType

0 = Image; 1 = Word; 2 = PDF; 3 = Text

integer