Pigeon // E-Sign
    Pigeon // E-Sign
    • Introduction
    • Authentication
    • Integrations
    • Documents
      • List Documents
        GET
      • Create Document
        POST
      • Get Document Status
        GET
      • Delete Document
        DELETE
      • Update Document
        PATCH
      • Update Document Status
        PATCH
      • Move Document to Draft
        POST
      • Get Document Details
        GET
      • Send Document
        POST
      • Create Document Session
        POST
      • Download Document
        GET
      • Download Protected Document
        GET
      • Update Document Ownership
        PATCH
      • Transfer Documents Ownership
        PATCH
    • Document Attachments
      • Document Attachment List
        GET
      • Document Attachment Create
        POST
      • Document Attachment Details
        GET
      • Document Attachment Delete
        DELETE
      • Document Attachment Download
        GET
    • Document Generation
      • List Document Fields
        GET
      • Create Document Fields
        POST
    • Document Recipients
      • Add Document Recipient
        POST
      • Edit Document Recipient
        PATCH
      • Delete Document Recipient
        DELETE
      • Reassign Document Recipient
        POST
    • Bulk Send
      • Trigger Bulk Send
      • Create Bulk Send List
      • Get Bulk Send List
      • Get Bulk Send Lists
      • Update Bulk Send List
      • Delete Bulk Send List
    • Templates
      • List Templates
      • Create Template
      • Template Details
      • Delete Template
    • Cloud Storage
      • List Cloud Storage Providers
      • Connect Cloud Storage Providers
      • Disconnect Cloud Storage Provider
    • Webhooks
      • Get all webhook subscriptions
      • Create webhook subscription
      • Get webhook subscription by uuid
      • Update webhook subscription
      • Delete webhook subscription
    • Branding
      • Get Organization Branding
      • Update Organization Branding
    • Confirmation Page
      • Enable/Disable Signature Confirmation Page

    Authentication

    API Access#

    To gain access to the Pigeon API, you must be subscribed to a paid Pigeon API plan. Upon subscription, we'll provide a live API key which can be used to authenticate with the production API.

    API Authentication#

    The Pigeon API uses API keys to authenticate requests.
    To authenticate an API request, specify your API key in the X-API-KEY request header:
    All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
    Your API keys carry many privileges, so be sure to keep them secure. Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
    Modified at 2024-09-17 21:47:21
    Previous
    Introduction
    Next
    Integrations