Skip to content

Download contributions as CSV​

GET
/data/api/v1/contribution-management/contribution/download

Runs the same query as GET /data/api/v1/contribution-management/contribution, with the same parameters and the same charge, and answers with a CSV file. The totals of the query are in the X-* response headers.

The file has a header line and one line per record. Lines end with CR LF. Columns: Fraud type, ID start, ID end, Originating country, Terminating country, Timestamp, Fraud status, Confidence index (reserved, always empty), Expiry date, Uploader ID, Source ID, Flagger ID, Flag timestamp, Asset Definition ID.

Errors are answered as JSON in the envelope.

Authorizations​

bearerAuth

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

Type
HTTP (bearer)

Parameters​

Query Parameters

size

The most records to return. Without it all matching records are returned.

Type
integer
Example50
Format
"int32"
Minimum
0
from

Return records uploaded at or after this time. An ISO 8601 date-time with an offset or Z. Encode a + of the offset as %2B.

Type
string
Example"2026-01-01T00:00:00Z"
Format
"date-time"
to

Return records uploaded at or before this time. An ISO 8601 date-time with an offset or Z. Encode a + of the offset as %2B.

Type
string
Example"2026-01-31T23:59:59Z"
Format
"date-time"
ft

Return only records of these fraud types. Repeat the parameter for several types. Without it all types are returned. Names that are not fraud types are ignored. Not applied with fetch-mode=SELF.

Type
array
Example"Wangiri""IRSF"
org

Return only records with one of these origination countries (ISO 3166-1 alpha-2). Repeat the parameter for several countries.

Type
array
Example"GB""IS"
dst

Return only records with one of these destination countries (ISO 3166-1 alpha-2). Repeat the parameter for several countries.

Type
array
Example"NZ""FJ"
fetch-mode

Which records to return.

  • DEFAULT: own records, records bought before, and records not seen before, which are bought.
  • NEW: only records that other companies uploaded and that the company has never bought. They are bought. A record another company uploaded with the caller's company as its source is included.
  • OLD: only own records and records bought before. Nothing is charged.
  • SELF: only records the company uploaded itself. Records that name it as the source are not included, and ft is not applied. Nothing is charged.
Type
string
Valid values
"DEFAULT""NEW""OLD""SELF"
Example"DEFAULT"
Default
"DEFAULT"
confidence-score

Reserved. Ignored; always empty.

Type
boolean
Examplefalse
Default
false

Responses​

The matching records as a CSV file.

text/csv
JSON
"Fraud type,ID start,ID end,Originating country,Terminating country,Timestamp,Fraud status,Confidence index,Expiry date,Uploader ID,Source ID,Flagger ID,Flag timestamp,Asset Definition ID IPFraud,198.51.100.9,198.51.100.9,DK,PT,2026-01-15T10:00:00Z,Active,,2026-02-14T10:00:00Z,example_vendor,example_vendor,,,00000000-0000-7000-8000-000000000003 IRSF,+447700900410,+447700900412,SE,GR,2026-01-15T10:00:00Z,Flagged,,2026-02-14T10:00:00Z,example_vendor,example_vendor,example_telco,2026-01-16T08:00:00Z,00000000-0000-7000-8000-000000000002 "

Samples​

Powered by VitePress OpenAPI