Get Contact Verification Challenge

POST 
/api/web/v1/contact/verification/challenge

Get a contact verification challenge for the specified contact. Caller requires the CONTACTVERIFICATION:ADD permission.

Request

application/json

Body

required

type stringrequired

Possible values: [NONE, OTP_EMAIL, OTP_SMS, OTP_VOICE]

Type of contact delivery. Only supported for OTP contact attributes.

value stringrequired

The exact email or phone number that the OTP will be sent to.

Responses

200

OK

application/json

Schema

Schema

challengeId stringrequired

The unique challenge response identifier which will be used for authentication.

Example (from schema)

{
  "challengeId": "74750999-a59f-4b84-aa26-687d36f5001f"
}

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...