v1

latestOpenAPI 3.1.0Apache 2.02026-07-24113269342.0 KB
Onboarding

Send SMS with One Time Password for onboarding

Send SMS with an OTP (One Time Password) code to validate an onboarding. Phone number is obtained from interview data, so phone step it's required.

get/omni/send/otp

Query parameters

communicationchannel'SMS' | 'EMAIL'

Headers

api-versionstring required

Response

OTP sent successfully

successboolean

Flag indicating request passed successfully.

sessionStatus'Alive' | 'Closed' | 'Deleted'

Session status