Skip to main content
POST
/
v3
/
transactions
Create Transaction
curl --request POST \
  --url https://verification.didit.me/v3/transactions/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "transaction_id": "<string>",
  "transaction_category": "finance",
  "transaction_details": {
    "direction": "inbound",
    "amount": 123,
    "currency": "<string>",
    "currency_kind": "<string>",
    "amount_in_default_currency": 123,
    "default_currency": "<string>",
    "payment_details": "<string>",
    "payment_reference_id": "<string>",
    "action_type": "<string>"
  },
  "subject": {
    "vendor_data": "<string>",
    "full_name": "<string>",
    "entity_type": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "2023-12-25",
    "address": {
      "country": "<string>",
      "town": "<string>",
      "state": "<string>",
      "street": "<string>",
      "post_code": "<string>"
    },
    "institution_details": {
      "name": "<string>",
      "code": "<string>",
      "address": {}
    },
    "device_context": {},
    "payment_method": {
      "method_type": "<string>",
      "account_id": "<string>",
      "issuing_country": "<string>"
    }
  },
  "transaction_at": "2023-11-07T05:31:56Z",
  "time_zone": "<string>",
  "counterparty": {
    "entity_type": "<string>",
    "vendor_data": "<string>",
    "full_name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "2023-12-25",
    "address": {},
    "institution_details": {},
    "device_context": {},
    "payment_method": {
      "method_type": "<string>",
      "account_id": "<string>",
      "issuing_country": "<string>"
    }
  },
  "custom_properties": {},
  "network_snapshot": {
    "nodes": [
      {}
    ],
    "edges": [
      {}
    ],
    "metrics": {}
  },
  "include_crypto_screening": true
}
'
{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "txn_id": "<string>",
  "status": "<string>",
  "score": 123,
  "severity": "<string>"
}

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.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
transaction_id
string
required

Your unique identifier for this transaction (max 128 characters).

​
transaction_category
enum<string>
required

Category of the transaction.

Available options:
finance,
kyc,
travel_rule,
user_event,
audit_trail_event,
gambling_bet,
gambling_limit_change,
gambling_bonus_change
​
transaction_details
object
required

Core financial details of the transaction.

​
subject
object
required

The subject (applicant) of the transaction.

​
transaction_at
string<date-time>

When the transaction occurred. Defaults to now if omitted.

​
time_zone
string

IANA time zone identifier, e.g. Europe/Madrid.

​
counterparty
object

The counterparty of the transaction (optional).

​
custom_properties
object

Arbitrary key-value pairs attached to the transaction.

​
travel_rule_details
object

Travel Rule compliance metadata.

​
network_snapshot
object

Pre-computed network graph snapshot.

​
include_crypto_screening
boolean | null

Per-transaction override for crypto blockchain analytics screening. When true, crypto screening is performed regardless of the application default. When false, crypto screening is skipped even if enabled in the application settings. When omitted or null, the application-level default configured in the Console is used. Crypto screening requires transaction_details.direction, currency_kind: "crypto", a chain/currency, and the wallet address selected by the direction: inbound pre-transfer screening uses counterparty.payment_method.account_id, inbound transaction-hash screening uses subject.payment_method.account_id, and outbound screening uses counterparty.payment_method.account_id. When transaction_details.payment_reference_id contains a blockchain transaction hash, Didit performs transaction screening and returns transaction summary enrichment when available.

Response

201 - application/json

Created

​
uuid
string<uuid>
​
txn_id
string
​
status
string
​
score
integer
​
severity
string