The page for each endpoint must contain the following structure:

Title

Use short, clear titles that fit in one line on the table of contents (ToC). Follow the standard verb pattern:
MethodVerbExample
POSTCreateCreate an Account
GETListList Accounts
GET (by ID)RetrieveRetrieve an Account
PATCHUpdateUpdate an Account
DELETEDelete / DeactivateDelete an Account

Description

Start with a clear and concise explanation of what the endpoint does and when to use it.

Prerequisites

List what is required to use the endpoint (e.g., authentication, permissions, required entities).

Parameters

Include all parameters, grouped by where they appear:
  • Header parameters
  • Path parameters
  • Query parameters

Body (Payload)

Document all fields that appear in the request body.
FieldTypeRequiredDescriptionPossible ValuesDefaultConstraintsExample
namestringYesName of the accountMaxLength: 100"Main Account"
typestringYesAccount typeasset, liability"asset"
assetIdstringYesAssociated asset IDUUID"01fbc1..."

Success responses

Describe what users receive when the request is successful. Include status codes like 200, 201, or 204.

Error Responses

All errors must follow Lerian’s standard error format. Include every possible error the endpoint can return.