Pigeon API // Staging
  1. Documents
Pigeon API // Staging
  • Introduction
  • Authentication
  • Integrations
  • Guides
    • Using Third-Party Cloud Storage
  • Requests
    • Requests
    • Create Request
      POST
    • List Requests
      GET
    • Get Request
      GET
    • List Organization Requests
      GET
    • Update Request
      PATCH
    • Delete Request
      DELETE
  • Documents
    • Documents
    • Get Document
      GET
    • Delete Document
      DELETE
    • List Request Documents
      GET
    • Delete Request Documents
      DELETE
    • List Request Item Documents
      GET
    • Download Document
      GET
    • Download Request Documents
      GET
    • Download Request Item Documents
      GET
  • Templates
    • Templates
    • List Templates
      GET
    • Create Template
      POST
    • Get Template
      GET
    • Update Template
      PATCH
    • Delete Template
      DELETE
    • List Organization Templates
      GET
  • RequestItems
    • Request Items
    • Create Request Item
    • List Request Items
    • Get Request Item
    • Update Request Item
    • Delete Request Item
    • Verify Request Item
  • Webhooks
    • Webhooks
    • Create Webhook Subscription
    • List Webhook Subscriptions
    • Get Webhook Subscription
    • Update Webhook Subscription
    • Delete Webhook Subscription
    • Get Webhook Signing Secret
  • Users
    • Get Current User
    • List Users
    • List Organization users
  • Contacts
    • List Contacts
    • Create or Update Contact
    • List Organization Contacts
  • Teams
    • List Teams
    • Get Team
  • Schemas
    • Schemas
      • CreateAuthMethod
      • CreateQuestionItem
      • RequestState
      • ResourceNotFoundModel
      • StorageProviders
      • SessionPayload
      • TEMPLATENotFoundModel
      • TEMPLATENotFoundModel
      • ORGANIZATIONNotFoundModel
      • ORGANIZATIONNotFoundModel
    • AuthMethod
    • CollaboratorPublic
    • CreateRecipientPostParams
    • ConnectionProvider
    • CreateRequestItem
    • CreateRequestPostParams
    • CreateRequestRecipient
    • CreateTemplatePostParams
    • CreateWebhookWithoutOrg
    • HTTPValidationError
    • DocumentNotFound
    • ItemType
    • DocumentPublic
    • FilenameFormat
    • RequestItemPublic
    • OrganizationNotFound
    • DocumentType
    • DocumentWithItemPublic
    • RequestPublic
    • RequestItemNotFound
    • RequestRecipientPublic
    • RequestNotFound
    • Language
    • RequestStatus
    • SendMethod
    • TemplatePublic
    • SortOrder
    • SessionPayloadPublic
    • TemplateNotFound
    • RecipientPublic
    • UpdateRequestItem
    • TeamNotFound
    • UpdateRequestPostParams
    • TeamPublic
    • UpdateTemplate
    • UpdateWebhook
    • UserRole
    • ValidationError
    • WebhookPublic
    • WebhookTopic
    • WebhookPublicWithSecret
    • WebhookNotFound
    • UserPublic
  1. Documents

Documents

Overview#

Documents represent files submitted by recipients to complete a Request Item. Pigeon supports a number of different document types that match the requirements of the associated Request Item.

Document Types#

File#

A File document represents a file uploaded for a Standard Upload Request Item.

E-Signature#

An E-Signature document represents the signed e-signature document completed for an E-Signature Request Item.

Question#

A Question document represents a file that is used to securely store the answer to a Question Request Item. The answer to a Question item can also be accessed via the Request Item's answer field.
Modified at 2025-02-12 17:23:25
Previous
Delete Request
Next
Get Document
Built with