# EviNotice API

REST API for submitting, querying, and retrieving certified electronic notifications and managing notice batches through Namirial Notify. EviNotice provides legally binding certified delivery with configurable certification levels, commitment workflows, delivery sign methods, and comprehensive evidence collection options. For the public Namirial Notify API environments, use routes under the `/v2` base path. The legacy `/api/v2/...` form is still accepted for backward compatibility.

Version: 2.0

## Servers

Production
```
https://api.evicertia.com
```

Pre-production / QA
```
https://api.ecertia.com
```

## Security

### basicAuth

Type: http
Scheme: basic

## Download OpenAPI description

 - [EviNotice API](https://docs.namirial.app/_bundle/products/namirialnotify/apis/oas/evinotice-api.yaml)

## EviNotice

 - [POST /v2/EviNotice/Submit](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticesubmit.md)
 - [GET /v2/EviNotice/{Id}](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticeget.md)
 - [POST /v2/EviNotice/Query](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticequery.md): Use State Closed to find notices that have reached the only terminal state. Outcome then identifies the final recorded result. A notice can close with Outcome Received when link access was recorded an
 - [GET /v2/EviNotice/{Id}/Attachments](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticeattachmentsdownload.md)
 - [GET /v2/EviNotice/{Id}/Affidavits](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticeaffidavitsdownload.md)
 - [GET /v2/EviNotice/Affidavits/{Id}](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticeaffidavitdownload.md)
 - [POST /v2/EviNotice/Affidavits/Request](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticeaffidavitrequest.md): Generates a custom affidavit for a previously submitted EviNotice. The original submit request must have included `AffidavitKinds` with the `OnDemand` value. The notice must still be eligible — not `D
 - [POST /v2/EviNotice/Batches](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticebatchcreate.md): Creates a new, empty notice batch. Only a `Description` is required at creation; the body, recipients, attachments, and options are set with the subsequent batch endpoints. Returns the `BatchId` used
 - [GET /v2/EviNotice/Batches](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticebatchesquery.md): Lists notice batches owned by the caller (or the caller's site), with cursor pagination. **This endpoint uses the HTTP `QUERY` method, not GET.** OpenAPI cannot express the `QUERY` method, so it is sh
 - [GET /v2/EviNotice/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticebatchget.md): Retrieves the full state of a batch, including its configured notice template and processing progress.
 - [PATCH /v2/EviNotice/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticebatchpatch.md): Updates batch metadata and the notice template options. All fields are optional; only the fields supplied are changed. Setting `State` transitions the batch (for example, to start processing or schedu
 - [DELETE /v2/EviNotice/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticebatchdelete.md): Removes a previously created batch.
 - [PUT /v2/EviNotice/Batches/{BatchId}/Body](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticebatchbodyput.md): Sets the HTML body of the notice for this batch. The body is sent as the raw request payload (HTML), not as a JSON field. Use `PATCH .../{BatchId}` to set the `Subject`.
 - [POST /v2/EviNotice/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticebatchrecipientspost.md): Adds recipients to the batch by uploading a `text/csv` file. The CSV uses `;` as the column separator. Mandatory columns: `address`, `legalname`. Optional columns: `lookupkey`, `displayname`, `custody
 - [GET /v2/EviNotice/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticebatchrecipientsquery.md): Lists the recipients of a batch, with cursor pagination. **This endpoint uses the HTTP `QUERY` method, not GET.** OpenAPI cannot express the `QUERY` method, so it is shown here as a `GET` with the fil
 - [DELETE /v2/EviNotice/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticebatchrecipientsdelete.md): Removes all recipients from the batch.
 - [POST /v2/EviNotice/Batches/{BatchId}/Attachments](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticebatchattachmentspost.md): Adds a single attachment to the batch by uploading it as `multipart/form-data`. The attachment is included in every notice generated from the batch.
 - [GET /v2/EviNotice/Batches/{BatchId}/Attachments](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticebatchattachmentsget.md): Returns metadata for all attachments configured on the batch.
 - [DELETE /v2/EviNotice/Batches/{BatchId}/Attachments](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticebatchattachmentsdelete.md): Removes all attachments from the batch.
 - [GET /v2/EviNotice/Batches/{BatchId}/Attachments/{AttachmentId}](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticebatchattachmentget.md): Downloads the binary content of a single batch attachment.
 - [DELETE /v2/EviNotice/Batches/{BatchId}/Attachments/{AttachmentId}](https://docs.namirial.app/products/namirialnotify/apis/oas/evinotice-api/evinotice/evinoticebatchattachmentdelete.md): Removes a single attachment from the batch.
