API integration

Welcome to the guide for integrating your system with the Penneo API.

This section provides the essential steps and documentation links you need to manage your entire digital signing workflow, from case file creation to document retrieval.

We've organized the integration process into the following core phases:

  1. Authentication

Before interacting with any of our services, you must establish a secure connection. This section covers the necessary steps to authenticate your application and obtain the credentials required to make API calls.

You can read the full details in the Authentication section.

  1. Sending case files

This phase covers how to create and submit a signing package (a case file). We offer two distinct methods to accommodate your integration needs:

  1. Simple case file creation (recommended): For simplified, single-call ingestion of all required case file data.
  2. Direct case file creation: For granular, step-by-step creation of case files.

Learn more about the options in the Sending case files section.

  1. Monitoring case file status

Once a case file is sent for signing, you need to track its progress (e.g., from pending to completed). We support two strategies for receiving status updates:

  • Webhooks (recommended): Real-time, server-to-server notifications.
  • Polling: Client-initiated requests to check the status at regular intervals.

Details on both strategies are available in the Monitoring case file status section.

  1. Retrieving signed documents

Once a case file reaches the completed status, this section guides you through the process of obtaining the final, signed documents.

Find the full procedure in the Retrieving signed documents section.