For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact Us
Knowledge BaseProduct UpdatesAPI Documentation
Knowledge BaseProduct UpdatesAPI Documentation
    • Getting Started
  • API Reference
      • GETCheck if a risk assessment exists
      • POSTAdd risk assessment information
      • PUTUpdate risk assessment in batch
Contact Us
LogoLogo
API ReferenceRisk Assessment

Add risk assessment information

POST
https://api.cable.tech/v2/risk_assessment
POST
/v2/risk_assessment
$curl -X POST https://api.cable.tech/v2/risk_assessment \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '[
>  {
>    "assessment_id": "ra-9f8b7c6d5e4a3b2c1d0e",
>    "timestamp": "2024-01-15T09:30:00Z",
>    "type": "onboarding risk band",
>    "outcome": [
>      "MEDIUM"
>    ]
>  }
>]'
1{
2  "success": true,
3  "write_count": 1,
4  "message": "Risk assessment record added successfully.",
5  "organization_id": "org-1234567890abcdef"
6}
Endpoint for adding new customer risk assessment information
Was this page helpful?
Previous

Update risk assessment in batch

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Risk assessment data to add.
assessment_idstringRequired
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.
timestampdatetimeRequired
When the risk assessment was performed, not when reported to Cable. Use ISO 8601 format.
typestringRequired

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

outcomestringRequired

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

related_company_idstringOptional

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_idstringOptional

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.

Response

Risk assessment added successfully
successboolean
Indicates if the write operation was successful.
write_countinteger
The number of records written to the database.
messagestring
Provides additional information about the operation result.
organization_idstring
The organization ID for which the operation was performed.

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error