TRANXACT.AI Help

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.

Type REST7 operationsBase path /api/platform/api-clientsPublished as /api/v1/api-clients

Download specification (OpenAPI 3.1) Screen: API Clients

Overview

PackagePlatform
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tableplatform.api_clients · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
codetextYesClient code
nametextYesName
descriptiontextNoWhat it is for
key_prefixtextNoKey prefix
scopes_textNoScopes
rate_limit_per_minuteintegerNoRate limit per minute
allowed_ips_textNoAllowed ips
statustextNoStatus
Allowed: active suspended revoked
expires_attimestamp with time zoneNoExpires
protocoltextNoProtocol — 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_asuuidNoActs 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_nametextNoWhat 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_emailtextNoWho to ask about it
homepage_urltextNoWhere it lives
require_allowlistbooleanNoOnly 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_instructionstextNoWhat 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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesClient code
nametextYesName
descriptiontextNoWhat it is for
key_prefixtextNoKey prefix
scopes_textNoScopes
rate_limit_per_minuteintegerNoRate limit per minute
allowed_ips_textNoAllowed ips
statustextNoStatus
Allowed: active suspended revoked
expires_attimestamp with time zoneNoExpires
protocoltextNoProtocol — 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_asuuidNoActs 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_nametextNoWhat 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_emailtextNoWho to ask about it
homepage_urltextNoWhere it lives
require_allowlistbooleanNoOnly 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_instructionstextNoWhat 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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
codetextread, writeClient code
nametextread, writeName
descriptiontextread, writeWhat it is for
key_prefixtextread, writeKey prefix
key_cipherbytearead onlyKey cipher
key_last4textread onlyKey last4
scopes_textread, writeScopes
rate_limit_per_minuteintegerread, writeRate limit per minute
allowed_ips_textread, writeAllowed ips
statustextread, writeStatus
Allowed: active suspended revoked
expires_attimestamp with time zoneread, writeExpires
last_used_attimestamp with time zoneread onlyLast used at
call_countbigintread onlyCall count
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
protocoltextread, writeProtocol — 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_asuuidread, writeActs 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_nametextread, writeWhat 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_emailtextread, writeWho to ask about it
homepage_urltextread, writeWhere it lives
require_allowlistbooleanread, writeOnly 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_instructionstextread, writeWhat 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_sha256textread onlyKey sha256
key_issued_attimestamp with time zoneread onlyKey issued at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Platform › API Clients for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.