logo
API Reference
SDKs and Tools
Changelog
Integrations
Create Sandbox
No results found.
Docs
Getting started
API Reference
Create signing link
Activate/deactivate signing link
Get signing links
Create signing link (v2)
Update signing link
Create document group signing link
Create document group signing session
Webhooks 1.0

Signing link

Signing link - a single-use link to a document that requires a signature. When the document is signed (or the signer declines to sign it), the link is no longer valid.

Keep in mind that you should get the document ID first before generating a link. Save it from a POST /document or GET /user/documents request.

This request returns 2 links:
"url" - having followed this link, the Signer is asked to log in to their SignNow account;
"url_no_signup" - document is accessible to anyone with the link.

Endpoints 
                
                  
                      POST
                     /link

The signing link object

Attributes
  • url string
    To access a document via this link, log in to signNow is required.
  • url_no_signup string
    Anyone with this link can access the document.
The template object 
                { 
              
                  "url": "http://signnow.com/s/1IFqEIt",
              
                  "url_no_signup": "http://signnow.com/s/1IFqFvT"

Create signing link

Allows API users to create a single-use link to a specific document.

Parameters
  • document_id required
    ID of a document to create a Signing Link for
  • organization_id optional
    ID of the sender's organization.
  • firstname optional
    Signer's first name which appears on the welcome message.
  • lastname optional
    Signer's last name which appears on the welcome message.
  • redirect_uri optional
    The link that opens when the Signer has filled in and signed the document by the signing link.
Returns

Returns two URLs in case of successul request: one for the Signer who has an account in signNow and one for a Signer who hasn't any. Returns an error when:

  • Invalid "from" email, "code": 65582. Message: "Document not found"
  • Invalid authorization, "code": 1537. Message: "invalid_token"
POST /link
cURL
  • cURL
  • Node.js
  • .NET 
                      
curl -X POST \          
  https://api-eval.signnow.com/link \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \       
  -d '{
  "document_id": "221a2cf5b3d0e9f75abd7e60bb236f84b27e25bd",
  "organization_id": "d15aq64wd65qw47r687wqd541a65d468wq4ed68w",
  "firstname": "Jane",
  "lastname": "Heathfield",
  "redirect_uri": "https://google.com"             
  } 
                      
                    
                      
api.link.create({
  token: 'your auth token',
  document_id: 'document or template id',
}, (err, res) => {
  // handle error or process response data
});
                      
                    
                      
public static partial class DocumentExamples
{
    /// <summary>
    /// Create a signing link to the document for signature.
    /// </summary>
    /// Identity of the document you’d like to have signed
    /// Access token
    /// <returns>
    /// Response with:
    ///  
    /// to sign the document via web browser using SignNow credentials. 
    ///  
    /// to sign the document via web browser without SignNow credentials. 
    /// </returns>
    public static async Task<SigningLinkResponse>
        CreateSigningLinkToTheDocument(string documentId, Token token)
    {
        // using token from the Authorization step
        var signNowContext = new SignNowContext(token);

        // using `documentId` from the Upload document step
        return await signNowContext.Documents
            .CreateSigningLinkAsync(documentId).ConfigureAwait(false);
    }
}
Response 
                {
  "url": "http://vm.signnow.com/s/q3KcLi29",
  "url_no_signup": "http://vm.signnow.com/s/IjsKEq9o"
}

Activate/deactivate signing link

Allows API users to activate or deactivate the existing signing links.

Parameters
  • signing_link_short_url_id required
    Path parameter: ID of a Signing Link that should be activated/deactivated
  • active required
    Boolean. Determines if the link must be active. Possible values: true - yes, the link must be active, false - deactivate the link.
Returns

Returns empty 204 successul request. Returns an error when:

  • Empty "active" parameter, "code": 0. Message: "Field `active` must be not null"
  • Incorrect value of "active" parameter, "code": 0. Message: "Field `active` must be a boolean"
  • API user is not the owner of the signing link, "code": 0. Message: "Access for the resource `signingLinkId` is forbidden"
  • Invalid "from" email, "code": 65582. Message: "Document not found"
  • Invalid authorization, "code": 1537. Message: "invalid_token"
