Skip to content

List OTP Registrations

GET
/api/v1/otp/{username}
curl --request GET \
--url https://api.spartanauth.com/api/v1/otp/example

Lists the OTP methods registered for an account. Authenticated users can view full registration details for themselves or users in a sector they administer, while unauthenticated login flows can supply a username and sector to receive obfuscated destination details.

username
required
string
transactionID
string
sectorID
string

A successful response.

Media type application/json
object
registrations
Array<object>
object
ID
string
DisplayName
string
Validated
boolean
Type
string
default: none
Allowed values: none sms email
Example
{
"registrations": [
{
"Type": "none"
}
]
}

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