POST api/SignatureRequest
Request Information
URI Parameters
None.
Body Parameters
SignatureRequestObject| Name | Description | Type | Additional information |
|---|---|---|---|
| SignatureRequestUID | integer |
None. |
|
| AddedDate | date |
None. |
|
| CompanyUID | integer |
None. |
|
| UserUID | integer |
None. |
|
| SenderName | string |
None. |
|
| ConfirmationEmailAddress | string |
None. |
|
| AccessCode | string |
None. |
|
| LogFile | string |
None. |
|
| ExtRefID | string |
None. |
|
| Completed | boolean |
None. |
|
| CompletedDate | date |
None. |
|
| SignedDocument | string |
None. |
|
| Latitude | string |
None. |
|
| Longitude | string |
None. |
|
| Accuracy | string |
None. |
|
| IPAddress | string |
None. |
|
| SigningRequestDisplayName | string |
None. |
|
| SigningRequestDisplayLogo | string |
None. |
|
| SMSUsername | string |
None. |
|
| SMSPassword | string |
None. |
|
| FromInterface | boolean |
None. |
|
| DocumentGroupID | string |
None. |
|
| SenderEmailedSignedDoc | string |
None. |
|
| Cancelled | boolean |
None. |
|
| CancelledDate | date |
None. |
|
| Environment | string |
None. |
|
| DocumentList | Collection of SignatureRequestDocument |
None. |
|
| SignerList | Collection of SignatureRequestSignerDetails |
None. |
|
| SigningSkipSignatureLocationSetup | boolean |
None. |
|
| DataClearedDate | date |
None. |
|
| OTPRequired | boolean |
None. |
|
| UserName | string |
None. |
|
| ESWhatsAppClientID | string |
None. |
|
| ESWhatsAppClientSecret | string |
None. |
|
| SMSorWhatsApp | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"SignatureRequestUID": 1,
"AddedDate": "2025-10-26T18:08:48.6644121+02:00",
"CompanyUID": 1,
"UserUID": 1,
"SenderName": "sample string 2",
"ConfirmationEmailAddress": "sample string 3",
"AccessCode": "sample string 4",
"LogFile": "sample string 5",
"ExtRefID": "sample string 6",
"Completed": true,
"CompletedDate": "2025-10-26T18:08:48.6644121+02:00",
"SignedDocument": "sample string 7",
"Latitude": "sample string 8",
"Longitude": "sample string 9",
"Accuracy": "sample string 10",
"IPAddress": "sample string 11",
"SigningRequestDisplayName": "sample string 12",
"SigningRequestDisplayLogo": "sample string 13",
"SMSUsername": "sample string 14",
"SMSPassword": "sample string 15",
"FromInterface": true,
"DocumentGroupID": "sample string 17",
"SenderEmailedSignedDoc": "sample string 18",
"Cancelled": true,
"CancelledDate": "2025-10-26T18:08:48.6644121+02:00",
"Environment": "sample string 19",
"DocumentList": [
{
"SignatureRequestDocumentUID": 1,
"SignatureRequestUID": 1,
"DocumentUID": 1,
"UnsignedDocument": "sample string 1",
"Completed": true,
"CompletedDate": "2025-10-26T18:08:48.6644121+02:00",
"SignedDocument": "sample string 2",
"Order": 1,
"ExternalURL": "sample string 3",
"LocalURL": "sample string 4",
"TotalPages": "sample string 5",
"DocumentName": "sample string 6",
"DocumentVersion": "sample string 7",
"ExternalDocString": "sample string 8",
"DocumentCancelled": true,
"DocumentCancelledDate": "2025-10-26T18:08:48.6644121+02:00",
"JSONWebToken": "sample string 9",
"DocumentDataList": [
{
"SignatureRequestDataUID": 1,
"SignatureRequestDocumentUID": 1,
"DataOrder": 1,
"DataValue": "sample string 1"
},
{
"SignatureRequestDataUID": 1,
"SignatureRequestDocumentUID": 1,
"DataOrder": 1,
"DataValue": "sample string 1"
}
],
"DocumentSignerSignaturesList": [
{
"SignerSignatureUID": 1,
"SignerUID": 2,
"SignatureRequestDocumentUID": 3,
"NumberOfSignatures": 1,
"NumberOfInitials": 1,
"SignatureLocations": "sample string 4",
"InitialLocations": "sample string 5",
"SignatureRequestUID": 6,
"SigningCompleted": true,
"SigningCompletedDate": "2025-10-26T18:08:48.6644121+02:00",
"SignerCanSkipPages": true,
"InitialLocationsSetup": true,
"SignatureLocationsSetup": true,
"SignatureSigningType": "sample string 11",
"RequiresLocation": true
},
{
"SignerSignatureUID": 1,
"SignerUID": 2,
"SignatureRequestDocumentUID": 3,
"NumberOfSignatures": 1,
"NumberOfInitials": 1,
"SignatureLocations": "sample string 4",
"InitialLocations": "sample string 5",
"SignatureRequestUID": 6,
"SigningCompleted": true,
"SigningCompletedDate": "2025-10-26T18:08:48.6644121+02:00",
"SignerCanSkipPages": true,
"InitialLocationsSetup": true,
"SignatureLocationsSetup": true,
"SignatureSigningType": "sample string 11",
"RequiresLocation": true
}
],
"SignioSubmission": "sample string 10",
"DocumentNameFriendly": "sample string 11",
"RequiresCertifiedBlock": true,
"CertifiedBlockLocation": "sample string 12",
"CertifiedBlockLocationSetup": true,
"OriginalDocumentName": "sample string 14",
"OriginalDocumentVersion": "sample string 15"
},
{
"SignatureRequestDocumentUID": 1,
"SignatureRequestUID": 1,
"DocumentUID": 1,
"UnsignedDocument": "sample string 1",
"Completed": true,
"CompletedDate": "2025-10-26T18:08:48.6644121+02:00",
"SignedDocument": "sample string 2",
"Order": 1,
"ExternalURL": "sample string 3",
"LocalURL": "sample string 4",
"TotalPages": "sample string 5",
"DocumentName": "sample string 6",
"DocumentVersion": "sample string 7",
"ExternalDocString": "sample string 8",
"DocumentCancelled": true,
"DocumentCancelledDate": "2025-10-26T18:08:48.6644121+02:00",
"JSONWebToken": "sample string 9",
"DocumentDataList": [
{
"SignatureRequestDataUID": 1,
"SignatureRequestDocumentUID": 1,
"DataOrder": 1,
"DataValue": "sample string 1"
},
{
"SignatureRequestDataUID": 1,
"SignatureRequestDocumentUID": 1,
"DataOrder": 1,
"DataValue": "sample string 1"
}
],
"DocumentSignerSignaturesList": [
{
"SignerSignatureUID": 1,
"SignerUID": 2,
"SignatureRequestDocumentUID": 3,
"NumberOfSignatures": 1,
"NumberOfInitials": 1,
"SignatureLocations": "sample string 4",
"InitialLocations": "sample string 5",
"SignatureRequestUID": 6,
"SigningCompleted": true,
"SigningCompletedDate": "2025-10-26T18:08:48.6644121+02:00",
"SignerCanSkipPages": true,
"InitialLocationsSetup": true,
"SignatureLocationsSetup": true,
"SignatureSigningType": "sample string 11",
"RequiresLocation": true
},
{
"SignerSignatureUID": 1,
"SignerUID": 2,
"SignatureRequestDocumentUID": 3,
"NumberOfSignatures": 1,
"NumberOfInitials": 1,
"SignatureLocations": "sample string 4",
"InitialLocations": "sample string 5",
"SignatureRequestUID": 6,
"SigningCompleted": true,
"SigningCompletedDate": "2025-10-26T18:08:48.6644121+02:00",
"SignerCanSkipPages": true,
"InitialLocationsSetup": true,
"SignatureLocationsSetup": true,
"SignatureSigningType": "sample string 11",
"RequiresLocation": true
}
],
"SignioSubmission": "sample string 10",
"DocumentNameFriendly": "sample string 11",
"RequiresCertifiedBlock": true,
"CertifiedBlockLocation": "sample string 12",
"CertifiedBlockLocationSetup": true,
"OriginalDocumentName": "sample string 14",
"OriginalDocumentVersion": "sample string 15"
}
],
"SignerList": [
{
"SignerUID": 1,
"SignatureRequestUID": 2,
"SignerOrder": 3,
"SignerName": "sample string 4",
"SignerEmailAddress": "sample string 5",
"SignerCellNum": "sample string 6",
"SignerIDNumber": "sample string 7",
"SignerOTP": "sample string 8",
"SignerEmailedSignedDoc": true,
"SignerSMSSentDate": "2025-10-26T18:08:48.6644121+02:00",
"SessionID": 10,
"PrimarySigner": true,
"signerProcessSignature": true,
"signerProcessOTP": true,
"signerOTPType": "sample string 14",
"SignerLastReminderSent": "2025-10-26T18:08:48.6644121+02:00",
"RequiresViewAllPages": true,
"SignerLocation": "sample string 16",
"SignerWhatsAppSentDate": "2025-10-26T18:08:48.6644121+02:00"
},
{
"SignerUID": 1,
"SignatureRequestUID": 2,
"SignerOrder": 3,
"SignerName": "sample string 4",
"SignerEmailAddress": "sample string 5",
"SignerCellNum": "sample string 6",
"SignerIDNumber": "sample string 7",
"SignerOTP": "sample string 8",
"SignerEmailedSignedDoc": true,
"SignerSMSSentDate": "2025-10-26T18:08:48.6644121+02:00",
"SessionID": 10,
"PrimarySigner": true,
"signerProcessSignature": true,
"signerProcessOTP": true,
"signerOTPType": "sample string 14",
"SignerLastReminderSent": "2025-10-26T18:08:48.6644121+02:00",
"RequiresViewAllPages": true,
"SignerLocation": "sample string 16",
"SignerWhatsAppSentDate": "2025-10-26T18:08:48.6644121+02:00"
}
],
"SigningSkipSignatureLocationSetup": true,
"DataClearedDate": "2025-10-26T18:08:48.6644121+02:00",
"OTPRequired": true,
"UserName": "sample string 21",
"ESWhatsAppClientID": "sample string 22",
"ESWhatsAppClientSecret": "sample string 23",
"SMSorWhatsApp": "sample string 24"
}
application/xml, text/xml
Sample:
<SignatureRequestObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SignEasy.SignatureRequest">
<AccessCode>sample string 4</AccessCode>
<Accuracy>sample string 10</Accuracy>
<AddedDate>2025-10-26T18:08:48.6644121+02:00</AddedDate>
<Cancelled>true</Cancelled>
<CancelledDate>2025-10-26T18:08:48.6644121+02:00</CancelledDate>
<CompanyUID>1</CompanyUID>
<Completed>true</Completed>
<CompletedDate>2025-10-26T18:08:48.6644121+02:00</CompletedDate>
<ConfirmationEmailAddress>sample string 3</ConfirmationEmailAddress>
<DataClearedDate>2025-10-26T18:08:48.6644121+02:00</DataClearedDate>
<DocumentGroupID>sample string 17</DocumentGroupID>
<DocumentList>
<SignatureRequestDocument>
<CertifiedBlockLocation>sample string 12</CertifiedBlockLocation>
<CertifiedBlockLocationSetup>true</CertifiedBlockLocationSetup>
<Completed>true</Completed>
<CompletedDate>2025-10-26T18:08:48.6644121+02:00</CompletedDate>
<DocumentCancelled>true</DocumentCancelled>
<DocumentCancelledDate>2025-10-26T18:08:48.6644121+02:00</DocumentCancelledDate>
<DocumentDataList>
<SignatureRequestDocumentData>
<DataOrder>1</DataOrder>
<DataValue>sample string 1</DataValue>
<SignatureRequestDataUID>1</SignatureRequestDataUID>
<SignatureRequestDocumentUID>1</SignatureRequestDocumentUID>
</SignatureRequestDocumentData>
<SignatureRequestDocumentData>
<DataOrder>1</DataOrder>
<DataValue>sample string 1</DataValue>
<SignatureRequestDataUID>1</SignatureRequestDataUID>
<SignatureRequestDocumentUID>1</SignatureRequestDocumentUID>
</SignatureRequestDocumentData>
</DocumentDataList>
<DocumentName>sample string 6</DocumentName>
<DocumentNameFriendly>sample string 11</DocumentNameFriendly>
<DocumentSignerSignaturesList>
<SignatureRequestDocumentSignerSignatureDetails>
<InitialLocations>sample string 5</InitialLocations>
<InitialLocationsSetup>true</InitialLocationsSetup>
<NumberOfInitials>1</NumberOfInitials>
<NumberOfSignatures>1</NumberOfSignatures>
<RequiresLocation>true</RequiresLocation>
<SignatureLocations>sample string 4</SignatureLocations>
<SignatureLocationsSetup>true</SignatureLocationsSetup>
<SignatureRequestDocumentUID>3</SignatureRequestDocumentUID>
<SignatureRequestUID>6</SignatureRequestUID>
<SignatureSigningType>sample string 11</SignatureSigningType>
<SignerCanSkipPages>true</SignerCanSkipPages>
<SignerSignatureUID>1</SignerSignatureUID>
<SignerUID>2</SignerUID>
<SigningCompleted>true</SigningCompleted>
<SigningCompletedDate>2025-10-26T18:08:48.6644121+02:00</SigningCompletedDate>
</SignatureRequestDocumentSignerSignatureDetails>
<SignatureRequestDocumentSignerSignatureDetails>
<InitialLocations>sample string 5</InitialLocations>
<InitialLocationsSetup>true</InitialLocationsSetup>
<NumberOfInitials>1</NumberOfInitials>
<NumberOfSignatures>1</NumberOfSignatures>
<RequiresLocation>true</RequiresLocation>
<SignatureLocations>sample string 4</SignatureLocations>
<SignatureLocationsSetup>true</SignatureLocationsSetup>
<SignatureRequestDocumentUID>3</SignatureRequestDocumentUID>
<SignatureRequestUID>6</SignatureRequestUID>
<SignatureSigningType>sample string 11</SignatureSigningType>
<SignerCanSkipPages>true</SignerCanSkipPages>
<SignerSignatureUID>1</SignerSignatureUID>
<SignerUID>2</SignerUID>
<SigningCompleted>true</SigningCompleted>
<SigningCompletedDate>2025-10-26T18:08:48.6644121+02:00</SigningCompletedDate>
</SignatureRequestDocumentSignerSignatureDetails>
</DocumentSignerSignaturesList>
<DocumentUID>1</DocumentUID>
<DocumentVersion>sample string 7</DocumentVersion>
<ExternalDocString>sample string 8</ExternalDocString>
<ExternalURL>sample string 3</ExternalURL>
<JSONWebToken>sample string 9</JSONWebToken>
<LocalURL>sample string 4</LocalURL>
<Order>1</Order>
<OriginalDocumentName>sample string 14</OriginalDocumentName>
<OriginalDocumentVersion>sample string 15</OriginalDocumentVersion>
<RequiresCertifiedBlock>true</RequiresCertifiedBlock>
<SignatureRequestDocumentUID>1</SignatureRequestDocumentUID>
<SignatureRequestUID>1</SignatureRequestUID>
<SignedDocument>sample string 2</SignedDocument>
<SignioSubmission>sample string 10</SignioSubmission>
<TotalPages>sample string 5</TotalPages>
<UnsignedDocument>sample string 1</UnsignedDocument>
</SignatureRequestDocument>
<SignatureRequestDocument>
<CertifiedBlockLocation>sample string 12</CertifiedBlockLocation>
<CertifiedBlockLocationSetup>true</CertifiedBlockLocationSetup>
<Completed>true</Completed>
<CompletedDate>2025-10-26T18:08:48.6644121+02:00</CompletedDate>
<DocumentCancelled>true</DocumentCancelled>
<DocumentCancelledDate>2025-10-26T18:08:48.6644121+02:00</DocumentCancelledDate>
<DocumentDataList>
<SignatureRequestDocumentData>
<DataOrder>1</DataOrder>
<DataValue>sample string 1</DataValue>
<SignatureRequestDataUID>1</SignatureRequestDataUID>
<SignatureRequestDocumentUID>1</SignatureRequestDocumentUID>
</SignatureRequestDocumentData>
<SignatureRequestDocumentData>
<DataOrder>1</DataOrder>
<DataValue>sample string 1</DataValue>
<SignatureRequestDataUID>1</SignatureRequestDataUID>
<SignatureRequestDocumentUID>1</SignatureRequestDocumentUID>
</SignatureRequestDocumentData>
</DocumentDataList>
<DocumentName>sample string 6</DocumentName>
<DocumentNameFriendly>sample string 11</DocumentNameFriendly>
<DocumentSignerSignaturesList>
<SignatureRequestDocumentSignerSignatureDetails>
<InitialLocations>sample string 5</InitialLocations>
<InitialLocationsSetup>true</InitialLocationsSetup>
<NumberOfInitials>1</NumberOfInitials>
<NumberOfSignatures>1</NumberOfSignatures>
<RequiresLocation>true</RequiresLocation>
<SignatureLocations>sample string 4</SignatureLocations>
<SignatureLocationsSetup>true</SignatureLocationsSetup>
<SignatureRequestDocumentUID>3</SignatureRequestDocumentUID>
<SignatureRequestUID>6</SignatureRequestUID>
<SignatureSigningType>sample string 11</SignatureSigningType>
<SignerCanSkipPages>true</SignerCanSkipPages>
<SignerSignatureUID>1</SignerSignatureUID>
<SignerUID>2</SignerUID>
<SigningCompleted>true</SigningCompleted>
<SigningCompletedDate>2025-10-26T18:08:48.6644121+02:00</SigningCompletedDate>
</SignatureRequestDocumentSignerSignatureDetails>
<SignatureRequestDocumentSignerSignatureDetails>
<InitialLocations>sample string 5</InitialLocations>
<InitialLocationsSetup>true</InitialLocationsSetup>
<NumberOfInitials>1</NumberOfInitials>
<NumberOfSignatures>1</NumberOfSignatures>
<RequiresLocation>true</RequiresLocation>
<SignatureLocations>sample string 4</SignatureLocations>
<SignatureLocationsSetup>true</SignatureLocationsSetup>
<SignatureRequestDocumentUID>3</SignatureRequestDocumentUID>
<SignatureRequestUID>6</SignatureRequestUID>
<SignatureSigningType>sample string 11</SignatureSigningType>
<SignerCanSkipPages>true</SignerCanSkipPages>
<SignerSignatureUID>1</SignerSignatureUID>
<SignerUID>2</SignerUID>
<SigningCompleted>true</SigningCompleted>
<SigningCompletedDate>2025-10-26T18:08:48.6644121+02:00</SigningCompletedDate>
</SignatureRequestDocumentSignerSignatureDetails>
</DocumentSignerSignaturesList>
<DocumentUID>1</DocumentUID>
<DocumentVersion>sample string 7</DocumentVersion>
<ExternalDocString>sample string 8</ExternalDocString>
<ExternalURL>sample string 3</ExternalURL>
<JSONWebToken>sample string 9</JSONWebToken>
<LocalURL>sample string 4</LocalURL>
<Order>1</Order>
<OriginalDocumentName>sample string 14</OriginalDocumentName>
<OriginalDocumentVersion>sample string 15</OriginalDocumentVersion>
<RequiresCertifiedBlock>true</RequiresCertifiedBlock>
<SignatureRequestDocumentUID>1</SignatureRequestDocumentUID>
<SignatureRequestUID>1</SignatureRequestUID>
<SignedDocument>sample string 2</SignedDocument>
<SignioSubmission>sample string 10</SignioSubmission>
<TotalPages>sample string 5</TotalPages>
<UnsignedDocument>sample string 1</UnsignedDocument>
</SignatureRequestDocument>
</DocumentList>
<ESWhatsAppClientID>sample string 22</ESWhatsAppClientID>
<ESWhatsAppClientSecret>sample string 23</ESWhatsAppClientSecret>
<Environment>sample string 19</Environment>
<ExtRefID>sample string 6</ExtRefID>
<FromInterface>true</FromInterface>
<IPAddress>sample string 11</IPAddress>
<Latitude>sample string 8</Latitude>
<LogFile>sample string 5</LogFile>
<Longitude>sample string 9</Longitude>
<OTPRequired>true</OTPRequired>
<SMSPassword>sample string 15</SMSPassword>
<SMSUsername>sample string 14</SMSUsername>
<SMSorWhatsApp>sample string 24</SMSorWhatsApp>
<SenderEmailedSignedDoc>sample string 18</SenderEmailedSignedDoc>
<SenderName>sample string 2</SenderName>
<SignatureRequestUID>1</SignatureRequestUID>
<SignedDocument>sample string 7</SignedDocument>
<SignerList>
<SignatureRequestSignerDetails>
<PrimarySigner>true</PrimarySigner>
<RequiresViewAllPages>true</RequiresViewAllPages>
<SessionID>10</SessionID>
<SignatureRequestUID>2</SignatureRequestUID>
<SignerCellNum>sample string 6</SignerCellNum>
<SignerEmailAddress>sample string 5</SignerEmailAddress>
<SignerEmailedSignedDoc>true</SignerEmailedSignedDoc>
<SignerIDNumber>sample string 7</SignerIDNumber>
<SignerLastReminderSent>2025-10-26T18:08:48.6644121+02:00</SignerLastReminderSent>
<SignerLocation>sample string 16</SignerLocation>
<SignerName>sample string 4</SignerName>
<SignerOTP>sample string 8</SignerOTP>
<SignerOrder>3</SignerOrder>
<SignerSMSSentDate>2025-10-26T18:08:48.6644121+02:00</SignerSMSSentDate>
<SignerUID>1</SignerUID>
<SignerWhatsAppSentDate>2025-10-26T18:08:48.6644121+02:00</SignerWhatsAppSentDate>
<signerOTPType>sample string 14</signerOTPType>
<signerProcessOTP>true</signerProcessOTP>
<signerProcessSignature>true</signerProcessSignature>
</SignatureRequestSignerDetails>
<SignatureRequestSignerDetails>
<PrimarySigner>true</PrimarySigner>
<RequiresViewAllPages>true</RequiresViewAllPages>
<SessionID>10</SessionID>
<SignatureRequestUID>2</SignatureRequestUID>
<SignerCellNum>sample string 6</SignerCellNum>
<SignerEmailAddress>sample string 5</SignerEmailAddress>
<SignerEmailedSignedDoc>true</SignerEmailedSignedDoc>
<SignerIDNumber>sample string 7</SignerIDNumber>
<SignerLastReminderSent>2025-10-26T18:08:48.6644121+02:00</SignerLastReminderSent>
<SignerLocation>sample string 16</SignerLocation>
<SignerName>sample string 4</SignerName>
<SignerOTP>sample string 8</SignerOTP>
<SignerOrder>3</SignerOrder>
<SignerSMSSentDate>2025-10-26T18:08:48.6644121+02:00</SignerSMSSentDate>
<SignerUID>1</SignerUID>
<SignerWhatsAppSentDate>2025-10-26T18:08:48.6644121+02:00</SignerWhatsAppSentDate>
<signerOTPType>sample string 14</signerOTPType>
<signerProcessOTP>true</signerProcessOTP>
<signerProcessSignature>true</signerProcessSignature>
</SignatureRequestSignerDetails>
</SignerList>
<SigningRequestDisplayLogo>sample string 13</SigningRequestDisplayLogo>
<SigningRequestDisplayName>sample string 12</SigningRequestDisplayName>
<SigningSkipSignatureLocationSetup>true</SigningSkipSignatureLocationSetup>
<UserName>sample string 21</UserName>
<UserUID>1</UserUID>
</SignatureRequestObject>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |