The Dictionary Vetter Plugin performs Registry Person Vetting by submitting selected CO Person attributes via Descartes Visual Compliance's Restricted Party Screening API.

This plugin is experimental and may change across minor releases.


The Visual Compliance Vetter is instantiated via a Vetting Step. The plugin may be instantiated with different configurations for multiple Vetting Steps.

  1. Define a new Server, via COServersAdd a New Server.
    1. Type: HTTP
    2. Configure the HTTP Server in accordance with the information provided in the Restricted Party Screening documentation.
      1. Server URL: Enter the "POST JSON (REST)" URL for the appropriate service tier (Sandbox or Production)
      2. Username: Enter the "secno" provided by the vendor
      3. Password or Token: Enter the password provided by the vendor
      4. HTTP Authentication Type: Basic
  2. Add a new Vetting Step, via COConfigurationVetting Steps > (plus) Add Vetting Step.
    1. Select the Server created above.
    2. Attribute selection is not currently configurable.

Vetting Records

The Visual Compliance Vetter uses attributes associated with the CO Person record to construct a request against the Restricted Party Screening API. Behavior of this API is beyond the scope of this documentation.

Supported Attributes

  • Primary Name: The Primary Name associated with the subject CO Person.
  • Identity Documents: The first Issuing Authority of any Identity Document associated with the subject CO Person.
  • Organizations: The Name of the first Organization associated with any subject CO Person Role, and the Locality and State of the first Address associated with the Organization. Note this requires that CoPersonRole.o be configured to use an Attribute Enumeration associated with an Organization Dictionary.

The Visual Compliance Vetter Plugin makes two searches (in the same API request):

  1. CO Person Primary Name + Organization name (if found) + Organization locality (if found) + Organization state (if found)
  2. CO Person Primary Name + Identity Document issuing authority (if found)

Vetting Results

  • An API "maxalert" result of RedDouble Red, or Triple Red will cause a Failed Vetting result.
  • An API "maxalert" result of Yellow will cause a Manual Review Vetting result.
  • Otherwise, the Vetting result is Passed.