Skip to main content

Person Risk Check

POST 

/compliance/person-risk-check

Risk management and fraud prevention are elementary functional areas and sub-processes for reducing risks in the processing of payments. There are two types of risk management and fraud prevention checks that we offer. They are:

  • Risk checks that are applied during sale order processing of products and/or services. These are risk checks that are offered as part of the ancillary services and is covered by this product and service description.
  • Risk checks that are applied during a payment processing for sale order is included as part of the payment services and is not covered by this product and service description.

Risk management and fraud prevention checks include:

  1. Blacklist checks
  2. Velocity checks
  3. Transaction limit checks
  4. Customer limit checks

The following section will describe the procedure and results of a person risk check and can be analogously applied to a company risk check (see API method Company Risk Check.

Call this API method and specify as much individual-related and order-related information as possible, e.g., customer name, address, list of order items, order value, etc.

Request

Header Parameters

    Content-Type stringrequired

    Must be application/json

    Accept-Language stringrequired

    Must be be en-US

    Origin stringrequired

    The origin of the request

    User-Agent stringrequired

    The client making the request

Body

required

    merchantAccno stringrequired

    Merchant account number

    accnoType stringrequired

    Account number type

    merchantProgramCode stringrequired

    Merchant program code

    customerId stringrequired

    Customer ID

    firstName stringrequired

    Customer's first name

    lastName stringrequired

    Customer's last name

    addressLine1 stringrequired

    Possible values: <= 127 characters

    First line of the address

    number stringrequired

    Possible values: <= 10 characters

    Address number

    postCode stringrequired

    Possible values: <= 10 characters

    Postal code

    city stringrequired

    Possible values: <= 54 characters

    City of residence

    countryCode stringrequired

    Possible values: <= 2 characters

    Country code (ISO 3166-1 alpha-2 format)

    emailAddress emailrequired

    Customer's email address

    dateOfBirth daterequired

    Customer's date of birth (YYYY-MM-DD)

    orderData

    object

    required

    Order data including items and value

    orderItems

    object[]

    List of items in the order

  • Array [

  • articleNumber string

    Article number of the item

    name string

    Name of the item

    group string

    Group of the item

    price decimal

    Price of the item

    amount decimal

    Amount of the item

    totalPrice decimal

    Total price of the item

    itemType string

    Type of the item

  • ]

  • orderValue decimal

    Total value of the order

    channel string

    Channel through which the order was made

    VIN string

    Vehicle Identification Number

    paymentOptionCode stringrequired

    Payment option code

    requestDateTime date-timerequired

    Date and time of the request

Responses

Successful response with compliance data.

Schema

    complianceData

    object

    archiveId string

    ID of the compliance archive

    trafficLight string

    Possible values: [GREEN, YELLOW, RED]

    Risk assessment result:

    • GREEN: Accepted
    • YELLOW: Over credit limit
    • RED: High risk
    recommendation string

    A recommendation based on the risk check result and the reason for denial.

    limit integer

    Limit associated with the risk check

    denialReason string

    Possible values: [BASKET_LIMIT, CUSTOMER_LIMIT, BLACKLIST, VELOCITY]

    Reason for denial if applicable:

    • BASKET_LIMIT: The order value exceeds the allowed basket limit
    • CUSTOMER_LIMIT: The order value exceeds the allowed customer limit
    • BLACKLIST: An entry in a black list was found for the provided customer information (see Compliance Checks.
    • VELOCITY: Unusual high number of transactions in a short period of time
    requestDateTime date-time

    Date and time of the request

    responseCode string

    Response code indicating the result of the request

    responseDescription string

    Description of the response

    additionalInformation

    object

    Contains diagnostic or tracking metadata returned with the API response. It is primarily used for support, logging and troubleshooting purposes.

    requestId string

    Unique ID for the request

Loading...