Platform · Published API
API Clients
The outside software that holds a key to this company. Every call it makes runs as a named user here, so nothing it can reach is anything that user could not already reach. The key is shown once when it is issued and never again.
/api/platform/api-clientsPublished as /api/v1/api-clientsOverview
| Package | Platform |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Platform › API Clients on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | platform.api_clients · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/platform/api-clientsList api clients
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"key_prefix": "text",
"key_cipher": "text",
"key_last4": "text",
"scopes": [],
"rate_limit_per_minute": 10,
"allowed_ips": [],
"status": "active",
"expires_at": "2026-10-30T09:00:00Z",
"last_used_at": "2026-10-30T09:00:00Z",
"call_count": "12.0000"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/api-clients?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/api-clients/{id}Read one api client
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"key_prefix": "text",
"key_cipher": "text",
"key_last4": "text",
"scopes": [],
"rate_limit_per_minute": 10,
"allowed_ips": [],
"status": "active",
"expires_at": "2026-10-30T09:00:00Z",
"last_used_at": "2026-10-30T09:00:00Z",
"call_count": "12.0000"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/platform/api-clients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/api-clientsCreate a api client
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Client code |
name | text | Yes | Name |
description | text | No | What it is for |
key_prefix | text | No | Key prefix |
scopes | _text | No | Scopes |
rate_limit_per_minute | integer | No | Rate limit per minute |
allowed_ips | _text | No | Allowed ips |
status | text | No | Status Allowed: active suspended revoked |
expires_at | timestamp with time zone | No | Expires |
protocol | text | No | Protocol — The same key reaches the same data either way; this decides which door it opens. An MCP key presented to the REST API is refused by name rather than confusingly. Allowed: rest mcp both |
run_as | uuid | No | Acts as — Every call this key makes is made as this person. Whatever they may not do, the key may not do — which is what stops an exposure ever widening access rather than narrowing it. Give it a user made for the purpose, with the narrowest role that works. |
software_name | text | No | What software is this — A key outlives the person who asked for it. In three years somebody has to decide whether it is still needed, and this is what they will have to go on. |
contact_email | text | No | Who to ask about it |
homepage_url | text | No | Where it lives |
require_allowlist | boolean | No | Only from allowed addresses — On, and it means it: a key with no addresses listed reaches nothing. Switching it off is a deliberate decision that this key may be presented from anywhere in the world by anybody holding it. |
mcp_instructions | text | No | What to tell an MCP client — Sent as the server instructions when an agent connects. A model that is not told these tools reach a live ledger will treat them as a sandbox. |
Sample body
{
"code": "COD-000001",
"name": "Example",
"description": "text",
"key_prefix": "text",
"scopes": [],
"rate_limit_per_minute": 10
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"key_prefix": "text",
"key_cipher": "text",
"key_last4": "text",
"scopes": [],
"rate_limit_per_minute": 10,
"allowed_ips": [],
"status": "active",
"expires_at": "2026-10-30T09:00:00Z",
"last_used_at": "2026-10-30T09:00:00Z",
"call_count": "12.0000"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/api-clients" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","description":"text","key_prefix":"text","scopes":[],"rate_limit_per_minute":10}'PUT/api/platform/api-clients/{id}Change a api client
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Client code |
name | text | Yes | Name |
description | text | No | What it is for |
key_prefix | text | No | Key prefix |
scopes | _text | No | Scopes |
rate_limit_per_minute | integer | No | Rate limit per minute |
allowed_ips | _text | No | Allowed ips |
status | text | No | Status Allowed: active suspended revoked |
expires_at | timestamp with time zone | No | Expires |
protocol | text | No | Protocol — The same key reaches the same data either way; this decides which door it opens. An MCP key presented to the REST API is refused by name rather than confusingly. Allowed: rest mcp both |
run_as | uuid | No | Acts as — Every call this key makes is made as this person. Whatever they may not do, the key may not do — which is what stops an exposure ever widening access rather than narrowing it. Give it a user made for the purpose, with the narrowest role that works. |
software_name | text | No | What software is this — A key outlives the person who asked for it. In three years somebody has to decide whether it is still needed, and this is what they will have to go on. |
contact_email | text | No | Who to ask about it |
homepage_url | text | No | Where it lives |
require_allowlist | boolean | No | Only from allowed addresses — On, and it means it: a key with no addresses listed reaches nothing. Switching it off is a deliberate decision that this key may be presented from anywhere in the world by anybody holding it. |
mcp_instructions | text | No | What to tell an MCP client — Sent as the server instructions when an agent connects. A model that is not told these tools reach a live ledger will treat them as a sandbox. |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"description": "text",
"key_prefix": "text",
"key_cipher": "text",
"key_last4": "text",
"scopes": [],
"rate_limit_per_minute": 10,
"allowed_ips": [],
"status": "active",
"expires_at": "2026-10-30T09:00:00Z",
"last_used_at": "2026-10-30T09:00:00Z",
"call_count": "12.0000"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/api-clients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/platform/api-clients/{id}Delete a api client
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/platform/api-clients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/api-clients/{id}/rotate-keyRotate key
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/api-clients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/rotate-key" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/api-clients/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/api-clients/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a api client, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
code | text | read, write | Client code |
name | text | read, write | Name |
description | text | read, write | What it is for |
key_prefix | text | read, write | Key prefix |
key_cipher | bytea | read only | Key cipher |
key_last4 | text | read only | Key last4 |
scopes | _text | read, write | Scopes |
rate_limit_per_minute | integer | read, write | Rate limit per minute |
allowed_ips | _text | read, write | Allowed ips |
status | text | read, write | Status Allowed: active suspended revoked |
expires_at | timestamp with time zone | read, write | Expires |
last_used_at | timestamp with time zone | read only | Last used at |
call_count | bigint | read only | Call count |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
protocol | text | read, write | Protocol — The same key reaches the same data either way; this decides which door it opens. An MCP key presented to the REST API is refused by name rather than confusingly. Allowed: rest mcp both |
run_as | uuid | read, write | Acts as — Every call this key makes is made as this person. Whatever they may not do, the key may not do — which is what stops an exposure ever widening access rather than narrowing it. Give it a user made for the purpose, with the narrowest role that works. |
software_name | text | read, write | What software is this — A key outlives the person who asked for it. In three years somebody has to decide whether it is still needed, and this is what they will have to go on. |
contact_email | text | read, write | Who to ask about it |
homepage_url | text | read, write | Where it lives |
require_allowlist | boolean | read, write | Only from allowed addresses — On, and it means it: a key with no addresses listed reaches nothing. Switching it off is a deliberate decision that this key may be presented from anywhere in the world by anybody holding it. |
mcp_instructions | text | read, write | What to tell an MCP client — Sent as the server instructions when an agent connects. A model that is not told these tools reach a live ledger will treat them as a sandbox. |
key_sha256 | text | read only | Key sha256 |
key_issued_at | timestamp with time zone | read only | Key issued at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Platform › API Clients for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.