Authenticate Contact Verification Challenge

POST 
/api/web/v1/contact/verification/authenticate

Authenticate the contact verification challenge. Caller requires the CONTACTVERIFICATION:ADD permission.

Request

application/json

Body

required

challengeId stringrequired

The unique challenge response identifier used for authentication

challengeResponse stringrequired

The otp response

Responses

200

OK

application/json

Schema

Schema

attemptsLeft int32required

The number of attempts left for authentication failure

challengeId stringrequired

The challenge Id of the user's input

errorCode string

The error message during the authentication

success booleanrequired

A boolean value which indicates if the authentication is successful

Example (from schema)

{
  "attemptsLeft": 5,
  "challengeId": "74750999-a59f-4b84-aa26-687d36f5001f",
  "errorCode": "invalid_otp",
  "success": true
}

400

Bad request

application/json

Schema

Schema

code stringrequired

The server error code

message stringrequired

A human-readable representation of the error

target string

The target of the error

Example (from schema)

{
  "code": "string",
  "message": "string",
  "target": "string"
}

401

Authorization information is missing or invalid

application/json

Schema

Schema

code stringrequired

The server error code

message stringrequired

A human-readable representation of the error

target string

The target of the error

Example (from schema)

{
  "code": "string",
  "message": "string",
  "target": "string"
}

429

Too many requests

application/json

Schema

Schema

code stringrequired

The server error code

message stringrequired

A human-readable representation of the error

target string

The target of the error

Example (from schema)

{
  "code": "string",
  "message": "string",
  "target": "string"
}

Loading...