confirmSkIdSmartIdSigningChallenge (v1)

Confirm SK-ID Smart-ID signing challenge

Query POST tag:SK-ID Smart-ID signing

Overview

Confirms SK-ID Smart-ID signing challenge.

This will trigger notification to user’s phone with prompt to confirm signing. Then get the signature, verify it and save. Note: This endpoint should be polled repeatedly whenever a SK_ID_SIGNING_NOT_YET_COMPLETED_EXCEPTION error response is returned. Continue polling until either:

  • a successful response (204 No Content) is received, indicating signing has completed, or
  • a different error response is returned, which means the signing process has failed and polling must stop.

POST (/internal/v1/mfa/sk-id/smart-id/signature/{challengeId}:confirm)

Parameters

  • challengeId (path) (required): The ID of the challenge.

Responses

400 Bad Request

401 Unauthorized

404 Not Found

500 Internal Server Error

Architecture

7 properties
code string
Allowed values: urn:plmr:mfa:sk-id:api:USER_NOT_FOUND urn:plmr:mfa:sk-id:api:USER_MISSING_REQUIRED_DETAILS urn:plmr:mfa:sk-id:api:SK_ID_COMMUNICATION_FAILURE urn:plmr:mfa:sk-id:api:STEP_UP_REQUEST_CONTEXT_NOT_FOUND urn:plmr:mfa:sk-id:api:SIGNING_CONFIRMATION_MESSAGE_TEMPLATE_NOT_FOUND urn:plmr:mfa:sk-id:api:SIGNING_CONFIRMATION_MESSAGE_TEMPLATE_EVALUATION_FAILED urn:plmr:mfa:sk-id:api:SIGNING_SESSION_NOT_FOUND urn:plmr:mfa:sk-id:api:SIGNING_SESSION_ALREADY_INITIATED urn:plmr:mfa:sk-id:api:SK_ID_WRONG_VERIFICATION_CODE urn:plmr:mfa:sk-id:api:SK_ID_USER_REFUSED urn:plmr:mfa:sk-id:api:SK_ID_TIMEOUT urn:plmr:mfa:sk-id:api:SK_ID_USER_NOT_MID_CLIENT urn:plmr:mfa:sk-id:api:SK_ID_USER_CANCELED urn:plmr:mfa:sk-id:api:SK_ID_DOCUMENT_UNUSABLE urn:plmr:mfa:sk-id:api:SK_ID_PHONE_ABSENT urn:plmr:mfa:sk-id:api:SK_ID_DELIVERY_ERROR urn:plmr:mfa:sk-id:api:SK_ID_SIM_ERROR urn:plmr:mfa:sk-id:api:SK_ID_SIGNATURE_HASH_MISMATCH urn:plmr:mfa:sk-id:api:SK_ID_INTERACTION_NOT_SUPPORTED urn:plmr:mfa:sk-id:api:SK_ID_USER_CANCELED_VERIFICATION_CODE_AND_MESSAGE urn:plmr:mfa:sk-id:api:SK_ID_USER_DOES_NOT_EXISTS urn:plmr:mfa:sk-id:api:USER_ID_DOES_NOT_MATCH_WITH_CHALLENGE_SUBJECT_USER_ID urn:plmr:mfa:sk-id:api:SK_ID_UNKNOWN_RESPONSE urn:plmr:mfa:sk-id:api:SK_ID_SIGNATURE_VERIFICATION_FAILURE urn:plmr:mfa:sk-id:api:SK_ID_SIGNING_INITIATION_FAILURE urn:plmr:mfa:sk-id:api:SK_ID_SIGNING_NOT_YET_COMPLETED_EXCEPTION urn:plmr:mfa:sk-id:api:NOT_SUPPORTED_SK_ID_TYPE urn:plmr:mfa:sk-id:api:INVALID_PERSONAL_ID urn:plmr:mfa:sk-id:api:INVALID_PHONE_NUMBER urn:plmr:mfa:sk-id:api:BAD_REQUEST
message string
requestId string
fieldErrors array [object]
7 properties
code string
Allowed values: urn:plmr:mfa:sk-id:api:USER_NOT_FOUND urn:plmr:mfa:sk-id:api:USER_MISSING_REQUIRED_DETAILS urn:plmr:mfa:sk-id:api:SK_ID_COMMUNICATION_FAILURE urn:plmr:mfa:sk-id:api:STEP_UP_REQUEST_CONTEXT_NOT_FOUND urn:plmr:mfa:sk-id:api:SIGNING_CONFIRMATION_MESSAGE_TEMPLATE_NOT_FOUND urn:plmr:mfa:sk-id:api:SIGNING_CONFIRMATION_MESSAGE_TEMPLATE_EVALUATION_FAILED urn:plmr:mfa:sk-id:api:SIGNING_SESSION_NOT_FOUND urn:plmr:mfa:sk-id:api:SIGNING_SESSION_ALREADY_INITIATED urn:plmr:mfa:sk-id:api:SK_ID_WRONG_VERIFICATION_CODE urn:plmr:mfa:sk-id:api:SK_ID_USER_REFUSED urn:plmr:mfa:sk-id:api:SK_ID_TIMEOUT urn:plmr:mfa:sk-id:api:SK_ID_USER_NOT_MID_CLIENT urn:plmr:mfa:sk-id:api:SK_ID_USER_CANCELED urn:plmr:mfa:sk-id:api:SK_ID_DOCUMENT_UNUSABLE urn:plmr:mfa:sk-id:api:SK_ID_PHONE_ABSENT urn:plmr:mfa:sk-id:api:SK_ID_DELIVERY_ERROR urn:plmr:mfa:sk-id:api:SK_ID_SIM_ERROR urn:plmr:mfa:sk-id:api:SK_ID_SIGNATURE_HASH_MISMATCH urn:plmr:mfa:sk-id:api:SK_ID_INTERACTION_NOT_SUPPORTED urn:plmr:mfa:sk-id:api:SK_ID_USER_CANCELED_VERIFICATION_CODE_AND_MESSAGE urn:plmr:mfa:sk-id:api:SK_ID_USER_DOES_NOT_EXISTS urn:plmr:mfa:sk-id:api:USER_ID_DOES_NOT_MATCH_WITH_CHALLENGE_SUBJECT_USER_ID urn:plmr:mfa:sk-id:api:SK_ID_UNKNOWN_RESPONSE urn:plmr:mfa:sk-id:api:SK_ID_SIGNATURE_VERIFICATION_FAILURE urn:plmr:mfa:sk-id:api:SK_ID_SIGNING_INITIATION_FAILURE urn:plmr:mfa:sk-id:api:SK_ID_SIGNING_NOT_YET_COMPLETED_EXCEPTION urn:plmr:mfa:sk-id:api:NOT_SUPPORTED_SK_ID_TYPE urn:plmr:mfa:sk-id:api:INVALID_PERSONAL_ID urn:plmr:mfa:sk-id:api:INVALID_PHONE_NUMBER urn:plmr:mfa:sk-id:api:BAD_REQUEST
message string
requestId string
fieldErrors array [object]
7 properties
code string
Allowed values: urn:plmr:mfa:sk-id:api:USER_NOT_FOUND urn:plmr:mfa:sk-id:api:USER_MISSING_REQUIRED_DETAILS urn:plmr:mfa:sk-id:api:SK_ID_COMMUNICATION_FAILURE urn:plmr:mfa:sk-id:api:STEP_UP_REQUEST_CONTEXT_NOT_FOUND urn:plmr:mfa:sk-id:api:SIGNING_CONFIRMATION_MESSAGE_TEMPLATE_NOT_FOUND urn:plmr:mfa:sk-id:api:SIGNING_CONFIRMATION_MESSAGE_TEMPLATE_EVALUATION_FAILED urn:plmr:mfa:sk-id:api:SIGNING_SESSION_NOT_FOUND urn:plmr:mfa:sk-id:api:SIGNING_SESSION_ALREADY_INITIATED urn:plmr:mfa:sk-id:api:SK_ID_WRONG_VERIFICATION_CODE urn:plmr:mfa:sk-id:api:SK_ID_USER_REFUSED urn:plmr:mfa:sk-id:api:SK_ID_TIMEOUT urn:plmr:mfa:sk-id:api:SK_ID_USER_NOT_MID_CLIENT urn:plmr:mfa:sk-id:api:SK_ID_USER_CANCELED urn:plmr:mfa:sk-id:api:SK_ID_DOCUMENT_UNUSABLE urn:plmr:mfa:sk-id:api:SK_ID_PHONE_ABSENT urn:plmr:mfa:sk-id:api:SK_ID_DELIVERY_ERROR urn:plmr:mfa:sk-id:api:SK_ID_SIM_ERROR urn:plmr:mfa:sk-id:api:SK_ID_SIGNATURE_HASH_MISMATCH urn:plmr:mfa:sk-id:api:SK_ID_INTERACTION_NOT_SUPPORTED urn:plmr:mfa:sk-id:api:SK_ID_USER_CANCELED_VERIFICATION_CODE_AND_MESSAGE urn:plmr:mfa:sk-id:api:SK_ID_USER_DOES_NOT_EXISTS urn:plmr:mfa:sk-id:api:USER_ID_DOES_NOT_MATCH_WITH_CHALLENGE_SUBJECT_USER_ID urn:plmr:mfa:sk-id:api:SK_ID_UNKNOWN_RESPONSE urn:plmr:mfa:sk-id:api:SK_ID_SIGNATURE_VERIFICATION_FAILURE urn:plmr:mfa:sk-id:api:SK_ID_SIGNING_INITIATION_FAILURE urn:plmr:mfa:sk-id:api:SK_ID_SIGNING_NOT_YET_COMPLETED_EXCEPTION urn:plmr:mfa:sk-id:api:NOT_SUPPORTED_SK_ID_TYPE urn:plmr:mfa:sk-id:api:INVALID_PERSONAL_ID urn:plmr:mfa:sk-id:api:INVALID_PHONE_NUMBER urn:plmr:mfa:sk-id:api:BAD_REQUEST
message string
requestId string
fieldErrors array [object]
7 properties
code string
Allowed values: urn:plmr:mfa:sk-id:api:USER_NOT_FOUND urn:plmr:mfa:sk-id:api:USER_MISSING_REQUIRED_DETAILS urn:plmr:mfa:sk-id:api:SK_ID_COMMUNICATION_FAILURE urn:plmr:mfa:sk-id:api:STEP_UP_REQUEST_CONTEXT_NOT_FOUND urn:plmr:mfa:sk-id:api:SIGNING_CONFIRMATION_MESSAGE_TEMPLATE_NOT_FOUND urn:plmr:mfa:sk-id:api:SIGNING_CONFIRMATION_MESSAGE_TEMPLATE_EVALUATION_FAILED urn:plmr:mfa:sk-id:api:SIGNING_SESSION_NOT_FOUND urn:plmr:mfa:sk-id:api:SIGNING_SESSION_ALREADY_INITIATED urn:plmr:mfa:sk-id:api:SK_ID_WRONG_VERIFICATION_CODE urn:plmr:mfa:sk-id:api:SK_ID_USER_REFUSED urn:plmr:mfa:sk-id:api:SK_ID_TIMEOUT urn:plmr:mfa:sk-id:api:SK_ID_USER_NOT_MID_CLIENT urn:plmr:mfa:sk-id:api:SK_ID_USER_CANCELED urn:plmr:mfa:sk-id:api:SK_ID_DOCUMENT_UNUSABLE urn:plmr:mfa:sk-id:api:SK_ID_PHONE_ABSENT urn:plmr:mfa:sk-id:api:SK_ID_DELIVERY_ERROR urn:plmr:mfa:sk-id:api:SK_ID_SIM_ERROR urn:plmr:mfa:sk-id:api:SK_ID_SIGNATURE_HASH_MISMATCH urn:plmr:mfa:sk-id:api:SK_ID_INTERACTION_NOT_SUPPORTED urn:plmr:mfa:sk-id:api:SK_ID_USER_CANCELED_VERIFICATION_CODE_AND_MESSAGE urn:plmr:mfa:sk-id:api:SK_ID_USER_DOES_NOT_EXISTS urn:plmr:mfa:sk-id:api:USER_ID_DOES_NOT_MATCH_WITH_CHALLENGE_SUBJECT_USER_ID urn:plmr:mfa:sk-id:api:SK_ID_UNKNOWN_RESPONSE urn:plmr:mfa:sk-id:api:SK_ID_SIGNATURE_VERIFICATION_FAILURE urn:plmr:mfa:sk-id:api:SK_ID_SIGNING_INITIATION_FAILURE urn:plmr:mfa:sk-id:api:SK_ID_SIGNING_NOT_YET_COMPLETED_EXCEPTION urn:plmr:mfa:sk-id:api:NOT_SUPPORTED_SK_ID_TYPE urn:plmr:mfa:sk-id:api:INVALID_PERSONAL_ID urn:plmr:mfa:sk-id:api:INVALID_PHONE_NUMBER urn:plmr:mfa:sk-id:api:BAD_REQUEST
message string
requestId string
fieldErrors array [object]