Check a verification code

The only billable moment in Verify.

POST/v1/verify/check

Body Parameters

phonestring
The number the code was texted to. Send this or email.
emailstring
The address the code was emailed to. After a fallback, check by email: the code proves the address, not the phone, and a check by phone answers 409 invalid_state.
codestringrequired
The code last sent Example: 482193.

Details

charged tells you whether this call was billed.

Responses

200JSON object
Check result
401Error
Missing, malformed, or revoked API key
402Error
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
404Error
No active verification
429Error
Rate limit or quota exceeded

Response Fields

verifiedboolean
channelsms, email
The channel of the code checked
phonestring
Channel sms: the number the code proved Nullable.
emailstring
Channel email: the address the code proved (after a fallback, the email, never the phone) Nullable.
statusapproved, pending, expired, max_attempts
attemptsinteger
chargedboolean

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

401
Missing, malformed, or revoked API key
402
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
404
No active verification
429
Rate limit or quota exceeded

import { TextKit } from 'jointextkit'; // npm install jointextkit

const sms = new TextKit(process.env.TEXTKIT_API_KEY);

const check = await sms.verify.check({ to: '+14155550132', code: '123456' });

console.log(check.verified);

Response 200

{
  "channel": "sms",
  "status": "approved"
}