Skip to main content
POST
/
{tenant_id}
/
registration
/
initialize
Start Passkey Registration
curl --request POST \
  --url https://passkeys.hanko.io/{tenant_id}/registration/initialize \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <apikey>' \
  --data '
{
  "user_id": "<string>",
  "username": "<string>",
  "icon": "<string>",
  "display_name": "<string>"
}
'
import requests

url = "https://passkeys.hanko.io/{tenant_id}/registration/initialize"

payload = {
    "user_id": "<string>",
    "username": "<string>",
    "icon": "<string>",
    "display_name": "<string>"
}
headers = {
    "apiKey": "<apikey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {apiKey: '<apikey>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    user_id: '<string>',
    username: '<string>',
    icon: '<string>',
    display_name: '<string>'
  })
};

fetch('https://passkeys.hanko.io/{tenant_id}/registration/initialize', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://passkeys.hanko.io/{tenant_id}/registration/initialize",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'user_id' => '<string>',
    'username' => '<string>',
    'icon' => '<string>',
    'display_name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apiKey: <apikey>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://passkeys.hanko.io/{tenant_id}/registration/initialize"

	payload := strings.NewReader("{\n  \"user_id\": \"<string>\",\n  \"username\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"display_name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apiKey", "<apikey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://passkeys.hanko.io/{tenant_id}/registration/initialize")
  .header("apiKey", "<apikey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"<string>\",\n  \"username\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"display_name\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://passkeys.hanko.io/{tenant_id}/registration/initialize")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["apiKey"] = '<apikey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"<string>\",\n  \"username\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"display_name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "publicKey": {
    "rp": {
      "name": "<string>",
      "id": "<string>"
    },
    "user": {
      "id": "<string>",
      "displayName": "<string>",
      "name": "<string>"
    },
    "challenge": "<string>",
    "pubKeyCredParams": [
      {
        "type": "public-key",
        "alg": 123
      }
    ],
    "timeout": 123,
    "excludeCredentials": [
      {
        "type": "public-key",
        "id": "<string>",
        "transports": []
      }
    ],
    "authenticatorSelection": {
      "requireResidentKey": false
    },
    "extensions": {
      "appid": "<string>",
      "appidExclude": "<string>",
      "credProps": true
    }
  }
}
{
  "title": [
    "explanatory title"
  ],
  "details": [
    "Information which helps resolving the problem"
  ],
  "status": 123
}
{
  "title": [
    "explanatory title"
  ],
  "details": [
    "Information which helps resolving the problem"
  ],
  "status": 123
}
{
  "title": [
    "explanatory title"
  ],
  "details": [
    "Information which helps resolving the problem"
  ],
  "status": 123
}

Headers

apiKey
string
required

Secret API key

Minimum string length: 32

Path Parameters

tenant_id
string<uuid>
required

UUID of the tenant

Required string length: 36
Example:
["1f496bcd-49da-4839-a02f-7ce681ccb488"]

Body

application/json
user_id
string
required
username
string
required
Maximum string length: 128
icon
string
display_name
string
Maximum string length: 128

Response

Example response

publicKey
object
required