Sign in

v1

latestOpenAPI 3.1.02026-07-268342124.0 KB
Passkeys

Verify Registration

Finish the process of registering a new passkey authenticator.

post/user-authenticators/passkey

Request body

challengeIdstring required

The ID of the passkey challenge returned when generating registration options.

registrationCredentialobject required

The registration credential object, based on https://w3c.github.io/webauthn/#dictdef-registrationresponsejson.

conditionalCreateboolean

Whether the registration used the automatic passkey upgrade / conditional create flow.

Response

OK

isVerifiedboolean required

True if the passkey challenge was valid and the device was enrolled successfully.

accessTokenstring

A new short-term token with scopes to manage authenticators (e.g. add secondary authenticators, remove authenticators, view or regenerate recovery codes). Only present if the challenge succeeded.

userAuthenticatorIdstring

The ID of the user's new authenticator which is associated with the passkey credential.

userIdstring

The ID of the Authsignal user associated with the passkey.

Example response

{
  "userAuthenticator": {
    "userAuthenticatorId": "4efd2d0d-3278-4e03-8143-d9a0850bebc0",
    "verificationMethod": "PASSKEY",
    "username": "jane.smith@authsignal.com",
    "displayName": "Jane Smith",
    "createdAt": "2024-05-13T04:59:02.640Z",
    "lastVerifiedAt": "2024-07-13T02:43:37.640Z",
    "verifiedAt": "2024-05-13T04:59:17.640Z",
    "webauthnCredential": {
      "credentialId": "71273a99-4a7b-47d4-82ab-9ea72b8f0a72",
      "deviceId": "d5a13d2d-8c34-4c90-938b-d8c6e3a88c5d",
      "name": "iCloud Keychain",
      "aaguid": "fbfc3007-154e-4ecc-8c0b-6e020557d7bd",
      "aaguidMapping": {
        "name": "iCloud Keychain",
        "svgIconDark": "data:image/svg+xml;base64...",
        "svgIconLight": "data:image/svg+xml;base64..."
      },
      "credentialBackedUp": true,
      "credentialDeviceType": "multiDevice",
      "authenticatorAttachment": "platform"
    }
  }
}