API Reference

The Seqlense Monitoring API - authentication, endpoints, schemas and live examples.

List alerts

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

status?string

Filter by alert status.

Value in

"OPEN"
"ACKNOWLEDGED"
"RESOLVED"
"MUTED"

severity?string

Filter by severity.

Value in

"INFO"
"WARNING"
"CRITICAL"

source?string

Filter by source (e.g. wallet-analyzer).

Lengthlength <= 100

entity_type?string

Filter by entity type (e.g. WALLET, IDENTITY, JOB).

q?string

Search in title, message, and source.

Lengthlength <= 100

page?integer

Default1

Response Body

`application/json`

curl -X GET "https://example.com/v1/alerts/"

{  "alerts": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "source": "string",      "severity": "INFO",      "title": "string",      "message": "string",      "entity_type": "string",      "entity_id": "8161163a-f227-466f-bc01-090a01e80165",      "status": "OPEN",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "page": 0,  "limit": 0}

Create an alert

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

source*string

Origin service identifier.

Lengthlength <= 100

severity*string

Value in

"INFO"
"WARNING"
"CRITICAL"

title*string

Lengthlength <= 200

message*string

Detailed alert description.

entity_type?string

Optional entity type (e.g. WALLET, IDENTITY, JOB).

entity_id?string

Optional UUID of the entity concerned.

Formatuuid

metadata?

Free-form JSON payload from the worker.

Response Body

`application/json`

curl -X POST "https://example.com/v1/alerts/" \  -H "Content-Type: application/json" \  -d '{    "source": "wallet-analyzer",    "severity": "INFO",    "title": "Suspicious transaction detected",    "message": "Wallet 0xABC received 150 ETH from sanctioned address 0xDEF"  }'

{  "status": "ok",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"}

Delete an alert

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

id*string

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/alerts/?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "status": "ok"}

Acknowledge an alert

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id*string

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/v1/alerts/acknowledge" \  -H "Content-Type: application/json" \  -d '{    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"  }'

{  "status": "ok"}

Bulk acknowledge or resolve alerts

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

ids*array<>

Array of alert UUIDs.

Itemsitems <= 100

action*string

Value in

"acknowledge"
"resolve"

Response Body

`application/json`

curl -X POST "https://example.com/v1/alerts/bulk-action" \  -H "Content-Type: application/json" \  -d '{    "ids": [      "6e0346a3-e54d-40e3-9779-4ba1e707e35b"    ],    "action": "acknowledge"  }'

{  "status": "ok"}

List notification channels

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/alerts/channels"

{  "channels": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "channel_type": "IN_APP",      "is_active": true,      "filter_severity": [        "string"      ],      "filter_sources": [        "string"      ],      "filter_entity_types": [        "string"      ],      "created_at": "2019-08-24T14:15:22Z"    }  ]}

Create a notification channel

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Lengthlength <= 100

channel_type*string

Value in

"IN_APP"
"WEBHOOK"
"DISCORD"
"SLACK"
"EMAIL"

config?

Required for WEBHOOK, DISCORD, SLACK. Must contain url. WEBHOOK also supports optional secret (HMAC-SHA256 signing) and headers.

filter_severity?array<>

Only forward alerts matching these severities. Omit or null for all.

filter_sources?array<string>

Only forward alerts from these sources. Omit or null for all.

filter_entity_types?array<string>

Only forward alerts for these entity types. Omit or null for all.

Response Body

`application/json`

curl -X POST "https://example.com/v1/alerts/channels" \  -H "Content-Type: application/json" \  -d '{    "name": "Slack #alerts",    "channel_type": "IN_APP"  }'

{  "status": "ok",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"}

Delete a notification channel

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

id*string

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/alerts/channels?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "status": "ok"}

Update a notification channel

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id*string

Formatuuid

name?string

Lengthlength <= 100

config?

Channel-specific config, for example {"url": "..."} for webhook, Discord or Slack.

filter_severity?array<>

filter_sources?array<string>

filter_entity_types?array<string>

is_active?boolean

Response Body

`application/json`

curl -X PUT "https://example.com/v1/alerts/channels" \  -H "Content-Type: application/json" \  -d '{    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"  }'

