Seqlense docs

Tags

Colored labels defined per organization and attached to identities, wallets, alerts and order-book clients.

List tags

GET
/v1/tags/

Returns every tag of your organization, sorted by name. Not paginated.

Authorization

ApiKeyAuth
AuthorizationBearer <token>

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

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/tags/"
{  "tags": [    {      "id": "3f2a1b0c-9d8e-4f7a-8b6c-5d4e3f2a1b0c",      "name": "High risk",      "color": "#dc3545",      "created_at": "2026-07-27 10:00:00"    }  ]}

Create a tag

POST
/v1/tags/

Creates a tag. name is trimmed and must be 1 to 50 characters, unique within your organization. color is a #rrggbb string (7 characters starting with #), default #6c757d.

Authorization

ApiKeyAuth
AuthorizationBearer <token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/tags/" \  -H "Content-Type: application/json" \  -d '{    "name": "High risk",    "color": "#dc3545"  }'
{  "id": "3f2a1b0c-9d8e-4f7a-8b6c-5d4e3f2a1b0c"}

Delete a tag

DELETE
/v1/tags/

Permanently deletes a tag and removes it from every entity it was attached to. An unknown id also returns {"ok": true}.

Authorization

ApiKeyAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

id*string

UUID of the tag.

Formatuuid

Response Body

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/tags/?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "ok": true}

Update a tag

PUT
/v1/tags/

Renames and recolors a tag. id and name are required, with the same rules as create. color is replaced on every update: if you omit it, the tag goes back to the default #6c757d, so always send the current color. An unknown id also returns {"ok": true} without changing anything.

Authorization

ApiKeyAuth
AuthorizationBearer <token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/tags/" \  -H "Content-Type: application/json" \  -d '{    "id": "3f2a1b0c-9d8e-4f7a-8b6c-5d4e3f2a1b0c",    "name": "Very high risk",    "color": "#dc3545"  }'
{  "ok": true}

Attach a tag

POST
/v1/tags/attach

Attaches one of your tags to an entity. Attaching a tag that is already there is a no-op that returns ok. The tag must belong to your organization (400 Tag not found otherwise). The entity itself is not looked up, only the shape of its id is checked. entity_type is case-sensitive.

Authorization

ApiKeyAuth
AuthorizationBearer <token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/tags/attach" \  -H "Content-Type: application/json" \  -d '{    "tag_id": "3f2a1b0c-9d8e-4f7a-8b6c-5d4e3f2a1b0c",    "entity_type": "IDENTITY",    "entity_id": "6f9619ff-8b86-4d11-b42d-00c04fc964ff"  }'
{  "ok": true}

Detach a tag

POST
/v1/tags/detach

Removes one of your tags from an entity. Detaching a tag that is not attached also returns ok. The tag must belong to your organization (400 Tag not found otherwise).

Authorization

ApiKeyAuth
AuthorizationBearer <token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/tags/detach" \  -H "Content-Type: application/json" \  -d '{    "tag_id": "3f2a1b0c-9d8e-4f7a-8b6c-5d4e3f2a1b0c",    "entity_type": "OB_CLIENT",    "entity_id": "POSTG0000114"  }'
{  "ok": true}

Get a tag

GET
/v1/tags/detail

Returns one tag of your organization.

Authorization

ApiKeyAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

id*string

UUID of the tag.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/tags/detail?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "color": "#6c757d",  "created_at": "string"}

List the tags on an entity

GET
/v1/tags/entity

Returns the tags attached to one entity, sorted by name. entity_id is a UUID for IDENTITY, WALLET and ALERT, and your own customer id for OB_CLIENT (1 to 190 characters, no control characters).

Authorization

ApiKeyAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

entity_type*string

Kind of entity a tag is attached to. Case-sensitive.

Value in

  • "IDENTITY"
  • "WALLET"
  • "ALERT"
  • "OB_CLIENT"
entity_id*string

Id of the entity, matching entity_type.

Lengthlength <= 190

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/tags/entity?entity_type=IDENTITY&entity_id=string"
{  "tags": [    {      "tag_id": "3f2a1b0c-9d8e-4f7a-8b6c-5d4e3f2a1b0c",      "name": "High risk",      "color": "#dc3545"    }  ]}

Alert History

Append-only event log of every alert at the moment it was raised (ClickHouse-backed).

Notes

Free-text investigation notes on identities, wallets, alerts and order-book clients.