Loading...

Create a new Agreement

Creates a new agreement in draft. Issuer is the name of the person or organization that issues the agreement. This name is used in communication with all signing parties as well as in their respective signing rooms.

Send request

  • POST https://api.zigned.io/rest/v2/agreements
  • Content-type: application/json

Request body

issuerString

Name of who issues the agreement. Will be used in communication with other parties.

const fetch = require('node-fetch'); let url = 'https://api.zigned.io/rest/v2/agreements'; let options = { method: 'POST', headers: {'x-zigned-api-key': 'Your API key'}, body: '{"issuer":"Example AB"}' }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));

Success response

Description

A new agreement is returned in draft

Details

  • HTTP Status: 201
  • Mime type: application/json

Response body

idString

The unique ID of the agreement

statusEnumeration

Status of the agreement.

Possible values:

  • draft
  • pending
  • fulfilled
test_modeBoolean

Indicates if the agreement is for testing purposes

issuerString | Null

Issuer of the agreement

sign_intentsArray | Null

Sign Intents of the agreement.

original_documentObject | Null

Original document to be signed.

signed_documentObject | Null

The signed and finished document.

created_atDateTime

The UTC date of when the agreement was created

updated_atDateTime

The UTC date of when the agreement was last updated

Code Example

{ "id": "bc08cbbd-d565-4d07-b219-71cb607a2216", "status": "draft", "test_mode": false, "issuer": "Example AB", "sign_intents": [], "original_document": {}, "signed_document": {}, "created_at": "Tue, 11 Jan 2022 15:59:53 GMT", "updated_at": "Tue, 11 Jan 2022 15:59:53 GMT" }