Stiply Connect API documentatie

How to use the API

To send a sign request to one or more signers, the following procedure should be followed:

1. Create a sign request
2. Add signer(s)
3. Send sign request

The status of a sign request may be checked at every moment. Once a sign request has been signed by all signers, the signed document and the proof document can be downloaded through the API.

URL and version

The base URL of the Stiply API is https://api.stiply.nl. The current version of the Stiply API is version 1.1. To use this the prefix for all API-calls is v1.1.https://api.stiply.nl/v1.1

Example

Should you want to use the PING function (as further described below) the URL you could call would be: https://api.stiply.nl/v1/actions/ping

SDK's we provide

To make life more easy we did build two SDK's to integrate Stiply.
To download this PHP or C# .NET SDK just follow the link below.

• Download the Stiply PHP SDK
• Download the Stiply C# .NET SDK

Authentication

OAuth2

Starting from v1.1, authentication with the Stiply API will be through OAuth2 (https://oauth.net/2/). A full treatment of the OAuth2 protocol is beyond the scope of this article. Instead, the primary goal is to discuss what you need to do in order to work with OAuth2 in the context of the Stiply API.

Setup

First off, in order to connect with the Stiply API through OAuth you will need an account for which API access is enabled. Once this is done you will see an “API settings” item in the “Account” section of the right-top dropdown menu in the Stiply app:

Selecting this menu item will redirect you to a page where you can configure several API related settings^[1]. Specifically, the OAuth section will look something like:

This grant can be used to acquire an access token on behalf of a user. Sign requests are created on behalf of the user that authenticates during the authentication flow. This authentication flow requires interaction with the user at least once to provide their credentials and consent.

2. Refresh tokens
With the Authorization Code Grant, after successful authentication a refresh token is issued together with the access token. When the access token expires, the refresh token can be used (in the background) to acquire a new access token. No user interaction is required when the refresh token is used.

3. OAuth Client Credential Grant
This grant can be used to acquire a token with a client id and secret. All sign requests are created on behalf of the user that has registered the client in the Stiply application. No user interaction is required to use this grant.

4. Personal Access Tokens
A Personal Access Token(PAT) is an access token that is created in the Stiply application and can be used to authorize on the API endpoints. All sign requests are created on behalf of the user that has created the PAT. A PAT has an expiration date after which it cannot be used anymore.

Use the OAuth Authorization Code Grant (with refresh tokens) when sign requests must be created on behalf of the end user. Use the OAuth Client Credential Grant when it is ok to create sign requests on behalf of just one user, regardless wo is signed in into the application that is calling the API. Use Personal Access Tokens when it is not possible to use the other two options.

Personal Access Tokens

To create a new personal access token, simply click the “Create New Token” link. This will open a modal where you can enter the name of your new token:

After clicking the “Create” button you will receive a new personal access token:

This will be the only time it will be shown to you, so store it somewhere safely and don’t lose it. The token can now be used to make your requests to the Stiply API (see the Authentication section below). The token is valid for one month. Once it expires it can no longer be used to authenticate with the API and you will have to generate a new personal access token in order to do so.

Authorisation Code Grant

Although a personal access token is an easy way to connect with the Stiply API, the recommended way is by means of the authorisation code grant. This is a bit more involved and hence, we will discuss it in some detail.

In order to describe the authorisation redirect flow we will assume you have a consumer or client app. This app will be responsible for initiating and further handling of the authorisation redirect procedure that is at the base of OAuth2^[3].

The first step is to create a new OAuth client using the API settings page of the Stiply app:

The name of your client could essentially be anything, but ideally would be something your users will recognise and trust. The redirect URL field is where you will be redirected to after your user accepts your authorisation request^[4]. Once successfully created, you will see a new entry in the OAuth clients table:

You can edit the details of this client or delete it if you no longer need it.

Now that you have registered a client with Stiply you can go ahead and reference it in your consumer app (i.e. your app that is consuming Stiply’s OAuth authentication services) in order to request an access token. The examples are written in PHP^[5], but should be easy enough to adapt to your own personal use case.

First off, the consuming application should make the following redirect request:

Route::get('/redirect', function (\Illuminate\Http\Request $request) { // Optional, but recommended; protection against XSRF

 $request->session()->put('state', $state = \Illuminate\Support\Str::random(40)); // Build the query parameter string to pass auth information to our request

 $query = http_build_query([ 'client_id' => 'my-client-id', 'redirect_uri' => 'http://consumer.test/callback', 'response_type' => 'code', 'state' => $state, ]);

 // Redirect the user to the OAuth authorisation page
 return redirect('https://app.stiply.nl/oauth/authorize?'.$query);
});

There are a couple of things to note here. As you can see, the “client_id” parameter is equal to the client id of the OAuth client we previously created in the Stiply app and the “redirect_uri” parameter is equal to the redirect URL field we specified when creating the client. Lastly, note that the root of the URL of our authorisation endpoint is https://app.stiply.nl (i.e. the URL of the Stiply app not the API). The root of the URL of our token endpoint is https://api.stiply.nl.

In response to this redirect request, and assuming the user is logged out of the Stiply app, the user will be redirected to the Stiply login page. After log in the user will be presented with the following view:

Clicking on the “Authorize” button then will redirect the user to your callback URL which in turn must be used to request the first access and refresh tokens:

// Route that user is forwarded back to after approving on server
Route::get('/callback', function (\Illuminate\Http\Request $request) {

 $state = $request->session()->pull('state');
   
 // If state parameters are different, someone else has initiated the request
 throw_unless(strlen($state) > 0 && $state === $request->state,\InvalidArgumentException::class);

 $http = new \GuzzleHttp\Client;

 $response = $http->post('https://api.stiply.nl/oauth/token', [
 'form_params' => [
  'grant_type' => 'authorization_code',
  'client_id' => 'my-client-id',
  'client_secret' => 'my-client-secret',
  'redirect_uri' => 'http://consumer.test/callback',
  'code' => $request->code, // Get authorisation code from the callback
  ],
 ]);

 // echo the response; normally we would save the access and refresh tokens in the DB
 return json_decode((string)$response->getBody(), true);
});

This will return a JSON response with the following content:

{
 "token_type": "Bearer",
 "expires_in": 1800,
 "access_token": "{accessToken}",
 "refresh_token": "{refreshToken}"
}

The access token can now be used to make your requests to the Stiply API (see the [Authentication](#authentiction) section). The access token is valid for 30 minutes. Once it expires you can use the refresh token to request a new access token:

// Route that may be used to request a new access token, using the refresh token
Route::get('/refresh_token', function () {
 $http = new \GuzzleHttp\Client;

 $response = $http->post('https://api.stiply.nl/oauth/token', [
  'form_params' => [
   'grant_type' => 'refresh_token',
   'refresh_token' => '{refreshToken}',
   'client_id' => 'my-client-id',
   'client_secret' => 'my-client-secret',
  ],
 ]);

 return json_decode((string) $response->getBody(), true);
});

This again will return a response of the form:

{
 "token_type": "Bearer",
 "expires_in": 1800,
 "access_token": "{accessToken}",
 "refresh_token": "{refreshToken}"
}

containing a new access and refresh token. Note that refresh tokens are valid for 14 days. Once they expire the user will have to restart the OAuth redirect procedure from the beginning.

In summary

1. Once a client has been created, you may use the client ID and secret to request an authorisation code from your application
2. Once the authorisation request has been approved the user will be redirected to your OAuth callback route from which you may now make a request to obtain your first access token using the authorisation code that is send along with your callback URL as a query parameter.
3. Once you have obtained your first access token you can use it to make requests to the Stiply API. Access tokens are valid for 30 minutes. Once they expire you can use the refresh token to request a new access (and refresh token). Refresh tokens are valid for 14 days, after which you will have to restart the authorisation redirect procedure from the beginning.

Client Credential Grant

To use the Client Credential Grant create a client as described in the Authorisation Code Grant chapter. The Redirect URL is required, but since it is not used in this flow, you can enter just the URL of your application.
After a client is created, use its properties to request an access token from the token endpoint.

// Route that may be used to request an access token, using the client credentials
Route::get('/client_credentials', function () {
  $http = new \GuzzleHttp\Client;

  $response = $http->post('https://api.stiply.nl/oauth/token', [
    'form_params' => [
      'grant_type' => 'client_credentials',
      'client_id' => 'my-client-id',
      'client_secret' => 'my-client-secret',
    ],
  ]);

  return json_decode((string) $response->getBody(), true);
});

This will return a JSON response with the following content:

{
  "token_type": "Bearer",
  "expires_in": 1800,
  "access_token": "{accessToken}"
}

The access token can now be used to make your requests to the Stiply API (see the Authentication section). The access token is valid for 30 minutes. Once it expires you can use the client credentials to request a new access token.

Authentication

Once you have obtained an access token, using either of the two previously discussed methods of generating such a token, authentication with the Stiply API is straightforward. Simply add a header to your request named “Authorization” and set its value equal to “Bearer YOUR_ACCESS_TOKEN”, where “YOUR_ACCESS_TOKEN” is the access token you either received in your callback or refresh token route in case of the authorisation code grant, or was displayed to you in the Stiply app after creating a new personal access token. An example in Postman:

Note that the URL for making API requests using an access token is the URL of the Stiply API not the Stiply app and that all routes should be prefixed with v1.1 .

1: Currently, the only settings you can configure are purely OAuth related and hence, this tab will be selected by default.

3: We assume you are already familiar with OAuth2 terminology and concepts that can, for instance, be found here: https://oauth2.thephpleague.com/terminology.

4: The root URL used here is purely for local test purposes. Hence the reason it starts with “http” and utilises the “.test” domain. In a more realistic setting it would rather look something like https://consumer.com.

5: Laravel to be exact, also see this for reference.

Reference

Ping

Description

Preconditions

Status codes

Parameters

Example JSON

Response

{  
 "ping_value": "pong",  
 "status_code": "200"
}

Create sign request

Description

Preconditions

Status codes

Parameters

Response

{
  "data": {
    "document": {
      "name": "End-user license agreement",
      "filename": "license-agreement.pdf",
      "file_size": "224615",
      "created_at": "2017-03-29T13:43:07+0200",
      "updated_at": "2017-03-29T13:43:07+0200"
    },
    "sign_request": {
      "key": "jgxfx3qYLaL9A2th3XejaOoODEp2QahRr1s5b3ki062JMu1k9n",
      "sent": 0,
      "sent_at": "0000-00-00 00:00:00",
      "all_signed": 0,
      "all_signed_at": "0000-00-00 00:00:00",
      "signed_hash": "",
      "proof_hash": "",
      "message": "Hi! Could you please sign our license agreement? Cheers!",
      "comment": "Customer wants to start asap",
      "external_key": "myexternalkey1234",
      "call_back_url": "https://www.myawesomewebsitecallbackurl.com/callback",
      "created_at": "2017-03-29T13:43:07+0200",
      "updated_at": "2017-03-29T13:43:07+0200",
      "terms": [
        {
          "term_code": "1w",
          "term_expired": 0,
          "term_expires": "0000-00-00 00:00:00",
          "created_at": "2017-03-29T13:43:07+0200"
        }
      ],
      "signers": []
    }
  }
}

Create signer

Description

Preconditions

• Sign request must exist
• Sign request has not been sent

Status codes

Parameters

Tags

Make sure the document includes a tag where the signature field should be added. You can pick the name yourself, but the tag has to be surrounded by accolades, like so: . Please make sure the tag is not connected to another word in the document. There are different tags available:

• to create a signature field use
• to create a checkbox field use
• to create a date field use
• to create a text field use
• to create an initial field use

Your JSON should look something like this: "signer_signature_fields":[{"name" : "signature_1"}] The top left of the field shall be positioned on the top left of the tag, provided that the field does not cross the page boundaries. You can optionally specify the width of the field, also provided that you keep within the minimum and maximum field dimensions. To make a field optional, add the property "optional" with the value "1" the JSON body. Please note that signature fields are always required and cannot be made optional.

Example

{"signer_email":"test@email.com", "signer_signature_fields":[{"name":"signature_1","width":"300"}, {"name":"signature_2"}]}

Coordinates

To add a field by coordinates you have to specify the page, x-coordinate and y-coordinate of the field. Coordinates are in pixels, relative to the manager viewport. (0,0) is the top left corner. You can check the coordinates by logging in the manager (app.stiply.nl/manager) as an API-user and adding a field to a document: the coordinates will be displayed in the field. X-max: 516 Y-max: 956

Example

"signer_signature_fields":[{"page":1,"x":100,"y":200}]

"signer_text_fields":[{"name":"text_field_1","width":"150"}]

"signer_text_fields":[{"page":1,"x":300,"y":300}, {"page":2,"x":400,"y":400}]

{"signer_email":"signer@stiply.nl","signer_signature_fields":[{"name":"signature_1"}], "auth_method":"emandate",
"emandate":{"instrument_code":"core", "sequence_type":"rcur","emandate_id":"12345"}}

{"signer_email":"signer@stiply.nl","signer_signature_fields":[{"name":"signature_1"}], "auth_method":"idin",
"idin":{"prefix":"van der", "last_name":"meer","date_of_birth":"01-09-1982"}}

Example JSON

{"signer_email":"signer@stiply.nl","signer_signature_fields":[{"name":"signature_0"}],"signer_text_fields":[{"name":"text_0"}], "auth_method":"sms","cell_phone_number":"31612345678"}

Response

{
  "data": {
    "key": "X7FylzU1MQlIaMEo4oec03lkQtI0wF2jtrEHQoXtotGDaDH5CI",
    "email": "signer@stiply.nl",
    "name": null,
    "order": 0,
    "language": "nl",
    "phone": 31612345678,
    "auth_method": "sms",
    "role": "",
    "sign_url": null,
    "emandate": [],
    "created_at": "2017-03-29T14:59:56+0200",
    "updated_at": "2017-03-29T14:59:57+0200",
    "signer_progresses": [],
    "fields": [
      {
        "type": "signature",
        "x": 91.34,
        "y": 865.35,
        "width": 250,
        "height": 125,
        "page": 1,
        "created_at": "2017-03-29T14:59:57+0200",
        "updated_at": "2017-03-29T14:59:57+0200"
      },
      {
        "type": "signature",
        "x": 144.64,
        "y": 755.36,
        "width": 230,
        "height": 20,
        "page": 1,
        "created_at": "2017-03-29T14:59:57+0200",
        "updated_at": "2017-03-29T14:59:57+0200"
      }
    ]
  }
}

Send sign request

POST /sign_requests/[:sign_request_key]/actions/send

Description

Preconditions

• Sign request must exist
• Sign request has not been sent
• Sign request has at least 1 signer with at least 1 signature field

Status codes

Parameters

Response

{
  "data": {
    "document": {
      "name": "End-user license agreement",
      "filename": "license-agreement.pdf",
      "file_size": "224615",
      "created_at": "2017-03-29T13:43:07+0200",
      "updated_at": "2017-03-29T13:43:07+0200"
    },
    "sign_request": {
      "key": "jfxfx3qYLoL9AHth3XejOOoODEp2QahRr1s5b3bi062JMu1k9n",
      "sent": 1,
      "sent_at": "2017-03-29T15:12:17+0200",
      "all_signed": 0,
      "all_signed_at": "0000-00-00 00:00:00",
      "signed_hash": "",
      "proof_hash": "",
      "message": "Hi! Could you please sign our license agreement? Cheers!",
      "comment": "Customer wants to start asap",
      "external_key": "myexternalkey1234",
      "call_back_url": "https://www.myawesomewebsitecallbackurl.com/callback",
      "created_at": "2017-03-29T13:43:07+0200",
      "updated_at": "2017-03-29T15:12:17+0200",
      "terms": [
        {
          "term_code": "1w",
          "term_expired": 0,
          "term_expires": "2017-04-05T15:12:17+0200",
          "created_at": "2017-03-29T13:43:07+0200"
        }
      ],
      "signers": [
        {
          "key": "X7FylzU1MQlIaMEo4oec03lkQtI0wF2jtrEHQoXtotGDaDH5CI",
          "email": "signer@stiply.nl",
          "name": null,
          "order": null,
          "phone": 31612345678,
          "auth_method": "sms",
          "created_at": "2017-03-29T14:59:56+0200",
          "updated_at": "2017-03-29T14:59:57+0200",
          "sign_url": null,
          "signer_progresses": [
            {
              "action": "mail_signrequest_sent",
              "ip": null,
              "location": null,
              "system": null,
              "value": "signer@stiply.nl",
              "created_at": "2017-03-29T15:12:17+0200",
              "status": null
            }
          ]
        }
      ]
    }
  }
}

Get signed document

GET /sign_requests/[:sign_request_key]/documents/actions/get_signed_document

Description

Preconditions

• Sign request must exist
• Sign request has been signed by all signers

Status codes

Parameters

Response

{
  "file_name": "license-agreement-[Ondertekend].pdf",
  "mimeType": "application/pdf",
  "file_size": "244087",
  "hash": "d24fe514aafcg15a79a9k3blb95b0237d0hf4d",
  "data": "JVBERi0xLjUNCiW1tbW1 (... long base64 ...) 00gl93a==",
  "status_code": "200"
}

Get proof document

GET /sign_requests/[:sign_request_key]/documents/actions/get_proof_document

Description

Preconditions

• Sign request must exist
• Sign request has been signed by all signers

Status codes

Parameters

Response

{
  "file_name": "license-agreement-[Bewijs].pdf",
  "mimeType": "application/pdf",
  "file_size": "244087",
  "hash": "2289ac9gkei61bd5b2306f90e27743fkaa184e64a",
  "data": "jQKJcOkw7zDtsOfC (... long base64 string ...) hg4fsa==",
  "status_code": "200"
}

Send reminder

POST /sign_requests/[:sign_request_key]/actions/send_reminder (JSON)

Description

Preconditions

• Sign request must exist
• Sign request has been sent

Status codes

Parameters

Response

{
  "data": {
    "document": {
      "name": "End-user license agreement",
      "filename": "license-agreement.pdf",
      "file_size": "224615",
      "created_at": "2017-03-29T16:57:19+0200",
      "updated_at": "2017-03-29T16:57:19+0200"
    },
    "sign_request": {
      "key": "eIGy1HCynD6B7QDo2gbsXeDoPKdjsLr1U8SNKGx1CMOzB77Peh",
      "sent": 1,
      "sent_at": "2017-03-29T16:58:16+0200",
      "all_signed": 0,
      "all_signed_at": "0000-00-00 00:00:00",
      "signed_hash": "",
      "proof_hash": "",
      "message": "Hi! Could you please sign our license agreement? Cheers!",
      "comment": "Customer wants to start asap",
      "external_key": "myexternalkey12345",
      "call_back_url": "https://www.myawesomewebsitecallbackurl.com/callback",
      "created_at": "2017-03-29T16:57:19+0200",
      "updated_at": "2017-03-29T16:58:16+0200",
      "terms": [
        {
          "term_code": "1w",
          "term_expired": 0,
          "term_expires": "2017-04-05T16:58:16+0200",
          "created_at": "2017-03-29T16:57:19+0200"
        }
      ],
      "signers": [
        {
          "key": "X7FylzU1MQlIaMEo4oec03lkQtI0wF2jtrEHQoXtotGDaDH5CI",
          "email": "signer@stiply.nl",
          "name": null,
          "order": null,
          "phone": 31612345678,
          "auth_method": "sms",
          "created_at": "2017-03-29T16:58:05+0200",
          "updated_at": "2017-03-29T16:58:06+0200",
          "sign_url": null,
          "signer_progresses": [
            {
              "action": "mail_signrequest_sent",
              "ip": null,
              "location": null,
              "system": null,
              "value": "signer@stiply.nl",
              "created_at": "2017-03-29T16:58:16+0200",
              "status": "failed"
            },
            {
              "action": "mail_reminder_sent",
              "ip": null,
              "location": null,
              "system": null,
              "value": "signer@stiply.nl",
              "created_at": "2017-03-29T16:58:27+0200",
              "status": null
            }
          ]
        }
      ]
    }
  }
}

Extend term

POST /sign_requests/[:sign_request_key]/actions/extend_term (JSON)

Description

Preconditions

• Sign request must exist
• Sign request has been sent

Status codes

Parameters

Example JSON

Response

{
  "data": {
    "document": {
      "name": "End-user license agreement",
      "filename": "license-agreement.pdf",
      "file_size": "224615",
      "created_at": "2017-03-29T16:57:19+0200",
      "updated_at": "2017-03-29T16:57:19+0200"
    },
    "sign_request": {
      "key": "eIGy1HCynD6B7QDo2gbsXeDoPKdjsLr1U8SNKGx1CMOzB77Peh",
      "sent": 1,
      "sent_at": "2017-03-29T16:58:16+0200",
      "all_signed": 0,
      "all_signed_at": "0000-00-00 00:00:00",
      "signed_hash": "",
      "proof_hash": "",
      "message": "Hi! Could you please sign our license agreement? Cheers!",
      "comment": "Customer wants to start asap",
      "external_key": "myexternalkey12345",
      "call_back_url": "https://www.myawesomewebsitecallbackurl.com/callback",
      "created_at": "2017-03-29T16:57:19+0200",
      "updated_at": "2017-03-29T16:58:16+0200",
      "terms": [
        {
          "term_code": "1w",
          "term_expired": 1,
          "term_expires": "2017-04-05T16:58:16+0200",
          "created_at": "2017-03-29T16:57:19+0200"
        },
               {
                  "term_code": "2d",
                  "term_expired": 0,
                  "term_expires": "2017-04-08T09:00:00+0200",
                  "created_at": "2017-04-06T09:00:00+0200"
               },
      ],
      "signers": [
        {
          "key": "X7FylzU1MQlIaMEo4oec03lkQtI0wF2jtrEHQoXtotGDaDH5CI",
          "email": "signer@stiply.nl",
          "name": null,
          "order": null,
          "phone": 31612345678,
          "auth_method": "sms",
          "created_at": "2017-03-29T16:58:05+0200",
          "updated_at": "2017-03-29T16:58:06+0200",
          "sign_url": null,
          "signer_progresses": [
            {
              "action": "mail_signrequest_sent",
              "ip": null,
              "location": null,
              "system": null,
              "value": "signer@stiply.nl",
              "created_at": "2017-03-29T16:58:16+0200",
              "status": "failed"
            },
            {
              "action": "mail_term_extended_sent",
              "ip": null,
              "location": null,
              "system": null,
              "value": "signer@stiply.nl",
              "created_at": "2017-03-29T16:58:27+0200",
              "status": null
            }
          ]
        }
      ]
    }
  }
}

Get sign requests

Description

Get a list with sign requests

Status codes

200 Success

Parameters

Response

{
    "data": [
        {
            "sign_request": {
                "key": "hE0NNZTIYfxtDLNC2ylhSOqtM0tB9BoPY4qxpTHztTcRYbdLr2",
                "document_name": "Test4",
                "signers": [
                    {
                        "key": "Z64ykTPuCervprfJPv9zlqSAEN7cB2NUmLrtRtQJiTv4TCb7Pr",
                        "email": "john.doe@example.com"
                    }
                ],
                "sent": 1,
                "sent_at": "2019-09-05T09:01:26+0200",
                "all_signed": 1,
                "all_signed_at": "2019-09-05T09:06:34+0200",
                "signed_hash": "295c07e906b08540e991deea42b3ee86537b2309",
                "proof_hash": "5478387f2d9108c33a7450c46bde54ef25ffc83f",
                "canceled": 0,
                "canceled_at": "0000-00-00 00:00:00",
                "message": "Test",
                "comment": null,
                "external_key": null,
                "created_at": "2019-09-05T09:01:12+0200",
                "updated_at": "2021-01-12T13:41:01+0100"
            }
        },
        {
            "sign_request": {
                "key": "eEAaoGFXs6A9tiyDlDMqqCQ5dWEIJisgcbvnMe1rF2MITnoqxt",
                "document_name": "Test4",
                "signers": [
                    {
                        "key": "QuZpGpmFW5hGUdgi4pc8eU0Pk1gG04vRIbYnjLCc4d37TvcFED",
                        "email": "john.doe@example.com"
                    }
                ],
                "sent": 1,
                "sent_at": "2019-09-05T09:14:51+0200",
                "all_signed": 1,
                "all_signed_at": "2019-09-05T09:15:08+0200",
                "signed_hash": "efafec803f7152243b48048e64400e98443b78d2",
                "proof_hash": "fb7f3141e13cc1205b0c1840e2179f85c0fa6543",
                "canceled": 0,
                "canceled_at": "0000-00-00 00:00:00",
                "message": "Test",
                "comment": null,
                "external_key": null,
                "created_at": "2019-09-05T09:14:39+0200",
                "updated_at": "2021-01-12T13:41:01+0100"
            }
        },
        {
            "sign_request": {
                "key": "87T5XDF059SoJtSz9bclLJpphnKgCO83X3kcF2OffULzkdMtjX",
                "document_name": "Test4",
                "signers": [
                    {
                        "key": "FeSar9Qxhw2HFRjJKn6kyA81bOCzAloVEnwBxhHHtgmag0HNpG",
                        "email": "john.doe@example.com"
                    }
                ],
                "sent": 1,
                "sent_at": "2019-09-05T12:14:49+0200",
                "all_signed": 1,
                "all_signed_at": "2019-09-05T13:38:24+0200",
                "signed_hash": "b97d1ac1e3c406ea15771281ebc9619fabb3ef69",
                "proof_hash": "5d879de09ea7d203b4ded9d583e033f2f83c970c",
                "canceled": 0,
                "canceled_at": "0000-00-00 00:00:00",
                "message": null,
                "comment": null,
                "external_key": null,
                "created_at": "2019-09-05T09:27:45+0200",
                "updated_at": "2021-01-12T13:41:01+0100"
            }
        }
    ]
}

{
  "key": "eIGy1HCynD6B7QDo2gbsXeDoPKdjsLr1U8SNKGx1CMOzB77Peh",
  "status_code": "200"
}

{
  "data": {
    "document": {
      "name": "End-user license agreement",
      "filename": "license-agreement.pdf",
      "file_size": "224615",
      "created_at": "2017-03-29T16:57:19+0200",
      "updated_at": "2017-03-29T16:57:19+0200"
    },
    "sign_request": {
      "key": "eIGy1HCynD6B7QDo2gbsXeDoPKdjsLr1U8SNKGx1CMOzB77Peh",
      "sent": 1,
      "sent_at": "2017-03-29T16:58:16+0200",
      "all_signed": 0,
      "all_signed_at": "0000-00-00 00:00:00",
      "signed_hash": "",
      "proof_hash": "",
      "message": "Hi! Could you please sign our license agreement? Cheers!",
      "comment": "Customer wants to start asap",
      "external_key": "myexternalkey12345",
      "call_back_url": "https://www.myawesomewebsitecallbackurl.com/callback",
      "created_at": "2017-03-29T16:57:19+0200",
      "updated_at": "2017-03-29T16:58:16+0200",
      "terms": [
        {
          "term_code": "1w",
          "term_expired": 1,
          "term_expires": "2017-04-05T16:58:16+0200",
          "created_at": "2017-03-29T16:57:19+0200"
        },
               {
                  "term_code": "2d",
                  "term_expired": 0,
                  "term_expires": "2017-04-08T09:00:00+0200",
                  "created_at": "2017-04-06T09:00:00+0200"
               },
      ],
      "signers": [
        {
          "key": "X7FylzU1MQlIaMEo4oec03lkQtI0wF2jtrEHQoXtotGDaDH5CI",
          "email": "signer@stiply.nl",
          "name": null,
          "order": null,
          "phone": 31612345678,
          "auth_method": "sms",
          "created_at": "2017-03-29T16:58:05+0200",
          "updated_at": "2017-03-29T16:58:06+0200",
          "sign_url": null,
          "signer_progresses": [
            {
              "action": "mail_signrequest_sent",
              "ip": null,
              "location": null,
              "system": null,
              "value": "signer@stiply.nl",
              "created_at": "2017-03-29T16:58:16+0200",
              "status": "failed"
            },
            {
              "action": "mail_reminder_sent",
              "ip": null,
              "location": null,
              "system": null,
              "value": "signer@stiply.nl",
              "created_at": "2017-03-29T16:58:27+0200",
              "status": null
            }
          ]
        }
      ]
    }
  }
}

{
  "message": "Ondertekenverzoek en document succesvol verwijderd.",
  "status_code": "200"
}

{
  "data": [
    {
      "key": "xuSfW4HkRZHW2dRZipk8jIefqYVsMdWXK3QmWALbMJ216NPdRZ",
      "email": "signer@stiply.nl",
      "name": null,
      "order": 0,
      "language": "nl",
      "phone": 31612345678,
      "auth_method": "sms",
      "role": "",
      "sign_url": null,
      "emandate": [],
      "created_at": "2017-03-29T16:58:05+0200",
      "updated_at": "2017-03-29T16:58:06+0200",
      "signer_progresses": [
        {
          "action": "mail_signrequest_sent",
          "ip": null,
          "location": null,
          "system": null,
          "value": "signer@stiply.nl",
          "created_at": "2017-03-29T16:58:16+0200"
        },
        {
          "action": "mail_reminder_sent",
          "ip": null,
          "location": null,
          "system": null,
          "value": "signer@stiply.nl",
          "created_at": "2017-03-29T16:58:27+0200"
        }
      ],
      "fields": [
        {
          "type": "signature",
          "x": 91.34,
          "y": 865.35,
          "width": 250,
          "height": 125,
          "page": 1,
          "created_at": "2017-03-29T16:58:06+0200",
          "updated_at": "2017-03-29T16:58:06+0200"
        },
        {
          "type": "signature",
          "x": 144.64,
          "y": 755.36,
          "width": 230,
          "height": 20,
          "page": 1,
          "created_at": "2017-03-29T16:58:06+0200",
          "updated_at": "2017-03-29T16:58:06+0200"
        }
      ]
    }
  ]
}

{
  "data": [
    {
      "key": "xuSfW4HkRZHW2dRZipk8jIefqYVsMdWXK3QmWALbMJ216NPdRZ",
      "email": "newemail@stiply.nl",
      "name": null,
      "order": 0,
      "language": "nl",
      "phone": 31612345678,
      "auth_method": "sms",
      "role": "",
      "sign_url": null,
      "emandate": [],
      "created_at": "2017-03-29T16:58:05+0200",
      "updated_at": "2017-03-29T16:58:06+0200",
      "signer_progresses": [
        {
          "action": "mail_signrequest_sent",
          "ip": null,
          "location": null,
          "system": null,
          "value": "signer@stiply.nl",
          "created_at": "2017-03-29T16:58:16+0200"
        },
        {
          "action": "mail_reminder_sent",
          "ip": null,
          "location": null,
          "system": null,
          "value": "signer@stiply.nl",
          "created_at": "2017-03-29T16:58:27+0200"
        }
      ],
      "fields": [
        {
          "type": "signature",
          "x": 91.34,
          "y": 865.35,
          "width": 250,
          "height": 125,
          "page": 1,
          "created_at": "2017-03-29T16:58:06+0200",
          "updated_at": "2017-03-29T16:58:06+0200"
        },
        {
          "type": "signature",
          "x": 144.64,
          "y": 755.36,
          "width": 230,
          "height": 20,
          "page": 1,
          "created_at": "2017-03-29T16:58:06+0200",
          "updated_at": "2017-03-29T16:58:06+0200"
        }
      ]
    }
  ]
}

{
  "message": "Ondertekenaar succesvol verwijderd.",
  "status_code": "200"
}