# Request an on-demand affidavit

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.

Endpoint: POST /v1/evisign/affidavitrequest
Version: 1.0
Security: basicAuth

## Security:

  - `basicAuth` (unknown)
    http basic

## Request body:

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

## Request fields (application/json):

  - `UniqueId` (string, required)
    Unique identifier of the EviSign for which an on-demand affidavit is requested.

  - `IncludeDocument` (boolean)
    Indicates whether the affidavit should include EviSign document content.

  - `IncludeAttachments` (boolean)
    Indicates whether the affidavit should include EviSign attachments.
Only attachments submitted with RequireContentCommitment enabled are included.

  - `IncludeEvents` (boolean)
    Indicates whether the affidavit should include detailed EviSign event information.

  - `IncludedCommitments` (string)
    Optional. Include None or Signers. The generation job uses None when omitted.
    Enum: "None", "Signers", "null"

  - `Masking` (array)
    Optional masking directives to obfuscate sensitive data in the generated affidavit output.

## Response 200:

  - `200` (unknown)
    Affidavit on-demand request accepted and queued for processing.

## Response 200 fields (application/json):

  - `requestId` (string)
    Unique identifier assigned to this affidavit request for correlation. V1 responses serialize UUIDs as 32 hexadecimal characters without dashes.

## Response 400:

  - `400` (unknown)
    Invalid request or business rule failure.

## Response 400 fields (application/json):

  - `responseStatus` (object)

  - `responseStatus.errorCode` (string)
    Holds the custom ErrorCode enum if provided in ValidationException
otherwise will hold the name of the Exception type, e.g. typeof(Exception).Name

A value of non-null means the service encountered an error while processing the request.

  - `responseStatus.message` (string)
    A human friendly error message

  - `responseStatus.stackTrace` (string)

  - `responseStatus.errors` (array)
    For multiple detailed validation errors.
Can hold a specific error message for each named field.

  - `responseStatus.errors.errorCode` (string)

  - `responseStatus.errors.fieldName` (string)

  - `responseStatus.errors.message` (string)

## Response 401:

  - `401` (unknown)
    Authentication failed.

## Response 401 fields (application/json):

  - `responseStatus` (object)

  - `responseStatus.errorCode` (string)
    Holds the custom ErrorCode enum if provided in ValidationException
otherwise will hold the name of the Exception type, e.g. typeof(Exception).Name

A value of non-null means the service encountered an error while processing the request.

  - `responseStatus.message` (string)
    A human friendly error message

  - `responseStatus.stackTrace` (string)

  - `responseStatus.errors` (array)
    For multiple detailed validation errors.
Can hold a specific error message for each named field.

  - `responseStatus.errors.errorCode` (string)

  - `responseStatus.errors.fieldName` (string)

  - `responseStatus.errors.message` (string)

## Response 403:

  - `403` (unknown)
    API, EviSign service, or required operation permission is missing.

## Response 403 fields (application/json):

  - `responseStatus` (object)

  - `responseStatus.errorCode` (string)
    Holds the custom ErrorCode enum if provided in ValidationException
otherwise will hold the name of the Exception type, e.g. typeof(Exception).Name

A value of non-null means the service encountered an error while processing the request.

  - `responseStatus.message` (string)
    A human friendly error message

  - `responseStatus.stackTrace` (string)

  - `responseStatus.errors` (array)
    For multiple detailed validation errors.
Can hold a specific error message for each named field.

  - `responseStatus.errors.errorCode` (string)

  - `responseStatus.errors.fieldName` (string)

  - `responseStatus.errors.message` (string)

## Response 500:

  - `500` (unknown)
    Unexpected server failure.

## Response 500 fields (application/json):

  - `responseStatus` (object)

  - `responseStatus.errorCode` (string)
    Holds the custom ErrorCode enum if provided in ValidationException
otherwise will hold the name of the Exception type, e.g. typeof(Exception).Name

A value of non-null means the service encountered an error while processing the request.

  - `responseStatus.message` (string)
    A human friendly error message

  - `responseStatus.stackTrace` (string)

  - `responseStatus.errors` (array)
    For multiple detailed validation errors.
Can hold a specific error message for each named field.

  - `responseStatus.errors.errorCode` (string)

  - `responseStatus.errors.fieldName` (string)

  - `responseStatus.errors.message` (string)

## Response default:

  - `default` (unknown)
    Error

## Response default fields (application/json):

  - `responseStatus` (object)

  - `responseStatus.errorCode` (string)
    Holds the custom ErrorCode enum if provided in ValidationException
otherwise will hold the name of the Exception type, e.g. typeof(Exception).Name

A value of non-null means the service encountered an error while processing the request.

  - `responseStatus.message` (string)
    A human friendly error message

  - `responseStatus.stackTrace` (string)

  - `responseStatus.errors` (array)
    For multiple detailed validation errors.
Can hold a specific error message for each named field.

  - `responseStatus.errors.errorCode` (string)

  - `responseStatus.errors.fieldName` (string)

  - `responseStatus.errors.message` (string)

