Skip to main content
API docs by Redocly

API de Contas — CryptoRisk

Download OpenAPI specification:Download

Consulta de risco de carteiras cripto (Ethereum e Tron) pela API de Contas (/api/v2).

Escopos: crypto-risk.read e crypto-risk.write. Credenciais já emitidas não recebem esses escopos automaticamente — crie uma nova credencial ou atualize a existente em Configurações → API Contas → Nova credencial. Credencial BaaS envia x-account-id.

Fluxo 201 vs 202

  1. POST /crypto-risk/analyses com { network, address }.
  2. 201 — histórico já ingerido: snapshot fechado com events.
  3. 202 — ingestão desta carteira começou ou ainda está rodando. O body não tem analysis id.
  4. Faça poll em GET /crypto-risk/ingest?network=&address= até IDLE com persisted != null (0 transações é índice vazio válido).
  5. Repita o POST para obter 201.
Retry do POST enquanto o ingest desta carteira está RUNNING também devolve 202. Ingest de outra carteira devolve 409. BITCOIN, TRX e demais redes devolvem 422 antes de qualquer chamada upstream.

Ingest vazio não é carteira limpa

Risk 0 + baixa confiança + historyCovered=false é ingest vazio, não carteira limpa. Os scores passam como o CryptoRisk devolve.

O snapshot público não inclui features, grafo de exposição, PDF, sanctions nem hash / endereço de contraparte nos events.

Guia: documentação CryptoRisk (seção Pagamentos).

CryptoRisk

Consulta de risco de carteiras cripto (Ethereum e Tron) pela API de Contas.

Escopos: crypto-risk.read e crypto-risk.write.

Solicitar análise de risco de carteira cripto.

Analisa a carteira {network, address}. Sem accountId no body. Redes: apenas ETHEREUM e TRON. BITCOIN, TRX e outras respondem 422 antes de qualquer chamada upstream.

201 quando o histórico já está ingerido — snapshot fechado com events. 202 se a ingestão desta carteira começou ou ainda está rodando. O 202 não tem analysis id. Faça poll em GET /crypto-risk/ingest até IDLE com persisted != null e repita o POST.

Retry do POST enquanto o ingest desta carteira está RUNNING também devolve 202. Ingest de outra carteira devolve 409.

Risk 0 + baixa confiança + historyCovered=false é ingest vazio, não carteira limpa.

Authorizations:
OAuth2
header Parameters
x-account-id
integer <int64>

Identificador interno da conta filha que será operada. Obrigatório quando o token foi emitido por uma credencial BaaS (clientId com prefixo baas_) em endpoints operacionais de conta.

Request Body schema: application/json
required
network
required
string (CryptoRiskNetwork)
Enum: "ETHEREUM" "TRON"

Redes suportadas na API de Contas. BITCOIN, TRX e qualquer outro valor respondem 422 antes de qualquer chamada upstream.

address
required
string [ 1 .. 128 ] characters

Endereço da carteira na rede informada.

Responses

Request samples

Content type
application/json
{
  • "network": "ETHEREUM",
  • "address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Listar análises de risco da conta.

Lista os snapshots fechados da conta autenticada. Itens sem events. Filtro address exige network. Paginação { meta: { total, page, limit }, data }.

Authorizations:
OAuth2
query Parameters
network
string (CryptoRiskNetwork)
Enum: "ETHEREUM" "TRON"

Redes suportadas na API de Contas. BITCOIN, TRX e qualquer outro valor respondem 422 antes de qualquer chamada upstream.

address
string <= 128 characters

Exige network.

page
integer [ 1 .. 10000 ]
Default: 1
limit
integer [ 1 .. 100 ]
Default: 20
header Parameters
x-account-id
integer <int64>

Identificador interno da conta filha que será operada. Obrigatório quando o token foi emitido por uma credencial BaaS (clientId com prefixo baas_) em endpoints operacionais de conta.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Consultar snapshot fechado de uma análise.

Devolve o snapshot fechado com resumos de events. Análise de outra conta responde 404. O id é inteiro positivo.

Authorizations:
OAuth2
path Parameters
id
required
string^[0-9]+$
header Parameters
x-account-id
integer <int64>

Identificador interno da conta filha que será operada. Obrigatório quando o token foi emitido por uma credencial BaaS (clientId com prefixo baas_) em endpoints operacionais de conta.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Consultar progresso da ingestão de uma carteira.

Use após um 202 em POST /crypto-risk/analyses. Faça poll até status=IDLE e persisted != null (0 transações é índice vazio válido) e então repita o POST para obter 201.

Authorizations:
OAuth2
query Parameters
network
required
string (CryptoRiskNetwork)
Enum: "ETHEREUM" "TRON"

Redes suportadas na API de Contas. BITCOIN, TRX e qualquer outro valor respondem 422 antes de qualquer chamada upstream.

address
required
string [ 1 .. 128 ] characters
header Parameters
x-account-id
integer <int64>

Identificador interno da conta filha que será operada. Obrigatório quando o token foi emitido por uma credencial BaaS (clientId com prefixo baas_) em endpoints operacionais de conta.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}