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.

Adding User to Service

After setting up your Service you can start adding Users to your Verigator Service.

Request URL

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

POST https://api.verigator.com/v1/service/service/{ServiceId}/users

ServiceID in the URL should be replaced with your ServiceID.

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
id_in_service
Username in your service that is used for logging in - usually users email address. Example: john.doe@verigator.com or john_doe
phone_number
Users phone number with country prefix. Example: +4401234567

Response body (JSON encoded)

KeyValue
id
Newly created UserID. You will need to store this in your database for this user - this UserID will be used for user authentication. Example: 81213bfd-b690-499e-b9d2-8754cb1550e8
ctime
Timestamp when the user was added to the service in Verigator
id_in_service
Username in your service that is used for logging in - same as provided in the Request Body

HTTP Response Codes

Status codeValueDescription
201
Created
User successfully created
401
Authentication required
Missing authentication headers (X-Service-Auth)
403
Forbidden
Forbidden request
404
Not found
409
Conflict
User already exists
422
Invalid data
Invalid request body - check the format and if it was correctly JSON encoded