Skip to main content
POST
Create a request for the Hanko Authenticator
Remember the returned id — you’ll need it to check the status of, validate, or cancel this operation.

Authorizations

Authorization
string
header
required

This API uses Authorization: secret <api_key> rather than the standard Bearer scheme.

Body

application/json

The description

operation
enum<string>
required
Available options:
AUTH,
DEREG,
REG
username
string
userId
string
displayName
string
clientData
object
transaction
string
deviceIds
string[]
authenticatorSelectionCriteria
object
attestationConveyancePreference
enum<string>
Available options:
direct,
indirect,
none
isSecondFactorOnly
boolean

Response

The full Hanko request for an initialized authentication operation including links

id
string
required
operation
enum<string>
required
Available options:
AUTH,
DEREG,
REG
username
string
required
userId
string
required
status
enum<string>
required
Available options:
PENDING,
OK,
FAILED,
INVALIDATED
createdAt
string<date-time>
required
validUntil
string<date-time>
required
relyingParty
object
required
request
string
required
deviceID
string
required
clientData
object
location
object
transaction
string
device
object
isSecondFactorOnly
boolean
error
object