Initiate device signature for any content internally (v1)

internalInitiateDeviceSigningGeneric

Overview

Creates a pending device signature.

Then, on the mobile app, the user has to complete the device signature process:

  • Retrieve the pending device signature using the external ‘Get pending device signatures’
  • Initiate the device signature using the external ‘Initiate pending device signature’ endpoint
  • Verify the device signature using the external ‘Verify pending device signature’ endpoint

After the verification is successful, the status can be polled internally using the ‘Confirm device signature’ endpoint.

POST (/internal/v1/mfa/device-signature:initiate)

Request Body

Responses

200 OK

400 Bad Request

404 Not Found

Architecture

4 properties
signableContent string
required

The content to be signed

confirmationMessage string
required

A confirmation message to be displayed to the user on the mobile app

username string
required

The username of the user who is performing the signing

source string
required

The source of the content to be signed

1 property
challengeId string
required

Challenge id for which the device signature is pending.

7 properties
code string
Allowed values: urn:plmr:mfa:device-signature:BAD_REQUEST urn:plmr:mfa:device-signature:RESOURCE_UNKNOWN urn:plmr:mfa:device-signature:UNAUTHORIZED urn:plmr:mfa:device-signature:FORBIDDEN urn:plmr:mfa:device-signature:DEVICE_NOT_FOUND urn:plmr:mfa:device-signature:INCORRECT_SIGNATURE urn:plmr:mfa:device-signature:STEP_UP_REQUEST_CONTEXT_NOT_FOUND urn:plmr:mfa:device-signature:USER_ID_DOES_NOT_MATCH_WITH_CHALLENGE_SUBJECT_USER_ID urn:plmr:mfa:device-signature:SIGNING_SESSION_NOT_INITIATED_OR_EXPIRED urn:plmr:mfa:device-signature:DEVICE_PASSCODE_SIGNING_NOT_ENABLED urn:plmr:mfa:device-signature:DEVICE_BIOMETRICS_SIGNING_NOT_ENABLED urn:plmr:mfa:device-signature:USER_NOT_FOUND urn:plmr:mfa:device-signature:SIGNING_CONFIRMATION_MESSAGE_TEMPLATE_NOT_FOUND urn:plmr:mfa:device-signature:SIGNING_CONFIRMATION_MESSAGE_TEMPLATE_EVALUATION_FAILED urn:plmr:mfa:device-signature:PENDING_DEVICE_SIGNATURE_ALREADY_EXISTS_FOR_CHALLENGE_ID urn:plmr:mfa:device-signature:PENDING_DEVICE_SIGNATURE_NOT_FOUND urn:plmr:mfa:device-signature:USER_ID_DOES_NOT_MATCH_WITH_CONTEXT_USER_ID urn:plmr:mfa:device-signature:DEVICE_ID_QUERY_PARAM_MANDATORY urn:plmr:mfa:device-signature:USER_ID_DOES_NOT_MATCH_WITH_DEVICE_USER
message string
requestId string
fieldErrors array [object]
7 properties
code string
Allowed values: urn:plmr:mfa:device-signature:BAD_REQUEST urn:plmr:mfa:device-signature:RESOURCE_UNKNOWN urn:plmr:mfa:device-signature:UNAUTHORIZED urn:plmr:mfa:device-signature:FORBIDDEN urn:plmr:mfa:device-signature:DEVICE_NOT_FOUND urn:plmr:mfa:device-signature:INCORRECT_SIGNATURE urn:plmr:mfa:device-signature:STEP_UP_REQUEST_CONTEXT_NOT_FOUND urn:plmr:mfa:device-signature:USER_ID_DOES_NOT_MATCH_WITH_CHALLENGE_SUBJECT_USER_ID urn:plmr:mfa:device-signature:SIGNING_SESSION_NOT_INITIATED_OR_EXPIRED urn:plmr:mfa:device-signature:DEVICE_PASSCODE_SIGNING_NOT_ENABLED urn:plmr:mfa:device-signature:DEVICE_BIOMETRICS_SIGNING_NOT_ENABLED urn:plmr:mfa:device-signature:USER_NOT_FOUND urn:plmr:mfa:device-signature:SIGNING_CONFIRMATION_MESSAGE_TEMPLATE_NOT_FOUND urn:plmr:mfa:device-signature:SIGNING_CONFIRMATION_MESSAGE_TEMPLATE_EVALUATION_FAILED urn:plmr:mfa:device-signature:PENDING_DEVICE_SIGNATURE_ALREADY_EXISTS_FOR_CHALLENGE_ID urn:plmr:mfa:device-signature:PENDING_DEVICE_SIGNATURE_NOT_FOUND urn:plmr:mfa:device-signature:USER_ID_DOES_NOT_MATCH_WITH_CONTEXT_USER_ID urn:plmr:mfa:device-signature:DEVICE_ID_QUERY_PARAM_MANDATORY urn:plmr:mfa:device-signature:USER_ID_DOES_NOT_MATCH_WITH_DEVICE_USER
message string
requestId string
fieldErrors array [object]