Customer Label

The Customer Label endpoint allows you to review customers across multiple fraud categories, including Payment Fraud and Refund Abuse. This endpoint replaces the legacy v2/label endpoint, which has been deprecated.

See our Payment Fraud or Refund Abuse guides for more information on how to use manual reviews to prevent fraud.

Field Status Definitions
Required Required fields must be sent. If the data is not sent Ravelin will return an error.
Important Important fields are crucial for performance where that data is relevant for your business.
Optional Optional fields are additional data points that can be shared with Ravelin.
These fields are unlikely to impact performance but may be visible in the Ravelin dashboard.

POST api.ravelin.com/v2/customer/:customerid:/labels

Show all
category string required

The fraud category associated with this label.

One of: PAYMENT_FRAUD or REFUND_ABUSE.

review string required

The specific label to apply, based on the category selected.

• For category: PAYMENT_FRAUD , one of: FRAUDSTER, GENUINE, POTENTIALLY_FRAUDSTER, POTENTIALLY_GENUINE or UNREVIEWED.

Note: The "potential" labels (POTENTIALLY_FRAUDSTER and POTENTIALLY_GENUINE) are only available if Ravelin has enabled them for your account.

• For category: REFUND_ABUSE , one of: REFUND_ABUSE, NOT_REFUND_ABUSE or UNREVIEWED.

reviewer object optional

The individual who is reviewing the customer.

Their details will appear in the audit log and manual review details on the Ravelin dashboard so you are able to see who did this review.

Show definition
comment string optional

The reason for reviewing the customer with this label.

This will appear in the audit log on the dashboard so you are able to see why this customer was reviewed.

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

{
  "category": "PAYMENT_FRAUD",
  "review": "GENUINE",
  "comment": "This customer is a regular and has been using the service for over a year.",
  "reviewer": {
    "name": "Bilbo Baggins",
    "email": "bilbo.b@shiremail.com"
  }
}

Example response:

{
    "eventTime": "2020-01-23T16:33:02Z"
}

Feedback