Sign in
Compliance Screening

Preview-screen an account holder (stateless)

Changed on

Stateless preview screen of an AccountHolderRequest (with inline legal_entity). No DB writes. Returns an unsaved ComplianceScreeningResponse.

post/api/compliance-screenings/screen-account-holder

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/compliance-screenings/screen-account-holder
  • Auth: none required

Request body

account_holder_numberstring nullable
account_holder_type'individual' | 'business' | 'trust' | 'nonprofit' required
chain_screeningboolean

When true (default), enqueues a compliance screening job after creation. Set to false to skip.

enabled_currenciesstring[] nullable
enabled_regimesstring[] nullable
external_idstring nullable
kyc_status'not_started' | 'in_progress' | 'approved' | 'rejected' | 'expired' nullable
last_reviewed_atstring date-time nullable
onboarded_atstring date-time nullable
risk_level'low' | 'medium' | 'high' | 'very_high' | 'prohibited' nullable
status'pending' | 'active' | 'suspended' | 'closed' | 'flagged' nullable
tenant_idstring uuid

Example request

{
  "account_holder_number": "",
  "account_holder_type": "individual",
  "chain_screening": false,
  "enabled_currencies": [
    ""
  ],
  "enabled_regimes": [
    ""
  ],
  "external_id": "",
  "kyc_status": "not_started",
  "last_reviewed_at": "2020-04-20T16:20:00Z",
  "legal_entity": null,
  "onboarded_at": "2020-04-20T16:20:00Z",
  "risk_level": "low",
  "status": "pending",
  "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6"
}

Response

Compliance screenings (paginated list response)

Example response

{
  "data": [
    {
      "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
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 50,
    "total_count": 125,
    "total_pages": 3
  }
}

Changes

  • e99ccd17df53Revision changes
    • breaking

      added the new required request property

    • breaking

      the response's body type changed from array to object for status

    • 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 optional 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 optional 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 optional request property

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status