ONonlink
Partner API

Register an administrator who can approve withdrawal addresses

The email domain must match the one configured for your partner account. This is checked server-side against an exact match — subdomains and lookalikes are refused.

post/v1/admins

Request

  • Base URL
    https://sandbox.onlink.africa
  • Auth
    API key in header X-OnLink-Key

Request body

emailstring required

Administrator email. MUST be on the domain configured for your partner account — enforced server-side.

namestring required

Administrator name, for the audit trail.

Example request

{
  "email": "ops@yourcompany.com"
}

Response

Administrator registered

adminIdstring uuid required

The administrator id. Use it for DELETE /v1/admins/{id}.

emailstring required

Administrator email, returned whole. It is an address you supplied on your own configured domain, so echoing it discloses nothing you do not hold — unlike approvalSentTo, which is masked because it accompanies a live second factor.

namestring required

Administrator name, as you registered it.

status'active' | 'removed' required

Lifecycle. Removal is recorded rather than deleted, so a removed administrator reads removed and never disappears from the audit trail — but only active administrators receive approval codes, and GET /v1/admins lists only those.

Example response

{
  "adminId": "c9f2a3b4-5d6e-4708-9a1b-2c3d4e5f6071",
  "email": "ops@yourcompany.com",
  "name": "Amina Otieno",
  "status": "active"
}

Changes

No recorded changes to this operation across all 1 revision of this API.