---
title: "List purchase scanner emails"
method: GET
path: "/companies/{company}/purchase-scan-emails"
tags: ["Purchase Scan Emails"]
---

# List purchase scanner emails

`GET /companies/{company}/purchase-scan-emails`

## Request

- Base URL: `https://api.factuarea.com/v1`
- URL: `https://api.factuarea.com/v1/companies/{company}/purchase-scan-emails`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

List the emails received in the purchase scanner mailbox with sender, subject, accepted and rejected attachments and ingestion result. Search by sender or subject and filter by ingestion result or date range; cursor-based pagination.

## Path parameters

- `company` string, uuid, required

## Query parameters

- `limit` integer
- `starting_after` string, uuid, nullable
- `search` string
- `result` string: Comma-separated list of email results. Allowed values: pending, processed, partially_processed, no_compatible_attachments, parked, rejected, failed.
- `created[gte]` string, date
- `created[lte]` string, date

## Headers

- `Factuarea-Version` string, date

## Response `200`

Successful scanner operation.

- object
  - `data` PurchaseScanEmail[], required
    - `id` string, uuid, required
    - `sender` string, required
    - `subject` string, nullable, required
    - `received_at` string, date-time, required
    - `result` 'pending' | 'processed' | 'partially_processed' | 'no_compatible_attachments' | 'parked' | 'rejected' | 'failed', required: pending while the attachments are still being ingested; parked when the sender is not allowlisted or fails SPF/DKIM/DMARC authentication (no scan is created).
    - `reason` 'sender_not_allowlisted' | 'sender_authentication_failed' | 'sender_authentication_unavailable' | 'too_many_attachments' | 'module_inactive' | 'read_only' | 'scanner_disabled' | 'processing_failed' | 'null', nullable, required: Why the email was parked, rejected or failed; null for any other result.
    - `sender_authentication` object, nullable, required: SPF/DKIM/DMARC verdict computed by the receiving server, or null when it was never evaluated.
      - `spf` 'pass' | 'fail' | 'softfail' | 'neutral' | 'none' | 'temperror' | 'permerror', required
      - `dkim` 'pass' | 'fail' | 'softfail' | 'neutral' | 'none' | 'temperror' | 'permerror', required
      - `dmarc` 'pass' | 'fail' | 'softfail' | 'neutral' | 'none' | 'temperror' | 'permerror', required
      - `alignment` 'aligned' | 'misaligned' | 'unknown', required
    - `accepted_attachments` object[], required
      - `filename` string, required
      - `sha256` string, required
      - `scan_id` string, uuid, required
    - `rejected_attachments` object[], required
      - `filename` string, required
      - `code` string, required
      - `message` string
  - `has_more` boolean, required
  - `next_cursor` string, uuid, nullable, required

## Other responses

- `400`: The operation failed. Possible `error.code` values: `parameter_unknown` — the query contains a parameter this operation does not accept.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`). `company_inactive`: the company in the path is deactivated; reactivate it to operate.
- `404`: The requested resource does not exist or belongs to another company. `profile_not_found`: the company in the path does not exist, is not in the API key scope or belongs to the other environment (live or test).
- `422`: The request could not be validated. Possible `error.code` values: `invalid_param_value` — a recognized query parameter has an invalid value.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)