Skip to content

Begin OTP Registration

POST
/api/v1/otp/begin
curl --request POST \
--url https://api.spartanauth.com/api/v1/otp/begin \
--header 'Content-Type: application/json' \
--data '{ "transactionID": "example", "OTPType": "none", "destination": "example", "sectorID": "example" }'

Sends a one-time password to the authenticated user’s requested email address or phone number to begin enrolling an OTP factor. Requires a valid bearer token and returns a transactionID that must be used to finish registration.

Media type application/json
object
transactionID
string
OTPType
string
default: none
Allowed values: none sms email
destination
email or phone number depending on OTPType
string
sectorID
string

A successful response.

Media type application/json
object
transactionID
string
Example generated
{
"transactionID": "example"
}

An unexpected error response.

Media type application/json
object
code
integer format: int32
message
string
details
Array<object>
object
@type
string
key
additional properties
Example generated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}