> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.
# API de backtest de regras de monitoramento de transações
> Simule uma regra KYT no seu histórico antes de ativá-la na Didit: correspondências, total avaliado e sujeitos afetados. Somente leitura e grátis.
Prompt da API de backtest de regras
Copiar o prompt para a área de transferência
\
\`Backtest a hypothetical rule configuration against my recent transactions.
Endpoint:
POST https://verification.didit.me/v3/transactions/rules/backtest/
Authentication:
Use the x-api-key header with my Didit API key.
Request body (application/json):
\{
"conditions": [{"field": "currency", "operator": "eq", "value": "EUR"},
\{"field": "amount", "operator": "lt", "value": 10000}],
"aggregation": [{"metric": "count", "operator": "gte", "value": 20, "window": "30d",
"filters": {"direction": "INBOUND", "transaction_type": "finance", "currency": "EUR", "subject_vendor_data": "__current__"}},
\{"metric": "max", "field": "amount", "operator": "lt", "value": 10000, "window": "30d",
"filters": {"direction": "INBOUND", "transaction_type": "finance", "currency": "EUR", "subject_vendor_data": "__current__"}}],
"evaluation_mode": "ALL",
"scope": {"transaction_types": ["finance"], "directions": ["INBOUND"]},
"period_days": 90 // 1-365, default 90
}
Response:
\{ "evaluated": 4820, "matched": 12, "affected_entities": 4, "period_days": 90 }
Behavior:
\- Read-only and free: no rule is created, no transaction is modified, no rule runs are recorded.
\- Evaluates the most recent transactions in the period, up to the backtest cap.
\- affected_entities counts distinct subjects (by vendor_data) among the matches.
\- Use it before switching a rule to ACTIVE; a surprising match count means the thresholds need tuning.
\- Copy the candidate rule EXACTLY: same conditions, aggregation, evaluation_mode and scope. Omitted conditions, aggregation and scope add no constraints of their own; dropping scope can include directions or transaction types the saved rule skips. Omitted evaluation_mode defaults to ALL (which can reduce matches for an ANY rule), and omitted period_days defaults to 90 days, not unlimited history.
Sandbox fixtures for this example: at least 20 inbound EUR finance transactions for the same subject within 30 days, each with raw amount below 10000. No normalized amount is required. Sandbox ingestion does not evaluate rules; call backtest explicitly.
Failure modes:
\- 400 - same condition/aggregation/scope validation as rule create.`
\
Colar em
## OpenAPI
````yaml pt-br/openapi-25.json POST /v3/transactions/rules/backtest/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: API de verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/transactions/rules/backtest/:
post:
tags:
- Transactions
summary: Configuração da regra de backtest
description: >-
Avalie uma configuração de regra hipotética com base nas suas transações
recentes (das mais recentes para as mais antigas, até o limite do
backtest) sem criar uma regra nem alterar nenhuma transação. Use antes
de ativar uma regra para ver com que frequência ela teria correspondido
e quantos sujeitos ela teria afetado.
operationId: backtestTransactionRules
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionRuleBacktestRequest'
example:
conditions:
- field: currency
operator: eq
value: EUR
- field: amount
operator: lt
value: 10000
aggregation:
- metric: count
operator: gte
value: 20
window: 30d
filters:
direction: INBOUND
transaction_type: finance
subject_vendor_data: __current__
currency: EUR
- metric: max
field: amount
operator: lt
value: 10000
window: 30d
filters:
direction: INBOUND
transaction_type: finance
subject_vendor_data: __current__
currency: EUR
evaluation_mode: ALL
scope:
transaction_types:
- finance
directions:
- INBOUND
period_days: 90
responses:
'200':
description: Estatísticas do backtest.
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionRuleBacktestResult'
example:
evaluated: 4820
matched: 12
affected_entities: 4
period_days: 90
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: curl
source: >-
curl -X POST
'https://verification.didit.me/v3/transactions/rules/backtest/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"conditions": [{"field": "currency", "operator": "eq", "value": "EUR"}, {"field": "amount", "operator": "lt", "value": 10000}], "aggregation": [{"metric": "count", "operator": "gte", "value": 20, "window": "30d", "filters": {"direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR"}}, {"metric": "max", "field": "amount", "operator": "lt", "value": 10000, "window": "30d", "filters": {"direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR"}}], "evaluation_mode": "ALL", "scope": {"transaction_types": ["finance"], "directions": ["INBOUND"]}, "period_days": 90}'
- lang: python
label: Python
source: |-
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.transactions.rules.backtest(
conditions=[{
"field": "currency",
"operator": "eq",
"value": "EUR",
}, {
"field": "amount",
"operator": "lt",
"value": 10000,
}],
aggregation=[{
"metric": "count",
"operator": "gte",
"value": 20.0,
"window": "30d",
"filters": {"direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR"},
}, {
"metric": "max",
"field": "amount",
"operator": "lt",
"value": 10000.0,
"window": "30d",
"filters": {"direction": "INBOUND", "transaction_type": "finance", "subject_vendor_data": "__current__", "currency": "EUR"},
}],
evaluation_mode="ALL",
scope={
"transaction_types": ["finance"],
"directions": ["INBOUND"],
},
period_days=90,
)
print(result)
- lang: javascript
label: Node.js
source: |-
import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.transactions.rules.backtest({
conditions: [{
field: "currency",
operator: "eq",
value: "EUR",
}, {
field: "amount",
operator: "lt",
value: 10000,
}],
aggregation: [{
metric: "count",
operator: "gte",
value: 20.0,
window: "30d",
filters: { direction: "INBOUND", transaction_type: "finance", subject_vendor_data: "__current__", currency: "EUR" },
}, {
metric: "max",
field: "amount",
operator: "lt",
value: 10000.0,
window: "30d",
filters: { direction: "INBOUND", transaction_type: "finance", subject_vendor_data: "__current__", currency: "EUR" },
}],
evaluation_mode: "ALL",
scope: {
transaction_types: ["finance"],
directions: ["INBOUND"],
},
period_days: 90,
});
console.log(result);
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Rules.Backtest(ctx, didit.TransactionRuleBacktestRequest{\n\tConditions: didit.Some([]didit.TransactionRuleConditionParam{{\n\t\tField: \"currency\",\n\t\tOperator: \"eq\",\n\t\tValue: didit.Some[any](\"EUR\"),\n\t}, {\n\t\tField: \"amount\",\n\t\tOperator: \"lt\",\n\t\tValue: didit.Some[any](10000),\n\t}}),\n\tAggregation: didit.Some([]didit.TransactionRuleAggregationParam{{\n\t\tMetric: didit.Some(didit.TransactionRuleAggregationMetric(\"count\")),\n\t\tOperator: didit.Some(didit.TransactionRuleAggregationOperator(\"gte\")),\n\t\tValue: 20.0,\n\t\tWindow: didit.String(\"30d\"),\n\t\tFilters: didit.Some(map[string]any{\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}),\n\t}, {\n\t\tMetric: didit.Some(didit.TransactionRuleAggregationMetric(\"max\")),\n\t\tField: didit.String(\"amount\"),\n\t\tOperator: didit.Some(didit.TransactionRuleAggregationOperator(\"lt\")),\n\t\tValue: 10000.0,\n\t\tWindow: didit.String(\"30d\"),\n\t\tFilters: didit.Some(map[string]any{\"direction\": \"INBOUND\", \"transaction_type\": \"finance\", \"subject_vendor_data\": \"__current__\", \"currency\": \"EUR\"}),\n\t}}),\n\tEvaluationMode: didit.Some(didit.TransactionRuleBacktestRequestEvaluationMode(\"ALL\")),\n\tScope: didit.Some(didit.TransactionRuleScopeParam{\n\t\tTransactionTypes: didit.Some([]string{\"finance\"}),\n\t\tDirections: didit.Some([]didit.TransactionRuleScopeDirections{\"INBOUND\"}),\n\t}),\n\tPeriodDays: didit.Int(90),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
- lang: java
label: Java
source: >-
import java.util.List;
import java.util.Map;
import me.didit.Didit;
import me.didit.types.TransactionRuleAggregation;
import me.didit.types.TransactionRuleBacktestRequest;
import me.didit.types.TransactionRuleCondition;
import me.didit.types.TransactionRuleScope;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result =
client.transactions().rules().backtest(TransactionRuleBacktestRequest.builder()
.conditions(List.of(
TransactionRuleCondition.builder()
.field("currency")
.operator(TransactionRuleCondition.Operator.of("eq"))
.value("EUR")
.build(),
TransactionRuleCondition.builder()
.field("amount")
.operator(TransactionRuleCondition.Operator.of("lt"))
.value(10000)
.build()))
.aggregation(List.of(
TransactionRuleAggregation.builder()
.metric(TransactionRuleAggregation.Metric.of("count"))
.operator(TransactionRuleAggregation.Operator.of("gte"))
.value(20.0)
.window("30d")
.filters(Map.of("direction", "INBOUND", "transaction_type", "finance", "subject_vendor_data", "__current__", "currency", "EUR"))
.build(),
TransactionRuleAggregation.builder()
.metric(TransactionRuleAggregation.Metric.of("max"))
.field("amount")
.operator(TransactionRuleAggregation.Operator.of("lt"))
.value(10000.0)
.window("30d")
.filters(Map.of("direction", "INBOUND", "transaction_type", "finance", "subject_vendor_data", "__current__", "currency", "EUR"))
.build()))
.evaluationMode(TransactionRuleBacktestRequest.EvaluationMode.of("ALL"))
.scope(TransactionRuleScope.builder()
.transactionTypes(List.of("finance"))
.directions(List.of(TransactionRuleScope.Directions.of("INBOUND")))
.build())
.periodDays(90L)
.build());
System.out.println(result);
- lang: php
label: PHP
source: |-
transactions->rules->backtest([
'conditions' => [[
'field' => 'currency',
'operator' => 'eq',
'value' => 'EUR',
], [
'field' => 'amount',
'operator' => 'lt',
'value' => 10000,
]],
'aggregation' => [[
'metric' => 'count',
'operator' => 'gte',
'value' => 20.0,
'window' => '30d',
'filters' => ['direction' => 'INBOUND', 'transaction_type' => 'finance', 'subject_vendor_data' => '__current__', 'currency' => 'EUR'],
], [
'metric' => 'max',
'field' => 'amount',
'operator' => 'lt',
'value' => 10000.0,
'window' => '30d',
'filters' => ['direction' => 'INBOUND', 'transaction_type' => 'finance', 'subject_vendor_data' => '__current__', 'currency' => 'EUR'],
]],
'evaluation_mode' => 'ALL',
'scope' => [
'transaction_types' => ['finance'],
'directions' => ['INBOUND'],
],
'period_days' => 90,
]);
print_r($result->toArray());
- lang: ruby
label: Ruby
source: |-
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.transactions.rules.backtest(
conditions: [{
field: "currency",
operator: "eq",
value: "EUR",
}, {
field: "amount",
operator: "lt",
value: 10000,
}],
aggregation: [{
metric: "count",
operator: "gte",
value: 20.0,
window: "30d",
filters: { direction: "INBOUND", transaction_type: "finance", subject_vendor_data: "__current__", currency: "EUR" },
}, {
metric: "max",
field: "amount",
operator: "lt",
value: 10000.0,
window: "30d",
filters: { direction: "INBOUND", transaction_type: "finance", subject_vendor_data: "__current__", currency: "EUR" },
}],
evaluation_mode: "ALL",
scope: {
transaction_types: ["finance"],
directions: ["INBOUND"],
},
period_days: 90
)
puts result.to_h
- lang: csharp
label: .NET
source: >-
using System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Transactions.Rules.BacktestAsync(new
TransactionRuleBacktestRequest
{
Conditions = new TransactionRuleCondition[]
{
new()
{
Field = "currency",
Operator = "eq",
Value = "EUR",
},
new()
{
Field = "amount",
Operator = "lt",
Value = 10000,
},
},
Aggregation = new TransactionRuleAggregation[]
{
new()
{
Metric = new TransactionRuleAggregationMetric("count"),
Operator = new TransactionRuleAggregationOperator("gte"),
Value = 20.0,
Window = "30d",
Filters = new Dictionary { ["direction"] = "INBOUND", ["transaction_type"] = "finance", ["subject_vendor_data"] = "__current__", ["currency"] = "EUR" },
},
new()
{
Metric = new TransactionRuleAggregationMetric("max"),
Field = "amount",
Operator = new TransactionRuleAggregationOperator("lt"),
Value = 10000.0,
Window = "30d",
Filters = new Dictionary { ["direction"] = "INBOUND", ["transaction_type"] = "finance", ["subject_vendor_data"] = "__current__", ["currency"] = "EUR" },
},
},
EvaluationMode = new TransactionRuleBacktestRequestEvaluationMode("ALL"),
Scope = new TransactionRuleScope
{
TransactionTypes = new string[] { "finance" },
Directions = new TransactionRuleScopeDirections[] { "INBOUND" },
},
PeriodDays = 90,
});
Console.WriteLine(JsonSerializer.Serialize(result));
components:
schemas:
TransactionRuleBacktestRequest:
type: object
properties:
conditions:
type: array
items:
$ref: '#/components/schemas/TransactionRuleCondition'
default: []
aggregation:
type: array
items:
$ref: '#/components/schemas/TransactionRuleAggregation'
default: []
evaluation_mode:
type: string
enum:
- ALL
- ANY
default: ALL
scope:
$ref: '#/components/schemas/TransactionRuleScope'
period_days:
type: integer
minimum: 1
maximum: 365
default: 90
description: >-
Configuração hipotética de regra a ser avaliada com base nas transações
recentes. Somente leitura e gratuita: nada é criado ou modificado. Envie
as mesmas condições, agregação, evaluation_mode E escopo da regra que
você pretende ativar. Condições, agregação e escopo omitidos não
adicionam restrições próprias; remover o escopo pode incluir direções ou
tipos de transação que a regra salva ignora. Se evaluation_mode for
omitido, o padrão é ALL (o que pode reduzir as correspondências de uma
regra ANY), e se period_days for omitido, o padrão é 90 dias, não o
histórico ilimitado.
TransactionRuleBacktestResult:
type: object
properties:
evaluated:
type: integer
description: Transações avaliadas (as mais recentes primeiro, com limite).
matched:
type: integer
description: Transações que teriam correspondido à configuração.
affected_entities:
type: integer
description: Titulares distintos (por vendor_data) entre as correspondências.
period_days:
type: integer
TransactionRuleCondition:
type: object
required:
- field
- operator
properties:
field:
type: string
description: >-
Caminho do campo da transação a ser avaliado. Campos principais:
amount, currency, direction, action_type, score, severity,
transaction_type, payment_details, preferred_currency_amount (usa
amount_in_default_currency como alternativa), default_currency_code,
subject_country, counterparty_country, subject_vendor_data,
counterparty_vendor_data, subject_device_fingerprint,
counterparty_device_fingerprint, subject_browser_family,
subject_browser_version, subject_platform, subject_accept_language,
subject_session_age_ms, subject_ip_country, counterparty_ip_country,
subject_ip_address, counterparty_ip_address,
subject_payment_method_type, subject_payment_method_country,
subject_payment_method_fingerprint,
subject_payment_method_account_id (e os equivalentes
counterparty_payment_method_*), travel_rule_status,
travel_rule_required, travel_rule_obligations_count,
counterparty_dd_status (sua decisão sobre a contraparte da Travel
Rule: APPROVED, RESTRICTED ou BLOCKED; uma entidade segue a decisão
da sua marca), counterparty_risk_level (LOW, MEDIUM ou HIGH; HIGH
enquanto a sua própria triagem da contraparte estiver sinalizada),
counterparty_jurisdiction (o país do VASP da contraparte),
counterparty_responsiveness (RESPONSIVE, UNRESPONSIVE ou UNKNOWN),
subject_days_since_previous_transaction, tags e custom_values.
para qualquer chave enviada em custom_properties na criação da
transação. Campos de código de país aceitam ISO-2 ou ISO-3; ambos os
lados são normalizados para ISO-3 antes da comparação.
operator:
type: string
enum:
- eq
- ne
- gt
- gte
- lt
- lte
- in
- not_in
- contains
- not_contains
- contains_any
- regex
- fuzzy_match
- exists
- is_not_empty
- is_not_null
- not_exists
- is_empty
- is_null
description: >-
Operador de comparação. in/not_in testam pertencimento (o valor pode
ser uma lista ou um único escalar). contains/not_contains verificam,
sem diferenciar maiúsculas de minúsculas, se uma substring está
contida em um valor de texto. contains_any recebe uma lista de
strings e corresponde quando qualquer uma delas é uma substring do
valor do campo, sem diferenciar maiúsculas de minúsculas. regex
compara o padrão do valor com o campo. fuzzy_match compara com a
string do valor usando o limiar `score` exigido (0-100).
gt/gte/lt/lte nunca correspondem quando um dos lados está ausente.
exists/is_not_empty/is_not_null (aliases) e
not_exists/is_empty/is_null (aliases) são verificações de presença
que ignoram `value`.
value:
description: >-
Valor de comparação. Seu formato depende do operador e de
value_type; omita-o nos operadores de verificação de presença. Todos
os outros operadores exigem um valor que não seja `null` nem uma
lista vazia; caso contrário, a regra é recusada com `400`.
`contains_any` exige uma lista de strings, e `contains`,
`not_contains` e `regex` exigem uma única string.
value_type:
type: string
enum:
- list
- field
- relative_date
description: >-
Interpretação opcional do valor. `list`: o valor é o UUID de uma
lista, e as entradas da lista passam a ser o valor de comparação.
`field`: o valor é o caminho de outro campo, comparado campo a
campo. `relative_date`: o valor é um objeto de data relativa, por
exemplo {"direction": "past", "unit": "days", "amount": 30}.
score:
type: number
minimum: 0
maximum: 100
description: >-
Obrigatório quando o operator for fuzzy_match: o limiar de
similaridade de 0 a 100.
group_index:
type: integer
description: >-
Lógica agrupada opcional. Quando alguma condição tiver group_index,
as condições que compartilham um índice formam um grupo, e a
avaliação agrupada substitui evaluation_mode.
group_logic:
type: string
enum:
- AND
- OR
default: AND
description: Como as condições se combinam DENTRO de um grupo.
groups_logic:
type: string
enum:
- AND
- OR
default: OR
description: >-
Como os resultados dos grupos se combinam ENTRE os grupos. Lido a
partir da primeira condição.
description: >-
Uma condição lê apenas a transação que está sendo avaliada - ela nunca
filtra a janela de agregação.
TransactionRuleAggregation:
type: object
required:
- value
properties:
metric:
type: string
enum:
- count
- sum
- max
- min
- avg
- distinct_count
default: count
description: >-
Como as transações históricas correspondentes são agregadas.
unique_count é aceito como alias de distinct_count.
field:
type: string
default: amount
description: >-
Campo agregado por sum/max/min/avg/distinct_count. Ignorado para
count.
operator:
type: string
enum:
- eq
- ne
- gt
- gte
- lt
- lte
default: eq
description: Comparação aplicada à métrica calculada.
value:
type: number
description: Limiar com o qual a métrica calculada é comparada.
window:
type: string
pattern: ^\d+(m|h|d)$
default: 1d
description: >-
Janela retroativa que termina na txn_date da transação: m
(MINUTOS, não meses), h (horas) ou d (dias), por exemplo, 30m,
24h, 7d, 30d.
filters:
type: object
additionalProperties: true
description: >-
Restringe quais transações históricas são agregadas. As chaves são
caminhos de campo do catálogo de campos de condição; um valor
"__current__" é resolvido para o valor do mesmo campo na transação
que está sendo avaliada (por exemplo, {"subject_vendor_data":
"__current__"} limita a janela ao mesmo titular), e um valor em
lista significa pertencimento. Os filtros comparam SOMENTE por
igualdade ou pertencimento: não existe filtro lt/gte, portanto um
intervalo como "transações históricas abaixo de 10,000" não pode ser
expresso aqui. Em vez disso, coloque o intervalo na métrica (a
métrica max com o operador lt mantém todas as transações da janela
abaixo do limiar).
description: >-
Verificação de velocidade sobre as transações históricas da aplicação
dentro da janela. Todas as entradas de agregação devem corresponder para
que a regra corresponda, independentemente de evaluation_mode. Uma
agregação restringe apenas a janela; a transação em avaliação é
restringida por scope e conditions, portanto repita direction, currency
ou transaction_type nas duas partes quando a regra os garantir.
TransactionRuleScope:
type: object
properties:
transaction_types:
type: array
items:
type: string
description: >-
Restringe a tipos de transação, por exemplo finance, kyc,
travel_rule, user_event. Vazio ou ausente = sem restrição.
directions:
type: array
items:
type: string
enum:
- INBOUND
- OUTBOUND
description: >-
Restringe a direções de transação (sem distinção entre maiúsculas e
minúsculas na gravação).
action_types:
type: array
items:
type: string
description: >-
Restringe aos seus valores de action_type, por exemplo withdrawal,
deposit.
description: >-
A quais transações a regra se aplica. Somente estas três chaves são
aceitas.
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
Chave de API da sua aplicação, em Developers -> API keys no Business
Console. A chave principal tem acesso total. Uma chave nomeada pode ter
escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada
a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a
uma data de validade. 401 significa que a chave está errada, revogada ou
expirada; 403 significa que nenhuma chave foi enviada, que a chave não
tem acesso a este recurso ou ação, ou que a requisição veio de um
endereço fora da sua lista de IPs; 404 em uma rota de sessão significa
que a sessão está fora dos fluxos ou status da chave. Uma chave sem
acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave
sem permissão de escrita em sessões recebe links e tokens de sessão como
null. Consulte https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.