Introduction

Nexmo's Verify API can be used for two-factor authentication, spam protection, hack protection and reaching users.

It sends a PIN via SMS text message and by telephone to verify user identity by proving that a user can be contacted at a specific telephone number. By default, the PIN is first sent via SMS. If there is no reply the Nexmo Verify API will then try a voice call using text-to-speech (TTS).


Conceptual model

Conceptual model


Definitions

PIN

A secret code that is only known by the issuer and yourself. The issuer uses and validates the PIN to verify if it's actually you they are communicating with.

SMS

SMS stands for Short Message Service and is the most widely used type of text messaging. With an SMS, you can send a message of up to 160 characters to another device.

TTS

Abbreviation for Text-To-Speech. Written text are spoken by a computer generated synthesized voice.

E.164

E.164 defines a general format for international telephone numbers. Plan-conforming numbers are limited to a maximum of 15 digits, excluding the international call prefix.


API workflow

API workflow


Features and constraints

Features

  • Authentication by mobile phone by SMS.
  • Option to cancel the request.
  • Check if the received user response is actually the same as the PIN sent by Nexmo.
  • If no response is send from the user, the system will call the user and tell the PIN.

Constraints

  • After a verify request is sent, your application has to retrieve the PIN from the user and check it by means of an additional API call.


How to...

Send a verification request

Send a verification code to a user phone to start a one-time password, two-factor authentication or phone verification process.

SwaggerHub:

  1. Select POST /.
  2. Click Try it out.
  3. Fill out the parameters number and brand with the telephone number (in E.164 format) and your brand message before the PIN.
  4. Click Execute.
  5. Check the response code and message.

Postman:

  1. Select (POST) Verify Request.
  2. Select the Verify-Nexmo environment from the environment selector.
  3. Open the environment and edit variables number and brand with the telephone number (in E.164 format) and your brand message before the PIN.
  4. Click Send.
  5. Check the response code and message.
^^Response example^^
{
  "request_id":"1267899",
  "status":"status",
  "error_text":"error"
}

Check a verification

Check a verification code that a user has provided. Use the request_id from the response message that was received when the verification code was sent with the check.

SwaggerHub:

  1. Select POST /check.
  2. Click Try it out.
  3. Fill out the parameters request_id and code with request_id as returned from the previous request and the PIN that the user of the mobile phone provided you.
  4. Click Execute.
  5. Check the response code and message.

Postman:

  1. Select (POST) Verify Check.
  2. Select the Verify-Nexmo environment from the environment selector.
  3. Open the environment and edit variables request_id and code with the request_id as returned from the previous request and the PIN that the user of the mobile phone provided you.
  4. Click Send.
  5. Check the response code and message.
^^Response example^^
{
  "request_id":"1267899",
  "status":"status",
  "error_text":"error"
}

Search verification requests

Send a Verify Search request containing the request_id's of the Verify requests to search for. Check the status response parameter in the search response to see if the request was successfully completed.

SwaggerHub:

  1. Select POST /search.
  2. Click Try it out.
  3. Fill out the parameters request_id with the request_id as returned from the initial request.
  4. Click Execute.
  5. Check the response code and message.

Postman:

  1. Select (POST) Verify Search.
  2. Select the Verify-Nexmo environment from the environment selector.
  3. Open the environment edit variables request_id with the request_id as returned from the initial request.
  4. Click Send.
  5. Check the response code and message.
^^Response example^^
{
  "request_id":"1267899",
  "status":"status",
  "error_text":"error"
}

Control verification requests

You can control the progress of your Verify Requests by filling in appropriate values. Supported values are:

  • cancel - stop the request
  • trigger_next_event - advance the request to the next part of the process

Note: verification requests can't be canceled within the first 30 seconds. You must wait at least 30 seconds after sending a Verify Request before canceling.

SwaggerHub:

  1. Select POST /control.
  2. Click Try it out.
  3. Fill out the parameters request_id and cmd with the request_id as returned from the initial request and one of the command option as describe above.
  4. Click Execute.
  5. Check the response code and message.

Postman:

  1. Select (POST) Verify Control.
  2. Select the Verify-Nexmo environment from the environment selector.
  3. Open the environment edit variables request_id and cmd with the request_id as returned from the initial request and one of the command option as describe above.
  4. Click Send.
  5. Check the response code and message.
^^Response example^^
{
  "request_id":"1267899",
  "status":"status",
  "error_text":"error"
}


Return codes

Code   Description
200   Success.
201   Created.
202   Accepted.
302   Found. Link in location header.
400   Bad request.
401   Unauthorized.
403   Forbidden.
404   Not found.
405   Method not allowed.
412   Precondition failed.
429   Too many requests.
500   Internal server error.
502   Bad gateway.
503   Service unavailable.