Retrieve Fraud Check request

GET

/fraud-checks/{id}

Returns the data of a specific Fraud Check request

Authorizations

token

Code Samples

#!/usr/bin/env bash
curl https://api.lox24.eu/fraud-checks/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee \
  -H 'Content-Type: application/json' \
  -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'

using Newtonsoft.Json.Linq;
using System;
using System.IO;
using System.Net;
using System.Text;

namespace Lox24.Api
{
    class client
    {
        static void Main()
        {
            string key = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx";

            var id = "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee";
            string url = "https://api.lox24.eu/fraud-checks/" + id;

            var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);
            httpWebRequest.ReadWriteTimeout = 100000;
            httpWebRequest.Accept = "application/json"; //or application/ld+json
            httpWebRequest.Method = "GET";
            httpWebRequest.KeepAlive = true;
            httpWebRequest.Headers.Add("X-LOX24-AUTH-TOKEN", key);
            httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;

            try
            {
                using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())
                {
                    int respCode = (int)resp.StatusCode;
                    Console.WriteLine("Success:{0} {1}", respCode, "item resource response");

                    Stream respStream = resp.GetResponseStream();
                    using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))
                    {
                        string responseText = sr.ReadToEnd();
                        Console.WriteLine("responseText : {0}", responseText);
                    }
                }
            }
            catch (System.Net.WebException ex)
            {
                var webResponse = ex.Response as System.Net.HttpWebResponse;
                Console.WriteLine("Error:{0}", webResponse.StatusCode);

                switch (webResponse.StatusCode)
                {
                    case HttpStatusCode.Unauthorized: // 401
                        Console.WriteLine("Error:401 Client ID or API key isn't active or invalid!");
                        break;
                    case HttpStatusCode.Forbidden: // 403
                        Console.WriteLine("Error:403 Account isn't activated. Please wait or contact to support!");
                        break;
                    case HttpStatusCode.NotFound: // 404
                        Console.WriteLine("Error:404 Resource not found");
                        break;
                    case HttpStatusCode.InternalServerError: // 500
                    case HttpStatusCode.BadGateway: //502
                    case HttpStatusCode.ServiceUnavailable: // 503
                    case HttpStatusCode.GatewayTimeout: // 504
                        Console.WriteLine("System error! Please contact to LOX24 support!");
                        break;
                }
            }
        }
    }

package main

import (
  "fmt"
  "io/ioutil"
  "log"
  "net/http"
)

func main() {

  const Method = "GET"
  const URL = "https://api.lox24.eu/fraud-checks/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
  const Token = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx"

  client := &http.Client{}

  req, err := http.NewRequest(Method, URL, nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Add("X-LOX24-AUTH-TOKEN", Token)
  req.Header.Add("Accept", "application/json")

  res, err := client.Do(req)
  if err != nil {
    log.Fatal(err)
  }

  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    log.Fatal(err)
  }

  switch res.StatusCode {
  case 200:
    fmt.Println((string(body)))
  case 401:
    fmt.Println("Error: code = 401 - Client ID or API key isn't active or invalid!")
  case 403:
    fmt.Println("Error: code = 403 - Account isn't activated. Please wait or contact to support!")
  case 404:
    fmt.Println("Error: code = 404 - Resource not found")
  default:
    fmt.Printf("Error: code = %d\n", res.StatusCode)
  }
}

package eu.lox24.doc.fraud_checks;

import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;

public class GetBulksItem {

