ONonlink
Partner API

Confirm a money-movement instruction

Verifies the code sent to your registered confirmation contact (or pushed to your webhook as confirmation.code_issued) and, once correct, hands the instruction off for execution. The response reflects the instruction status immediately after this call (confirmed) — poll GET /v1/transfers/:id for what happens next.

post/v1/confirmations/{id}

Request

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

Path parameters

idstring required

Request body

codestring required

The 6-digit code delivered to your registered confirmation contact.

Example request

{
  "code": "482913"
}

Response

The code was correct. Execution has been handed off.

confirmationIdstring required

The confirmation id.

subjectType'transfer' | 'usdt_send' | 'batch' required

What this confirmation authorises.

subjectIdstring required

The id of the instruction this confirmation authorises.

status'awaiting_confirmation' | 'confirmed' | 'executing' | 'processing' | 'settled' | 'failed' | 'expired' | 'cancelled' | 'awaiting_confirmation' | 'confirmed' | 'processing' | 'settled' | 'failed' | 'expired' | 'awaiting_confirmation' | 'confirmed' | 'processing' | 'completed' | 'failed' | 'expired' required

The instruction's status after this call: 'confirmed' — execution has been handed off.

verifiedAtstring date-time required

ISO-8601 instant the code was verified.

Example response

{
  "confirmationId": "df9f1e6a-0000-4000-8000-000000000030",
  "subjectType": "transfer",
  "subjectId": "bd9f1e6a-0000-4000-8000-000000000010",
  "status": "confirmed",
  "verifiedAt": "2026-09-11T00:02:00.000Z"
}

Changes

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