Get Transaction Data
Applies to: Direct
This is the JSON private_data response schema for the /get-transaction-data endpoint.
See
/get-transaction-datain the API explorer for more information.
In the schema, only top-level summary objects are shown for the following result properties:
barcode_resultocr_resultmrz_resultdevice_address_resultemail_validation_resultphone_validation_resultcriminal_background_result
This is because the exact schema for each result property cannot be known. Each transaction is different, and therefore, the results will vary. The results also vary depending on whether include_pii was submitted with the /get-transaction-data request.
{
"private_data": {
"title": "Private Data",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "True if the API call was successful; false otherwise."
},
"message": {
"type": "string",
"description": "A description of the result output, for example, \"success\" or an error message."
},
"transactions_count": {
"type": "integer",
"description": "Number of transactions returned."
},
"transactions": {
"type": "array",
"description": "Array of transaction data.",
"items":{
"type": "object",
"properties": {
"mapping_version": {
"type": "integer",
"description": "Version to which the response is mapped. Intellicheck-only."
},
"customer_id": {
"type": "string",
"description": "Your provided customer ID."
},
"customer_name": {
"type": "string",
"description": "Customer name associated with the provided `customer_id`."
},
"transaction_id": {
"type": "string",
"description": "ID issued at the beginning of a transaction to associate all subsequent processes within the transaction until ended."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Transaction timestamp. Same as `trans_time`."
},
"trans_time": {
"type": "string",
"format": "date-time",
"description": "Transaction timestamp. Same as `created_at`."
},
"year": {
"type": "integer",
"description": "Year from transaction timestamp."
},
"month": {
"type": "integer",
"description": "Month from transaction timestamp."
},
"day": {
"type": "integer",
"description": "Day from transaction timestamp."
},
"hour": {
"type": "integer",
"description": "Hour from transaction timestamp."
},
"document_type": {
"type": "string",
"description": "Identification type. Values: `na_dl`, `passport`, `other`."
},
"pii_ttl_date": {
"type": "string",
"description": "Time and date value at which the transaction PII data is removed."
},
"transaction_source": {
"type": "string",
"description": "Transaction source, for example, <<capture-api>> or <<direct-api>>."
},
"front_back": {
"type": "object",
"description": "Contains details about the front and back of the ID document.",
"properties": {
"front": {
"type": "object",
"description": "Details about the front of the ID document.",
"properties": {
"is_barcode": {
"type": "integer",
"description": "0 if the submitted front did not contain a barcode. 1 if it did contain a barcode."
},
"is_front": {
"type": "integer",
"description": "0 if the submitted image is not a front. 1 if it is a front."
}
}
},
"back": {
"type": "object",
"description": "Details about the back of the ID document.",
"properties": {
"is_barcode": {
"type": "integer",
"description": "0 if the submitted back did not contain a barcode. 1 if it did contain a barcode."
},
"is_back": {
"type": "integer",
"description": "0 if the submitted image is not a back. 1 if it is a back."
}
}
}
}
},
"qr_breakpoint_px": {
"type": "integer",
"description": "Specifies the pixel measurement at which point a screen width exceeding this value results in a QR code displayed by <<capture-api>> (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."
},
"datalake": {
"type": "object",
"description": "Data repository from which the image data was returned.",
"properties": {
"front_image_key": {
"type": "string",
"description": "Key value for the raw front image data."
},
"back_image_key": {
"type": "string",
"description": "Key value for the raw back image data."
},
"barcode_key": {
"type": "string",
"description": "Key value for the raw barcode data."
}
}
},
"signals_run": {
"type": "array",
"description": "Array of signals requested for the transaction.",
"items": {
"type": "string",
"description": "A signal requested for the transaction."
}
},
"barcode_result": {
"type": "object",
"description": "The transaction results for a barcode check. Object properties vary depending on whether `include_pii` was requested.",
"properties": {
}
},
"ocr_result": {
"type": "object",
"description": "Transaction results returned if the request included an `ocr` signal. Object properties vary depending on whether `include_pii` was requested.",
"properties": {
}
},
"mrz_result": {
"type": "object",
"description": "The transaction results for a machine readable zone (MRZ) check. Object properties vary depending on whether `include_pii` was requested.",
"properties": {
}
},
"device_address_result": {
"type": "object",
"description": "The transaction results for a device address check. Object properties vary depending on whether `include_pii` was requested.",
"properties": {
}
},
"email_validation_result": {
"type": "object",
"description": "The transaction results for an email validation check. Object properties vary depending on whether `include_pii` was requested.",
"properties": {
}
},
"phone_validation_result": {
"type": "object",
"description": "The transaction results for a phone validation check. Object properties vary depending on whether `include_pii` was requested.",
"properties": {
}
},
"criminal_background_result": {
"type": "object",
"description": "The transaction results for a criminal background check. Object properties vary depending on whether `include_pii` was requested.",
"properties": {
}
}
}
}
},
"search_after": {
"type": "array",
"description": "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.",
"items": {
"type": "number",
"format": "integer"
}
}
}
}
}
Updated 15 days ago