    public static void main(String[] args) {

        var key = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx";
        var id = "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee";

        var url = "https://api.lox24.eu/fraud-checks/" + id;

        var httpRequest = HttpRequest.newBuilder(URI.create(url))
                .timeout(Duration.ofMillis(100000))
                .setHeader("Accept", "application/json") // or application/ld+json
                .setHeader("X-LOX24-AUTH-TOKEN", key)
                .GET()
                .build();

        var client = HttpClient.newBuilder()
                .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default
                .build();

        try {
            var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());

            if (httpResponse.statusCode() == HttpURLConnection.HTTP_OK) {
                System.out.println("Success:" + httpResponse.statusCode());
                System.out.println("Response text : \n" + httpResponse.body());

            } else {

                System.out.println("Error: wrong response code " + httpResponse.statusCode());
                System.out.println("Response text : \n" + httpResponse.body());

                switch (httpResponse.statusCode()) {

                    case HttpURLConnection.HTTP_UNAUTHORIZED: // 401
                        System.out.println("Error:401 Client ID or API key isn't active or invalid!");
                        break;
                    case HttpURLConnection.HTTP_FORBIDDEN: // 403
                        System.out.println("Error:403 Account isn't activated. Please wait or contact to support!");
                        break;
                    case HttpURLConnection.HTTP_NOT_FOUND: // 404
                        System.out.println("Error:404 Resource not found");
                        break;
                    case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500
                    case HttpURLConnection.HTTP_BAD_GATEWAY: //502
                    case HttpURLConnection.HTTP_UNAVAILABLE: // 503
                    case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504
                        System.out.println("System error! Please contact to LOX24 support!");
                        break;
                }

            }

        } catch (IOException | InterruptedException e) {
            e.printStackTrace();
        }
    }
}

const host = 'api.lox24.eu';
const token = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx";

const id = 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee';

const https = require('https');
const options = {
    hostname: host,
    path: '/fraud-checks/' + id,
    method: 'GET',
    headers: {
        'Accept': 'application/json',
        'X-LOX24-AUTH-TOKEN': token
    }
}

const req = https.request(options, res => {
    if (res.statusCode == 200) {
        console.log('Success: code = 200');
        res.on('data', d => { process.stdout.write(d) })
    } else if (res.statusCode == 401) {
        console.log("Error: code = 401 - Client ID or API key isn't active or invalid!");
    } else if (res.statusCode == 403) {
        console.log("Error: code = 403 - Account isn't activated. Please wait or contact to support!");
    } else if (res.statusCode == 404) {
        console.log("Error: code = 404 - Resource not found");
    } else {
        console.log("Error: code = " + res.statusCode );
    }

})

req.on('error', error => {
    console.error(error)
})

req.end();

<?php

$token = '1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx';

$id = '11111111-2222-3333-4444-55555555555';
$uri = 'https://api.lox24.eu/fraud-checks/' . $id;

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => $uri,
    CURLOPT_HTTPHEADER => [
        "X-LOX24-AUTH-TOKEN: $token",
        'Accept: application/json', // or application/ld+json
    ],
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 20,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
]);

$response = curl_exec($curl);
$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

$data = json_decode($response, JSON_OBJECT_AS_ARRAY);

if(200 === $code) {
    echo 'Success: response data = ' . var_export($data, true);
} elseif(404 === $code) {
    echo "Request with id = $id not found!";
} else {
    echo "Error: code = $code, data = " . var_export($data, true);
}

import json
import requests


token = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx"
sms_id = "11111111-2222-3333-4444-55555555555"

url = f'https://api.lox24.eu/fraud-checks/{sms_id}'


headers = {
    'Accept': 'application/json', # or application/ld+json
    'X-LOX24-AUTH-TOKEN': token,
}

try:
    # timeout is 100 seconds
    res = requests.get(url, headers=headers, timeout=100)
    if res.status_code != 200:
        res.raise_for_status()
    else:
        print(f'Success: code = {res.status_code} - Fraud request resource response')
        print("Response: ", json.dumps(res.json(), indent=4))

except requests.HTTPError:
    if res.status_code == 401:
        print("Error: code = 401 - Client ID or API key isn't active or invalid!")
    elif res.status_code == 403:
        print("Error: code = 403 - Account isn't activated. Please wait or contact to support!")
    elif res.status_code == 404:
        print("Error:404 Resource not found")
    elif res.status_code in (500, 502, 503, 504):
        print("System error! Please contact to LOX24 support!")
    else:
        print(f"Error: code {res.status_code}")
    print(json.dumps(res.json(), indent=4))

Parameters

