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.
Starting User Authentication
If your Service's User is starting the login process, you must initiate authentication on the Verigator side as well.
Request URL
Request to register a service will be made to the following URL:
POST 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 header | Description | Required |
|---|---|---|
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)
| Key | Description | Required |
|---|---|---|
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 |
Response body (JSON encoded)
| Key | Value |
|---|---|
method | totp - TOTP authentication method was used sms - SMS-based authentication was initiated |
HTTP Response Codes
| Status code | Value | Description |
|---|---|---|
201 | Created | User successfully created |
401 | Authentication required | Missing authentication headers (X-Service-Auth) |
403 | Forbidden | Forbidden request |
404 | Not found | User not found |
409 | Conflict | Conflict |
422 | Invalid data | Invalid request body - check the format and if it was correctly JSON encoded |