Send an SMS passcode

post

https://kigo-core-server-stage.kigodigital.net/api/v1/accounts/sms/send

Sends a one-time passcode to the given phone number for the program
identified by external_program_id. Requires a partner session token; the
partner is taken from the token, never the request body.

Body Params

Request body for sending or resending an SMS one-time passcode.

external_program_id is required: these routes are partner-authenticated
only, so there is no anonymous session to supply a fallback program from
configuration.

external_program_id

string

required

The identifier of the program from the partner's system.

phone_number

string

required

The phone number to send the one-time passcode to, including the country code —
+12025550143 or 12025550143, +442071838750 or 442071838750.

The country code is the caller's to supply: it is never inferred, so a national number
is not assumed to be North American. The leading + is optional and spaces, hyphens,
dots and parentheses are ignored; the number is stored canonically either way.

Sending the + is still worth doing: without it a missing country code cannot be
distinguished from a short international number, so a national number is taken at face
value as though its first digits were a country code rather than being rejected.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201Successfully sent the SMS one-time passcode.

400The phone number does not include a country code — one is required and is never inferred — or the program external ID is unknown.

403SMS authentication is not enabled for this program.

429A one-time passcode is still active for this phone number.

500Internal error occurred while sending the one-time passcode.