Path Parameters

required

Unique entity UUID

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

Fraud Check request ID

Responses

200

Fraud-check resource

Fraud check request

object

@id

JSON-LD ID

string

@type

JSON-LD type

string

@context

One of:

string
object

string

Unique entity UUID

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

status_code

Request processing status codes:

0 – new request and not processed yet
5 – request’s processing in progress
10 – request’s processing completed successfully
20 - request’s processing completed with error: not enough credits
21 - request’s processing completed with error: invalid data
1000 - request’s processing completed with error: unexpected error

integer

Allowed values: 0 5 10 20 21 1000

risk_score

Fraud risk score from 0 (good) to 100 (bad)

number

<= 100

service_code

required

Service code defines the type of fraud query you make. Economy contains only a risk value, while Pro and Direct contain more details about the results, so you can make your own decision. Direct queries are also processed with priority. (see /me)

string

Allowed values: economy pro direct

created_at

Timestamp when the entity was added to the system by the user

integer

updated_at

Timestamp when the entity was changed

integer

callback_data

Any of:

string | null
null

String which will be send back to your endpoint. E.g. it can be usable to pass your system message id.

string | null

<= 36 characters

request_phone

Any of:

object
null

Fraud check request phone number

object

@id

JSON-LD ID

string

@type

JSON-LD type

string

@context

One of:

string
object

string

status_code

Request processing status codes:

0 – new request and not processed yet
5 – request’s processing in progress
10 – request’s processing completed successfully
20 - request’s processing completed with error: not enough credits
21 - request’s processing completed with error: invalid data
1000 - request’s processing completed with error: unexpected error

integer

Allowed values: 0 5 10 20 21 1000

phone

required

Recipient (international) number:

+491701234567 (E.164)
00491701234567
491701234567
01701234567 (if the account is registered in Germany) will be convert to +491701234567

If the number is not in an E.164 format then the service will convert it based on user’s address. To avoid problems with the converting please use E.164 preferentially.

string

>= 4 characters <= 16 characters /^\+[1-9]\d{1,14}$/

Example

+14155552671

created_at

Timestamp when the entity was added to the system by the user

integer

updated_at

Timestamp when the entity was changed

integer

is_possible

Is phone number possible

boolean

is_valid

Is phone number valid

boolean

region

Country code

string

>= 2 characters <= 2 characters /^[A-Z]{2}$/

number_type

Phone number type

string

request_email

Any of:

object
null

Fraud check request email

object

@id

JSON-LD ID

string

@type

JSON-LD type

string

@context

One of:

string
object

string

status_code

Request processing status codes:

0 – new request and not processed yet
5 – request’s processing in progress
10 – request’s processing completed successfully
20 - request’s processing completed with error: not enough credits
21 - request’s processing completed with error: invalid data
1000 - request’s processing completed with error: unexpected error

integer

Allowed values: 0 5 10 20 21 1000

email

required

An email address sent to check

More information

string format: email

>= 6 characters <= 500 characters

created_at

Timestamp when the entity was added to the system by the user

integer

updated_at

Timestamp when the entity was changed

integer

is_possible

Is this email possible or not

boolean

is_anonymous

Is the service used to anonymize the sender of the email

boolean

request_ip

Any of:

object
null

Fraud check request IP address

object

@id

JSON-LD ID

string

@type

JSON-LD type

string

@context

One of:

string
object

string

status_code

Request processing status codes:

0 – new request and not processed yet
5 – request’s processing in progress
10 – request’s processing completed successfully
20 - request’s processing completed with error: not enough credits
21 - request’s processing completed with error: invalid data
1000 - request’s processing completed with error: unexpected error

integer

Allowed values: 0 5 10 20 21 1000

required

IP address (IP v4/v6)

string

>= 7 characters <= 39 characters

created_at

Timestamp when the entity was added to the system by the user

integer

updated_at

Timestamp when the entity was changed

integer

iso2

Country code

string

>= 2 characters <= 2 characters /^[A-Z]{2}$/

state

Country code

string