PUT /v2/application/signing-links/{{signing_link_short_url_id}}
cURL
  • cURL 
                      
curl -X PUT \          
  https://api-eval.signnow.com/v2/application/signing-links/{{signing_link_short_url_id}} \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \       
  -d '{
  "active": true             
  }
Response (204) 
                
  No content

Get signing links

Retrieve the list of user's signing links.

Parameters
  • per_pageoptional
    Query parameter: how many links to show per page in response. Default value: 15
  • page optional
    Query parameter: in how many pages to display the response. Default value: 1
  • count optional
    Query parameter. Possible values: array with 2 items. Item type is null or integer. Format: ?filters=[{"count":{"type":"between","value":[2,5]}}]
  • active optional
    Query parameter. Filter only active or inactive links. Possible values: true/false. Format: ?filters=[{"active":{"type":"=","value":false}}]
  • created optional
    Query parameter. Filter by the date of creation. Possible values: desc (descending order)/asc (ascending order). Example: ?sort[created]=desc
  • count optional
    Query parameter. Filter by count. Possible values: desc (descending order)/asc (ascending order). Example: ?sort[count]=desc
Returns

Returns data about links. Returns an error when:

  • Invalid authorization, "code": 1537. Message: "invalid_token"
GET /v2/application/signing-links
cURL
  • cURL 
                      
curl -X GET \          
  https://api-eval.signnow.com/v2/application/signing-links?filters=[{"active":{"type":"=","value":true}}] \        
  -H 'Authorization: Basic {{basic_authorization_token}}' \
  -H 'content-type: application/json' \
Response (201) 
                {
  "data": [
    {
      "id": "247a8c718b48958df42e0556e205453bf5151f5a",
      "active": true,
      "created": 1554801793,
      "count": 7,
      "hash": "HaSh"
    }
  ],
  "meta": {
    "pagination": {
      "total": 3,
      "count": 1,
      "per_page": 1,
      "current_page": 2,
      "total_pages": 3,
      "links": {
        "previous": "http://127.0.0.1:84/v2/signing-links?per_page=1&page=1",
        "next": "http://127.0.0.1:84/v2/signing-links?per_page=1&page=3"
      }
    }
  }
}

Create signing link (v2)

Generates a signing link without query parameters.

Parameters
  • document_id required
    Path parameter: ID of a document to create a Signing Link for
  • blank_redirect optional
    The link that opens when the Signer has filled in and signed the document by the signing link.
  • form optional
    Possible values: true - the link opens on the Send Invite page where you can add signer names and addresse, null - the link opens the document in signNow editor.
  • guest_signing optional
    Boolean. Possible values: true - yes, allow guest signing, false - guest signing not allowed.
  • authentication_type optional
    Type of signer's identity verification. Possible values: password or phone.
  • password required if "authentication_type": "password"
    Signer's verification password.
  • phone required if "authentication_type": "phone"
    Signer's verification phone number.
Returns

Returns a short URL in case of successul request. Returns an error when:

  • Invalid "from" email, "code": 19002001. Message: "Document not found"
  • Invalid authorization, "code": 1537. Message: "invalid_token"
POST /v2/documents/{{document_id}}/signing-links
cURL
  • cURL 
                      
curl -X POST \          
  https://api-eval.signnow.com/v2/documents/{{document_id}}/signing-links \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \       
  -d '{
  "blank_redirect": "https://test.test",
  "form": null,
  "guest_signing": true,
  "authentication_type": "password",
  "password": 12345
}
Response 
                {
  "data": {
    "id": "8590ee488a7d43dd842dfd3aca42343297f1c151",
    "hash": "r9zGvxo3",
    "active": true,
    "count": null,
    "created": 1598633972,
    "short_url": "https://vm.signnow.com/dispatch?route=nosignup_signing_link_without_query_parameters&signing_link_id=84af4b74ae4c4f82b40cee59d6b278fa0f645a0a&document_id=027150a0da2c426abdd455369b13116ae5ccd27a"
  }
}

Update signing link (v2)

Updates a signing link without query parameters.

Parameters
  • document_id required
    Path parameter: ID of a document with a Signing Link to be updated for.
  • signing_link_short_url_id required
    Path parameter: ID of a Signing Link that must be updated.
  • blank_redirect optional
    The link that opens when the Signer has filled in and signed the document by the signing link.
  • form optional
    Possible values: true - the link opens on the Send Invite page where you can add signer names and addresse, null - the link opens the document in signNow editor.
  • guest_signing optional
    Boolean. Possible values: true - yes, allow guest signing, false - guest signing not allowed.
  • authentication_type optional
    Type of signer's identity verification. Possible values: password or phone.
  • password required if "authentication_type": "password"
    Signer's verification password.
  • phone required if "authentication_type": "phone"
    Signer's verification phone number.
Returns

Returns a short URL in case of successul request. Returns an error when:

  • Invalid "from" email, "code": 19002001. Message: "Document not found"
  • Invalid authorization, "code": 1537. Message: "invalid_token"
PUT /v2/documents/{{document_id}}/signing-links/{{signing_link_short_url_id}}
cURL
  • cURL 
                      
curl -X PUT \          
  https://api-eval.signnow.com/v2/documents/{{document_id}}/signing-links/{{signing_link_short_url_id}} \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \       
  -d '{
  "blank_redirect": "https://test.test",
  "form": null,
  "guest_signing": true,
  "authentication_type": "phone",
  "phone": +123456789
}
Response 
                {
  "data": {
    "id": "8590ee488a7d43dd842dfd3aca42343297f1c151",
    "hash": "r9zGvxo3",
    "active": true,
    "count": null,
    "created": 1598633972,
    "short_url": "https://vm.signnow.com/dispatch?route=nosignup_signing_link_without_query_parameters&signing_link_id=84af4b74ae4c4f82b40cee59d6b278fa0f645a0a&document_id=027150a0da2c426abdd455369b13116ae5ccd27a"
  }
}

Create document group signing link (v2)

Creates a signing link for a document group.

Parameters
  • document_group_id required
    Path parameter: ID of a document group to create a Signing Link for
Returns

Returns a signing link in case of successul request. Returns an error when:

  • API user is not the document group owner, "code": 19040001. Message: "Current user is not document group owner."
  • Invalid authorization, "code": 1537. Message: "invalid_token"
POST /v2/document-groups/{{document_group_id}}/signing-links
cURL
  • cURL 
                      
curl -X POST \          
  https://api-eval.signnow.com/v2/document-groups/{{document_group_id}}/signing-links \        
  -H 'Authorization: Bearer {{access_token}}' \
  -H 'content-type: application/json' \
Response 
                {
    "data": {
        "id": "2ae4c0ac7710446289987ae92f2ad6a9c8becfc2",
        "hash": "r9zGvxo3",
        "created": 1625239864,
        "url": "https://vm.signnow.com/dispatch?route=document_group_signing_link&signing_link_id=84af4b74ae4c4f82b40cee59d6b278fa0f645a0a"
    }
}

Create document group signing session

Sends a group invite with the document group signing link.

Parameters
  • document_group_id required
    Path parameter: ID of a document group to create a Signing Link for
  • document_group_signing_link_id required
    The signing link created for the document group using POST /v2/document-groups/{{document_group_id}}/signing-links request.
Returns

Returns 302 - Redirect to signing the document in case of successul request.

GET /v2/document-groups/{{document_group_id}}/signing-link/{{document_group_signing_link_id}}/create
cURL
  • cURL 
                      
curl -X GET \          
  https://api-eval.signnow.com/v2/document-groups/{{document_group_id}}/signing-link/{{document_group_signing_link_id}}/create \
Response (302) 
                {
               Redirect to signing the document group