Skip to content

Submit a certified email

Request

Security
basicAuth
Headers
X-Evi-IdempotencyTokenstring

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.

Bodyapplication/jsonrequired
Subjectstring, <= 1024 charactersrequired
Bodystring, <= 10485760 charactersrequired

HTML body. HTTP request-size limits can also apply.

LookupKeystring, <= 35 characters
IssuerNamestring, <= 135 characters
Fromstring, (email)
ReplyTostring, (email)
DisableSenderHeaderboolean
Recipientobject(EviMailRecipient)required
CarbonCopyArray of objects, <= 10 items(EviMailCarbonCopy)
AttachmentsArray of objects, <= 15 items(EviMailAttachment)

Each decoded file must be smaller than 8 MiB. All decoded files together can total up to 25 MiB.

Optionsobject(EviMailOptions)
curl -i -X POST \
  -u '<username>:<password>' \
  https://api.evicertia.com/v1/EviMail/Submit \
  -H 'Content-Type: application/json' \
  -H 'X-Evi-IdempotencyToken: string' \
  -d '{
    "Subject": "Certified email example",
    "Body": "<p>Hello, this is a certified email.</p>",
    "LookupKey": "MAIL-001",
    "IssuerName": "Sender Corp.",
    "From": "sender@example.com",
    "ReplyTo": "reply@example.com",
    "DisableSenderHeader": false,
    "Recipient": {
      "LegalName": "Recipient Corp.",
      "EmailAddress": "recipient@example.com"
    },
    "CarbonCopy": [
      {
        "Name": "Legal Team",
        "EmailAddress": "legal@example.com"
      }
    ],
    "Attachments": [
      {
        "DisplayName": "Contract",
        "Filename": "contract.txt",
        "MimeType": "text/plain",
        "Data": "Q29udHJhY3QgZXhhbXBsZQo="
      }
    ],
    "Options": {
      "CertificationLevel": "Advanced_EU",
      "TimeToLive": 1440,
      "Language": "en",
      "AffidavitLanguage": "en",
      "AffidavitKinds": [
        "Submitted",
        "DeliveryResult",
        "Read",
        "Closed"
      ],
      "PushNotificationFilter": [
        "Sent",
        "Delivered",
        "Read",
        "Failed"
      ],
      "PushNotificationUrl": "https://example-callback.invalid/",
      "EvidenceAccessControlMethod": "Public",
      "OnlineRetentionPeriod": 1
    }
  }'

Responses

Email accepted

Headers
X-Evi-IdempotencyStatusstring

Idempotency outcome for the submission request.

Value:"New"
Bodyapplication/json
eviIdstringrequired
Response
{ "eviId": "string" }