Enviar Documentos para OCR

POST

docs-gateway

api

ocr

import

Enviar Documentos para OCR

curl --request POST \
  --url https://api.valid.com/docs-gateway/api/v1/ocr/import \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "cpf": "<string>",
  "documents": [
    "<string>"
  ],
  "workflowPresetAlias": "<string>"
}
'

import requests

url = "https://api.valid.com/docs-gateway/api/v1/ocr/import"

payload = {
    "cpf": "<string>",
    "documents": ["<string>"],
    "workflowPresetAlias": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({cpf: '<string>', documents: ['<string>'], workflowPresetAlias: '<string>'})
};

fetch('https://api.valid.com/docs-gateway/api/v1/ocr/import', 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/ocr/import",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cpf' => '<string>',
    'documents' => [
        '<string>'
    ],
    'workflowPresetAlias' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.valid.com/docs-gateway/api/v1/ocr/import"

	payload := strings.NewReader("{\n  \"cpf\": \"<string>\",\n  \"documents\": [\n    \"<string>\"\n  ],\n  \"workflowPresetAlias\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.valid.com/docs-gateway/api/v1/ocr/import")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cpf\": \"<string>\",\n  \"documents\": [\n    \"<string>\"\n  ],\n  \"workflowPresetAlias\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/docs-gateway/api/v1/ocr/import")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cpf\": \"<string>\",\n  \"documents\": [\n    \"<string>\"\n  ],\n  \"workflowPresetAlias\": \"<string>\"\n}"

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

{
  "requestId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
  "documentId": "123e4567-e89b-12d3-a456-426614174000",
  "batchExternalId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
  "backofficeBatchId": "229462",
  "flexImageResponse": {
    "id": "229462",
    "status": "created"
  }
}

{
  "error": "INVALID_WORKFLOW_PRESET",
  "message": "workflowPresetAlias inválido ou indisponível para OCR",
  "requestId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
  "timestamp": "2026-06-01T12:00:00.000Z"
}

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

Diferente da análise de documentos, o OCR aceita documentos não identificados: você não precisa informar qual é a frente, o verso ou o tipo de cada arquivo.

Request Body

string

required

CPF do titular dos documentos. Aceita 11 dígitos, com ou sem máscara, e os dígitos verificadores precisam ser válidos.Exemplo: 12345678909

string[]

required

Lista de documentos em data URI base64. Envie de 1 a 20 documentos por requisição.Limite de 10 MB por arquivo. Formatos: JPG, JPEG, PNG e PDF.Exemplo: ["data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ..."]

string

Alias do preset de workflow de OCR. Quando omitido, o preset configurado no projeto é aplicado.Consulte os valores disponíveis em Listar Presets de Workflow, filtrando por process=ocr.Exemplo: ocr_auto_2min

O tamanho máximo do corpo da requisição não deve ultrapassar 50 MB.

Response

string

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

string

Identificador do documento criado. Use-o para consultar status e dados extraídos.Exemplo: 123e4567-e89b-12d3-a456-426614174000

string

Identificador externo do lote enviado para extração.Exemplo: 7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c

string

Identificador do lote gerado no processamento.Exemplo: 229462

object

Retorno do serviço de processamento no envio do lote.

{
  "requestId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
  "documentId": "123e4567-e89b-12d3-a456-426614174000",
  "batchExternalId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
  "backofficeBatchId": "229462",
  "flexImageResponse": {
    "id": "229462",
    "status": "created"
  }
}

{
  "error": "INVALID_WORKFLOW_PRESET",
  "message": "workflowPresetAlias inválido ou indisponível para OCR",
  "requestId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
  "timestamp": "2026-06-01T12:00:00.000Z"
}

{
  "error": "FLEXIMAGE_IMPORT_FAILED",
  "message": "Unknown error",
  "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
`INVALID_WORKFLOW_PRESET`	400
`FLEXIMAGE_IMPORT_FAILED`	400, 502

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

⌘I

Enviar Documentos para OCR

curl --request POST \
  --url https://api.valid.com/docs-gateway/api/v1/ocr/import \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "cpf": "<string>",
  "documents": [
    "<string>"
  ],
  "workflowPresetAlias": "<string>"
}
'

import requests

url = "https://api.valid.com/docs-gateway/api/v1/ocr/import"

payload = {
    "cpf": "<string>",
    "documents": ["<string>"],
    "workflowPresetAlias": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({cpf: '<string>', documents: ['<string>'], workflowPresetAlias: '<string>'})
};

fetch('https://api.valid.com/docs-gateway/api/v1/ocr/import', 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/ocr/import",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cpf' => '<string>',
    'documents' => [
        '<string>'
    ],
    'workflowPresetAlias' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.valid.com/docs-gateway/api/v1/ocr/import"

	payload := strings.NewReader("{\n  \"cpf\": \"<string>\",\n  \"documents\": [\n    \"<string>\"\n  ],\n  \"workflowPresetAlias\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.valid.com/docs-gateway/api/v1/ocr/import")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cpf\": \"<string>\",\n  \"documents\": [\n    \"<string>\"\n  ],\n  \"workflowPresetAlias\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.valid.com/docs-gateway/api/v1/ocr/import")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cpf\": \"<string>\",\n  \"documents\": [\n    \"<string>\"\n  ],\n  \"workflowPresetAlias\": \"<string>\"\n}"

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

{
  "requestId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
  "documentId": "123e4567-e89b-12d3-a456-426614174000",
  "batchExternalId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
  "backofficeBatchId": "229462",
  "flexImageResponse": {
    "id": "229462",
    "status": "created"
  }
}

{
  "error": "INVALID_WORKFLOW_PRESET",
  "message": "workflowPresetAlias inválido ou indisponível para OCR",
  "requestId": "7d7a6f2b-8d9f-4f55-9a2d-ec8e7b4f1d0c",
  "timestamp": "2026-06-01T12:00:00.000Z"
}

{
  "error": "FLEXIMAGE_IMPORT_FAILED",
  "message": "Unknown error",
  "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

Enviar Documentos para OCR

Request Body

Response

Erros

​Request Body

​Response

​Erros

Request Body

Response

Erros