githubEdit

Run AMS Request

To run a search, execute the adverseMediaSearch mutation as below.

Search for an individual

const bodyJSON = {
  variables: {
    input: {
      firstName: "John",
      lastName: "Smith",
      country: "AU",
    },
  },
  query: `
mutation ($input: AmsRequestInput!) {
  adverseMediaSearch(input: $input) {
    success
    code
    message
    amsRequest {
      id
      status
    }
  }
}`,
};

Search for an organisation

Use accountName instead of individual name fields when screening a business or other non-person entity.

Name — firstName / lastName / middleName or accountName

For individuals, provide firstName and lastName. The optional middleName improves matching accuracy.

For organisations, use accountName instead. You cannot combine accountName with individual name fields.

circle-exclamation

Country — country

A two-letter ISO 3166-1 alpha-2 country code (e.g. AU, US, GB). This is required and used to contextualise results — articles where the detected location does not match the supplied country are flagged via locationMismatch.

Background scan — tracking progress

The scan runs in the background and may take several minutes. The mutation returns immediately with status: INITIALISED. Use the returned id to poll for results or subscribe to webhook events to be notified when the scan progresses.

Webhook events fired during a scan:

Event
Status

ams_initialised

INITIALISED

ams_pending

PENDING

ams_completed

COMPLETED

ams_failed

FAILED

See AMS statuses for the full lifecycle.

Deduplication

If you submit a search for the same name and country more than once within the same calendar day, the existing request is returned rather than creating a new one. The code field indicates whether the scan was newly scheduled or is already in progress or complete:

Code
Meaning

SCAN_SCHEDULED

New scan created and queued

SCAN_ALREADY_SCHEDULED

A scan for this name and country is already in progress today

SCAN_ALREADY_COMPLETED

A completed scan for this name and country already exists today

Monthly request limit

A free monthly limit applies to AMS requests. Once reached, success: false is returned with code: LIMIT_EXCEEDED. Contact support to increase your limit.

Last updated

Was this helpful?