Get Document Verification
|
https://api.signinghub.com/v3/packages/{package_id}/documents/{document_id}/verification |
||
|
HTTP Verb |
GET |
|
|
Authorization |
Bearer {access_token} |
|
| x-base64 | true | |
|
Content-Type |
application/json |
|
|
Accept |
application/json |
|
|
Response Headers |
||
|
Request Body |
|
|
|
Status Code |
Message |
Response Body |
|
200 |
OK |
[ { "field_name": "SH", "signer_name": "John Smith", "signer_photo": "base64", "signer_photo_url": "https://api_link_to_resource", "signature_status": "VALID", "signing_reason": "I approve this document", "signing_location": "United Kingdom", "contact_information": "", "signing_time": "2015-09-08 07:29:33", "ltv": true, "qualified": false, "certified": false, "certify_permission": "NO_CHANGES_ALLOWED", "timestamp_at": "2015-09-08 07:29:35", "timestamp_authority": "Ascertia", "subject_dn": "CN=John Smith", "issuer_dn": "O=Ascertia,CN=Ascertia Docs CA 1", "cert_valid_from": "2015-05-04 07:40:28", "cert_valid_to": "2020-05-04 07:40:28", "signature_type": "PADES_PART2", "signature_algorithm": "SHA256", "signature_application": "Ascertia", "signature_policy_id": 0, "signature_policy_uri": 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. |
| document_id |
The ID of the document to be downloaded. |
| package_id | Package ID of the package to which the document is added. |
| Response Parameters | |
| field_name | Name of the field for which the verification was requested. |
| signer_name | Name of the signer. |
| signer_photo | Base64 image of the signer's avatar. |
| signer_photo_url | API endpoint to access the resource |
| signature_status | If the overall status of the signature is valid or not. Possible values are "VALID" or "INVALID". |
| signing_reason | Reason provided by the user while signing the field. |
| signing_location | Location entered by the user while signing the field. |
| contact_information | Contact information entered by the user while signing the field. |
| signing_time | Date and time of signing in 8601 format. Default timezone from SH Admin is followed the the time. |
| ltv | True, if signature is LTV. |
| qualified | True, if signatures are qualified. |
| certified | True, if signatures are certified. |
| certify_permission | Permission level for certified digital signature. |
| timestamp_at | Date and time when signature was timestamped. |
| timestamp_authority | Authority by which the signature was timestamped. |
| subject_dn | Subject DN from the certificate used while signing the field. |
| issuer_dn | Issuers DN from the certificate used while signing the field. |
| cert_valid_from | Date and time from which the certificate is valid. |
| cert_valid_to | Date and time to which the certificate is valid. |
| signature_type | Type of signatures, possible values are "PADES_PART2" or "PADES_PART4". |
| signature_algorithm | Signature algorithm used while signing the field. |
| signed_hash | Hash of the document that was signed in respective signature. |
| signature_application | Application name from where the field was signed. |
| signature_policy_id | Signature policy ID. |
| signature_policy_uri | Signature policy URI. |
| Message |
The service specific error message returned by the API. This message provides useful information about why the service has returned an error response. |