Get Package Verification
Business applications can use this service API to get verification results for all the digital signature fields of all documents in a single package.
|
https://api.signinghub.com/v3/packages/{package_id}/verification |
||
|
HTTP Verb |
GET |
|
|
Authorization |
Bearer {access_token} |
|
| x-base64 | false | |
|
Content-Type |
application/json |
|
|
Accept |
application/json |
|
|
Response Headers |
||
|
Request Body |
|
|
|
Status Code |
Message |
Response Body |
|
200 |
OK |
[ { "document_id":513318, "fields":[ { "field_name":"SH_SIGNATURE_884726", "signer_name":"John Smith", "signer_photo":null, "signer_photo_url":"http://qarc1:82/v3/settings/profile/general/photo/QUVTMjU2LUdDTbDQjd2u4uFreTWVJ5vCQ7dHu-2F-1", "signature_status":"valid", "signing_reason":"I approve this document", "signing_location":"England", "contact_information":"johnsimt@gmail.com", "signing_time":"2019-05-23 13:51:21 +05:00", "ltv":true, "qualified":false, "certified":false, "certify_permission":null, "timestamp_at":"2019-05-23 13:51:21 +05:00", "timestamp_authority":"Samples TSA Service Certificate", "subject_dn":"Aasim, Shehzad", "issuer_dn":"CN=ADSS Samples Test CA,OU=Ascertia Software Distribution,O=Ascertia Limited,C=GB", "cert_valid_from":"2019-05-22 17:05:04 +05:00", "cert_valid_to":"2020-05-22 17:05:04 +05:00", "signature_type":"PADES_PART4", "signature_application":"Ascertia", "signature_policy_id":0, "signature_policy_uri":null, "signature_algorithm":"SHA256", "signed_hash":"dd3ozz6hCJQIZX0CDBgDirtH/jBiH4OPVoLr+JDRIu0=", "display":"VISIBLE", "error_message":null } ] }, { "document_id":513317, "fields":[ { "field_name":"SH_SIGNATURE_350793", "signer_name":"John Smith", "signer_photo":null, "signer_photo_url":"http://qa-rc1:82/v3/settings/profile/general/photo/QUVTMjU2LUdDTfuAH1-2F-Q0v2-", "signature_status":"valid", "signing_reason":"I approve this document", "signing_location":"England", "contact_information":"johnsimt@gmail.com", "signing_time":"2019-05-23 13:51:10 +05:00", "ltv":true, "qualified":false, "certified":false, "certify_permission":null, "timestamp_at":"2019-05-23 13:51:10 +05:00", "timestamp_authority":"Samples TSA Service Certificate", "subject_dn":"Aasim, Shehzad", "issuer_dn":"CN=ADSS Samples Test CA,OU=Ascertia Software Distribution,O=Ascertia Limited,C=GB", "cert_valid_from":"2019-05-22 17:05:04 +05:00", "cert_valid_to":"2020-05-22 17:05:04 +05:00", "signature_type":"PADES_PART4", "signature_application":"Ascertia", "signature_policy_id":0, "signature_policy_uri":null, "signature_algorithm":"SHA256", "signed_hash":"d+RiP/T01bVsZRnEGAe4Kmon687CfpftrUNGjxrbUH8=", "display":"VISIBLE", "error_message":null } ] }] |
| 403 | Forbidden |
{ "Message": "Account is disabled"} |
|
500 |
Internal Server Error |
{ "Message": "An internal server error occurred while processing the request"} |
| Item Details | |
| Names |
Description |
| Request Parameters |
|
| access_token | The access token obtained as a result of successful authentication. If "scope" parameter was used in authentication request, then this service requires the access token to be obtained using the credentials of an Enterprise admin whose enterprise role has the application integration privileges. |
| x-base64 | True if response should have images in base64 format. False will only return the resource URLs in response. |
| package_id | Package ID of the package to which the document is added. |
| Response Parameters | |
| document_id | The ID of the document containing verification results of respective fields. |
| fields > field_name | Name of the field for which the verification was requested. |
| fields > signer_name | Name of the signer. |
| fields > signer_photo | Base64 image of the signer's avatar. |
| fields > signer_photo_url | API endpoint to access the resource |
| fields > signature_status | If the overall status of the signature is valid or not. Possible values are "VALID" or "INVALID". |
| fields > signing_reason | Reason provided by the user while signing the field. |
| fields > signing_location | Location entered by the user while signing the field. |
| fields >contact_information | Contact information entered by the user while signing the field. |
| fields > signing_time | Date and time of signing in 8601 format. Default timezone from SH Admin is followed the the time. |
| fields > ltv | True, if signature is LTV. |
| fields > qualified | True, if signatures are qualified. |
| fields > certified | True, if signatures are certified. |
| fields > certify_permission | Permission level for certified digital signature. |
| fields > timestamp_at | Date and time when signature was timestamped. |
| fields>timestamp_authority | Authority by which the signature was timestamped. |
| fields > subject_dn | Subject DN from the certificate used while signing the field. |
| fields > issuer_dn | Issuers DN from the certificate used while signing the field. |
| fields > cert_valid_from | Date and time from which the certificate is valid. |
| fields > cert_valid_to | Date and time to which the certificate is valid. |
| fields > signature_type | Type of signatures, possible values are "PADES_PART2" or "PADES_PART4". |
| fields >signature_algorithm | Signature algorithm used while signing the field. |
| fields > signed_hash | Hash of the document that was signed in respective signature. |
| fields > signature_application | Application name from where the field was signed. |
| fields > signature_policy_id | Signature policy ID. |
| fields >signature_policy_uri | Signature policy URI. |
| fields >display | Visibility of the signature field. |
| fields >error_message | Returns error in case verification fails. |
| Message |
The service specific error message returned by the API. This message provides useful information about why the service has returned an error response. |