curl --request POST \
--url https://api.urtentic.com/api/v1/workflows/{workflowId}/otp \
--header 'Content-Type: application/json' \
--data '
{
"key": "+2348012345678",
"channel": "PHONE",
"verificationId": "85c94e71-6e3f-4a19-b15c-781d8a876542"
}
'{
"sent": true
}Workflows
Send Workflow OTP
Sends a one-time code by email or SMS for a verification that is in progress. Use it during the EMAIL_CHECK and PHONE_CHECK verification processes.
Notes
- The verification must belong to this workflow and still be in progress
- Email codes are free
- Each SMS is paid from the organization’s credits when it’s sent - the first code and every
resend, with no limit. If the credits can’t pay, no SMS is sent and the response is
{"sent": false}: don’t ask for a code, submit the phone number without one. See Billing and usage.
POST
/
workflows
/
{workflowId}
/
otp
curl --request POST \
--url https://api.urtentic.com/api/v1/workflows/{workflowId}/otp \
--header 'Content-Type: application/json' \
--data '
{
"key": "+2348012345678",
"channel": "PHONE",
"verificationId": "85c94e71-6e3f-4a19-b15c-781d8a876542"
}
'{
"sent": true
}Path Parameters
Unique identifier of the workflow
Body
application/json
Where to send the code: an email address for EMAIL, or a phone number in
E.164 format for PHONE.
Example:
"+2348012345678"
The verification the code is for.
Example:
"85c94e71-6e3f-4a19-b15c-781d8a876542"
How to send the code. Defaults to EMAIL.
Available options:
EMAIL, PHONE Response
Whether a code was sent
false when an SMS was skipped because the organization's credits couldn't
pay for it. Always true for email.