Skip to main content
POST
Analisar risco de uma transação
Esta rota usa a sua chave de API (secret key), não o token de login (JWT) das demais rotas. Envie Authorization: Bearer sk_.... Veja Chave de API.
Envie apenas o BIN (card.bin, 6 dígitos) e os últimos 4 dígitos (card.last4). Número completo, CVV ou validade do cartão fazem a chamada retornar 422 (forbidden_card_field).
Use o header opcional Idempotency-Key para garantir que um reenvio da mesma transação não gere uma nova análise (nem nova cobrança). Veja idempotência.
O amount é em centavos (25000 = R$ 250,00). Todos os dados do cliente, do cartão e do contexto são opcionais, mas quanto mais dados, melhor a análise — o e-mail, o documento e o IP têm peso importante no risco.

Authorizations

Authorization
string
header
required

Chave de API (secret key) da conta, no formato sk_live_... (produção) ou sk_test_... (Dev mode). Envie no header Authorization: Bearer <chave>. Usada apenas nas rotas de Análise de Fraude. Gere a sua no dashboard em Configurações → Chaves de API.

Headers

Idempotency-Key
string

Chave de idempotência opcional. Repetir a mesma chave com o mesmo corpo devolve a análise original sem cobrar de novo; a mesma chave com corpo diferente retorna 422.

Example:

"order-9f2b1a"

Body

application/json
amount
integer
required

Valor da transação em centavos (10000 = R$ 100,00)

Required range: x >= 0
Example:

25000

currency
string
required

Moeda no padrão ISO 4217 (3 letras)

Required string length: 3
Example:

"BRL"

external_reference
string

Seu identificador da transação (aparece na resposta)

Maximum string length: 191
Example:

"order-1024"

payment_method
string
Maximum string length: 30
Example:

"credit_card"

customer
object
card
object

Apenas BIN e últimos 4 dígitos. Enviar o número completo, o CVV ou a validade faz a requisição retornar 422 (forbidden_card_field).

context
object

Response

Análise concluída

Resultado de uma análise de risco

object
string
Example:

"risk_analysis"

id
string

Código da análise (use-o para consultar depois)

Example:

"fan_a1b2c3d4e5f6g7h8"

external_reference
string | null
Example:

"order-1024"

status
enum<string>
Available options:
completed,
unavailable,
failed
Example:

"completed"

risk_score
integer

Nota de risco de 0 (baixo) a 100 (alto)

Required range: 0 <= x <= 100
Example:

30

risk_level
enum<string>
Available options:
low,
medium,
high
Example:

"low"

recommendation
enum<string> | null

Ação sugerida: seguir, validar melhor ou recusar

Available options:
follow,
additional_validation,
reject
Example:

"follow"

decision
enum<string> | null

Decisão do motor: aprovar, revisar ou recusar

Available options:
ALLOW,
CHALLENGE,
DENY
Example:

"ALLOW"

reasons
string[]

Códigos dos motivos que pesaram na decisão

Example:
analyzed_at
string<date-time>
Example:

"2026-07-27T12:00:00-03:00"