API Reference

Verify an SMS passcode

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

Verifies the passcode and signs the member in, creating the account if this
is their first passcode sign-in. Returns the account with
AccountSpaceApiSession tokens, so access_token authenticates subsequent
account-space API calls. Requires a partner session token.

Body Params

Request body for verifying an SMS one-time passcode.

external_program_id is required for the same reason as
[SendSmsOtpApiInput].

string
required

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

string
required

The one-time passcode from the SMS.

string
required

The phone number the one-time passcode was sent to, in E.164 format including the
country code (for example +14165551234).

Must match what was sent to [SendSmsOtpApiInput]: the passcode is stored under the
number verbatim, so a differently formatted value will not find it.

Responses

Updated 10 days ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 days ago

Did this page help you?