Cellosign API v3 (3.1)

Download OpenAPI specification:Download

INTRODUCTION

Welcome to Cellosign API documentation. Please make sure to read these guidelines before getting started Terms Of Service, User Agreement

Getting Started

In order to access our APIs you will need an Access Token and projectName(s). Please retain your Access Token from your administrator and keep it confidential.

REST API

Overview

Cellosign REST API allows you to integrate and perform queries and actions to Cellosign systems. The API is based on REST principles. It supports GET, POST, and DELETE requests.

Use a GET request to retrieve information from a resource and
Use a POST to update an entity.
Use a DELETE removes an entity.

After receiving your request, the API sends back an HTTP status code and a response in JSON

Staus Codes

Status Code	Description	Notes
200	OK	The request was successful
400	Bad Request	The request could not be understood by the server. Incoming parameters might not be valid
401	Unauthorized	The supplied Token, if any, are not sufficient to access the resource
404	Not Found	The requested resource is not found
500	Server Error	The server could not complete request and return the representation due to an internal server error

Base URI

All URLs referenced in the documentation have the following base: https://app.cellosign.com/api/v3/

Security Considerations

Cellosign REST API is served over HTTPS. All requests are logged and validated. All parameters must be URL-encoded.

Depreciation Notice

Please note that API URLs that does not carry api/v3 in thier base are due to deprectiation within the end of 2021.

Authentication

TokenAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	Token

Session

Session is a process where single recipient is involved. For processes with multiple recipients check Workflow API. Use this API to POST/GET/Delete a form or query for Sessions.

List of Sessions.

Return a list of sessions in the project and corresponding metadata and status.

Authorizations:

TokenAuth

query Parameters

page_size	integer [ 1 .. 1000 ] Default: 100 Maximum number of elements on each page.
page	integer >= 1 Default: 1 Requested page number.
author	string Agent email.
sent_to	string Example: sent_to=mail1@cellosign.com,mail2@cellosign.com List of destination, comma separated.
assignee	string Example: assignee=mail1@cellosign.com destination of the session assigned to
process	string uuid of workflow or process
is_expired	boolean Is the form expired.
is_submitted	boolean Is the form submitted.
submitted_at	string <date> YYYY-MM-DDTHH:MM:SS Enum: "submitted_at" "submitted_at__gt" "submitted_at__lt" Example: submitted_at=2021-11-08T10:46:34 Form created date, date must be in ISO 8601 format.
created_at	string <date> YYYY-MM-DDTHH:MM:SS Enum: "created_at" "created_at__gt" "created_at__lt" Example: created_at=2021-11-08T10:46:34 Form submitted date, date must be in ISO 8601 format.
expired_at	string <date> YYYY-MM-DDTHH:MM:SS Enum: "expired_at" "expired_at__gt" "expired_at__lt" Example: expired_at=2021-11-08T10:46:34 Form expired date, date must be in ISO 8601 format.

Responses

200

The list of sesions

401

The request is not authorized.

403

There is no access to requested resource.

get /session/

https://app.cellosign.com/api/v3/{projectName}/session/

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"many": true,
"paginated": true,
"total": 22,
"links": 
{"previous": null,
"next": "https://app.cellosign.com/api/v3/demo/workflow/?page=2&page_size=2"
}
},
"data": 
[
{"id": "yejyha9qI8",
"author": "email@example.com",
"recipient": 
{"id": 1,
"name": "client"
},
"description": "Direct Debit",
"created_at": "2021-03-20T20:19:44.037958",
"expired_at": "2021-04-29T20:19:43.786714",
"deleted_at": null,
"submitted_at": null,
"form_loaded_at": null,
"process_id": "null,",
"reference": "e0711799-5086-4540-b65d-cdb1d3a380c0",
"transaction_number": 10966,
"template": 
{"id": "5838e3a61d7c40e08a092dee31e5833a"
}
}
]
}

Create a Session.

Create a session from a pre-configured Template. This is a common case when it is required to inject data into a form and post it to remote client.

Authorizations:

TokenAuth

Request Body schema: application/json

ttl	integer [ 1 .. 960 ] Nullable Default: 72 Time to live of process, in hours.
template	Predefined template. (object) or Adhoc template from document. (object) or Adhoc template from many documents. (object) or Replace pdf source from document of predefined template. (object) or Replace pdf source from documents of predefined template. (object)
initial	object use this key/value pairs to inject initial values into session and form. Key must be a field ID in the template
recipient	object On session create this data is used to ship the url to client via email or SMS. Alternatively you may retain the url on response and post (or redirect to it) yourself.
labels	object This object will be posted back to your API when session is submitted. Typically used to push internal placeholders for postprocessing in your core application. You may use any key/value pair.
integrations	Array of objects

Responses

200

Session details

400

The requested resource malformed or required data is missing, details attached to response.

401

The request is not authorized.

403

There is no access to requested resource.

post /session/

