# Submit a certified email

Endpoint: POST /v1/EviMail/Submit
Version: 1.0
Security: basicAuth

## Security:

  - `basicAuth` (unknown)
    http basic

## Header parameters:

  - `X-Evi-IdempotencyToken` (string)
    Optional idempotency token (UUID recommended) to prevent duplicate submissions on retry. A replay of a cached `200 OK` submission returns `202 Accepted`. Responses `400`, `401`, `408`, `409`, `429`, and `5xx` are not cached for replay.

## Request fields (application/json):

  - `Subject` (string, required)

  - `Body` (string, required)
    HTML body. HTTP request-size limits can also apply.

  - `LookupKey` (string)

  - `IssuerName` (string)

  - `From` (string)

  - `ReplyTo` (string)

  - `DisableSenderHeader` (boolean)

  - `Recipient` (object, required)

  - `Recipient.LegalName` (string)
    Optional legal name of the recipient.

  - `Recipient.EmailAddress` (string, required)

  - `CarbonCopy` (array)

  - `CarbonCopy.Name` (string)
    Optional name of the carbon copy recipient.

  - `CarbonCopy.EmailAddress` (string, required)

  - `Attachments` (array)
    Each decoded file must be smaller than 8 MiB. All decoded files together can total up to 25 MiB.

  - `Attachments.ContentId` (string)
    Attachment content identifier.

  - `Attachments.DisplayName` (string)

  - `Attachments.Filename` (string)

  - `Attachments.MimeType` (string)
    Attachment MIME type.

  - `Attachments.ContentDescription` (string)

  - `Attachments.ContentDisposition` (string)

  - `Attachments.ContentLocation` (string)

  - `Attachments.ContentEncoding` (string)

  - `Attachments.Data` (string)
    Base64-encoded file content.

  - `Attachments.Attributes` (array)
    Attachment key-value attributes. Use the `IncludeOnAffidavits` key with value `"true"` to reference the attachment in generated affidavits (PDF attachments only; not valid with basic affidavit content).

  - `Attachments.Attributes.Key` (string)

  - `Attachments.Attributes.Value` (string)

  - `Options` (object)

  - `Options.CertificationLevel` (string)
    Certification level for EviMail v1. Supported values include the bare `Standard` and `Advanced` levels and their regional variants, such as `Standard_EU` or `Advanced_EU`. Availability depends on the account.
    Enum: "Standard", "Advanced", "Standard_CO", "Standard_CR", "Standard_EC", "Standard_EU", "Standard_MX", "Standard_PE", "Advanced_CO", "Advanced_CR", "Advanced_EC", "Advanced_EU", "Advanced_MX", "Advanced_PE"

  - `Options.TimeToLive` (integer)
    Tracking duration in minutes. The platform default is normally 10080 minutes (7 days).

  - `Options.DeliveryAppearance` (string)
    Controls the visual appearance of the delivery notification page. Accepted values: `Certified` (default branded certified-delivery appearance) or `AsIs` (plain appearance without certification branding).
    Enum: "Certified", "AsIs"

  - `Options.Language` (string)
    Defaults to English on sites using current defaults. Sites using legacy language defaults can resolve a different value.
    Enum: "en", "es", "ca", "it", "pt", "pt-BR", "fr", "de", "ro", "el"

  - `Options.AffidavitLanguage` (string)
    Defaults to English on sites using current defaults. Sites using legacy language defaults can resolve a different value.
    Enum: "en", "es", "ca", "it", "pt", "pt-BR", "fr", "de", "ro", "el"

  - `Options.AffidavitKinds` (array)

  - `Options.CommitmentOptions` (string)
    Formal acceptance or rejection mode. If omitted, the platform default is normally AcceptOrReject.
    Enum: "Disabled", "Accept", "Reject", "AcceptOrReject"

  - `Options.CommitmentCommentsAllowed` (boolean)

  - `Options.PushNotificationFilter` (array)

  - `Options.PushNotificationUrl` (string)

  - `Options.PushNotificationExtraData` (string)

  - `Options.EvidenceAccessControlMethod` (string)
    Controls how recipients access the evidence record. Supported values: `Public`, `Challenge`, `AutoChallenge`. When omitted, the account's configured default method applies.
    Enum: "AutoChallenge", "Public", "Challenge"

  - `Options.EvidenceAccessControlChallenge` (string)

  - `Options.EvidenceAccessControlChallengeResponse` (string)

  - `Options.RequireAcceptReason` (boolean)
    Requires CommitmentCommentsAllowed true and an accept-capable commitment mode.

  - `Options.AcceptReasons` (array)
    Requires CommitmentCommentsAllowed true and an accept-capable commitment mode.

  - `Options.RequireRejectReason` (boolean)
    Requires CommitmentCommentsAllowed true and a reject-capable commitment mode.

  - `Options.RejectReasons` (array)
    Requires CommitmentCommentsAllowed true and a reject-capable commitment mode.

  - `Options.OnlineRetentionPeriod` (integer)

  - `Options.CostCentre` (string)

  - `Options.OwnerNotificationTemplate` (string)
    Identifier of an enabled custom template used for the issuer's status notification email. See [Using communication templates from the API](/it/products/namirialnotify/dev/templates).

  - `Options.OwnerNotificationTemplateValues` (object)
    Key-value pairs supplying values for the user variables declared in OwnerNotificationTemplate.

  - `Options.CustomLayoutLogoUrl` (string)
    URL of a custom logo to display in the certified email layout.

  - `Options.DisablePlatformReferences` (boolean)
    When true, internal platform references are suppressed in the generated affidavits.

  - `Options.LtaStorage` (boolean)
    When true, the evidence for this transaction is stored in Namirial Archive during post-close processing after tracking reaches `Closed`. Requires LTA to be enabled for the site. `OnlineRetentionPeriod` separately controls online accessibility.

  - `Options.NotaryRetentionPeriod` (integer)
    Notarial deposit retention period in years. Requires NotaryProfile to be set.

  - `Options.NotaryProfile` (string)
    The notary profile identifier to use for notarial deposit.

