Vault

REST API · 80+ endpoints · 14 scopes

Vault API

API para tokenizacao segura de dados sensiveis, compliance (risk scoring), limites transacionais, KYC/onboarding, ledger double-entry e integracao DICT para chaves PIX.

Autenticacao via API Keys

Todos os endpoints requerem autenticacao via Bearer token com 14 scopes granulares. Use POST /v1/bootstrap para criar a primeira API key admin.

Base URL

Sandbox:    https://sandbox.vault.axon.com
Production: https://vault.axon.com

Autenticacao

Todas as requisicoes devem incluir o header de autenticacao:

Authorization: Bearer {api_key_secret}

Endpoints - Tokenizacao

POST

/v1/tokens

Tokeniza dados de cartao de credito/debito (scope: tokens:write)

GET

/v1/tokens/{id}

Detokeniza - recupera dados originais (scope: tokens:read)

DELETE

/v1/tokens/{id}

Remove um token (soft delete) (scope: tokens:write)

Endpoints - PIX Tokenization

POST

/v1/pix/tokens

Tokeniza uma chave PIX com validacao DICT opcional (scope: pix:write)

GET

/v1/pix/tokens/{token}

Detokeniza chave PIX (scope: pix:read)

DELETE

/v1/pix/tokens/{token}

Remove um token PIX (scope: pix:write)

Endpoints - Compliance

POST

/v1/compliance/evaluate

Avalia uma entidade contra todas as regras ativas (scope: compliance:write)

Requestjson

{
  "entity_type": "TRANSACTION",
  "entity_id": "tx_123",
  "data": { "amount": 50000 }
}

POST

/v1/compliance/rules

Cria regra de compliance (7 categorias) (scope: compliance:write)

GET

/v1/compliance/rules

Lista regras (scope: compliance:read)

POST

/v1/compliance/blocklist

Adiciona a blocklist (ISPB, CPF, CNPJ, EMAIL, PHONE, ACCOUNT) (scope: compliance:write)

POST

/v1/compliance/blocklist/check

Verifica se valor esta na blocklist (scope: compliance:read)

Endpoints - Limites

POST

/v1/limits/check

Verifica limites sem consumir (scope: limits:write)

Requestjson

{
  "account_id": "acc_123",
  "channel": "pix_out",
  "amount": 50000
}

POST

/v1/limits/consume

Check + increment atomico (scope: limits:write)

POST

/v1/limits/templates

Cria template de limite (scope: limits:write)

GET

/v1/limits/accounts/{id}/usage

Consulta uso atual (scope: limits:read)

Endpoints - KYC/Onboarding

POST

/v1/kyc/registers

Cria registro KYC (scope: kyc:write)

Requestjson

{
  "tax_id": "12345678901",
  "person_type": "NATURAL",
  "name": "Joao Silva",
  "document_type": "CPF",
  "document_number": "12345678901"
}

PATCH

/v1/kyc/registers/{id}/status

Atualiza status KYC (scope: kyc:write)

POST

/v1/kyc/registers/{id}/face-verification

Submete face verification (scope: kyc:write)

POST

/v1/kyc/blocklist

Adiciona a blocklist KYC (7 tipos) (scope: kyc:write)

Endpoints - Ledger

POST

/v1/ledger/accounts

Cria conta no ledger (scope: ledger:write)

POST

/v1/ledger/transfers

Processa transferencia double-entry (scope: ledger:write)

GET

/v1/ledger/accounts/{id}/balance

Consulta saldo (scope: ledger:read)

GET

/v1/ledger/accounts/{id}/entries

Lista entries da conta (scope: ledger:read)

Endpoints - DICT

POST

/v1/dict/keys

Registra chave PIX (scope: dict:write)

POST

/v1/dict/keys/lookup

Lookup chave por tipo+valor (scope: dict:read)

POST

/v1/dict/claims

Inicia claim de portabilidade (scope: dict:write)

POST

/v1/dict/infractions

Reporta infracao/fraude (scope: dict:write)

POST

/v1/dict/refunds

Solicita reembolso (scope: dict:write)

Scopes de Autorizacao

Scope	Descricao
tokens:read/write	Tokenizacao de cartoes
pix:read/write	Tokenizacao PIX
ledger:read/write	Contabilidade double-entry
dict:read/write	Chaves PIX, claims, infracoes
compliance:read/write	Regras, risk scoring, blocklist
limits:read/write	Limites transacionais
kyc:read/write	KYC/onboarding
admin:keys	Gerenciamento de API keys

Tipos de chave PIX

Tipo	key_type	Formato
CPF	cpf	11 digitos
CNPJ	cnpj	14 digitos
Email	email	Email valido
Telefone	phone	+55DDDNNNNNNNNN
Chave aleatoria	evp	UUID v4