Skip to main content

Verification API Documentation

Deprecation Notice

The API has been deprecated. Looking to build a one-time phone verification? Use our Number Verification API instead for a more flexible solution.

You can use Messente's HTTP SMS API to verify your client's phone number​

Messente has lots of ready-made libraries for easy integration - go and check out Messente API Libraries.

How to Verify client's phone number with Messente​

  1. Use Verification API to send and verify PIN codes
  2. Use ready-made Verification Widget for super-fast integration

Verifying PIN Code​

After starting authentication, you must verify the PIN code of the user.

Request URL​

Request to register a service will be made to the following URL:

PUT https://api.verigator.com/v1/service/service/{ServiceId}/users/{UserID}/auth

ServiceId and UserId in the URL should be replaced with your ServiceID and UserID.

Request headers​

HTTP headerDescriptionRequired
Content-Type
application/json
Accept
application/json
X-Service-Auth
Refer to authentication section on how to authenticate your API calls with Messente API username and password

Request body (JSON encoded)​

KeyDescriptionRequired
method
totp - Prefer TOTP verification with Verigator App. In case app is not set up for this user, Verigator will fallback to SMS automatically.
sms - Start SMS-based authentication
token
PIN code entered by the User

Response body (JSON encoded)​

KeyValue
method
totp - TOTP authentication method was used
sms - SMS-based authentication was initiated
verified
true - Verification was successful, allow user to log in
false - Verification failed, deny access for this user

HTTP Response Codes​

Status codeValueDescription
200
OK
Request was successful
401
Authentication required
Missing authentication headers (X-Service-Auth)
403
Forbidden
Forbidden request
404
Not found
Verifitacion with auth_id was not found
422
Not found
Invalid request body - check the format and if it was correctly JSON encoded