This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock
- Introduction
- Concepts
- Authentication
- MCP server
- MCP tools
- Webhooks
- Envelope lifecycle
- Error handling
- Quickstart
- Vaults
- Pagination
- Signer states
- Sandbox
- Retries and idempotency
- Versioning
- Blockchain anchoring
- Contact
- Document
- Envelope
- Get envelope certificate file
- Process envelope certificate
- Download an attachment uploaded by a signer
- Get envelope blockchain anchors
- Download a signer's simple-selfie image
- Remove envelope
- List available envelope owners
- Create envelope access link
- Rename envelope
- List envelope access links
- Move envelope
- Get envelope
- Publish envelope
- Update envelope
- Unschedule envelope publication
- Hold envelope
- Cancel envelope
- Create envelope
- Restore envelope
- Manual reinvite to review envelope
- Change envelope user account owner
- Revoke envelope access link
- Download the anchor receipt
- Get signer evidence images
- Get access link address
- Get access link password
- List envelopes
- List pending envelopes
- List envelope accesses of the account
- Create signature link
- List envelope accesses
- Issue signature link
- Template
- Vault
- Raiz
- Seal
- AccessPolicy
- Account
- Invite
- Report
- Signer
- UserAccount
- Webhook
- WebhookReport
- Schemas
- Schemas
- BadRequestApiResponse
- AccessPolicyApiResponse
- BadRequestApiResponseError
- ChangeEnvelopeUserAccountOwnerApiRequest
- CreateContactApiRequest
- BlockchainActivityApiResponse
- CreateContactApiResponse
- BlockchainActivityApiResponseItem
- CreateDocumentFromTemplateApiRequest
- BlockchainByTypeApiResponse
- CreateDocumentFromTemplateApiResponse
- BlockchainEventTypeApiResponseItem
- CreateDocumentFromTemplateFieldApiRequest
- BlockchainStatCardsApiResponse
- CreateDocumentFromTemplatePageSizeApiResponse
- CreateEnvelopeApiRequest
- CreateEnvelopeApiResponse
- CreateEnvelopeDocumentApiRequest
- CreateEnvelopeSignerApiRequest
- CreateEnvelopeSignerSignMarkApiRequest
- CreateSignatureLinkApiResponse
- CreateEnvelopeAccessLinkApiRequest
- CreateTemplateApiRequest
- CreateEnvelopeAccessLinkApiResponse
- CreateTemplateApiResponse
- CreateTemplateFieldApiRequest
- ForbiddenApiResponse
- CreateVaultApiRequest
- GetContactApiResponse
- CreateVaultApiResponse
- GetDocumentOriginalFileUrlApiResponse
- GetDocumentSignedFileUrlApiResponse
- GetEnvelopeAnchorsApiResponse
- GetAccessPolicyApiResponse
- GetEnvelopeAnchorsApiResponseBatch
- DocumentPageSizeApiResponse
- GetEnvelopeApiResponseDocumentPageSize
- EnvelopeAccessLogApiResponseItem
- GetEnvelopeApiResponseSeal
- EnvelopeAccessLogApiResponseLink
- GetEnvelopeApiResponseDocument
- EnvelopeAccessLogApiResponseLocation
- EnvelopeAccessLogApiResponseWho
- GetEnvelopeCertificateFileApiResponse
- GetTemplateApiResponse
- GetEnvelopeApiResponseSigner
- GetTemplateFieldApiResponse
- GetEnvelopeApiResponseAccessPolicy
- GetAccountApiResponse
- GetAccountApiResponseAccountInformation
- GetVaultMembersApiResponse
- GetAccountApiResponseBalanceInformation
- GetVaultMembersApiResponseItem
- GetAccountApiResponseSubscriptionInformation
- GetVaultOwnersApiResponse
- ListAccountVaultsApiRequest
- GetAccountApiResponseTenantInformation
- GetVaultOwnersApiResponseItem
- GetAccountApiResponseUserAccountInformation
- GetVaultUserAccountMemberApiResponse
- ListAccountVaultsApiResponse
- GetDashboardApiResponse
- GetDashboardApiResponseAuthMethodItem
- ListAccountVaultsApiResponseItemUserAccountMember
- GetDashboardApiResponseCountryItem
- GetVaultApiResponse
- ListAvailableEnvelopeOwnersApiResponse
- GetDashboardApiResponseEnvelopeActivity
- ListAvailableEnvelopeOwnersApiResponseItem
- GetDashboardApiResponseEnvelopeActivityItem
- ListContactsApiResponse
- ListUserAccountVaultsApiRequest
- GetDashboardApiResponseRegionItem
- ListAvailableSealsApiResponse
- GetDashboardApiResponseSignaturesByRegion
- ListUserAccountVaultsApiResponse
- ListAvailableSealsApiResponseItem
- GetDashboardApiResponseStatCards
- GetDashboardApiResponseStatusDistributionItem
- ListContactsApiResponseItem
- ListUserAccountVaultsApiResponseItemUserAccountMember
- ListVaultApiRequest
- GetDashboardApiResponseTopSignerItem
- ListVaultApiResponse
- GetDocumentApiResponse
- ListVaultApiResponseItem
- ListVaultApiResponseItemEnvelope
- ListVaultApiResponseItemEnvelopeSigner
- GetDocumentsApiResponse
- ListVaultApiResponseItemTemplate
- GetDocumentsApiResponseItem
- ListVaultUserAccountMemberApiResponse
- GetEnvelopeAccessLinkPasswordApiResponse
- ListVaultVaultApiResponse
- GetEnvelopeAccessLinkUrlApiResponse
- Pagination
- ProcessEnvelopeCertificateApiRequest
- ListEnvelopeAccessLinksApiResponse
- RenameEnvelopeApiRequest
- GetEnvelopeAnchorsApiResponseEvent
- ListEnvelopeAccessLinksApiResponseItem
- GetEnvelopeApiResponse
- MoveTemplateApiRequest
- TemplateFieldConstraints
- TemplateFieldSchema
- TemplateFieldValue
- GetEnvelopeApiResponseAttachment
- UnauthorizedApiResponse
- RenameTemplateApiRequest
- RestoreTemplateApiRequest
- GetEnvelopeApiResponseEnvelopeAction
- UpdateEnvelopeDocumentApiRequest
- GetEnvelopeApiResponsePlace
- UpdateContactApiRequest
- GetEnvelopeApiResponseSignMark
- UpdateEnvelopeApiRequest
- UpdateEnvelopeSignerSignMarkApiRequest
- GetEnvelopeApiResponseSignerAction
- UploadDocumentApiResponse
- UploadDocumentPageSizeApiResponse
- UpdateTemplateApiRequest
- GetEnvelopesBlockchainSummaryApiResponse
- UpdateTemplateFieldApiRequest
- UpdateEnvelopeSignerApiRequest
- GetEnvelopesReportSummaryActivityApiResponse
- GetEnvelopesReportSummaryActivityApiResponseItem
- GetEnvelopesReportSummaryApiResponse
- GetEnvelopesReportSummaryBySignersApiResponseItem
- UpdateAccessPolicyApiRequest
- GetEnvelopesReportSummaryDurationBucketApiResponseItem
- GetEnvelopesReportSummaryFunnelApiResponse
- GetEnvelopesReportSummaryHourWeekdayApiResponseItem
- GetEnvelopesReportSummaryOutcomeFlowApiResponse
- GetEnvelopesReportSummaryOutcomeFlowLinkApiResponse
- GetEnvelopesReportSummaryOutcomeFlowNodeApiResponse
- UpdateVaultApiRequest
- GetEnvelopesReportSummaryStatCardsApiResponse
- GetEnvelopesReportSummaryStatusDistributionApiResponseItem
- GetEnvelopesSealingSummaryApiResponse
- VaultAccessPolicyApiRequest
- GetInviteApiResponse
- VaultAccessPolicyApiResponse
- GetSignerActionsSummaryApiResponse
- GetSignerActionsSummaryApiResponseActivity
- GetSignerActionsSummaryApiResponseActivityItem
- GetSignerActionsSummaryApiResponseBand
- GetSignerActionsSummaryApiResponseDevice
- GetSignerActionsSummaryApiResponseFunnel
- GetSignerActionsSummaryApiResponseHourWeekday
- GetSignerActionsSummaryApiResponseStatCards
- GetSignerActionsSummaryApiResponseType
- GetSignerEvidenceImagesApiResponse
- GetSignersIdentitySummaryApiResponse
- GetSignersNotificationsSummaryApiResponse
- GetTeamProductivitySummaryApiResponse
- GetTemplatesPerformanceSummaryApiResponse
- GetUsageBalanceApiResponse
- GetUsageBalanceApiResponseCards
- GetUsageBalanceApiResponseDailyConsumption
- GetUsageBalanceApiResponseExpirations
- GetUsageBalanceApiResponseLot
- GetUsageBalanceApiResponseProjection
- GetUserAccountApiResponse
- GetWebhookApiResponse
- GetWebhookApiResponseApiKeyConfig
- GetWebhookApiResponseAwsSignatureConfig
- GetWebhookApiResponseBasicAuthConfig
- GetWebhookApiResponseBearerTokenConfig
- GetWebhookApiResponseCustomSignatureConfig
- GetWebhookApiResponseOAuth2AuthorizationCodeConfig
- GetWebhookApiResponseOAuth2ClientCredentialsConfig
- ListAccountVaultsApiResponseItem
- ListEnvelopeAccessesApiResponse
- ListEnvelopesAccessesApiResponse
- ListEnvelopesAccessesApiResponseEnvelope
- ListEnvelopesAccessesApiResponseItem
- ListEnvelopesApiResponse
- ListEnvelopesApiResponseItem
- ListEnvelopesApiResponseSigner
- ListInvitesApiResponse
- ListInvitesApiResponseItem
- ListPendingEnvelopesApiResponse
- ListPendingEnvelopesApiResponseItem
- ListSignerActionsApiResponse
- ListSignerActionsApiResponseItem
- ListTemplateEnvelopesApiResponse
- ListTemplateEnvelopesApiResponseItem
- ListTemplateVersionsApiResponse
- ListTemplateVersionsApiResponseItem
- ListTemplatesApiResponse
- ListTemplatesApiResponseItem
- ListUsageAllocationApiResponse
- ListUsageAllocationApiResponseItem
- ListUsageStatementApiResponse
- ListUsageStatementApiResponseItem
- ListUsageStorageApiResponse
- ListUsageStorageApiResponseItem
- ListUserAccountVaultsApiResponseItem
- ListUserAccountsApiResponse
- ListUserAccountsApiResponseItem
- ListWebhookDeliveriesApiResponse
- ListWebhookDeliveriesApiResponseItem
- ListWebhookEndpointsApiResponse
- ListWebhookEndpointsApiResponseItem
- ListWebhooksApiResponse
- ListWebhooksApiResponseItem
- SealingByVaultApiResponse
- SealingLtvApiResponse
- SealingLtvApiResponseItem
- SealingSealBreakdownApiResponseItem
- SealingStatCardsApiResponse
- SealingTimestampCountApiResponseItem
- SealingTimestampsApiResponse
- SealingTimestampsApiResponseItem
- SealingVaultApiResponseItem
- SignersIdentityFactorOutcomeApiResponseItem
- SignersIdentityFailureCountApiResponseItem
- SignersIdentityLocationApiResponseItem
- SignersIdentityLocationsApiResponse
- SignersIdentityOutcomesApiResponse
- SignersIdentityStatCardsApiResponse
- SignersNotificationsActivityApiResponse
- SignersNotificationsActivityApiResponseItem
- SignersNotificationsByVaultApiResponse
- SignersNotificationsChannelCountApiResponseItem
- SignersNotificationsCodeCountApiResponseItem
- SignersNotificationsKindCountApiResponseItem
- SignersNotificationsStatCardsApiResponse
- SignersNotificationsVaultApiResponseItem
- TeamProductivityActivityApiResponse
- TeamProductivityActivityApiResponseItem
- TeamProductivityDurationBucketApiResponseItem
- TeamProductivityMemberPointApiResponseItem
- TeamProductivityPortfolioApiResponse
- TeamProductivityPortfolioApiResponseItem
- TeamProductivityPortfolioOthersApiResponse
- TeamProductivityStatCardsApiResponse
- TemplatesPerformanceActivityApiResponse
- TemplatesPerformanceActivityApiResponseItem
- TemplatesPerformanceOutcomeApiResponseItem
- TemplatesPerformanceOutcomeByTemplateApiResponse
- TemplatesPerformanceOutcomeOthersApiResponse
- TemplatesPerformanceSignersTimeApiResponseItem
- TemplatesPerformanceStatCardsApiResponse
- TemplatesPerformanceTimeStatsApiResponse
- TemplatesPerformanceTimeToCompleteApiResponseItem
- TemplatesPerformanceUsageApiResponseItem
ListWebhookDeliveriesApiResponseItem
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"event": "EnvelopeCreated",
"envelopeId": "9494e254-c08a-4611-806e-b9c722e2fe3d",
"envelopeName": "string",
"signerName": "string",
"createdAtUtc": "2019-08-24T14:15:22.123Z",
"processedAtUtc": "2019-08-24T14:15:22.123Z",
"status": "Pending",
"notSentReason": "AccountSettingsMissing"
}