Verify

Check a verification code

Submit the OTP code the end-user received. Max 5 attempts. Accepts 4, 6, or 8 digit codes depending on how the verification was started.

Requires verify:w.

post/v1/verify/{id}/check

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/verify/{id}/check
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

Request body

codestring required

4 to 8 digit OTP code

Response

Code accepted: the verification is now verified.

idstring required
phone_numberstring required
from_numberstring required
status'pending' | 'verified' | 'expired' | 'max_attempts' required
attemptsinteger required
code_lengthinteger required
app_namestring nullable required
mode'LIVE' | 'TEST' required

TEST verifications are simulated: no SMS is sent, nothing is billed, and the code is always 000000 padded to code_length.

cost_centsinteger required

Cost in cents CAD. On a TEST verification this is 0: nothing was charged.

expires_atstring date-time required
verified_atstring date-time nullable required
created_atstring date-time required
attempts_remaininginteger required

Always 0 on success.

Changes

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