# Query AMS requests

#### Retrieving a single AMS request

Use the `amsRequest` query with the `id` returned from the `adverseMediaSearch` mutation to check the status of a scan or retrieve its results.

{% tabs %}
{% tab title="JavaScript" %}

```javascript
const bodyJSON = {
  variables: {
    id: "6820a4f3e1c2b5d8f0123456",
  },
  query: `
query ($id: ID!) {
  amsRequest(id: $id) {
    id
    name
    country
    status
    createdAt
    results {
      title
      link
      adversityScore
      personSimilarity
      summary
    }
  }
}`,
};
```

{% endtab %}

{% tab title="GraphQL Query" %}

```graphql
query($id: ID!) {
  amsRequest(id: $id) {
    id
    name
    country
    status
    createdAt
    results {
      title
      link
      adversityScore
      personSimilarity
      summary
      # there are many other result fields
    }
  }
}
```

{% endtab %}

{% tab title="Variables" %}

```json
{
  "id": "6820a4f3e1c2b5d8f0123456"
}
```

{% endtab %}

{% tab title="Response" %}

```json
{
  "data": {
    "amsRequest": {
      "id": "6820a4f3e1c2b5d8f0123456",
      "name": "John Smith",
      "country": "AU",
      "status": "COMPLETED",
      "createdAt": "2025-03-15T08:23:14.521Z",
      "results": [
        {
          "title": "Local businessman John Smith fined for tax evasion",
          "link": "https://example-news.com.au/articles/smith-tax",
          "adversityScore": 72,
          "personSimilarity": 85,
          "summary": "John Smith of Sydney was fined $45,000 for understating income over three financial years."
        }
      ]
    }
  }
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
The `results` field is populated only once the scan reaches `COMPLETED` status. While the scan is `INITIALISED` or `PENDING`, `results` will be `null`.
{% endhint %}

#### Retrieving all your AMS requests

{% tabs %}
{% tab title="JavaScript" %}

```javascript
const bodyJSON = {
  variables: {
    input: {},
  },
  query: `
query ($input: AmsQueryInput) {
  amsRequests(input: $input) {
    id
    name
    country
    status
    createdAt
  }
}`,
};
```

{% endtab %}

{% tab title="GraphQL Query" %}

```graphql
query($input: AmsQueryInput) {
  amsRequests(input: $input) {
    id
    name
    country
    status
    createdAt
    # there are many other properties
  }
}
```

{% endtab %}

{% tab title="Variables" %}

```json
{
  "input": {}
}
```

{% endtab %}

{% tab title="Response" %}

```json
{
  "data": {
    "amsRequests": [
      {
        "id": "6820a4f3e1c2b5d8f0123456",
        "name": "John Smith",
        "country": "AU",
        "status": "COMPLETED",
        "createdAt": "2025-03-15T08:23:14.521Z"
      },
      {
        "id": "6820b1d9c3f4a7e2d0987654",
        "name": "Acme Pty Ltd",
        "country": "AU",
        "status": "PENDING",
        "createdAt": "2025-03-15T09:01:44.008Z"
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

#### Filtering AMS requests

Use the `input` parameter to narrow results by status, date range, or name.

{% tabs %}
{% tab title="JavaScript" %}

```javascript
const bodyJSON = {
  variables: {
    input: {
      statuses: ["COMPLETED"],
      minCreatedAt: "2025-03-01T00:00:00.000Z",
      maxCreatedAt: "2025-04-01T00:00:00.000Z",
      country: "AU",
    },
  },
  query: `
query ($input: AmsQueryInput) {
  amsRequests(input: $input) {
    id
    name
    country
    status
    createdAt
  }
}`,
};
```

{% endtab %}

{% tab title="GraphQL Query" %}

```graphql
query($input: AmsQueryInput) {
  amsRequests(input: $input) {
    id
    name
    country
    status
    createdAt
  }
}
```

{% endtab %}

{% tab title="Variables" %}

```json
{
  # there are more filter parameters available, see the API schema
  "input": {
    "statuses": ["COMPLETED"],
    "minCreatedAt": "2025-03-01T00:00:00.000Z",
    "maxCreatedAt": "2025-04-01T00:00:00.000Z",
    "country": "AU"
  }
}
```

{% endtab %}

{% tab title="Response" %}

```json
{
  "data": {
    "amsRequests": [
      {
        "id": "6820a4f3e1c2b5d8f0123456",
        "name": "John Smith",
        "country": "AU",
        "status": "COMPLETED",
        "createdAt": "2025-03-15T08:23:14.521Z"
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}

Available filter fields on `AmsQueryInput`:

| Field          | Description                                                   |
| -------------- | ------------------------------------------------------------- |
| `statuses`     | Filter by one or more AMS statuses                            |
| `minCreatedAt` | Return only requests created after this timestamp (ISO 8601)  |
| `maxCreatedAt` | Return only requests created before this timestamp (ISO 8601) |
| `firstName`    | Filter by first name — case insensitive, partial match        |
| `middleName`   | Filter by middle name — case insensitive, partial match       |
| `lastName`     | Filter by last name — case insensitive, partial match         |
| `accountName`  | Filter by business name — case insensitive, partial match     |
| `country`      | Filter by two-letter ISO country code                         |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.flash-payments.com/compliance/adverse-media-search/query-ams-requests.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.