verify.mobile-text-alerts.com Open in urlscan Pro
54.224.71.206  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Body
 * Headers (1)

 * Body
 * Headers (0)




Public


Documentation Settings

ENVIRONMENT
Public API

LAYOUT
Double Column

LANGUAGE
cURL - cURL



SMS Verify API
Introduction
Authentication
Verification Status
POST
Trigger SMS Verification Code
POST
Check SMS Code


SMS VERIFY API

The Mobile Text Alerts SMS Verify API is an easy to use and convienent way to
manage SMS multi-factor authentication workflows within your application. The
API endpoints provided by this service enable end user applications to rely on
Mobile Text Alerts for verification code generation, delivery of SMS messages
and validation of user supplied codes. Read on below for more details on how to
manage this workflow within your application using Mobile Text Alerts.


AUTHENTICATION

All protected endpoints use Bearer Token authentication. In order to access
these endpoints, the request must include an Authorization header with a value
of Bearer myAPIKey where myAPIKey is the unique access token assigned to your
Mobile Text Alerts account.


VERIFICATION STATUS

The API endpoints described below make reference to a Verification Status value
that will be supplied in the response to certain API calls. This Verification
Status value is used to communicate the current status of the SMS verification
request and to confirm the validity of the user supplied code. The possible
values for this enum are:

   
 * PENDING
     
   * The verification request has been processed by MTA and was sent to the
     user.
     
   
 * APPROVED
     
   * The supplied verification code is valid and the request has not yet
     expired.
     
   
 * EXPIRED
     
   * The verification request has expired. This status does not indicate whether
     the supplied code was/is valid or invalid.
     
   
 * INVALID
     
   * The verification request has not yet expired but the supplied code did not
     match the code sent to the user via SMS.
     
   

AUTHORIZATIONBearer Token
Token




POSTTRIGGER SMS VERIFICATION CODE


https://api.mobile-text-alerts.com/v3/verify/sms/send-code


OVERVIEW

Initiates a 2FA verification code process via SMS message. Request parameters
allow for control over the timeout of the verification code and the length of
the generated code. A successful response will include a unique identifier for
this verification request that can be used to check the validity of a user
supplied code after it has been sent.


REQUEST FIELDS

   
 * to: string - Required
     
   * The destination phone number to send the SMS verification code to
     
   
 * serviceName: string - Required
     
   * A customer friendly name for your service. This string will be included in
     the verification message as follows: Your ${serviceName} verification code
     is: ${code} where code is the code generated by the system for this
     verification request
     
   
 * timeoutSeconds: number - Optional
     
   * Default: 300
     
   * The number of seconds the verification code should be considered valid for.
     Mobile Text Alerts will store a timestamp associated with this timeout and
     reflect an EXPIRED status if a code is checked after the timeout period has
     elapsed.
     
   
 * codeLength: number - Optional
     
   * Default: 6
     
   * Controls the length of the code generated. Valid values for codeLength are
     between 4 and 8
     
   


RESPONSE FIELDS

   
 * to: string
     
   * The destination number supplied in the request
     
   
 * timeoutSeconds: number
     
   * The value of timeoutSeconds supplied in the request
     
   
 * type: string
     
   * The type of verification code. In this response, this value will always be
     "sms"
     
   
 * status: enum
     
   * An ENUM value representing the current status of this verification request.
     Please see the Verification Status section for more details
     
   
 * verificationId: string
     
   * A unique identifier that identifies this specific verification request. Can
     be used when checking code validity to identify the associated verification
     request
     
   

AUTHORIZATIONBearer Token
This request is using Bearer Token from collectionSMS Verify API
Bodyraw (json)
json


{
    "to": "<number|string>",
    "serviceName": "<string>",
    "timeoutSeconds": "<number>",
    "codeLength": "<number>"
}

Example Request
Success

View More
curl


curl --location 'https://api.mobile-text-alerts.com/v3/verify/sms/send-code' \
--data '{"to": "+12125550876","serviceName": "Mobile Text Alerts","timeoutSeconds": 300,"codeLength": 6}'

200 OK
Example Response
 * Body
 * Headers (1)

json


{
  "to": "+12125550876",
  "timeoutSeconds": 300,
  "type": "sms",
  "status": "PENDING",
  "verificationId": "c2d86657-0259-4fae-a4c2-6d8a00445f86"
}

Content-Type

application/json


POSTCHECK SMS CODE


https://api.mobile-text-alerts.com/v3/verify/sms/check-code


OVERVIEW

After initiating an SMS Verification request, the user will be sent a code via
SMS that they must enter into your application. Once you've received this code,
it can be validated using the Check SMS Code endpoint described here. You must
retain one identifier for this request in order to validate it with the
user-supplied code.


REQUEST FIELDS

   

 * to: string - Optional
   
     
   * The destination phone number this SMS verification code was sent to. While
     marked as Optional, at least one of [ to, verificationId ] is required to
     identify this request
     
   

 * verificationId: string - Optional
   
     
   * The unique identifier supplied in the response to a "Trigger SMS
     Verification Code" request that identifies this specific verification code
     request. While marked as Optional, at least one of [ to, verificationId ]
     is required to identify this request
     
   

 * code: string - Required
   
     
   * The code supplied by the user that should be validated for this
     verification request. Length must match the configured codeLength for this
     request.
     
   


RESPONSE FIELDS

   
 * to: string
     
   * The destination number supplied in the request
     
   
 * verificationId: string
     
   * The verification request ID supplied in the request. If only to is
     supplied, the response will still include this ID for reporting purposes.
     
   
 * status: enum
     
   * An ENUM value representing the current status of this verification request.
     Please see the Verification Status section for more details
     
   

AUTHORIZATIONBearer Token
This request is using Bearer Token from collectionSMS Verify API
Bodyraw (json)
json


{
	"to": "<string>",
	"verificationId": "<string>",
	"code": "<string>"
}

Example Request
Success - Code Valid

curl


curl --location 'https://api.mobile-text-alerts.com/v3/verify/sms/check-code' \
--data '{
	"to": "+12125550876",
	"verificationId": "c2d86657-0259-4fae-a4c2-6d8a00445f86",
	"code": "123456"
}'

200 OK
Example Response
 * Body
 * Headers (0)

{
  "to": "+12125550876",
  "verificationId": "c2d86657-0259-4fae-a4c2-6d8a00445f86",
  "status": "APPROVED"
}

No response headers
This request doesn't return any response headers