>= 2 characters <= 2 characters /^[A-Z]{2}$/

city

The city name of the IP address

string

postcode

The zip or post code of the IP address

string

geolocation

The latitude,longitude of the IP address (array)

Array<number>

isp_name

The name of the ISP

string

isp_risk_score

Risk score for the ISP

number

<= 100

proxy_type

If host is proxy:

VPN – Anonymizing VPN services. These services offer users a publicly accessible VPN for the purpose of hiding their IP address.
TOR – Tor Exit Nodes. The Tor Project is an open network used by those who wish to maintain anonymity.
DCH – Hosting Provider, Data Centre or Content Delivery Network. Since hosting providers and data centres can serve to provide anonymity, the Anonymous IP database flags IP addresses associated with them.
PUB – Public Proxies. These are services which make connection requests on a user’s behalf. Proxy server software can be configured by the administrator to listen on some specified port. These differ from VPNs in that the proxies usually have limited functions compare to VPNs.
WEB – Web Proxies. These are web services which make web requests on a user’s behalf. These differ from VPNs or Public Proxies in that they are simple web-based proxies rather than operating at the IP address and other ports level.
SES – Search Engine Robots. These are services which perform crawling or scraping to a website, such as, the search engine spider or bots engine.

string

Allowed values: VPN TOR DCH PUB WEB SES

connection_type

The values can be one of either: “dialup”, “isdn”, “cable”, “dsl”, “fttx”, “wireless” or null

string | null

Allowed values: dialup isdn cable dsl fttx wireless

is_ok

Was the request handled correctly?

boolean

request_address

Any of:

object
null

Fraud check request address

object

@id

JSON-LD ID

string

@type

JSON-LD type

string

@context

One of:

string
object

string

status_code

The request status

integer | null

iso2

required

Country code

string

>= 2 characters <= 2 characters /^[A-Z]{2}$/

city

required

The city name of the address

string | null

>= 2 characters <= 100 characters

postcode

The zip or post code of the address

string | null

>= 3 characters <= 20 characters

street_number

The number of house

string | null

>= 1 characters <= 30 characters

street_name

required

The street name

string | null

>= 2 characters <= 255 characters

created_at

Timestamp when the entity was added to the system by the user

integer

updated_at

Timestamp when the entity was changed

integer

price

Price

number

Fraud check request

object

Unique entity UUID

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

status_code

Request processing status codes:

0 – new request and not processed yet
5 – request’s processing in progress
10 – request’s processing completed successfully
20 - request’s processing completed with error: not enough credits
21 - request’s processing completed with error: invalid data
1000 - request’s processing completed with error: unexpected error

integer

Allowed values: 0 5 10 20 21 1000

risk_score

Fraud risk score from 0 (good) to 100 (bad)

number

<= 100

service_code

required

string

Allowed values: economy pro direct

created_at

Timestamp when the entity was added to the system by the user

integer

updated_at

Timestamp when the entity was changed

integer

callback_data

Any of:

string | null
null

String which will be send back to your endpoint. E.g. it can be usable to pass your system message id.

string | null

<= 36 characters

request_phone

Any of:

object
null

Fraud check request phone number

object

status_code

Request processing status codes:

0 – new request and not processed yet
5 – request’s processing in progress
10 – request’s processing completed successfully
20 - request’s processing completed with error: not enough credits
21 - request’s processing completed with error: invalid data
1000 - request’s processing completed with error: unexpected error

integer

Allowed values: 0 5 10 20 21 1000

phone

required

Recipient (international) number:

+491701234567 (E.164)
00491701234567
491701234567
01701234567 (if the account is registered in Germany) will be convert to +491701234567

If the number is not in an E.164 format then the service will convert it based on user’s address. To avoid problems with the converting please use E.164 preferentially.

string

>= 4 characters <= 16 characters /^\+[1-9]\d{1,14}$/

Example

+14155552671

created_at

Timestamp when the entity was added to the system by the user

integer

updated_at

Timestamp when the entity was changed

integer

is_possible

Is phone number possible

