Skip to content
Console(opens in a new tab)

Get negative news

Get recent negative news about each matched registered entity, in the POST response or through a background task you poll.

POSThttps://api.enigma.com/v2/kyb/?package=verify&attrs=negative_news

Look for recent news articles with negative sentiment about each registered entity Enigma matches. Add negative news to a Verify a business request, on either package, or to an attribute-only request: like every use case, it is one POST /v2/kyb/ request, and add-ons combine.

This request verifies Enigma Technologies and asks for negative news.

cURL
curl --request POST "https://api.enigma.com/v2/kyb/?package=verify&attrs=negative_news" \
--header "x-api-key: $ENIGMA_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"name": "Enigma Technologies",
"website": "https://enigma.com",
"address": {
"street_address1": "245 5th Ave",
"city": "New York",
"state": "NY",
"postal_code": "10016"
}
}'
x-api-keyheaderRequired

Your API key. Send it from your server only. See Authentication.

attrsqueryRequired

negative_news, or the same value in products. Must be enabled for your account. Values are case-sensitive, and a misspelled one is ignored without an error. See Query parameters.

Negative news has no body field of its own. Enigma looks up news for the registered entities it matches, so send the inputs in Send strong identifiers. All body fields are in Request body, and the rules in Validation.

The articles arrive in a top-level background_task object, not in data, because they can take longer than the rest of the response. Results that are ready when the POST returns are in the response, and you poll GET /v2/kyb/{task_id} for the rest.

background_task.idstring or null

The task ID to pass to GET /v2/kyb/{task_id}, or null when there is nothing to poll. See The background_task object.

background_task.statusstring

pending, complete or failed. See Status values.

background_task.subtasks[]array

The results that were ready when the POST returned, each in a media subtask whose legal_entity_id names the registered entity. Can be empty. See The media subtask.

background_task is absent when no registered entity matched or the news lookup failed for every matched entity. Negative news adds no task to risk_summary.tasks, so there is no result to branch on.

Topic Behavior
Where to request it attrs=negative_news with either package, or products=negative_news in an attribute-only request. Both can return background_task. In an attribute-only request, each registered entity holds only its id, and with top_n=1, risk_summary.tasks is empty.
Match count (top_n) Works at any top_n. Enigma looks up news for every registered entity in the response, so each one can get its own result. Other parts of the response change above 1; see When top_n is above 1.
Person-only screen Not available. A person-only screen accepts only attrs=watchlist.
Timing The POST waits for the news lookups to respond before it returns. Results that are not ready by then arrive through the background task.
  1. Read background_task in the POST response. When id is set, keep the subtasks and poll. See What the POST returns.
  2. Call GET /v2/kyb/{task_id} with that id, and poll with backoff until status is complete. The schedule and the failed case are in Poll for results.
  3. Merge the complete subtasks from the POST with the subtasks from the final GET, keyed by legal_entity_id. See Combine POST and GET results.
  4. Read each registered entity’s result. See Interpret the results.
  • A slower POST. The POST waits for the news lookups, and if a lookup runs past the request time limit, the whole POST can time out. See Timeouts.
  • No guaranteed retention. No retention period is guaranteed for a background task. Poll soon after the POST, and store the results you need. See Poll for results.
  • A missing result is not a clean result. A registered entity with no complete subtask carrying its id has no negative news result, which is not the same as no negative news. See Interpret the results.
  • Account enablement. Negative news is an add-on; see Account enablement.