v1.0.0
OpenAPI 3.1.0

Secure Automation API

Interactive reference for approved Secure Automation operations. Authenticate with your API client ID and client secret. Credentials are held only in browser memory and are not persisted by the console.

Server:

Current Secure Automation API host

Client Libraries

System

​

Service health checks

Get service status

​
Responses
  • application/json
Request Example for get/status
curl /status
{
  "service": "secure-automation-api-v1",
  "status": "running"
}

Check process liveness

​
Responses
  • application/json
Request Example for get/health/live
curl /health/live
{
  "status": "ok"
}

Check application and database readiness

​
Responses
  • application/json
  • application/json
Request Example for get/health/ready
curl /health/ready
{
  "status": "ok"
}

Authentication (Collapsed)

​

Short-lived service authentication

Locations (Collapsed)

​

Location-scoped access and sanitized account inventory

Provisioning (Collapsed)

​

Agency operations performed internally without exposing the agency credential

Provisioning Operations

Payments (Collapsed)

​

Queen Afua Square checkout and reconciliation

Enrollment Inquiries (Collapsed)

​

Non-payment Queen Afua enrollment requests

Enrollment Inquiries Operations

Models