DevelopersIn progress

The API is coming soon.

Every Aegis service already owns an OpenAPI contract, and the consoles are generated from them. The public API for integrations is being opened up next: create runs, follow them, receive signed decisions, and issue and verify credentials over the open protocols.

Ask for early access The standards endpoints

The shape

Plain HTTP, typed throughout.

Create a runrequest

POST /v1/runs HTTP/1.1
Host: api.aegis.example
Authorization: Bearer <client-credentials token>
Idempotency-Key: <unique per attempt>
Content-Type: application/json

{
  "flow": "<flow id>",
  "applicant": { "invite": { "channel": "email", "to": "<address>" } }
}

Createdresponse

HTTP/1.1 201 Created
Content-Type: application/json

{
  "run": "<run id>",
  "flow_version": "<pinned version>",
  "state": "awaiting_applicant",
  "links": { "timeline": "/v1/runs/<run id>/timeline" }
}

A typed errorRFC 9457

HTTP/1.1 409 Conflict
Content-Type: application/problem+json

{
  "type": "https://aegis.protoworks.dev/problems/run-already-decided",
  "title": "The run has already been decided",
  "status": 409,
  "detail": "A decided run cannot be cancelled."
}

A decision, deliveredStandard Webhooks

POST <your endpoint>
webhook-id: <message id>
webhook-timestamp: <unix seconds>
webhook-signature: v1,<signature over id.timestamp.body>

{ "type": "run.decided", "run": "<run id>", "decision": "approved" }

What to expect

Built the way the platform is built.

REST under /v1: JSON over HTTPS, versioned in the path, with an OpenAPI 3.1 document for every service and generated clients.; Built
Typed errors: Every error is an RFC 9457 problem document with a stable type you can branch on.; Built
Idempotent writes: Retries are safe: every mutation takes an idempotency key.; Built
Signed webhooks: Deliveries signed to Standard Webhooks, retried on transient failure and dead-lettered when they cannot land. Secrets are shown once and stored sealed.; Built
Client credentials: Separate test and live credentials; a live credential needs a second administrator’s approval, and its secret is shown once and rotatable.; Planned
Never a person: An integration credential can never act as a person: it cannot review, reveal or approve.; Planned
Open protocols: Issuer metadata, pushed authorisation, token, nonce, credential and notification endpoints for OpenID4VCI; status lists; OpenID4VP request and response endpoints.; Built
An embeddable journey: The verification surface as a package for your own site.; In progress

Ask for early access