Check a one-time code
Checks the code the person typed. A correct code marks the challenge verified and returns the record. No proof token is returned, and a contact proved here cannot be carried into a verification submission.
Every call spends one attempt, including a repeat call on a challenge that is already verified. A wrong code answers 400 invalid_code with attemptsRemaining.
Billing. The check is charged once, when a code is first accepted, in production only. chargedAmount reports the cost. A repeat call does not charge again.
Error codes
A missing or unknown key answers 401, where error is a short sentence rather than a code.
Requires a secret (sk_) key. A publishable key receives 403 secret_key_required.
Authentication
AuthorizationBearer
Send the API key as a Bearer token. Each operation states whether a publishable key is enough or a secret key is required.
Path parameters
id
The contact verification id returned when the code was sent.
Request
This endpoint expects an object.
code
The code the person typed.
Response
The code was accepted.
contactVerification
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
410
Gone Error
429
Too Many Requests Error