URL
https://verify.safeid.io/api/v1.0/oath/verify
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 | ||
| otp | no | n/a | A one-time passcode | ||
| dtfc | yes | current time | Date Time in UTC when the OTP was captured | 2022-06-28T17:22:00 | |
| 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 |
|---|
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 error
- time: the date time when the OTP was generated (when auth=false)
Error Code List
| Error Code | Description |
|---|---|
| 0 | Success |
| 1 | Internal Server Error |
| 10 | Access Denied |
| 11 | Call Limit Exceeded |
| 12 | Insufficient Licenses |
| 20 | Missing Client ID |
| 21 | Incorrect Client ID |
| 30 | Missing API Key |
| 31 | Incorrect API Key |
| 32 | API Key Not Set up |
| 40 | Missing Token Serial Number |
| 41 | Incorrect Token Serial Number |
| 42 | Duplicated Token Found in Database |
| 50 | Missing OTP |
| 51 | Incorrect OTP |
Examples
Example 1
GET: https://verify.safeid.io/api/v1.0/oath/verify?clientID=10011001&ApiKey=cl9ASENZV1k=&tsn=10011001&otp=576151
Result: {"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
Result: {"error":0,"message":"OK","time":"2019-12-30T12:34:49000:00"}