Requests and Responses

Requests in SignNow API are mostly formatted in JSON. In some cases the content-type to be used is multipart/form-data. This means that the body of almost all requests should be a valid JSON object. Here’s an example of how the POST request looks like for generating a document from a template:

curl -X POST \
https://api-eval.signnow.com/template \
-H 'Authorization: Bearer {{access_token}}' \
-H 'Content-Type: application/json' \
-d '{
"document_id":"{{document_id}}",
"document_name":"my_template"
}'

Requests and Responses rely on principles of the RESTful architecture. All actions are requested via HTTP methods: GET, POST, PUT, DELETE.

Parameters

4 main categories of each endpoint: path, query string, request body, response body

Structure of the request

  • HTTP Method
  • Base URL
  • Authorization header
  • Content-Type header
  • Request body in key-value pairs

Example:

curl -X POST https://api-eval.signnow.com/documentgroup \
-H 'Authorization: Bearer {{access_token}}' \
-H 'Content-Type: application/json' \
--data '{
"document_ids": ["cddc2f79a3873af02ebc1d1ab0d45b2a1a3a2e7b",
                 "dd63da6fbe213863626a61d36b0c13ce61e4a2be"], 
"group_name":"Document Group 1"}'

Requests to all endpoints must contain an Authorization header. In most cases it’s:

- H 'Authorization: Bearer {{access_token}}'

When you request an access token or create a new user in your organization, the Authorization header is Basic.

- H 'Authorization: Basic {{encoded_client_credentials}}'