---
title: "Run Collexus Ingest"
method: POST
path: "/integrations/collexus/ingest/run"
tags: ["integrations", "collexus"]
---

# Run Collexus Ingest

`POST /integrations/collexus/ingest/run`

## Request

- Base URL: `https://dev.whispa.net` (the document declares no server; this is the origin it was published from)
- URL: `https://dev.whispa.net/integrations/collexus/ingest/run`
- Auth: one of:
  - OAuth 2
    - Password
    - Token URL: `auth/bearer/login`
  - API key in cookie `access_token`

Start one poll of the creditor's folder, importing the newest account file.

One tick of the scheduled ingest, on request: the same import path, the
same ledger, the same refusal to read anything while no host key is
pinned. It works with the import schedule off, and never arms the
account-file freshness gate — so the exchange can be proved with a single
file without dialling starting to depend on the next one.

It answers at once and the poll runs in the background: a creditor's whole
book takes longer to import than the load balancer keeps a request open.
The outcome lands on the run, which ``/status`` reports as ``ingest_run``.

## Response `200`

Successful Response

- CollexusIngestRunResponse: The answer to "import the latest file now": started, or why not. It comes back at once. The import's outcome is on ``run``, and on the exchange status, once the poll finishes.
  - `status` 'started' | 'busy' | 'not_configured' | 'untrusted', required
  - `detail` string, required
  - `run` CollexusIngestRunRead: One import an admin asked for, as it stands now.
    - `id` string, uuid, required
    - `status` 'running' | 'imported' | 'nothing_new' | 'failed' | 'busy', required
    - `detail` string, nullable
    - `listed` integer
    - `imported` integer
    - `superseded` integer
    - `failed` integer
    - `accounts` integer
    - `unrecognised_statuses` CollexusUnrecognisedStatus[]
      - `status` string, required
      - `count` integer, required
    - `started_at` string, date-time, required
    - `finished_at` string, date-time, nullable

---

[API](https://skmtc.dev/whispa/apis/whispa-api.md) - [All operations](https://skmtc.dev/whispa/apis/whispa-api/llms.txt) - [OpenAPI document](https://skmtc.dev/whispa/apis/whispa-api/revisions/12c2e4aca43c?raw)