Consultar inteligência da transação

GET

transactions

{id}

intelligence

curl --request GET \
  --url https://api.valid.com/transactions/{id}/intelligence \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.valid.com/transactions/{id}/intelligence', 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/transactions/{id}/intelligence",
  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/transactions/{id}/intelligence"

	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/transactions/{id}/intelligence")

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": "<string>",
  "status": "<string>",
  "statusReason": "<string>",
  "origin": "<string>",
  "validated": true,
  "validationAttempts": [
    {
      "identityMasked": "<string>",
      "identityType": "<string>",
      "validated": true,
      "at": "<string>"
    }
  ],
  "documentChangedBeforeMatch": true,
  "hasPasskey": true,
  "createdAt": "<string>",
  "expiresAt": "<string>",
  "buyerContact": {
    "phone": "<string>",
    "email": "<string>"
  },
  "deviceIntelligence": {
    "buyer": {
      "score": 123,
      "country": "<string>"
    },
    "holder": {},
    "deviceMatchFlag": true,
    "geoMismatch": true
  },
  "card_check_result": {
    "match": true,
    "result": "<string>",
    "reason_code": "<string>",
    "reason": "<string>",
    "conclusiveness": "<string>",
    "checked_at": "<string>"
  },
  "biometric_result": {
    "result": "<string>",
    "confidence_level": "<string>",
    "checked_at": "<string>"
  },
  "device_intelligence_result": {
    "buyer": {
      "device_score": 123,
      "is_emulated": true,
      "is_jailbroken": true,
      "is_proxy": true,
      "is_device_masked": true,
      "virtual_os": true,
      "running_screen_sharing": true,
      "hooking": true,
      "app_tampering": true,
      "request_payload_tampered": true,
      "running_clone_apps": true,
      "running_vpn_spoofers": true,
      "running_gps_spoofers": true,
      "suspicious_factory_reset": true,
      "auto_clicker_enabled": true,
      "checked_at": "<string>"
    },
    "holder": {}
  }
}

Enquanto a consulta de transação é pensada para a tela de checkout, este endpoint retorna a visão de risco completa, destinada à sua aplicação (o lojista) decidir como tratar o caso.

Path Parameters

string

required

ID da transação.

Response

string

ID da transação.

string

Status atual da transação. Veja a lista completa de status.

string

Motivo específico associado ao status atual (ex.: motivo de reprovação ou de fraude). null quando não informado. Este campo é destinado à sua aplicação — o comprador final nunca vê este texto.

string

Onde a transação foi criada: x-api-key (integração via API) ou platform (dashboard).

boolean

Indica se a titularidade do cartão já foi confirmada.

object[]

Histórico de tentativas de validação.

Show Propriedades de cada item

string

Documento (CPF/CNPJ) mascarado da tentativa.

string

Tipo do documento: cpf ou cnpj.

boolean

Resultado da tentativa.

string

Data e hora da tentativa.

boolean

Indica se o documento informado foi alterado antes de uma validação bem-sucedida.

boolean

Indica se o titular possui uma passkey cadastrada.

string

Data e hora de criação da transação.

string

Data e hora em que a transação expira.

object

Contato do comprador informado na criação. null quando nenhum contato foi enviado.

Show Propriedades de buyerContact

string

Telefone no formato E.164. null quando não informado.

string

E-mail. null quando não informado.

object

Resumo dos sinais de dispositivo do comprador (buyer) e, quando aplicável, do titular do cartão no fluxo de titular terceiro (holder). null quando nenhum dispositivo foi registrado.

Show Propriedades de deviceIntelligence

object

null quando o dispositivo do comprador ainda não foi registrado.

Show Propriedades de buyer/holder

number

Score de risco do dispositivo. null quando não informado.

string

País identificado para o dispositivo. null quando não informado.

object

Mesmo formato de buyer, preenchido apenas quando há um fluxo de titular terceiro. null nos demais casos.

boolean

Indica se o dispositivo do comprador e do titular (quando houver validação de terceiro) foi identificado como o mesmo. null quando não aplicável.

boolean

Indica divergência de geolocalização entre comprador e titular. null quando não aplicável.

object

Resultado da validação de titularidade do cartão (documento × cartão), no mesmo contrato do Card Check. Quando a titularidade ainda não foi confirmada, reflete a tentativa mais recente.

Show Propriedades de card_check_result

boolean

true somente quando a titularidade foi confirmada. Uma exceção também volta como false: use result para diferenciar.

string

true (confirmada), false (não confirmada) ou exception (a verificação não pôde ser realizada).

string

Código do motivo no padrão Valid (T01–T02, F01–F05, E01–E06). Veja a tabela de motivos. null quando não há motivo, inclusive quando o Card Check estava indisponível.

string

Constante estável do motivo, para uso em regras. null junto com reason_code.

string

