POST api/prod/signdesk/callback
Request Information
URI Parameters
None.
Body Parameters
SignDesk| Name | Description | Type | Additional information |
|---|---|---|---|
| status | string |
None. |
|
| document_id | string |
None. |
|
| completed_at | string |
None. |
|
| docket_id | string |
None. |
|
| file_content | string |
None. |
|
| tiff_data | Collection of string |
None. |
|
| signers_info | Collection of signers_info |
None. |
Request Formats
application/json, text/json
Sample:
{
"status": "sample string 1",
"document_id": "sample string 2",
"completed_at": "sample string 3",
"docket_id": "sample string 4",
"file_content": "sample string 5",
"tiff_data": [
"sample string 1",
"sample string 2"
],
"signers_info": [
{
"signer_position": {
"appearance": [
{
"x1": 1,
"x2": 2,
"y1": 3,
"y2": 4
},
{
"x1": 1,
"x2": 2,
"y1": 3,
"y2": 4
}
]
},
"document_to_be_signed": "sample string 1",
"signer_ref_id": "sample string 2",
"is_pinned": "sample string 3",
"signer_email": "sample string 4",
"signer_name": "sample string 5",
"signer_mobile": "sample string 6",
"sequence": "sample string 7",
"signer_remarks": "sample string 8",
"page_number": "sample string 9",
"signature_type": "sample string 10",
"trigger_esign_request": true,
"autosign_user_id": "sample string 12"
},
{
"signer_position": {
"appearance": [
{
"x1": 1,
"x2": 2,
"y1": 3,
"y2": 4
},
{
"x1": 1,
"x2": 2,
"y1": 3,
"y2": 4
}
]
},
"document_to_be_signed": "sample string 1",
"signer_ref_id": "sample string 2",
"is_pinned": "sample string 3",
"signer_email": "sample string 4",
"signer_name": "sample string 5",
"signer_mobile": "sample string 6",
"sequence": "sample string 7",
"signer_remarks": "sample string 8",
"page_number": "sample string 9",
"signature_type": "sample string 10",
"trigger_esign_request": true,
"autosign_user_id": "sample string 12"
}
]
}
application/xml, text/xml
Sample:
<SignDesk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SignDesk.Model">
<completed_at>sample string 3</completed_at>
<docket_id>sample string 4</docket_id>
<document_id>sample string 2</document_id>
<file_content>sample string 5</file_content>
<signers_info>
<signers_info>
<autosign_user_id>sample string 12</autosign_user_id>
<document_to_be_signed>sample string 1</document_to_be_signed>
<is_pinned>sample string 3</is_pinned>
<page_number>sample string 9</page_number>
<sequence>sample string 7</sequence>
<signature_type>sample string 10</signature_type>
<signer_email>sample string 4</signer_email>
<signer_mobile>sample string 6</signer_mobile>
<signer_name>sample string 5</signer_name>
<signer_position>
<appearance>
<appearance>
<x1>1</x1>
<x2>2</x2>
<y1>3</y1>
<y2>4</y2>
</appearance>
<appearance>
<x1>1</x1>
<x2>2</x2>
<y1>3</y1>
<y2>4</y2>
</appearance>
</appearance>
</signer_position>
<signer_ref_id>sample string 2</signer_ref_id>
<signer_remarks>sample string 8</signer_remarks>
<trigger_esign_request>true</trigger_esign_request>
</signers_info>
<signers_info>
<autosign_user_id>sample string 12</autosign_user_id>
<document_to_be_signed>sample string 1</document_to_be_signed>
<is_pinned>sample string 3</is_pinned>
<page_number>sample string 9</page_number>
<sequence>sample string 7</sequence>
<signature_type>sample string 10</signature_type>
<signer_email>sample string 4</signer_email>
<signer_mobile>sample string 6</signer_mobile>
<signer_name>sample string 5</signer_name>
<signer_position>
<appearance>
<appearance>
<x1>1</x1>
<x2>2</x2>
<y1>3</y1>
<y2>4</y2>
</appearance>
<appearance>
<x1>1</x1>
<x2>2</x2>
<y1>3</y1>
<y2>4</y2>
</appearance>
</appearance>
</signer_position>
<signer_ref_id>sample string 2</signer_ref_id>
<signer_remarks>sample string 8</signer_remarks>
<trigger_esign_request>true</trigger_esign_request>
</signers_info>
</signers_info>
<status>sample string 1</status>
<tiff_data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</tiff_data>
</SignDesk>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
None.