Skip to content

Request an on-demand affidavit

Request

The original submitting account can request an affidavit for a submitted Letter or LetterLite before it closes. At Submit, enable AffidavitsOnDemandEnabled and use AdvancedContentOnSubmit, AdvancedContentOnClose, or AdvancedContentOnSubmitAndOnClose. Generation is asynchronous and a configurable limit applies per communication. Registered accepts the flag at Submit but cannot use this operation. The platform skips a queued request if the communication closes or earlier requests reach the limit before processing. In these cases no AffidavitPublished callback is sent for the request.

Security
basicAuth
Bodyapplication/jsonrequired
UniqueIdstring, (uuid)required

Unique ID of the EviPost to generate an affidavit for.

IncludeDocumentboolean

If true, the document is included in the affidavit.

IncludeEventsboolean

If true, detailed event information is included in the affidavit.

curl -i -X POST \
  -u '<username>:<password>' \
  https://api.evicertia.com/v1/EviPost/AffidavitRequest \
  -H 'Content-Type: application/json' \
  -d '{
    "UniqueId": "87ffa214-e773-4bd5-9b8d-a8ef00fd80f8",
    "IncludeDocument": true,
    "IncludeEvents": true
  }'

Responses

Affidavit request queued. Use Query to check which affidavits were generated.

Bodyapplication/json
requestIdstring^[0-9a-fA-F]{32}$required

Identifier of the affidavit generation request, serialized as 32 hexadecimal characters without dashes.

Response
{ "requestId": "79726a87000c1f7042aca3ea149f9438" }