Sign in
Compliance Screening

Get compliance screening by ID

Changed on

Returns a single compliance screening.

get/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

Response

Compliance screening

aml_control_countinteger nullable
aml_high_risk_countrystring nullable
screening_type'sanctions' | 'pep' | 'aml' | 'adverse_media' required
compliance_screening_numberstring nullable
sanctions_screening_datestring date-time nullable
scope'account_holder' | 'beneficial_owner' | 'counterparty' | 'payment_account' | 'transaction' required
match_countinteger nullable
false_positive_qualifier'none' | 'manual_override' | 'auto_suppressed'
screening_status'pending' | 'pass' | 'potential_match' | 'blocked' | 'escalated' required
manual_review_requiredboolean
aml_control_flagboolean nullable
screening_scorenumber nullable
screened_atstring date-time nullable
sanctions_screening_status'cleared' | 'pending' | 'match' | 'failed' nullable
legal_entity_idstring uuid nullable
reviewed_by_user_idstring uuid nullable
screening_rulesstring nullable
tenant_idstring uuid
screened_entity_type'individual' | 'company' | 'crypto_address' | 'payment_account' required
idstring uuid
payment_account_idstring uuid nullable
pep_indicatorboolean nullable
pep_list_namestring nullable
updated_atstring date-time
reviewed_atstring date-time nullable
aml_geographic_risk_flagboolean nullable
review_notesstring nullable
aml_risk_scorenumber nullable
screened_entity_namestring required
inserted_atstring date-time
escalation_levelinteger nullable

Example response

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

Changes

  • e99ccd17df53Revision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new beneficial_owner enum value to the response property for the response status

    • warning

      added the new crypto_address enum value to the response property for the response status

    • warning

      added the new payment_account enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status