Screen Names
screen_namesAudit-ready sanctions screening of 1 to 100 names against 10 official lists. The response includes a record id, the snapshot version, the data-as-of date for each source list, and the matching engine version. Each screened name costs one credit. Hits are candidates for human review and require further assessment.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| names | Yes | A list of 1 to 100 names to be screened. | |
| threshold | No | An optional minimum score from 0.6 to 1; only hits at or above this score are returned. | |
| idempotency_key | No | An optional key to prevent duplicate screenings. A retry with the same key within 24 hours returns the stored record and charges no credits. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||