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

required

merchantAccno stringrequired

Merchant account number

accnoType stringrequired

Account number type

merchantProgramCode stringrequired

Merchant program code

customerId stringrequired

Customer ID

companyName stringrequired

Name of the company

addressLine1 stringrequired

First line of the address

number stringrequired

Address number

postCode stringrequired

Postal code

city stringrequired

City of the company's address

countryCode stringrequired

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

emailAddress emailrequired

Company's email address

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

200

Successful response with compliance data.

application/json

Schema

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

Example (from schema)

{
  "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

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "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

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "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

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "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

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "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

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

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

Example

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

Loading...