Passcode

Finalize passcode login

Finalize a passcode login given the id of the passcode and the actual code provided in the the email sent to the user during initialization.

On success, sets the User's verified status to true.

post/passcode/login/finalize

Request

Base URL
https://.hanko.io/admin
Auth
none required
TypeScript
https://skmtc.dev/hanko/apis/hanko-admin-api/docs/passcode/login/finalize/post.ts
A function with typed inputs. Its response is checked against the schema.

idstring uuid4

codestring

The actual passcode from the email sent to the user during initialization, a string of 6 decimal digits

{
  "id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c",
  "code": "897481"
}

Successful passcode login finalization

idstring uuid4

ttlinteger

Lifespan of a passcode in seconds

created_atstring date-time

Time of creation of the passcode

{
  "id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c",
  "ttl": 300
}

No recorded changes to this operation across all 1 revision of this API.