Run Adverse Media Check

Example

To run an adverse media check on an entity, you will make this request:

Request

Method: POST
Endpoint: v1/adverse-media
Headers :

  {
    "apiKey" : [YOUR APP API_KEY],
    "apiSecret" : [YOUR APP API_SECRET],
    "Content-Type": "application/json"
  }  
  

Body:

  {
    "q": "Hushpuppi"
    "limit": 20
  }
  

Parameter	Type	Description
q	String	The name of the entity to check for adverse media
limit	Int	The max number of result

Response

After submitting your request, the success response you will receive can be seen below:

   {
    "message": "Request created successfully. Result will be sent to your webhook",
    "data": {
        "id": "66a383f5a8bd4e3d7e84b2c2",
        "query": "Hushpuppi",
        "businessProfile": "65291e39e37760c80f2e351c",
        "status": "pending",
        "createdAt": "2024-07-26T11:09:41.803Z",
        "updatedAt": "2024-07-26T11:09:41.803Z"
     }
   }
  

Parameter	Type	Description
message	String	Message from the server after hitting the request
data	Object	Contains information about the request
data.id	String	ID of the request
data.businessProfile	String	Business ID of the business
data.status	string	Status of the request
data.createdAt	string	Date the request was sent
data.updatedAt	string	Date the request was updated

Once your request is processed and a response is ready, a webhook will be sent to your pre-defined webhook URL.

Response

Go to webhooks to setup your webhook see possible responses from the request