7.3 Add Proof from External Source
7.3.1 Description
This call allows API users to add extra proofs from an external source to a location on a document.
This call can be done multiple times for the same location and even when the package is fully signed (in this case the API user is responsible for making sure that any proof is added before retrieving the signed Audit proofs xml).
7.3.2 URL
https://[servername]:[port]/webportalapi/v3/packages/{packageId}/auditproof/proofs
7.3.3 HTTP Method
POST
7.3.4 MIME Type
application/json
7.3.5 Request parameters
Parameter | Occurrence | Content / Description | Type |
---|---|---|---|
Content | Mandatory | The actual content of the proof. | Base64 string |
LocationId | Mandatory | Location of the signature for which the proof content was generated. | Guid |
Name | Mandatory | Name of the proof. | String |
Type | Mandatory | A machine-readable “type” key. Can be freely chosen. | String |
Description | Optional | Brief human-readable description of the proof. | String |
IpAddress | Optional | IP address of the end user of the external source for which the proof was added. | String |
7.3.6 Example request
{
"locationId": "740745da-eda9-4520-a7b8-0b5b930667d3",
"name": "pdfSignature-1523563886023.log",
"description": "Traces de la signature du pdf",
"type": "OTHER",
"content": "Your signing code is 045002 In-Base-64",
"ipaddress": "192.168.0.3"
}
7.3.7 Response codes
Response status code | Description |
---|---|
204 No content | The proof was created for the requested location. |
400 Bad Request | The request contained parameters which could not be accepted. |
404 Not Found | The documentId or the LocationId could not be found. |
409 Conflict | The proof could not be added due to some other reason. |
7.3.8 Error codes
HTTP Code | Code |
---|---|
TBD |