POST api/Document
Request Information
URI Parameters
None.
Body Parameters
DocumentPostRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | DocumentPostRequestFields |
None. |
Request Formats
application/json, text/json
Sample:
{
"Data": {
"Ids": [
1,
2
],
"Action": "sample string 1",
"UserId": "sample string 2",
"Timestamp": "2026-02-04T02:20:11.035998+00:00",
"UserTimezone": "sample string 4",
"UserUTCOffset": "sample string 5",
"DeclineReason": "sample string 6",
"Comments": "sample string 7",
"Token": "sample string 8",
"SignerSignatures": [
{
"Id": 1,
"Guid": "sample string 2",
"base64": "sample string 3"
},
{
"Id": 1,
"Guid": "sample string 2",
"base64": "sample string 3"
}
]
}
}
application/xml, text/xml
Sample:
<DocumentPostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignAPI.Models.Requests">
<Data>
<Action>sample string 1</Action>
<Comments>sample string 7</Comments>
<DeclineReason>sample string 6</DeclineReason>
<Ids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:long>1</d3p1:long>
<d3p1:long>2</d3p1:long>
</Ids>
<SignerSignatures>
<SignerSignature>
<Guid>sample string 2</Guid>
<Id>1</Id>
<base64>sample string 3</base64>
</SignerSignature>
<SignerSignature>
<Guid>sample string 2</Guid>
<Id>1</Id>
<base64>sample string 3</base64>
</SignerSignature>
</SignerSignatures>
<Timestamp>2026-02-04T02:20:11.035998+00:00</Timestamp>
<Token>sample string 8</Token>
<UserId>sample string 2</UserId>
<UserTimezone>sample string 4</UserTimezone>
<UserUTCOffset>sample string 5</UserUTCOffset>
</Data>
</DocumentPostRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
DocumentPostResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ProcessingDetails | Collection of DocumentProcessingStatusItem |
None. |
|
| Response | BaseResponseItems |
None. |
Response Formats
application/json, text/json
Sample:
{
"ProcessingDetails": [
{
"DocId": 1,
"DocProcessed": "sample string 2",
"DocError": "sample string 3"
},
{
"DocId": 1,
"DocProcessed": "sample string 2",
"DocError": "sample string 3"
}
],
"Response": {
"Processed": "sample string 1",
"Error": "sample string 2"
}
}
application/xml, text/xml
Sample:
<DocumentPostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignAPI.Models.Responses">
<Response>
<Error>sample string 2</Error>
<Processed>sample string 1</Processed>
</Response>
<ProcessingDetails>
<DocumentProcessingStatusItem>
<DocError>sample string 3</DocError>
<DocId>1</DocId>
<DocProcessed>sample string 2</DocProcessed>
<RequestorId>sample string 4</RequestorId>
</DocumentProcessingStatusItem>
<DocumentProcessingStatusItem>
<DocError>sample string 3</DocError>
<DocId>1</DocId>
<DocProcessed>sample string 2</DocProcessed>
<RequestorId>sample string 4</RequestorId>
</DocumentProcessingStatusItem>
</ProcessingDetails>
</DocumentPostResponse>