Get started

Introduction

This is Clust API official online documentation. We have made it simple for you to generate API tokens that can be used to consume Clust's API.

About Clust Sandbox

Clust provides a full testing environment called Clust Sandbox.
The Clust sandbox mirrors the features found on the Clust production servers. While some Clust features may not not apply to the sandbox, this environment has parity with the Clust API feature set supported by the live environment.
This means you can test your Clust processes and know they will behave the same on the production servers as they do in the sandbox environment. To test your code end-to-end, you need to create an account on sandbox.clustdoc.com. By using fictitious sandbox test accounts and their associated authentication credentials in your Clust calls, you can test and debug your application without referencing any real Clust users . The sandbox lets you operate your application in a safe environment and provides you a way to fine tune your Clust routines before moving your product into production.

Testing and going live

3 steps to start testing Clust API
1- Create a Clust account on sandbox.clustdoc.com 2- Create and copy your API token in you settings page 3- Add that API token in your API calls to Clust endpoint.
When you're ready to go live, just log in to you Clust account and repeat these steps to get your LIVE API token.
Your users can now enjoy using Clust to collect documents ;)

Create and send a Clust dossier (aka Clust Request)

Using Clust to collect documents can be performed in 5 simple steps
1- Create a Clust Dossier using the createDossier API 2- Get the Dossier public_url attribute from the response 3- Share that url with the Dossier recipient. 4- The recipient uploads the required documents on the Dossier public page. 5- Use the getDossier API to get the dossier status and uploaded files.

What can a Clust Dossier contain ?
A Clust Dossier can contain dossier items and attachments

Dossier items
: list of documents that need to be provided

There are 3 types of Dossier items : file (the recipient should upload a file), form (the recipient should fill in an oline form) and separator (section header in the list)

- file :
This type of Dossier item can accept multiple files. For instance, you can add 1 Dossier item called "Identity card". On the Dossier public page, the recipient will be able to add two different files to this single item (front-side.pdf and back-side.jpg).

- form :
Some times, you may need to gather information from the recipient through an online form. To achieve this, add a Dossier Item with the parameter type=form and add a json form description in the form_data field.
On the Dossier public page, instead of an upload field, an online form will be displayed and filled in by the recipient.

- separator :
Use this value to add a separator in the list. Ex: Personal details, Financial situation, etc.


Attachments
: external files linked to the dossier

Marketing documentation, user guide, etc. These documents will be displayed in the "Information" section of the public page.

Notification Emails

By default, Clust will send a notification email to the recipient of the Dossier. If you don't want Clust to send that automatic email, add a auto_emails = 0 parameter to your createDossier API call. You will then be in charge of sending the public_url link the recipient

Recipient / Contact

Each Clust Dossier is created for a specific recipient. As part of the createDossier API, you need to provide the recipient's personal information : first name, last name and email. In the response, you will get a Contact object including a contact_id value
If you want to create new dossiers for the same user, simply pass the contact_id.

Dossier status

After the request has been sent to the recipient, you can call the getDossier API to check the Dossier' status. Here are the available values :
0_not_started : initial state, no document provided 1_in_progress : documents' collection in progress 2_approved : all documents have been approved 3_archived : dossier has been archived

Deadlines and Reminders

When creating a Dossier, you can pass a deadline parameter which will be used by Clust to send 3 reminders to the recipient. (D-7, D-3, D-1). By default, if no deadline is provided, we will add 14 days to the current date to define the deadline. If you don't want these automatic reminders to be sent, you should pass auto_emails = 0.

Embed your list in a web page

Sometime you may want to embed the list of required document directly in a web page for a full white label experience.
This can be achieved by adding ?embedded=1 to the public_url returned by the createRequest API. Then, pass that URL in an iframe on the target page.