## Request examples:

  - `emailOk` (unknown)

## Response 200:

  - `200` (unknown)
    Email accepted

## Response 200 fields (application/json):

  - `eviId` (string, required)

## Response 200 headers (application/json):

  - `X-Evi-IdempotencyStatus` (string)
    Idempotency outcome for the submission request.
    Enum: "New"

## Response 202:

  - `202` (unknown)
    Idempotent replay. The same X-Evi-IdempotencyToken was used for a cached 200 OK submission. The original response body is returned; the message is not resubmitted.

## Response 202 fields (application/json):

  - `eviId` (string, required)

## Response 202 headers (application/json):

  - `X-Evi-IdempotencyStatus` (string)
    Idempotency outcome for the submission request.
    Enum: "Replay"

## Response 400:

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

## Response 400 fields (application/json):

  - `responseStatus` (object)

  - `responseStatus.errorCode` (string)

  - `responseStatus.message` (string)

  - `responseStatus.errors` (array)

  - `responseStatus.errors.errorCode` (string)

  - `responseStatus.errors.fieldName` (string)

  - `responseStatus.errors.message` (string)

## Response 401:

  - `401` (unknown)
    Authentication failed

## Response 403:

  - `403` (unknown)
    Access denied. The authenticated account lacks the required API permission, has specified a From address that is not permitted for this account, or has attempted to set a restricted request header.

## Response 409:

  - `409` (unknown)
    Another Submit with the same X-Evi-IdempotencyToken is currently in flight.

## Response 409 headers:

  - `X-Evi-IdempotencyStatus` (string)
    Idempotency outcome for the submission request.
    Enum: "Conflict"

