Skip to main content
POST
/
passcode
/
login
/
finalize
Finalize passcode login
curl --request POST \
  --url https://{tenant_id}.hanko.io/passcode/login/finalize \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c",
  "code": "897481"
}
'
{
  "id": "c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c",
  "ttl": 300,
  "created_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.hanko.io/llms.txt

Use this file to discover all available pages before exploring further.

Deprecated. Please use the Flow API instead. What’s the Flow API?.
Finalize a passcode login given the id of the passcode and the actual code provided in the email sent to the user during initialization. On success, sets the User’s verified status to true

Body

application/json
​
id
string<uuid4>

The ID of the passcode

Example:

"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c"

​
code
string

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

Required string length: 6
Example:

"897481"

Response

Successful passcode login finalization

Representation of a passcode

​
id
string<uuid4>

The ID of the passcode

Example:

"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c"

​
ttl
integer

Lifespan of a passcode in seconds

Example:

300

​
created_at
string<date-time>

Time of creation of the passcode