{  "status": "ok"}

Get channel detail

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

id*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/alerts/channels/detail?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "channel_type": "IN_APP",  "config": {},  "filter_severity": [    "INFO"  ],  "filter_sources": [    "string"  ],  "filter_entity_types": [    "string"  ],  "is_active": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Send a test alert to a channel

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id*string

ID of the channel to test.

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/v1/alerts/channels/test" \  -H "Content-Type: application/json" \  -d '{    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"  }'

{  "status": "ok",  "test_alert_id": "be48373a-ede4-4900-a26e-e97a078a0465"}

Get alert counts

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/alerts/count"

{  "total": 0,  "open": 0,  "critical_open": 0}

Get alert detail

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

id*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/alerts/detail?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "source": "string",  "severity": "INFO",  "title": "string",  "message": "string",  "entity_type": "string",  "entity_id": "8161163a-f227-466f-bc01-090a01e80165",  "metadata": {},  "status": "OPEN",  "acknowledged_by": 0,  "acknowledged_at": "2019-08-24T14:15:22Z",  "resolved_by": 0,  "resolved_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "deliveries": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "status": "PENDING",      "channel_name": "string",      "channel_type": "IN_APP",      "response_code": 0,      "error_message": "string",      "delivered_at": "2019-08-24T14:15:22Z"    }  ]}

Get alert event history

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

severity?string

Value in

"INFO"
"WARNING"
"CRITICAL"

source?string

Lengthlength <= 100

limit?integer

Rangevalue <= 200

Default50

offset?integer

Default0

Response Body

`application/json`

curl -X GET "https://example.com/v1/alerts/history"

{  "events": [    {      "event_uuid": "edeeb604-9b4c-4f9d-8619-8d1d70caf94c",      "alert_id": "c8b0bcf7-1a95-4165-9b1e-665b02ceda9f",      "source": "string",      "severity": "INFO",      "title": "string",      "message": "string",      "entity_type": "string",      "entity_id": "string",      "status": "string",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "limit": 0,  "offset": 0}

Resolve an alert

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id*string

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/v1/alerts/resolve" \  -H "Content-Type: application/json" \  -d '{    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"  }'

{  "status": "ok"}

Hello world

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

name?string

Name to greet. Defaults to world.

Response Body

`application/json`

curl -X GET "https://example.com/v1/hello"

{  "message": "Hello, world!",  "service": "seqlense-monitoring",  "version": "1.0.0"}

List identities

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

type?string

Filter by identity type.

Value in

"PERSON"
"COMPANY"
"GOVERNMENT"

q?string

Case-insensitive search on the display name (person first/last name, company legal name, or government official name). Max 100 characters.

Lengthlength <= 100

page?integer

1-based page number.

Range1 <= value <= 10000

Default1

Response Body

`application/json`

curl -X GET "https://example.com/v1/identity/"

{  "identities": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "type": "PERSON",      "display_name": "string",      "country": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "page": 0,    "page_size": 0,    "total": 0,    "total_pages": 0,    "has_next": true,    "has_prev": true  }}

Create an identity

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type*string

first_name*string

Lengthlength <= 25

last_name*string

Lengthlength <= 25

middle_name?string

date_of_birth?string

ISO date, YYYY-MM-DD.

Formatdate

place_of_birth?string

nationality?string

ISO 3166-1 alpha-2 country code.

gender?string

Value in

"M"
"F"
"OTHER"

pep_status?string

Default"NONE"

Value in

"NONE"
"PEP"
"RELATIVE"
"CLOSE_ASSOCIATE"

Response Body

`application/json`

curl -X POST "https://example.com/v1/identity/" \  -H "Content-Type: application/json" \  -d '{    "type": "PERSON",    "first_name": "Alice",    "last_name": "Martin",    "nationality": "FR",    "date_of_birth": "1990-05-14",    "pep_status": "NONE"  }'

{  "status": "ok",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"}

Delete an identity

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

id*string

UUID of the identity to delete.

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/identity/?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "status": "ok"}

Update an identity

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Fields that can be updated on an identity. Provide only the ones you want to change; the applicable set depends on the identity's type.

id*string

UUID of the identity to update.

Formatuuid

first_name?string

