---
title: "Get Journey Data"
method: POST
path: "/api/v1/get-journey-data"
tags: ["Get Data"]
---

# Get Journey Data

`POST /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.

## Headers

- `signature` string, required — Encrypted Request Body
- `customer-id` string, required — Your provided customer ID.

## Request body

- AppRoutesRoutesMvpV1SwaggerSwaggerDocModelsGetJourneyDataRouteRequest
  - `public_data` object, required — May **not** contain personally identifiable information (PII).
  - `private_data` object, required — May contain personally identifiable information (PII).
    - `transaction_id` string — Include a transaction ID value to request details for a single transaction. Only one `transaction_id` is allowed per request. If found, details for that transaction ID are returned in the response. If the requested `transaction_id` is not found, an error message is returned in the `message` field.
    - `include_pii` boolean — If true, returns personally identifiable information (PII) with the results.
    - `start_date` string — Start date for customer journey data. Format as yyyy-mm-dd. Default date range is the past seven days.
    - `end_date` string — End date for customer journey data. Format as yyyy-mm-dd. Default date range is the past seven days.
    - `result_size` number — The number of customer journey transactions to return between 1 and 10,000.
    - `search_after` number[] — This array of one number should only be passed if it was returned in the corresponding `search_after` property of the `private_data` response object. The `search_after` property is returned when the maximum `result_size` of 10,000 customer journey transactions is reached but there are additional transactions to return. In that case, make a second call to `/get-journey-data` and pass the returned `search_after` value with your request to receive the next chunk of customer journey transactions. Pass only the `search_after` value; no other `private_data` object properties are necessary. Do not pass `search_after` on an initial request. Doing so will invalidate the request, resulting in an empty or unexpected response.

## Response `200`

Successfully retrieved journey data.

- AppRoutesRoutesMvpV1SwaggerSwaggerDocModelsGetJourneyDataRouteResponse
  - `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 — Empty if no error. Else, a description of the error result, for example, "No image found to process."
    - `transactions_count` integer — Number of transactions returned.
    - `transactions` object[] — Array of customer journey data.
      - `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` string, 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` 'capture' | 'direct' | 'desktop' | 'portal' — Transaction type.
      - `message_type` 'sms' — Type of message sent to the customer.
      - `trans_url` string — Transaction URL. This is the URL a customer selects to begin the transaction.
      - `steps_to_run` string[] — A list of the steps required to complete the transaction.
      - `ipqs_submitted` boolean — True if the transaction included a fraud-check request to IPQS; false otherwise.
      - `ipqs_submitted_time` string, 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` string, date-time — Date and time at which the customer visited the landing page.
      - `landing_continue_clicked_timestamp` string, 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` string, 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` string, 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` string, date-time — Date and time at which captured front image was submitted.
      - `front_timestamp` string, 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` string, 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` string, 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` string, 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` string, 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` string, 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` string, 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.

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/intellicheck/apis/idn-direct-api.md) · [All operations](https://skmtc.net/intellicheck/apis/idn-direct-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/intellicheck/idn-direct-api/versions/9ce4fb734b46/schema)