Loading...

Retrieve a Single Agreement

Get a single agreement with the specified ID.

Send request

  • GET https://api.zigned.io/rest/v2/agreements/{Agreement ID}
  • Content-type: application/json
const fetch = require('node-fetch'); let url = 'https://api.zigned.io/rest/v2/agreements/91bdff46-e24b-480b-b478-67a566c1edac'; let options = {method: 'GET', headers: {'x-zigned-api-key': 'Your API key'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));

Success response

Description

Returns the Agreement Object of the specified ID

Details

  • HTTP Status: 200
  • 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": "John Doe", "sign_intents": [{ "id": "4da3a490-db93-476b-ba24-f548e79f75ae", "email": "email@example.com", "status": "draft", "signing_room_url": "www.zigned.se", "signing_session": { "id": "6b4a86ae-5f58-4836-828f-9e23cee2dba7", "status": "draft", "signing_session_events": [{ "id": "be39518a-4b76-48f5-bc0a-b9c3738f4379", "title": "Entered Signing Room", "description": "Entered Signing Room", "ip": "80.217.101.28", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.110 Safari/537.36", "created_at": "Tue, 11 Jan 2022 15:59:53 GMT" }], "signed_at": "Tue, 11 Jan 2022 15:59:53 GMT", "signature_method": "Signature not initiated", "created_at": "Tue, 11 Jan 2022 15:59:53 GMT", "updated_at": "Tue, 11 Jan 2022 15:59:53 GMT" }, "created_at": "Tue, 11 Jan 2022 15:59:53 GMT", "updated_at": "Tue, 11 Jan 2022 15:59:53 GMT" }], "original_document": { "id": "7c7cfbc0-32c5-4a2b-8cd0-4e39585f9f03", "filename": "example.pdf", "mime_type": "application/pdf", "url": "www.zigned.se", "compatibility_check": "successful", "created_at": "Tue, 11 Jan 2022 15:59:53 GMT", "updated_at": "Tue, 11 Jan 2022 15:59:53 GMT" }, "signed_document": { "id": "7c7cfbc0-32c5-4a2b-8cd0-4e39585f9f03", "filename": "example.pdf", "mime_type": "application/pdf", "url": "www.zigned.se", "compatibility_check": "successful", "created_at": "Tue, 11 Jan 2022 15:59:53 GMT", "updated_at": "Tue, 11 Jan 2022 15:59:53 GMT" }, "created_at": "Tue, 11 Jan 2022 15:59:53 GMT", "updated_at": "Tue, 11 Jan 2022 15:59:53 GMT" }

Error responses

Description

We could not find an agreement with the specified ID.

Details

  • HTTP Status: 400
  • Mime type: application/json
  • Message: The requested agreement does not exist.

Code Example

{ "status": 400, "message": "The requested agreement does not exist." }