Quão conclusivo é o resultado: HIGH, MEDIUM ou LOW. null nas exceções e quando não há motivo.

string

Data e hora da checagem. null quando a checagem não foi realizada.

object

Resultado da biometria facial.

Show Propriedades de biometric_result

string

approved, reproved ou pending (biometria ainda não concluída).

string

Nível de confiança da biometria: low, medium, high ou maximum. null quando não houve checagem de identidade ou o nível não foi informado.

string

Data e hora da checagem. null enquanto result for pending.

object

Sinais de inteligência de dispositivo do comprador (buyer) e, no fluxo de titular terceiro, do titular (holder). Cada um é null quando o dispositivo correspondente não foi registrado.

Show Propriedades de device_intelligence_result

object

Sinais do dispositivo do comprador.

Show Propriedades de buyer/holder

integer

Score agregado de risco do dispositivo. Quanto maior, mais indícios de anomalia. null quando não informado.

boolean

O dispositivo é um emulador de software, não um aparelho físico.

boolean

As proteções do sistema operacional foram removidas ou contornadas (jailbreak/root).

boolean

A conexão passa por um proxy ou VPN.

boolean

Há tentativa ativa de falsificar as características do dispositivo.

boolean

O dispositivo roda dentro de uma máquina virtual.

A tela está sendo compartilhada ou controlada remotamente durante a transação.

boolean

Há injeção de código interceptando ou manipulando funções do aplicativo.

boolean

O aplicativo instalado foi modificado em relação à versão oficial.

boolean

Os dados da requisição foram alterados em trânsito.

boolean

Há clones do mesmo aplicativo instalados no dispositivo.

boolean

Há ferramentas que forjam informações de VPN.

boolean

Há ferramentas que falsificam a localização GPS.

boolean

O dispositivo passou por uma restauração de fábrica recente em condições suspeitas.

boolean

Há ferramentas de automação de cliques ou toques (bots).

string

Data e hora da checagem do dispositivo.

object

Mesmo formato de buyer, preenchido apenas quando há um fluxo de titular terceiro. null nos demais casos.

Os sinais booleanos de device_intelligence_result vêm como null quando não são avaliados na plataforma do dispositivo. Em navegadores (web), por exemplo, só is_emulated e is_proxy são avaliados. Trate null como “não avaliado”, e não como false.

As faixas de interpretação do device_score (o que é considerado risco baixo, médio ou alto) ainda estão em definição. Até lá, use o valor em conjunto com os sinais booleanos.

Códigos de erro

Código HTTP	`code`	Descrição
401	—	API key ausente ou inválida.
404	`TRANSACTION_NOT_FOUND`	Transação não encontrada para esta API key.

⌘I

Consultar inteligência da transação

curl --request GET \
  --url https://api.valid.com/transactions/{id}/intelligence \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.valid.com/transactions/{id}/intelligence', 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/transactions/{id}/intelligence",
  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/transactions/{id}/intelligence"

	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/transactions/{id}/intelligence")

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": "<string>",
  "status": "<string>",
  "statusReason": "<string>",
  "origin": "<string>",
  "validated": true,
  "validationAttempts": [
    {
      "identityMasked": "<string>",
      "identityType": "<string>",
      "validated": true,
      "at": "<string>"
    }
  ],
  "documentChangedBeforeMatch": true,
  "hasPasskey": true,
  "createdAt": "<string>",
  "expiresAt": "<string>",
  "buyerContact": {
    "phone": "<string>",
    "email": "<string>"
  },
  "deviceIntelligence": {
    "buyer": {
      "score": 123,
      "country": "<string>"
    },
    "holder": {},
    "deviceMatchFlag": true,
    "geoMismatch": true
  },
  "card_check_result": {
    "match": true,
    "result": "<string>",
    "reason_code": "<string>",
    "reason": "<string>",
    "conclusiveness": "<string>",
    "checked_at": "<string>"
  },
  "biometric_result": {
    "result": "<string>",
    "confidence_level": "<string>",
    "checked_at": "<string>"
  },
  "device_intelligence_result": {
    "buyer": {
      "device_score": 123,
      "is_emulated": true,
      "is_jailbroken": true,
      "is_proxy": true,
      "is_device_masked": true,
      "virtual_os": true,
      "running_screen_sharing": true,
      "hooking": true,
      "app_tampering": true,
      "request_payload_tampered": true,
      "running_clone_apps": true,
      "running_vpn_spoofers": true,
      "running_gps_spoofers": true,
      "suspicious_factory_reset": true,
      "auto_clicker_enabled": true,
      "checked_at": "<string>"
    },
    "holder": {}
  }
}

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

Card Check

TrustPass

BPO

Extração Dados

Mensageria

Documentoscopia

Storage

Coleção Postman

Consultar inteligência da transação

Path Parameters

Response

Códigos de erro

​Path Parameters

​Response

​Códigos de erro

Path Parameters

Response

Códigos de erro