Docs / Getting started
Introduction
Gurdx is a fraud-prevention and user-intelligence API that scores IP addresses, emails, phone numbers, cards, IBANs and payments in a single JSON call.
What Gurdx does#
Gurdx helps you decide, in real time, whether a visitor or a transaction deserves your trust. You send a value (an IP address, an email, a BIN, a payment, a piece of text) and Gurdx answers with structured data and, where it makes sense, a risk score you can act on.
Every method shares the same paths convention, response envelope and numbered error codes, so one client works for the whole API. Start with the API reference.
Base URL#
All requests go to:
https://gurdx.cretip.com/api
Every endpoint is reachable over HTTPS only. See HTTPS.
Your first request#
Create an API key in the dashboard (https://gurdx.cretip.com/app), then call the IP geolocation endpoint:
curl "https://gurdx.cretip.com/api/geoip?key=YOUR_API_KEY"
When no ip parameter is given, Gurdx looks up the address the request came from. A successful response looks like this:
{
"data": {
"ip": "203.0.113.7",
"countryCode": "SA",
"countryName": "Saudi Arabia"
},
"status": "success",
"executionTime": 12
}
executionTime is the processing time in milliseconds.
Available endpoints#
| Method | Path | Plans |
|---|---|---|
| IP Geolocation | GET /geoip |
Free trial Standard Premium Pay-as-you-go |
| IP Lookup | GET /lookup/ip |
Free trial Standard Premium Pay-as-you-go |
| Bulk IP Lookup | GET /lookup/ip/bulk |
Free trial Standard Premium Pay-as-you-go |
| IP Reputation | GET /lookup/ip/threats |
Free trial Standard Premium Pay-as-you-go |
| ASN Lookup | GET /lookup/asn |
Free trial Premium Pay-as-you-go |
| BIN Lookup | GET /lookup/bin |
Free trial Standard Premium Pay-as-you-go |
| IBAN Lookup | GET /lookup/iban |
Free trial Premium Pay-as-you-go |
| Country Lookup | GET /lookup/country |
Free trial Standard Premium Pay-as-you-go |
| Domain Lookup | GET /lookup/domain |
Free trial Standard Premium Pay-as-you-go |
| Email Scoring | GET /scoring/email |
Free trial Premium Pay-as-you-go |
| Phone Validation | GET /scoring/phone |
Free trial Premium Pay-as-you-go |
| Profanity Detection | GET /scoring/profanity |
Free trial Standard Premium Pay-as-you-go |
| Payment Fraud Detection | POST /scoring/payment |
Free trial Premium Pay-as-you-go |
| User Data Deletion | DELETE /account/users/delete |
Free trial Standard Premium Pay-as-you-go |
| Payment Outcome Feedback | POST /feedback/payment |
Free trial Standard Premium Pay-as-you-go |
| Fraud Label Feedback | POST /feedback/event |
Free trial Standard Premium Pay-as-you-go |
| Bulk Feedback | POST /feedback/bulk |
Free trial Standard Premium Pay-as-you-go |
| Free Get-IP | GET /ip |
No key needed |
Each method has its own page in the API reference, for example IP Lookup and Payment Fraud Detection.
Response shape#
- Success:
{"data": {...}, "status": "success", "executionTime": 12}. - Failure:
{"status": "error", "code": 101, "type": "invalid_key", "description": "..."}.
Errors are returned with HTTP status 200. Always check the status field of the body instead of relying on the HTTP status. The full list is on Error codes.
Options common to every method#
| Parameter | Purpose |
|---|---|
key |
Your API key (or use a Bearer header). See Authentication. |
format |
JSON, XML, CSV or Newline. See Response format. |
lang |
Language of translated fields. See Localization. |
mode |
live or test. See Development environment. |
params |
Extra data modules. See Customize modules. |
userID |
Tag the request with your own user. See User identifier. |
callback |
JSONP callback. See JSONP callback. |
Where to go next#
- Authentication and API keys.
- Usage limits for your plan.
- Error codes and how to handle them.
Found a mistake? Tell us on the contact page. Contact