boolean

is_valid

Is phone number valid

boolean

region

Country code

string

>= 2 characters <= 2 characters /^[A-Z]{2}$/

number_type

Phone number type

string

request_email

Any of:

object
null

Fraud check request email

object

status_code

Request processing status codes:

0 – new request and not processed yet
5 – request’s processing in progress
10 – request’s processing completed successfully
20 - request’s processing completed with error: not enough credits
21 - request’s processing completed with error: invalid data
1000 - request’s processing completed with error: unexpected error

integer

Allowed values: 0 5 10 20 21 1000

email

required

An email address sent to check

More information

string format: email

>= 6 characters <= 500 characters

created_at

Timestamp when the entity was added to the system by the user

integer

updated_at

Timestamp when the entity was changed

integer

is_possible

Is this email possible or not

boolean

is_anonymous

Is the service used to anonymize the sender of the email

boolean

request_ip

Any of:

object
null

Fraud check request IP address

object

status_code

Request processing status codes:

0 – new request and not processed yet
5 – request’s processing in progress
10 – request’s processing completed successfully
20 - request’s processing completed with error: not enough credits
21 - request’s processing completed with error: invalid data
1000 - request’s processing completed with error: unexpected error

integer

Allowed values: 0 5 10 20 21 1000

required

IP address (IP v4/v6)

string

>= 7 characters <= 39 characters

created_at

Timestamp when the entity was added to the system by the user

integer

updated_at

Timestamp when the entity was changed

integer

iso2

Country code

string

>= 2 characters <= 2 characters /^[A-Z]{2}$/

state

Country code

string

>= 2 characters <= 2 characters /^[A-Z]{2}$/

city

The city name of the IP address

string

postcode

The zip or post code of the IP address

string

geolocation

The latitude,longitude of the IP address (array)

Array<number>

isp_name

The name of the ISP

string

isp_risk_score

Risk score for the ISP

number

<= 100

proxy_type

If host is proxy:

VPN – Anonymizing VPN services. These services offer users a publicly accessible VPN for the purpose of hiding their IP address.
TOR – Tor Exit Nodes. The Tor Project is an open network used by those who wish to maintain anonymity.
DCH – Hosting Provider, Data Centre or Content Delivery Network. Since hosting providers and data centres can serve to provide anonymity, the Anonymous IP database flags IP addresses associated with them.
PUB – Public Proxies. These are services which make connection requests on a user’s behalf. Proxy server software can be configured by the administrator to listen on some specified port. These differ from VPNs in that the proxies usually have limited functions compare to VPNs.
WEB – Web Proxies. These are web services which make web requests on a user’s behalf. These differ from VPNs or Public Proxies in that they are simple web-based proxies rather than operating at the IP address and other ports level.
SES – Search Engine Robots. These are services which perform crawling or scraping to a website, such as, the search engine spider or bots engine.

string

Allowed values: VPN TOR DCH PUB WEB SES

connection_type

The values can be one of either: “dialup”, “isdn”, “cable”, “dsl”, “fttx”, “wireless” or null

string | null

Allowed values: dialup isdn cable dsl fttx wireless

is_ok

Was the request handled correctly?

boolean

request_address

Any of:

object
null

Fraud check request address

object

status_code

The request status

integer | null

iso2

required

Country code

string

>= 2 characters <= 2 characters /^[A-Z]{2}$/

city

required

The city name of the address

string | null

>= 2 characters <= 100 characters

postcode

The zip or post code of the address

string | null

>= 3 characters <= 20 characters

street_number

The number of house

string | null

>= 1 characters <= 30 characters

street_name

required

The street name

string | null

>= 2 characters <= 255 characters

created_at

Timestamp when the entity was added to the system by the user

integer

updated_at

Timestamp when the entity was changed

integer

price

Price

number

401

Client ID or API key isn’t active or invalid!

403

Account isn’t activated. Please wait or contact to support!

404

Resource not found

429

IP address was temporary blocked, because during short time from it was sent many request with invalid credentials. Please wait and try later.