---
title: "Check Collexus Sftp"
method: POST
path: "/integrations/collexus/sftp/check"
tags: ["integrations", "collexus"]
---

# Check Collexus Sftp

`POST /integrations/collexus/sftp/check`

## 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/sftp/check`
- Auth: one of:
  - OAuth 2
    - Password
    - Token URL: `auth/bearer/login`
  - API key in cookie `access_token`

Probe the Collexus SFTP server and report what came back.

The creditor's firewall admits only the deployment's NAT egress addresses,
so this has to run from inside the stack — and the image carries no ssh
client, so an admin route is the way to run it. It answers cleanly on a
deployment that has no Collexus configuration at all.

With no `COLLEXUS_SFTP_HOST_KEY` set the check runs in discovery mode: it
reports the server's fingerprint and the key line to pin, having
authenticated nothing and transferred nothing. Once pinned, a host key that
does not match aborts the connection and the check says so.

## Response `200`

Successful Response

- CollexusSftpCheckResponse: What one connection check learned, in the order a human reads it.
  - `status` 'ok' | 'discovery' | 'not_configured' | 'failed', required
  - `detail` string, required
  - `mode` 'pinned' | 'discovery', nullable
  - `host` string, nullable
  - `port` integer, nullable
  - `username` string, nullable
  - `missing_settings` string[]
  - `reachable` boolean
  - `host_key_pinned` boolean
  - `host_key_verified` boolean
  - `host_key_type` string, nullable
  - `host_key_fingerprint` string, nullable
  - `host_key_line` string, nullable
  - `authenticated` boolean
  - `inbound_path` string, nullable
  - `outbound_path` string, nullable
  - `inbound_entries` CollexusRemoteFileRead[], nullable
    - `filename` string, required
    - `size` integer, nullable
    - `modified_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)