Sign in

v1

latestOpenAPI 3.0.32026-08-04404186.8 KB
Risk Assessment

Add risk assessment information

Endpoint for adding new customer risk assessment information

post/v2/risk_assessment

Request body

assessment_idstring required

Unique identifier for a risk assessment belonging to a risk assessment. This is the primary key for a risk assessment and should be unique across all risk assessments. Updates to a risk assessment should be made using this identifier.

outcomestring required

The outcome of the assessment. One of: LOW, MEDIUM, HIGH, CRITICAL

related_company_idstring

Unique identifier of the related company entity (used for business contexts). Only one of related_company_id and related_person_id can be specified.

related_person_idstring

Unique identifier of the related person entity (used for retail contexts or when a person is the subject). Only one of related_company_id and related_person_id can be specified.

timestampstring date-time required

When the risk assessment was performed, not when reported to Cable. Use ISO 8601 format.

typestring required

Type of risk assessment (e.g., pre-onboarding risk rating, risk band, risk engine score)

Example request

[
  {
    "related_company_id": "company-id-12345",
    "related_person_id": "person-id-56789",
    "type": "onboarding risk band"
  }
]

Response

Risk assessment added successfully

messagestring required

Provides additional information about the operation result.

organization_idstring required

The organization ID for which the operation was performed.

successboolean required

Indicates if the write operation was successful.

write_countinteger required

The number of records written to the database.