Get Transaction Data

post https://apiexample.intellicheck.com/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 not the same as the response from /get-results.

Responses

Response body

object

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

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 transaction data.

transactions

object

mapping_version

integer

Version to which the response is mapped. 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

date-time

Transaction timestamp. Same as trans_time.

trans_time

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_date

string

Time and date value at which the transaction PII data is removed.

transaction_source

string

Transaction source, for example, Capture or Direct.

front_back

object

Contains details about the front and back of the ID document.

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

array of strings

Array of signals requested for the transaction.

signals_run

barcode_result

object

The transaction results for a barcode check. Object properties vary depending on whether include_pii was requested.

ocr_result

object

Transaction results returned if the request included an ocr signal. Object properties vary depending on whether include_pii was requested.

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_result

object

The transaction results for a device address check. Object properties vary depending on whether include_pii was requested.

email_validation_result

object

The transaction results for an email validation check. Object properties vary depending on whether include_pii was requested.

phone_validation_result

object

The transaction results for a phone validation check. Object properties vary depending on whether include_pii was requested.

search_after

array of numbers

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.

search_after

200Successfully retrieved transaction data.

401Unauthorized