Notes
Free-text investigation notes on identities, wallets, alerts and order-book clients.
Returns every note of your organization on one entity, newest first. Not paginated. 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 Send your API key as a bearer token: Authorization: Bearer sq_YOUR_API_KEY.
In: header
Query Parameters
Kind of entity a note is written on. Case-sensitive.
Value in
- "IDENTITY"
- "WALLET"
- "ALERT"
- "OB_CLIENT"
Id of the entity, matching entity_type.
length <= 190Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/notes/?entity_type=IDENTITY&entity_id=string"{ "notes": [ { "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f", "text": "Same person as the order-book client POSTG0000114.", "created_by": 17, "created_by_name": "Jane Doe", "created_at": "2026-07-27 10:00:00" } ]}Adds a note to an entity. entity_type, entity_id and text are trimmed; text must then be 1 to 4000 characters (counted in UTF-8 bytes). The entity itself is not looked up. A "Note added" event is written to the activity feed of that entity type. Notes written with an API key have created_by 0.
Authorization
ApiKeyAuth 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/notes/" \ -H "Content-Type: application/json" \ -d '{ "entity_type": "IDENTITY", "entity_id": "6f9619ff-8b86-4d11-b42d-00c04fc964ff", "text": "Same person as the order-book client POSTG0000114." }'{ "id": "1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f"}Permanently deletes one note of your organization. Returns 404 when no note with that id exists in your organization.
Authorization
ApiKeyAuth Send your API key as a bearer token: Authorization: Bearer sq_YOUR_API_KEY.
In: header
Query Parameters
UUID of the note.
uuidResponse Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/v1/notes/?id=497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "ok": true}