initiateSkIdSmartIdGenericSigningChallenge (v2)
Initiate Smart-ID signing challenge
Overview
Initiates SK-ID Smart-ID signing challenge.
This endpoint initiates the document signing process and returns the current signing session status together with the challengeId. Challenge id should be used in subsequent confirm endpoint.
- When the status is
PENDING_CODE, the signing session is not fully initialized and the verification code is not present in the response. - When the status is
PENDING_SIGNATURE, the signing session is fully initialized and the response includes a verification code that the end user must confirm in the SK-ID Smart-ID application.
POST (/internal/v2/mfa/sk-id/smart-id/signature:initiate)
Request Body
Responses
200 OK
400 Bad Request
401 Unauthorized
404 Not Found
500 Internal Server Error
Architecture
signableContent string
requiredBase64 content that will be signed by Smart-ID
confirmationMessage string
Text shown to the user during Smart-ID confirmation
username string
requiredName of the user inside Plumery system
source string
requiredThe path of the resource which needs to be signed(e.g. /api/v1/documents/1234567890)
No properties match your search
Try a different search term or clear the search to see all properties
challengeId string
requiredverificationCode string
status string
requiredAllowed values:
PENDING_CODE PENDING_SIGNINGNo properties match your search
Try a different search term or clear the search to see all 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:INCORRECT_SK_ID_TYPE 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_REQUESTmessage string
requestId string
fieldErrors array [object]
Item Details:
code string
Allowed values:
urn:plmr:mfa:sk-id:NOT_BLANK urn:plmr:mfa:sk-id:NOT_NULLmessage string
field string
No properties match your search
Try a different search term or clear the search to see all 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:INCORRECT_SK_ID_TYPE 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_REQUESTmessage string
requestId string
fieldErrors array [object]
Item Details:
code string
Allowed values:
urn:plmr:mfa:sk-id:NOT_BLANK urn:plmr:mfa:sk-id:NOT_NULLmessage string
field string
No properties match your search
Try a different search term or clear the search to see all 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:INCORRECT_SK_ID_TYPE 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_REQUESTmessage string
requestId string
fieldErrors array [object]
Item Details:
code string
Allowed values:
urn:plmr:mfa:sk-id:NOT_BLANK urn:plmr:mfa:sk-id:NOT_NULLmessage string
field string
No properties match your search
Try a different search term or clear the search to see all 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:INCORRECT_SK_ID_TYPE 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_REQUESTmessage string
requestId string
fieldErrors array [object]
Item Details:
code string
Allowed values:
urn:plmr:mfa:sk-id:NOT_BLANK urn:plmr:mfa:sk-id:NOT_NULLmessage string
field string
No properties match your search
Try a different search term or clear the search to see all properties