Obtém o resultado consolidado do processo

GET

onboarding

api

steps

result

{requestId}

Obtém o resultado consolidado do processo

curl --request GET \
  --url https://api.valid.com/onboarding/api/v1/steps/result/{requestId} \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.valid.com/onboarding/api/v1/steps/result/{requestId}', 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/onboarding/api/v1/steps/result/{requestId}",
  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/onboarding/api/v1/steps/result/{requestId}"

	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/onboarding/api/v1/steps/result/{requestId}")

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

{
  "status": "APPROVED",
  "createdAt": "2026-10-19T13:02:11.512Z",
  "requestData": {
    "cpf": "00000000191",
    "externalId": "order-12345",
    "webhookUrl": "https://seusistema.com/webhook/onboarding"
  },
  "livenessResponse": {
    "status": "APPROVED",
    "selfieImage": "/9j/4AAQSkZJRg...",
    "processingTime": 1830,
    "sessionId": "lv-session-0001",
    "captureId": "lv-capture-0001",
    "verified": true
  },
  "fraudResponse": {
    "status": "APPROVED",
    "score": 92,
    "hardStop": false,
    "penalties": [],
    "docType": "RG",
    "docFamily": "DOC_IDENTIDADE",
    "message": "Documento processado com sucesso",
    "processingMode": 2,
    "faceMatch": { "match": true, "score": 97.4 }
  }
}

{
  "code": "UNAUTHORIZED",
  "message": "Provide x-api-key, or Authorization Bearer with x-organization-id and x-project-id"
}

{
  "code": "FORBIDDEN",
  "message": "Você não tem permissão de acesso ao documento"
}

{
  "code": "NOT_FOUND",
  "message": "requestId not found"
}

{
  "code": "VALIDATION_ERROR",
  "message": "Erro de validação nos campos informados",
  "details": [
    {
      "field": "requestId",
      "message": "requestId must be a UUID"
    }
  ]
}

Use GET /onboarding/api/v1/steps/result/{requestId} para consultar o resultado final consolidado de um processo iniciado anteriormente. A requisição requer o requestId como parâmetro de caminho para identificar o processo e não espera um corpo de requisição. A API irá retornar todos os dados e status consolidados do processo especificado pelo identificador. Requisito: é necessário enviar o header de autenticação, mais informações aqui

Path Parameters

string

required

O ID único da requisição de processo a ser consultada, no formato UUID.Exemplo: 05be75cc-8f8a-414a-891f-434aa9b4e7a5

Response

Retorna o resultado consolidado e o status do processo. Os blocos de resultado (livenessResponse, mfaResponse, fraudResponse, uploadResponse, signerResponse, bureauQueryResponse, doclessResponse) vêm apenas para as etapas executadas no processo. Os campos de cada bloco estão abaixo; as regras de status e o webhook estão em Retornos via API ou webhook.

{
  "status": "APPROVED",
  "createdAt": "2026-10-19T13:02:11.512Z",
  "requestData": {
    "cpf": "00000000191",
    "externalId": "order-12345",
    "webhookUrl": "https://seusistema.com/webhook/onboarding"
  },
  "livenessResponse": {
    "status": "APPROVED",
    "selfieImage": "/9j/4AAQSkZJRg...",
    "processingTime": 1830,
    "sessionId": "lv-session-0001",
    "captureId": "lv-capture-0001",
    "verified": true
  },
  "fraudResponse": {
    "status": "APPROVED",
    "score": 92,
    "hardStop": false,
    "penalties": [],
    "docType": "RG",
    "docFamily": "DOC_IDENTIDADE",
    "message": "Documento processado com sucesso",
    "processingMode": 2,
    "faceMatch": { "match": true, "score": 97.4 }
  }
}

{
  "code": "UNAUTHORIZED",
  "message": "Provide x-api-key, or Authorization Bearer with x-organization-id and x-project-id"
}

