--- updatedAt: 2026-04-21T08:57:19.000Z agentTools: projectIndex: https://docs.mesh.complyadvantage.com/llms.txt --- # Override customer's risk score level Manually override the overall risk score level for a customer. Once overridden, the risk score type is set to MANUAL and will not be automatically recalculated by the system. The manual override persists until explicitly changed again through this endpoint or removed. You need the "Update customers" permission to use this endpoint. # OpenAPI definition ```json { "components": { "schemas": { "risk-scoring_CategoryResult": { "properties": { "attribute_results": { "items": { "oneOf": [ { "$ref": "#/components/schemas/risk-scoring_ListField" }, { "$ref": "#/components/schemas/risk-scoring_ValueField" } ] }, "type": "array" }, "category": { "enum": [ "BASIC_INFORMATION", "CHANNEL", "COUNTRY", "PRODUCT", "SCREENING", "CUSTOM_FIELDS" ], "type": "string" }, "level": { "enum": [ "LOW", "MEDIUM", "HIGH", "PROHIBITED", "SKIPPED" ], "type": "string" }, "score": { "format": "double", "type": "number" }, "weight": { "format": "double", "type": "number" } }, "required": [ "attribute_results", "category", "level", "score", "weight" ], "type": "object" }, "risk-scoring_Field": { "discriminator": { "mapping": { "list_field": "#/components/schemas/risk-scoring_ListField", "value_field": "#/components/schemas/risk-scoring_ValueField" }, "propertyName": "type" }, "properties": { "attribute_name": { "type": "string" }, "score": { "format": "double", "type": "number" }, "type": { "type": "string" } }, "required": [ "attribute_name", "score", "type" ], "type": "object" }, "risk-scoring_ListField": { "allOf": [ { "$ref": "#/components/schemas/risk-scoring_Field" }, { "properties": { "attribute_results": { "items": { "oneOf": [ { "$ref": "#/components/schemas/risk-scoring_ListField" }, { "$ref": "#/components/schemas/risk-scoring_ValueField" } ] }, "type": "array" } }, "type": "object" } ], "required": [ "attribute_name", "attribute_results", "score" ], "type": "object" }, "risk-scoring_OverallResult": { "properties": { "level": { "enum": [ "LOW", "MEDIUM", "HIGH", "PROHIBITED", "SKIPPED" ], "type": "string" }, "score": { "format": "double", "type": "number" } }, "required": [ "level", "score" ], "type": "object" }, "risk-scoring_OverallResultRequest": { "properties": { "level": { "enum": [ "LOW", "MEDIUM", "HIGH", "PROHIBITED" ], "type": "string" } }, "required": [ "level" ], "type": "object" }, "risk-scoring_ProblemDetailErrorResponse": { "additionalProperties": true, "properties": { "detail": { "type": "string" }, "identifier": { "format": "uuid", "type": "string" }, "instance": { "format": "uri", "type": "string" }, "status": { "format": "int32", "type": "integer" }, "timestamp": { "format": "date-time", "type": "string" }, "title": { "type": "string" }, "type": { "format": "uri", "type": "string" } }, "required": [ "identifier", "timestamp" ], "type": "object" }, "risk-scoring_RiskScore": { "properties": { "account_identifier": { "deprecated": true, "format": "uuid", "type": "string" }, "category_results": { "items": { "$ref": "#/components/schemas/risk-scoring_CategoryResult" }, "type": "array" }, "created_at": { "format": "date-time", "type": "string" }, "customer_identifier": { "format": "uuid", "type": "string" }, "customer_version": { "format": "int32", "type": "integer" }, "overall_result": { "$ref": "#/components/schemas/risk-scoring_OverallResult" }, "override_reason": { "type": "string" }, "risk_model_identifier": { "format": "uuid", "type": "string" }, "risk_model_version": { "format": "int32", "type": "integer" }, "score_identifier": { "format": "uuid", "type": "string" }, "type": { "enum": [ "PARTIAL", "FULL", "MANUAL" ], "type": "string" }, "updated_by": { "format": "uuid", "type": "string" } }, "required": [ "account_identifier", "category_results", "created_at", "customer_identifier", "customer_version", "overall_result", "risk_model_identifier", "risk_model_version", "score_identifier", "type" ], "type": "object" }, "risk-scoring_RiskScoreOverrideRequest": { "properties": { "calculate_automatically": { "type": "boolean" }, "overall_result": { "$ref": "#/components/schemas/risk-scoring_OverallResultRequest" }, "override_reason": { "maxLength": 1000, "minLength": 1, "type": "string" } }, "required": [ "override_reason" ], "type": "object" }, "risk-scoring_ValueField": { "allOf": [ { "$ref": "#/components/schemas/risk-scoring_Field" }, { "properties": { "evaluated_parameter": { "type": "string" } }, "type": "object" } ], "required": [ "attribute_name", "evaluated_parameter", "score" ], "type": "object" } }, "securitySchemes": { "BearerAuth": { "description": "HTTP Bearer Token Authentication", "scheme": "bearer", "type": "http" } } }, "info": { "title": "Mesh API", "version": "v2.0" }, "openapi": "3.0.3", "paths": { "/v2/customers/{customer_identifier}/scores": { "patch": { "description": "Manually override the overall risk score level for a customer. Once overridden, the risk score type is set to MANUAL and will not be automatically recalculated by the system. The manual override persists until explicitly changed again through this endpoint or removed. \n\n\nYou need the \"Update customers\" permission to use this endpoint.", "operationId": "riskScoringManagerServiceAPIUpdateRiskScore", "parameters": [ { "description": "The unique identifier we provided when you created the customer.", "example": "00000000-0000-0000-0000-000000000000", "in": "path", "name": "customer_identifier", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/risk-scoring_RiskScoreOverrideRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Manual Risk Score": { "description": "Manual Risk Score", "value": { "category_results": [], "created_at": "2025-09-12T09:18:23.529Z", "customer_identifier": "01985c02-690f-7f0e-95ce-0dec29e985ff", "customer_version": 1, "overall_result": { "level": "LOW", "score": 0 }, "override_reason": "Some detailed reason", "risk_model_identifier": "01985c02-690f-7f0e-95ce-0dec29e985ff", "risk_model_version": 1, "score_identifier": "01993d37-fd29-70f6-bb67-391347164c97", "type": "MANUAL", "updated_at": "2025-09-12T09:18:23.529Z", "updated_by": "01985c02-690f-7f0e-95ce-0dec29e985ff" } } }, "schema": { "$ref": "#/components/schemas/risk-scoring_RiskScore" } } }, "description": "Successfully overridden the customer's risk score level." }, "400": { "content": { "application/json": { "examples": { "Invalid Risk Level": { "description": "Invalid Risk Level", "value": { "detail": "Missing or invalid risk level or override reason values", "identifier": "018e1971-1c6f-761f-a510-43540727ff48", "instance": "https://example.com/v2/customers/00000000-0000-0000-0000-000000000000/scores", "properties": { "errors": [ { "field": "overallResult.level", "reasons": [ { "key": "ValidRiskLevel", "message": "Risk level must be LOW, MEDIUM, HIGH or PROHIBITED" } ], "rejected": "SKIPPED" } ] }, "status": 400, "timestamp": "2024-03-07T15:03:47.055Z", "title": "Validation failed", "type": "about:blank" } } }, "schema": { "$ref": "#/components/schemas/risk-scoring_ProblemDetailErrorResponse" } } }, "description": "Missing or invalid risk level or override reason" }, "403": { "content": { "application/json": { "examples": { "Forbidden": { "description": "Forbidden", "value": { "detail": "You do not have permission to override a customer risk score.", "identifier": "018d3157-0ec8-73ba-a684-865e5e2ff1ed", "instance": "https://example.com/v2/customers/00000000-0000-0000-0000-000000000000/scores", "properties": {}, "status": 403, "timestamp": "2024-01-22T13:23:25.512Z", "title": "Forbidden", "type": "about:blank" } } }, "schema": { "$ref": "#/components/schemas/risk-scoring_ProblemDetailErrorResponse" } } }, "description": "Forbidden - insufficient permissions to override customer risk score." }, "404": { "content": { "application/json": { "examples": { "Customer not found": { "description": "Customer not found", "value": { "detail": "Customer not found", "identifier": "018e1971-1c6f-761f-a510-43540727ff48", "instance": "https://example.com/v2/customers/00000000-0000-0000-0000-000000000000/scores", "properties": { "errors": [] }, "status": 404, "timestamp": "2024-03-07T15:03:47.055Z", "title": "Customer not found", "type": "about:blank" } } }, "schema": { "$ref": "#/components/schemas/risk-scoring_ProblemDetailErrorResponse" } } }, "description": "Customer or risk score not found." } }, "summary": "Override customer's risk score level", "tags": [ "Customers" ] } } }, "security": [ { "BearerAuth": [] } ], "servers": [ { "description": "ComplyAdvantage Mesh API", "url": "https://api.mesh.complyadvantage.com" } ], "tags": [ { "name": "Customers" } ] } ```