--- updatedAt: 2026-04-21T08:57:19.000Z agentTools: projectIndex: https://docs.mesh.complyadvantage.com/llms.txt --- # Rescreen a customer synchronously This endpoint initiates the synchronous 'rescreen' workflow for your customer. The workflow consists of two steps: 1. **Customer Rescreening:** The customer is screened against the latest data sources to identify any new risk information. 2. **Alerting:** If new, relevant, risks are found an alert is generated. The workflow executes synchronously, returning the workflow status and result immediately. The rescreening operation applies the rules and settings defined in the customer's monitoring configuration. If no monitoring configuration is currently assigned to the customer, the system will default to using the initial screening configuration applied when the customer was first screened. Rescreen events count towards your total onboarding search volumes You need "Enables re-screening of customers on demand via UI/API" enabled to use this endpoint. # OpenAPI definition ```json { "components": { "schemas": { "ol_AlertStep": { "properties": { "alert_skipped_code": { "enum": [ "ALERT_SKIPPED_CODE_UNSPECIFIED", "ALERT_SKIPPED_CODE_NO_ALERT_REQUIRED", "ALERT_SKIPPED_CODE_MANUAL_SUPPRESSION", "ALERT_SKIPPED_CODE_FROM_SOURCE" ], "nullable": true, "type": "string" }, "identifier": { "format": "uuid", "type": "string" } }, "required": [ "identifier" ], "type": "object" }, "ol_AlertingStepOutput": { "properties": { "alerts": { "items": { "$ref": "#/components/schemas/ol_AlertStep" }, "type": "array" } }, "required": [ "alerts" ], "type": "object" }, "ol_BooleanEnrichmentValueV3": { "allOf": [ { "$ref": "#/components/schemas/ol_EnrichmentValueV3" }, { "properties": { "boolean": { "default": false, "description": "The boolean value", "example": true, "type": "boolean" } }, "type": "object" } ], "description": "Boolean representation of the enrichment value.", "required": [ "boolean", "data_type" ], "title": "Boolean Value", "type": "object" }, "ol_CaseCreationStepOutput": { "properties": { "case_identifier": { "format": "uuid", "type": "string" } }, "required": [ "case_identifier" ], "type": "object" }, "ol_CustomerCreationStepOutput": { "properties": { "customer_identifier": { "format": "uuid", "type": "string" }, "external_identifier": { "type": "string" } }, "required": [ "customer_identifier", "external_identifier" ], "type": "object" }, "ol_CustomerScreeningStepOutput": { "properties": { "aml_types": { "items": { "enum": [ "UNSPECIFIED", "ADVERSE_MEDIA", "ADVERSE_MEDIA_GENERAL", "ADVERSE_MEDIA_V2_OTHER_MINOR", "ADVERSE_MEDIA_V2_EU_AML_DIRECTIVE", "ADVERSE_MEDIA_V1_HIGH_RISK", "ADVERSE_MEDIA_VIOLENT_CRIME", "ADVERSE_MEDIA_V2_VIOLENCE_AML_CFT", "ADVERSE_MEDIA_V2_VIOLENCE_NON_AML_CFT", "ADVERSE_MEDIA_FINANCIAL_CRIME", "WARNING", "PEP", "ADVERSE_MEDIA_V2_PROPERTY", "PEP_CLASS_1_TO_3", "ADVERSE_MEDIA_NARCOTICS", "ADVERSE_MEDIA_V2_NARCOTICS_AML_CFT", "FITNESS_PROBITY", "ADVERSE_MEDIA_FRAUD", "ADVERSE_MEDIA_V2_FRAUD_LINKED", "PEP_CLASS_2", "ADVERSE_MEDIA_V2_REGULATORY", "PEP_CLASS_1", "ADVERSE_MEDIA_V2_GENERAL_AML_CFT", "ADVERSE_MEDIA_V2_OTHER_SERIOUS", "ADVERSE_MEDIA_TERRORISM", "ADVERSE_MEDIA_V2_FINANCIAL_AML_CFT", "ADVERSE_MEDIA_V2_FINANCIAL_DIFFICULTY", "PEP_CLASS_4", "ADVERSE_MEDIA_V2_TERRORISM", "ADVERSE_MEDIA_SEXUAL_CRIME", "PEP_CLASS_3", "ADVERSE_MEDIA_V2_CYBERCRIME", "SANCTION", "ADVERSE_MEDIA_V2_OTHER_FINANCIAL", "SANCTION_RELATED", "CUSTOM" ], "type": "string" }, "nullable": true, "type": "array" }, "screening_result": { "$ref": "#/components/schemas/ol_ScreeningResult" } }, "required": [ "screening_result" ], "type": "object" }, "ol_CustomerUpdateStepOutput": { "properties": { "customer_identifier": { "format": "uuid", "type": "string" }, "customer_version": { "format": "int32", "type": "integer" }, "external_identifier": { "type": "string" } }, "required": [ "customer_identifier", "customer_version", "external_identifier" ], "type": "object" }, "ol_DecimalEnrichmentValueV3": { "allOf": [ { "$ref": "#/components/schemas/ol_EnrichmentValueV3" }, { "properties": { "decimal": { "description": "The decimal value", "example": 98.33, "type": "number" } }, "type": "object" } ], "description": "Decimal representation of the enrichment value.", "required": [ "data_type", "decimal" ], "title": "Decimal Value", "type": "object" }, "ol_DecisionStepOutput": { "properties": { "decision": { "enum": [ "UNKNOWN", "PROCESS", "HOLD", "REJECT", "ALLOW", "SKIPPED" ], "type": "string" } }, "required": [ "decision" ], "type": "object" }, "ol_EmptyStepOutput": { "type": "object" }, "ol_EnrichmentDataTypeV3": { "description": "The type of data stored in an enrichment value.", "enum": [ "TEXT", "DECIMAL", "BOOLEAN" ], "type": "string" }, "ol_EnrichmentStepOutput": { "properties": { "enrichments": { "items": { "$ref": "#/components/schemas/ol_EnrichmentV3" }, "type": "array" } }, "required": [ "enrichments" ], "type": "object" }, "ol_EnrichmentTypeV3": { "description": "The type of enrichment source.", "enum": [ "LOOKUP_LIST", "REGEX_BOOLEAN" ], "example": "LOOKUP_LIST", "type": "string" }, "ol_EnrichmentV3": { "description": "A representation of a transaction enrichment.", "properties": { "key": { "description": "The key of the enrichment.", "example": "debtors_country_risk", "minLength": 1, "type": "string" }, "type": { "$ref": "#/components/schemas/ol_EnrichmentTypeV3" }, "value": { "oneOf": [ { "$ref": "#/components/schemas/ol_BooleanEnrichmentValueV3" }, { "$ref": "#/components/schemas/ol_DecimalEnrichmentValueV3" }, { "$ref": "#/components/schemas/ol_TextEnrichmentValueV3" } ] } }, "required": [ "key", "type", "value" ], "type": "object" }, "ol_EnrichmentValueV3": { "description": "The value of the enrichment.", "discriminator": { "propertyName": "data_type" }, "properties": { "data_type": { "$ref": "#/components/schemas/ol_EnrichmentDataTypeV3" } }, "required": [ "data_type" ], "type": "object" }, "ol_FullRiskScoringStepOutput": { "properties": { "overall_level": { "enum": [ "UNSPECIFIED-RISK", "LOW-RISK", "MEDIUM-RISK", "HIGH-RISK", "PROHIBITED", "SKIPPED" ], "type": "string" }, "overall_value": { "format": "double", "type": "number" } }, "required": [ "overall_level", "overall_value" ], "type": "object" }, "ol_InitialRiskScoringStepOutput": { "properties": { "overall_level": { "enum": [ "UNSPECIFIED-RISK", "LOW-RISK", "MEDIUM-RISK", "HIGH-RISK", "PROHIBITED", "SKIPPED" ], "type": "string" }, "overall_value": { "format": "double", "type": "number" } }, "required": [ "overall_level", "overall_value" ], "type": "object" }, "ol_ProblemDetailErrorResponse": { "additionalProperties": true, "properties": { "detail": { "nullable": true, "type": "string" }, "identifier": { "format": "uuid", "type": "string" }, "instance": { "format": "uri", "nullable": true, "type": "string" }, "status": { "format": "int32", "nullable": true, "type": "integer" }, "timestamp": { "format": "date-time", "type": "string" }, "title": { "nullable": true, "type": "string" }, "type": { "format": "uri", "nullable": true, "type": "string" } }, "required": [ "identifier", "timestamp" ], "type": "object" }, "ol_ScreeningResult": { "oneOf": [ { "enum": [ "HAS-HITS", "NO-HITS" ], "type": "string" }, { "enum": [ "HAS_PROFILES", "NO_PROFILES" ], "type": "string" } ], "type": "object" }, "ol_StepDetails": { "properties": { "error_message": { "nullable": true, "type": "string" }, "identifier": { "description": "- For the alerting step, this field is always null at the step level.\n- Actual alert identifiers are nested within step_output.alerts[].identifier.", "format": "uuid", "nullable": true, "type": "string" }, "status": { "enum": [ "NOT-STARTED", "IN-PROGRESS", "COMPLETED", "SKIPPED", "ERRORED" ], "type": "string" }, "step_output": { "$ref": "#/components/schemas/ol_StepOutput" } }, "required": [ "status" ], "type": "object" }, "ol_StepOutput": { "anyOf": [ { "$ref": "#/components/schemas/ol_EmptyStepOutput" }, { "$ref": "#/components/schemas/ol_CustomerCreationStepOutput" }, { "$ref": "#/components/schemas/ol_InitialRiskScoringStepOutput" }, { "$ref": "#/components/schemas/ol_CustomerScreeningStepOutput" }, { "$ref": "#/components/schemas/ol_CaseCreationStepOutput" }, { "$ref": "#/components/schemas/ol_AlertingStepOutput" }, { "$ref": "#/components/schemas/ol_StoredActivityStepOutput" }, { "$ref": "#/components/schemas/ol_DecisionStepOutput" }, { "$ref": "#/components/schemas/ol_CustomerUpdateStepOutput" }, { "$ref": "#/components/schemas/ol_FullRiskScoringStepOutput" }, { "$ref": "#/components/schemas/ol_EnrichmentStepOutput" } ], "nullable": true, "type": "object" }, "ol_StoredActivityStepOutput": { "properties": { "activity_identifier": { "format": "uuid", "type": "string" } }, "required": [ "activity_identifier" ], "type": "object" }, "ol_TextEnrichmentValueV3": { "allOf": [ { "$ref": "#/components/schemas/ol_EnrichmentValueV3" }, { "properties": { "text": { "description": "The text content.", "example": "HIGH", "maxLength": 256, "minLength": 0, "type": "string" } }, "type": "object" } ], "description": "String representation of the enrichment value.", "required": [ "data_type", "text" ], "title": "Text Value", "type": "object" }, "ol_WorkflowState": { "properties": { "status": { "enum": [ "NOT-STARTED", "IN-PROGRESS", "COMPLETED", "SKIPPED", "ERRORED" ], "type": "string" }, "step_details": { "additionalProperties": { "$ref": "#/components/schemas/ol_StepDetails" }, "type": "object" }, "steps": { "items": { "enum": [ "customer-creation", "initial-risk-scoring", "customer-screening", "customer-rescreening", "case-creation", "alerting", "customer-update", "risk-scoring", "payment-screening", "store-transaction", "transaction-monitoring" ], "type": "string" }, "type": "array" }, "workflow_instance_identifier": { "format": "uuid", "type": "string" }, "workflow_type": { "enum": [ "create-and-screen", "update-and-rescore", "rescreen-customer" ], "type": "string" } }, "required": [ "status", "step_details", "steps", "workflow_instance_identifier", "workflow_type" ], "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}/workflows/sync/rescreen": { "post": { "description": "This endpoint initiates the synchronous 'rescreen' workflow for your customer. The workflow consists of two steps:\n1. **Customer Rescreening:** The customer is screened against the latest data sources to identify any new risk information.\n2. **Alerting:** If new, relevant, risks are found an alert is generated. The workflow executes synchronously, returning the workflow status and result immediately.\nThe rescreening operation applies the rules and settings defined in the customer's monitoring configuration. If no monitoring configuration is currently assigned to the customer, the system will default to using the initial screening configuration applied when the customer was first screened. Rescreen events count towards your total onboarding search volumes You need \"Enables re-screening of customers on demand via UI/API\" enabled to use this endpoint.", "operationId": "orchestrationLayerAPIPostV2RescreenCustomerWorkflowsSync", "parameters": [ { "description": "Identifier of the customer to rescreen", "example": "b30a02b7-eb74-445a-b678-b778ab3f091e", "in": "path", "name": "customer_identifier", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "A unique, client-generated string that identifies a single operational attempt. You must generate a new key for every distinct operation, and use the exact same key when retrying a failed request to prevent duplication.\nThe usage of this key is recommended to ensure safe retries without duplicate processing or billing. While any unique string is accepted, we strongly recommend using a standard UUID to guarantee global uniqueness.", "example": "019b2d24-cdcc-737c-9186-2c87451edf7f", "in": "header", "name": "X-ComplyAdvantage-Idempotency-Key", "required": false, "schema": { "maxLength": 255, "minLength": 0, "type": "string" } }, { "description": "Specifies the screening logic to apply. Set to DELTA to perform a differential screen, which compares the new result against the customer's previous screening baseline and only alerts on new or changed risk factors.", "example": "DELTA", "in": "query", "name": "rescreen_type", "required": false, "schema": { "default": "DELTA", "enum": [ "DELTA" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "WORKFLOW COMPLETED": { "description": "Once all step workflows are marked as COMPLETED then the workflow status will be marked as COMPLETED.", "value": { "status": "COMPLETED", "step_details": { "alerting": { "identifier": null, "status": "COMPLETED", "step_output": { "alerts": [ { "identifier": "019b2ce4-6850-7451-8d50-a2525e482426" } ] } }, "customer-rescreening": { "identifier": "019b2ce4-5766-7a85-bcc8-138a1661d7d7", "status": "COMPLETED", "step_output": { "aml_types": [ "SANCTION", "ADVERSE_MEDIA", "ADVERSE_MEDIA_V2_CYBERCRIME", "PEP_CLASS_1", "PEP_CLASS_2", "WARNING" ], "rescreen_type": "DELTA", "rescreened_at": "2025-12-17T15:18:44.000Z", "rescreening_result": "HAS_CHANGES" } } }, "steps": [ "customer-rescreening", "alerting" ], "workflow_instance_identifier": "019b2ce4-5718-71be-9899-a90b319ea9d6", "workflow_type": "rescreen-customer" } }, "WORKFLOW COMPLETED (NO CHANGES FOUND)": { "description": "Once all step workflows are marked as COMPLETED then the workflow status will be marked as COMPLETED.", "value": { "status": "COMPLETED", "step_details": { "alerting": { "identifier": null, "status": "COMPLETED", "step_output": { "alerts": [] } }, "customer-rescreening": { "identifier": "019b2ce4-5766-7a85-bcc8-138a1661d7d7", "status": "COMPLETED", "step_output": { "rescreen_type": "DELTA", "rescreened_at": "2025-12-17T15:18:44.000Z", "rescreening_result": "NO_CHANGES" } } }, "steps": [ "customer-rescreening", "alerting" ], "workflow_instance_identifier": "019b2ce4-5718-71be-9899-a90b319ea9d6", "workflow_type": "rescreen-customer" } }, "WORKFLOW ERRORED": { "description": "If any of the step workflows returns an ERRORED state then the workflow status will be marked as ERRORED.", "value": { "status": "ERRORED", "step_details": { "alerting": { "identifier": null, "status": "SKIPPED", "step_output": {} }, "customer-rescreening": { "error_message": "An error occurred while rescreening the customer", "identifier": "019b298b-3ef5-75ef-85f7-bf43f6909986", "status": "ERRORED", "step_output": {} } }, "steps": [ "customer-rescreening", "alerting" ], "workflow_instance_identifier": "019b298b-3ed8-73a1-9efc-24c7f2dfc7b9", "workflow_type": "rescreen-customer" } } }, "schema": { "$ref": "#/components/schemas/ol_WorkflowState" } } }, "description": "Rescreen customer workflow executed" }, "400": { "content": { "application/json": { "examples": { "Invalid workflow_type": { "description": "Invalid workflow_type", "value": { "identifier": "018c3ff3-7099-7090-a15b-8daee4cb81df", "status": 400, "timestamp": "2023-12-11T09:30:03.975Z", "title": "Invalid workflow_type: Invalid" } }, "Validation error": { "description": "Validation error", "value": { "identifier": "018c3ff3-7099-7090-a15b-8daee4cb81df", "status": 400, "timestamp": "2023-12-11T09:30:03.975Z", "title": "Validation error" } } }, "schema": { "$ref": "#/components/schemas/ol_ProblemDetailErrorResponse" } } }, "description": "Bad request" } }, "summary": "Rescreen a customer synchronously", "tags": [ "Customers" ] } } }, "security": [ { "BearerAuth": [] } ], "servers": [ { "description": "ComplyAdvantage Mesh API", "url": "https://api.mesh.complyadvantage.com" } ], "tags": [ { "name": "Customers" } ] } ```