OTP Execute

post

https://api.eu.xtremepush.com/api/external/otp/execute

Send your own OTPs to your users

Body Params

apptoken

string

required

Your App token

string

required

Identifier of the user profile. Required only if you're specifying the recipient using customer, profile, or user ID

id_type

string

required

Specify if the ID is a user_id, profile_id, or customer_id

service_id

string

required

Your OTP integration ID. The associated OTP integration must be active.

mobile_number

string

required

The mobile number to which the OTP must be delivered. Required only if you're specifying the recipient using a mobile number.

send_by

string

required

Determines how the profile is identified for OTP delivery. Choose id if the profile is identified using an ID, or contact if using a phone number

otp_code

string

required

The pre-generated OTP code you want to send to your user. The OTP must be alphanumeric and between 4 to 10 characters in length

channel

string

required

Specify sms as the delivery channel for your OTP

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200