{ "openapi": "3.1.0", "info": { "title": "Gurdx API", "version": "1.0.0", "summary": "Fraud prevention and user intelligence API, scores IPs, payments, cards, emails, phones and text.", "description": "Gurdx scores IPs, payments, emails, phone numbers, cards and text. Errors are returned with HTTP 200 and a JSON body `{status: \"error\", code, type, description}` — see the error-code list.\n\nDocumentation: https://gurdx.cretip.com/docs", "contact": { "url": "https://gurdx.cretip.com/contact", "email": "hello@gurdx.com" } }, "servers": [ { "url": "https://gurdx.cretip.com/api", "description": "Gurdx API" } ], "security": [ { "ApiKeyQuery": [] }, { "BearerAuth": [] } ], "tags": [ { "name": "Data lookup" }, { "name": "Scoring" }, { "name": "Feedback" }, { "name": "Account" } ], "paths": { "/geoip": { "get": { "operationId": "geoip", "summary": "IP Geolocation", "tags": [ "Data lookup" ], "description": "Counts as one request against your plan quota (free in test mode).", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" }, { "name": "params", "in": "query", "required": false, "description": "The params command can be used to specify the required modules you want to get in the response. Expected values: `security`, `currency`, `timezone`, `location`, and/or `device` Sample value: `security,timezone,currency` For more information please refer to [Customize response modules](/docs/options/customize-modules).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "ip": { "type": "string" }, "ipType": { "type": "string" }, "IPNumber": { "type": "integer" }, "bogon": { "type": "boolean" }, "continentName": { "type": "string" }, "continentCode": { "type": "string" }, "countryCode": { "type": "string" }, "continentGeoNameID": { "type": "integer" }, "countryName": { "type": "string" }, "countryGeoNameID": { "type": "integer" }, "regionName": { "type": "string" }, "cityName": { "type": "string" }, "zipCode": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "location": { "type": "object", "properties": { "capital": { "type": "string" }, "population": { "type": "integer" }, "language": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "native": { "type": "string" } } }, "flag": { "type": "object", "properties": { "emoji": { "type": "string" }, "unicode": { "type": "string" }, "png": { "type": "object", "properties": { "1000px": { "type": "string" }, "250px": { "type": "string" }, "100px": { "type": "string" } } }, "svg": { "type": "string" } } }, "phoneCode": { "type": "string" }, "countryIsEU": { "type": "boolean" }, "countryNeighbours": { "type": "string" }, "tld": { "type": "string" } } }, "currency": { "type": "object", "properties": { "currencyName": { "type": "string" }, "currencyCode": { "type": "string" }, "currencySymbol": { "type": "string" } } }, "asn": { "type": "object", "properties": { "asn": { "type": "string" }, "name": { "type": "string" }, "org": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "domain": { "type": "string" }, "created": { "type": "string" }, "type": { "type": "string" } } }, "timezone": { "type": "object", "properties": { "name": { "type": "string" }, "abbreviation": { "type": "string" }, "offset": { "type": "integer" }, "currentTime": { "type": "string" }, "currentTimestamp": { "type": "integer" }, "isDST": { "type": "boolean" }, "sunInfo": { "type": "object", "properties": { "sunset": { "type": "string" }, "sunrise": { "type": "string" }, "transit": { "type": "string" }, "civilTwilightBegin": { "type": "string" }, "civilTwilightEnd": { "type": "string" }, "nauticalTwilightBegin": { "type": "string" }, "nauticalTwilightEnd": { "type": "string" }, "astronomicalTwilightBegin": { "type": "string" }, "astronomicalTwilightEnd": { "type": "string" }, "dayLength": { "type": "string" } } } } }, "security": { "type": "object", "properties": { "isProxy": { "type": "boolean" }, "proxyType": { "type": "string" }, "isTor": { "type": "boolean" }, "isBot": { "type": "boolean" }, "isRelay": { "type": "boolean" }, "isHosting": { "type": "boolean" }, "blacklisted": { "type": "boolean" } } }, "device": { "type": "object", "properties": { "isMobile": { "type": "boolean" }, "type": { "type": "string" }, "OS": { "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "family": { "type": "string" }, "version": { "type": "string" }, "title": { "type": "string" }, "64bits_mode": { "type": "integer" } } }, "browser": { "type": "object", "properties": { "name": { "type": "string" }, "version": { "type": "number" }, "versionMajor": { "type": "integer" }, "title": { "type": "string" } } } } }, "custom_rules_applied": { "type": "object", "properties": { "total": { "type": "integer" }, "rules": { "type": "array", "items": {} } } } } }, "status": { "type": "string" }, "executionTime": { "type": "integer" } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "data": { "ip": "165.227.149.217", "ipType": "IPv4", "IPNumber": 2783155673, "bogon": false, "continentName": "Europe", "continentCode": "EU", "countryCode": "DE", "continentGeoNameID": 6255148, "countryName": "Germany", "countryGeoNameID": 2921044, "regionName": "Hessen", "cityName": "Frankfurt am Main", "zipCode": "65931", "latitude": "50.115520", "longitude": "8.684170", "location": { "capital": "Berlin", "population": 83783942, "language": { "name": "German", "code": "de", "native": "Deutsch" }, "flag": { "emoji": "🇩🇪", "unicode": "U+1F1E9 U+1F1EA", "png": { "1000px": "https://gurdx.cretip.com/flags/png1000px/de.png", "250px": "https://gurdx.cretip.com/flags/png250px/de.png", "100px": "https://gurdx.cretip.com/flags/png100px/de.png" }, "svg": "https://gurdx.cretip.com/flags/svg/de.svg" }, "phoneCode": "49", "countryIsEU": true, "countryNeighbours": "CH,PL,NL,DK,BE,CZ,LU,FR,AT", "tld": ".de" }, "currency": { "currencyName": "Euro", "currencyCode": "EUR", "currencySymbol": "€" }, "asn": { "asn": "AS14061", "name": "DIGITALOCEAN-ASN", "org": "DigitalOcean, LLC", "phone": "+1-347-875-6044", "email": "noc@digitalocean.com", "domain": "digitalocean.com", "created": "2012-05-14", "type": "hosting" }, "timezone": { "name": "Europe/Berlin", "abbreviation": "CET", "offset": 3600, "currentTime": "03:33:13", "currentTimestamp": 1709519593, "isDST": false, "sunInfo": { "sunset": "18:14:11", "sunrise": "06:59:29", "transit": "12:36:50", "civilTwilightBegin": "06:28:47", "civilTwilightEnd": "18:44:53", "nauticalTwilightBegin": "05:51:20", "nauticalTwilightEnd": "19:22:21", "astronomicalTwilightBegin": "05:13:27", "astronomicalTwilightEnd": "20:00:13", "dayLength": "11:14:42" } }, "security": { "isProxy": true, "proxyType": "VPN", "isTor": false, "isBot": false, "isRelay": false, "isHosting": true, "blacklisted": false }, "device": { "isMobile": false, "type": "desktop", "OS": { "type": "desktop", "name": "MacOS", "family": "macintosh", "version": "Big Sur", "title": "MacOS Big Sur", "64bits_mode": 1 }, "browser": { "name": "Safari", "version": 17.2, "versionMajor": 1, "title": "Safari 17.2" } }, "custom_rules_applied": { "total": 0, "rules": [] } }, "status": "success", "executionTime": 4 } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } } } }, "/lookup/ip": { "get": { "operationId": "ipLookup", "summary": "IP Lookup", "tags": [ "Data lookup" ], "description": "Counts as one request against your plan quota (free in test mode).", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" }, { "name": "ip", "in": "query", "required": true, "description": "The ip command is used to specify the IP address you want to lookup. Expected values: an IP address (IPv4 or IPv6) Sample value: `1.1.1.1`", "schema": { "type": "string" } }, { "name": "params", "in": "query", "required": false, "description": "The params command can be used to specify the required modules you want to get in the response. Expected values: `security`, `currency`, `timezone`, and/or `location`. Sample value: `security,timezone,currency` For more information please refer to [Customize response modules](/docs/options/customize-modules).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "ip": { "type": "string" }, "ipType": { "type": "string" }, "IPNumber": { "type": "integer" }, "bogon": { "type": "boolean" }, "continentName": { "type": "string" }, "continentCode": { "type": "string" }, "countryCode": { "type": "string" }, "continentGeoNameID": { "type": "integer" }, "countryName": { "type": "string" }, "countryGeoNameID": { "type": "integer" }, "regionName": { "type": "string" }, "cityName": { "type": "string" }, "zipCode": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "location": { "type": "object", "properties": { "capital": { "type": "string" }, "population": { "type": "integer" }, "language": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "native": { "type": "string" } } }, "flag": { "type": "object", "properties": { "emoji": { "type": "string" }, "unicode": { "type": "string" }, "png": { "type": "object", "properties": { "1000px": { "type": "string" }, "250px": { "type": "string" }, "100px": { "type": "string" } } }, "svg": { "type": "string" } } }, "phoneCode": { "type": "string" }, "countryIsEU": { "type": "boolean" }, "countryNeighbours": { "type": "string" }, "tld": { "type": "string" } } }, "currency": { "type": "object", "properties": { "currencyName": { "type": "string" }, "currencyCode": { "type": "string" }, "currencySymbol": { "type": "string" } } }, "asn": { "type": "object", "properties": { "asn": { "type": "string" }, "name": { "type": "string" }, "org": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "domain": { "type": "string" }, "created": { "type": "string" }, "type": { "type": "string" } } }, "timezone": { "type": "object", "properties": { "name": { "type": "string" }, "abbreviation": { "type": "string" }, "offset": { "type": "integer" }, "currentTime": { "type": "string" }, "currentTimestamp": { "type": "integer" }, "isDST": { "type": "boolean" }, "sunInfo": { "type": "object", "properties": { "sunset": { "type": "string" }, "sunrise": { "type": "string" }, "transit": { "type": "string" }, "civilTwilightBegin": { "type": "string" }, "civilTwilightEnd": { "type": "string" }, "nauticalTwilightBegin": { "type": "string" }, "nauticalTwilightEnd": { "type": "string" }, "astronomicalTwilightBegin": { "type": "string" }, "astronomicalTwilightEnd": { "type": "string" }, "dayLength": { "type": "string" } } } } }, "security": { "type": "object", "properties": { "isProxy": { "type": "boolean" }, "proxyType": { "type": "string" }, "isTor": { "type": "boolean" }, "isBot": { "type": "boolean" }, "isRelay": { "type": "boolean" }, "isHosting": { "type": "boolean" }, "blacklisted": { "type": "boolean" } } }, "custom_rules_applied": { "type": "object", "properties": { "total": { "type": "integer" }, "rules": { "type": "array", "items": {} } } } } }, "status": { "type": "string" }, "executionTime": { "type": "integer" } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "data": { "ip": "165.227.149.217", "ipType": "IPv4", "IPNumber": 2783155673, "bogon": false, "continentName": "Europe", "continentCode": "EU", "countryCode": "DE", "continentGeoNameID": 6255148, "countryName": "Germany", "countryGeoNameID": 2921044, "regionName": "Hessen", "cityName": "Frankfurt am Main", "zipCode": "65931", "latitude": "50.115520", "longitude": "8.684170", "location": { "capital": "Berlin", "population": 83783942, "language": { "name": "German", "code": "de", "native": "Deutsch" }, "flag": { "emoji": "🇩🇪", "unicode": "U+1F1E9 U+1F1EA", "png": { "1000px": "https://gurdx.cretip.com/flags/png1000px/de.png", "250px": "https://gurdx.cretip.com/flags/png250px/de.png", "100px": "https://gurdx.cretip.com/flags/png100px/de.png" }, "svg": "https://gurdx.cretip.com/flags/svg/de.svg" }, "phoneCode": "49", "countryIsEU": true, "countryNeighbours": "CH,PL,NL,DK,BE,CZ,LU,FR,AT", "tld": ".de" }, "currency": { "currencyName": "Euro", "currencyCode": "EUR", "currencySymbol": "€" }, "asn": { "asn": "AS14061", "name": "DIGITALOCEAN-ASN", "org": "DigitalOcean, LLC", "phone": "+1-347-875-6044", "email": "noc@digitalocean.com", "domain": "digitalocean.com", "created": "2012-05-14", "type": "hosting" }, "timezone": { "name": "Europe/Berlin", "abbreviation": "CET", "offset": 3600, "currentTime": "03:33:13", "currentTimestamp": 1709519593, "isDST": false, "sunInfo": { "sunset": "18:14:11", "sunrise": "06:59:29", "transit": "12:36:50", "civilTwilightBegin": "06:28:47", "civilTwilightEnd": "18:44:53", "nauticalTwilightBegin": "05:51:20", "nauticalTwilightEnd": "19:22:21", "astronomicalTwilightBegin": "05:13:27", "astronomicalTwilightEnd": "20:00:13", "dayLength": "11:14:42" } }, "security": { "isProxy": true, "proxyType": "VPN", "isTor": false, "isBot": false, "isRelay": false, "isHosting": true, "blacklisted": false }, "custom_rules_applied": { "total": 0, "rules": [] } }, "status": "success", "executionTime": 4 } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } } } }, "/lookup/ip/bulk": { "get": { "operationId": "ipBulk", "summary": "Bulk IP Lookup", "tags": [ "Data lookup" ], "description": "Counts as one request against your plan quota (free in test mode).", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" }, { "name": "ips", "in": "query", "required": true, "description": "The ips command is used to specify the IP address you want to lookup. Expected values: comma serarated IP addresses (IPv4 or IPv6) Sample value: `1.1.1.1,2.2.2.2`", "schema": { "type": "string" } }, { "name": "params", "in": "query", "required": false, "description": "The params command can be used to specify the required modules you want to get in the response. Expected values: `security`, `currency`, `timezone`, `location`, and/or `device` Sample value: `security,timezone,currency` For more information please refer to [Customize response modules](/docs/options/customize-modules).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "1.1.1.1": { "type": "object", "properties": { "ip": { "type": "string" }, "ipType": { "type": "string" }, "IPNumber": { "type": "integer" }, "bogon": { "type": "boolean" }, "continentName": { "type": "string" }, "continentCode": { "type": "string" }, "countryCode": { "type": "string" }, "continentGeoNameID": { "type": "integer" }, "countryName": { "type": "string" }, "countryGeoNameID": { "type": "integer" }, "regionName": { "type": "string" }, "cityName": { "type": "string" }, "zipCode": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "location": { "type": "object", "properties": { "capital": { "type": "string" }, "population": { "type": "integer" }, "language": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "native": { "type": "string" } } }, "flag": { "type": "object", "properties": { "emoji": { "type": "string" }, "unicode": { "type": "string" }, "png": { "type": "object", "properties": { "1000px": { "type": "string" }, "250px": { "type": "string" }, "100px": { "type": "string" } } }, "svg": { "type": "string" } } }, "phoneCode": { "type": "string" }, "countryIsEU": { "type": "boolean" }, "countryNeighbours": { "type": "string" }, "tld": { "type": "string" } } }, "currency": { "type": "object", "properties": { "currencyName": { "type": "string" }, "currencyCode": { "type": "string" }, "currencySymbol": { "type": "string" } } }, "asn": { "type": "object", "properties": { "asn": { "type": "string" }, "name": { "type": "string" }, "org": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "domain": { "type": "string" }, "created": { "type": "string" }, "type": { "type": "string" } } }, "timezone": { "type": "object", "properties": { "name": { "type": "string" }, "abbreviation": { "type": "string" }, "offset": { "type": "integer" }, "currentTime": { "type": "string" }, "currentTimestamp": { "type": "integer" }, "isDST": { "type": "boolean" }, "sunInfo": { "type": "object", "properties": { "sunset": { "type": "string" }, "sunrise": { "type": "string" }, "transit": { "type": "string" }, "civilTwilightBegin": { "type": "string" }, "civilTwilightEnd": { "type": "string" }, "nauticalTwilightBegin": { "type": "string" }, "nauticalTwilightEnd": { "type": "string" }, "astronomicalTwilightBegin": { "type": "string" }, "astronomicalTwilightEnd": { "type": "string" }, "dayLength": { "type": "string" } } } } }, "security": { "type": "object", "properties": { "isProxy": { "type": "boolean" }, "proxyType": { "type": "string" }, "isTor": { "type": "boolean" }, "isBot": { "type": "boolean" }, "isRelay": { "type": "boolean" }, "isHosting": { "type": "boolean" }, "blacklisted": { "type": "boolean" } } }, "custom_rules_applied": { "type": "object", "properties": { "total": { "type": "integer" }, "rules": { "type": "array", "items": {} } } } } }, "8.8.8.8": { "type": "object", "properties": { "ip": { "type": "string" }, "ipType": { "type": "string" }, "IPNumber": { "type": "integer" }, "bogon": { "type": "boolean" }, "continentName": { "type": "string" }, "continentCode": { "type": "string" }, "countryCode": { "type": "string" }, "continentGeoNameID": { "type": "integer" }, "countryName": { "type": "string" }, "countryGeoNameID": { "type": "integer" }, "regionName": { "type": "string" }, "cityName": { "type": "string" }, "zipCode": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "location": { "type": "object", "properties": { "capital": { "type": "string" }, "population": { "type": "integer" }, "language": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "native": { "type": "string" } } }, "flag": { "type": "object", "properties": { "emoji": { "type": "string" }, "unicode": { "type": "string" }, "png": { "type": "object", "properties": { "1000px": { "type": "string" }, "250px": { "type": "string" }, "100px": { "type": "string" } } }, "svg": { "type": "string" } } }, "phoneCode": { "type": "string" }, "countryIsEU": { "type": "boolean" }, "countryNeighbours": { "type": "string" }, "tld": { "type": "string" } } }, "currency": { "type": "object", "properties": { "currencyName": { "type": "string" }, "currencyCode": { "type": "string" }, "currencySymbol": { "type": "string" } } }, "asn": { "type": "object", "properties": { "asn": { "type": "string" }, "name": { "type": "string" }, "org": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "domain": { "type": "string" }, "created": { "type": "string" }, "type": { "type": "string" } } }, "timezone": { "type": "object", "properties": { "name": { "type": "string" }, "abbreviation": { "type": "string" }, "offset": { "type": "integer" }, "currentTime": { "type": "string" }, "currentTimestamp": { "type": "integer" }, "isDST": { "type": "boolean" }, "sunInfo": { "type": "object", "properties": { "sunset": { "type": "string" }, "sunrise": { "type": "string" }, "transit": { "type": "string" }, "civilTwilightBegin": { "type": "string" }, "civilTwilightEnd": { "type": "string" }, "nauticalTwilightBegin": { "type": "string" }, "nauticalTwilightEnd": { "type": "string" }, "astronomicalTwilightBegin": { "type": "string" }, "astronomicalTwilightEnd": { "type": "string" }, "dayLength": { "type": "string" } } } } }, "security": { "type": "object", "properties": { "isProxy": { "type": "boolean" }, "proxyType": { "type": "string" }, "isTor": { "type": "boolean" }, "isBot": { "type": "boolean" }, "isRelay": { "type": "boolean" }, "isHosting": { "type": "boolean" }, "blacklisted": { "type": "boolean" } } }, "custom_rules_applied": { "type": "object", "properties": { "total": { "type": "integer" }, "rules": { "type": "array", "items": {} } } } } } } }, "status": { "type": "string" }, "executionTime": { "type": "integer" } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "data": { "1.1.1.1": { "ip": "165.227.149.217", "ipType": "IPv4", "IPNumber": 2783155673, "bogon": false, "continentName": "Europe", "continentCode": "EU", "countryCode": "DE", "continentGeoNameID": 6255148, "countryName": "Germany", "countryGeoNameID": 2921044, "regionName": "Hessen", "cityName": "Frankfurt am Main", "zipCode": "65931", "latitude": "50.115520", "longitude": "8.684170", "location": { "capital": "Berlin", "population": 83783942, "language": { "name": "German", "code": "de", "native": "Deutsch" }, "flag": { "emoji": "🇩🇪", "unicode": "U+1F1E9 U+1F1EA", "png": { "1000px": "https://gurdx.cretip.com/flags/png1000px/de.png", "250px": "https://gurdx.cretip.com/flags/png250px/de.png", "100px": "https://gurdx.cretip.com/flags/png100px/de.png" }, "svg": "https://gurdx.cretip.com/flags/svg/de.svg" }, "phoneCode": "49", "countryIsEU": true, "countryNeighbours": "CH,PL,NL,DK,BE,CZ,LU,FR,AT", "tld": ".de" }, "currency": { "currencyName": "Euro", "currencyCode": "EUR", "currencySymbol": "€" }, "asn": { "asn": "AS14061", "name": "DIGITALOCEAN-ASN", "org": "DigitalOcean, LLC", "phone": "+1-347-875-6044", "email": "noc@digitalocean.com", "domain": "digitalocean.com", "created": "2012-05-14", "type": "hosting" }, "timezone": { "name": "Europe/Berlin", "abbreviation": "CET", "offset": 3600, "currentTime": "03:33:13", "currentTimestamp": 1709519593, "isDST": false, "sunInfo": { "sunset": "18:14:11", "sunrise": "06:59:29", "transit": "12:36:50", "civilTwilightBegin": "06:28:47", "civilTwilightEnd": "18:44:53", "nauticalTwilightBegin": "05:51:20", "nauticalTwilightEnd": "19:22:21", "astronomicalTwilightBegin": "05:13:27", "astronomicalTwilightEnd": "20:00:13", "dayLength": "11:14:42" } }, "security": { "isProxy": true, "proxyType": "VPN", "isTor": false, "isBot": false, "isRelay": false, "isHosting": true, "blacklisted": false }, "custom_rules_applied": { "total": 0, "rules": [] } }, "8.8.8.8": { "ip": "8.8.8.8", "ipType": "IPv4", "IPNumber": 2783155673, "bogon": false, "continentName": "Europe", "continentCode": "EU", "countryCode": "DE", "continentGeoNameID": 6255148, "countryName": "Germany", "countryGeoNameID": 2921044, "regionName": "Hessen", "cityName": "Frankfurt am Main", "zipCode": "65931", "latitude": "50.115520", "longitude": "8.684170", "location": { "capital": "Berlin", "population": 83783942, "language": { "name": "German", "code": "de", "native": "Deutsch" }, "flag": { "emoji": "🇩🇪", "unicode": "U+1F1E9 U+1F1EA", "png": { "1000px": "https://gurdx.cretip.com/flags/png1000px/de.png", "250px": "https://gurdx.cretip.com/flags/png250px/de.png", "100px": "https://gurdx.cretip.com/flags/png100px/de.png" }, "svg": "https://gurdx.cretip.com/flags/svg/de.svg" }, "phoneCode": "49", "countryIsEU": true, "countryNeighbours": "CH,PL,NL,DK,BE,CZ,LU,FR,AT", "tld": ".de" }, "currency": { "currencyName": "Euro", "currencyCode": "EUR", "currencySymbol": "€" }, "asn": { "asn": "AS14061", "name": "DIGITALOCEAN-ASN", "org": "DigitalOcean, LLC", "phone": "+1-347-875-6044", "email": "noc@digitalocean.com", "domain": "digitalocean.com", "created": "2012-05-14", "type": "hosting" }, "timezone": { "name": "Europe/Berlin", "abbreviation": "CET", "offset": 3600, "currentTime": "03:33:13", "currentTimestamp": 1709519593, "isDST": false, "sunInfo": { "sunset": "18:14:11", "sunrise": "06:59:29", "transit": "12:36:50", "civilTwilightBegin": "06:28:47", "civilTwilightEnd": "18:44:53", "nauticalTwilightBegin": "05:51:20", "nauticalTwilightEnd": "19:22:21", "astronomicalTwilightBegin": "05:13:27", "astronomicalTwilightEnd": "20:00:13", "dayLength": "11:14:42" } }, "security": { "isProxy": true, "proxyType": "VPN", "isTor": false, "isBot": false, "isRelay": false, "isHosting": true, "blacklisted": false }, "custom_rules_applied": { "total": 0, "rules": [] } } }, "status": "success", "executionTime": 9 } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } } } }, "/lookup/ip/threats": { "get": { "operationId": "ipReputation", "summary": "IP Reputation", "tags": [ "Data lookup" ], "description": "Counts as one request against your plan quota (free in test mode).", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" }, { "name": "ip", "in": "query", "required": true, "description": "The ip parameter is used to specify the IP address you want to retrieve it's threat intelligence information. Expected values: an IP address (IPv4 or IPv6) Sample value: `1.1.1.1`", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "ip": { "type": "string" }, "threats": { "type": "object", "properties": { "isProxy": { "type": "boolean" }, "proxyType": { "type": "string" }, "isTor": { "type": "boolean" }, "isBot": { "type": "boolean" }, "isRelay": { "type": "boolean" }, "isHosting": { "type": "boolean" }, "blacklisted": { "type": "boolean" } } }, "custom_rules_applied": { "type": "object", "properties": { "total": { "type": "integer" }, "rules": { "type": "array", "items": {} } } } } }, "executionTime": { "type": "integer" } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "status": "success", "data": { "ip": "12.12.12.12", "threats": { "isProxy": true, "proxyType": "Socks", "isTor": false, "isBot": false, "isRelay": false, "isHosting": true, "blacklisted": false }, "custom_rules_applied": { "total": 0, "rules": [] } }, "executionTime": 90 } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } } } }, "/lookup/asn": { "get": { "operationId": "asn", "summary": "ASN Lookup", "tags": [ "Data lookup" ], "description": "Counts as one request against your plan quota (free in test mode).", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" }, { "name": "asn", "in": "query", "required": true, "description": "The asn command is used to specify the AS Number you want to lookup. Sample value: `AS6167` or `6167`", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "asn": { "type": "string" }, "name": { "type": "string" }, "country": { "type": "string" }, "org": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": [ "string", "null" ] }, "domain": { "type": "string" }, "status": { "type": "string" }, "created": { "type": "string" }, "type": { "type": "string" }, "registry": { "type": "string" }, "prefixes": { "type": "object", "properties": { "ipv4": { "type": "array", "items": { "type": "string" } }, "ipv6": { "type": "array", "items": { "type": "string" } }, "total": { "type": "integer" } } } } }, "status": { "type": "string" }, "executionTime": { "type": "integer" } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "data": { "asn": "AS9112", "name": "POZMAN", "country": "PL", "org": "Institute of Bioorganic Chemistry Polish Academy of Science, Poznan Supercomputing and Networking Center", "phone": "+48 61 8582010", "email": null, "domain": "poznan.pl", "status": "ASSIGNED", "created": "2004-04-17T11:47:57Z", "type": "education", "registry": "RIPE", "prefixes": { "ipv4": [ "150.254.0.0/16", "62.3.160.0/19" ], "ipv6": [ "2001:808::/35" ], "total": 3 } }, "status": "success", "executionTime": 0 } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } } } }, "/lookup/bin": { "get": { "operationId": "bin", "summary": "BIN Lookup", "tags": [ "Data lookup" ], "description": "Counts as one request against your plan quota (free in test mode).", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" }, { "name": "bin", "in": "query", "required": true, "description": "The BIN/IIN of the card (min: 6 digits). Sample value: `456789`, `456789XXXXXX1234`, or `4567891234567890`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "reason": { "type": "string" }, "isValid": { "type": "boolean" }, "blacklisted": { "type": "boolean" }, "bin": { "type": "string" }, "info": { "type": "object", "properties": { "scheme": { "type": "object", "properties": { "name": { "type": "string" }, "coName": { "type": "string" }, "isLuha": { "type": "boolean" }, "isPrepaid": { "type": "boolean" }, "isCommercial": { "type": "boolean" }, "type": { "type": "string" }, "brand": { "type": "string" }, "currency": { "type": "string" } } }, "detected_digits": { "type": "string" }, "syntax": { "type": "object", "properties": { "gaps": { "type": "array", "items": { "type": "integer" } }, "lengths": { "type": "array", "items": { "type": "integer" } }, "code": { "type": "object", "properties": { "name": { "type": "string" }, "size": { "type": "integer" } } } } }, "bank": { "type": "object", "properties": { "id": { "type": "string" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "city": { "type": "string" }, "url": { "type": "string" }, "phone": { "type": "string" }, "logo": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" } } }, "country": { "type": "object", "properties": { "alpha2": { "type": "string" }, "name": { "type": "string" }, "code": { "type": "string" }, "numeric": { "type": "string" }, "emoji": { "type": "string" }, "continent": { "type": "string" }, "languageCode": { "type": "string" }, "languageNative": { "type": "string" } } } } }, "custom_rules_applied": { "type": "object", "properties": { "total": { "type": "integer" }, "rules": { "type": "array", "items": {} } } } } }, "status": { "type": "string" }, "executionTime": { "type": "integer" } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "data": { "reason": "", "isValid": true, "blacklisted": false, "bin": "456789", "info": { "scheme": { "name": "Visa", "coName": "Mada", "isLuha": true, "isPrepaid": false, "isCommercial": false, "type": "debit", "brand": "Traditional", "currency": "SAR" }, "detected_digits": "4", "syntax": { "gaps": [ 4, 8, 12 ], "lengths": [ 16, 18, 19 ], "code": { "name": "CVV", "size": 3 } }, "bank": { "id": "588847", "identifier": "80", "name": "AL RAJHI BANKING AND INVESTMENT CORP.", "city": "Riyadh", "url": "https://www.alrajhibank.com.sa", "phone": "+96611211600", "logo": "https://gurdx.io/img/banks/al-rajhi.jpg", "latitude": "25", "longitude": "45" }, "country": { "alpha2": "SA", "name": "Saudi Arabia", "code": "966", "numeric": "682", "emoji": "🇸🇦", "continent": "Asia", "languageCode": "ar", "languageNative": "العربية" } }, "custom_rules_applied": { "total": 0, "rules": [] } }, "status": "success", "executionTime": 2 } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } } } }, "/lookup/iban": { "get": { "operationId": "iban", "summary": "IBAN Lookup", "tags": [ "Data lookup" ], "description": "Counts as one request against your plan quota (free in test mode).", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" }, { "name": "iban", "in": "query", "required": true, "description": "The International Bank Account Number (IBAN) you want to validate. Sample value: `BE71096123456769`, or `BE71 0961 2345 6769`.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "formats": { "type": "object", "properties": { "machine": { "type": "string" }, "human": { "type": "string" }, "obfuscated": { "type": "string" } } }, "country": { "type": "object", "properties": { "name": { "type": "string" }, "IANA": { "type": "string" }, "ISO3166": { "type": "string" }, "currency": { "type": "string" }, "centralBank": { "type": "object", "properties": { "url": { "type": "string" }, "name": { "type": "string" } } }, "membership": { "type": "string" }, "isEU": { "type": "boolean" }, "length": { "type": "string" }, "isSEPA": { "type": "boolean" }, "swiftOfficial": { "type": "boolean" } } }, "custom_rules_applied": { "type": "object", "properties": { "total": { "type": "integer" }, "rules": { "type": "array", "items": {} } } }, "bank": { "type": [ "string", "null" ] } } }, "status": { "type": "string" }, "executionTime": { "type": "integer" } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "data": { "isValid": true, "formats": { "machine": "BE71096123456769", "human": "BE71 0961 2345 6769", "obfuscated": "BE** **** **** 6769" }, "country": { "name": "Belgium", "IANA": "be", "ISO3166": "BE", "currency": "EUR", "centralBank": { "url": "http://www.nbb.be/", "name": "National Bank of Belgium" }, "membership": "eu_member", "isEU": true, "length": "16", "isSEPA": true, "swiftOfficial": true }, "custom_rules_applied": { "total": 0, "rules": [] }, "bank": null }, "status": "success", "executionTime": 1 } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } } } }, "/lookup/country": { "get": { "operationId": "country", "summary": "Country Lookup", "tags": [ "Data lookup" ], "description": "Counts as one request against your plan quota (free in test mode).", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" }, { "name": "CountryCode", "in": "query", "required": true, "description": "The `ISO 3166-1 alpha-2` format of the country code. [Learn more](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Sample value: `GB`", "schema": { "type": "string" } }, { "name": "params", "in": "query", "required": false, "description": "The params command is used to determine the data you need in the response. Expected values: `language`, `flag`, `currency`, and/or `timezone`. Sample value: `language,currency,timezone`", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "countryCode": { "type": "string" }, "countryName": { "type": "string" }, "countryGeoNameID": { "type": "integer" }, "capital": { "type": "string" }, "population": { "type": "integer" }, "phoneCode": { "type": "string" }, "currency": { "type": "object", "properties": { "currencyName": { "type": "string" }, "currencyCode": { "type": "string" }, "currencySymbol": { "type": "string" } } }, "language": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "native": { "type": "string" } } }, "timezone": { "type": "object", "properties": { "name": { "type": "string" }, "abbreviation": { "type": "string" }, "offset": { "type": "integer" }, "currentTime": { "type": "string" }, "currentTimestamp": { "type": "integer" }, "isDST": { "type": "boolean" }, "sunInfo": { "type": "object", "properties": { "sunset": { "type": "string" }, "sunrise": { "type": "string" }, "transit": { "type": "string" }, "civilTwilightBegin": { "type": "string" }, "civilTwilightEnd": { "type": "string" }, "nauticalTwilightBegin": { "type": "string" }, "nauticalTwilightEnd": { "type": "string" }, "astronomicalTwilightBegin": { "type": "string" }, "astronomicalTwilightEnd": { "type": "string" }, "dayLength": { "type": "string" } } } } }, "flag": { "type": "object", "properties": { "emoji": { "type": "string" }, "unicode": { "type": "string" }, "png": { "type": "object", "properties": { "1000px": { "type": "string" }, "250px": { "type": "string" }, "100px": { "type": "string" } } }, "svg": { "type": "string" } } }, "countryIsEU": { "type": "boolean" }, "countryNeighbours": { "type": "string" }, "tld": { "type": "string" }, "continentName": { "type": "string" }, "continentCode": { "type": "string" }, "continentGeoNameID": { "type": "integer" } } }, "status": { "type": "string" }, "executionTime": { "type": "integer" } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "data": { "countryCode": "US", "countryName": "United States", "countryGeoNameID": 6252001, "capital": "Washington, D.C.", "population": 331000000, "phoneCode": "1", "currency": { "currencyName": "United States Dollar", "currencyCode": "USD", "currencySymbol": "$" }, "language": { "name": "Portuguese", "code": "pt", "native": "Português" }, "timezone": { "name": "America/Adak", "abbreviation": "HST", "offset": -36000, "currentTime": "11:51:19", "currentTimestamp": 1643406679, "isDST": false, "sunInfo": { "sunset": "08:17:34", "sunrise": "20:08:16", "transit": "02:12:55", "civilTwilightBegin": "19:47:39", "civilTwilightEnd": "08:38:10", "nauticalTwilightBegin": "19:22:22", "nauticalTwilightEnd": "09:03:28", "astronomicalTwilightBegin": "18:57:01", "astronomicalTwilightEnd": "09:28:49", "dayLength": "11:50:42" } }, "flag": { "emoji": "🇺🇸", "unicode": "U+1F1FA U+1F1F8", "png": { "1000px": "https://gurdx.cretip.com/flags/png1000px/us.png", "250px": "https://gurdx.cretip.com/flags/png250px/us.png", "100px": "https://gurdx.cretip.com/flags/png100px/us.png" }, "svg": "https://gurdx.cretip.com/flags/svg/us.svg" }, "countryIsEU": false, "countryNeighbours": "CA,MX,CU", "tld": ".us", "continentName": "North America", "continentCode": "NA", "continentGeoNameID": 6255149 }, "status": "success", "executionTime": 0 } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } } } }, "/lookup/domain": { "get": { "operationId": "domain", "summary": "Domain Lookup", "tags": [ "Data lookup" ], "description": "Counts as one request against your plan quota (free in test mode).", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" }, { "name": "domain", "in": "query", "required": true, "description": "The fully qualified domain name (FQDN) to look up. [Learn more](https://en.wikipedia.org/wiki/Fully_qualified_domain_name) Sample value: `example.com`", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string" }, "is_dangerous": { "type": "boolean" }, "is_disposable": { "type": "boolean" }, "is_forwarding": { "type": "boolean" }, "is_spf": { "type": "boolean" }, "is_dmarc": { "type": "boolean" }, "is_dkim": { "type": "boolean" }, "is_mx": { "type": "boolean" }, "is_bimi": { "type": "boolean" }, "created_at": { "type": "string" }, "is_new": { "type": "boolean" } } }, "status": { "type": "string" }, "executionTime": { "type": "integer" } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "data": { "name": "dangerous-domain.com", "is_dangerous": true, "is_disposable": false, "is_forwarding": false, "is_spf": false, "is_dmarc": false, "is_dkim": false, "is_mx": false, "is_bimi": false, "created_at": "2025-02-05", "is_new": true }, "status": "success", "executionTime": 0 } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } } } }, "/scoring/email": { "get": { "operationId": "email", "summary": "Email Scoring", "tags": [ "Scoring" ], "description": "Counts as one request against your plan quota (free in test mode).", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" }, { "name": "email", "in": "query", "required": true, "description": "The email command is used to specify the email you want to validate. Expected values: an email address Sample value: `name@domain.com`", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "score": { "type": "integer" }, "reason": { "type": "string" }, "isValid": { "type": "boolean" }, "isFree": { "type": "boolean" }, "isRoleBased": { "type": "boolean" }, "isEducational": { "type": "boolean" }, "isDisposable": { "type": "boolean" }, "blacklisted": { "type": "boolean" }, "email": { "type": "string" }, "domain": { "type": "object", "properties": { "name": { "type": "string" }, "is_dangerous": { "type": "boolean" }, "is_spf": { "type": "boolean" }, "is_dmarc": { "type": "boolean" }, "is_dkim": { "type": "boolean" }, "is_mx": { "type": "boolean" }, "is_bimi": { "type": "boolean" }, "created_at": { "type": "string" }, "is_new": { "type": "boolean" } } }, "custom_rules_applied": { "type": "object", "properties": { "total": { "type": "integer" }, "rules": { "type": "array", "items": {} } } }, "suggestion": { "type": [ "string", "null" ] }, "isGibberish": { "type": "boolean" }, "normalized": { "type": "string" } } }, "status": { "type": "string" }, "executionTime": { "type": "integer" } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "data": { "score": 3, "reason": "Email domain is considered dangerous.", "isValid": false, "isFree": false, "isRoleBased": true, "isEducational": false, "isDisposable": false, "blacklisted": false, "email": "test@dangerous-domain.com", "domain": { "name": "dangerous-domain.com", "is_dangerous": true, "is_spf": false, "is_dmarc": false, "is_dkim": false, "is_mx": false, "is_bimi": false, "created_at": "2025-02-05", "is_new": true }, "custom_rules_applied": { "total": 0, "rules": [] }, "suggestion": null, "isGibberish": false, "normalized": "test@dangerous-domain.com" }, "status": "success", "executionTime": 1 } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } } } }, "/scoring/phone": { "get": { "operationId": "phone", "summary": "Phone Validation", "tags": [ "Scoring" ], "description": "Counts as one request against your plan quota (free in test mode).", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" }, { "name": "phone", "in": "query", "required": true, "description": "The phone command is used to specify the phone number you want to validate. Expected values: a phone number Sample value: `+12121234567`, `0012121234567`, `12121234567`, or `2121234567`", "schema": { "type": "string" } }, { "name": "countryCode", "in": "query", "required": true, "description": "The `ISO 3166-1 alpha-2` format of the country code of the phone number. [Learn more](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Sample value: `US`", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "carrier": { "type": "string" }, "reason": { "type": "string" }, "isValid": { "type": "boolean" }, "blacklisted": { "type": "boolean" }, "disposable": { "type": "boolean" }, "phone": { "type": "string" }, "countryCode": { "type": "string" }, "custom_rules_applied": { "type": "object", "properties": { "total": { "type": "integer" }, "rules": { "type": "array", "items": {} } } } } }, "status": { "type": "string" }, "executionTime": { "type": "integer" } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "data": { "carrier": "", "reason": "Invalid phone number structure.", "isValid": false, "blacklisted": false, "disposable": false, "phone": "+12121234567", "countryCode": "US", "custom_rules_applied": { "total": 0, "rules": [] } }, "status": "success", "executionTime": 1 } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } } } }, "/scoring/profanity": { "get": { "operationId": "profanity", "summary": "Profanity Detection", "tags": [ "Scoring" ], "description": "Counts as one request against your plan quota (free in test mode).", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" }, { "name": "text", "in": "query", "required": true, "description": "The text you want to filter Sample value: `This is a sample text without profanity!`", "schema": { "type": "string" } }, { "name": "scoreOnly", "in": "query", "required": false, "description": "Returns only the score of the text and whether it's safe or not. Expected values: `yes`, or `no`.", "schema": { "type": "string", "default": "no" } }, { "name": "listBadWords", "in": "query", "required": false, "description": "Used to list the bad words in an array. Expected values: `yes`, or `no`.", "schema": { "type": "string", "default": "no" } } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "isML": { "type": "boolean" }, "text": { "type": "string" }, "totalBadWords": { "type": [ "string", "null" ] }, "riskScore": { "type": "integer" }, "isSafe": { "type": "boolean" }, "status": { "type": "string" }, "executionTime": { "type": "integer" } } } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "data": { "isML": true, "text": "This is just a normal text", "totalBadWords": null, "riskScore": 0, "isSafe": true, "status": "success", "executionTime": 120 } } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } } } }, "/scoring/payment": { "post": { "operationId": "payment", "summary": "Payment Fraud Detection", "tags": [ "Scoring" ], "description": "Counts as one request against your plan quota (free in test mode).", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "score": { "type": "integer" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" } } } }, "rulesChecked": { "type": "integer" }, "rulesDetected": { "type": "integer" }, "custom_rules_applied": { "type": "object", "properties": { "total": { "type": "integer" }, "rules": { "type": "array", "items": {} } } } } }, "status": { "type": "string" }, "executionTime": { "type": "integer" } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "data": { "score": 82, "rules": [ { "id": "PF10003", "description": "Customer IP Address is probably VPN/Proxy/Bot/Hosting/Cloud." }, { "id": "PF10004", "description": "Customer Email Address is probably invalid or spam." }, { "id": "PF10001", "description": "High purchase rate, according to `customer_ip`." }, { "id": "PF10002", "description": "High purchase rate, according to `customer_id`." }, { "id": "PF10013", "description": "Customer device might not be a real device (according to `customer_useragent`)." }, { "id": "PF10014", "description": "Customer device is registered as a high-risk device (according to `customer_useragent`)." } ], "rulesChecked": 21, "rulesDetected": 6, "custom_rules_applied": { "total": 0, "rules": [] } }, "status": "success", "executionTime": 5 } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "description": "The transaction.", "properties": { "action": { "type": "string", "description": "The action your customer try to implement. Accepts: `purchase`, `deposit`, or `withdrawal`." }, "website_domain": { "type": "string", "description": "The domain name of the website the customer trying to purchase from. Sample value: `domain.com`" }, "website_name": { "type": "string", "description": "The name of the website the customer trying to purchase from. Sample value: `Nike Store, California`" }, "merchant_id": { "type": [ "string", "integer" ], "description": "If your a service provider with \"sub-websites\" (like Shopify), then provide a unique identification code indicating the website the customer trying to purchase from. Sample values: `12330098`, `01as-aowq-029jd`, or `abcdefg`." }, "shipment_id": { "type": [ "string", "integer", "number" ], "description": "The identification code of the shipment." }, "transaction_id": { "type": [ "string", "integer", "number" ], "description": "The identification code of the transaction in your system." }, "transaction_amount": { "type": [ "string", "number" ], "description": "The total amount of the transaction." }, "transaction_currency": { "type": "string", "description": "The currency in which the customer pay with. Sample value: `GBP`" }, "cart_items": { "type": [ "string", "integer", "number" ], "description": "" }, "isDigitalProducts": { "type": "boolean", "description": "Set this to true if the customer is purchasing a digital product." }, "coupon": { "type": "string", "description": "The promo code used by the customer to complete the checkout." }, "customer_id": { "type": [ "string", "integer" ], "description": "The identification number of the customer in your system." }, "customer_firstname": { "type": "string", "description": "The first name of the customer." }, "customer_lastname": { "type": "string", "description": "The last name of the customer (Family Name)." }, "customer_pob": { "type": "string", "description": "The Place of Birth of the customer." }, "customer_ip": { "type": "string", "description": "The IP address of the customer." }, "customer_country": { "type": "string", "description": "The `ISO 3166-1 alpha-2` code format of the country where the customer live. [Learn more](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)" }, "customer_region": { "type": "string", "description": "The name of the region where the customer live." }, "customer_city": { "type": "string", "description": "The name of the city where the customer live." }, "customer_zip": { "type": [ "string", "integer", "number" ], "description": "The name of the zip code of customer location." }, "customer_street": { "type": "string", "description": "The \"address line 1\" of the customer." }, "customer_street2": { "type": "string", "description": "The \"address line 2\" of the customer." }, "customer_latitude": { "type": [ "integer", "number" ], "description": "The customer latitude on the map (GPS Coordinates)." }, "customer_longitude": { "type": [ "integer", "number" ], "description": "The customer longitude on the map (GPS Coordinates)." }, "customer_device_id": { "type": [ "string", "integer", "number" ], "description": "The device identification code of the customer." }, "customer_phone": { "type": [ "string", "integer", "number" ], "description": "The phone number of the customer (international format)." }, "customer_registration_date": { "type": "integer", "description": "The registration date of the customer (UNIX Timestamp)." }, "customer_balance": { "type": [ "string", "integer", "number" ], "description": "If you offer a Wallet feature in your website, then pass the user balance to this pararmeter." }, "customer_dob": { "type": "string", "description": "The customer's date of birth. Sample value: '1985-12-27\\`" }, "customer_email": { "type": "string", "description": "The email address of the customer." }, "customer_2fa": { "type": "boolean", "description": "Set this to true if the customer has 2FA enabled in his/her account." }, "customer_useragent": { "type": "string", "description": "Pass the [User Agent](https://en.wikipedia.org/wiki/User_agent) of the customer to this parameter." }, "shipping_country": { "type": "string", "description": "The shipping country code of the customer (in `ISO 3166-1 alpha-2` format)." }, "shipping_region": { "type": "string", "description": "The shipping region name of the customer." }, "shipping_city": { "type": "string", "description": "The shipping city name of the customer." }, "shipping_zip": { "type": [ "string", "number", "integer" ], "description": "The zip code of the customer's shipping address." }, "shipping_street": { "type": "string", "description": "The shipping \"address 1\" of the customer." }, "shipping_street2": { "type": "string", "description": "The shipping \"address 2\" of the customer." }, "shipping_latitude": { "type": [ "integer", "number" ], "description": "The latitude of the customer's shipping address (GPS Coordinates)." }, "shipping_longitude": { "type": [ "integer", "number" ], "description": "The longitude of the customer's shipping address (GPS Coordinates)." }, "billing_country": { "type": "string", "description": "The billing country code of the customer (in `ISO 3166-1 alpha-2` format)." }, "billing_region": { "type": "string", "description": "The billing region name of the customer." }, "billing_city": { "type": "string", "description": "The billing city name of the customer." }, "billing_zip": { "type": [ "string", "number", "integer" ], "description": "The zip code of the customer's billing address." }, "billing_street": { "type": "string", "description": "The billing \"address 1\" of the customer." }, "billing_street2": { "type": "string", "description": "The billing \"address 2\" of the customer." }, "billing_latitude": { "type": [ "integer", "number" ], "description": "The latitude of the customer's billing address (GPS Coordinates)." }, "billing_longitude": { "type": [ "integer", "number" ], "description": "The longitude of the customer's billing address (GPS Coordinates)." }, "payment_type": { "type": "string", "description": "The payment method used to complete this transaction. Accepted values: `cards`, `cards_mada`, `applepay`, `stcpay`, `bank`, `crypto`, `wallet`, or `cod`." }, "card_name": { "type": "string", "description": "The name on the card (Cardholder Name)." }, "card_number": { "type": [ "string", "number", "integer" ], "description": "The card number (min: 6 digits)." }, "card_expiry": { "type": "string", "description": "The expiry date of the customer debit/credit card. Sample value: 29/05" }, "cvv_result": { "type": "boolean", "description": "Set this to true if the customer passed the CVV/CSV verification process." } } } } }, "example": { "data": { "action": "purchase", "transaction_amount": 149.99, "transaction_currency": "USD", "customer_ip": "203.0.113.42", "customer_email": "user@example.com" } } } } } } }, "/account/users/delete": { "delete": { "operationId": "userDelete", "summary": "User Data Deletion", "tags": [ "Account" ], "description": "Not counted against your quota.", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "transaction_data": { "type": "integer" }, "ips": { "type": "integer" }, "profanity_data": { "type": "integer" }, "emails": { "type": "integer" }, "phone_numbers": { "type": "integer" }, "ibans": { "type": "integer" } } }, "status": { "type": "string" } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "data": { "transaction_data": 25, "ips": 4, "profanity_data": 3, "emails": 1, "phone_numbers": 1, "ibans": 10 }, "status": "success" } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } }, "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string", "description": "Email address, phone number or user ID whose data should be deleted." } } } } } } } }, "/feedback/payment": { "post": { "operationId": "feedbackPayment", "summary": "Payment Outcome Feedback", "tags": [ "Feedback" ], "description": "Not counted against your quota.", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "transaction_id": { "type": "string" }, "outcome": { "type": "string" }, "status": { "type": "string" }, "matched": { "type": "integer" }, "label": { "type": "string" } } }, "status": { "type": "string" }, "executionTime": { "type": "integer" } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "data": { "transaction_id": "ORD-10492", "outcome": "chargeback", "status": "applied", "matched": 1, "label": "created" }, "status": "success", "executionTime": 4 } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "transaction_id", "outcome" ], "properties": { "transaction_id": { "type": "string", "description": "The `transaction_id` you sent to [Payment Fraud Detection](/docs/api-reference/payment) (your order or payment id)." }, "outcome": { "type": "string", "description": "What really happened: `approved`, `declined`, `chargeback`, `refunded`, `fraud_confirmed` or `legit_confirmed`." }, "reason": { "type": "string", "description": "Free text, e.g. the gateway decline code or the chargeback reason. A `declined` outcome whose reason mentions fraud (for example `fraud`, `stolen_card`, `suspected_fraud`) counts as fraud for learning." }, "occurred_at": { "type": [ "string", "integer" ], "description": "When the outcome happened: ISO-8601 date or UNIX timestamp. Defaults to now." }, "customer_id": { "type": "string", "description": "Optional. The customer of this payment, for transactions that were never scored by Gurdx (historical backfill)." }, "customer_email": { "type": "string", "description": "Optional, as above." }, "customer_phone": { "type": "string", "description": "Optional, as above." }, "customer_ip": { "type": "string", "description": "Optional, as above." }, "customer_device_id": { "type": "string", "description": "Optional, as above." } } }, "example": { "transaction_id": "ORD-10492", "outcome": "chargeback", "reason": "fraudulent", "occurred_at": "2026-10-20T14:05:00Z" } } } } } }, "/feedback/event": { "post": { "operationId": "feedbackEvent", "summary": "Fraud Label Feedback", "tags": [ "Feedback" ], "description": "Not counted against your quota.", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" }, "label": { "type": "string" }, "status": { "type": "string" } } }, "status": { "type": "string" }, "executionTime": { "type": "integer" } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "data": { "type": "email", "value": "b***@example.com", "label": "fraud", "status": "created" }, "status": "success", "executionTime": 3 } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "label" ], "properties": { "type": { "type": "string", "description": "What you are labelling: `ip`, `email`, `email_domain`, `phone`, `card_bin`, `customer_id`, `device_id` or `text`. Required unless you send `event_id`." }, "value": { "type": "string", "description": "The IP, email, phone number, BIN, id or text. Required with `type`." }, "event_id": { "type": "integer", "description": "Instead of `type` + `value`: the id of a dashboard event (sent as `event_id` in webhooks). `fraud` marks it a true positive, `legit` a false positive." }, "label": { "type": "string", "description": "`fraud` or `legit`." }, "reason": { "type": "string", "description": "Free text kept with the label." }, "source": { "type": "string", "description": "Who decided, e.g. `support`, `risk_team`, `chargeback_portal`." }, "occurred_at": { "type": [ "string", "integer" ], "description": "When it was decided: ISO-8601 date or UNIX timestamp. Defaults to now." } } }, "example": { "type": "email", "value": "buyer@example.com", "label": "fraud", "reason": "stolen card confirmed by issuer", "source": "risk_team" } } } } } }, "/feedback/bulk": { "post": { "operationId": "feedbackBulk", "summary": "Bulk Feedback", "tags": [ "Feedback" ], "description": "Not counted against your quota.", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "received": { "type": "integer" }, "created": { "type": "integer" }, "updated": { "type": "integer" }, "unchanged": { "type": "integer" }, "pending": { "type": "integer" }, "failed": { "type": "integer" }, "results": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer" }, "kind": { "type": "string" }, "transaction_id": { "type": "string" }, "outcome": { "type": "string" }, "status": { "type": "string" }, "matched": { "type": "integer" }, "label": { "type": "string" } } } } } }, "status": { "type": "string" }, "executionTime": { "type": "integer" } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "data": { "received": 3, "created": 2, "updated": 0, "unchanged": 1, "pending": 1, "failed": 0, "results": [ { "index": 0, "kind": "payment", "transaction_id": "ORD-10492", "outcome": "approved", "status": "applied", "matched": 1, "label": "created" }, { "index": 1, "kind": "payment", "transaction_id": "ORD-9921", "outcome": "chargeback", "status": "pending", "matched": 0, "label": "created" }, { "index": 2, "kind": "event", "type": "ip", "value": "203.0.*.*", "label": "fraud", "status": "unchanged" } ] }, "status": "success", "executionTime": 21 } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "Up to 1,000 feedback objects. Each has `kind`: `payment` (fields of [Payment Outcome Feedback](/docs/api-reference/feedback-payment)) or `event` (fields of [Fraud Label Feedback](/docs/api-reference/feedback-event)). When `kind` is missing it is `payment` if the item has `transaction_id` or `outcome`.", "items": { "type": "object" }, "maxItems": 1000 } } }, "example": { "items": [ { "kind": "payment", "transaction_id": "ORD-10492", "outcome": "approved" }, { "kind": "payment", "transaction_id": "ORD-9921", "outcome": "chargeback", "reason": "fraudulent" }, { "kind": "event", "type": "ip", "value": "203.0.113.42", "label": "fraud" } ] } } } } } }, "/ip": { "get": { "operationId": "freeIp", "summary": "Free Get-IP", "tags": [ "Data lookup" ], "description": "Not counted against your quota.", "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/lang" }, { "$ref": "#/components/parameters/mode" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/callback" } ], "responses": { "200": { "description": "Success — or an error object: Gurdx delivers errors with HTTP 200.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "ip": { "type": "string" }, "ipType": { "type": "string" } } }, "status": { "type": "string" }, "executionTime": { "type": "integer" } }, "required": [ "data", "status" ] }, { "$ref": "#/components/schemas/Error" } ] }, "examples": { "success": { "value": { "data": { "ip": "203.0.113.42", "ipType": "IPv4" }, "status": "success", "executionTime": 0 } }, "error": { "value": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } } } } }, "security": [] } } }, "components": { "securitySchemes": { "ApiKeyQuery": { "type": "apiKey", "in": "query", "name": "key", "description": "Your gx_live_… or gx_test_… key." }, "BearerAuth": { "type": "http", "scheme": "bearer", "description": "Authorization: Bearer " } }, "parameters": { "format": { "name": "format", "in": "query", "description": "Response format.", "schema": { "type": "string", "enum": [ "JSON", "XML", "CSV", "Newline" ], "default": "JSON" } }, "lang": { "name": "lang", "in": "query", "description": "Language of localised fields.", "schema": { "type": "string", "enum": [ "EN", "AR", "FR", "DE", "ES", "JA", "ZH", "RU" ], "default": "EN" } }, "mode": { "name": "mode", "in": "query", "description": "Use `test` for fake data that never consumes quota.", "schema": { "type": "string", "enum": [ "live", "test" ], "default": "live" } }, "userID": { "name": "userID", "in": "query", "description": "Your own identifier of the end user, to trace events.", "schema": { "type": "string" } }, "callback": { "name": "callback", "in": "query", "description": "JSONP callback function name (JSON format only).", "schema": { "type": "string" } } }, "schemas": { "Error": { "type": "object", "required": [ "status", "code", "type", "description" ], "properties": { "status": { "type": "string", "const": "error" }, "code": { "type": "integer", "enum": [ 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132 ] }, "type": { "type": "string", "enum": [ "invalid_key", "inactive_user", "limit_reached", "invalid_params", "plan_expired", "flood_detected", "invalid_callback_name", "invalid_format", "callback_not_allowed", "invalid_language", "invalid_mode", "invalid_ip", "domain_not_whitelisted", "security_module_not_allowed", "generic_error", "invalid_country_code", "feature_not_available", "invalid_phone_number", "invalid_email_address", "invalid_bin_number", "invalid_asn", "invalid_iban", "invalid_userid", "invalid_user_type", "invalid_user_value", "too_many_deletions", "subscription_required", "invalid_domain", "invalid_text", "invalid_payment_data", "invalid_feedback", "too_many_feedback_items" ] }, "description": { "type": "string" } }, "example": { "status": "error", "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." } } } }, "x-error-codes": [ { "code": 101, "type": "invalid_key", "description": "The API Key is missing or invalid." }, { "code": 102, "type": "inactive_user", "description": "The API Key owner (the account) is inactive right now. Please contact the support team for more information." }, { "code": 103, "type": "limit_reached", "description": "You reached the usage limit of your account. Please upgrade your subscription or pay any unpaid invoices." }, { "code": 104, "type": "invalid_params", "description": "Please check out the params parameter's value." }, { "code": 105, "type": "plan_expired", "description": "Your plan has expired. Renew the subscription to enable using the API." }, { "code": 106, "type": "flood_detected", "description": "Our system has detected too many requests at the same time. Kindly please try to slow down." }, { "code": 107, "type": "invalid_callback_name", "description": "The value of the callback parameter cannot be a function name." }, { "code": 108, "type": "invalid_format", "description": "The value of the format parameter is not a valid format. Use JSON, XML, CSV or Newline." }, { "code": 109, "type": "callback_not_allowed", "description": "You can use the callback feature only with the JSON format." }, { "code": 110, "type": "invalid_language", "description": "The value of the lang parameter is not a valid format. Use EN, AR, FR, DE, ES, JA, ZH or RU." }, { "code": 111, "type": "invalid_mode", "description": "The value of the mode parameter is not a valid format. Use test or live." }, { "code": 112, "type": "invalid_ip", "description": "The IP Address is not valid or empty." }, { "code": 113, "type": "domain_not_whitelisted", "description": "You are sending the request from a host that is not in the authorized hosts of your account." }, { "code": 114, "type": "security_module_not_allowed", "description": "You cannot use the security module in your plan. Please upgrade your API plan to unlock this feature." }, { "code": 115, "type": "generic_error", "description": "An error occurred while processing your request. Please try again later." }, { "code": 116, "type": "invalid_country_code", "description": "The Country Code is invalid or not found." }, { "code": 117, "type": "feature_not_available", "description": "This feature is not available for your plan, please upgrade your plan first." }, { "code": 118, "type": "invalid_phone_number", "description": "The Phone Number is invalid or missing." }, { "code": 119, "type": "invalid_email_address", "description": "The Email Address is invalid or missing." }, { "code": 120, "type": "invalid_bin_number", "description": "The BIN number is invalid or missing." }, { "code": 121, "type": "invalid_asn", "description": "The AS Number you provided is empty or invalid." }, { "code": 122, "type": "invalid_iban", "description": "The IBAN is invalid or missing." }, { "code": 123, "type": "invalid_userid", "description": "The user identifier is invalid or too long." }, { "code": 124, "type": "invalid_user_type", "description": "The user type is invalid or missing. Use email, phone or user_id." }, { "code": 125, "type": "invalid_user_value", "description": "The user value is invalid or missing (value parameter)." }, { "code": 126, "type": "too_many_deletions", "description": "You have reached the limit of deletions for this day. Please wait until the next day to delete more user data." }, { "code": 127, "type": "subscription_required", "description": "A paid subscription or an active trial is required to use this API. Subscribe from your dashboard." }, { "code": 128, "type": "invalid_domain", "description": "The domain name is invalid or missing." }, { "code": 129, "type": "invalid_text", "description": "The text is missing or too long (max 10,000 characters)." }, { "code": 130, "type": "invalid_payment_data", "description": "The data object is missing or invalid." }, { "code": 131, "type": "invalid_feedback", "description": "The feedback is missing or invalid." }, { "code": 132, "type": "too_many_feedback_items", "description": "Send at most 1,000 feedback items per request." } ] }