Privacy PolicyTerms and ConditionsSubprocessorsTrust Center
API Reference
Go to Inscribe

Create Collect Session

post
https://api.inscribe.ai/api/v2/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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

A collect session request object.

customer
object
required
document_requests
array of objects
required
document_requests*
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.

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.

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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/plain

Updated 7 months ago