Lengthlength <= 25

last_name?string

Lengthlength <= 25

middle_name?string

date_of_birth?string

ISO date, YYYY-MM-DD.

Formatdate

place_of_birth?string

nationality?string

ISO 3166-1 alpha-2 country code.

gender?string

Value in

"M"
"F"
"OTHER"

pep_status?string

Value in

"NONE"
"PEP"
"RELATIVE"
"CLOSE_ASSOCIATE"

legal_name?string

Lengthlength <= 255

trade_name?string

legal_form?string

registration_number?string

country_of_incorporation?string

ISO 3166-1 alpha-2 country code.

official_name?string

Lengthlength <= 255

country_code?string

ISO 3166-1 alpha-2 country code.

institution_type?string

jurisdiction_level?string

Value in

"NATIONAL"
"REGIONAL"
"LOCAL"

Response Body

`application/json`

curl -X PUT "https://example.com/v1/identity/" \  -H "Content-Type: application/json" \  -d '{    "id": "6f9619ff-8b86-d011-b42d-00c04fc964ff",    "pep_status": "PEP"  }'

{  "status": "ok"}

Get identity activity

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

id?string

Restrict the feed to a single identity UUID.

Formatuuid

q?string

Search in entity title, detail, or actor name. Max 100 characters.

Lengthlength <= 100

page?integer

1-based page number.

Range1 <= value

Default1

Response Body

`application/json`

curl -X GET "https://example.com/v1/identity/activity"

{  "events": [    {      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",      "entity_uuid": "ccd0bbaa-1979-4620-9054-a91c61d70e41",      "entity_title": "string",      "action": "string",      "detail": "string",      "severity": "INFO",      "actor": "string",      "actor_name": "string",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "page": 0,    "page_size": 0  }}

Bulk create identities

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

items*array<||>

Identities to create. Each item follows the create-identity shape.

Items1 <= items <= 1000

Response Body

`application/json`

curl -X POST "https://example.com/v1/identity/bulk" \  -H "Content-Type: application/json" \  -d '{    "items": [      {        "type": "PERSON",        "first_name": "string",        "last_name": "string"      }    ]  }'

{  "status": "ok",  "success": 0,  "failed": 0,  "errors": [    {      "index": 0,      "error": "string"    }  ]}

Bulk delete identities

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

ids*array<>

UUIDs of the identities to delete.

Items1 <= items <= 500

Response Body

`application/json`

curl -X POST "https://example.com/v1/identity/bulk-delete" \  -H "Content-Type: application/json" \  -d '{    "ids": [      "6e0346a3-e54d-40e3-9779-4ba1e707e35b"    ]  }'

{  "status": "ok",  "success": 0,  "failed": 0}

Count identities

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/identity/count"

{  "total": 0,  "persons": 0,  "companies": 0,  "governments": 0}

List deleted identities

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

type?string

Filter by identity type.

Value in

"PERSON"
"COMPANY"
"GOVERNMENT"

q?string

Search on display name. Max 100 characters.

Lengthlength <= 100

page?integer

1-based page number.

Range1 <= value <= 10000

Default1

Response Body

`application/json`

curl -X GET "https://example.com/v1/identity/deleted"

{  "identities": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "type": "PERSON",      "display_name": "string",      "country": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "page": 0,    "page_size": 0,    "total": 0,    "total_pages": 0,    "has_next": true,    "has_prev": true  }}

Get identity detail

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

id*string

UUID of the identity.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/identity/detail?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "type": "PERSON",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "person": {    "first_name": "string",    "last_name": "string",    "middle_name": "string",    "date_of_birth": "2019-08-24",    "place_of_birth": "string",    "nationality": "string",    "gender": "M",    "pep_status": "NONE"  },  "company": {    "legal_name": "string",    "trade_name": "string",    "legal_form": "string",    "registration_number": "string",    "country_of_incorporation": "string"  },  "government": {    "official_name": "string",    "country_code": "string",    "institution_type": "string",    "jurisdiction_level": "NATIONAL"  }}

Restore a deleted identity

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id*string

UUID of the identity to restore.

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/v1/identity/restore" \  -H "Content-Type: application/json" \  -d '{    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"  }'

