Skip to content
Authrim

Complete passkey registration.

POST
/api/account/passkeys/complete
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/account/passkeys/complete \
  --header 'Content-Type: application/json' \
  --cookie authrim_session=<authrim_session> \
  --data '{ "challenge_id": "example", "passkey_response": { "additionalProperty": "example" }, "device_name": "example" }'

Verifies a WebAuthn registration response against the stored challenge and registers the passkey for the authenticated Account Page user.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
challenge_id
required
string
passkey_response
required
object
key
additional properties
device_name
string
<= 100 characters
Example generated
{
  "challenge_id": "example",
  "passkey_response": {
    "additionalProperty": "example"
  },
  "device_name": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Account Page passkey creation response.

Media type application/json
object
ok
required
boolean
passkey
required
object
id
required
string
device_name
required
string | null
aaguid
required

Display-only WebAuthn authenticator AAGUID. Do not use for trust decisions.

string | null
provider
required
One of:
object
aaguid
required
string
name
required
string | null
icon_dark
required

Display-only data URI icon for dark backgrounds when available.

string | null
icon_light
required

Display-only data URI icon for light backgrounds when available.

string | null
known
required
boolean
created_at
required
integer
last_used_at
required
integer | null
webauthn_signal

Best-effort WebAuthn Signal API data for authenticated Account Page browser sessions. Credential IDs are exposed only in this authenticated self-service response and are intended for PublicKeyCredential.signalAllAcceptedCredentials().

object
rp_id
required
string
user_id
required

Base64url-encoded WebAuthn user handle.

string
credential_ids
required

Base64url-encoded credential IDs accepted by the server for this user.

Array<string>
Example 
{
  "webauthn_signal": {
    "rp_id": "login.example.com",
    "user_id": "dXNlci0xMjM"
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
error_code

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
error_code

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
error_code

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

409

Section titled “409 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
error_code

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}