Add risk assessment information

Endpoint for adding new customer risk assessment information

Authentication

AuthorizationBearer

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

Request

This endpoint expects a list of objects.

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.

1	curl -X POST https://api.cable.tech/v2/risk_assessment \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '[
5	{
6	"assessment_id": "assessment_id",
7	"timestamp": "2024-01-15T09:30:00Z",
8	"type": "onboarding risk band",
9	"outcome": "outcome"
10	}
11	]'

1	{
2	"success": true,
3	"write_count": 1,
4	"message": "message",
5	"organization_id": "organization_id"
6	}

Authentication

Headers

Request

Response

Errors