Purpose: To fetch metadata about a completed verification.
Auth: Requires an access_token
bearer token for authentication in the Authorization
header parameter. Authorization: Bearer <token>
Expected Response: JSON payload for the specified transaction including the action
, flags
and fields
.
API Library Usage
var transactionData = await client.fetchTransaction(transactionTokens)
$transactionData = $client->fetchTransaction($transactionTokens);
transaction_data = client.fetch_transaction(transaction_tokens)
transaction_data = client.fetch_transaction(transaction_tokens)
Transaction transactionData = client.fetchTransaction(Tokens tokens);
transactionData, err := client.FetchTransaction(transactionTokens)
Response Values
For a detailed explanation of the data contained within the payload, expand the sample 200
response below or review the linked resources.
id
: Transaction IDflags
: Transaction Flagsaction
: Decision based on Action Mapsfields
,value
,confidence
andsources
: Transaction Fieldscustomer_uid
: Customer UID Best Practicesimages
: URL links to captured images are not available in the payload by default. Reach out to [email protected] to discuss if this is needed for your workflow.duplicates
: Duplicate Transactionsdashboard_url
: Link to the Transaction Report in the dashboardaction_map_results
: The Action Map used to determine theaction
broken down bycondition
andcondition_triggered
results.session_metadata
: Session Information as determined by the user's device and ISP is not included in the payload by default. Please reach out to [email protected] to discuss if needed.
Do we need to rely on Berbix to make the "action" decision?
By fetching the transaction metadata, you are able to consume the
flags
andfields
associated with a transaction to create custom rules and decisions on your end.With that said, we strongly recommend that you consume and rely on the
action
field for making business decisions. Berbix Action Maps are specifically built for this purpose, and by leveraging this tool, you can adjust business logic without any code changes on your end.