API version: 2
Availability: DIGIPASS Gateway 5.10 and later
Authentication: Basic HTTP authentication using the front-end API key.
The getPreparedSignatureRequest service retrieves a prepared signature request for scan and sign. The respective signature request is identified by a request key previously received on the mobile device by scanning a Cronto image.
Only one application is allowed to retrieve the signature request. The request key is consumed by the first application retrieving the signature transaction message, subsequent attempts to retrieve it will fail with the STAT_NOT_FOUND status code.
Depending on the user’s choice the mobile application can either complete the signature request (see authSignature (service)) or cancel it (see cancelAuthSignatureRequest (service)).
URL
https://dpgateway_host:dpgateway_port/rest/v2/signature/scan/getPreparedSignatureRequest
Request
getPreparedSignatureRequest parameters | ||
Parameter name | Data type | Description |
|---|---|---|
requestKey | String | Required. The request key referring to the signature request previously generated by OneSpan Authentication Server and received by scanning a Cronto image. |
serialNumber | String | Required. The Digipass authenticator serial number, e.g. VDS1000120-1. |
Parameter names are case-sensitive.
Example
{
"requestKey": "8408980524",
"serialNumber": "VDS1000120-1"
}Response
getPreparedSignatureRequest return values | |
Return value | Description |
|---|---|
resultCodes | A JSON object that contains the return and status codes of the service. |
result | A JSON object that contains the actual signature request as a Secure Channel message (requestMessage). |
Example
{
"resultCodes":
{
"returnCodeEnum": "RET_SUCCESS",
"statusCodeEnum": "STAT_SUCCESS",
"returnCode": 0,
"statusCode": 0
},
"result":
{
"requestMessage": "00C1C3E40F42B8B36D836BE8A3CC1168…"
}
}