Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The ID of the verification to check against.

Example:

"vfn_01jayh15c2f2xamftg0xpyq1nj"

Body

application/json

Parameters for checking a Verification code

code
string
required

The Verification code that was received.

Pattern: ^[0-9]{6}$
Example:

"123456"

Response

Correct code

The result of checking a Verification code

result
enum<string>

The result of the code check.

Available options:
ok,
incorrect,
exhausted,
expired,
already_verified
verification
Verification · object

A phone number verification

Example: