v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
VerifyRule

VerifyRule:Create

Mark certain data points as reliable (positive) or unreliable (negative) and our VERIFY module will take this into account in the decision making. If a merchant is supplied then you need to have access to that merchant. You need to authenticate with an AT-code as username and a token as password.

post/v2/verifyrules

Request body

merchantCodestring required

Example request

{
  "merchantCode": "M-1234-1234",
  "verifyRule": {
    "verifyRuleType": "email",
    "label": "fraud",
    "value": "robbert.vanderwerf@company.com",
    "score": -25,
    "expiresAt": "2024-03-25T07:48:00+02:00"
  }
}

Response

Created

codestring nullable

The RV-code for a Rule verify

verifyRuleTypestring nullable

The verify rule verifyRuleType

labelstring

The verify rule label.

valuestring

The verify rule value.

scoreinteger

The verify rule score.

expiresAtstring date-time nullable

The expiration date date time presented in the correct ISO-8601 (a.k.a. ATOM) notation

createdAtstring date-time nullable

The date and time at which this entity was created in ISO-8601 (ATOM) notation

createdBystring nullable

The reference to an account or token whom created the entity

modifiedAtstring date-time nullable

The date and time at which this entity was modified in ISO-8601 (ATOM) notation.

modifiedBystring nullable

The reference to an account or token whom modified this entity

deletedAtstring date-time nullable

The date and time at which this entity was deleted in ISO-8601 (ATOM) notation.

deletedBystring nullable

The reference to an account or token whom deleted the entity

Example response

{
  "code": "RV-1234-4321-1234",
  "verifyRuleType": "email",
  "label": "fraud",
  "value": "support@pay.nl",
  "score": -25,
  "merchant": {
    "code": "M-1234-4321",
    "status": "ACTIVE",
    "name": "GMS Demo Merchant"
  },
  "expiresAt": "2016-06-04T08:15:00+01:00",
  "createdAt": "2024-06-04T08:15:00+01:00",
  "createdBy": "A-1234-4321",
  "modifiedAt": "2024-06-04T08:15:00+01:00",
  "modifiedBy": "A-1234-4321",
  "deletedAt": "A-1234-4321",
  "deletedBy": "A-1234-4321"
}