API product catalogInstitutional Reporting, Auditing & Compliance

List document templates and generation history

Institutional Reporting, Auditing & Compliance

GET

/documents

Sandbox availablelistPartnerDocuments

Returns the partner document catalogue and the 20 most recent generated-document evidence records. Sandbox entries include downloadable deterministic PDF fixtures.

Parameters

This endpoint has no path or query parameters.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

catalogobject[]Required

catalog[].idaccount-statement | compliance-summary | operations-summaryRequired

catalog[].titlestringRequired

catalog[].descriptionstringRequired

catalog[].requiresUserbooleanRequired

recentobject[]Required

recent[].idstring

recent[].typestring

recent[].titlestring

recent[].userIdstring | null

recent[].createdBystring | null

recent[].createdAtstring | null

Response codes

200Document catalogue and recent generation history.

Sandbox playground

Read-only sandbox request

Sandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/documents

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "catalog",
    "recent"
  ],
  "properties": {
    "catalog": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "title",
          "description",
          "requiresUser"
        ],
        "properties": {
          "id": {
            "type": "string",
            "enum": [
              "account-statement",
              "compliance-summary",
              "operations-summary"
            ]
          },
          "title": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "requiresUser": {
            "type": "boolean"
          }
        }
      }
    },
    "recent": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "userId": {
            "type": [
              "string",
              "null"
            ]
          },
          "createdBy": {
            "type": [
              "string",
              "null"
            ]
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        }
      }
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/documents' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

GET /commercial

POST /documents