Consultar Documento

GET

docs-gateway

api

documents

{id}

Consultar Documento

curl --request GET \
  --url https://api.valid.com/docs-gateway/api/v1/documents/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.valid.com/docs-gateway/api/v1/documents/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valid.com/docs-gateway/api/v1/documents/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.valid.com/docs-gateway/api/v1/documents/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/docs-gateway/api/v1/documents/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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": "docs",
  "createdAt": "2026-06-01T12:00:00.000Z",
  "updatedAt": "2026-06-01T12:05:00.000Z",
  "sentAt": "2026-06-01T12:00:01.000Z",
  "sentToBackofficeAt": "2026-06-01T12:00:02.000Z",
  "finishedAt": "2026-06-01T12:05:00.000Z",
  "errorMessage": null,
  "errorCode": null,
  "backofficeBatchId": "229462",
  "requestId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
  "name": "JOAO DA SILVA",
  "workflowPresetAlias": "documentoscopia_auto_base_face_15min",
  "result": {
    "id": "223e4567-e89b-12d3-a456-426614174001",
    "documentId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "APPROVED",
    "confidenceScore": 98.5,
    "raw_response": {},
    "processedBy": "backoffice",
    "createdAt": "2026-06-01T12:05:00.000Z"
  }
}

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

{
  "error": "INTERNAL_ERROR",
  "message": "Failed to retrieve document",
  "requestId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
  "timestamp": "2026-06-01T12:00:00.000Z"
}

Path Params

string

required

Identificador do documento, retornado no envio.Exemplo: 123e4567-e89b-12d3-a456-426614174000

Response

string

Identificador do documento.Exemplo: 123e4567-e89b-12d3-a456-426614174000

string

Identificador da organização à qual o documento pertence.Exemplo: 123e4567-e89b-12d3-a456-426614174001

string

Identificador do projeto à qual o documento pertence.Exemplo: 123e4567-e89b-12d3-a456-426614174002

string

Identificador do produto associado ao documento.Exemplo: 123e4567-e89b-12d3-a456-426614174003

string

CPF do titular do documento.Exemplo: 12345678909

string

Status atual do documento. Valores possíveis: PENDING, MERGING, UPLOADING, SENDING, SENT, PROCESSING, COMPLETED, ERROR, FAILED e TIMEOUT.Exemplo: COMPLETED

string

Tipo de processamento aplicado ao documento: docs, checklist ou ocr.Exemplo: docs

datetime

Data e hora em que o documento foi registrado.Exemplo: 2026-06-01T12:00:00.000Z

datetime

Data e hora da última atualização do documento.Exemplo: 2026-06-01T12:05:00.000Z

datetime

Data e hora do envio para análise.Exemplo: 2026-06-01T12:00:01.000Z

datetime

Data e hora em que o documento chegou ao processamento.Exemplo: 2026-06-01T12:00:02.000Z

datetime

Data e hora da conclusão da análise.Exemplo: 2026-06-01T12:05:00.000Z

string

Mensagem do erro registrado, quando houver.Exemplo: null

string

Código do erro registrado, quando houver.Exemplo: null

string

Identificador do lote gerado no processamento. Enquanto estiver nulo, arquivos e face não estão disponíveis.Exemplo: 229462

string

Identificador da requisição que originou o documento.Exemplo: 7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c

string

Nome do titular extraído do documento durante a análise.Exemplo: JOAO DA SILVA

string

Alias do preset de workflow aplicado no envio.Exemplo: documentoscopia_auto_base_face_15min

object

Resultado da análise. Permanece nulo enquanto a análise não é concluída.

string

Parecer da análise. Valores possíveis: APPROVED, REJECTED, MANUAL_REVIEW e ERROR.Exemplo: APPROVED

number

Índice de confiança da análise.Exemplo: 98.5

object

Retorno completo da análise, como recebido do processamento.

string

Origem do processamento do resultado.Exemplo: backoffice

{
  "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": "docs",
  "createdAt": "2026-06-01T12:00:00.000Z",
  "updatedAt": "2026-06-01T12:05:00.000Z",
  "sentAt": "2026-06-01T12:00:01.000Z",
  "sentToBackofficeAt": "2026-06-01T12:00:02.000Z",
  "finishedAt": "2026-06-01T12:05:00.000Z",
  "errorMessage": null,
  "errorCode": null,
  "backofficeBatchId": "229462",
  "requestId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
  "name": "JOAO DA SILVA",
  "workflowPresetAlias": "documentoscopia_auto_base_face_15min",
  "result": {
    "id": "223e4567-e89b-12d3-a456-426614174001",
    "documentId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "APPROVED",
    "confidenceScore": 98.5,
    "raw_response": {},
    "processedBy": "backoffice",
    "createdAt": "2026-06-01T12:05:00.000Z"
  }
}

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

{
  "error": "INTERNAL_ERROR",
  "message": "Failed to retrieve document",
  "requestId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
  "timestamp": "2026-06-01T12:00:00.000Z"
}

Erros

Respostas de erro possíveis neste endpoint:

`error`	HTTP
`UNAUTHORIZED`	401
`NOT_FOUND`	404
`INTERNAL_ERROR`	500

Veja o envelope de cada resposta e o significado dos códigos em Erros e Autenticação.

⌘I

Consultar Documento

curl --request GET \
  --url https://api.valid.com/docs-gateway/api/v1/documents/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.valid.com/docs-gateway/api/v1/documents/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valid.com/docs-gateway/api/v1/documents/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.valid.com/docs-gateway/api/v1/documents/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/docs-gateway/api/v1/documents/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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": "docs",
  "createdAt": "2026-06-01T12:00:00.000Z",
  "updatedAt": "2026-06-01T12:05:00.000Z",
  "sentAt": "2026-06-01T12:00:01.000Z",
  "sentToBackofficeAt": "2026-06-01T12:00:02.000Z",
  "finishedAt": "2026-06-01T12:05:00.000Z",
  "errorMessage": null,
  "errorCode": null,
  "backofficeBatchId": "229462",
  "requestId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
  "name": "JOAO DA SILVA",
  "workflowPresetAlias": "documentoscopia_auto_base_face_15min",
  "result": {
    "id": "223e4567-e89b-12d3-a456-426614174001",
    "documentId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "APPROVED",
    "confidenceScore": 98.5,
    "raw_response": {},
    "processedBy": "backoffice",
    "createdAt": "2026-06-01T12:05:00.000Z"
  }
}

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

{
  "error": "INTERNAL_ERROR",
  "message": "Failed to retrieve document",
  "requestId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
  "timestamp": "2026-06-01T12:00:00.000Z"
}

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

Card Check

BPO

Extração Dados

Mensageria

Documentoscopia

Path Params

Response

Erros

​Path Params

​Response

​Erros

Path Params

Response

Erros