Skip to Content

PasskeyAuthenticationApi

All URIs are relative to https://business.apis.kesk.app/v1 

MethodHTTP requestDescription
completePasskeyAuthenticationPOST /passkeys/authenticate/completeComplete passkey authentication
completePasskeyRegistrationPOST /passkeys/register/completeComplete passkey registration
deletePasskeyDELETE /passkeys/{id}Delete registered passkey
initiatePasskeyAuthenticationPOST /passkeys/authenticate/initiateInitiate passkey authentication
initiatePasskeyRegistrationPOST /passkeys/register/initiateInitiate passkey registration
listPasskeysGET /passkeysList user’s registered passkeys

completePasskeyAuthentication

LoginSuccessResponse completePasskeyAuthentication(PasskeyAuthenticationResponse)

Complete passkey authentication

Verifies the authenticator’s signature and completes the login process. Validates the cryptographic assertion against the stored public key and issues a JWT token upon success, granting the user access to their account.

Parameters

NameTypeDescriptionNotes
PasskeyAuthenticationResponsePasskeyAuthenticationResponseAuthentication response containing authenticator assertion

Return type

LoginSuccessResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

completePasskeyRegistration

PasskeyInfo completePasskeyRegistration(PasskeyRegistrationResponse)

Complete passkey registration

Verifies the authenticator’s response and stores the new passkey credential. Validates the cryptographic attestation from the client and persists the public key for future authentication. Returns the registered passkey details.

Parameters

NameTypeDescriptionNotes
PasskeyRegistrationResponsePasskeyRegistrationResponseRegistration response containing authenticator attestation

Return type

PasskeyInfo

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

deletePasskey

EmptyResponse deletePasskey(id)

Delete registered passkey

Removes a specific passkey from the user’s account authentication methods. Users should maintain multiple passkeys to prevent account lockout. This operation is permanent and requires re-registration to restore the passkey.

Parameters

NameTypeDescriptionNotes
idLongUnique identifier of the passkey to delete[default to null]

Return type

EmptyResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

initiatePasskeyAuthentication

PasskeyAuthenticationChallengeResponse initiatePasskeyAuthentication(PasskeyAuthenticationRequest)

Initiate passkey authentication

Starts the WebAuthn authentication ceremony by generating a cryptographic challenge. Returns challenge data and allowed credentials that the client uses to prompt the user’s authenticator for signature-based authentication without a password.

Parameters

NameTypeDescriptionNotes
PasskeyAuthenticationRequestPasskeyAuthenticationRequestAuthentication request containing user identifier

Return type

PasskeyAuthenticationChallengeResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

initiatePasskeyRegistration

PasskeyRegistrationChallengeResponse initiatePasskeyRegistration(PasskeyRegistrationRequest)

Initiate passkey registration

Starts the WebAuthn registration ceremony by generating a cryptographic challenge. Returns challenge data and registration options that the client uses to create a new passkey credential with the user’s authenticator (device biometrics or security key).

Parameters

NameTypeDescriptionNotes
PasskeyRegistrationRequestPasskeyRegistrationRequestRegistration request containing device information

Return type

PasskeyRegistrationChallengeResponse

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

listPasskeys

PaginatedResponse_PasskeyInfo listPasskeys(page, per_page)

List user’s registered passkeys

Retrieves all passkeys registered to the authenticated user’s account. Returns device names, creation dates, and last usage information for each registered passkey to help users manage their authentication methods.

Parameters

NameTypeDescriptionNotes
pageInteger[optional] [default to null]
per_pageInteger[optional] [default to null]

Return type

PaginatedResponse_PasskeyInfo

Authorization

JwtAuthScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8