Initiaite an Business Client Assessment

POST {{baseurl}}/v2/api/actors/risk/assessment

This endpoint allows you to initiate an individual client assessment, also known as an individual actor or entity, depending on your nomenclature. This is typically an individual you have a business or commercial relationship with.

NameTypeDescription

token*

String

API token

Body

FieldTypeDescription

type*

String

type of customer - one of individual or business

firstName*

String

firstName of customer - if customer is individual

lastName*

String

lastName of customer - if customer is individual

middleName

String

middleName of customer - if customer is individual

businessName*

String

businessName of customer - if customer is business

city*

String

Address city - required for both types

country*

String

Address country code - required for both types

industry

String

industry of customer - applies for both types

lengthOfStay

Number

Address length Of Stay - in months, applies for both types

ageOfAccount

Number

Age of Account - in months, applies for both types

previousAdverseMediaScore

Number

Previous Adverse Media Score - applies for both types

previousRiskScore

Number

Previous Risk Score - applies for both types

adverseMediaQueryDateRange*

Object

Date Range for the adverse Media Query required for individual or business , but for beneficiaries send as "null"

startDate*

String

start Date for the adverse Media Query

endDate*

String

end Date for the adverse Media Query

kycVerifiedBy*

String

KYC verified By one of youverify - if KYC was verified by youverify, client - if KYC was verified by client, not_verified - if KYC has not been verified, expired_30 - if ID has expired within the last 30 days, expired_90 - if ID has expired within the last 90 days

isBeneficiary

Number

is the risk assessment for a transaction beneficiary - applies for both types, "true, if the risk assessment is for a transaction beneficiary, "false", if it's not"

customWeight

Object

business custom weight - if business has a custom weight set

kyc

Number

kyc weight

industry

Number

industry weight

city

Number

city weight

country

Number

country weight

sanction

Number

sanction weight

pep

Number

pep weight

adverse_media

Number

adverse media weight

{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}

Last updated