Skip to main content

The CustomerRiskProfile object

Risk assessment profile for a customer. Contains detailed risk scoring information used for fraud prevention and compliance decisions.

Fields​

FieldTypeDescription
customerId
REQUIRED
stringCustomer ID this profile belongs to
riskLevel
REQUIRED
RiskLevelOverall risk level RiskLevel
riskScore
REQUIRED
numberNumeric risk score (0-100, higher is riskier)
factors
REQUIRED
{ /** Name of the risk factor */ name: string /** Score contribution from this factor */ score: number /** Human-readable description of the factor */ description: string }[]Individual risk factors contributing to the score
lastAssessedAt
REQUIRED
stringISO 8601 timestamp when the risk was last assessed
recommendations
OPTIONAL
string[]Recommended actions based on the risk assessment

Example​

{
"customerId": "customer_1a2b3c",
"riskLevel": "low",
"riskScore": 1,
"factors": {},
"lastAssessedAt": "2026-01-15T09:30:00Z",
"recommendations": []
}