API product catalogDeveloper Platform, Sandbox & Key Management

Update certification evidence

Developer Platform, Sandbox & Key Management

PATCH

/certification

Production onlyupdateCertification

Updates partner-owned certification checks with status, evidence URL, and notes. MyStocks-owned approval checks cannot be marked passed or waived by partners.

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

checksobjectRequired

Response fields

partnerIdstring

statusin_progress | go_live_requested | approved

checksobject

checklistobject[]

checklist[].idstring

checklist[].titlestring

checklist[].descriptionstring

checklist[].requiredboolean

checklist[].ownerpartner | mystocks

progressobject

progress.requiredinteger

progress.completedinteger

progress.percentinteger

goLiveRequestedAtstring | null

approvedAtstring | null

messagestring

Response codes

200Updated certification progress.

Request reference

Production only

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

https://mystocks.africa/api/v1/partner/certification

Open in API Tester API Reference

Response schema

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "partnerId": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "in_progress",
            "go_live_requested",
            "approved"
          ]
        },
        "checks": {
          "type": "object",
          "additionalProperties": {
            "type": "object",
            "properties": {
              "status": {
                "$ref": "#/components/schemas/CertificationStatus"
              },
              "evidenceUrl": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "uri"
              },
              "notes": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "updatedAt": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time"
              },
              "updatedBy": {
                "type": [
                  "string",
                  "null"
                ]
              }
            }
          }
        },
        "checklist": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "title": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "required": {
                "type": "boolean"
              },
              "owner": {
                "type": "string",
                "enum": [
                  "partner",
                  "mystocks"
                ]
              }
            }
          }
        },
        "progress": {
          "type": "object",
          "properties": {
            "required": {
              "type": "integer"
            },
            "completed": {
              "type": "integer"
            },
            "percent": {
              "type": "integer"
            }
          }
        },
        "goLiveRequestedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "approvedAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "message": {
          "type": "string"
        }
      }
    }
  ]
}

curl -X PATCH 'https://mystocks.africa/api/v1/partner/certification' \
  -H "Authorization: Bearer $MYSTOCKS_API_KEY" \
  -H "Idempotency-Key: YOUR_UNIQUE_REQUEST_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "checks": {
    "webhook_retry": {
      "status": "passed",
      "evidenceUrl": "https://trust.partner.example/mystocks/webhook-retry.pdf",
      "notes": "Replay and retry tests passed in sandbox."
    }
  }
}'

GET /certification

POST /certification