API Reference
Home
Start typing to search…

Start Transaction

post https://apiexample.intellicheck.com/api/v1/start

Starts a transaction. For Capture, you begin and end the transaction with a single call to the /start endpoint. For Direct, you begin the transaction with a call to the /start endpoint, and then continue the transaction with subsequent calls to additional endpoints, such as /submit-back, /end, and /get-results.

Recipes
🌱
Start Transaction with Encoding (Python)
Open Recipe
🌱
Start Transaction with Encrypting (Python)
Open Recipe
🌱
Start Transaction with Encoding (JavaScript)
Open Recipe
🌱
Start Transaction with Encoding (Java)
Open Recipe
🌱
Start Transaction with Encrypting (Java)
Open Recipe
🌱
Start Transaction with Encrypting & SHA512 (Java)
Open Recipe
🌱
Start Transaction with Signed Payload (C#/.NET Framework)
Open Recipe
Log in to see full request history
Body Params
public_data
object
required

May not contain personally identifiable information (PII). A public_data object is required even if it is empty, for example, public_data: {}.

private_data
object
required

May contain personally identifiable information (PII). A private_data object is required even if it is empty, for example, private_data: {}. If empty, default values are used according to the configuration established by Intellicheck for your account.

Headers
string
required
Defaults to <calculated_signature>

Encrypted Request Body

string
required
Defaults to <customer_id>

Your provided customer ID.

Responses

Response body
object
public_data
object
required
string

The requested endpoint.

string

Version of the API.

string

A URL address for the capture session.

string

Postback URL to handle response data from the verification process. Verification results are not delivered to the end-user browser. Verification results are posted back to this URL to be viewed by your customer associate.

string

Postback URL to handle status updates for the Capture experience.

string

Language setting.

private_data
object
required
string

ID issued at the beginning of a transaction to associate all subsequent processes within the transaction until ended.

string

A URL address for the capture session. Returned here if return_capture_url: True in the private_data request.

signals
array of strings

Confirmed list of signals to run.

signals
number
≤ 30

Minutes user will have to complete the capture process. Defaults to 10 minutes unless overridden.

string

A UTC date and time when the transaction expires. Format is mm-dd-yyyy hh:mm:ss. It is calculated based on the current date and time plus the ttl value, which is in minutes.

Updated about 1 year ago

Did this page help you?
Language

Updated about 1 year ago

Did this page help you?