Listar Documentos

GET

docs-gateway

api

documents

Listar Documentos

curl --request GET \
  --url https://api.valid.com/docs-gateway/api/v1/documents \
  --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', 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",
  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"

	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")

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

{
  "items": [
    {
      "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"
      }
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}

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

Query Params

string

CPF do titular, com ou sem máscara.Exemplo: 12345678909

string

Nome do titular. A busca é parcial e não diferencia maiúsculas de minúsculas.Exemplo: JOAO

string

Alias do preset de workflow, em correspondência exata.Exemplo: documentoscopia_auto_base_face_15min

string

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

string

Status consolidado do documento. Valores possíveis: processing, error, approved, rejected e pending.Exemplo: approved

string

Início do intervalo de criação, em ISO 8601.Exemplo: 2026-01-01T00:00:00.000Z

string

Fim do intervalo de criação, em ISO 8601.Exemplo: 2026-12-31T23:59:59.999Z

string

default:"createdAt"

Campo usado na ordenação. Valores possíveis: createdAt, updatedAt, sentAt, finishedAt, status, cpf, name e workflowPresetAlias.Exemplo: createdAt

string

default:"desc"

Direção da ordenação: asc ou desc.Exemplo: desc

integer

default:"20"

Quantidade máxima de itens por página, de 1 a 100.Exemplo: 20

integer

default:"0"

Número de itens a pular na paginação.Exemplo: 0

Response

array

Documentos encontrados. Cada item segue a mesma estrutura de Consultar Documento.

integer

Total de documentos que atendem aos filtros.Exemplo: 1

integer

Quantidade máxima de itens por página aplicada.Exemplo: 20

integer

Número de itens ignorados na paginação.Exemplo: 0

{
  "items": [
    {
      "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"
      }
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}

{
  "error": "INTERNAL_ERROR",
  "message": "Failed to list documents",
  "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
`INTERNAL_ERROR`	500

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

⌘I

Listar Documentos

curl --request GET \
  --url https://api.valid.com/docs-gateway/api/v1/documents \
  --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', 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",
  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"

	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")

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

{
  "items": [
    {
      "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"
      }
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}

{
  "error": "INTERNAL_ERROR",
  "message": "Failed to list documents",
  "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

Query Params

Response

Erros

​Query Params

​Response

​Erros

Query Params

Response

Erros