API Reference

Every Gurdx API method, its inputs, its response and the rules that apply to every call.

Overview#

The Gurdx API is a set of HTTP methods for checking IP addresses, emails, phone numbers, cards, IBANs, domains, text and whole payments for fraud signals. Every method uses the same response envelope and the same numbered error codes.

All requests go to https://gurdx.cretip.com/api, for example https://gurdx.cretip.com/api/lookup/ip. Each method below documents its path, the plans that include it, its parameters and a runnable sample in four languages.

Conventions shared by every method#

• Authentication. Send your key as the key query parameter or as a Authorization: Bearer <key> header. Keys starting with gx_test_ are test keys.
• Common options. Every method accepts format (JSON, XML, CSV or Newline), lang, mode (live or test), callback (JSONP, JSON format only) and userID, a free-form identifier that ties a request to one of your users in the events log. Methods that return modules also accept params; see Customize modules.
• Success envelope. A successful call returns {"data": ..., "status": "success", "executionTime": <ms>}. The shape inside data is described on each method page.
• Errors come with HTTP 200. A failed call still answers with status 200 and a body of the form {"status": "error", "code": 119, "type": "invalid_email_address", "description": "..."}. Always check the status field, not only the HTTP code. Codes 101 to 127 are the core set; 128 (invalid_domain), 129 (invalid_text) and 130 (invalid_payment_data) are later additions.
• Test mode. With mode=test or a gx_test_ key you get realistic fake data, no quota is consumed, no events are raised and no external service is contacted. Use it while you build the integration.
• Billing. Each call counts as one request against your monthly quota, except User data deletion, which is free.

Order of checks#

Each request goes through the same pipeline: options are validated first, then the key, the account and subscription state, authorized hosts, whether your plan includes the method, flood protection and finally the quota. The first failure decides the error code you receive.

Rules, blacklists and events#

Methods that evaluate a subject can apply your custom rules and blacklists, and can raise events that you can receive through webhooks. The individual pages say which apply.

All methods#