API Reference > Endpoints > Lookup

Lookup

POST api.ravelin.com/v2/lookup

Show all definitions

timestamp integer required

The unix time in seconds that the event happened

email object optional

The email address associated with the identified fraud.

Show definition

address string required

The email address associated with the identified fraud.

verified boolean optional

If the email address has been verified (e.g. with a link sent to the email).

timestamp integer optional

When the email address was first seen (unix timestamp in UTC).

telephone object optional

The telephone number associated with the identified fraud.

Show definition

number string required

The telephone number in E.164 format.

countryCode string optional

An unambiguous ISO 3316-1 country-code, either 2- or 3-letter (e.g. 'GB' or 'GBR').

Pattern: ^[A-Z]{2,3}$

verified boolean optional

If the telephone number has been verified (e.g. with SMS-code confirmation).

timestamp integer optional

When the telephone number was first seen (unix timestamp in UTC).

ipAddress object optional

The IP address associated with the identified fraud.

Show definition

address string required

IP address in IPv4 or IPv6 formats. Local and Private IP ranges are not allowed (10.x.x.x, 100.64.x.x-100.127.x.x, 169.254.x.x, 172.16.x.x-172.31.x.x, 192.168.x.x, 192.18.x.x-192.19.x.x).

timestamp integer required

When the IP address was seen (unix timestamp in UTC).

paymentMethod object optional

The payment method associated with the identified fraud. Only one of instrumentId, payerId or bankId can be provided.

One of the following:

Show definition

instrumentId string optional

A unique identifier for the physical card, shared between users. Must not be a hash of the PAN

payerId string optional

PayPal payer ID.

bankAccountId string optional

A unique identifier for a bank account

timestamp integer optional

When the payment method was first seen (unix timestamp in UTC).

chargebacks array optional

Show definition

chargebackId string required

A unique identifier for the chargeback (often a "dispute ID").

gatewayReference string required

Your PSP/gateway's reference for the transaction which was disputed.

gateway string optional

The name of the PSP from which this chargeback originated.

customerId string optional

A unique identifier for the customer who submitted the order/transaction which has been disputed.

reason string optional

The reason code from the chargeback.

status string optional

The status of the dispute.

amount integer optional

The amount that is being disputed, in the lowest denomination of the currency (e.g. cents or pennies).

currency string optional

A three-letter currency code. Both lowercase and uppercase are accepted.

Pattern: ^[a-zA-Z]{3}$

disputeTime integer optional

The unix time in seconds that the dispute was opened.

custom object optional

Extra properties describing the chargeback.

manualReviews array optional

Show definition

reviewId string required

A unique identifier for the manual review

label string optional

The label applied in this review. The conclusion reached.

One of: UNREVIEWED, GENUINE, or FRAUDSTER.

comment string optional

Comment for the review

customerId string optional

A unique identifier for the customer if known

reviewer object optional

The person who decided these details belong to a fraudster.

Show definition

name string optional

Name of reviewer

email string optional

Email of review

timestamp integer optional

The unix time in seconds that the manual review took place

POST https://api.ravelin.com/v2/lookup HTTP/1.1
Authorization: token ...
Content-Type: application/json

{
  "timestamp": 1479231064,
  "email": {
    "address": "review@example.com",
    "verified": true,
    "timestamp": 1479231064
  },
  "telephone": {
    "number": "+442222222222",
    "countryCode": "GB",
    "verified": true,
    "timestamp": 1479231064
  },
  "ipAddress": {
    "address": "33.33.33.33",
    "timestamp": 1479231064
  },
  "paymentMethod": {
    "instrumentId": "ljkvel433-34t3g5-4334g3g",
    "timestamp": 1479231064
  },
  "chargebacks": [
    {
      "chargebackId": "dp_15RsQX2eZvKYlo2C0MFNUWJC",
      "gateway": "stripe",
      "gatewayReference": "tx_abc123",
      "customerId": "9307355",
      "reason": "general",
      "status": "lost",
      "amount": 195,
      "currency": "USD",
      "disputeTime": 1422915137
    }
  ],
  "manualReviews": [
    {
      "reviewId": "12345678",
      "comment": "Definitely a fraudster.",
      "customerId": "9307355",
      "reviewer": {
        "name": "tom@mycompany.com",
        "email": "Tom"
      },
      "timestamp": 1486387634000
    }
  ]
}

GET api.ravelin.com/v2/lookup

Query Parameters:

email
telephone
ipAddress
ipFromTime
instrumentId
limitIndustry

DELETE api.ravelin.com/v2/lookup

Query Parameters:

email
telephone
ipAddress

Feedback

Was this page helpful?