WorkspaceDarkLight
Contents

API reference

Documents

The right version, in order. Open the product

GET/v1/documentsOpen ↗

Describes this API: what it takes and what it returns.

POST/v1/documents/registerKey

What the product must give, and before which step

Body
{product, context?}

POST/v1/documents/versionKey

Checked for placeholders and hashed

Body
{doc: {key, version, effectiveFrom, text}}

POST/v1/documents/checkKey

Whether a document may be issued: a credit guide missing an item s 126 requires may not

Body
{doc}

POST/v1/documents/proceedKey

Body
{step, given: [{key, version, sha256, givenOn}], product, context?, library?, onDay?}

POST/v1/documents/assessment-copyKey

Body
{requestedOn, creditDay?}