Skip to main content
GET
/
api
/
customer
/
{customerId}
/
risk-assessment
getRiskAssessment
curl --request GET \
  --url https://api.artemis.cynopsis.co/api/customer/{customerId}/risk-assessment \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Domain-ID: <x-domain-id>'
{
  "createdAt": {
    "date": 123,
    "day": 123,
    "hours": 123,
    "minutes": 123,
    "month": 123,
    "nanos": 123,
    "seconds": 123,
    "time": 123,
    "timezoneOffset": 123,
    "year": 123
  },
  "createdBy": {
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "id": 123,
    "lastName": "<string>"
  },
  "customerId": 123,
  "id": 123,
  "risk": {},
  "riskScore": 123,
  "updatedAt": {
    "date": 123,
    "day": 123,
    "hours": 123,
    "minutes": 123,
    "month": 123,
    "nanos": 123,
    "seconds": 123,
    "time": 123,
    "timezoneOffset": 123,
    "year": 123
  },
  "updatedBy": {
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "id": 123,
    "lastName": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.cynopsis.co/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint retrieves the most recent detailed Risk Report of a Primary Customer.
The Risk Report provides compliance teams with the latest calculated risk profile based on customer data, screenings, and other assessments.

​
Path Parameter

​
Example Request

curl -X GET "{{backend_url}}/api/customer/{{customerId}}/risk-assessment" \
  -H "Authorization: Bearer <token>" \
  -H "X-Domain-ID: {{domain_id}}"

​
Below is the following sample JSON response body of a Risk Report

​
Success Code 200

{
    "id": 663,
    "createdAt": "2022-07-26T06:54:06.903+00:00",
    "updatedAt": "2022-07-26T06:54:06.903+00:00",
    "createdBy": {...},
    "updatedBy": {...},
    "risk": {
        "comments": {
            "926": [],
            "927": [],
            "928": [
                "Marked as Politically Exposed Person.",
                "Marked as Sanction related person/entity.",
                "Adverse media found.",
                "Politically exposed",
                "Sanctioned"
            ]
        },
        "risk_score": 57.008335,
        "risk_rating": "HIGH",
        "component_score": {
            "cpi": 6.8,
            "fsi": 0.8333333333333335,
            "fatf": 8.958333333333332,
            "oecd": 10.0,
            "fatca": 1.25,
            "industry": 1.6666666666666667,
            "screening": 0.0,
            "entity_type": 10.0,
            "payment_modes": 5.0,
            "onboarding_mode": 5.0,
            "ownership_layer": 2.5,
            "product_complexity": 5.0,
            "individual_shareholding": 0
        },
        "weight_settings": {
            "cpi": 10.0,
            "fsi": 2.5,
            "fatf": 10.0,
            "oecd": 10.0,
            "fatca": 2.5,
            "industry": 2.5,
            "screening": 20.0,
            "entity_type": 15.0,
            "payment_modes": 5.0,
            "primary_weight": 50.0,
            "onboarding_mode": 5.0,
            "ownership_layer": 2.5,
            "product_complexity": 5.0,
            "individual_shareholding": 10.0
        }
    },
    "riskRating": "HIGH",
    "overrideRiskRating": null,
    "riskScore": 57.008335,
    "approvalStatus": null,
    "customerId": 926
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
X-Domain-ID
integer<int64>
required

X-Domain-ID

Path Parameters

​
customerId
integer<int64>
required

customerId

Response

OK

​
approvalStatus
enum<string>
Available options:
ACCEPTED,
CLEARED,
PENDING,
REJECTED,
REQUEST_CHANGES
​
createdAt
TimestampRes · object
​
createdBy
UserInfo · object
​
customerId
integer<int64>
​
id
integer<int64>
​
overrideRiskRating
enum<string>
Available options:
HIGH,
LOW,
MEDIUM,
MEDIUM_HIGH,
MEDIUM_LOW,
UNKNOWN
​
risk
object
​
riskRating
enum<string>
Available options:
HIGH,
LOW,
MEDIUM,
MEDIUM_HIGH,
MEDIUM_LOW,
UNKNOWN
​
riskScore
number<float>
​
updatedAt
TimestampRes · object
​
updatedBy
UserInfo · object