API ReferenceRisk Assessment

Update risk assessment in batch

Authentication

AuthorizationBearer

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

Request

An array of risk assessment update payloads. Each payload must include the ‘assessment_id’ to identify the identity verification and can include any other fields that need to be updated. The ‘timestamp’ field represents the time of update.

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.
timestampstringRequiredformat: "date-time"
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 updated 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