Collect allows you to request and validate customer documents with ease. This page will guide you through Collect's features, and provide detailed instructions for a sample use case of requesting and validating an in-date bank statement.

Collect is designed to deliver most value when used via the API, and you can find a complete reference for the Collect API at our documentation page. However, it's also possible to get started with Collect just by using the web app, and this Getting Started guide will assume no familiarity with the API.

You can create a Collect session for a customer simply by visiting the customer's page within the web app, and clicking the Collect button shown below.

If no Collect button is shown, please reach out to your Account Executive in order to enable Collect for your organisation.

Clicking the Collect button will bring up a modal window, allowing you to customise the Collect session associated with this customer.

You can choose to input an email for the customer, and Inscribe will contact them directly, or you can click the email toggle to generate a URL that you can share yourself.

Collect sessions are made up of document requests. The label field allows you to indicate what document you're looking to Collect (for example, "January Bank statement"). If you want to allow the end-user to upload a variable number of documents for a given label, you can set a suitable corresponding value for 'Max docs'. In the image above, we're telling Inscribe to email the customer, and to show two document requests; for each request we're accepting one document.

Once the session is created, a unique Collect portal is generated for the end-user. An example portal is shown below.

You can learn more about the branding shown in your Collect portal at our Setting up Collect page.

When the end user has uploaded at least one document for each document request, the Finish button will activate, and the user will be brought to the session completion URL after clicking.

In order to ensure you're collecting the right documents, you can use Collect together with Inscribe's Checks feature.

When creating or editing a Check, you can choose to show the results of the Check to Collect users with the toggle below.

In the remainder of this subsection, we'll consider a concrete example of applying a Check during a Collect session, and show how this is experienced by the end user.

First, we'll create a suitable Check. In order to only apply it to the right documents, we set the filter condition to require the presence of the tag "recent_bs".

Next, we'll set the Check requirements. In this example we want to ensure that the document we request is a bank statement, and that the statement date is no more than 90 days old.

Finally, we ensure that we've set the toggle to show this Check to Collect users.

Note that some variables (Detector results, Trust score, Sensitive details edited and Document software) are not supported for Checks that are shown to users. If you include any of these variables as filters or conditions, the toggle will be disabled.

Now that we've created a Check, we can start creating Collect sessions that will interact with it.

Since the only filter condition on our Check is that the document has been tagged "recent_bs", all we need to do is ensure that the documents uploaded during the Collect session have this tag.

This can be done when creating a Session by clicking on the tags icon associated with a document request, and choosing the desired tag from the dropdown menu. Once the tag has been chosen, it will appear under the document request.

With all this in place, let's take a look at what happens when we visit the Collect portal and upload a valid bank statement, but with an issue date too old for our Check requirement.

Once the document has completed processing, Inscribe will compare the document class and extracted date from what was expected.

Since the document class matched what was expected, the user is only prompted with the date issue. The user is encouraged to re-upload with dynamic feedback until a document meeting all the Check conditions has been received.

You can track the progress of sessions in real time via the API and your Collect dashboard. In addition you can create webhooks on the notification page to perform custom actions whenever a Collect session has been completed.

Once you're familiar with the Collect flow described above, we recommend checking out the reference page for the Collect API. Using the API allows for additional functionality, such as: