Skip to main content
The Alentra API is a small REST surface. Publish an API-only workflow in the dashboard, then call the API server-to-server with its workflow_id to create and manage session runs. Users complete them on Alentra’s hosted page; results arrive at your webhook.

​
Base URL

​
Authentication

Authenticate every request with your API key as a bearer token. Get your key from the dashboard at alentra.app.
API keys are secrets — use them only from your backend, never in browser or mobile code. A key is scoped to the business that created it.

​
What you call vs. what the page calls

The endpoints documented here are the business API — the ones your server calls. The hosted session page has its own internal transport endpoints (opening, fetching the wallet request, submitting the response); those are not part of the public API and you never call them directly.

​
Content types

JSON for most requests. A workflow containing sign needs files for each run, so its session is created as multipart/form-data — see Create a session.

​
Idempotency

Pass an Idempotency-Key header on POST /v1/sessions to make retries safe: a repeat create with the same key returns the original session instead of a duplicate. The reservation is scoped to your business and does not compare request bodies, so use a new key for every logically different session.

​
Webhook first, GET for reconciliation

Verified results are pushed by webhook, which is why a webhook URL is required before session creation. GET /v1/sessions/{id} returns the same completed results for one-off reconciliation after a missed delivery; it is not a supported polling loop.

Errors

Error format and status codes.