v1
latestOpenAPI 3.1.12026-07-141331164.8 KBStart Transaction
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.
Headers
Encrypted Request Body
Encrypted Request Body
Your provided customer ID.
Your provided customer ID.
Request body
Response
Transaction successfully started. The response body varies based on the integration and request parameters. Here are four common examples:
Direct integration - polling
Your request included only the minimum required properties: signals and document_type. The private_data response object includes a transaction_id. Your application must poll the /get-results endpoint to retrieve verification results.
Direct integration - webhook
Your request included the optional results_url. The public_data response echoes back the results_url. This approach is the preferred method. Intellicheck sends verification results to your webhook URL when processing completes. No polling is required.
Capture integration - send SMS
Your request included send_link with a phone number. The private_data response echoes back the send_link property. The capture_url is returned in public_data for reference. Intellicheck sends the capture_url link to the end user by way of SMS or WhatsApp.
Capture integration - redirect
Your request included return_capture_url: True. The private_data response includes a capture_url property for reference. Intellicheck redirects the end user browser to the capture_url to begin the Capture process.