--- title: "AAL2ProcMessageResponseICSF" slug: "a3s-cppprg-icsf-zos-aal2procmessageresponseicsf-4-0" updated: 2026-11-11T09:54:58Z published: 2026-11-11T09:54:58Z canonical: "docs.onespan.com/a3s-cppprg-icsf-zos-aal2procmessageresponseicsf-4-0" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.onespan.com/llms.txt > Use this file to discover all available pages before exploring further. # AAL2ProcMessageResponseICSF > The request message generation functionality is applicable: > > - To hardware or software Digipass authenticators compliant with the multi-device two-step activation (in the context of multi-device licensing) and if the Secure Channel feature has been ordered (configured by OneSpan at the time of order). > - To hardware Digipass authenticators based on the single-device licensing model and able to perform operations based on the Secure Channel protocol. > > For more information, refer to the [Authentication Suite Server SDK Product Guide](/secsdks/docs/a3s-product-guide-4-0). ## Function prototype ```cpp aat_int32 AAL2ProcMessageResponseICSF ( aat_ascii *PKBlob, TKernelParms *CallParms, aat_ascii *aStorageKeyNameIn, aat_ascii *aInitialVectorIn, aat_ascii *ResponseMessage, aat_ascii *RequestMessage, aat_ascii *ResponseBody, aat_int32 *ResponseBodyLength); ``` ## Description This function is used to extract a clear response body from a response message, using the payload key embedded into the payload key BLOB. The payload key BLOB, mandatory only if the response message is protected (encrypted and/or signed) must be mandatorily the one corresponding to the Digipass serial number of the client device that generated the response message. For Digipass client devices supporting the two-way Secure Channel, the response message will be sent back by the device as a reply to a request message. > Response message processing is only applicable to hardware and software Digipass authenticators compliant with the Secure Channel protocol. If the response message was correctly processed and contains a Secure Channel request error that is detected by the device, the return code is dependent on the Secure Channel request error code byte (return code = offset + code byte with offset = 5000). See the list of return codes in [Table: Return codes (AAL2ProcMessageResponseICSF)](/secsdks/docs/a3s-cppprg-icsf-zos-aal2procmessageresponseicsf-4-0#TAB_AAL2ProcMsgRspnsICSF_return_codes) for more details. ## Parameters | Type | Name | Use | Description | | --- | --- | --- | --- | | aat_ascii * | PKBlob | I | Contains the payload key BLOB that has been generated for the Digipass instances activated with a particular serial number license (in case of the multi-device licensing model) or that has been imported for the Digipass authenticator with a particular serial number license (in case of single-device licensing model). The payload key BLOB parameter is mandatory only if the information message is protected (encrypted and/or signed); can be NULL or empty if the information message is not protected (neither encrypted nor signed). | | TKernelParms * | CallParms | I | Structure of runtime parameters to use during this function call. | | aat_ascii * | aStorageKeyNameIn | I | String of up to 64+1 characters, left-justified, null-terminated, or right-padded with spaces. This is the label of the ICSF storage key used to encrypt the sensitive Digipass application BLOB data. | | aat_ascii * | aInitialVectorIn | I | String of 16 or 32 hexadecimal characters, left-justified, null-terminated. This is the initial vector used to encrypt the sensitive authenticator application BLOB data. | | aat_ascii * | ResponseMessage | I | Hexadecimal character string containing the response message that has been generated by the Digipass client device in reply to a request message. The string length must be a multiple of 2 with a maximum length of 1070 characters. | | aat_ascii * | RequestMessage | I | Hexadecimal character string containing the request message that has been used by the Digipass device to generate the response message. String length must be multiple of 2 with a maximum length of 1070 characters. | | aat_ascii * | ResponseBody | O | String of up to 1024+1 hexadecimal characters, null-terminated. In case of a successful operation, this parameter contains the clear response body extracted from the ResponseMessage. | | aat_int32 * | ResponseBodyLength | I/O | In input, this parameter must indicate the size of the allocated buffer for the ResponseBody parameter (recommended are 1025 bytes). In output, this parameter indicates the length of the RequestBody string (without the null-terminated character). | ## Return codes | Code | Meaning | Code | Meaning | | --- | --- | --- | --- | | 0 | Success | 1348 | Invalid response message pointer | | 412 | Invalid checksum | 1349 | Invalid response body pointer | | 413 | Invalid Base64 format | 1350 | Invalid response body length pointer | | 807 | Serial number not equal | 1351 | Response body buffer too small | | 951 | Invalid HSM key type for HSM decryption | 1352 | Nonces are not equal | | 1119 | Unsupported payload key BLOB | 1353 | Payload key BLOB is mandatory | | 1285 | Master key derivation failed | 1354 | Invalid request message type | | 1288 | Invalid serial number prefix | 1355 | Invalid response message type | | 1289 | Invalid serial number suffix | 1361 | Invalid authentication tag | | 1302 | AES CTR encryption failed | 1362 | Invalid response message error length | | 1303 | Invalid request message pointer | 5001[[1]](/secsdks/docs/a3s-cppprg-icsf-zos-aal2procmessageresponseicsf-4-0#Cite_1) | Unsupported request message protocol version | | 1337 | Unsupported message protocol version | 5002[[1]](/secsdks/docs/a3s-cppprg-icsf-zos-aal2procmessageresponseicsf-4-0#Cite_1) | Unsupported request message type | | 1338 | Unsupported message type | 5003[[1]](/secsdks/docs/a3s-cppprg-icsf-zos-aal2procmessageresponseicsf-4-0#Cite_1) | Unsupported request message protection type | | 1341 | Message is not hexadecimal | 5004[[1]](/secsdks/docs/a3s-cppprg-icsf-zos-aal2procmessageresponseicsf-4-0#Cite_1) | Invalid request message length | | 1342 | Invalid response message length | 5005[[1]](/secsdks/docs/a3s-cppprg-icsf-zos-aal2procmessageresponseicsf-4-0#Cite_1) | Invalid request message; character not hexadecimal | | 1344 | Invalid request message length | 5006[[1]](/secsdks/docs/a3s-cppprg-icsf-zos-aal2procmessageresponseicsf-4-0#Cite_1) | Incorrect serial number in the request message | | 1345 | Invalid request message protection type | 5007[[1]](/secsdks/docs/a3s-cppprg-icsf-zos-aal2procmessageresponseicsf-4-0#Cite_1) | Invalid authentication tag in the request message | | 1346 | Invalid message response protection type | | | 1. Specific request error message codes