{  "status": "ok"}

Get SIRET enrichment

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

id*string

UUID of the company identity.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/identity/siret?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "siret": "string",  "siren": "string",  "denomination": "string",  "forme_juridique": "string",  "categorie_juridique": "string",  "code_naf": "string",  "libelle_naf": "string",  "domaine_activite": "string",  "date_creation": "2019-08-24",  "statut": "string",  "entreprise_cessee": true,  "capital": 0,  "effectif": "string",  "tranche_effectif": "string",  "adresse": "string",  "code_postal": "string",  "ville": "string",  "pays": "string",  "latitude": 0,  "longitude": 0,  "fetched_at": "2019-08-24T14:15:22Z"}

Refresh SIRET enrichment

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id*string

UUID of the company identity to refresh.

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/v1/identity/siret/refresh" \  -H "Content-Type: application/json" \  -d '{    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"  }'

{  "siret": "string",  "siren": "string",  "denomination": "string",  "forme_juridique": "string",  "categorie_juridique": "string",  "code_naf": "string",  "libelle_naf": "string",  "domaine_activite": "string",  "date_creation": "2019-08-24",  "statut": "string",  "entreprise_cessee": true,  "capital": 0,  "effectif": "string",  "tranche_effectif": "string",  "adresse": "string",  "code_postal": "string",  "ville": "string",  "pays": "string",  "latitude": 0,  "longitude": 0,  "fetched_at": "2019-08-24T14:15:22Z"}

Launch a market-abuse scan

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

wallet*string

Address to scan.

Lengthlength <= 190

chain*string

Either the full chain name or your wallet's own chain code: ethereum and ETH both work.

Value in

"ethereum"
"bitcoin"
"bsc"
"polygon"
"arbitrum"
"optimism"
"base"
"solana"

Response Body

`application/json`

curl -X POST "https://example.com/v1/mabu/runs" \  -H "Content-Type: application/json" \  -d '{    "wallet": "0xd90e2f925da726b50c4ed8d0fb90ad053324f31b",    "chain": "ethereum"  }'

