Introduction

SSHVerify offers a REST API for creating and managing SSH key collection and verification sessions. Use the API when you want to automate session creation, attach sessions to your own users or devices, and receive results through webhooks.

For the complete endpoint reference, request and response schemas, and interactive examples, see the API Reference.

Base URL

The public REST API is available under:

https://sshverify.com/api/v1

Authentication

Send your project API key in the x-api-key header:

curl https://sshverify.com/api/v1/auth/info/ \
  -H "x-api-key: <api-key>"

API keys are scoped to one project. API requests made with a key can only access resources in that project.

Main resources

Resource	Endpoints
API key info	GET /auth/info/
Collection sessions	/ssh/collect/sessions/
Collection webhooks	/ssh/collect/sessions/{session}/webhooks/
Verification sessions	/ssh/verify/sessions/
Verification webhooks	/ssh/verify/sessions/{session}/webhooks/

Rate limiting

Projects are limited to 500 API requests per hour. When the limit is exceeded, the API responds with 429 Too Many Requests.

Example

Create a collection session:

curl https://sshverify.com/api/v1/ssh/collect/sessions/ \
  -H "content-type: application/json" \
  -H "x-api-key: <api-key>" \
  -d '{
    "external_id": "user_123",
    "multi_key": true,
    "multi_connection": false,
    "must_confirm": false
  }'