Retrieves a signature session's details
Overview
When a user is redirected back to your application at the end of a signature session, a query parameter is appended to the returnUrl containing the ID of the signature session, i.e. ?signatureSessionId=.... Your app must get this parameter and use it to call this API, which will return information about the session, mainly its status and documents.
Statuses
When a user is redirected back to your app, the session will have one of two possible statuses: Completed or UserCancelled. You should always check the status, since it is perfecly normal for a user to land back on your app by cancelling the session instead of going through the procedure.
Statuses (when background processing is enabled)
If you enabled background processing of the session by passing EnableBackgroundProcessing = true when creating the session, then two additional statuses are possible: Processing and ProcessingError.
While a session is still Processing, some documents will be in status Processing and cannot be downloaded. Only when the session transitions to the Complete status are all documents ready to be downloaded.
The status ProcessingError is a rare condition that occurrs only in corner cases such as the user's certificate being revoked during the time between the start of the session and the completion of the background processing. It is perfectly appropriate for your app to throw if this status is returned.
Downloading signed files
The signed files are not returned on the body of the response. Instead, a location is given for each file which must be invoked to get the actual files' contents (see DocumentFileModel).
Request
- Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
- URL: /api/signature-sessions/{id}
- Auth: none declared
Path parameters
Response
Success
Example response
{
"signerCertificate": {
"serialNumber": "serialNumber",
"issuerName": {
"country": "country",
"commonName": "commonName",
"serialNumber": "serialNumber",
"initials": "initials",
"dnString": "dnString",
"givenName": "givenName",
"locality": "locality",
"organizationUnit": "organizationUnit",
"title": "title",
"pseudonym": "pseudonym",
"emailAddress": "emailAddress",
"dnQualifier": "dnQualifier",
"stateName": "stateName",
"surname": "surname",
"organization": "organization",
"generationQualifier": "generationQualifier",
"allValues": {
"key": [
"allValues",
"allValues"
]
}
},
"validityEnd": "2000-01-23T04:56:07.000+00:00",
"thumbprint": "thumbprint",
"pkiBrazil": {
"rgEmissor": "rgEmissor",
"oabNumero": "oabNumero",
"rgNumero": "rgNumero",
"companyName": "companyName",
"cpf": "cpf",
"oabUF": "oabUF",
"dateOfBirth": "dateOfBirth",
"rgEmissorUF": "rgEmissorUF",
"cnpj": "cnpj",
"responsavel": "responsavel",
"certificateType": "Unknown"
},
"validityStart": "2000-01-23T04:56:07.000+00:00",
"issuer": null,
"binaryThumbprintSHA256": "binaryThumbprintSHA256",
"emailAddress": "emailAddress",
"pkiItaly": {
"idCarta": "idCarta",
"codiceFiscale": "codiceFiscale",
"certificateType": "Undefined"
},
"organizationIdentifier": "organizationIdentifier",
"issuerDisplayName": "issuerDisplayName",
"organization": "organization",
"subjectIdentifier": "subjectIdentifier",
"subjectCommonName": "subjectCommonName",
"thumbprintSHA256": "thumbprintSHA256",
"subjectDisplayName": "subjectDisplayName",
"subjectName": {
"country": "country",
"commonName": "commonName",
"serialNumber": "serialNumber",
"initials": "initials",
"dnString": "dnString",
"givenName": "givenName",
"locality": "locality",
"organizationUnit": "organizationUnit",
"title": "title",
"pseudonym": "pseudonym",
"emailAddress": "emailAddress",
"dnQualifier": "dnQualifier",
"stateName": "stateName",
"surname": "surname",
"organization": "organization",
"generationQualifier": "generationQualifier",
"allValues": {
"key": [
"allValues",
"allValues"
]
}
}
},
"callbackArgument": "callbackArgument",
"documents": [
{
"availableUntil": "2000-01-23T04:56:07.000+00:00",
"originalFile": {
"name": "name",
"length": 0,
"location": "location",
"mimeType": "mimeType",
"contentType": "contentType",
"content": "content",
"url": "url",
"blobToken": "blobToken"
},
"markedFile": {
"name": "name",
"length": 0,
"location": "location",
"mimeType": "mimeType",
"contentType": "contentType",
"content": "content",
"url": "url",
"blobToken": "blobToken"
},
"signatureType": "Pdf",
"signedFile": {
"name": "name",
"length": 0,
"location": "location",
"mimeType": "mimeType",
"contentType": "contentType",
"content": "content",
"url": "url",
"blobToken": "blobToken"
},
"id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"dateSigned": "2000-01-23T04:56:07.000+00:00",
"key": "key",
"formattedKey": "formattedKey",
"status": "PendingSignature"
},
{
"availableUntil": "2000-01-23T04:56:07.000+00:00",
"originalFile": {
"name": "name",
"length": 0,
"location": "location",
"mimeType": "mimeType",
"contentType": "contentType",
"content": "content",
"url": "url",
"blobToken": "blobToken"
},
"markedFile": {
"name": "name",
"length": 0,
"location": "location",
"mimeType": "mimeType",
"contentType": "contentType",
"content": "content",
"url": "url",
"blobToken": "blobToken"
},
"signatureType": "Pdf",
"signedFile": {
"name": "name",
"length": 0,
"location": "location",
"mimeType": "mimeType",
"contentType": "contentType",
"content": "content",
"url": "url",
"blobToken": "blobToken"
},
"id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"dateSigned": "2000-01-23T04:56:07.000+00:00",
"key": "key",
"formattedKey": "formattedKey",
"status": "PendingSignature"
}
],
"id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"processingErrorCode": "processingErrorCode",
"status": "Pending"
}Changes
No recorded changes to this operation across all 1 revision of this API.