Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Sua chave de API no cabeçalho Authorization: Bearer sk_.... Crie e revogue chaves no painel ou pelos endpoints de Chaves de API.

Headers

​
Idempotency-Key
string

Torna a criação segura para retentativa. Reenviar a mesma chave repete a resposta original em vez de criar (e cobrar) uma validação nova.

Required string length: 1 - 256
Pattern: ^[A-Za-z0-9_-]{1,256}$

Body

application/json

Dados para criar uma validação de troca de chip.

​
phone
string
required

Telefone celular brasileiro do titular, em formato E.164.

Example:

"+5511999998888"

​
consent
boolean
required

Confirma que o titular consentiu com a consulta. Precisa ser true.

​
max_age_hours
integer

Janela, em horas, para considerar uma troca de chip como recente.

Required range: 1 <= x <= 2400
Example:

24

​
external_id
string

Sua referência de correlação. Volta em todas as respostas desta validação.

Required string length: 1 - 256
Pattern: ^[A-Za-z0-9_-]{1,256}$
Example:

"pedido_12345"

Response

Validação concluída.

Resultado de uma validação.

​
object
enum<string>
required

Sempre validation.

Available options:
validation
​
id
string
required

Identificador único da validação.

Example:

"val_0NQW3MVYJYQ453E95V3V1T76AV"

​
type
enum<string>
required

Tipo da validação.

Os três primeiros têm endpoint de criação. Os outros dois podem aparecer em consultas e listagens de contas que os usam por outros canais.

Available options:
liveness_document_match,
liveness_cpf_match,
cpf_phone_match,
sim_swap,
telco_financial_capacity
​
status
enum<string>
required

Estado atual.

Available options:
pending,
completed,
failed,
expired
​
result
enum<string> | null
required

Resultado de negócio. É null enquanto status for pending.

Available options:
passed,
not_passed,
match,
no_match,
recent_swap,
no_recent_swap,
high_capacity,
moderate_capacity,
low_capacity,
unknown
​
reason_code
enum<string> | null
required

Por que o resultado foi unknown. É null em qualquer outro caso.

Available options:
liveness_failed,
face_mismatch,
spoof_detected,
document_tampered,
document_invalid,
document_unreadable,
cpf_reference_not_found,
data_unavailable,
phone_not_covered
​
external_id
string | null
required

A referência de correlação que você enviou na criação.

​
created_at
string<date-time>
required

Data de criação em ISO-8601.

​
resolved_at
string<date-time> | null
required

Data de resolução em ISO-8601. É null enquanto não resolvida.

​
validation_url
string | null
required

URL para onde redirecionar o titular. Preenchida nas validações hospedadas; null nas síncronas.

​
expires_at
string<date-time> | null
required

Quando a sessão hospedada vence, em ISO-8601. Preenchida nas validações hospedadas; null nas síncronas.

​
details
object | null
required

Dados extraídos, agrupados pela chave do type. Hoje só liveness_document_match produz detalhes, e só com status igual a completed. Nos demais casos é null.