Reference
No authentication. These back the marketing site, the status page and the Trust centre, and are open to anyone. Generated from the OpenAPI document; 6 operations.
Browser calls are allowed only from the RemoteRegister sites (exact origin match). Server-to-server calls are not subject to CORS. The two form endpoints are for the RemoteRegister website; they apply a honeypot, per-IP limits and (when enabled) Cloudflare Turnstile, and are not a bulk-submission API.
Record verification (GET /api/v1/verify/:hash) is public too; it is used by
rr-verify.medq.co.zw. It is not yet described in the OpenAPI
document. A well-formed but unknown hash returns 404 NOT_FOUND; there is no
"probably valid" answer.
/api/v1/public/platform # Trust-centre facts
getPublicPlatformFacts Returns jurisdiction, governing law, hosting location, cross-border transfer basis, compliance frameworks and public surface URLs. No personal information.
| Status | Meaning | Schema |
|---|---|---|
200 | Platform facts | MobileEnvelope |
default | Error response | MobileError |
/api/v1/public/leads # Submit a marketing enquiry
submitPublicLead Creates a marketing lead with POPIA s11/s18 consent metadata. Honeypot field companyWebsite is used for bot detection. Rate limited to 5 requests per 10 minutes per IP.
PublicLeadRequest (application/json)| Field | Type | Details |
|---|---|---|
name required | string | max length 120 |
email required | string (email) | |
organisation | string | max length 160 |
role | string | max length 120 |
message required | string | max length 4000 |
consent required | const true | |
companyWebsite required | string | Honeypot; must be empty. |
sourcePage | string |
| Status | Meaning | Schema |
|---|---|---|
201 | Lead accepted | MobileEnvelope |
default | Error response | MobileError |
/api/v1/public/newsletter/subscribe # Start newsletter double opt-in
subscribeNewsletter Creates a PENDING subscriber and dispatches a confirmation email. POPIA s69 requires opt-in consent. Rate limited to 3 requests per 10 minutes per IP.
NewsletterSubscribeRequest (application/json)| Field | Type | Details |
|---|---|---|
email required | string (email) | |
consent required | const true | |
companyWebsite required | string | Honeypot; must be empty. |
sourcePage | string |
| Status | Meaning | Schema |
|---|---|---|
202 | Subscription pending confirmation | MobileEnvelope |
default | Error response | MobileError |
/api/v1/public/newsletter/confirm # Confirm a newsletter subscription
confirmNewsletter Consumes a single-use, hashed confirmation token.
| Name | In | Type | Description |
|---|---|---|---|
token required | query | string |
| Status | Meaning | Schema |
|---|---|---|
200 | Subscription confirmed | MobileEnvelope |
default | Error response | MobileError |
/api/v1/public/newsletter/unsubscribe # Unsubscribe from the newsletter
unsubscribeNewsletter Consumes a single-use, hashed unsubscribe token.
| Name | In | Type | Description |
|---|---|---|---|
token required | query | string |
| Status | Meaning | Schema |
|---|---|---|
200 | Subscription removed | MobileEnvelope |
default | Error response | MobileError |
/api/v1/public/status # Operational status feed
getPublicStatus Aggregated persistence, integration and platform status for the status page.
| Status | Meaning | Schema |
|---|---|---|
200 | Status feed | MobileEnvelope |
default | Error response | MobileError |