--- title: "Get Transaction Data" method: POST path: "/api/v1/get-transaction-data" tags: ["Get Data"] --- # Get Transaction Data `POST /api/v1/get-transaction-data` Use this endpoint to request transaction data for a single transaction or for multiple transactions during a specified timeframe. The results can be useful for evaluating success and failure rates. This endpoint retrieves historic transaction data. Note that this response is not the same as the response from `/get-results`. IMPORTANT: The `/get-transaction-data` endpoint response will vary depending on the endpoints that were called for each transaction. Intellicheck may also periodically change the response object schema without notice. Do not implement code that relies on an identical response schema over time for this endpoint. ## Headers - `signature` string, required — Encrypted Request Body - `customer-id` string, required — Your provided customer ID. ## Request body - AppRoutesRoutesMvpV1SwaggerSwaggerDocModelsGetTransactionDataRouteRequest - `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 transaction data. Format as yyyy-mm-dd. Default date range is the past seven days. - `end_date` string — End date for transaction data. Format as yyyy-mm-dd. Default date range is the past seven days. - `result_size` number — The number of 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 transactions is reached but there are additional transactions to return. In that case, make a second call to `/get-transaction-data` and pass the returned `search_after` value with your request to receive the next chunk of 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 transaction data. Compatibility note: Intellicheck may add new properties to this response over time. Additions to existing response objects are not considered a breaking change. Your integration should ignore unrecognized properties and unknown enum values. - AppRoutesRoutesMvpV1SwaggerSwaggerDocModelsGetTransactionDataRouteResponse - `public_data` object - `version` string — Version of the API. - `endpoint` string — The requested endpoint. - `private_data` object, required - `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 transaction data. - `mapping_version` integer — Version to which the response is mapped. Intellicheck-only. - `api` string — Intellicheck only. - `record_type` integer — Intellicheck only. - `customer_id` string — Your provided customer ID. - `customer_name` string — Customer name associated with the provided `customer_id`. - `transaction_id` string — ID issued at the beginning of a transaction to associate all subsequent processes within the transaction until ended. - `created_at` string, date-time — Transaction timestamp. Same as `trans_time`. - `trans_time` string, date-time — Transaction timestamp. Same as `created_at`. - `year` integer — Year from transaction timestamp. - `month` integer — Month from transaction timestamp. - `day` integer — Day from transaction timestamp. - `hour` integer — Hour from transaction timestamp. - `document_type` string — Identification type. Values: `na_dl`, `passport`, `other`. - `pii_ttl` integer — TTL value for the transaction PII data. - `pii_ttl_date` string — Time and date value at which the transaction PII data is removed. - `transaction_source` string — Transaction source, for example, Capture or Direct. - `barcode-only_req_time` string, date-time — Transaction request time for the barcode-only endpoint. - `barcode-only_res_time` string, date-time — Transaction response time for the barcode-only endpoint. - `submit-front_req_time` string, date-time — Transaction request time for the submit-front endpoint. - `submit-front_res_time` string, date-time — Transaction response time for the submit-front endpoint. - `submit-barcode_req_time` string, date-time — Transaction request time for the submit-barcode endpoint. - `submit-barcode_res_time` string, date-time — Transaction response time for the submit-barcode endpoint. - `start_req_time` string, date-time — Transaction request time for the start endpoint. - `start_res_time` string, date-time — Transaction response time for the start endpoint. - `end_req_time` string, date-time — Transaction request time for the end endpoint. - `end_res_time` string, date-time — Transaction response time for the end endpoint. - `submit-selfie_req_time` string, date-time — Transaction request time for the submit-selfie endpoint. - `submit-selfie_res_time` string, date-time — Transaction response time for the submit-selfie endpoint. - `front_back` object — Contains details about the front and back of the ID document. - `front` object — Details about the front of the ID document. - `is_barcode` integer — 0 if the submitted front did not contain a barcode. 1 if it did contain a barcode. - `is_front` integer — 0 if the submitted image is not a front. 1 if it is a front. - `back` object — Details about the back of the ID document. - `is_barcode` integer — 0 if the submitted back did not contain a barcode. 1 if it did contain a barcode. - `is_back` integer — 0 if the submitted image is not a back. 1 if it is a back. - `qr_breakpoint_px` integer — Specifies the pixel measurement at which point a screen width exceeding this value results in a QR code displayed by Capture (instead of the capture process welcome page). For example, if `qr_breakpoint_px` is 700, then a screen larger than 700 pixels results in a QR code to be scanned. Therefore, this value is the breakpoint measurement that specifies whether the customer is using a phone screen or a monitor. - `signals_run` string[] — Array of signals requested for the transaction. - `barcode` boolean — True if barcode_result was returned; false otherwise. - `barcode_result` object — The transaction results for a barcode check. Object properties vary depending on whether `include_pii` was requested. - `document_liveness` boolean — True if document_liveness_result was returned; false otherwise. - `document_liveness_result` object — The transaction results for a document liveness check. Object properties vary depending on whether `include_pii` was requested. - `ocr` boolean — True if ocr_result was returned; false otherwise. - `ocr_result` object — Transaction results returned if the request included an `ocr` signal. Object properties vary depending on whether `include_pii` was requested. - `ocr_match` boolean — True if ocr_match_result was returned; false otherwise. - `ocr_match_result` object — The transaction results for an OCR match check. Object properties vary depending on whether `include_pii` was requested. - `mrz` boolean — True if mrz_result was returned; false otherwise. - `mrz_result` object — The transaction results for a machine readable zone (MRZ) check. Object properties vary depending on whether `include_pii` was requested. - `device_address` boolean — True if device_address_result was returned; false otherwise. - `device_address_result` object — The transaction results for a device address check. Object properties vary depending on whether `include_pii` was requested. - `email_validation` boolean — True if email_validation_result was returned; false otherwise. - `email_validation_result` object — The transaction results for an email validation check. Object properties vary depending on whether `include_pii` was requested. - `phone_validation` boolean — True if phone_validation_result was returned; false otherwise. - `phone_validation_result` object — The transaction results for a phone validation check. Object properties vary depending on whether `include_pii` was requested. - `mailing_address` boolean — True if mailing_address_result was returned; false otherwise. - `mailing_address_result` object — The transaction results for a mailing address check. Object properties vary depending on whether `include_pii` was requested. - `face_comparison` boolean — True if face_comparison_result was returned; false otherwise. - `face_comparison_result` object — The transaction results for a face comparision check. Object properties vary depending on whether `include_pii` was requested. - `mailing_address_check` boolean — True if mailing_address_check_result was returned; false otherwise. - `mailing_address_check_result` object — The transaction results for a mailing address check. Object properties vary depending on whether `include_pii` was requested. - `search_after` number[] — This array of one number is returned when the maximum `result_size` of 10,000 transactions is reached but there are additional transactions to return. In that case, make a second call to `/get-transaction-data` and pass this returned `search_after` value with your request to receive the next chunk of transactions. ## 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)