URL
https://verify.safeid.io/api/v1.0/oath/verifysync
Input Parameters
| clientId | no | n/a | Client ID of your account provided by the service provider | |||||||||||
| apiKey | no | n/a | API Key of your account provided by the service provider | |||||||||||
| tsn | no | n/a | The serial number of the token to be verified | |||||||||||
| otpotp1 | no | n/a | A 1st one-time passcode | |||||||||||
| dtfcotp2 | yes | current time | Date Time in UTC when the OTP was captured | 2022-06-28T17:22:00 | no | n/a | 2nd one-time passcode | The 1st and 2nd OTP should be consecutive | auth | true/false | yes | true | true=authentication only false=return the date time when the OTP was generated | |
| Param | Values | Optional | Default Value | Remarks | Example |
|---|
Note: This command should be posted, and its body should be a JSON object containing all of above parameters, e.g.
{ "clientId" : "xxxxxxx", "apiKey": "*******************", "tsn": "nnnnnnnn", "otp1": "nnnnnn", "otp2": "nnnnnn"}
Output Result
The output of this api function is a JSON object containing the following key/value pairs:
- error: the error code of the result. 0 means success, others mean failure
- message: the description of the errortime: the date time when the OTP was generated (when auth=false)
Examples
Example 1
GETPOST: https://verify.safeid.io/api/v1.0/oath/verify?clientID=10011001&ApiKey=cl9ASENZV1k=&tsn=10011001&otp=576151sync
BODYResult: {"error":0,"message":"OK"}
Example 2
GET: https://verify.safeid.io/api/v1.0/oath/verify?clientID=10011001&ApiKey=cl9ASENZV1k=&tsn=10011001&otp=576151&auth=false "clientId" : "438929220", "apiKey": "XS91cLX5_Gt7-n_TdzR4.t_8t.C-7b6-", "tsn": "90002109", "otp1": "657159", "otp2": "006977"}
Result: {"error":0,"message":"OK","time":"2019-12-30T12:34:49000:00"}