v1

latestOpenAPI 3.0.22026-07-17255.6 KB

Validate an authentication code

Validate an authentication code. Any unsuccessful response (either the response code is not 200 or an error is generated or response.body.success is not true) means that the code given by the user is not valid.

post/verify/validate

Request body

targetstring email required

Actual target to verify. If target_type is email, should be a valid email address

target_type'email'

Type of target. Currently only email is supported

codeinteger required

The code received by the target

Example request

{
  "target": "john.doe@company.com",
  "target_type": "email",
  "code": 123456
}

Response

Success Response

successboolean

Whether the code is valid or not