Transaction context
- GET
/transaction/contextSearch captured transaction context - GET
/transaction/{transactionReference}/contextRead the circumstances under which one transaction was made
GET Search captured transaction context
GET /transaction/context
Every filter is optional and they combine. The window defaults to the last ninety days when no dates are given. This is the surface that answers a question nobody thought to write a rule for - every transaction from one ASN, or one IP, or one geohash prefix - which is why the circumstances are stored rather than only the conclusions drawn from them at the time.
Headers
| Name | Notes |
|---|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Query parameters
| Name | Default |
|---|---|
userReference | Optional |
deviceReference | Optional |
ipAddress | Optional |
country | Optional |
asn | Optional |
origin | Optional |
geoHashPrefix | Optional |
from | Optional |
to | Optional |
page | [object Object] |
size | [object Object] |
Example
Response: GenericResponseRequestCircumstancePage
curl -X GET "https://api.bridgemoni.com/transaction/context?page=value&size=value" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" {
"data": {
"circumstances": [
{
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"transactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"contextOrigin": "string",
"inheritedFromCircumstanceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"capturedAt": "string",
"completenessScore": 0,
"assuranceSummary": "string",
"spoofIndicatorCount": 0,
"enrichmentTruncated": true,
"retentionTier": "string",
"session": {
"sessionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"sessionReferenceOrigin": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"channelName": "string",
"applicationName": "string",
"applicationVersion": "string",
"traceId": "string",
"pinValidated": true,
"deviceValidated": true,
"hourOfDayLocal": 0
},
"device": {
"deviceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"deviceType": "string",
"brandName": "string",
"operatingSystem": "string",
"operatingSystemVersion": "string",
"integrityVerdict": "string",
"newToUser": true,
"locale": "string",
"timezoneOffsetMinutes": 0
},
"network": {
"ipCountry": "string",
"ipSubdivision": "string",
"ipCity": "string",
"ipAsn": 0,
"ipAsnOrganisation": "string",
"ipConnectionType": "string",
"anonymiserVerdict": "string",
"networkType": "string",
"mobileCountryCode": "string",
"mobileNetworkCode": "string"
},
"location": {
"source": "string",
"capturedAt": "string",
"accuracyMetres": 0,
"geoHash": "string",
"resolvedCountry": "string",
"resolvedSubdivision": "string",
"distanceFromHomeKilometres": "string",
"distanceFromLastKilometres": "string",
"minutesSinceLastTransaction": 0,
"impliedSpeedKilometresPerHour": "string"
}
}
],
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPages": 0
},
"description": "Transaction context retrieved successfully"
} Responses
| Status | When |
|---|---|
200 | Transaction context retrieved successfully |
GET Read the circumstances under which one transaction was made
GET /transaction/{transactionReference}/context
The record is written before the transaction is screened and in its own database transaction, so a refused transaction still has one - those are the ones whose circumstances matter most. Every value carries an assurance grade: DERIVED means Bridge computed it from something the client cannot control, DECLARED means the client asserted it and nothing corroborated it, and CONTRADICTED means a claim and an independent derivation disagreed. Precise coordinates are not returned here; read the attributes endpoint for those.
Headers
| Name | Notes |
|---|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Path parameters
| Name |
|---|
transactionReference |
Example
Response: GenericResponseRequestCircumstance
curl -X GET "https://api.bridgemoni.com/transaction/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/context" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" {
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"transactionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"userReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"contextOrigin": "string",
"inheritedFromCircumstanceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"capturedAt": "string",
"completenessScore": 0,
"assuranceSummary": "string",
"spoofIndicatorCount": 0,
"enrichmentTruncated": true,
"retentionTier": "string",
"session": {
"sessionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"sessionReferenceOrigin": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"channelName": "string",
"applicationName": "string",
"applicationVersion": "string",
"traceId": "string",
"pinValidated": true,
"deviceValidated": true,
"hourOfDayLocal": 0
},
"device": {
"deviceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"deviceType": "string",
"brandName": "string",
"operatingSystem": "string",
"operatingSystemVersion": "string",
"integrityVerdict": "string",
"newToUser": true,
"locale": "string",
"timezoneOffsetMinutes": 0
},
"network": {
"ipCountry": "string",
"ipSubdivision": "string",
"ipCity": "string",
"ipAsn": 0,
"ipAsnOrganisation": "string",
"ipConnectionType": "string",
"anonymiserVerdict": "string",
"networkType": "string",
"mobileCountryCode": "string",
"mobileNetworkCode": "string"
},
"location": {
"source": "string",
"capturedAt": "string",
"accuracyMetres": 0,
"geoHash": "string",
"resolvedCountry": "string",
"resolvedSubdivision": "string",
"distanceFromHomeKilometres": "string",
"distanceFromLastKilometres": "string",
"minutesSinceLastTransaction": 0,
"impliedSpeedKilometresPerHour": "string"
}
},
"description": "Transaction context retrieved successfully"
} Responses
| Status | When |
|---|---|
200 | Transaction context retrieved successfully |
Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors