v1

latestOpenAPI 3.0.3AGPL-3.0-or-later2026-07-2687268192.4 KB
Hanko Authenticator

Create a request for the Hanko Authenticator

Using this endpoint you initialize a new registration, authentication, or deregistration by creating a new operation. Be sure to indicate the requested type by setting the operation to the correct enum value. Remember the id to take actions regarding this operation.

post/v1/uaf/requests

Request body

operation'AUTH' | 'DEREG' | 'REG' required
usernamestring
userIdstring
displayNamestring
transactionstring
deviceIdsstring[]
attestationConveyancePreference'direct' | 'indirect' | 'none'
isSecondFactorOnlyboolean

Response

The full Hanko request for an initialized authentication operation including links

idstring required
operation'AUTH' | 'DEREG' | 'REG' required
usernamestring required
userIdstring required
status'PENDING' | 'OK' | 'FAILED' | 'INVALIDATED' required
createdAtstring date-time required
validUntilstring date-time required
transactionstring
requeststring required
deviceIDstring required
isSecondFactorOnlyboolean