Quickstart for customers

Authenticate and walk the signature workflow from lookup through create, track, update, and retract.

SutureHealth and its integrations are on the home page. What this API allows and the request path are in the Partner API overview. This page is how you authenticate and reach the sandbox.

Prerequisites

  • An API key from SutureHealth Support. The key is tied to a user in one organization.
    • If you send documents for multiple organizations, request and store a unique API key per organization.
  • Sandbox access with a sender user and a signer user (created by the SutureHealth team).
  • Document ingestion enabled for the sender organization. Create Task cannot deliver documents without it.

Environments

Health

Confirm connectivity before you send a key. Health lives on the host root, not under /api/v1, and does not require x-api-key.

GET /health-check
Host: partner-api.demo.suturehealth.com

Sandbox: https://partner-api.demo.suturehealth.com/health-check

Production: https://partner-api.suturehealth.com/health-check

A healthy host returns 200.

Using the API

Send the key in the x-api-key header. The API version is in the path (v1). Every endpoint except health requires the key. Missing or invalid keys return 401 or 403.

GET /api/v1/documenttypes
Host: partner-api.demo.suturehealth.com
x-api-key: YOUR_API_KEY

Typical workflow

  1. Look up document types, templates, and the signer’s NPI.
  2. Request a signature with Create Task.
  3. Prefer status webhooks for updates; use read / list for the PDF and as a fallback.
  4. Update a completed task with your saved-document id, or retract it while it is still pending.

Field-level request and response schemas live in the API Reference.


Did this page help you?