Compliance Screening

Update compliance screening (review workflow)

Changed on May 20, 2026

Updates a compliance screening — used for the false positive review workflow (e.g., setting false_positive_qualifier, review_notes, reviewed_by_user_id).

put/api/compliance-screenings/{id}

Request

Base URL: http://localhost:4100
URL: http://localhost:4100/api/compliance-screenings/{id}
Auth: none required

Path parameters

idstring uuid required

Compliance screening ID

Request body

aml_control_countinteger nullable

aml_control_flagboolean nullable

aml_geographic_risk_flagboolean nullable

aml_high_risk_countrystring nullable

aml_risk_scorenumber nullable

compliance_screening_numberstring nullable

escalation_levelinteger nullable

false_positive_qualifier'none' | 'manual_override' | 'auto_suppressed'

legal_entity_idstring uuid nullable

manual_review_requiredboolean

match_countinteger nullable

payment_account_idstring uuid nullable

pep_indicatorboolean nullable

pep_list_namestring nullable

review_notesstring nullable

reviewed_atstring date-time nullable

reviewed_by_user_idstring uuid nullable

sanctions_screening_datestring date-time nullable

sanctions_screening_status'cleared' | 'pending' | 'match' | 'failed' nullable

scope'account_holder' | 'beneficial_owner' | 'counterparty' | 'payment_account' | 'transaction' required

screened_atstring date-time nullable

screened_entity_namestring required

screened_entity_type'individual' | 'company' | 'crypto_address' | 'payment_account' required

screening_rulesstring nullable

screening_scorenumber nullable

screening_status'pending' | 'pass' | 'potential_match' | 'blocked' | 'escalated' required

screening_type'sanctions' | 'pep' | 'aml' | 'adverse_media' required

Example request

{
  "aml_control_count": 0,
  "aml_control_flag": false,
  "aml_geographic_risk_flag": false,
  "aml_high_risk_country": "",
  "aml_risk_score": 0,
  "compliance_screening_number": "",
  "escalation_level": 0,
  "false_positive_qualifier": "none",
  "legal_entity_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "manual_review_required": false,
  "match_count": 0,
  "payment_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "pep_indicator": false,
  "pep_list_name": "",
  "review_notes": "",
  "reviewed_at": "2020-04-20T16:20:00Z",
  "reviewed_by_user_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "sanctions_screening_date": "2020-04-20T16:20:00Z",
  "sanctions_screening_status": "cleared",
  "scope": "account_holder",
  "screened_at": "2020-04-20T16:20:00Z",
  "screened_entity_name": "",
  "screened_entity_type": "individual",
  "screening_rules": "",
  "screening_score": 0,
  "screening_status": "pending",
  "screening_type": "sanctions"
}

Changes

May 20, 2026e99ccd17df53 Revision changes
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new beneficial_owner enum value to the request property
- info
  added the new crypto_address enum value to the request property
- info
  added the new payment_account enum value to the request property

Operation history