Company Risk Check

POST 
/compliance/company-risk-check

Performs a risk check for a company based on company-related and order-related information.

Risk management and fraud prevention checks include:

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

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

application/json

Body

Bodyrequired

merchantAccnostringrequired

Merchant account number

accnoTypestringrequired

Account number type

merchantProgramCodestringrequired

Merchant program code

customerIdstringrequired

Customer ID

companyNamestringrequired

Name of the company

addressLine1stringrequired

First line of the address

numberstringrequired

Address number

postCodestringrequired

Postal code

citystringrequired

City of the company's address

countryCodestringrequired

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

emailAddressstring<email>required

Company's email address

orderData objectrequired

Order data including items and value

orderItems object[]

List of items in the order

Array [

articleNumberstring

Article number of the item

namestring

Name of the item

groupstring

Group of the item

pricenumber<decimal>

Price of the item

amountnumber<decimal>

Amount of the item

totalPricenumber<decimal>

Total price of the item

itemTypestring

Type of the item

]

orderValuenumber<decimal>

Total value of the order

channelstring

Channel through which the order was made

VINstring

Vehicle Identification Number

paymentOptionCodestringrequired

Payment option code

requestDateTimestring<date-time>required

Date and time of the request

Example

{
  "merchantAccno": "000000005",
  "accnoType": "00",
  "merchantProgramCode": "COMPANY123",
  "customerId": "100001073541",
  "companyName": "Meier FS AG",
  "addressLine1": "Anystreet",
  "number": "321",
  "postCode": "12345",
  "city": "Anycity",
  "countryCode": "DE",
  "emailAddress": "user@example.com",
  "orderData": {
    "orderItems": [
      {
        "articleNumber": "4M0.054.816A 05A",
        "name": "Connected Infotainment services 3 Months",
        "group": "Infotainment",
        "price": 50,
        "amount": 1,
        "totalPrice": 50,
        "itemType": "SUBSCRIPTION"
      }
    ],
    "orderValue": 50,
    "channel": "In-Car App"
  },
  "VIN": "123456",
  "paymentOptionCode": "VISA",
  "requestDateTime": "2021-02-08T17:43:19.027Z"
}

Responses

200

Successful response with compliance data.

application/json

Schema

Schema

complianceData object

archiveIdstring

ID of the compliance archive

trafficLightstring

Risk assessment result:


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

Possible values: [GREEN, YELLOW, RED]

recommendationstring

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

limitinteger

Limit associated with the risk check

denialReasonstring

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

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

Example (auto)

{
  "complianceData": {
    "archiveId": "string",
    "trafficLight": "GREEN",
    "recommendation": "string",
    "limit": 0,
    "denialReason": "BASKET_LIMIT"
  }
}

Example

{
  "complianceData": {
    "archiveId": "4858000025016093",
    "trafficLight": "GREEN",
    "recommendation": "All checks successful",
    "limit": 100,
    "denialReason": ""
  },
  "requestDateTime": "2021-02-08T17:43:19.027Z",
  "responseCode": "0000",
  "responseDescription": "Successful execution.",
  "additionalInformation": {
    "requestId": "aff2728481a181dc36daedc14055b516"
  }
}

400

Bad Request

info

For error handling, please refer to this section.

application/json

Schema

Schema

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Value out of bounds. Value must be between 1 and 100",
      "code": "value_out_of_bounds",
      "property": "someField",
      "context": {
        "minimum": 1,
        "maximum": 100
      }
    }
  ]
}

401

Unauthenticated

info

For error handling, please refer to this section.

application/json

Schema

Schema

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You are not authenticated to perform this request.",
      "code": "unauthorized"
    }
  ]
}

403

Forbidden

info

For error handling, please refer to this section.

application/json

Schema

Schema

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You do not have permissions to perform this request.",
      "code": "forbidden"
    }
  ]
}

404

Not Found

info

For error handling, please refer to this section.

application/json

Schema

Schema

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Resource not found.",
      "code": "not_found"
    }
  ]
}

500

Internal Server Error

info

For error handling, please refer to this section.

application/json

Schema

Schema

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Internal server error."
    }
  ]
}