Overview

What this API allows

The Partner API is how a sender system puts work onto the SutureHealth network and reads it back.

With an API key for your organization you can:

• Confirm a provider is an active signer on SutureHealth by NPI
• List the document types and templates available to your org
• Create a signature task: patient, signer, PDF, and the fields they must complete
• Read that task by id (or list many) until it is pending, signed, rejected, retracted, or failed
• Receive status webhooks when a task changes status (preferred over tight polling)
• Download the signed PDF when the task completes
• Retract a task that is still waiting in the inbox, or record your saved-document id after you store the outcome

Signing and rejecting happen in SutureHealth Inbox. This API does not sign or reject on the provider’s behalf, and it does not support multiple signers on one task.

Keys, hosts, and health are in Quickstart for customers. Payload detail is in Requesting a document signature.

How a signature request works

Your system checks the signer and creates the task. The Partner API places the request in Inbox, a webhook notifies you at Pending, the provider signs, another webhook notifies Completed, and you GET the task for the signed PDF.

sequenceDiagram
  actor You as Your system
  participant API as Partner API
  participant Inbox as SutureHealth Inbox
  actor Signer as Signer

  You->>API: GET /users/providers/{npi}
  API-->>You: 200 active signer

  You->>API: POST /signature/tasks
  API-->>You: 201 taskId, Received

  API->>Inbox: Create signature request
  Inbox->>Signer: Document ready to sign

  API-->>You: Webhook status=Pending

  Signer->>Inbox: Signs

  API-->>You: Webhook status=Completed
  You->>API: GET /signature/tasks/{id}
  API-->>You: Completed, signed PDF

Next