--- title: "Create Collect Session" method: POST path: "/collect/sessions" tags: ["Collect Sessions"] --- # Create Collect Session `POST /collect/sessions` Inscribe's Collect API allows you to automate each step of your document collection process, from customer contact to fraud checks and verification. In order to initiate a Collect Session, you will need to provide Inscribe with information about the user you wish to collect documents from, as well as the documents you need to collect from them. You will also need to provide your authentication details. ## Request body - CollectSessionCreateRequest - `customer` object, required - `id` string, uuid — The unique identifier of the associated customer object. If an id is not provided, a name must be provided. - `name` string — The name of the customer object that will be created and associated with the session. If an id is provided this field will be ignored. Note that customer object names are required to be unique. - `email` string, email — The contact email of the user. This field is required if the value of send_email is True. - `document_requests` CreateDocumentRequest[], required - `label` string, required — A descriptive string displayed when making the document request. - `description` string — An optional description of the document request that will be visible to the collect session user. - `max_documents` integer — The maximum number of accepted documents that the user can upload to this request. The maximum value is 70, the default and minimum value is 1. Requests which stipulate a value in excess of 70 will be silently capped at 70. - `tags` UploadTag[] - `text` string, required — A descriptive value chosen by you to group documents together across customers. - `verify` VerificationsRequest — Optional information to be verified against a document. If supplied there must be exactly one entry for each document, an entry can be blank if no information is to be verified. - `name` string — A personal name you wish to verify against the document. **Warning** This field is deprecated and will be removed in a future release. Please use `names` instead. - `names` string[] — An array of personal names you wish to verify against the document. - `address` string — An address you wish to verify is represented in the document. **Warning** This field is deprecated and will be removed in a future release. Please use `addresses` instead. - `addresses` string[] — An array of address you wish to verify are represented in the document. - `company` string — A company name you wish to verify against the document. **Warning** This field is deprecated and will be removed in a future release. Please use `companies` instead. - `companies` string[] — An array of company names you wish to verify against the document. - `id_number` string — An identification number you wish to verify against the document. Currently, SSN and EIN formats are supported. **Warning** This field is deprecated and will be removed in a future release. Please use `id_numbers` instead. - `id_numbers` string[] — An array of identification numbers you wish to verify against the document. - `strings` object[] - `key` string — An identifier for the input. Set by you for your own reference. - `input` string — A string you wish to verify against the document. - `patterns` object[] - `key` string — An identifier for the pattern. Set by you for your own reference. - `pattern` string — A regular expression pattern you wish to verify against the document. - `use_parsed_details_only` boolean — If true, only the parsed details will be used for verification not the whole document text. If false or not present, both parsed details and the whole document text will be used for verification. - `success_url` string — The URL the user will be redirected to when they complete the session. Any occurrence of the string "{SESSION_ID}" in the URL will be replaced with the session id. - `cancel_url` string — The URL the user will be redirected to when they abort or cancel the session. Any occurrence of the string "{SESSION_ID}" in the URL will be replaced with the session id. - `send_email` boolean — A boolean indicating whether Inscribe should email the user a URL for the Collect session (if send_email is True, the email field must not be null). ## Response `200` Successfully created collect session. - CollectSession - `id` string, uuid — Unique identifier for the object. - `url` string — The URL for the session. The first UUID in the URL is a unique identifier for your organisation that will be static accross Collect sessions. The second UUID in the URL is the session id. - `customer_id` string, uuid — Unique identifier for the associated customer. - `created_at` string, date-time — Time at which the session was created. In the format: yyyy-MM-dd'T'HH:mm:ssZ - `completed_at` string, nullable — Time at which the session was completed. This will be null if the session has not been completed. In the format: yyyy-MM-dd'T'HH:mm:ssZ - `success_url` string — The URL the user will be redirected to when they complete the session. - `cancel_url` string — The URL the user will be redirected to when they abort or cancel the session. - `logo_url` string — A link to the logo displayed in the collect session. - `display_name` string — The name of the company being displayed in the collect session. - `expired` boolean — States if the session is active ## Other responses - `400` — You have provided incorrect data. - `403` — You do not have permission to access this resource. - `429` — Too many requests. The request has been rate limited. For more information, visit our [documentation on rate limiting](https://docs.inscribe.ai/docs/are-the-endpoints-rate-limited). --- [API](https://skmtc.dev/inscribe/apis/core-resources.md) · [All operations](https://skmtc.dev/inscribe/apis/core-resources/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/inscribe/core-resources/revisions/6489b36eb60f/schema)