Pigeon // E-Sign
  1. Schemas
Pigeon // E-Sign
  • Introduction
  • Authentication
  • Integrations
  • Documents
    • List Documents
    • Create Document
    • Get Document Status
    • Delete Document
    • Update Document
    • Update Document Status
    • Move Document to Draft
    • Get Document Details
    • Send Document
    • Create Document Session
    • Download Document
    • Download Protected Document
    • Update Document Ownership
    • Transfer Documents Ownership
  • Document Attachments
    • Document Attachment List
    • Document Attachment Create
    • Document Attachment Details
    • Document Attachment Delete
    • Document Attachment Download
  • Document Generation
    • List Document Fields
    • Create Document Fields
  • Document Recipients
    • Add Document Recipient
    • Edit Document Recipient
    • Delete Document Recipient
    • Reassign Document Recipient
  • 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
  • Schemas
    • Sample Schemas
      • Pet
      • Category
      • Tag
    • Schemas
      • BulkSendList
      • BulkSendItem
      • OrganizationBranding
      • CloudStorageServices
      • CloudStorageProvider
      • DocumentGenerationFormField
      • OAuth2CreateAccessTokenRequest
      • OAuth2RefreshAccessTokenRequests
      • OAuth2AccessTokenResponse
      • DocumentListResponse
      • DocumentCreateByTemplateRequest
      • DocumentCreateByPdfRequest
      • DocumentCreateRequest
      • DocumentCreateResponse
      • DocumentStatusResponse
      • DocumentUpdateRequest
      • DocumentStatusChangeRequest
      • DocumentDetailsResponse
      • DocumentCreateLinkRequest
      • DocumentCreateLinkResponse
      • DocumentSendRequest
      • DocumentSendResponse
      • DocumentAttachmentRequest
      • DocumentAttachmentResponse
      • DocumentTransferOwnershipRequest
      • DocumentTransferAllOwnershipRequest
      • DocumentRecipientCreateRequest
      • DocumentRecipientEditRequest
      • DocumentRecipientResponse
      • TemplateListResponse
      • TemplateDetailsResponse
      • ContactDetailsResponse
      • ContactListResponse
      • ContactCreateRequest
      • ContactUpdateRequest
      • MemberDetailsResponse
      • MemberListResponse
      • DocumentStatusEnum
      • DocumentStatusRequestEnum
      • DocumentOrderingFieldsEnum
      • Field
      • CreateDocumentActor
      • Recipient
      • RecipientGroup
      • Recipient
      • RecipientGroup
      • BaseField
      • Checkbox
      • Collect File
      • Date
      • Dropdown
      • Initials
      • Radio Buttons
      • Signature
      • Stamp
      • Text
      • Recipient
      • Recipient Group
      • WebhookSubscriptionPayloadEnum
      • WebhookSubscriptionTriggerEnum
      • WebhookSubscriptionStatusEnum
      • WebhookSubscriptionCreateRequest
      • WebhookSubscriptionPatchRequest
      • WebhookSubscriptionItemResponse
      • WebhookSubscriptionSharedKeyResponse
      • WebhookSubscriptionListResponse
      • WebhookEventErrorEnum
      • WebhookEventHttpStatusCodeGroupEnum
      • WebhookEventTriggerEnum
      • WebhookEventItemResponse
      • WebhookEventDetailsResponse
      • WebhookEventPageResponse
      • UploadSectionByPdfRequest
      • UploadSectionByTemplateRequest
      • UploadSectionRequest
      • UploadSectionListResponse
      • UploadSectionResponse
      • UploadSectionStatusResponse
      • UploadSectionStatusEnum
      • SectionInfoResponse
      • RecipientVerificationSettings
      • RecipientRedirect
      • RecipientDeliveryMethods
      • CreateWorkspaceRequest
      • CreateWorkspaceResponse
      • CreateUserRequest
      • CreateUserResponse
      • AddMemberRequest
      • AddMemberResponse
      • ListUsersResponse
      • ListWorkspacesResponse
      • Recipient
      • Recipient Group
    • Response
      • 401
      • 403
      • 404
      • 409
      • 429
      • 400RequestError
      • 400ValidationError
  1. Schemas

DocumentDetailsResponse

{
    "id": "7kqXgjFejB2toXxjcC5jfZ",
    "name": "API Sample Document from Pigeon Template",
    "autonumbering_sequence_name_prefix": "string",
    "date_created": "2021-10-23T21:07:04.147345Z",
    "date_modified": "2021-10-23T21:07:04.147345Z",
    "date_completed": "2021-10-23T21:07:04.147345Z",
    "content_date_modified": "2021-10-23T21:07:04.147345Z",
    "date_sent": "2021-10-23T21:07:04.147345Z",
    "ref_number": "MTMJR-FEUQB-ECEWW-3WVZP",
    "created_by": {
        "id": "7kqXgjFejB2toXxjcC5jfZ",
        "membership_id": "7kqXgjFejB2toXxjcC5jfZ",
        "email": "teset@test.test",
        "first_name": "Jhon",
        "last_name": "Dow",
        "avatar": "https://pd-live-media.s3.amazonaws.com/users/000GTSGwJw000L2KZqc000/avatar.jpg"
    },
    "template": {
        "id": "hryJY9mqYZHjQCYQuSjRQg",
        "name": "Upload test"
    },
    "expiration_date": "string",
    "metadata": {
        "document__created_via_public_api": "true",
        "my_favorite_pet": "Panda",
        "opp_id": "1234567"
    },
    "tokens": [
        {
            "name": "Document.GrandTotal",
            "value": "$29.99"
        },
        {
            "name": "Favorite.Pet",
            "value": "Panda"
        }
    ],
    "fields": [
        {
            "uuid": "f9574c3b-5b1e-4479-b2c9-c3ccd92748f3",
            "name": "Click to upload a file",
            "title": "",
            "placeholder": "Click to upload a file",
            "value": {
                "name": "file_name.pdf",
                "url": "https://uploadfields.pandadoc-static.com/collect_files/e7b082c2-395b-43c7-a24c-66bd1bbb5d2f/65af1f23-9d26-4622-8ff0-f406b3be27b8-file_name.pdf"
            },
            "assigned_to": {
                "id": "Fx7CgaVgpGbJBgZ4i5oTx8",
                "first_name": "John",
                "last_name": "Roe",
                "email": "john@example.com",
                "recipient_type": "signer",
                "has_completed": false,
                "role": "",
                "roles": [
                    "singer"
                ],
                "type": "recipient"
            },
            "field_id": "CollectFile1",
            "type": "collect_file"
        },
        {
            "uuid": "f9574c3b-5b1e-4479-b2c9-c3ccd92748f3",
            "name": "Favorite.Color",
            "merge_field": "Favorite.Color",
            "title": "Textfield",
            "value": "value",
            "assigned_to": {
                "id": "Fx7CgaVgpGbJBgZ4i5oTx8",
                "name": "Group 2",
                "email": "group2@example.com",
                "recipient_type": "signer",
                "has_completed": false,
                "roles": [],
                "type": "recipient_group",
                "members": {
                    "id": "4b011d86-286b-4f86-b697-90a6ad3f1489",
                    "email": "john@example.com",
                    "first_name": "John",
                    "last_name": "Doe"
                }
            },
            "field_id": "text1",
            "type": "text"
        },
        {
            "uuid": "M4755SJuoyz5Jzsw4WXTDb",
            "name": "Like",
            "merge_field": "Like",
            "title": "Checkbox",
            "value": "value",
            "assigned_to": {
                "id": "Fx7CgaVgpGbJBgZ4i5oTx8",
                "first_name": "John",
                "last_name": "Roe",
                "email": "john@example.com",
                "recipient_type": "signer",
                "has_completed": false,
                "role": "",
                "roles": [
                    "signer"
                ],
                "type": "recipient"
            },
            "field_id": "checkbox1",
            "type": "checkbox"
        }
    ],
    "version": "2",
    "tags": [
        "tag1",
        "tag2"
    ],
    "sent_by": "string",
    "recipients": [
        {
            "id": "7kqXgjFejB2toXxjcC5jfZ",
            "recipient_type": "CC",
            "role": "",
            "roles": [
                "user"
            ],
            "signing_order": 1,
            "email": "test@test.com",
            "has_completed": true,
            "last_name": "Dow",
            "contact_id": "7kqXgjFejB2toXxjcC5jfZ",
            "first_name": "Jhon",
            "phone": "+14842634627",
            "delivery_methods": {
                "email": true,
                "sms": false
            },
            "shared_link": "https://app.pigeondocuments.com/document/b7f11ea3c09d1c11208cc122457d4f3a2829d364",
            "signature_date": "2021-10-23T21:07:04.147Z",
            "verification_settings": {
                "verification_place": "before_open",
                "passcode_verification": {
                    "passcode": "SimpleCode1"
                },
                "phone_verification": {
                    "phone_number": "+1234567890"
                }
            },
            "redirect": {
                "is_enabled": true,
                "url": "https://example.com"
            },
            "avatar": "https://pd-live-media.s3.amazonaws.com/users/000GTSGwJw000L2KZqc000/avatar.jpg",
            "type": "recipient"
        }
    ],
    "status": "document.draft"
}