v1

latestSwagger 2.02026-07-132830204.5 KB
Telephony

Verify Security Code

Check if a security code sent via SMS Verify or Phone Verify is valid

get/verify-security-code

Query parameters

security-codestring required

The security code to verify

limit-bystring

If set then enable additional brute-force protection by limiting the number of attempts by the supplied value. This can be set to any unique identifier you would like to limit by, for example a hash of the users email, phone number or IP address. Requests to this API will be ignored after approximately 10 failed verification attempts

Response

OK

verifiedboolean required

True if the code is valid

Example response

{
  "verified": false
}