https://app.cellosign.com/api/v3/{projectName}/session/

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"ttl": 72,
"template": 
{"id": "string",
"fields": 
{"property1": 
{"type": "paragraph",
"width": 0,
"height": 0,
"page": 1,
"recipient": 
{"property1": 
{"rw": false,
"show": false
},
"property2": 
{"rw": false,
"show": false
}
},
"question": null,
"description": "",
"required": true,
"show": true,
"b_rep_control": false,
"b_client_control": true,
"error_message_invalid": null,
"error_message_missing": null,
"dependencies": 
[
{"conditions": 
[
{"id": "string",
"operation": "string"
}
],
"control": false,
"enabled": false
}
],
"bg_color": null,
"font_color": null,
"inline_block": false,
"icon": "object",
"faicon": null,
"icon_position": "icon_right",
"api_validation": null,
"class": 
["string"
],
"label": null,
"left": null,
"top": null,
"value": null,
"id": null,
"mask": null,
"validation": null,
"options": 
{"all_chars": true,
"hebrew_chars": false,
"latin_chars": false,
"numbers": false,
"contains": "",
"endswith": "",
"startswith": "",
"maxlength": 0,
"minlength": 0,
"equate_ignore_case": "fasle",
"equate": "string",
"equate_to": "string"
}
},
"property2": 
{"type": "paragraph",
"width": 0,
"height": 0,
"page": 1,
"recipient": 
{"property1": 
{"rw": false,
"show": false
},
"property2": 
{"rw": false,
"show": false
}
},
"question": null,
"description": "",
"required": true,
"show": true,
"b_rep_control": false,
"b_client_control": true,
"error_message_invalid": null,
"error_message_missing": null,
"dependencies": 
[
{"conditions": 
[
{"id": "string",
"operation": "string"
}
],
"control": false,
"enabled": false
}
],
"bg_color": null,
"font_color": null,
"inline_block": false,
"icon": "object",
"faicon": null,
"icon_position": "icon_right",
"api_validation": null,
"class": 
["string"
],
"label": null,
"left": null,
"top": null,
"value": null,
"id": null,
"mask": null,
"validation": null,
"options": 
{"all_chars": true,
"hebrew_chars": false,
"latin_chars": false,
"numbers": false,
"contains": "",
"endswith": "",
"startswith": "",
"maxlength": 0,
"minlength": 0,
"equate_ignore_case": "fasle",
"equate": "string",
"equate_to": "string"
}
}
}
},
"initial": 
{"property1": "string",
"property2": "string"
},
"recipient": 
{"invitations": 
[
{"address": "email"
}
],
"otp": 
{"address": "email"
},
"is_system_user": true,
"is_require_otp": true,
"message": "string"
},
"labels": 
{"property1": "string",
"property2": "string"
},
"integrations": 
[
{"type": "string",
"payload": 
{"url": "string"
}
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"type": "object"
},
"data": 
[
{"id": "cHofAM85Fr",
"author": "user@cellosign.com",
"recipient": 
{"id": 1,
"name": "client",
"is_system_user": false,
"is_require_otp": true,
"otp_destination": 
{"address": "0509999999",
"type": "sms",
"provider": null,
"status": "scheduled"
},
"invitations": 
[
{"address": "email@example.com",
"type": "email",
"provider": null,
"status": "sent"
}
]
},
"description": "Direct Debit",
"created_at": "2021-03-20T20:19:44.037958",
"expired_at": "2021-04-29T20:19:43.786714",
"deleted_at": null,
"submitted_at": null,
"form_loaded_at": null,
"process_id": "null,",
"reference": "e0711799-5086-4540-b65d-cdb1d3a3805d",
"transaction_number": 10966,
"template": 
{"id": "5128e3a61d7c40e08a092dee31e5833a"
},
"integrations": [ ],
"client_url": "https://app.cellosign.com/t/cHofAM85Fr",
"agent_url": "https://app.cellosign.com/mashcal/rep?tok=cHofAM85Fr&template=5838e3a61d7c40e08a092dee31e5833a"
}
]
}

Retrieve details of a Session.

Get Session detail, status etc..

Authorizations:

TokenAuth

path Parameters

reference

required

string <uuid>

Unique id for the session. Generated on create session, use this id to query and delete.

Responses

200

Session details

401

The request is not authorized.

403

There is no access to requested resource.

404

The requested resource does not exist.

get /session/{reference}

https://app.cellosign.com/api/v3/{projectName}/session/{reference}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"meta": 
{"type": "object"
},
"data": 
[
{"id": "cHofAM85Fr",
"author": "user@cellosign.com",
"recipient": 
{"id": 1,
"name": "client",
"is_system_user": false,
"is_require_otp": true,
"otp_destination": 
{"address": "0509999999",
"type": "sms",
"provider": null,
"status": "scheduled"
},
"invitations": 
[
{"address": "email@example.com",
"type": "email",
"provider": null,
"status": "sent"
}
]
},
"description": "Direct Debit",
"created_at": "2021-03-20T20:19:44.037958",
"expired_at": "2021-04-29T20:19:43.786714",
"deleted_at": null,
"submitted_at": null,
"form_loaded_at": null,
"process_id": "null,",
"reference": "e0711799-5086-4540-b65d-cdb1d3a3805d",
"transaction_number": 10966,
"template": 
{"id": "5128e3a61d7c40e08a092dee31e5833a"
},
"integrations": [ ],
"client_url": "https://app.cellosign.com/t/cHofAM85Fr",
"agent_url": "https://app.cellosign.com/mashcal/rep?tok=cHofAM85Fr&template=5838e3a61d7c40e08a092dee31e5833a"
}
]
}

Delete a Session.

delete a session and revoke access to session url.

Authorizations:

TokenAuth

path Parameters

reference

required

string <uuid>

Unique id for the session. Generated on create session, use this id to query and delete.

Responses

200

Delete confirmation returns an empty Object

401

The request is not authorized.

403

There is no access to requested resource.

404

The requested resource does not exist.

delete /session/{reference}

https://app.cellosign.com/api/v3/{projectName}/session/{reference}

Template

Get details of peconfigured templates repository in a project.

List of templates.

Return a list of templates in the project.

Authorizations:

TokenAuth

query Parameters

page_size	integer [ 1 .. 1000 ] Default: 100 Maximum number of elements on each page.