Build against the actual Azums API.
Identity and commercial payments use the existing Rust backend and PostgreSQL. Wallets, stablecoin checkout, payouts and other financial products remain unavailable until genuine providers are connected.
Download current OpenAPIAuthentication and payment authority
Browser sessions require verified email, MFA, tenant permissions and secure host-only cookies. Mutations require the exact application Origin and X-Azums-CSRF: 1. Production and staging have separate data and credentials.
Plan purchases require an owner, admin or finance MFA session. Supply only the approved plan identifier, catalogue version and original Idempotency-Key. Paystack redirects and webhook notifications never grant access without server verification.
Money is represented as exact integer strings. Plan prices use currency minor units, with 100 minor units per major unit for the supported currencies. Tokens, when connected, use their own asset decimals. Never convert financial values through floating point.
Preserve the original request after an uncertain result. No automatic recurring charges are enabled in this integration.
29 operations
POST /v1/auth/register
{
"summary": "Create local-fixture account and limited pre-MFA session",
"operationId": "post_v1_auth_register",
"responses": {
"201": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [],
"parameters": [
{
"name": "X-Azums-CSRF",
"in": "header",
"description": "Required for browser/password-session mutations; value 1. Bearer-key clients do not require it.",
"schema": {
"type": "string",
"enum": [
"1"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Register"
}
}
}
}
}POST /v1/auth/login
{
"summary": "Password authentication; MFA still required",
"operationId": "post_v1_auth_login",
"responses": {
"200": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [],
"parameters": [
{
"name": "X-Azums-CSRF",
"in": "header",
"description": "Required for browser/password-session mutations; value 1. Bearer-key clients do not require it.",
"schema": {
"type": "string",
"enum": [
"1"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Login"
}
}
}
}
}POST /v1/auth/logout
{
"summary": "Immediately revoke current session",
"operationId": "post_v1_auth_logout",
"responses": {
"200": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"SandboxSession": []
}
],
"parameters": [
{
"name": "X-Azums-CSRF",
"in": "header",
"description": "Required for browser/password-session mutations; value 1. Bearer-key clients do not require it.",
"schema": {
"type": "string",
"enum": [
"1"
]
}
}
]
}POST /v1/auth/verify-email
{
"summary": "Consume local verification token; does not certify real mail delivery",
"operationId": "post_v1_auth_verify-email",
"responses": {
"200": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"SandboxSession": []
}
],
"parameters": [
{
"name": "X-Azums-CSRF",
"in": "header",
"description": "Required for browser/password-session mutations; value 1. Bearer-key clients do not require it.",
"schema": {
"type": "string",
"enum": [
"1"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Token"
}
}
}
}
}POST /v1/auth/resend-verification
{
"summary": "Replace local verification challenge",
"operationId": "post_v1_auth_resend-verification",
"responses": {
"200": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"SandboxSession": []
}
],
"parameters": [
{
"name": "X-Azums-CSRF",
"in": "header",
"description": "Required for browser/password-session mutations; value 1. Bearer-key clients do not require it.",
"schema": {
"type": "string",
"enum": [
"1"
]
}
}
]
}POST /v1/auth/mfa/enroll
{
"summary": "Return a new pending authenticator seed once",
"operationId": "post_v1_auth_mfa_enroll",
"responses": {
"200": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"SandboxSession": []
}
],
"parameters": [
{
"name": "X-Azums-CSRF",
"in": "header",
"description": "Required for browser/password-session mutations; value 1. Bearer-key clients do not require it.",
"schema": {
"type": "string",
"enum": [
"1"
]
}
}
]
}POST /v1/auth/mfa/confirm
{
"summary": "Confirm enrollment and return one-time recovery codes",
"operationId": "post_v1_auth_mfa_confirm",
"responses": {
"200": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"SandboxSession": []
}
],
"parameters": [
{
"name": "X-Azums-CSRF",
"in": "header",
"description": "Required for browser/password-session mutations; value 1. Bearer-key clients do not require it.",
"schema": {
"type": "string",
"enum": [
"1"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnrollmentConfirm"
}
}
}
}
}POST /v1/auth/mfa/verify
{
"summary": "Verify a fresh OTP or consume one recovery code and rotate the session",
"operationId": "post_v1_auth_mfa_verify",
"responses": {
"200": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"SandboxSession": []
}
],
"parameters": [
{
"name": "X-Azums-CSRF",
"in": "header",
"description": "Required for browser/password-session mutations; value 1. Bearer-key clients do not require it.",
"schema": {
"type": "string",
"enum": [
"1"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MfaCode"
}
}
}
}
}GET /v1/auth/me
{
"summary": "Own account state; organizations hidden until MFA",
"operationId": "get_v1_auth_me",
"responses": {
"200": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"SandboxSession": []
}
],
"parameters": []
}GET /v1/organizations
{
"summary": "List only active memberships after verified email/MFA",
"operationId": "get_v1_organizations",
"responses": {
"200": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"SandboxSession": []
}
],
"parameters": []
}POST /v1/organizations
{
"summary": "Create sandbox organization with pending legal status",
"operationId": "post_v1_organizations",
"responses": {
"201": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"SandboxSession": []
}
],
"parameters": [
{
"name": "X-Azums-CSRF",
"in": "header",
"description": "Required for browser/password-session mutations; value 1. Bearer-key clients do not require it.",
"schema": {
"type": "string",
"enum": [
"1"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationCreate"
}
}
}
}
}POST /v1/invitations/accept
{
"summary": "Accept only the verified recipient?s unexpired invitation",
"operationId": "post_v1_invitations_accept",
"responses": {
"200": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"SandboxSession": []
}
],
"parameters": [
{
"name": "X-Azums-CSRF",
"in": "header",
"description": "Required for browser/password-session mutations; value 1. Bearer-key clients do not require it.",
"schema": {
"type": "string",
"enum": [
"1"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Token"
}
}
}
}
}GET /v1/organizations/{org}
{
"summary": "Read authorized organization metadata",
"operationId": "get_v1_organizations_org",
"responses": {
"200": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"sandboxKey": []
},
{
"SandboxSession": []
}
],
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /v1/organizations/{org}/members
{
"summary": "List own organization members",
"operationId": "get_v1_organizations_org_members",
"responses": {
"200": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"sandboxKey": []
},
{
"SandboxSession": []
}
],
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PATCH /v1/organizations/{org}/members/{member}
{
"summary": "Change a non-owner membership; owner/admin policy applies",
"operationId": "patch_v1_organizations_org_members_member",
"responses": {
"200": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"SandboxSession": []
}
],
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "member",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-Azums-CSRF",
"in": "header",
"description": "Required for browser/password-session mutations; value 1. Bearer-key clients do not require it.",
"schema": {
"type": "string",
"enum": [
"1"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberChange"
}
}
}
}
}POST /v1/organizations/{org}/invitations
{
"summary": "Create recipient-bound local-fixture invitation",
"operationId": "post_v1_organizations_org_invitations",
"responses": {
"201": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"SandboxSession": []
}
],
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-Azums-CSRF",
"in": "header",
"description": "Required for browser/password-session mutations; value 1. Bearer-key clients do not require it.",
"schema": {
"type": "string",
"enum": [
"1"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvitationCreate"
}
}
}
}
}GET /v1/organizations/{org}/keys
{
"summary": "List permitted key metadata, never full secrets",
"operationId": "get_v1_organizations_org_keys",
"responses": {
"200": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"SandboxSession": []
}
],
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /v1/organizations/{org}/keys
{
"summary": "Issue a sandbox key no broader than current role",
"operationId": "post_v1_organizations_org_keys",
"responses": {
"201": {
"description": "One-time credential",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OneTimeKey"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"SandboxSession": []
}
],
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-Azums-CSRF",
"in": "header",
"description": "Required for browser/password-session mutations; value 1. Bearer-key clients do not require it.",
"schema": {
"type": "string",
"enum": [
"1"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KeyCreate"
}
}
}
}
}DELETE /v1/organizations/{org}/keys/{key}
{
"summary": "Revoke immediately; repeated revocation is idempotent",
"operationId": "delete_v1_organizations_org_keys_key",
"responses": {
"200": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"SandboxSession": []
}
],
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-Azums-CSRF",
"in": "header",
"description": "Required for browser/password-session mutations; value 1. Bearer-key clients do not require it.",
"schema": {
"type": "string",
"enum": [
"1"
]
}
}
]
}POST /v1/organizations/{org}/keys/{key}/rotate
{
"summary": "Atomically replace an unexpired key, preserving expiry",
"operationId": "post_v1_organizations_org_keys_key_rotate",
"responses": {
"201": {
"description": "One-time credential",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OneTimeKey"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"SandboxSession": []
}
],
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-Azums-CSRF",
"in": "header",
"description": "Required for browser/password-session mutations; value 1. Bearer-key clients do not require it.",
"schema": {
"type": "string",
"enum": [
"1"
]
}
}
]
}GET /v1/organizations/{org}/audit
{
"summary": "Latest 100 tenant audit events",
"operationId": "get_v1_organizations_org_audit",
"responses": {
"200": {
"description": "Successful authorized operation",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Envelope"
}
}
}
},
"default": {
"description": "Bounded problem response. 401 invalid/expired credential; 403 missing MFA, role/scope, production denial or CSRF; 404 foreign/missing object; 409 conflict; 429 rate limited; 503 persistence unavailable.",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Cache-Control": {
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"security": [
{
"sessionCookie": []
},
{
"sandboxKey": []
},
{
"SandboxSession": []
}
],
"parameters": [
{
"name": "org",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /v1/organizations/{org}/billing/plans
{
"operationId": "get_v1_organizations_org_billing_plans",
"summary": "Real Azums commercial plans",
"security": [
{
"BrowserSession": []
}
],
"x-permissions": [
"organization:read",
"billing:read"
],
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Authoritative server response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"configured": {
"type": "boolean"
},
"catalog_version": {
"type": "string"
},
"plans": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"currency": {
"type": "string",
"enum": [
"NGN",
"USD",
"GHS",
"ZAR",
"KES"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9][0-9]*$",
"description": "Exact positive unsigned 64-bit minor units; never JSON floating point"
},
"interval": {
"type": "string",
"enum": [
"monthly",
"annually"
]
},
"renewal": {
"const": "manual"
},
"features": {
"type": "array",
"items": {
"type": "string",
"enum": [
"api_keys",
"team_management"
]
}
}
},
"required": [
"id",
"name",
"currency",
"amount_minor",
"interval",
"renewal",
"features"
]
}
},
"environment": {
"enum": [
"staging",
"production"
]
},
"reason": {
"type": "string"
}
},
"required": [
"configured",
"plans",
"environment"
]
}
}
}
},
"401": {
"description": "Authentication required"
},
"403": {
"description": "Tenant, MFA or permission denied"
},
"409": {
"description": "Original request or provider evidence conflict"
},
"503": {
"description": "Genuine provider not configured or outcome unresolved"
}
}
}GET /v1/organizations/{org}/billing/status
{
"operationId": "get_v1_organizations_org_billing_status",
"summary": "Real Azums commercial status",
"security": [
{
"BrowserSession": []
}
],
"x-permissions": [
"organization:read",
"billing:read"
],
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Authoritative server response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"environment": {
"enum": [
"staging",
"production"
]
},
"grants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"plan": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"currency": {
"type": "string",
"enum": [
"NGN",
"USD",
"GHS",
"ZAR",
"KES"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9][0-9]*$",
"description": "Exact positive unsigned 64-bit minor units; never JSON floating point"
},
"interval": {
"type": "string",
"enum": [
"monthly",
"annually"
]
},
"renewal": {
"const": "manual"
},
"features": {
"type": "array",
"items": {
"type": "string",
"enum": [
"api_keys",
"team_management"
]
}
}
},
"required": [
"id",
"name",
"currency",
"amount_minor",
"interval",
"renewal",
"features"
]
},
"valid_from": {
"type": "string"
},
"valid_until": {
"type": "string"
}
},
"required": [
"id",
"plan",
"valid_from",
"valid_until"
]
}
}
},
"required": [
"environment",
"grants"
]
}
}
}
},
"401": {
"description": "Authentication required"
},
"403": {
"description": "Tenant, MFA or permission denied"
},
"409": {
"description": "Original request or provider evidence conflict"
},
"503": {
"description": "Genuine provider not configured or outcome unresolved"
}
}
}POST /v1/organizations/{org}/billing/checkout
{
"operationId": "post_v1_organizations_org_billing_checkout",
"summary": "Real Azums commercial checkout",
"security": [
{
"BrowserSession": []
}
],
"x-permissions": [
"organization:read",
"billing:read",
"billing:write",
"human_mfa"
],
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{8,80}$"
}
}
],
"responses": {
"200": {
"description": "Authoritative server response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"plan": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"currency": {
"type": "string",
"enum": [
"NGN",
"USD",
"GHS",
"ZAR",
"KES"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9][0-9]*$",
"description": "Exact positive unsigned 64-bit minor units; never JSON floating point"
},
"interval": {
"type": "string",
"enum": [
"monthly",
"annually"
]
},
"renewal": {
"const": "manual"
},
"features": {
"type": "array",
"items": {
"type": "string",
"enum": [
"api_keys",
"team_management"
]
}
}
},
"required": [
"id",
"name",
"currency",
"amount_minor",
"interval",
"renewal",
"features"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9][0-9]*$",
"description": "Exact positive unsigned 64-bit minor units; never JSON floating point"
},
"currency": {
"type": "string"
},
"state": {
"enum": [
"initializing",
"ready",
"initialization_unknown",
"pending",
"paid",
"failed",
"reversed"
]
},
"reference": {
"type": "string"
},
"authorization_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"plan",
"amount_minor",
"currency",
"state",
"reference",
"authorization_url",
"created_at"
]
}
}
}
},
"401": {
"description": "Authentication required"
},
"403": {
"description": "Tenant, MFA or permission denied"
},
"409": {
"description": "Original request or provider evidence conflict"
},
"503": {
"description": "Genuine provider not configured or outcome unresolved"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"plan_id": {
"type": "string"
},
"catalog_version": {
"type": "string"
}
},
"required": [
"plan_id",
"catalog_version"
],
"additionalProperties": false
}
}
}
}
}GET /v1/organizations/{org}/billing/checkouts
{
"operationId": "get_v1_organizations_org_billing_checkouts",
"summary": "Real Azums commercial checkouts",
"security": [
{
"BrowserSession": []
}
],
"x-permissions": [
"organization:read",
"billing:read"
],
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Authoritative server response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"checkouts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"plan": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"currency": {
"type": "string",
"enum": [
"NGN",
"USD",
"GHS",
"ZAR",
"KES"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9][0-9]*$",
"description": "Exact positive unsigned 64-bit minor units; never JSON floating point"
},
"interval": {
"type": "string",
"enum": [
"monthly",
"annually"
]
},
"renewal": {
"const": "manual"
},
"features": {
"type": "array",
"items": {
"type": "string",
"enum": [
"api_keys",
"team_management"
]
}
}
},
"required": [
"id",
"name",
"currency",
"amount_minor",
"interval",
"renewal",
"features"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9][0-9]*$",
"description": "Exact positive unsigned 64-bit minor units; never JSON floating point"
},
"currency": {
"type": "string"
},
"state": {
"enum": [
"initializing",
"ready",
"initialization_unknown",
"pending",
"paid",
"failed",
"reversed"
]
},
"reference": {
"type": "string"
},
"authorization_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"plan",
"amount_minor",
"currency",
"state",
"reference",
"authorization_url",
"created_at"
]
}
}
},
"required": [
"checkouts"
]
}
}
}
},
"401": {
"description": "Authentication required"
},
"403": {
"description": "Tenant, MFA or permission denied"
},
"409": {
"description": "Original request or provider evidence conflict"
},
"503": {
"description": "Genuine provider not configured or outcome unresolved"
}
}
}GET /v1/organizations/{org}/billing/checkouts/{id}
{
"operationId": "get_v1_organizations_org_billing_checkouts_id",
"summary": "Real Azums commercial checkouts/{id}",
"security": [
{
"BrowserSession": []
}
],
"x-permissions": [
"organization:read",
"billing:read"
],
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Authoritative server response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"plan": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"currency": {
"type": "string",
"enum": [
"NGN",
"USD",
"GHS",
"ZAR",
"KES"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9][0-9]*$",
"description": "Exact positive unsigned 64-bit minor units; never JSON floating point"
},
"interval": {
"type": "string",
"enum": [
"monthly",
"annually"
]
},
"renewal": {
"const": "manual"
},
"features": {
"type": "array",
"items": {
"type": "string",
"enum": [
"api_keys",
"team_management"
]
}
}
},
"required": [
"id",
"name",
"currency",
"amount_minor",
"interval",
"renewal",
"features"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9][0-9]*$",
"description": "Exact positive unsigned 64-bit minor units; never JSON floating point"
},
"currency": {
"type": "string"
},
"state": {
"enum": [
"initializing",
"ready",
"initialization_unknown",
"pending",
"paid",
"failed",
"reversed"
]
},
"reference": {
"type": "string"
},
"authorization_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"plan",
"amount_minor",
"currency",
"state",
"reference",
"authorization_url",
"created_at"
]
}
}
}
},
"401": {
"description": "Authentication required"
},
"403": {
"description": "Tenant, MFA or permission denied"
},
"409": {
"description": "Original request or provider evidence conflict"
},
"503": {
"description": "Genuine provider not configured or outcome unresolved"
}
}
}POST /v1/organizations/{org}/billing/checkouts/{id}/verify
{
"operationId": "post_v1_organizations_org_billing_checkouts_id_verify",
"summary": "Real Azums commercial checkouts/{id}/verify",
"security": [
{
"BrowserSession": []
}
],
"x-permissions": [
"organization:read",
"billing:read",
"billing:write",
"human_mfa"
],
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Authoritative server response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"plan": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"currency": {
"type": "string",
"enum": [
"NGN",
"USD",
"GHS",
"ZAR",
"KES"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9][0-9]*$",
"description": "Exact positive unsigned 64-bit minor units; never JSON floating point"
},
"interval": {
"type": "string",
"enum": [
"monthly",
"annually"
]
},
"renewal": {
"const": "manual"
},
"features": {
"type": "array",
"items": {
"type": "string",
"enum": [
"api_keys",
"team_management"
]
}
}
},
"required": [
"id",
"name",
"currency",
"amount_minor",
"interval",
"renewal",
"features"
]
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9][0-9]*$",
"description": "Exact positive unsigned 64-bit minor units; never JSON floating point"
},
"currency": {
"type": "string"
},
"state": {
"enum": [
"initializing",
"ready",
"initialization_unknown",
"pending",
"paid",
"failed",
"reversed"
]
},
"reference": {
"type": "string"
},
"authorization_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"plan",
"amount_minor",
"currency",
"state",
"reference",
"authorization_url",
"created_at"
]
}
}
}
},
"401": {
"description": "Authentication required"
},
"403": {
"description": "Tenant, MFA or permission denied"
},
"409": {
"description": "Original request or provider evidence conflict"
},
"503": {
"description": "Genuine provider not configured or outcome unresolved"
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}
}
}
}
}GET /v1/organizations/{org}/billing/receipts
{
"operationId": "get_v1_organizations_org_billing_receipts",
"summary": "Real Azums commercial receipts",
"security": [
{
"BrowserSession": []
}
],
"x-permissions": [
"organization:read",
"billing:read"
],
"parameters": [
{
"in": "path",
"name": "org",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Authoritative server response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"receipts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"checkout_id": {
"type": "string",
"format": "uuid"
},
"provider_transaction_id": {
"type": "string"
},
"provider_reference": {
"type": "string"
},
"amount_minor": {
"type": "string",
"pattern": "^[1-9][0-9]*$",
"description": "Exact positive unsigned 64-bit minor units; never JSON floating point"
},
"currency": {
"type": "string"
},
"fees_minor": {
"type": [
"string",
"null"
]
},
"verified_at": {
"type": "string"
},
"reversed": {
"type": "boolean"
}
},
"required": [
"id",
"checkout_id",
"provider_transaction_id",
"provider_reference",
"amount_minor",
"currency",
"fees_minor",
"verified_at",
"reversed"
]
}
}
},
"required": [
"receipts"
]
}
}
}
},
"401": {
"description": "Authentication required"
},
"403": {
"description": "Tenant, MFA or permission denied"
},
"409": {
"description": "Original request or provider evidence conflict"
},
"503": {
"description": "Genuine provider not configured or outcome unresolved"
}
}
}POST /v1/billing/paystack/webhook
{
"operationId": "post_v1_billing_paystack_webhook",
"summary": "Provider only: authenticate exact raw bytes, persist inbox, then reconcile",
"security": [],
"x-authentication": "Paystack timestamped HMAC-SHA512 signing secret; legacy only without configured modern secret",
"responses": {
"200": {
"description": "Durably accepted"
},
"401": {
"description": "Invalid signature"
},
"503": {
"description": "Not accepted; provider should retry"
}
}
}