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:
- Blacklist checks
- Velocity checks
- Transaction limit checks
- 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
Must be application/json
Must be be en-US
The origin of the request
The client making the request
- application/json
Body
required
Array [
]
Merchant account number
Account number type
Merchant program code
Customer ID
Customer's first name
Customer's last name
Possible values: <= 127 characters
First line of the address
Possible values: <= 10 characters
Address number
Possible values: <= 10 characters
Postal code
Possible values: <= 54 characters
City of residence
Possible values: <= 2 characters
Country code (ISO 3166-1 alpha-2 format)
Customer's email address
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
Article number of the item
Name of the item
Group of the item
Price of the item
Amount of the item
Total price of the item
Type of the item
Total value of the order
Channel through which the order was made
Vehicle Identification Number
Payment option code
Date and time of the request
Responses
- 200
- 400
- 401
- 403
- 404
- 500
Successful response with compliance data.
- application/json
- Schema
- Example (from schema)
- Example
Schema
GREEN
: AcceptedYELLOW
: Over credit limitRED
: High riskBASKET_LIMIT
: The order value exceeds the allowed basket limitCUSTOMER_LIMIT
: The order value exceeds the allowed customer limitBLACKLIST
: 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
complianceData
object
ID of the compliance archive
Possible values: [GREEN
, YELLOW
, RED
]
Risk assessment result:
A recommendation based on the risk check result and the reason for denial.
Limit associated with the risk check
Possible values: [BASKET_LIMIT
, CUSTOMER_LIMIT
, BLACKLIST
, VELOCITY
]
Reason for denial if applicable:
Date and time of the request
Response code indicating the result of the request
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.
Unique ID for the request
{
"complianceData": {
"archiveId": "string",
"trafficLight": "GREEN",
"recommendation": "string",
"limit": 0,
"denialReason": "BASKET_LIMIT"
},
"requestDateTime": "2024-07-29T15:51:28.071Z",
"responseCode": "string",
"responseDescription": "string",
"additionalInformation": {
"requestId": "string"
}
}
{
"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"
}
}
Bad Request
For error handling, please refer to this section.
- application/json
- Schema
- Example (from schema)
- Example
Schema
- MOD1
- MOD2
Array [
]
errorDetails
object
message
object
oneOf
string
string
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"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
}
}
]
}
Unauthenticated
For error handling, please refer to this section.
- application/json
- Schema
- Example (from schema)
- Example
Schema
- MOD1
- MOD2
Array [
]
errorDetails
object
message
object
oneOf
string
string
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "You are not authenticated to perform this request.",
"code": "unauthorized"
}
]
}
Forbidden
For error handling, please refer to this section.
- application/json
- Schema
- Example (from schema)
- Example
Schema
- MOD1
- MOD2
Array [
]
errorDetails
object
message
object
oneOf
string
string
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "You do not have permissions to perform this request.",
"code": "forbidden"
}
]
}
Not Found
For error handling, please refer to this section.
- application/json
- Schema
- Example (from schema)
- Example
Schema
- MOD1
- MOD2
Array [
]
errorDetails
object
message
object
oneOf
string
string
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "Resource not found.",
"code": "not_found"
}
]
}
Internal Server Error
For error handling, please refer to this section.
- application/json
- Schema
- Example (from schema)
- Example
Schema
- MOD1
- MOD2
Array [
]
errorDetails
object
message
object
oneOf
string
string
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "Internal server error."
}
]
}