{  "status": "ok",  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f"}

Get one scan run

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

id*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/mabu/runs/detail?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "wallet": "string",  "chain": "string",  "status": "PENDING",  "dispatch_error": "string",  "created_at": "2019-08-24T14:15:22Z",  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z"}

Get a scan report

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

scan_id*string

The job_id returned at launch.

Match^[A-Za-z0-9_-]+$

Lengthlength <= 64

Response Body

`application/json`

curl -X GET "https://example.com/v1/mabu/runs/result?scan_id=string"

{  "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",  "type": "job.success.mabu",  "source": "string",  "timestamp": "2019-08-24T14:15:22Z",  "ingestedAt": "2019-08-24T14:15:22Z",  "data": {    "tool": "string",    "version": "string",    "scanId": "string",    "wallet": "string",    "blockchain": "string",    "generatedAt": "2019-08-24T14:15:22Z",    "durationMs": 0,    "fetch": {},    "walletStats": {},    "graph": {},    "riskCounterparties": [      {}    ],    "market": {},    "traversal": {},    "tokens": [      {}    ],    "patterns": {},    "summary": {}  }}

List scan runs

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

status?string

Value in

"PENDING"
"DISPATCHED"
"RUNNING"
"DONE"
"FAILED"
"CANCELLED"

chain?string

Value in

"ethereum"
"bitcoin"
"bsc"
"polygon"
"arbitrum"
"optimism"
"base"
"solana"

wallet?string

Exact wallet address.

Lengthlength <= 190

q?string

Prefix of a run id.

Lengthlength <= 36

limit?integer

Range1 <= value <= 200

Default25

offset?integer

Range0 <= value

Default0

Response Body

`application/json`

curl -X GET "https://example.com/v1/mabu/runs/search"

{  "runs": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "wallet": "string",      "chain": "string",      "status": "PENDING",      "dispatch_error": "string",      "created_at": "2019-08-24T14:15:22Z",      "started_at": "2019-08-24T14:15:22Z",      "finished_at": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "limit": 0,  "offset": 0}

Get flag thresholds

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/mabu/thresholds"

{  "thresholds": [    {      "pattern": "pump_dump",      "label": "string",      "threshold": 0,      "default": 0,      "customised": true    }  ]}

Set flag thresholds

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

thresholds*

Map of pattern name to threshold.

Response Body

`application/json`

curl -X POST "https://example.com/v1/mabu/thresholds" \  -H "Content-Type: application/json" \  -d '{    "thresholds": {      "pump_dump": 55,      "wash_trading": 80    }  }'

Empty

Reset flag thresholds

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Response Body

`application/json`

curl -X POST "https://example.com/v1/mabu/thresholds/reset"

Empty

List API keys

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Response Body

`application/json`

curl -X GET "https://example.com/v1/settings/api-keys"

{  "keys": [    {      "ak_id": 0,      "ak_name": "string",      "ak_prefix": "sq_p_abcdefg",      "ak_scope": "dev",      "ak_created_by": 0,      "ak_created_by_name": "string",      "ak_created_at": "2019-08-24T14:15:22Z",      "ak_last_used_at": "2019-08-24T14:15:22Z",      "ak_expires_at": "2019-08-24T14:15:22Z",      "ak_is_active": true    }  ]}

Create an API key

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Human-readable label for the key.

Length3 <= length <= 100

scope*string

Environment scope.

Value in

"dev"
"prod"

expires_in_days?integer

Optional expiration in days from now. Omit for no expiration.

Range1 <= value

Response Body

`application/json`

curl -X POST "https://example.com/v1/settings/api-keys" \  -H "Content-Type: application/json" \  -d '{    "name": "Production Backend",    "scope": "dev"  }'

{  "status": "ok",  "key": "sq_p_abcdefghijklmnopqrstuvwxyz1234567890ab"}

Delete an API key

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

ak_id*integer

ID of the API key to delete.

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/settings/api-keys?ak_id=0"

{  "status": "ok"}

Get audit logs

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

limit?integer

Max number of events to return.

Rangevalue <= 500

Default100

entity_type?string

Filter by entity type (e.g. IDENTITY).

action?string

Filter by action type.

Value in

"CREATE"
"UPDATE"
"DELETE"

search?string

Search in entity title, detail, or actor name.

Lengthlength <= 100

Response Body

`application/json`

curl -X GET "https://example.com/v1/settings/audit-logs"

{  "events": [    {      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",      "entity_type": "string",      "entity_uuid": "ccd0bbaa-1979-4620-9054-a91c61d70e41",      "entity_title": "string",      "action": "CREATE",      "detail": "string",      "severity": "INFO",      "actor": "string",      "actor_name": "string",      "created_at": "2019-08-24T14:15:22Z"    }  ]}

List wallets

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

chain?string

Filter by chain (uppercase, e.g. ETH, BTC, SOL).

Lengthlength <= 20

q?string

Search by address or label. Max 100 characters.

Lengthlength <= 100

page?integer

1-based page number.

Range1 <= value <= 10000

Default1

Response Body

`application/json`

curl -X GET "https://example.com/v1/wallet/"

{  "wallets": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "address": "string",      "chain": "string",      "label": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}

Create a wallet

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

address*string

Wallet address. Allowed characters: letters, digits, and _ - :.

Length10 <= length <= 128

chain*string

Uppercase chain identifier (letters and digits), e.g. ETH, BTC, SOL, TRX, TON, DOGE, BSC, POLYGON.

Lengthlength <= 20

label?string

Optional human-readable label.

Lengthlength <= 100

Response Body

`application/json`

curl -X POST "https://example.com/v1/wallet/" \  -H "Content-Type: application/json" \  -d '{    "address": "stringstri",    "chain": "string"  }'

{  "status": "ok",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"}

Delete a wallet

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

id*string

UUID of the wallet to delete.

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/wallet/?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "status": "ok"}

Update a wallet

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id*string

UUID of the wallet to update.

Formatuuid

label?string

Lengthlength <= 100

chain?string

Uppercase chain identifier.

Lengthlength <= 20

Response Body

`application/json`

curl -X PUT "https://example.com/v1/wallet/" \  -H "Content-Type: application/json" \  -d '{    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"  }'

{  "status": "ok"}

Bulk create wallets

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

wallets*array<>

Items1 <= items <= 500

Response Body

`application/json`

curl -X POST "https://example.com/v1/wallet/bulk" \  -H "Content-Type: application/json" \  -d '{    "wallets": [      {        "address": "stringstri",        "chain": "string"      }    ]  }'

{  "status": "ok",  "created": 0,  "failed": 0}

Get wallet detail

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

id*string

UUID of the wallet.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/wallet/detail?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "address": "string",  "chain": "string",  "label": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "identities": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "type": "PERSON",      "display_name": "string",      "country": "string"    }  ]}

Enrich a wallet

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

id?string

UUID of the wallet to enrich. Provide this or address.

Formatuuid

address?string

Wallet address to enrich, when you do not have its id. Provide this or id.

Lengthlength <= 190

force?boolean

Bypass the cache and force a fresh lookup.

Defaultfalse

Response Body

`application/json`

curl -X GET "https://example.com/v1/wallet/enrich"

{  "status": "string",  "type": "string",  "categories": [    "string"  ],  "labels": [    "string"  ],  "sanctions": {},  "risk_score": 0,  "risk_level": "string",  "enriched_at": "2019-08-24T14:15:22Z",  "cached": true}

Export wallets

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

chain?string

Filter by chain.

q?string

Search by address or label.

format?string

Output format.

Default"json"

Value in

"json"
"csv"

Response Body

`application/json`

curl -X GET "https://example.com/v1/wallet/export"

{  "wallets": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "address": "string",      "chain": "string",      "label": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "total": 0}

Link an identity to a wallet

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

wallet_id*string

Formatuuid

identity_id*string

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/v1/wallet/link-identity" \  -H "Content-Type: application/json" \  -d '{    "wallet_id": "d9a8fbfc-848f-43a2-9168-911ed3a04a48",    "identity_id": "011a42b9-62d7-49eb-8328-c2e454af88a1"  }'

{  "status": "ok"}

Unlink an identity from a wallet

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

wallet_id*string

Formatuuid

identity_id*string

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/wallet/link-identity?wallet_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&identity_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "status": "ok"}

