Skip to content

Begin OTP Challenge

POST
/api/v1/login/otp/begin
curl --request POST \
--url https://api.spartanauth.com/api/v1/login/otp/begin \
--header 'Content-Type: application/json' \
--data '{ "username": "example", "transactionID": "example", "registrationID": "example", "sectorID": "example" }'
Media type application/json
object
username
optional - required if initializing a new challenge flow
string
transactionID
optional
string
registrationID
the ID of the OTP registration to use
string
sectorID
string
Example generated
{
"username": "example",
"transactionID": "example",
"registrationID": "example",
"sectorID": "example"
}

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"
}
]
}