Sign in

v3

latestOpenAPI 3.1.02026-08-087684214.2 KB
verification

Check Verification

Check a verification code against a pending verification.

Possible results:

  • ok — code is correct, phone number verified
  • incorrect — wrong code, try again (up to 3 attempts)
  • exhausted — too many failed attempts, send a new code
  • expired — verification expired (10 min), send a new code
  • already_verified — this verification was already completed

Billing. An ok or already_verified result costs a $0.05 verification fee. Other results are free.

post/v1/verify/check

Request body

verification_idstring required

Verification ID returned from /v1/verify/send

codestring required

6-digit verification code

Response

Successful Response

resultstring required

One of ok, incorrect, exhausted, expired, or already_verified.

attempts_remaininginteger nullable

Checks left before the verification is exhausted. 0 once it reaches a final state.