Skip to content

Look up an identifier​

GET
/data/api/v1/contribution-management/contribution/{id}

Returns the active records that cover an identifier. The lookup is free of charge. Use it to find the assetDefinitionId of a record to flag.

Matching rules:

  • A device (IMEI) matches a record with the same IMEI.
  • A single phone number or IPv4 address matches a record that is this value or a range that starts with it. A value inside a stored range that is not its first value is not found.
  • A range matches a stored record with exactly this range. It also matches a stored record that shares a value with it and whose first value begins with the characters that both ends of the asked range have in common. Other overlapping records are not found, so ask with the identifier or range as it is stored.
  • Email addresses and URLs are not found by this route.

Flagged and expired records are not returned. A privileged record is returned only to its own company and to the companies it has approved.

Authorizations​

bearerAuth

The accessToken of a sign-in or refresh answer. Valid for 5 minutes.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

A phone number in E.164 form with +, an IPv4 address, a range of either (first-last), or a 15-digit IMEI.

Type
string
Required
Examples
"+447700900501"

Responses​

The records that cover the identifier. Never empty.

application/json
JSON
{
  
"status": {
  
  
"code": 0,
  
  
"name": "Ok"
  
},
  
"data": [
  
  
{
  
  
  
"id": "+447700900501-+447700900501",
  
  
  
"fraudType": "Wangiri",
  
  
  
"origination": "LV",
  
  
  
"destination": "EE",
  
  
  
"expiryDate": "2026-03-16T10:00:00Z",
  
  
  
"fraudStatus": "Active",
  
  
  
"confidenceIndex": null,
  
  
  
"isPrivileged": false,
  
  
  
"peerId": "example_telco",
  
  
  
"flagger": null,
  
  
  
"timestamp": "2026-01-15T10:00:00Z",
  
  
  
"flagTimestamp": null,
  
  
  
"assetDefinitionId": "00000000-0000-7000-8000-000000000001",
  
  
  
"sourcePeerId": "example_telco"
  
  
}
  
]
}

Samples​

Powered by VitePress OpenAPI