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.

Bad Request - The request contains invalid or malformed data.

Request Errors

Missing required values

• Required values in the header are missing from the request. The customer_id and signature values are required.

Poorly formed customer id

• The customer_id header value is malformed or cannot be parsed.

Bad encoding

• The request body could not be decoded from base64 or parsed as valid JSON.

Field Validation Errors

Poorly formed phone number

• Invalid phone number in the send_link.to property. Prefix phone numbers with a plus sign (+) followed by country code (e.g., +15551234567 for US numbers).

Invalid capture_language

• Invalid value in the capture_language property in public_data. Must be one of: en-us, fr-ca, or es-mx.

Invalid urls

• Invalid URLs in public_data properties: redirect_url, error_redirect_url, results_url, or status_url. URLs must be properly formatted with valid protocol (https://) and domain. Do not include spaces.

send_link object bad request

• Invalid data in the send_link object in private_data. The type property must be one of: sms or whatsapp. The to property must match the format required by the specified type.

invalid ttl value

• Invalid value in the ttl property in private_data. Must be a positive integer, greater than 0 but less than or equal to 30, representing minutes to complete.

Purpose field missing from private_data

• Missing purpose property in private_data. This field is required based on your account configuration and describes the reason for identity verification.

Private body bad request

• One or more fields in private_data contain invalid types, missing required fields, forbidden fields, or values outside allowed ranges.

Public body bad request

• One or more fields in public_data contain invalid types, missing required fields, forbidden fields, or values outside allowed ranges.

Unauthorized - Authentication failed.

Common Causes:

• Invalid HMAC-SHA256 signature
• Invalid customer ID
• Invalid application credentials

Not Found - The requested endpoint does not exist.

Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request.

Common Causes:

• Database connection failures
• Missing server configuration
• Request processing errors
• Signal processing errors

Action: If this error persists, contact Intellicheck support with your transaction ID (if available). The error details are logged on the server for investigation.