Skip to main content
POST
/
verifications
/
{verification_id}
/
actions
/
verify
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const verifyVerificationCodeResponse = await client.verifications.actions.verify(
  '12ade33a-21c0-473b-b055-b3c836e1c292',
);

console.log(verifyVerificationCodeResponse.data);
{
  "data": {
    "phone_number": "+13035551234",
    "response_code": "accepted"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
verification_id
string<uuid>
required

The identifier of the verification to retrieve.

Example:

"12ade33a-21c0-473b-b055-b3c836e1c292"

Body

application/json
​
code
string

This is the code the user submits for verification.

Example:

"17686"

​
status
enum<string>

Identifies if the verification code has been accepted or rejected. Only permitted if custom_code was used for the verification.

Available options:
accepted,
rejected
Example:

"accepted"

Response

Expected verify response to a valid request.

​
data
object
required