Transfon Gateway API

Get started with Transfon Gateway

Transfon Gateway API Documentation

This document provides details on the response fields returned by the Transfon Gateway API.

HTTP Response Data Fields

FieldTypeDescription
qsBooleanIndicates if the traffic passed the quality check. true means passed; false means failed.
ibBooleanIndicates if the traffic is identified as a bot. true means bot; false means not a bot.
icBooleanIndicates if the traffic originates from an Internet Data Center (IDC). true means IDC traffic.
dcStringCode representing the data center or cloud provider. Example: "AMAZON_AWS".
ixBooleanIndicates if the traffic is coming through a proxy. true means proxy traffic.
itBooleanIndicates if the traffic is coming through the Tor network. true means Tor traffic.
ivBooleanIndicates if the traffic is coming through a VPN. true means VPN traffic.
ihBooleanIndicates if the request failed the HTTP header consistency check, i.e. the request headers contradict the browser claimed by the User-Agent. true means inconsistent headers.
hcStringComma-separated codes of the header consistency rules that failed. Omitted when all rules pass. Example: "no_ch,no_sec_fetch". See Header Consistency Codes.
geoStringTwo-letter country code representing the geographic location of the traffic. Example: "GB".
blockBooleanIndicates if the traffic is blocked. true means blocked; false means allowed.

Header Consistency Codes

The header consistency check only applies to requests whose User-Agent claims to be a real browser (Chrome, Firefox, or Safari). When a rule fails, its code is included in the hc field and ih is set to true. A failed rule also causes the quality check (qs) to fail.

CodeDescription
no_chUser-Agent claims Chrome/Chromium 89 or later, but the sec-ch-ua client hint header is missing.
ch_nonchromiumUser-Agent claims a non-Chromium browser (Firefox or Safari), but Chromium-only sec-ch-ua headers are present.
ch_verThe Chromium major version in sec-ch-ua does not match the Chrome version in the User-Agent.
ch_platformThe sec-ch-ua-platform value does not match the operating system in the User-Agent.
ch_mobileThe sec-ch-ua-mobile value does not match the mobile token in the User-Agent.
no_sec_fetchUser-Agent claims a modern browser, but the sec-fetch-* headers are missing.
no_accept_encodingBrowser User-Agent, but the Accept-Encoding header is missing.
no_accept_languageBrowser User-Agent, but the Accept-Language header is missing.
no_acceptBrowser User-Agent, but the Accept header is missing.

Example HTTP Response

{
  "qs": false,
  "ib": false,
  "ic": true,
  "dc": "AMAZON_AWS",
  "ix": false,
  "it": false,
  "iv": false,
  "ih": false,
  "geo": "GB",
  "block": false
}