{
  "code": "FORBIDDEN",
  "message": "Você não tem permissão de acesso ao documento"
}

{
  "code": "NOT_FOUND",
  "message": "requestId not found"
}

{
  "code": "VALIDATION_ERROR",
  "message": "Erro de validação nos campos informados",
  "details": [
    {
      "field": "requestId",
      "message": "requestId must be a UUID"
    }
  ]
}

string

Status consolidado do processo. Valores: STARTED, PROCESSING, ANALYSIS, SIGNING, APPROVED, REJECTED, FINISHED, FAILED, ABORTED, IGNORED, CANCELLED, EXPIRED.

string

Data e hora (ISO 8601) de criação do processo.

string

Data e hora (ISO 8601) do fim do processo. Preenchido pela etapa de assinatura.

string

Nome do titular, quando conhecido.

object

Dados enviados no início do processo.

Show propriedades

string

CPF do titular (só dígitos).

string

Seu identificador do processo.

string

Nome informado.

string

E-mail informado.

string

Celular informado (só dígitos).

string

Destino depois da conclusão.

string

URL do webhook.

string

Credencial Basic Auth do webhook, como enviada.

string

Selfie em base64 enviada no POST /steps/fraud.

object

Resultado da etapa de liveness.

Show propriedades

string

Valores: APPROVED, REJECTED, PROCESSING, FAILED, CANCELLED.

string

Selfie capturada, em base64.

number

Tempo de processamento, em milissegundos.

string

Id da sessão de liveness.

string

Id da captura.

boolean

Resultado da prova de vida.

string

Nome do titular.

object

Consulta à base facial, quando ligada nas configurações.

Show propriedades

string

Id da consulta. Vazio quando status é NOT_FOUND.

string

CPF consultado.

string

Valores: APPROVED, REJECTED, NOT_FOUND.

boolean | null

Resultado da comparação.

string | null

Nível de confiança. Valores: high, medium, low.

boolean

true quando a consulta falhou. Nesse caso vêm só error, message e timestamp.

string

Mensagem da falha.

string

Data e hora (ISO 8601) da falha.

string

Mensagem do erro quando status é FAILED.

object

Resultado da etapa MFA.

Show propriedades

string

Valores: APPROVED, STARTED, PROCESSING, FAILED.

string

Id da sessão de MFA.

string

Celular usado.

string

E-mail usado.

string

Nome do titular.

object

Envio do código. O código enviado não sai na resposta.

Show propriedades

string

Valores: sms, email, whatsapp.

string

Data e hora (ISO 8601) da geração do código.

string

Valores: SENT, FAILED.

string

Data e hora (ISO 8601) do envio, quando SENT.

string

Motivo da falha, quando FAILED.

object

Validação do código.

Show propriedades

string

Valores: sms, email, whatsapp.

boolean

true quando o código foi validado.

string

Mensagem do erro quando status é FAILED.

object

Resultado da documentoscopia (OCR e facematch).

Show propriedades

string

Valores: APPROVED, REJECTED, ANALYSIS, PROCESSING, FINISHED (só OCR), FAILED, CANCELLED.

number

Score de confiança, de 0 a 100.

boolean

true quando uma regra bloqueia a aprovação.

object[]

Regras aplicadas.

Show propriedades

string

Código da regra, em maiúsculas (ex.: FACE_08).

number

Peso da penalidade.

boolean

true quando a regra bloqueia a aprovação.

string

Descrição da regra.

string

Tipo do documento, em maiúsculas (ex.: RG, CNH).

string

Família do documento, em maiúsculas (ex.: DOC_IDENTIDADE).

string

Nome do titular.

string

Mensagem do resultado (ex.: Documento processado com sucesso).

number

Valores: 1 (só OCR), 2 (processo completo).

string

Id do documento na documentoscopia.

string | null

Id do lote de análise manual.

object

Comparação da selfie com a foto do documento.

