Perform a verification

post

https://connect.routee.net/2step

You can send a Two Factor Authentication very easily just by specifying the recipient, the type of the message and the method that the verification will be sent. The message type that is currently supported is "code" which generates a numeric only code with the specified number of digits. The supported methods are "sms" and "voice", so the specified recipient must be a valid mobile or landline (for voice) number. All optional parameters that are required by 2Step are taken from your application settings which can be configured through the Routee web console. This is a paid service. For pricing check here.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

RESPONSE PARAMETERS

KEY	DESCRIPTION
trackingId	The tracking id used to reference this specific verification.
status	The status of the verification.
updatedAt	The last time this verification was updated.
maxRetries	The number of retries only, the first try is not included.
expiresAt	When will the verification expire.
timesTried	How many tries were made by the user.

ERROR CODES

STATUS	CODE	DESCRIPTION
404	404001001	Account not found.
400	400001009	Insufficient Balance.
404	404010002	Application not found.
400	400011001	Invalid message template.
400	400005000	Sms contains invalid data.

Body Params

method

string

required

The method which will be used to send the 2step verification. Values: "sms", "voice".

type

string

required

Defaults to code

The type of the message. Value: "code".

recipient

string

required

The recipient that will receive the 2step verification. For sms method format with a '+' and country code e.g., +306948530920 (E.164 format).

template

string

required

The template of the message. It must contain a @@pin that will be replaced by the generated code.

arguments

string

If the template is for example '@@name your code is @@pin' and the argument has a property name: 'Nick' the message will be 'Nick your code is 4232'. Note that if the template contains a @@ placeholder and a value is not present in the arguments property it will stay as is.

templateCountry

string

Country in ISO-3166-1 alpha 2 format (GR, US etc.). The country to use in order to select a translated template (if defined in Routee web interface)

originator

string

The senderId that will be set when sending the SMS

lifetimeInSeconds

int32

How many seconds this verification will remain active. After that time passes the verification status will be Expired.

maxRetries

int32

Defines the number of times the user can re-confirm the verification before the verification changes its state to Failed.

digits

int32

The number of digits of the generated random numeric code.

restrictions

object

[OPTIONAL] Provide the registered Content Template ID and Principal Entity ID to ensure the message is not rejected by TRAI regulations.

Headers

Content-Type

string

required

Defaults to application/json

application/json

Authorization

string

required

Defaults to Bearer {access_token}

Bearer {access_token}

Responses

Language

Loading…

Response

Choose an example:

application/json

200200

400400