Get Journey Data

post https://apiexample.intellicheck.com/api/v1/get-journey-data

Use this endpoint to request customer journey data for a single transaction or for multiple transactions during a specified timeframe. The results can be useful for evaluating time spent per page and abandonment rates.

Responses

Response body

object

public_data

object

version

string

Version of the API.

endpoint

string

The requested endpoint.

private_data

object

success

boolean

True if the API call was successful; false otherwise.

message

string

A description of the result output, for example, "success" or an error message.

transactions_count

integer

Number of transactions returned.

transactions

array of objects

Array of customer journey data.

transactions

object

transaction_id

string

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

customer_id

string

Your provided customer ID.

customer_name

string

Customer name associated with the provided customer_id.

trans_time

date-time

Transaction timestamp.

document_type

string

Identification type. Values: na_dl, passport, other.

message_opened

boolean

True if the customer opened the text message; false otherwise.

api_version

string

API version used for the transaction.

completed

boolean

True if the customer finished the transaction; false otherwise.

trans_type

string

Transaction type.

capture direct desktop portal

trans_url

string

Transaction URL. This is the URL a customer selects to begin the transaction.

steps_to_run

array of strings

A list of the steps required to complete the transaction.

steps_to_run

ipqs_submitted

boolean

True if the transaction included a fraud-check request to IPQS; false otherwise.

ipqs_submitted_time

date-time

Date and time at which the fraud-check request was submitted to IPQS.

landing_count

integer

Count of the landing page visits. This count includes browser refreshes.

landing_visited

boolean

True if the customer browser visited the landing page; false otherwise. The landing page is where the customer must begin the capture process.

landing_visited_timestamp

date-time

Date and time at which the customer visited the landing page.

landing_continue_clicked_timestamp

date-time

Date and time at which the customer selected the continue button on the landing page.

landing_delta

number

Elapse time in seconds between the landing page visit and exit.

camera_permission_presented

boolean

True if the camera permissions dialog was presented; false otherwise. The camera permissions dialog is where the customer must accept a request to grant permission for camera access.

camera_permission_presented_timestamp

date-time

Date and time at which the camera permissions dialog was presented.

camera_permission_presented_count

integer

Count of the camera permissions dialog visits. This count includes browser refreshes.

camera_permission_accepted

boolean

True if the customer accepted the request; false otherwise.

camera_permission_accepted_timestamp

date-time

Date and time at which the customer accepted the request.

camera_permission_accepted_count

integer

Count of the camera permissions accepted button selection. Typically one (1).

camera_permission_delta

number

Elapse time in seconds between the camera permissions dialog visit and exit.

front_visited

boolean

True if the customer browser visited the capture-front page; false otherwise. The front page is where the customer captures an image of the front of the identification document.

front_count

integer

Count of the front page visits. This count includes browser refreshes.

front_use_image_clicked

boolean

True if the customer approved the captured front-image of the identification document; false otherwise.

front_delta

number

Elapse time in seconds between the front page visit and exit.

front_submitted_timestamp

date-time

Date and time at which captured front image was submitted.

front_timestamp

date-time

Date and time at which the front page was visited.

barcode_visited

boolean

True if the customer browser visited the capture-barcode page; false otherwise. The barcode page is where the customer captures an image of the barcode, which is typically located on the back of the identification document.

barcode_delta

number

Elapse time in seconds between the barcode page visit and exit.

barcode_submitted_timestamp

date-time

Date and time at which the captured barcode was submitted.

barcode_count

integer

Count of the barcode page visits. This count includes browser refreshes.

barcode_timestamp

date-time

Date and time at which the barcode page was visited.

bio_consent_visited

boolean

True if the customer browser visited the biometrics consent page; false otherwise. The biometric consent page is where a customer must accept the biometric consent policy.

bio_consent_visited_timestamp

date-time

Date and time at which the biometric consent page was visited.

bio_consent_visited_count

integer

Count of the biometric consent page visits. This count includes browser refreshes.

selfie_visited

boolean

True if the customer browser visited the capture-selfie page; false otherwise. The selfie page is where the customer must capture a selfie portrait.

selfie_delta

number

Elapse time in seconds between the selfie page visit and exit.

selfie_timestamp

date-time

Date and time at which the selfie page was visited.

selfie_count

integer

Count of the selfie page visits. This count includes browser refreshes.

selfie_camera_permission_presented

boolean

True if the selfie camera permissions page was presented; false otherwise. The selfie camera permissions page is where a customer must accept a request to grant permission for selfie-camera access.

selfie_camera_permission_presented_timestamp

date-time

Date and time at which the selfie camera permissions page was presented.

selfie_camera_permission_presented_count

integer

Count of the selfie camera permissions page visits. This count includes browser refreshes.

selfie_camera_permission_accepted

boolean

True if the customer accepted the request; false otherwise.

selfie_camera_permission_accepted_timestamp

date-time

Date and time at which the selfie camera permissions page was accepted.

selfie_camera_permission_accepted_count

integer

Count of the camera permissions accepted button selection. Typically one (1).

selfie_camera_permission_delta

number

Elapse time in seconds between the selfie camera permissions page visit and exit.

transaction_success

boolean

True if the transaction successfully concluded; false otherwise.

last_step

string

Last-step status message of the capture journey completed by the customer, for example, transaction_completed.

single_pass

boolean

True if the page-flow journey was completed in a single pass with no revisits or refreshes; false otherwise.

200Successfully retrieved journey data.

401Unauthorized