Passer au contenu

Request an on-demand affidavit

Requête

Asynchronously request an affidavit for an EviSign owned by the caller. The original submission must enable OnDemand affidavits; Draft and Closed entries, exhausted limits and unavailable records are rejected with 400. IncludedCommitments accepts None or Signers and defaults to None in the generation job. Acceptance queues the request. Closure or the request limit can prevent later generation.

Sécurité
basicAuth
Corpsapplication/jsonobligatoire

Required nonempty UniqueId; optional IncludeDocument, IncludeAttachments, IncludeEvents, IncludedCommitments (None or Signers), and Masking. IncludeAttachments includes only attachments submitted with RequireContentCommitment enabled.

UniqueIdstring, (uuid)obligatoire

Unique identifier of the EviSign for which an on-demand affidavit is requested.

IncludeDocumentboolean

Indicates whether the affidavit should include EviSign document content.

IncludeAttachmentsboolean

Indicates whether the affidavit should include EviSign attachments. Only attachments submitted with RequireContentCommitment enabled are included.

IncludeEventsboolean

Indicates whether the affidavit should include detailed EviSign event information.

IncludedCommitmentsstring or null

Optional. Include None or Signers. The generation job uses None when omitted.

Enum:"None""Signers"null
MaskingArray of strings or null

Optional masking directives to obfuscate sensitive data in the generated affidavit output.

curl -i -X POST \
  -u '<username>:<password>' \
  https://api.evicertia.com/v1/evisign/affidavitrequest \
  -H 'Content-Type: application/json' \
  -d '{
    "UniqueId": "d11caec2-70bd-4739-afd5-aa7600920538",
    "IncludeDocument": true,
    "IncludeAttachments": false,
    "IncludeEvents": true,
    "IncludedCommitments": "Signers"
  }'

Réponses

Affidavit on-demand request accepted and queued for processing.

Corpsapplication/json
requestIdstring or null^[0-9a-fA-F]{32}$

Unique identifier assigned to this affidavit request for correlation. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.

Réponse
{ "requestId": "string" }