PUT

/anti-fraud-services/{anti_fraud_service_id}

curl --request PUT \
  --url https://api.sandbox.{gr4vy_id}.gr4vy.app/anti-fraud-services/{anti_fraud_service_id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "anti_fraud_service_definition_id": "sift-anti-fraud"
}'
{
  "active": true,
  "anti_fraud_service_definition_id": "sift-anti-fraud",
  "created_at": "2013-07-16T19:23:00.000+00:00",
  "display_name": "Sift Anti-Fraud Service.",
  "fields": [
    {
      "key": "approve_decision",
      "value": "sk_test_26PHem9AhJZvU623DfE1x4sd"
    }
  ],
  "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
  "merchant_account_id": "default",
  "reviews_enabled": "boolean",
  "type": "anti-fraud-service",
  "updated_at": "2013-07-16T19:23:00.000+00:00"
}

This endpoint requires the anti-fraud-services.write scope.

Authorizations

Authorizationheaderrequired
string

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

Path Parameters

anti_fraud_service_idrequired
string

The unique ID for an anti-fraud service.

Body

application/json
active
Default: true
boolean

Defines if this service is currently active or not. There can only be one active service at any time. When updating a service to active, the current active service will be deactivated.

anti_fraud_service_definition_idrequired
enum<string>

The name of the Anti-Fraud service provider. During update request, this value is used for validation only but the underlying service can not be changed for an existing service.

Available options:
cybersource-anti-fraud,
forter-anti-fraud,
sift-anti-fraud
display_name
string

A unique name for this anti-fraud service which is used in the Gr4vy admin panel to give a anti-fraud Service a human readable name.

fields
object[]

A list of fields, each containing a key-value pair for each field defined by the definition for this anti-fraud service e.g. for Sift api_key must be sent within this field when creating the service.

For updates, only the fields sent here will be updated, existing ones will not be affected if not present.

reviews_enabled
Default: false
boolean

Defines if this service needs to handle the review status from anti-fraud responses with a proper review workflow. If not, the review status will be treated as any other one.

Response

200 - application/json
active
Default: true
boolean

Defines if this service is currently active or not.

anti_fraud_service_definition_id
enum<string>

The name of the Anti-Fraud service provider. During update request, this value is used for validation only but the underlying service can not be changed for an existing service.

Available options:
cybersource-anti-fraud,
forter-anti-fraud,
sift-anti-fraud
created_at
string

The date and time when this anti-fraud service was created in our system.

display_name
string | null

A unique name for this anti-fraud service which is used in the Gr4vy admin panel to give a anti-fraud service a human readable name.

fields
object[]

A list of fields, each containing a key-value pair for anti-fraud service decision mapping e.g. for Sift approve_decision will be in the response.

id
string

The unique Gr4vy ID for this anti-fraud service.

merchant_account_id
string

The unique ID for a merchant account.

reviews_enabled
Default: false
boolean

Defines if this service needs to handle the review status with a proper review workflow. If not, the review status will be treated as any other one.

type
enum<string>

The type of this resource. Is always anti-fraud-service.

Available options:
anti-fraud-service
updated_at
string

The date and time when this anti-fraud service was last updated in our system.