GET
/
anti-fraud-service-definitions
/
{anti_fraud_service_definition_id}
curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/anti-fraud-service-definitions/{anti_fraud_service_definition_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "sift-anti-fraud",
  "type": "anti-fraud-service-definition",
  "display_name": "Stripe",
  "fields": [
    {
      "key": "private_api_key",
      "display_name": "Private API key",
      "required": true,
      "format": "text",
      "secret": true
    }
  ],
  "icon_url": "https://cdn.gr4vy.app/stripe.svg"
}

This endpoint requires the anti-fraud-service-definition.read scope.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
anti_fraud_service_definition_id
string
required

The unique ID for an anti-fraud service definition.

Example:

"sif-ati-fraud"

Response

200
application/json
Returns an anti fraud service definition.

An available anti fraud service that can be configured.

​
id
string

The ID of the anti fraud service definition.

Example:

"sift-anti-fraud"

​
type
enum<string>
default:anti-fraud-service-definition

anti-fraud-service-definition.

Available options:
anti-fraud-service-definition
Example:

"anti-fraud-service-definition"

​
display_name
string

The display name of this service.

Example:

"Stripe"

​
fields
object[]

A list of fields that need to be submitted when activating the payment. service.

A single field that needs to be submitted for a payment service when it is created.

​
icon_url
string

An icon to display for the payment service.

Example:

"https://cdn.gr4vy.app/stripe.svg"

Was this page helpful?