API product catalogInstitutional Reporting, Auditing & Compliance

Record a reconciliation sign-off

Institutional Reporting, Auditing & Compliance

POST

/reconciliation-signoffs

Production onlycreateReconciliationSignoff

Records partner evidence that a dated reconciliation period was reviewed.

Parameters

This endpoint has no path or query parameters.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Idempotency-KeystringheaderRequired

Unique string that makes write calls safe to retry on network failure. Required for money movement, trading, KYC, subscriptions, and webhook creation. Deduplicated for 24 hours -- duplicate keys return the cached response. HTTP 409 if a concurrent request with the same key is still in progress.

Example: dep_user42_1743152580

Request body

fromstringRequired

tostringRequired

statusstring

exceptionCountinteger

reportGeneratedAtstring | null

notesstringRequired

Response fields

messagestringRequired

signoffobjectRequired

signoff.idstringRequired

signoff.partnerIdstringRequired

signoff.fromstringRequired

signoff.tostringRequired

signoff.statusstringRequired

signoff.exceptionCountintegerRequired

signoff.reportGeneratedAtstring | null

signoff.notesstringRequired

signoff.createdBystringRequired

signoff.createdAtstringRequired

Response codes

201Reconciliation sign-off recorded.

400Dates or notes failed validation.

Request reference

Production only

Use the API Tester for write requests, including request bodies and idempotency keys.

https://mystocks.africa/api/v1/partner/reconciliation-signoffs

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "required": [
    "message",
    "signoff"
  ],
  "properties": {
    "message": {
      "type": "string"
    },
    "signoff": {
      "type": "object",
      "required": [
        "id",
        "partnerId",
        "from",
        "to",
        "status",
        "exceptionCount",
        "notes",
        "createdBy",
        "createdAt"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "partnerId": {
          "type": "string"
        },
        "from": {
          "type": "string",
          "format": "date"
        },
        "to": {
          "type": "string",
          "format": "date"
        },
        "status": {
          "type": "string",
          "maxLength": 30
        },
        "exceptionCount": {
          "type": "integer",
          "minimum": 0
        },
        "reportGeneratedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "notes": {
          "type": "string",
          "maxLength": 4000
        },
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "type": "string",
          "format": "date-time"
        }
      }
    }
  }
}

curl -X POST 'https://mystocks.africa/api/v1/partner/reconciliation-signoffs' \
  -H "Authorization: Bearer $MYSTOCKS_API_KEY" \
  -H "Idempotency-Key: YOUR_UNIQUE_REQUEST_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "from": "2026-07-01",
  "to": "2026-07-23",
  "status": "BALANCED",
  "exceptionCount": 0,
  "notes": "Reviewed against the custody and cash ledgers."
}'

GET /reconciliation-signoffs

GET /report/aum