v1

latestOpenAPI 3.0.0Apache 2.02026-07-244385400.4 KB

Collect Sessions

Create Collect Session

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.

post/collect/sessions

Request body

success_urlstring

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_urlstring

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_emailboolean

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).

Example request

{
  "customer": {
    "id": "0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b",
    "name": "lnrrigby-fdda-400c-8583-9b686c7254fd",
    "email": "johnsmith@inscribe.ai"
  },
  "document_requests": [
    {
      "label": "July Bank Statements",
      "description": "A personal bank statement for proof-of-income",
      "max_documents": 5,
      "tags": [
        {
          "text": "onboarding"
        }
      ],
      "verify": {
        "name": "Frank Abagnale",
        "names": [
          "Frank Abagnale"
        ],
        "address": "123 Fake Street",
        "addresses": [
          "123 Fake Street"
        ],
        "company": "Inscribe AI Inc",
        "companies": [
          "Inscribe AI Inc"
        ],
        "id_number": "12-1234567",
        "id_numbers": [
          "12-1234567"
        ],
        "strings": [
          {
            "key": "Phone number",
            "input": "929 947 9991"
          }
        ],
        "patterns": [
          {
            "key": "Phone number",
            "pattern": "^\\d{3} \\d{3} \\d{4}$"
          }
        ]
      }
    }
  ],
  "success_url": "https://inscribe.com/portal/#success?session_id={SESSION_ID}",
  "cancel_url": "https://inscribe.com/portal/#cancel?session_id={SESSION_ID}",
  "send_email": true
}

Response

Successfully created collect session.

idstring uuid

Unique identifier for the object.

urlstring

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_idstring uuid

Unique identifier for the associated customer.

created_atstring date-time

Time at which the session was created. In the format: yyyy-MM-dd'T'HH:mm:ssZ

completed_atstring 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_urlstring

The URL the user will be redirected to when they complete the session.

cancel_urlstring

The URL the user will be redirected to when they abort or cancel the session.

logo_urlstring

A link to the logo displayed in the collect session.

display_namestring

The name of the company being displayed in the collect session.

expiredboolean

States if the session is active

Example response

{
  "id": "0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b",
  "url": "https://collect.inscribe.ai/#/fa207be0-b4da-4234-a350-fbbfe3b3298c/d1e07ab9-36a6-43eb-a550-2bc77dce8afc",
  "customer_id": "0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b",
  "created_at": "2019-12-12T15:35:08.460Z",
  "completed_at": "2019-12-12T15:35:08.460Z",
  "success_url": "https://example.com/#success?session_id=0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b",
  "cancel_url": "https://example.com/#cancel?session_id=0efae611-b3eb-4b84-8ed0-a4e92ad3bf4b",
  "logo_url": "https://assets.website-files.com/5ea61a1bf0e208bb1c5737ac/5ec69023b5341a114ab26bc7_inscribe_logo.svg",
  "display_name": "Inscribe"
}