OTP

Get an OTP request

Returns the OTP request with the given id — useful for debugging delivery or rendering state in a support tool. The code is never returned.

Scope required: otp:read.

Only requests belonging to your own account are visible; anyone else's id returns 404.

This read does not expire the request. Expiry is resolved lazily, on /v1/otp/verify. A request whose expiresAt has already passed will still read status: "SENT" here until someone tries to verify it. To know whether a code is still usable, compare expiresAt against the current time yourself — do not treat status: "SENT" as "still valid".

get/v1/otp/{id}

Request

Base URL: https://api.dzverify.com
URL: https://api.dzverify.com/v1/otp/{id}
Auth: API key in header X-API-Key

Path parameters

idstring required

Example:01HZX5N7M4J2K8Q4R0T5V7Y9AB

The OTP request id returned by /v1/otp/send.

Response

The OTP request.

successtrue required

messagestring

Short status message (e.g. "OTP sent", "OTP verified").

Example response

{
  "data": {
    "id": "01HZX5N7M4J2K8Q4R0T5V7Y9AB",
    "recipient": "+213612345678"
  }
}

Changes

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