Show propriedades

boolean

true quando a selfie e o documento são da mesma pessoa.

number

Similaridade, de 0 a 100.

boolean

true quando a comparação falhou. Nesse caso vêm só error, message e timestamp.

string

Mensagem da falha.

string

Data e hora (ISO 8601) da falha.

object

Consulta à base facial. Mesmos campos de livenessResponse.faceDb.

object

Leitura do documento.

Show propriedades

object

Campos lidos do documento.

Show propriedades

object[]

Um item por campo lido: ruleField (boolean), name (string, ex.: NOME), value (string), boundingBox (number[]), confidence (number), forensicsScore (number). Os nomes variam conforme o tipo do documento.

string

Tipo do documento reconhecido.

string

Família do documento reconhecido.

string

Nome do modelo do documento.

boolean

true para documento digital.

string

Imagem do documento, em base64.

string

Mensagem do erro quando status é FAILED.

object

Resultado da etapa de upload.

Show propriedades

string

Valores: FINISHED, IGNORED, PROCESSING, FAILED.

string

Id do arquivo (envio de 1 arquivo).

string

Caminho do arquivo no storage.

string

Nome do arquivo.

string

Tipo do arquivo (ex.: pdf).

string

Categoria do arquivo.

number | string

Tamanho do arquivo.

string

Igual a file_path.

string

Igual a file_name.

string

Igual a file_type.

string

Igual a file_category.

number | string

Igual a file_size.

string

Data e hora (ISO 8601) de criação do arquivo no storage.

string

Data e hora (ISO 8601) da última mudança do arquivo no storage.

object[]

Envio de vários arquivos: um item por arquivo, cada um com id.

string

Motivo da falha (ex.: Arquivos obrigatórios ausentes: rg).

object

Resultado da etapa de assinatura.

Show propriedades

string

Valores: SIGNING, FINISHED, REJECTED, CANCELLED, EXPIRED, ABORTED.

object

Mapa fileId → documento.

Show propriedades

string

Id do envelope de assinatura.

string

Id do arquivo no envelope.

string

Valores: Aguardando assinatura, Assinado, Cancelado, Recusado, Vencido.

string

Data e hora (ISO 8601) de criação do documento.

string

Data e hora (ISO 8601) da última mudança de state.

object[]

Signatários.

Show propriedades

string

Id do signatário.

string

Token da sessão de assinatura.

string

Link para assinar.

object

Estado de execução da assinatura.

Show propriedades

number

Índice do documento em assinatura (-1 = início).

object

Mapa id do documento → valores do modelo.

Show propriedades

string

Seu identificador do documento.

object

Valores usados para preencher o modelo.

object[]

Documentos coletados por URL.

Show propriedades

string

Id do documento (chave em signerResponse.files).

string

Seu identificador do documento.

string

URL do documento.

object

Resultado da consulta ao pacote de datasets.

Show propriedades

string

Valores: PROCESSING, COMPLETED, FAILED.

string

Id do pacote consultado.

object[]

Um item por dataset.

Show propriedades

string | object

Nome do dataset ou { name, description }.

object

Dados devolvidos. A forma depende do dataset.

object[]

Datasets com falha.

Show propriedades

string

Nome do dataset.

string

Motivo da falha.

object

Pacote de datasets consultado.

Show propriedades

string

Id do pacote.

string

Nome do pacote.

string

Motivo da falha.

string

Data e hora (ISO 8601) do início da consulta.

string

Data e hora (ISO 8601) do fim da consulta.

object

Emissão de documento docless.

Show propriedades

object

Aceite da pessoa.

Show propriedades

boolean

true quando a pessoa aceitou.

string

Data e hora (ISO 8601) do aceite.

object

Busca de documentos.

Show propriedades

string

Id da busca.

string

Data e hora (ISO 8601) de expiração da busca.

object[]

Documentos encontrados: id, type e imageDate (todos string).