List the recurring jobs of a wallet

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

wallet_id*string

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/wallet/schedules?wallet_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "schedules": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "wallet_id": "d9a8fbfc-848f-43a2-9168-911ed3a04a48",      "kind": "MABU",      "interval_days": 1,      "enabled": true,      "last_run_at": "string",      "next_run_at": "string",      "last_error": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "kinds": [    "MABU"  ],  "min_interval_days": 1,  "max_interval_days": 90}

Create or update a recurring job

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

wallet_id*string

Formatuuid

kind*"MABU"

What recurs.

Value in

"MABU"

interval_days*integer

Days between runs, from one day to three months.

Range1 <= value <= 90

enabled?boolean

Defaulttrue

Response Body

`application/json`

curl -X POST "https://example.com/v1/wallet/schedules" \  -H "Content-Type: application/json" \  -d '{    "wallet_id": "d9a8fbfc-848f-43a2-9168-911ed3a04a48",    "kind": "MABU",    "interval_days": 1  }'

{  "status": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"}

Remove a recurring job

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Send your API key as a bearer token: Authorization: Bearer YOUR_API_KEY.

In: header

Query Parameters

wallet_id*string

Formatuuid

kind*"MABU"

Value in

"MABU"

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/wallet/schedules?wallet_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&kind=MABU"

Empty

API Reference

200application/json

401application/json

200application/json

400application/json

401application/json

200application/json

400application/json

401application/json

200application/json

400application/json

401application/json

200application/json

400application/json

401application/json

200application/json

401application/json

200application/json

400application/json

401application/json

200application/json

400application/json

401application/json

200application/json

400application/json

401application/json

404

200application/json

401application/json

404

200application/json

400application/json

401application/json

404

200application/json

401application/json

200application/json

401application/json

404

200application/json

401application/json

200application/json

400application/json

401application/json

200application/json

401application/json

200application/json

401application/json

200application/json

400application/json

401application/json

200application/json

400application/json

401application/json

403application/json

404application/json

200application/json

400application/json

401application/json

404application/json

200application/json

401application/json

404application/json

200application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`