CryptonMobile CryptoSign API is a secure and easy way to send documents to your customers for signing. You and your customers will get notifications and copy of the document once it has been signed and completed. This documentation will also guide you with embedded signing to your own application/website.
\nApart from this API, you will also be able to manage signature campaigns and see status of signature requests you sent via the eSign Client Portal. All signed/completed documents can be downloaded in the portal as well.
\nOverview
\nYou will need an API Key and Secret code to use any endpoints. Authorization is basic auth over HTTPS/TLS1.2. You just need to include in every request a header with key=Authorization and value=Basic base64(API Key:Secret). See sample headers below.
All requests should be done over HTTPS
Request body and response to every request is in JSON format. Make sure to set Content-Type: application/json in the headers of every request.
HTTP status codes will be sent to every response to any API call. 200 OK response means the call was successful. 4XX or 5XX response means there was an error on the API call.
All errors are represented by a JSON response of \"error\": {} key indicating the name of the error and a description.
If you need help on using CryptonMobile eSign API, you may send an email to support@cryptonmobile.com
This endpoint allows you to create a signature campaign and send them to single or multiple recipients for signing. The signature requests will be sent to the recipients via SMS and email.
\nRequest Notes
\n\n#URL#) where the actual signing link will be placed.#URL#) where the download link to the completed document will be placed.HTTP POST to your Callback URL as soon as there's a change in the signature request status. You can see more information on getting Signature Request status via webhook on Receive Signature Request Status Via Webhook section under Getting Campaign Status and Completed section folder in this documentation.SignatureRequests (required) - This is the list of the signature requests or envelopes you want to send to your customers for signing. You can send a single or multiple SignatureRequests on one API call. See below for sample SignatureRequests.
A SignatureRequest contains the following elements:
Signers (required) - This is the list of signers you want to receive and sign the documents. A SignatureRequest can contain a single Signer element or multiple Signers (like in the case of a Borrower and Co-borrower tandem). A Signer should contain the following required elements: FirstName, LastName, PhoneNumber (in the format +[COUNTRY CODE][VALID PHONE NUMBER]), and VerificationCode. Optional elements are Email, Role, and Order.
Additional notes on Signer element:
\"customFields\":[
{
\"name\":\"Product\",
\"value\":\"CONTRACT,SECURITYAREEMENT\"
},
{
\"name\":\"VerifyIdentity\",
\"value\":\"Borrower\"
}
]true or false. If you want to update the documents of the signature request, you will need to set this to true and send the copy of the documents under the element Documents. This is useful if you have the updated documents pre-filled with the signer information already and you want to use these documents instead so that when the signer receives it for signing, the documents or contract is customized just for them. See below for the Documents section.FileContent and FileName elements. When uploading multiple documents, they will be merged into a single document. The documents will be ordered according to their order on the list.Response Notes
\n\nResponse Description
\nsignatureCampaignId - represents the unique identifier for the signature campaign.
signatureRequests - an array containing one or more signature request objects. In this case, there is only one signature request object.
Each signature request object contains the following information:
signatureRequestId: A unique identifier for the signature request.
signers: An array of signer objects representing the individuals involved in the signature request. In this example, there are two signers. Each signer object contains the following details:
firstName- The first name of the signer.
lastName-The last name of the signer.
phoneNumber- The phone number of the signer.
email- The email address of the signer.
role- The role of the signer in the signature process.
order- The order in which the signers are expected to sign (0 being the first).
verificationCode- A verification code associated with the signer.
returnSignLink- A boolean indicating whether a sign link should be returned to the signer.
signLink- The URL of the sign link for the signer.
sendSms- A boolean indicating whether an SMS notification should be sent to the signer.
sendEmail- A boolean indicating whether an email notification should be sent to the signer.
This endpoint allows you to create a signature campaign using any document with text tags. This is similar to creating a Signature Campaign except that it does not need a Template Id. The signature requests will be sent to the recipients via SMS and email.
\nRequest Notes
\n\nSubject (required) - This is the subject or title that you can use to identify a signature campaign in the client portal. This will also appear in all email notifications that will be sent to you and your customers.
Message (required) - This is the message that will appear in all email notifications that will be sent to your customers.
InviteSMS (required, max 160 characters) - This is the content of the text message that will be sent to the recipients of your signature campaign. This should contain a keyword (#URL#) where the actual signing link will be placed.
IsHideTextTag (required, boolean) - This determines if the text tag will be visible or hidden (in white font) from the document signing page. If set as true, our API hides all the text tags from the document so that it won't be seen when the signer signs the document.
Note on Text Tag Removal:
While the IsHideTextTag can be enabled, we won't recommend it as this causes additional document processing time and parsing texts using automatic tag removal is inconsistent and inexact. Instead of enabling IsHideTextTag feature, we suggest that you should try to hide your text tags by making the text tag font color similar to the document background color which is usually white.
ThankYouSMS (required, max 160 characters) - This is the content of the text message that will be sent to the recipients once they have signed and completed a document. This should contain a keyword (#URL#) where the download link to the completed document will be placed.
StatusCallbackUrl (optional) - If you want to receive real-time status updates of your request, place your Callback Url here. Our API will do a HTTP POST to your Callback URL as soon as there's a change in the signature request status. You can see more information on getting Signature Request status via webhook on Receive Signature Request Status Via Webhook section under Getting Campaign Status and Completed section folder in this documentation.
FirstName, LastName, PhoneNumber (in the format +[COUNTRY CODE][VALID PHONE NUMBER]), and VerificationCode. Optional elements are Email, Role, and Order.Email (optional) - This should be included if you want the recipient to receive the signing link via email too.
Order (optional) - This is the signing order or the order by which you want your signers to sign in. If you have multiple signers to an envelope or document, you can either have them sign in order or not. If an Order is provided, the first in the signing order will have to sign and complete the document first before the second signer can sign. Order values should start from zero and increment by one.
VerificationCode (required) - This is the code that the recipient will enter at the start of the signing process. The verification code here should match with what the signer will enter to move forward with the actual document signing. This can be the last four digits of the signer's social security number or any other code that you and the signer knows.
DateOfBirth (optional) - Apart from the verification code, should you want your signers to enter their date of birth as additional item for identity verification, you may include this with a value of the signer's date of birth in this format: \"MM/dd/yyyy\". Not including this parameter will use the verification code only for signer identification.
SendSMS (boolean,required) - Setting this to true will enable the api to send SMS notification to the signer.
SendEmail (boolean,required) - Setting this to true will enable the api to send email notification to the signer.
ReturnSignLink (boolean,optional,default false) - Setting this to true will return a URL of the document's signing page for the respective signer. Note: Directly accessing the ReturnSignLink from the API response will skip the validation process. However, clicking on the sign link from the SMS/Email will point you to the user validation page.
CustomFields (optional) - If you want the document pre-populated with some signer information, this is where to put those information. A CustomField is a Name and Value pair which will be identified during template creation and will be given to you once your document has been digitized.
Here is a sample code block for enabling CryptoVerifi:\"customFields\":[
{
\"name\":\"VerifyIdentity\",
\"value\":\"Borrower\"
}
]
Documents (optional) - If UpdateDocuments is set to true, this element is required. This should contain a list of FileContent and FileName elements. When uploading multiple documents, they will be merged into a single document. The documents will be ordered according to their order on the list.
Additional Notes on Documents element:
FileContent (required) - This should contain the document (in PDF format) file's byte array encoded in Base64. The file's size should not exceed 40 MB.
FileName (optional) - The name of the document file. If provided, it helps identify each document.
RedirectUrlAfterSigning (optional) - Contains the URL that directs users to a specific page or app after successfully completing the signing process. For more information, please refer to \"Redirect Back To Your Website After Signing\" section at the bottom of this document.
Text Tag Syntax
\n\nThe correct Text tag format is enclosed by double curly braces \"{{ }}\" and separated by pipe \"|\" between parts. Below is a sample formatting of a text tag:
\n{{field-type|req,noreq|signerN|fieldName(optional)}}
Text Tag Parts:
\n\nfield-type (required) -These may be signature, initials, date-signed, text, text-merge, or checkbox. You may refer to the table below for the list of usable text tag field types.
req/noreq (required) - This part indicates if the field type is required or optional. 'req' means required while 'noreq' means optional.
signerN (required)- This part indicates which signer role is assigned to the tag. Format for signer name is 'Signer' + N (where N is the role order). For example, values for signers may be signer1, signer2, signer3 ... signerN, and sender as the last signer.
fieldName (optional) - This part is where you can define the name of the field. It can be used as a reference to get the entered value from signing or can be used to pre-set the value of the field using the CustomFields section in the API request.
Usable Text Tag field types:
\n| Field Type | Description |
|---|---|
signature | Signature field |
initials | Signer's initials field |
date-signed | Auto-fills the current date of signing the document |
text | Editable text field |
text-merge | A read-only text field that is pre-set by the API |
checkbox | Checkbox field |
Sample text tag formats:
\n\n| Example | Text tag format |
|---|---|
Required signature field for signer 1 | {{signature|req|signer1}} |
Optional signature field for signer 2 | {{signature|noreq|signer2}} |
Editable text with placeholder text (Enter Name) | {{text|req|signer1|name|Enter Name}} |
Grouping of Checkboxes. For example, we need a checkbox for two Payment options -Cash/Card. The first and second part of the tag is similar to all tags. The fourth part of the text tag is to uniquely identify the specific checkbox and the fifth part is the groupName named as paymentMode where the Payment options share in common. | {{checkbox|req|signer1|paymentOptionCash|paymentMode}}{{checkbox|req|signer1|paymentOptionCard|paymentMode}} |
Sending Text Tags with pre-set value. The value can be set in the custom field section and use the field name as the key or reference. | {{text-merge|req|signer1|signer1Name}}....\"customFields\":[{\"name\":\"signer1Name\",\"value\":\"John Smith\"}].... |
Response Notes
\n\nA successful response will contain a SignatureCampaignId with information including the signature request(s) within the campaign, and details about each signer involved in the request(s). You can use the SIgnatureCampaignId to get the status of the campaign via the Get Signature Campaign Status endpoint.
Response Description
\nsignatureCampaignId - represents the unique identifier for the signature campaign.signatureRequests - an array containing one or more signature request objects. In this case, there is only one signature request object.signatureRequestId: A unique identifier for the signature request.signers: An array of signer objects representing the individuals involved in the signature request. In this example, there are two signers. Each signer object contains the following details:firstName- The first name of the signer.lastName-The last name of the signer.phoneNumber- The phone number of the signer.email- The email address of the signer.role- The role of the signer in the signature process.order- The order in which the signers are expected to sign (0 being the first).verificationCode- A verification code associated with the signer.returnSignLink- A boolean indicating whether a sign link should be returned to the signer.signLink- The URL of the sign link for the signer.sendSms- A boolean indicating whether an SMS notification should be sent to the signer.sendEmail- A boolean indicating whether an email notification should be sent to the signer.This endpoint allows you to create a signature campaign using any document with PDF form fields. It transforms the existing PDF form field into CryptoSign fields. This is similar to creating a Signature Campaign except that it does not need a Template Id. The signature requests will be sent to the recipients via SMS and email.
\nRequest Notes
\n\nSubject (required) - This is the subject or title that you can use to identify a signature campaign in the client portal. This will also appear in all email notifications that will be sent to you and your customers.
Message (required) - This is the message that will appear in all email notifications that will be sent to your customers.
InviteSMS (required, max 160 characters) - This is the content of the text message that will be sent to the recipients of your signature campaign. This should contain a keyword (#URL#) where the actual signing link will be placed.
ThankYouSMS (required, max 160 characters) - This is the content of the text message that will be sent to the recipients once they have signed and completed a document. This should contain a keyword (#URL#) where the download link to the completed document will be placed.
StatusCallbackUrl (optional) - If you want to receive real-time status updates of your request, place your Callback Url here. Our API will do a HTTP POST to your Callback URL as soon as there's a change in the signature request status. You can see more information on getting Signature Request status via webhook on Receive Signature Request Status Via Webhook section under Getting Campaign Status and Completed section folder in this documentation.
FirstName, LastName, PhoneNumber (in the format +[COUNTRY CODE][VALID PHONE NUMBER]), and VerificationCode. Optional elements are Email, Role, and Order.Email (optional) - This should be included if you want the recipient to receive the signing link via email too.
Order (optional) - This is the signing order or the order by which you want your signers to sign in. If you have multiple signers to an envelope or document, you can either have them sign in order or not. If an Order is provided, the first in the signing order will have to sign and complete the document first before the second signer can sign. Order values should start from zero and increment by one.
VerificationCode (required) - This is the code that the recipient will enter at the start of the signing process. The verification code here should match with what the signer will enter to move forward with the actual document signing. This can be the last four digits of the signer's social security number or any other code that you and the signer knows.
DateOfBirth (optional) - Apart from the verification code, should you want your signers to enter their date of birth as additional item for identity verification, you may include this with a value of the signer's date of birth in this format: \"MM/dd/yyyy\". Not including this parameter will use the verification code only for signer identification.
SendSMS (boolean,required) - Setting this to true will enable the api to send SMS notification to the signer.
SendEmail (boolean,required) - Setting this to true will enable the api to send email notification to the signer.
ReturnSignLink (boolean,optional,default false) - Setting this to true will return a URL of the document's signing page for the respective signer. Note: Directly accessing the ReturnSignLink from the API response will skip the validation process. However, clicking on the sign link from the SMS/Email will point you to the user validation page.
CustomFields (optional) - If you want the document pre-populated with some signer information, this is where to put those information. A CustomField is a Name and Value pair which will be identified during template creation and will be given to you once your document has been digitized.
Here is a sample code block for enabling CryptoVerifi:\"customFields\":[
{
\"name\":\"VerifyIdentity\",
\"value\":\"Borrower\"
}
]
Documents (optional) - If UpdateDocuments is set to true, this element is required. This should contain a list of FileContent and FileNameelements. When uploading multiple documents, they will be merged into a single document. The documents will be ordered according to their order on the list.
Additional Notes on Documents element:
FileContent (required) - This should contain the document (in PDF format) file's byte array encoded in Base64. The file's size should not exceed 40 MB.
FileName (optional) - The name of the document file. If provided, it helps identify each document.
RedirectUrlAfterSigning (optional) - Contains the URL that directs users to a specific page or app after successfully completing the signing process. For more information, please refer to \"Redirect Back To Your Website After Signing\" section at the bottom of this document.
PDF fields are converted to CryptoSign field types based on the naming conventions of the Adobe field as shown below:
\nPDF Form Field to CryptoSign Field Naming Conventions
\n\nResponse Notes
\n\nA successful response will contain a SignatureCampaignId with information including the signature request(s) within the campaign, and details about each signer involved in the request(s). You can use the SIgnatureCampaignId to get the status of the campaign via the Get Signature Campaign Status endpoint.
Response Description
\nsignatureCampaignId - represents the unique identifier for the signature campaign.signatureRequests - an array containing one or more signature request objects. In this case, there is only one signature request object.signatureRequestId: A unique identifier for the signature request.signers: An array of signer objects representing the individuals involved in the signature request. In this example, there are two signers. Each signer object contains the following details:firstName- The first name of the signer.lastName-The last name of the signer.phoneNumber- The phone number of the signer.email- The email address of the signer.role- The role of the signer in the signature process.order- The order in which the signers are expected to sign (0 being the first).verificationCode- A verification code associated with the signer.returnSignLink- A boolean indicating whether a sign link should be returned to the signer.signLink- The URL of the sign link for the signer.sendSms- A boolean indicating whether an SMS notification should be sent to the signer.sendEmail- A boolean indicating whether an email notification should be sent to the signer.This endpoint allows you to create a signature campaign and assign form field coordinates and size (X, Y, Width Height) for every available field type. This request will not require Template Id unlike with Creating Signature Campaign using a Template. The signature requests will be sent to the recipients via SMS and email.
\nRequest Notes
\n\n#URL#) where the actual signing link will be placed.#URL#) where the download link to the completed document will be placed.HTTP POST to your Callback URL as soon as there's a change in the signature request status. You can see more information on getting Signature Request status via webhook on Receive Signature Request Status Via Webhook section under Getting Campaign Status and Completed section folder in this documentation.SignatureRequests (required) - This is the list of the signature requests or envelopes you want to send to your customers for signing. You can send a single or multiple SignatureRequests on one API call. See below for sample SignatureRequests.
A SignatureRequest contains the following elements:
Signers (required) - This is the list of signers you want to receive and sign the documents. A SignatureRequest can contain a single Signer element or multiple Signers (like in the case of a Borrower and Co-borrower tandem). A Signer should contain the following required elements: FirstName, LastName, PhoneNumber (in the format +[COUNTRY CODE][VALID PHONE NUMBER]), and VerificationCode. Optional elements are Email, Role, and Order.
Additional notes on Signer element:
We will have to get the document's width ratio basing from the base size of the document which is 612 x 792 DPI. To do that, we will divide 612 (standard doc width in pixels) to 792 (ledger doc width in pixels) The ratio would be 0.7727
To get the document height, use this computation:
New Doc Height / sqrt(pow(ratio, 2) + 1) = new height
1224 / sqrt(pow(0.7727, 2) + 1 = 990
Therefore, the new document resolution is: 612 X 990.
Now, we can calculate the new coordinates. Here is a sample computation from the given values and obtained ratio:
New x position : 600 \\\\* 0.7727 = 463
Adjusting the textbox width: 300 \\\\* 0.7727 = 232
Calculate y scaling ratio: 990 / 792 = 1.25
Calculate y position: 700\\\\* 1.25 = 875
Consider the invisible margin to get the new y position: 700 - ((990 - 875) / 2) = 642.5
The new coordinates are (X,Y,W) = (463, 642.5, 232)
Additional notes on Formfields element:
Usable formfield types:
\nDocuments (optional) - If UpdateDocuments is set to true, this element is required. This should contain a list of FileContent and FileName elements. When uploading multiple documents, they will be merged into a single document. The documents will be ordered according to their order on the list.
Additional Notes on Documents element:
FileContent (required) - This should contain the document (in PDF format) file's byte array encoded in Base64. The file's size should not exceed 40 MB.
FileName (optional) - The name of the document file. If provided, it helps identify each document.
Response Notes
\n\nResponse Description
\nsignatureCampaignId - represents the unique identifier for the signature campaign.
signatureRequests - an array containing one or more signature request objects. In this case, there is only one signature request object.
Each signature request object contains the following information:
signatureRequestId: A unique identifier for the signature request.
signers: An array of signer objects representing the individuals involved in the signature request. In this example, there are two signers.Each signer object contains the following details:
firstName- The first name of the signer.
lastName-The last name of the signer.
phoneNumber- The phone number of the signer.
email- The email address of the signer.
role- The role of the signer in the signature process.
order- The order in which the signers are expected to sign (0 being the first).
verificationCode- A verification code associated with the signer.
returnSignLink- A boolean indicating whether a sign link should be returned to the signer.
signLink- The URL of the sign link for the signer.
sendSms- A boolean indicating whether an SMS notification should be sent to the signer.
sendEmail- A boolean indicating whether an email notification should be sent to the signer.
Here is an example of a signature request with document upload requirement. On the Custom Fields section of the API request of this format:
\nName: UploadRequirementsValue: {Role}|{Requirements}
For example, if you want to require the borrower to upload a photo of driver’s license and social security card, the custom field would look like this:
\nName: UploadRequirementsValue: Borrower|Drivers License, Social Security Card
Then when the borrower receives the message and click on the sign link, after verification, a screen will show to ask the borrower to upload required pictures. If the borrower opened the link on a mobile phone, he/she can use the phone’s camera to take a photo of the ID or select from existing photos. After uploading the requirement, he/she can proceed to finish signing the documents.
\nTo view the uploaded requirement, please refer to Getting Uploaded Requirements Section in this documentation.
\nResponse Notes
\n\nA successful response will contain a SignatureCampaignId with information including the signature request(s) within the campaign, and details about each signer involved in the request(s). You can use the SIgnatureCampaignId to get the status of the campaign via the Get Signature Campaign Status endpoint.
Here is an example of a signature request with Verification via CryptoVerifi. On the Custom Fields section of the API request of this format:
\nName: \"VerifyIdentity\",Value: {Role}
For example, if you want to enable CryptoVerifi for the borrower, the custom field would look like this:
\nName: \"VerifyIdentity\",Value: \"borrower\"
Then when the borrower receives the message and clicks on the sign link, a verification screen will show to start the verification process. When the signer is verified, he/she can sign and complete the document.
\nResponse Notes
\n\nA successful response will contain a SignatureCampaignId with information including the signature request(s) within the campaign, and details about each signer involved in the request(s). You can use the SIgnatureCampaignId to get the status of the campaign via the Get Signature Campaign Status endpoint.
Here is an example of a signature request that accepts multiple document upload. On the Documents section of the API request:
\n\"documents\":[\n {\n \"fileContent\":\"file's byte array encoded in Base64 here\",\n \"fileName\":\"Template 1.pdf\"\n },\n {\n \"fileContent\":\"file's byte array encoded in Base64 here\",\n \"fileName\":\"Template 2.pdf\"\n },\n {\n \"fileContent\":\"file's byte array encoded in Base64 here\",\n \"fileName\":\"Template 3.pdf\"\n },\n {\n \"fileContent\":\"file's byte array encoded in Base64 here\",\n \"fileName\":\"Template 4.pdf\"\n }\n]\n\nWhen uploading multiple documents, they will be merged into a single document. The documents will be ordered according to their order on the list. Ensure that the combined size of all documents does not exceed 40 MB.
\nResponse Notes
\n\nA successful response will contain a SignatureCampaignId with information including the signature request(s) within the campaign, and details about each signer involved in the request(s). You can use the SIgnatureCampaignId to get the status of the campaign via the Get Signature Campaign Status endpoint.
This endpoint allows you to get the status of signature campaigns you have submitted and download the completed or signed document. You will just need to place the SignatureCampaignId at the end of the endpoint URL.\n
\nThe resulting JSON response will contain the campaign details and a list of SignatureRequests with its signer and delivery status information. Status can be Queued, Sent, Failed, Declined, or Completed.\n
\nIf a SignatureRequest is already completed (means the document has already been signed), a DocumentDownloadLink in the JSON response will be available. You can use this link to download a copy of the completed/signed document.
This endpoint allows you to get the status of a single SignatureRequest that is included in a signature campaign you have submitted. You will just need to place the SignatureRequestId at the end of the endpoint URL.\n
\nThe resulting JSON response will contain the SignatureRequest details with its signer and delivery status information. Status can be Queued, Sent, Failed, Declined, or Completed.\n
\nIf a SignatureRequest is already completed (means the document has already been signed), a DocumentDownloadLink in the JSON response will be available. You can use this link to download a copy of the completed/signed document.
Sending a signature campaign enables you to receive real-time status update with the use of a webhook on the statuscallbackURL provided on your API request. Every time a document is sent, viewed, or signed by both signers and sender, our API will do a HTTP POST to your Callback URL. This is an easy way to get the status update of your request.
\nNotes on Status Update:
\nIt is important to respond with HTTP Server Response 200 to acknowledge the receipt of status update. Failure to acknowledge the response or sending a response other than Response 200,our system will continue to attempt the status delivery up to three (3) retries before marking the status post as failed.
The following are response samples for every document update.
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"cd685088-82b9-40aa-a30e-d72a0a9235f7","name":"Receive Signature Request Status via Webhook - Sent To Signer","originalRequest":{"method":"VIEW","header":[],"url":""},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"SignatureCampaignId\": \"---id here---\",\r\n \"TemplateId\": \"---id here---\",\r\n \"Subject\": \"\",\r\n \"Message\": \"\",\r\n \"InviteSms\": \"Crypton Mobile has sent documents for review and signature. To begin the process, click here #URL# Reply STOP to stop.\",\r\n \"ThankYouSms\": \"Your documents have been CryptoSigned and are now complete. To view them, click here #URL# Reply STOP to stop.\",\r\n \"SendCopyToSignerEmail\": true,\r\n \"SignatureRequests\": [\r\n {\r\n \"SignatureRequestId\": \"---id here---\",\r\n \"Status\": \"Sent\",\r\n \"Signers\": [\r\n {\r\n \"SignatureId\": \"---id here---\",\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Smith\",\r\n \"PhoneNumber\": \"+11000000015\",\r\n \"Email\": \"johnsmith@domain.com\",\r\n \"Role\": \"Borrower\",\r\n \"Order\": 0,\r\n \"VerificationCode\": \"1234\",\r\n \"Status\": \"Queued\",\r\n \"SmsStatus\": \"Sent via email only\",\r\n \"EmailStatus\": \"Sent - Delivered\"\r\n },\r\n {\r\n \"SignatureId\": \"---id here---2\",\r\n \"FirstName\": \"Jane\",\r\n \"LastName\": \"Smith\",\r\n \"PhoneNumber\": \"\",\r\n \"Email\": \"janesmith@domain.com\",\r\n \"Role\": \"Sender\",\r\n \"Order\": 1,\r\n \"VerificationCode\": \"123456\",\r\n \"Status\": \"Queued\",\r\n \"SmsStatus\": \"\",\r\n \"EmailStatus\": \"\"\r\n }\r\n ],\r\n \"CustomFields\": [\r\n {\r\n \"Name\": \"Name\",\r\n \"Value\": \"John Smith\"\r\n }\r\n ],\r\n \"DateCreated\": \"2022-01-21T03:06:14.833Z\"\r\n }\r\n ]\r\n}"},{"id":"9765f68e-b4f2-4304-bff8-523a52b20a88","name":"Receive Signature Request Status via Webhook - Viewed By Signer","originalRequest":{"method":"VIEW","header":[],"url":""},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"SignatureCampaignId\": \"---id here---\",\r\n \"TemplateId\": \"---id here---\",\r\n \"Subject\": \"\",\r\n \"Message\": \"\",\r\n \"InviteSms\": \"Crypton Mobile has sent documents for review and signature. To begin the process, click here #URL# Reply STOP to stop.\",\r\n \"ThankYouSms\": \"Your documents have been CryptoSigned and are now complete. To view them, click here #URL# Reply STOP to stop.\",\r\n \"SendCopyToSignerEmail\": true,\r\n \"SignatureRequests\": [\r\n {\r\n \"SignatureRequestId\": \"---id here---\",\r\n \"Status\": \"Sent\",\r\n \"Signers\": [\r\n {\r\n \"SignatureId\": \"---id here---\",\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Smith\",\r\n \"PhoneNumber\": \"+11000000015\",\r\n \"Email\": \"johnsmith@domain.com\",\r\n \"Role\": \"Borrower\",\r\n \"Order\": 0,\r\n \"VerificationCode\": \"1234\",\r\n \"Status\": \"Viewed\",\r\n \"SmsStatus\": \"Sent via email only\",\r\n \"EmailStatus\": \"Sent - Delivered\"\r\n },\r\n {\r\n \"SignatureId\": \"---id here---2\",\r\n \"FirstName\": \"Jane\",\r\n \"LastName\": \"Smith\",\r\n \"PhoneNumber\": \"\",\r\n \"Email\": \"janesmith@domain.com\",\r\n \"Role\": \"Sender\",\r\n \"Order\": 1,\r\n \"VerificationCode\": \"123456\",\r\n \"Status\": \"Queued\",\r\n \"SmsStatus\": \"\",\r\n \"EmailStatus\": \"\"\r\n }\r\n ],\r\n \"CustomFields\": [\r\n {\r\n \"Name\": \"Name\",\r\n \"Value\": \"John Smith\"\r\n }\r\n ],\r\n \"DateCreated\": \"2022-01-21T03:06:14.833Z\"\r\n }\r\n ]\r\n}"},{"id":"e9d43ee2-81db-4827-bdd2-734e0a3d33c9","name":"Receive Signature Request Status via Webhook - Signed By Signer","originalRequest":{"method":"VIEW","header":[],"url":""},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"SignatureCampaignId\": \"---id here---\",\r\n \"TemplateId\": \"---id here---\",\r\n \"Subject\": \"\",\r\n \"Message\": \"\",\r\n \"InviteSms\": \"Crypton Mobile has sent documents for review and signature. To begin the process, click here #URL# Reply STOP to stop.\",\r\n \"ThankYouSms\": \"Your documents have been CryptoSigned and are now complete. To view them, click here #URL# Reply STOP to stop.\",\r\n \"SendCopyToSignerEmail\": true,\r\n \"SignatureRequests\": [\r\n {\r\n \"SignatureRequestId\": \"---id here---\",\r\n \"Status\": \"Sent\",\r\n \"Signers\": [\r\n {\r\n \"SignatureId\": \"---id here---\",\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Smith\",\r\n \"PhoneNumber\": \"+11000000015\",\r\n \"Email\": \"johnsmith@domain.com\",\r\n \"Role\": \"Borrower\",\r\n \"Order\": 0,\r\n \"VerificationCode\": \"1234\",\r\n \"Status\": \"Signed\",\r\n \"SmsStatus\": \"Sent via email only\",\r\n \"EmailStatus\": \"Sent - Delivered\"\r\n },\r\n {\r\n \"SignatureId\": \"---id here---2\",\r\n \"FirstName\": \"Jane\",\r\n \"LastName\": \"Smith\",\r\n \"PhoneNumber\": \"\",\r\n \"Email\": \"janesmith@domain.com\",\r\n \"Role\": \"Sender\",\r\n \"Order\": 1,\r\n \"VerificationCode\": \"123456\",\r\n \"Status\": \"Queued\",\r\n \"SmsStatus\": \"\",\r\n \"EmailStatus\": \"\"\r\n }\r\n ],\r\n \"CustomFields\": [\r\n {\r\n \"Name\": \"Name\",\r\n \"Value\": \"John Smith\"\r\n }\r\n ],\r\n \"DateCreated\": \"2022-01-21T03:06:14.833Z\"\r\n }\r\n ]\r\n}"},{"id":"bfda8823-70fa-4039-a4f1-583929b45ccd","name":"Receive Signature Request Status via Webhook - Viewed By Sender","originalRequest":{"method":"VIEW","header":[],"url":""},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"SignatureCampaignId\": \"---id here---\",\r\n \"TemplateId\": \"---id here---\",\r\n \"Subject\": \"\",\r\n \"Message\": \"\",\r\n \"InviteSms\": \"Crypton Mobile has sent documents for review and signature. To begin the process, click here #URL# Reply STOP to stop.\",\r\n \"ThankYouSms\": \"Your documents have been CryptoSigned and are now complete. To view them, click here #URL# Reply STOP to stop.\",\r\n \"SendCopyToSignerEmail\": true,\r\n \"SignatureRequests\": [\r\n {\r\n \"SignatureRequestId\": \"---id here---\", \r\n \"Status\": \"Sent\",\r\n \"Signers\": [\r\n {\r\n \"SignatureId\": \"---id here---\",\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Smith\",\r\n \"PhoneNumber\": \"+11000000015\",\r\n \"Email\": \"johnsmith@domain.com\",\r\n \"Role\": \"Borrower\",\r\n \"Order\": 0,\r\n \"VerificationCode\": \"1234\",\r\n \"Status\": \"Signed\",\r\n \"SmsStatus\": \"Sent via email only\",\r\n \"EmailStatus\": \"Sent - Delivered\",\r\n\t\t \"DateSigned\": \"2022-01-21T03:13:19Z\"\r\n },\r\n {\r\n \"SignatureId\": \"---id here---2\",\r\n \"FirstName\": \"Jane\",\r\n \"LastName\": \"Smith\",\r\n \"PhoneNumber\": \"\",\r\n \"Email\": \"janesmith@domain.com\",\r\n \"Role\": \"Sender\",\r\n \"Order\": 1,\r\n \"VerificationCode\": \"123456\",\r\n \"Status\": \"Viewed\",\r\n \"SmsStatus\": \"\",\r\n \"EmailStatus\": \"\"\r\n }\r\n ],\r\n \"CustomFields\": [\r\n {\r\n \"Name\": \"Name\",\r\n \"Value\": \"John Smith\"\r\n }\r\n ],\r\n \"DateCreated\": \"2022-01-21T03:06:14.833Z\"\r\n }\r\n ]\r\n}"},{"id":"79bf2fad-2305-42ed-9a96-0e8b1f53f533","name":"Receive Signature Request Status via Webhook - Signed By Signer","originalRequest":{"method":"VIEW","header":[],"url":""},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"SignatureCampaignId\": \"---id here---\",\r\n \"TemplateId\": \"---id here---\",\r\n \"Subject\": \"\",\r\n \"Message\": \"\",\r\n \"InviteSms\": \"Crypton Mobile has sent documents for review and signature. To begin the process, click here #URL# Reply STOP to stop.\",\r\n \"ThankYouSms\": \"Your documents have been CryptoSigned and are now complete. To view them, click here #URL# Reply STOP to stop.\",\r\n \"SendCopyToSignerEmail\": true,\r\n \"SignatureRequests\": [\r\n {\r\n \"SignatureRequestId\": \"---id here---\",\r\n \"Status\": \"Sent\",\r\n \"Signers\": [\r\n {\r\n \"SignatureId\": \"---id here---\",\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Smith\",\r\n \"PhoneNumber\": \"+11000000015\",\r\n \"Email\": \"johnsmith@domain.com\",\r\n \"Role\": \"Borrower\",\r\n \"Order\": 0,\r\n \"VerificationCode\": \"1234\",\r\n \"Status\": \"Signed\",\r\n \"SmsStatus\": \"Sent via email only\",\r\n \"EmailStatus\": \"Sent - Delivered\",\r\n\t\t \"DateSigned\": \"2022-01-21T03:13:19Z\"\r\n },\r\n {\r\n \"SignatureId\": \"---id here---2\",\r\n \"FirstName\": \"Jane\",\r\n \"LastName\": \"Smith\",\r\n \"PhoneNumber\": \"\",\r\n \"Email\": \"janesmith@domain.com\",\r\n \"Role\": \"Sender\",\r\n \"Order\": 1,\r\n \"VerificationCode\": \"123456\",\r\n \"Status\": \"Signed\",\r\n \"SmsStatus\": \"\",\r\n \"EmailStatus\": \"\",\r\n\t\t \"DateSigned\": \"2022-01-21T03:15:21Z\"\r\n }\r\n ],\r\n \"CustomFields\": [\r\n {\r\n \"Name\": \"Name\", \r\n \"Value\": \"John Smith\"\r\n }\r\n ],\r\n \"DateCreated\": \"2022-01-21T03:06:14.833Z\"\r\n }\r\n ]\r\n}"},{"id":"f76426e3-1f3f-40ed-9055-525072a4d5bd","name":"Receive Signature Request Status via Webhook - Document Completed","originalRequest":{"method":"VIEW","header":[],"url":""},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"SignatureCampaignId\": \"---id here---\",\r\n \"TemplateId\": \"---id here---\",\r\n \"Subject\": \"\",\r\n \"Message\": \"\",\r\n \"InviteSms\": \"Crypton Mobile has sent documents for review and signature. To begin the process, click here #URL# Reply STOP to stop.\",\r\n \"ThankYouSms\": \"Your documents have been CryptoSigned and are now complete. To view them, click here #URL# Reply STOP to stop.\",\r\n \"SendCopyToSignerEmail\": true,\r\n \"SignatureRequests\": [\r\n {\r\n \"SignatureRequestId\": \"---id here---\",\r\n \"Status\": \"Completed\",\r\n \"Signers\": [\r\n {\r\n \"SignatureId\": \"---id here---\",\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Smith\",\r\n \"PhoneNumber\": \"+11000000015\",\r\n \"Email\": \"johnsmith@domain.com\",\r\n \"Role\": \"Borrower\",\r\n \"Order\": 0,\r\n \"VerificationCode\": \"1234\",\r\n \"Status\": \"Signed\",\r\n \"SmsStatus\": \"Sent via email only\",\r\n \"EmailStatus\": \"Sent - Delivered\",\r\n\t\t \"DateSigned\": \"2022-01-21T03:13:19Z\"\r\n },\r\n {\r\n \"SignatureId\": \"---id here---2\",\r\n \"FirstName\": \"Jane\",\r\n \"LastName\": \"Smith\",\r\n \"PhoneNumber\": \"\",\r\n \"Email\": \"janesmith@domain.com\",\r\n \"Role\": \"Sender\",\r\n \"Order\": 1,\r\n \"VerificationCode\": \"123456\",\r\n \"Status\": \"Signed\",\r\n \"SmsStatus\": \"\",\r\n \"EmailStatus\": \"\",\r\n\t\t \"DateSigned\": \"2022-01-21T03:15:21Z\"\r\n }\r\n ],\r\n \"CustomFields\": [\r\n {\r\n \"Name\": \"Name\",\r\n \"Value\": \"John Smith\"\r\n }\r\n ],\r\n \"DocumentDownloadLink\": \"https://esign.edocs.co/tools/view-doc/{document id here}\",\r\n \"DateCreated\": \"2022-01-21T03:06:14.833Z\",\r\n \"DateCompleted\": \"2022-01-21T03:15:23Z\"\r\n\t \r\n }\r\n ]\r\n} "},{"id":"45604e91-c52e-4907-a830-fb94a25f984c","name":"Receive Signature Request Status via Webhook - Verification Success","originalRequest":{"method":"VIEW","header":[],"url":""},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"SignatureCampaignId\": \"---id here---\",\r\n \"TemplateId\": \"---id here---\",\r\n \"Subject\": \"Your Document Is Ready For Signing\",\r\n \"Message\": \"Please sign this document to renew your contract with us. You may contact support for any questions. Thank you!\",\r\n \"InviteSms\": \"We have sent you documents for your review and signature. To begin the process, click #URL# Reply STOP to stop.\",\r\n \"ThankYouSms\": \"Your documents have been CryptoSigned and are now complete. To view them, click here #URL# #BRANCH_PHONE# Reply STOP to stop.\",\r\n \"SendCopyToSignerEmail\": false,\r\n \"SignatureRequests\": [\r\n {\r\n \"SignatureRequestId\": \"---id here---\",\r\n \"Status\": \"Queued\",\r\n \"Signers\": [\r\n {\r\n \"SignatureId\": \"---id here---\",\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Smith\",\r\n \"PhoneNumber\": \"+11000000701\",\r\n \"Email\": \"johnsmith@domain.com\",\r\n \"Role\": \"signer1\",\r\n \"Order\": 0,\r\n \"VerificationCode\": \"1234\",\r\n \"Status\": \"Sent\",\r\n \"SmsStatus\": \"Sent via email only\",\r\n \"EmailStatus\": \"Sent - Delivered\",\r\n \"VerifyIdentitySessionId\": \"---id here---\",\r\n \"VerifyIdentityResult\": {\r\n \"SessionId\": \"---id here---\",\r\n \"IdType\": \"DriversLicense\",\r\n \"IdentityVerified\": true,\r\n \"IdentityVerificationScore\": 99.9894790649414\r\n }\r\n }\r\n ],\r\n \"CustomFields\": [\r\n {\r\n \"Name\": \"VerifyIdentity\",\r\n \"Value\": \"signer1\"\r\n }\r\n ],\r\n \"DateCreated\": \"2023-11-13T06:49:10.143Z\"\r\n }\r\n ]\r\n}"},{"id":"47afcc5c-aa4b-47bf-acb1-3cd8bd9cd3aa","name":"Receive Signature Request Status via Webhook - Verification Failed","originalRequest":{"method":"VIEW","header":[],"url":""},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"SignatureCampaignId\": \"---id here---\",\r\n \"TemplateId\": \"---id here---\",\r\n \"Subject\": \"Your Document Is Ready For Signing\",\r\n \"Message\": \"Please sign this document to renew your contract with us. You may contact support for any questions. Thank you!\",\r\n \"InviteSms\": \"We have sent you documents for your review and signature. To begin the process, click #URL# Reply STOP to stop.\",\r\n \"ThankYouSms\": \"Your documents have been CryptoSigned and are now complete. To view them, click here #URL# #BRANCH_PHONE# Reply STOP to stop.\",\r\n \"SendCopyToSignerEmail\": false,\r\n \"SignatureRequests\": [\r\n {\r\n \"SignatureRequestId\": \"---id here---\",\r\n \"Status\": \"Queued\",\r\n \"Signers\": [\r\n {\r\n \"SignatureId\": \"---id here---\",\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Smith\",\r\n \"PhoneNumber\": \"+11000000701\",\r\n \"Email\": \"johnsmith@domain.com\",\r\n \"Role\": \"signer1\",\r\n \"Order\": 0,\r\n \"VerificationCode\": \"1234\",\r\n \"Status\": \"Sent\",\r\n \"SmsStatus\": \"Sent via email only\",\r\n \"EmailStatus\": \"Sent - Delivered\",\r\n \"VerifyIdentitySessionId\": \"---id here---\",\r\n \"VerifyIdentityResult\": {\r\n \"SessionId\": \"---id here---\",\r\n \"IdType\": \"DriversLicense\",\r\n \"IdentityVerified\": false,\r\n \"IdentityVerificationScore\": 0.0\r\n }\r\n }\r\n ],\r\n \"CustomFields\": [\r\n {\r\n \"Name\": \"VerifyIdentity\",\r\n \"Value\": \"signer1\"\r\n }\r\n ],\r\n \"DateCreated\": \"2023-11-13T06:49:10.143Z\"\r\n }\r\n ]\r\n}"}],"_postman_id":"e7946303-1698-4f75-a7a9-61b7f1d5a8b8"}],"id":"af7f6502-0741-4896-a254-341639a4d952","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"dc32ae46-bd7a-461f-88d3-c32a5ca7c33f"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"d54a9a7b-090c-4c84-8c7e-5c1641b3caca"}}],"_postman_id":"af7f6502-0741-4896-a254-341639a4d952","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"c1eaade9-a4ee-47fd-a64e-e352ed5a201e","id":"c1eaade9-a4ee-47fd-a64e-e352ed5a201e","name":"Crypton Mobile CryptoSign API","type":"collection"}}},{"name":"Resending a Signature Request","item":[{"name":"Resend a Signature Request","id":"1e5ada06-f08a-403e-bd6d-5f380db423a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"SendEmail\": true,\r\n \"Email\": \"john.smith@email.com\",\r\n \"SendSMS\": true,\r\n \"PhoneNumber\": \"+11001000017\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://esignapi.edocs.co/v1/signaturerequest/{{SignatureRequestId}}/resend/{{SignatureId}}","description":"This endpoint allows you to resend a signing link to a recipient. Use this feature to ensure that recipients receive the signature request and complete the signing process as needed. This is useful for recipients who encounter issues with receiving signing notifications.
\nRequest Notes:
\n\nSendEmail (required, boolean): Set this flag to true to resend the signature request notification via email. Provide the recipient's email address in the Email field to specify the recipient.
Email (optional, string): If SendEmail is set to true, provide the recipient's email address here. This field specifies the email recipient for the resent signature request.
SendSMS (required, boolean): Set this flag to true to resend the signature request notification via SMS (Short Message Service). Use the PhoneNumber field to specify the recipient's phone number.
PhoneNumber (optional, string): If SendSMS is set to true, provide the recipient's phone number here, including the country code. This field specifies the phone number recipient for the resent signature request notification. Sample phone number format: +11001000017.
Response Notes:
\n\nsignatureRequestId (string): This indicates the unique identifier associated with the signature request that was targeted for resending. This value helps you identify the specific signature request that received the resend request.
\nsignatureId (string): This is the unique identifier of the signature within the signature request that was resent. This value assists in pinpointing the exact signature that was the focus of the resend operation.
\nsendEmail (boolean): This states whether the signature request notification was successfully sent via email. A value of true means that an email notification was dispatched.
email (string): This corresponds to the recipient's email address to which the email notification was sent. This field confirms the email recipient for the resent signature request notification.
\nsendSMS (boolean): This indicates whether the signature request notification was successfully sent via SMS. A value of true means that an SMS notification was dispatched.
phoneNumber (string): This shows the recipient's phone number to which the SMS notification was sent. This field confirms the phone number recipient for the resent signature request notification.
\nThis endpoint allows you to cancel a signature request. You will be able to cancel a completed or on-going signature request. Additionally, you can choose whether to send a notification when canceling the request by setting the optional SendNotification parameter to either true (default) or false. After successful cancellation, the final document status will be marked as CANCELLED.
This endpoint allows you to mark a contract as paid in full. A successful transaction will mark the contract as “FULLY PAID” and will be resent to the signers and client.\n
\n
Request Notes
\nResponse Notes
\nWhen signing a document, signers/customers may have to upload requirements such as images of their IDs. This endpoint allows you to get the details of the uploaded requirements of a signature request. \n
Response Notes
\nThis endpoint allows you to download a specific uploaded file with the given SignatureRequestId and FileId. The URL parameter FileId can be obtained from the Get Uploaded File Details endpoint.
\nResponse Notes
\nThis endpoint allows you to search completed signature requests by providing search filters such as customer's phone number or email and a specific date range. The resulting response will contain a link that you can use to download a copy of the document.
\nResponse Notes
\n\nHTTP 200 OK with a listing of completed signature requests with download links to the document in JSON format. Please see sample response below.HTTP 400 Bad Request with JSON response of the errorSample Response
\nYou can see in this response the signers info, the date the signature request was completed, and also a download link which also requires basic authentication.
\n[\n {\n \"signers\": [\n {\n \"signatureId\": {signatureId},\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phoneNumber\": \"+11234567890\",\n \"email\": \"johnsmith@cryptonmobile.com\",\n \"role\": \"Borrower\"\n },\n {\n \"signatureId\": {signatureId},\n \"firstName\": \"Sender\",\n \"lastName\": \"Test\",\n \"phoneNumber\": \"+11234567891\",\n \"email\": \"\",\n \"role\": \"Sender\"\n }\n ],\n \"dateCompleted\": \"2021-09-27711:29:21\",\n \"downloadlink\": \"/vl/signaturerequest/files/{SignatureRequestId}\"\n },\n {\n \"signers\": [\n {\n \"signatureld\": {signatureId},\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"phoneNumber\": \"+11234567890\",\n \"email\": \"johnsmith@cryptonmobile.com\",\n \"role\": \"Borrower\"\n },\n {\n \"signatureId\": {signatureId},\n \"firstName\": \"Sender\",\n \"lastName\": \"Test\",\n \"phoneNumber\": \"+11234567891\",\n \"email\": \"\",\n \"role\": \"Sender\"\n }\n ],\n \"dateCompleted\": \"2021-09-09T18:34:29\",\n \"downloadlink\": \"/vl/signaturerequest/files/{SignatureRequestId}\"\n }\n]\n\n(optional) – This would be the customer/signer’s phone number in this format: [country code][10-digit phonenumber]. Ex: 11234567890
\n","type":"text/plain"},"key":"phonenumber","value":"{phonenumber}"},{"description":{"content":"(optional) – This should be the customer/signer’s email address. Ex: john@cryptonmobile.com
\n","type":"text/plain"},"key":"email","value":"{email}"},{"description":{"content":"(optional) - This would be the start date of a date range filter
\n","type":"text/plain"},"key":"startdate","value":"{startdate}"},{"description":{"content":"(optional) - This would be the end date of a date range filter
\n","type":"text/plain"},"key":"enddate","value":"{enddate}"}],"variable":[]}},"response":[{"id":"1f31dbdf-b740-43cd-a297-ccf6a36af609","name":"Get Completed Signature Requests","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://esignapi.edocs.co/v1/signaturerequest/search/?phonenumber={phonenumber}&email={email}&startdate={startdate}&enddate={enddate}","protocol":"https","host":["esignapi","edocs","co"],"path":["v1","signaturerequest","search",""],"query":[{"key":"phonenumber","value":"{phonenumber}","description":"(optional) – This would be the customer/signer’s phone number in this format: [country code][10-digit phonenumber]. Ex: 11234567890"},{"key":"email","value":"{email}","description":"(optional) – This should be the customer/signer’s email address. Ex: john@cryptonmobile.com"},{"key":"startdate","value":"{startdate}","description":"(optional) - This would be the start date of a date range filter"},{"key":"enddate","value":"{enddate}","description":"(optional) - This would be the end date of a date range filter"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\r\n\t{\r\n\t\t\"signers\": [\r\n\t\t\t{\r\n\t\t\t\t\"signatureId\": {signatureId},\t\t\t\t\r\n\t\t\t\t\"firstName\": \"John\",\r\n\t\t\t\t\"lastName\": \"Smith\",\r\n\t\t\t\t\"phoneNumber\": \"+11000000011\",\r\n\t\t\t\t\"email\": \"johnsmith@emaildomain.com\",\r\n\t\t\t\t\"role\": \"Borrower\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"signatureId\": {signatureId},\r\n\t\t\t\t\"firstName\": \"Jane\",\r\n\t\t\t\t\"lastName\": \"Smith\",\r\n\t\t\t\t\"phoneNumber\": \"+11000000012\",\r\n\t\t\t\t\"email\": \"janesmith@emaildomain.com\",\r\n\t\t\t\t\"role\": \"Coborrower\"\r\n\t\t\t}\r\n\t\t],\r\n\t\t\"dateCompleted\": \"2024-01-23T08:29:34\",\r\n\t\t\"downloadLink\": \"/v1/signaturerequest/files/{signatureRequestId}\"\r\n\t},\r\n\t\r\n\t{\r\n\t\t\"signers\": [\r\n\t\t\t{\r\n\t\t\t\t\"signatureId\": {signatureId},\t\t\t\t\r\n\t\t\t\t\"firstName\": \"John\",\r\n\t\t\t\t\"lastName\": \"Smith\",\r\n\t\t\t\t\"phoneNumber\": \"+11000000011\",\r\n\t\t\t\t\"email\": \"johnsmith@emaildomain.com\",\r\n\t\t\t\t\"role\": \"Borrower\",\r\n\t\t\t}\r\n\t\t],\r\n\t\t\"dateCompleted\": \"2024-01-23T06:40:05\",\r\n\t\t\"downloadLink\": \"/v1/signaturerequest/files/{signatureRequestId}\"\r\n\t}\r\n\t\r\n]"}],"_postman_id":"687ef6fe-d781-4dab-89e9-c1c1313cefb5"}],"id":"831789fd-43fd-4664-9e80-466c95d03910","_postman_id":"831789fd-43fd-4664-9e80-466c95d03910","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"c1eaade9-a4ee-47fd-a64e-e352ed5a201e","id":"c1eaade9-a4ee-47fd-a64e-e352ed5a201e","name":"Crypton Mobile CryptoSign API","type":"collection"}}},{"name":"Getting Cancelled Signature Requests","item":[{"name":"Get Cancelled Signature Requests","id":"1b8b5a19-c085-4ad6-950d-8a1c05ff7e19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://esignapi.edocs.co/v1/signaturerequest/cancelled?startdate={startdate}&enddate={enddate}","description":"This API endpoint allows you to get the list of signature requests that have been canceled within a specific date range.
\nResponse Notes
\nThe resulting JSON response will contain the list of SignatureRequest details of all canceled documents that were specified on the date range parameter. Note that DateCancelled is in UTC format.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"c1eaade9-a4ee-47fd-a64e-e352ed5a201e","id":"c1eaade9-a4ee-47fd-a64e-e352ed5a201e","name":"Crypton Mobile CryptoSign API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","signaturerequest","cancelled"],"host":["esignapi","edocs","co"],"query":[{"description":{"content":"(required) - This would be the start date of a date range filter
\n","type":"text/plain"},"key":"startdate","value":"{startdate}"},{"description":{"content":"(required) - This would be the end date of a date range filter. Maximum date range is 30 days
\n","type":"text/plain"},"key":"enddate","value":"{enddate}"}],"variable":[]}},"response":[{"id":"9551d490-5347-4872-aa11-7e0d3007c26d","name":"Get Cancelled Signature Requests","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://esignapi.edocs.co/v1/signaturerequest/cancelled?startdate={startdate}&enddate={enddate}","protocol":"https","host":["esignapi","edocs","co"],"path":["v1","signaturerequest","cancelled"],"query":[{"key":"startdate","value":"{startdate}","description":"(required) - This would be the start date of a date range filter"},{"key":"enddate","value":"{enddate}","description":"(required) - This would be the end date of a date range filter. Maximum date range is 30 days"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\r\n\t{\r\n\t\t\"signatureRequestId\": {signatureRequestId},\r\n\t\t\"status\": \"Cancelled\",\r\n\t\t\"signers\": [\r\n\t\t\t{\r\n\t\t\t\t\"signatureId\": {signatureId},\r\n\t\t\t\t\"firstName\": \"John\",\r\n\t\t\t\t\"lastName\": \"Smith\",\r\n\t\t\t\t\"phoneNumber\": \"+11000000011\",\r\n\t\t\t\t\"email\": \"johnsmith@emaildomain.com\",\r\n\t\t\t\t\"role\": \"Borrower\",\r\n\t\t\t\t\"order\": 0,\r\n\t\t\t\t\"verificationCode\": \"1234\",\r\n\t\t\t\t\"status\": \"Viewed\"\r\n\t\t\t}\r\n\t\t],\r\n\t\t\"customFields\": [\r\n\t\t\t{\r\n\t\t\t\t\"name\": \"Borrower_first_name\",\r\n\t\t\t\t\"value\": \"John\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"name\": \"Borrower_last_name\",\r\n\t\t\t\t\"value\": \"Smith\"\r\n\t\t\t}\r\n\t\t],\r\n\t\t\"documentDownloadLink\": \"/v1/signaturerequest/files/{signatureRequestId}\",\r\n\t\t\"dateCreated\": \"2024-01-04T17:00:31.333\",\r\n\t\t\"dateCancelled\": \"2024-01-04T17:57:33.733\"\r\n\t},\r\n\t{\r\n\t\t\"signatureRequestId\": {signatureRequestId},\r\n\t\t\"status\": \"Cancelled\",\r\n\t\t\"signers\": [\r\n\t\t\t{\r\n\t\t\t\t\"signatureId\": {signatureId},\r\n\t\t\t\t\"firstName\": \"John\",\r\n\t\t\t\t\"lastName\": \"Smith\",\r\n\t\t\t\t\"phoneNumber\": \"+11000000011\",\r\n\t\t\t\t\"email\": \"johnsmith@emaildomain.com\",\r\n\t\t\t\t\"role\": \"Borrower\",\r\n\t\t\t\t\"order\": 0,\r\n\t\t\t\t\"verificationCode\": \"1234\",\r\n\t\t\t\t\"status\": \"Queued\"\r\n\t\t\t}\r\n\t\t],\r\n\t\t\"customFields\": [\r\n\t\t\t{\r\n\t\t\t\t\"name\": \"Borrower_first_name\",\r\n\t\t\t\t\"value\": \"John\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"name\": \"Borrower_last_name\",\r\n\t\t\t\t\"value\": \"Smith\"\r\n\t\t\t}\r\n\t\t],\r\n\t\t\"documentDownloadLink\": \"/v1/signaturerequest/files/{signatureRequestId}\",\r\n\t\t\"dateCreated\": \"2024-01-04T17:21:34.837\",\r\n\t\t\"dateCancelled\": \"2024-01-04T17:59:14.203\"\r\n\t}\r\n]"}],"_postman_id":"1b8b5a19-c085-4ad6-950d-8a1c05ff7e19"}],"id":"22d50a67-606c-4ebb-aa84-8c20743d5cfc","_postman_id":"22d50a67-606c-4ebb-aa84-8c20743d5cfc","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"c1eaade9-a4ee-47fd-a64e-e352ed5a201e","id":"c1eaade9-a4ee-47fd-a64e-e352ed5a201e","name":"Crypton Mobile CryptoSign API","type":"collection"}}},{"name":"Embedded Signing","item":[],"id":"7cd31cf1-c08c-48ab-9359-8cbaf7c1d4c7","description":"
This feature allows you to have your signers view and sign documents within your own website. The documentation below will guide you through the process of setting up embedded signing, know what elements to add in your API requests, and what to look for in responses.
Preparation and Testing:
Submitting an API request with ReturnSignLink \n
To start doing embedded signing within your application, refer to steps under Creating Signature Campaign section and add a ReturnSignLink on the Signer element.
ReturnSignLink accepts Boolean (true/false) value. If this is set to true, it will return a sign link on the API response. For example, when a user sends a signature request, it will return the sign link per signer. Navigating to the returned signed link will start the signing process for each signer.
Here is a sample snippet of request code that has ReturnSignLink enabled:
... \n \"signers\": [\n {\n \"firstName\": \"Test\",\n \"lastName\": \"Signer\",\n \"phoneNumber\": \"+10000000001\",\n \"email\": \"test@signer1.com\",\n \"role\": \"Customer1\",\n \"returnSignLink\": true,\n \"order\": 0,\n \"verificationCode\": \"1975\"\n },\n...\n\nOnce a request is successfully sent, it will return a signLink in below format:
...\n \"signers\": [\n {\n \"firstName\": \"Test\",\n \"lastName\": \"Signer\",\n \"phoneNumber\": \"+10000000001\",\n \"email\": \"test@signer1.com\",\n \"role\": \"Customer1\",\n \"order\": 0,\n \"verificationCode\": \"1975\",\n \"returnSignLink\": true,\n \"signLink\": \"https://dlem.co/dem0f8\"\n },\n ...\n\nThis SignLink is what you can use to embed in your website in an iFrame or just do a simple redirect. Opening it will go directly to the signing process.
Sending SMS and Email Options \n
Since you plan on embedding the signing process within your own website, it is likely that you will also handle notifications to the signers. In this case, you may want to turn off our sending of SMS and email to the signers by setting to false the following elements in the Signer section of your API request: SendSms and SendEmail. Here is an example:
... \n \"signers\": [\n {\n \"firstName\": \"Test\",\n \"lastName\": \"Signer\",\n \"phoneNumber\": \"+10000000001\",\n \"email\": \"test@signer1.com\",\n \"role\": \"Customer1\",\n \"returnSignLink\": true,\n \"sendSms\": false,\n \"sendEmail\": false,\n \"order\": 0,\n \"verificationCode\": \"1975\"\n },\n...\n\n
Redirect Back To Your Website After Signing
Lastly, you may want to redirect your signers back to your website after they signed the document. You can do this by specifying a URL in RedirectUrlAfterSigning element in your API request. This is also useful to know what action was taken by the signer during the signing process. The redirect to your URL will happen with an additional querystring parameter. The final URL will look something like this: https://yoururl.com?actiontaken=signed. Valid values for actiontaken parameter are: signed, finishLater, and declined.
For more questions on embedded signing, just email us at support@cryptonmobile.com.