object

Documento emitido.

Show propriedades

string

Id da emissão.

string

Id do documento.

string

Tipo do documento.

string

URL do documento.

string

Data e hora (ISO 8601) de expiração da URL.

object[]

Emissões.

Show propriedades

string

Id da emissão.

string

Data e hora (ISO 8601) da emissão.

string

Data e hora (ISO 8601) de expiração.

string

URL do documento.

object

id, type e imageDate (todos string).

object

searchId, scanId e protectionTxId (todos string).

object

name e cnpj (string).

string

Finalidade da emissão.

boolean

true quando alguma etapa do fluxo já reprovou e o processo ainda não terminou.

string

Recorte do rosto do documento (base64) enquanto o facematch está pendente.

Respostas de Erro

A API pode retornar os status 401, 403, 404, 422 e 500 (Internal server error). Todo erro tem o mesmo corpo: code, message e, nos erros de validação, details.

Status	`code`	Quando acontece
`401`	`UNAUTHORIZED`	Falta a autenticação, ou ela é inválida.
`403`	`FORBIDDEN`	O processo pertence a outro projeto, ou a credencial não tem acesso de leitura ao onboarding.
`404`	`NOT_FOUND`	O `requestId` não existe.
`422`	`VALIDATION_ERROR`	O `requestId` não é um UUID.

string

required

Código do erro. Valores: UNAUTHORIZED, FORBIDDEN, NOT_FOUND, VALIDATION_ERROR, INTERNAL_SERVER_ERROR.

string

required

Mensagem do erro.

object[]

Um item por campo inválido. Vem nos erros 422.

Show propriedades

string

Campo inválido (ex.: cpf).

string

O que está errado no campo.

⌘I

Obtém o resultado consolidado do processo

curl --request GET \
  --url https://api.valid.com/onboarding/api/v1/steps/result/{requestId} \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.valid.com/onboarding/api/v1/steps/result/{requestId}', 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/onboarding/api/v1/steps/result/{requestId}",
  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/onboarding/api/v1/steps/result/{requestId}"

	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/onboarding/api/v1/steps/result/{requestId}")

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

{
  "status": "APPROVED",
  "createdAt": "2026-10-19T13:02:11.512Z",
  "requestData": {
    "cpf": "00000000191",
    "externalId": "order-12345",
    "webhookUrl": "https://seusistema.com/webhook/onboarding"
  },
  "livenessResponse": {
    "status": "APPROVED",
    "selfieImage": "/9j/4AAQSkZJRg...",
    "processingTime": 1830,
    "sessionId": "lv-session-0001",
    "captureId": "lv-capture-0001",
    "verified": true
  },
  "fraudResponse": {
    "status": "APPROVED",
    "score": 92,
    "hardStop": false,
    "penalties": [],
    "docType": "RG",
    "docFamily": "DOC_IDENTIDADE",
    "message": "Documento processado com sucesso",
    "processingMode": 2,
    "faceMatch": { "match": true, "score": 97.4 }
  }
}

{
  "code": "UNAUTHORIZED",
  "message": "Provide x-api-key, or Authorization Bearer with x-organization-id and x-project-id"
}

{
  "code": "FORBIDDEN",
  "message": "Você não tem permissão de acesso ao documento"
}

{
  "code": "NOT_FOUND",
  "message": "requestId not found"
}

{
  "code": "VALIDATION_ERROR",
  "message": "Erro de validação nos campos informados",
  "details": [
    {
      "field": "requestId",
      "message": "requestId must be a UUID"
    }
  ]
}

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

Card Check

TrustPass

BPO

Extração Dados

Mensageria

Documentoscopia

Storage

Coleção Postman

Obtém o resultado consolidado do processo

Path Parameters

Response

Respostas de Erro

​Path Parameters

​Response

​Respostas de Erro

Path Parameters

Response

Respostas de Erro