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

Request

Base URL
https://demo-api.incodesmile.com
Auth
API key in header x-api-key and API key in header X-Incode-Hardware-Id
TypeScript
https://skmtc.dev/incode/apis/incode-omni-api/docs/omni/send/otp/get.ts
A function with typed inputs. Its response is checked against the schema.

communicationchannel'SMS' | 'EMAIL'

api-versionstring required

OTP sent successfully

successboolean

Flag indicating request passed successfully.

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

Session status

No recorded changes to this operation across all 1 revision of this API.