Skip to Content
Documents

Check whether a document is ready to send

GET
/api/v1/documents/{id}/readiness

Runs the checks POST /api/v1/documents/{id}/send runs before it sends, without sending. ready is true when no BLOCKER remains. Each issue has a code, such as MISSING_EMAIL or NO_EXPIRATION, an English message, and a Swedish userMessage that names the party or field.

When a send fails the same checks, it returns an HTTP 409 Conflict status code with code DOCUMENT_NOT_READY and this list in readiness.

Authorization

headerAuthorizationBearer <token>

API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.

Path Parameters

id*string

The document ID.

Header Parameters

Sajn-Version?string

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Value in"2026-09""2026-10"
Sajn-Workspace?string

ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.

Response Body

200

application/json
  1. response
ready*boolean

True when nothing blocks sending the document; warnings can remain.

issues*array<>

Blockers first, then warnings

Example Request
curl -X GET 'https://app.sajn.se/api/v1/documents/cm4k2x9p10003abcd1234efgh/readiness'
Example Response
{  "ready": false,  "issues": [    {      "code": "MISSING_PHONE",      "severity": "BLOCKER",      "message": "A party invited by SMS has no phone number.",      "userMessage": "Kai Lindqvist saknar telefonnummer för SMS-leverans."    }  ]}

Was this page helpful?