Getting started

aledgent is reached through one HTTP service, ingress. Every route needs a bearer credential, except the two under /v1/auth, which check what their body carries. Amounts are decimal-integer strings of minor units, identifiers are did:aledgent: strings, and times are milliseconds since the Unix epoch.

Get a credential. A principal presents a bearer token: an API key registered for its identity, or a session from a passkey sign-in (POST /v1/auth/challenge, then POST /v1/auth/passkey).

Send a transfer, with a client key of your own:

curl -X POST "$INGRESS/v1/transfers" \
  -H "Authorization: Bearer $TOKEN" \
  -H "client-key: payout-2026-10-13-0042" \
  -H "content-type: application/json" \
  -d '{"legs":[{"from":"did:aledgent:acct:…","to":"did:aledgent:acct:…","asset":"TSTA","amount":"125000"}],
       "reference":{"invoice":"inv-8812"}}'

Read the acknowledgement. By default a transfer is acknowledged at Received, with 202:
```
{
  "operation_reference": "did:aledgent:op:…",
  "state": "Received",
  "class": "open-non-refunding",
  "terminal": false,
  "client_key": "payout-2026-10-13-0042",
  "client_key_derived": false,
  "reference": { "invoice": "inv-8812" }
}
```
This is an acknowledgement, not an outcome: nothing is decided yet and no balance has changed. reference is your own pass-through data, echoed back; it is not the operation reference.
Learn the decision by notification, or by reading the operation: GET /v1/operations/{reference}. See The operation lifecycle for what each state means and what you are expected to do in it.

The operation lifecycle: the states a caller sees, client keys, and refusals.
API reference: every route ingress serves, generated from its OpenAPI document.

Getting started

Next