API Reference

Verify a one-time password

post
https://{project_url}/webservice/rest-api/{api_interface}/{version}/one-time-password/actions/verify

Verifies a one-time password. The password must be submitted within 1 hour of being sent and can only be used once.
Use the request ID returned by POST /one-time-password/actions/send together with the verification code received by the recipient.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Verification code from email, SMS or notification provided by recipient.

string
required

The parameter specifies the request that caused the OTP to be created. The request ID is returned by POST /one-time-password/actions/send.

string
required

The unique ID of the external application that requested the one-time password. If you do not have an external application ID, see the authentication documentation.

Headers
string
Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

error.error_data.invalid_params[] array lists the parameters that caused the failure, each carrying a reason code. See the BadRequestErrorBody schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 25 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 25 days ago