Skip to main content
GET
/
onboarding
/
api
/
v1
/
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>'
import requests

url = "https://api.valid.com/onboarding/api/v1/steps/result/{requestId}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
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))

}
HttpResponse<String> response = Unirest.get("https://api.valid.com/onboarding/api/v1/steps/result/{requestId}")
  .header("x-api-key", "<api-key>")
  .asString();
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
{
  "requestId": "<string>",
  "status": "<string>",
  "details": {},
  "finishedAt": "<string>",
  "code": "<string>",
  "message": "<string>"
}
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.

​
Path Parameters

​
requestId
string
required
O ID único da requisição de processo a ser consultada.Exemplo: 05be75cc-8f8a-414a-891f-434aa9b4e7a5

​
Response

Retorna o resultado consolidado e o status final do processo.

​
Exemplo de sucesso (200 OK)

{
  "requestId": "05be75cc-8f8a-414a-891f-434aa9b4e7a5",
  "status": "APPROVED",
  "details": {
    "livenessResult": "MATCHED",
    "fraudScore": 0.95
  },
  "finishedAt": "2023-01-01T12:05:00"
}
​
requestId
string
required
ID do processo consultado.
​
status
string
required
Status final consolidado do processo (e.g., APPROVED, REJECTED, PENDING).
​
details
object
Objeto contendo os resultados detalhados das etapas executadas.
​
finishedAt
string
Data e hora de finalização do processo.

​
Respostas de Erro

A API pode retornar os status 400 (Bad request), 404 (Resource not found — requestId não existe) e 500 (Internal server error).
​
code
string
Código do erro que categoriza o tipo de erro.Exemplo: NOT_FOUND
​
message
string
Mensagem de erro.Exemplo: Resource not found