Please review and accept the attached contract.
", "LookupKey": "CONTRACT-001", "TimeToLive": 10080, "RecipientAddress": "recipient@example.com", "RecipientDisplayName": "Jane Doe", "RecipientLegalName": "Acme Corp", "CertificationLevel": "Advanced_EU", "IssuerLegalName": "Sender Co.", "Attachments": [ { "Data": "JVBERi0xLjQgZXhhbXBsZQ==", "Filename": "contract.pdf", "DisplayName": "Contract 2026", "MimeType": "application/pdf", "IncludeOnAffidavits": true } ], "AffidavitKinds": [ "SubmittedAdvanced", "TransmissionResult", "DeliveryResult", "Received", "Read", "CommittedAdvanced", "Refused", "Event", "Complete", "Failed" ], "EvidenceAccessControlMethod": "AutoChallenge", "DeliverySignMethod": "MobilePin", "DeliverySignFixedMobile": "+34600000000", "MobilePinChannels": [ [ "Sms", "Rcs", "WhatsApp" ], [ "Sms", "Rcs", "WhatsApp" ], [ "Sms", "Rcs", "WhatsApp" ] ], "CommitmentChoice": "AcceptOrReject", "CommitmentCommentsAllowed": true, "RejectReasons": [ "I do not agree with the terms", "The information is incorrect" ], "RequireRejectReason": false, "AcceptReasons": [ "I accept the terms", "I confirm the information" ], "RequireAcceptReason": false, "PushNotificationFilter": [ "Processed", "Sent", "Dispatched", "Delivered", "Read", "Replied" ], "PushNotificationUrl": "https://your-system.example.com/callbacks/notify", "Language": "en", "AffidavitLanguage": "en", "NotificationLayout": "Certified", "Reminders": { "Initial": "P2D", "Repeat": "P1D", "Days": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ], "TimeRange": [ "FROM08TO10", "FROM10TO12", "FROM12TO15", "FROM15TO19" ], "Max": 5, "Stop": "P15D", "TimeZone": "Etc/GMT-1" } } } } } } }, "responses": { "200": { "description": "EviNotice accepted", "headers": { "X-Evi-IdempotencyStatus": { "description": "Idempotency outcome for the submission request.", "schema": { "type": "string", "enum": [ "New" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviNoticeSubmitResponse" }, "example": { "Id": "550e8400-e29b-41d4-a716-446655440000" } } } }, "202": { "description": "Idempotent replay. The same X-Evi-IdempotencyToken was used for a cached 200 OK submission. The original response body is returned; the notice is not resubmitted.", "headers": { "X-Evi-IdempotencyStatus": { "description": "Idempotency outcome for the submission request.", "schema": { "type": "string", "enum": [ "Replay" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviNoticeSubmitResponse" }, "example": { "Id": "550e8400-e29b-41d4-a716-446655440000" } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/EviNoticeProblem" } } } }, "401": { "description": "Authentication failed" }, "403": { "description": "The authenticated account lacks the required API permission for EviNotice, or the account has insufficient credit balance to submit the notice." }, "409": { "description": "Another Submit with the same X-Evi-IdempotencyToken is currently in flight.", "headers": { "X-Evi-IdempotencyStatus": { "description": "Idempotency outcome for the submission request.", "schema": { "type": "string", "enum": [ "Conflict" ] } } } } } } }, "/v2/EviNotice/{Id}": { "get": { "tags": [ "EviNotice" ], "summary": "Get a single EviNotice", "operationId": "eviNoticeGet", "security": [ { "basicAuth": [] } ], "parameters": [ { "name": "Id", "in": "path", "required": true, "description": "The UUID of the EviNotice returned at submission.", "schema": { "type": "string", "format": "uuid" } }, { "name": "IncludeAffidavits", "in": "query", "description": "Include affidavit metadata in the response.", "schema": { "type": "boolean" } }, { "name": "IncludeAttachments", "in": "query", "description": "Include attachment metadata in the response.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "EviNotice retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviNoticeGetResponse" }, "example": { "Id": "550e8400-e29b-41d4-a716-446655440000", "Subject": "Contract review required", "LookupKey": "CONTRACT-001", "Issuer": "Sender Co.", "IssuerEmail": "sender@example.com", "RecipientAddress": "recipient@example.com", "RecipientDisplayName": "Jane Doe", "RecipientLegalName": "Acme Corp", "State": "Read", "Outcome": "None", "CreationDate": "2026-01-15T09:00:00Z", "LastUpdateDate": "2026-01-16T11:23:00Z", "SubmittedOn": "2026-01-15T09:00:01Z", "ProcessedOn": "2026-01-15T09:00:03Z", "SentOn": "2026-01-15T09:00:10Z", "DispatchedOn": "2026-01-15T09:00:03Z", "DeliveredOn": "2026-01-15T09:15:00Z", "ReceivedOn": "2026-01-16T11:20:00Z", "ReadOn": "2026-01-16T11:23:00Z", "TimeToLive": 10080, "AllowRefusal": false, "NotaryRetention": false, "OnlineRetentionPeriod": 1, "SourceChannel": "Api", "AffidavitKinds": [ "TransmissionResult", "DeliveryResult", "Read" ], "SiteName": "acme-corp", "XmissionResult": true, "XmissionSummary": "250 OK" } } } }, "400": { "description": "Invalid request" }, "401": { "description": "Authentication failed" }, "404": { "description": "EviNotice not found" } } } }, "/v2/EviNotice/Query": { "post": { "tags": [ "EviNotice" ], "summary": "Query multiple EviNotices", "operationId": "eviNoticeQuery", "security": [ { "basicAuth": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviNoticeQueryRequest" } } } }, "responses": { "200": { "description": "Query executed successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviNoticeQueryResponse" }, "example": { "Cursor": "AQAAAADFDwwAAAAAABVOhADim0HUo3Jm+wAAAAAAAAA=", "Results": [ { "Id": "550e8400-e29b-41d4-a716-446655440000", "Subject": "Contract review required", "LookupKey": "CONTRACT-001", "Issuer": "Sender Co.", "IssuerEmail": "sender@example.com", "RecipientAddress": "recipient@example.com", "RecipientDisplayName": "Jane Doe", "State": "Read", "Outcome": "None", "CreationDate": "2026-01-15T09:00:00Z", "SubmittedOn": "2026-01-15T09:00:01Z", "ReadOn": "2026-01-16T11:23:00Z", "TimeToLive": 10080, "AffidavitKinds": [ "TransmissionResult", "DeliveryResult", "Read" ] } ] } } } }, "401": { "description": "Authentication failed" } } } }, "/v2/EviNotice/{Id}/Attachments": { "get": { "tags": [ "EviNotice" ], "summary": "Download all attachments of an EviNotice", "operationId": "eviNoticeAttachmentsDownload", "security": [ { "basicAuth": [] } ], "parameters": [ { "name": "Id", "in": "path", "required": true, "description": "The UUID of the EviNotice.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "ZIP file containing all attachments.", "content": { "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "204": { "description": "No attachments available for this EviNotice." }, "401": { "description": "Authentication failed" }, "404": { "description": "EviNotice not found." } } } }, "/v2/EviNotice/{Id}/Affidavits": { "get": { "tags": [ "EviNotice" ], "summary": "Download all affidavits of an EviNotice", "operationId": "eviNoticeAffidavitsDownload", "security": [ { "basicAuth": [] } ], "parameters": [ { "name": "Id", "in": "path", "required": true, "description": "The UUID of the EviNotice.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "ZIP file containing all affidavits.", "content": { "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "204": { "description": "No affidavits have been generated yet for this EviNotice." }, "401": { "description": "Authentication failed" }, "404": { "description": "EviNotice not found." } } } }, "/v2/EviNotice/Affidavits/{Id}": { "get": { "tags": [ "EviNotice" ], "summary": "Download one EviNotice affidavit", "operationId": "eviNoticeAffidavitDownload", "security": [ { "basicAuth": [] } ], "parameters": [ { "name": "Id", "in": "path", "required": true, "description": "The UUID of the affidavit.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "PDF file containing the requested affidavit.", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Authentication failed" }, "404": { "description": "Affidavit not found." } } } }, "/v2/EviNotice/Affidavits/Request": { "post": { "tags": [ "EviNotice" ], "summary": "Request an on-demand affidavit", "operationId": "eviNoticeAffidavitRequest", "description": "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 `Draft`, not `Closed`, and within the configured per-notice on-demand limit.\n", "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviNoticeAffidavitRequestBody" } } } }, "responses": { "200": { "description": "Affidavit request accepted. Generation is asynchronous; an AffidavitPublished callback fires when the affidavit is ready.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviNoticeAffidavitRequestResponse" } } } }, "401": { "description": "Authentication failed" }, "403": { "description": "The per-notice on-demand affidavit limit has been reached." }, "405": { "description": "OnDemand was not included in AffidavitKinds at submission, or the notice is in a state that does not support on-demand affidavit generation (Draft or Closed).\n" } } } }, "/v2/EviNotice/Batches": { "post": { "tags": [ "EviNotice" ], "summary": "Create a notice batch", "operationId": "eviNoticeBatchCreate", "description": "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 by all other batch operations.\n", "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviNoticeBatchCreateRequest" }, "example": { "Description": "March 2026 customer notices" } } } }, "responses": { "200": { "description": "Batch created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviNoticeBatchCreateResponse" }, "example": { "BatchId": "550e8400-e29b-41d4-a716-446655440000" } } } }, "401": { "description": "Authentication failed" }, "500": { "description": "Internal server error" } } }, "get": { "tags": [ "EviNotice" ], "summary": "Query notice batches (HTTP QUERY method)", "operationId": "eviNoticeBatchesQuery", "description": "Lists notice batches owned by the caller (or the caller's site), with cursor pagination.\n\n**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 filter fields as query parameters. In practice, send an HTTP `QUERY` request with the fields in a JSON body (`States`, `Cursor`, `Limit`, `SortBy`, `SortOrder`, `Direction`, `TextSearch`).\n", "security": [ { "basicAuth": [] } ], "parameters": [ { "name": "States", "in": "query", "description": "Filter by one or more batch states.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "Draft", "Submitted", "Scheduled", "Processing", "Processed", "Invalid", "Failed" ] } } }, { "name": "Cursor", "in": "query", "description": "Opaque pagination cursor returned by the previous response.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "required": true, "description": "Maximum number of batches to return (1–100).", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "SortBy", "in": "query", "schema": { "type": "string", "enum": [ "None", "LastUpdated", "ScheduledFor", "StartedOn" ], "default": "LastUpdated" } }, { "name": "SortOrder", "in": "query", "schema": { "type": "string", "enum": [ "None", "Ascending", "Descending" ], "default": "Ascending" } }, { "name": "Direction", "in": "query", "schema": { "type": "string", "enum": [ "None", "Forward", "Backward" ], "default": "Forward" } }, { "name": "TextSearch", "in": "query", "description": "Free-text search over batch descriptions.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Query executed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviNoticeBatchesQueryResponse" } } } }, "400": { "description": "Malformed request (invalid state, sort, or direction value)." }, "401": { "description": "Authentication failed" } } } }, "/v2/EviNotice/Batches/{BatchId}": { "parameters": [ { "name": "BatchId", "in": "path", "required": true, "description": "The UUID of the batch, as returned at creation.", "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "EviNotice" ], "summary": "Get a notice batch", "operationId": "eviNoticeBatchGet", "description": "Retrieves the full state of a batch, including its configured notice template and processing progress.", "security": [ { "basicAuth": [] } ], "responses": { "200": { "description": "Batch retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviNoticeBatchGetResponse" } } } }, "400": { "description": "BatchId is missing or a default (empty) UUID." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } }, "patch": { "tags": [ "EviNotice" ], "summary": "Update a notice batch", "operationId": "eviNoticeBatchPatch", "description": "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 schedule it). Setting `ScheduledDate` schedules the batch for later dispatch. Batch scheduling uses UTC. Specify `ScheduledDate` in UTC.\n", "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviNoticeBatchPatchRequest" }, "example": { "Subject": "Important notice regarding your account", "IssuerName": "Sender Co.", "CertificationLevel": "Advanced_EU", "Language": "en", "State": "Submitted" } } } }, "responses": { "200": { "description": "Batch updated." }, "400": { "description": "Invalid request." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } }, "delete": { "tags": [ "EviNotice" ], "summary": "Delete a notice batch", "operationId": "eviNoticeBatchDelete", "description": "Removes a previously created batch.", "security": [ { "basicAuth": [] } ], "responses": { "204": { "description": "Batch deleted." }, "400": { "description": "Invalid request." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } } }, "/v2/EviNotice/Batches/{BatchId}/Body": { "parameters": [ { "name": "BatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "put": { "tags": [ "EviNotice" ], "summary": "Set the batch body", "operationId": "eviNoticeBatchBodyPut", "description": "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`.\n", "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "text/html": { "schema": { "type": "string" }, "example": "We inform you that today is a very interesting day.
" } } }, "responses": { "202": { "description": "Body accepted and queued for update. Poll GET .../{BatchId} to check status." }, "400": { "description": "The request has no valid body." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } } }, "/v2/EviNotice/Batches/{BatchId}/Recipients": { "parameters": [ { "name": "BatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "post": { "tags": [ "EviNotice" ], "summary": "Add batch recipients (CSV)", "operationId": "eviNoticeBatchRecipientsPost", "description": "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`, `custodychallenge`, `custodychallengeresponse`, `deliverychallenge`, `deliverychallengeresponse`, `deliveryotpchannel`, `deliveryotpaddress`. Custom per-recipient fields are added as extra columns prefixed with `*` (for example, `*orderid`).\n", "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "text/csv": { "schema": { "type": "string" }, "example": "address;legalname;displayname;*orderid\njane@example.com;Acme Corp;Jane Doe;ORD-001\njohn@example.com;Beta Ltd;John Roe;ORD-002\n" } } }, "responses": { "200": { "description": "Recipients accepted. No response body is returned." }, "400": { "description": "The recipient payload is empty or the Content-Type is not `text/csv`." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." }, "409": { "description": "The recipient list failed validation (for example, missing mandatory columns)." } } }, "get": { "tags": [ "EviNotice" ], "summary": "Query batch recipients (HTTP QUERY method)", "operationId": "eviNoticeBatchRecipientsQuery", "description": "Lists the recipients of a batch, with cursor pagination.\n\n**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 filter fields as query parameters. In practice, send an HTTP `QUERY` request with the fields (`Cursor`, `Limit`, `SortDirection`) in a JSON body.\n", "security": [ { "basicAuth": [] } ], "parameters": [ { "name": "Cursor", "in": "query", "description": "Opaque pagination cursor returned by the previous response.", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "description": "Maximum number of recipients to return (1–1000).", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string", "enum": [ "None", "Ascending", "Descending" ] } } ], "responses": { "200": { "description": "Query executed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviNoticeBatchRecipientsQueryResponse" } } } }, "400": { "description": "Malformed request." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } }, "delete": { "tags": [ "EviNotice" ], "summary": "Delete all batch recipients", "operationId": "eviNoticeBatchRecipientsDelete", "description": "Removes all recipients from the batch.", "security": [ { "basicAuth": [] } ], "responses": { "204": { "description": "Recipients removed." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } } }, "/v2/EviNotice/Batches/{BatchId}/Attachments": { "parameters": [ { "name": "BatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "post": { "tags": [ "EviNotice" ], "summary": "Add a batch attachment", "operationId": "eviNoticeBatchAttachmentsPost", "description": "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.\n", "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Content": { "type": "string", "format": "binary", "description": "The attachment file content." }, "DisplayName": { "type": "string" }, "Filename": { "type": "string" }, "ContentId": { "type": "string", "description": "A Content-ID that can be referenced with `cid:` in the body HTML to embed the attachment inline." }, "MimeType": { "type": "string" }, "ContentDescription": { "type": "string" }, "ContentDisposition": { "type": "string" }, "ContentLocation": { "type": "string" }, "ContentEncoding": { "type": "string" }, "IncludeOnAffidavits": { "type": "boolean" } }, "required": [ "Content" ] } } } }, "responses": { "200": { "description": "Attachment added.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviNoticeBatchAttachmentPostResponse" } } } }, "400": { "description": "No file was supplied, or more than one file was supplied." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } }, "get": { "tags": [ "EviNotice" ], "summary": "List batch attachments", "operationId": "eviNoticeBatchAttachmentsGet", "description": "Returns metadata for all attachments configured on the batch.", "security": [ { "basicAuth": [] } ], "responses": { "200": { "description": "Attachment metadata returned.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EviNoticeBatchAttachmentInfo" } } } } }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } }, "delete": { "tags": [ "EviNotice" ], "summary": "Delete all batch attachments", "operationId": "eviNoticeBatchAttachmentsDelete", "description": "Removes all attachments from the batch.", "security": [ { "basicAuth": [] } ], "responses": { "204": { "description": "Attachments removed." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } } }, "/v2/EviNotice/Batches/{BatchId}/Attachments/{AttachmentId}": { "parameters": [ { "name": "BatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "AttachmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "EviNotice" ], "summary": "Download a batch attachment", "operationId": "eviNoticeBatchAttachmentGet", "description": "Downloads the binary content of a single batch attachment.", "security": [ { "basicAuth": [] } ], "responses": { "200": { "description": "Attachment content.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Authentication failed" }, "404": { "description": "No attachment or batch with the given IDs was found." } } }, "delete": { "tags": [ "EviNotice" ], "summary": "Delete a batch attachment", "operationId": "eviNoticeBatchAttachmentDelete", "description": "Removes a single attachment from the batch.", "security": [ { "basicAuth": [] } ], "responses": { "204": { "description": "Attachment removed." }, "401": { "description": "Authentication failed" }, "404": { "description": "No attachment or batch with the given IDs was found." } } } }, "/v1/EviMail/Submit": { "post": { "tags": [ "EviMail" ], "summary": "Submit a certified email", "operationId": "eviMailSubmit", "security": [ { "basicAuth": [] } ], "parameters": [ { "name": "X-Evi-IdempotencyToken", "in": "header", "required": false, "description": "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.\n", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviMailSubmitRequest" }, "examples": { "emailOk": { "value": { "Subject": "Certified email example", "Body": "Hello, this is a certified email.
", "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.pdf", "MimeType": "application/pdf", "Data": "base64-content", "Attributes": [ { "Key": "IncludeOnAffidavits", "Value": "true" } ] } ], "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": { "200": { "description": "Email accepted", "headers": { "X-Evi-IdempotencyStatus": { "description": "Idempotency outcome for the submission request.", "schema": { "type": "string", "enum": [ "New" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviMailSubmitResponse" } } } }, "202": { "description": "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.", "headers": { "X-Evi-IdempotencyStatus": { "description": "Idempotency outcome for the submission request.", "schema": { "type": "string", "enum": [ "Replay" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviMailSubmitResponse" } } } }, "400": { "description": "Invalid request or business rule failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviMailError" } } } }, "401": { "description": "Authentication failed" }, "403": { "description": "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.\n" }, "409": { "description": "Another Submit with the same X-Evi-IdempotencyToken is currently in flight.", "headers": { "X-Evi-IdempotencyStatus": { "description": "Idempotency outcome for the submission request.", "schema": { "type": "string", "enum": [ "Conflict" ] } } } } } } }, "/v1/EviMail/Query": { "get": { "tags": [ "EviMail" ], "summary": "Query certified emails (GET)", "operationId": "eviMailQueryGet", "security": [ { "basicAuth": [] } ], "parameters": [ { "name": "WithUniqueIds", "in": "query", "schema": { "type": "string" } }, { "name": "WithLookupKeys", "in": "query", "schema": { "type": "string" } }, { "name": "WithLinkedId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "OnState", "in": "query", "schema": { "type": "string", "enum": [ "Draft", "New", "Ready", "Sent", "Dispatched", "Delivered", "Read", "Replied", "Closed", "Failed" ] } }, { "name": "WithOutcome", "in": "query", "schema": { "type": "string", "enum": [ "None", "Certified", "Sent", "Delivered", "Read", "Accepted", "Rejected", "Failed" ] } }, { "name": "OrderResultsBy", "in": "query", "schema": { "type": "string", "enum": [ "CreationDate" ] } }, { "name": "Limit", "in": "query", "schema": { "type": "integer" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer" } }, { "name": "IncludeAffidavits", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeAffidavitBlobs", "in": "query", "deprecated": true, "description": "Deprecated. When true with IncludeAffidavits, includes Base64 affidavit PDFs in affidavits[].bytes and limits the query to one email. Set false for metadata-only results and use /AffidavitsDownload for new integrations.", "schema": { "type": "boolean" } }, { "name": "IncludeAttachments", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Query executed successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviMailQueryResponse" } } } }, "401": { "description": "Authentication failed" } } } }, "/v1/EviMail/AffidavitRequest": { "post": { "tags": [ "EviMail" ], "summary": "Request an on-demand affidavit", "operationId": "eviMailAffidavitRequest", "description": "Generates a custom affidavit for a previously submitted EviMail. The original Submit request must have included `AffidavitKinds` containing `OnDemand`, and the communication must still be eligible for on-demand affidavits.\n", "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviMailAffidavitRequest" }, "example": { "UniqueId": "87ffa214-e773-4bd5-9b8d-a8ef00fd80f8", "IncludeBody": true, "IncludeAttachments": true, "IncludeEvents": true } } } }, "responses": { "200": { "description": "Affidavit request accepted. Generation is asynchronous.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviMailAffidavitResponse" }, "example": { "requestId": "79726a87000c1f7042aca3ea149f9438" } } } }, "400": { "description": "Invalid request or business rule failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviMailAffidavitError" } } } }, "401": { "description": "Authentication failed" } } } }, "/v2/EviMail/Batches": { "servers": [ { "url": "https://api.evicertia.com" }, { "url": "https://api.ecertia.com" } ], "post": { "tags": [ "EviMail" ], "summary": "Create an email batch", "operationId": "eviMailBatchCreate", "description": "Creates a new, empty email 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 by all other batch operations.\n", "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviMailBatchCreateRequest" }, "example": { "Description": "March 2026 customer emails" } } } }, "responses": { "200": { "description": "Batch created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviMailBatchCreateResponse" }, "example": { "BatchId": "550e8400-e29b-41d4-a716-446655440000" } } } }, "401": { "description": "Authentication failed" }, "500": { "description": "Internal server error" } } }, "get": { "tags": [ "EviMail" ], "summary": "Query email batches (HTTP QUERY method)", "operationId": "eviMailBatchesQuery", "description": "Lists email batches owned by the caller (or the caller's site), with cursor pagination.\n\n**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 filter fields as query parameters. In practice, send an HTTP `QUERY` request with the fields in a JSON body (`States`, `Cursor`, `Limit`, `SortBy`, `SortOrder`, `Direction`, `TextSearch`).\n", "security": [ { "basicAuth": [] } ], "parameters": [ { "name": "States", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "Draft", "Submitted", "Scheduled", "Processing", "Processed", "Invalid", "Failed" ] } } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "SortBy", "in": "query", "schema": { "type": "string", "enum": [ "None", "LastUpdated", "ScheduledFor", "StartedOn" ], "default": "LastUpdated" } }, { "name": "SortOrder", "in": "query", "schema": { "type": "string", "enum": [ "None", "Ascending", "Descending" ], "default": "Ascending" } }, { "name": "Direction", "in": "query", "schema": { "type": "string", "enum": [ "None", "Forward", "Backward" ], "default": "Forward" } }, { "name": "TextSearch", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Query executed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviMailBatchesQueryResponse" } } } }, "400": { "description": "Malformed request." }, "401": { "description": "Authentication failed" } } } }, "/v2/EviMail/Batches/{BatchId}": { "servers": [ { "url": "https://api.evicertia.com" }, { "url": "https://api.ecertia.com" } ], "parameters": [ { "name": "BatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "EviMail" ], "summary": "Get an email batch", "operationId": "eviMailBatchGet", "description": "Retrieves the full state of a batch, including its configured email template and processing progress.", "security": [ { "basicAuth": [] } ], "responses": { "200": { "description": "Batch retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviMailBatchGetResponse" } } } }, "400": { "description": "BatchId is missing or a default (empty) UUID." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } }, "patch": { "tags": [ "EviMail" ], "summary": "Update an email batch", "operationId": "eviMailBatchPatch", "description": "Updates batch metadata and the email template options. All fields are optional; only the fields supplied are changed. Setting `State` transitions the batch (for example, to start processing). Setting `ScheduledDate` schedules the batch. Batch scheduling uses UTC. Specify `ScheduledDate` in UTC.\n", "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviMailBatchPatchRequest" }, "example": { "Subject": "Your March statement", "IssuerName": "Sender Corp.", "CertificationLevel": "Advanced_EU", "Language": "en", "State": "Submitted" } } } }, "responses": { "200": { "description": "Batch updated." }, "400": { "description": "Invalid request." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } }, "delete": { "tags": [ "EviMail" ], "summary": "Delete an email batch", "operationId": "eviMailBatchDelete", "description": "Removes a previously created batch.", "security": [ { "basicAuth": [] } ], "responses": { "204": { "description": "Batch deleted." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } } }, "/v2/EviMail/Batches/{BatchId}/Body": { "servers": [ { "url": "https://api.evicertia.com" }, { "url": "https://api.ecertia.com" } ], "parameters": [ { "name": "BatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "put": { "tags": [ "EviMail" ], "summary": "Set the batch body", "operationId": "eviMailBatchBodyPut", "description": "Sets the HTML body of the email 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`.\n", "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "text/html": { "schema": { "type": "string" }, "example": "Hello, this is a certified email.
" } } }, "responses": { "202": { "description": "Body accepted and queued for update. Poll GET .../{BatchId} to check status." }, "400": { "description": "The request has no valid body." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } } }, "/v2/EviMail/Batches/{BatchId}/Recipients": { "servers": [ { "url": "https://api.evicertia.com" }, { "url": "https://api.ecertia.com" } ], "parameters": [ { "name": "BatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "post": { "tags": [ "EviMail" ], "summary": "Add batch recipients (CSV)", "operationId": "eviMailBatchRecipientsPost", "description": "Adds recipients to the batch by uploading a `text/csv` file. The CSV uses `;` as the column separator. Mandatory columns: `emailaddress`, `legalname`. Optional columns: `lookupkey`, `displayname`, `evidenceaccesscontrolchallenge`, `evidenceaccesscontrolchallengeresponse`. Custom per-recipient fields are added as extra columns prefixed with `*` (for example, `*orderid`).\n", "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "text/csv": { "schema": { "type": "string" }, "example": "emailaddress;legalname;displayname;*orderid\njane@example.com;Acme Corp;Jane Doe;ORD-001\njohn@example.com;Beta Ltd;John Roe;ORD-002\n" } } }, "responses": { "200": { "description": "Recipients accepted. No response body is returned." }, "400": { "description": "The recipient payload is empty or the Content-Type is not `text/csv`." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." }, "409": { "description": "The recipient list failed validation (for example, missing mandatory columns)." } } }, "get": { "tags": [ "EviMail" ], "summary": "Query batch recipients (HTTP QUERY method)", "operationId": "eviMailBatchRecipientsQuery", "description": "Lists the recipients of a batch, with cursor pagination.\n\n**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 filter fields as query parameters. In practice, send an HTTP `QUERY` request with the fields (`Cursor`, `Limit`, `SortDirection`) in a JSON body.\n", "security": [ { "basicAuth": [] } ], "parameters": [ { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string", "enum": [ "None", "Ascending", "Descending" ] } } ], "responses": { "200": { "description": "Query executed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviMailBatchRecipientsQueryResponse" } } } }, "400": { "description": "Malformed request." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } }, "delete": { "tags": [ "EviMail" ], "summary": "Delete all batch recipients", "operationId": "eviMailBatchRecipientsDelete", "description": "Removes all recipients from the batch.", "security": [ { "basicAuth": [] } ], "responses": { "204": { "description": "Recipients removed." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } } }, "/v2/EviMail/Batches/{BatchId}/Attachments": { "servers": [ { "url": "https://api.evicertia.com" }, { "url": "https://api.ecertia.com" } ], "parameters": [ { "name": "BatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "post": { "tags": [ "EviMail" ], "summary": "Add a batch attachment", "operationId": "eviMailBatchAttachmentsPost", "description": "Adds a single attachment to the batch by uploading it as `multipart/form-data`. The attachment is included in every email generated from the batch.\n", "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Content": { "type": "string", "format": "binary", "description": "The attachment file content." }, "DisplayName": { "type": "string" }, "Filename": { "type": "string" }, "ContentId": { "type": "string" }, "MimeType": { "type": "string" }, "ContentDescription": { "type": "string" }, "ContentDisposition": { "type": "string" }, "ContentLocation": { "type": "string" }, "ContentEncoding": { "type": "string" }, "IncludeOnAffidavits": { "type": "boolean" } }, "required": [ "Content" ] } } } }, "responses": { "200": { "description": "Attachment added.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviMailBatchAttachmentPostResponse" } } } }, "400": { "description": "No file was supplied, or more than one file was supplied." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } }, "get": { "tags": [ "EviMail" ], "summary": "List batch attachments", "operationId": "eviMailBatchAttachmentsGet", "description": "Returns metadata for all attachments configured on the batch.", "security": [ { "basicAuth": [] } ], "responses": { "200": { "description": "Attachment metadata returned.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EviMailBatchAttachmentInfo" } } } } }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } }, "delete": { "tags": [ "EviMail" ], "summary": "Delete all batch attachments", "operationId": "eviMailBatchAttachmentsDelete", "description": "Removes all attachments from the batch.", "security": [ { "basicAuth": [] } ], "responses": { "204": { "description": "Attachments removed." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } } }, "/v2/EviMail/Batches/{BatchId}/Attachments/{AttachmentId}": { "servers": [ { "url": "https://api.evicertia.com" }, { "url": "https://api.ecertia.com" } ], "parameters": [ { "name": "BatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "AttachmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "EviMail" ], "summary": "Download a batch attachment", "operationId": "eviMailBatchAttachmentGet", "description": "Downloads the binary content of a single batch attachment.", "security": [ { "basicAuth": [] } ], "responses": { "200": { "description": "Attachment content.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Authentication failed" }, "404": { "description": "No attachment or batch with the given IDs was found." } } }, "delete": { "tags": [ "EviMail" ], "summary": "Delete a batch attachment", "operationId": "eviMailBatchAttachmentDelete", "description": "Removes a single attachment from the batch.", "security": [ { "basicAuth": [] } ], "responses": { "204": { "description": "Attachment removed." }, "401": { "description": "Authentication failed" }, "404": { "description": "No attachment or batch with the given IDs was found." } } } }, "/v1/EviSms/Submit": { "post": { "tags": [ "EviSMS" ], "summary": "Submit a certified SMS", "operationId": "eviSmsSubmit", "security": [ { "basicAuth": [] } ], "parameters": [ { "name": "X-Evi-IdempotencyToken", "in": "header", "required": false, "description": "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.\n", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviSmsSubmitRequest" }, "examples": { "smsOk": { "value": { "Text": "We inform you that your request has been processed.", "LookupKey": "SMS-001", "IssuerName": "SendCo", "Recipient": { "LegalName": "Recipient Corp.", "PhoneNumber": "+34600000000" }, "Options": { "CertificationLevel": "Advanced_EU", "DeliveryChannels": [ "SMS" ], "TimeToLive": 11400, "Language": "es", "AffidavitLanguage": "es", "AffidavitKinds": [ "Submitted", "TransmissionResult", "DeliveryResult", "Read", "Closed", "CompleteAdvanced" ], "PushNotificationFilter": [ "Ready", "Sent", "Dispatched", "Delivered", "Read", "Failed", "Closed", "AffidavitPublished" ], "PushNotificationUrl": "https://your-system.example.com/callbacks/evisms", "EvidenceAccessControlMethod": "Challenge", "EvidenceAccessControlChallenge": "What is your mother's maiden name?", "EvidenceAccessControlChallengeResponse": "Smith", "OnlineRetentionPeriod": 1 } } } } } } }, "responses": { "200": { "description": "SMS accepted", "headers": { "X-Evi-IdempotencyStatus": { "description": "Idempotency outcome for the submission request.", "schema": { "type": "string", "enum": [ "New" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviSmsSubmitResponse" } } } }, "202": { "description": "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.", "headers": { "X-Evi-IdempotencyStatus": { "description": "Idempotency outcome for the submission request.", "schema": { "type": "string", "enum": [ "Replay" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviSmsSubmitResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviSmsError" } } } }, "401": { "description": "Authentication failed" }, "403": { "description": "The authenticated account lacks the required API permission for EviSMS." }, "409": { "description": "Another Submit with the same X-Evi-IdempotencyToken is currently in flight.", "headers": { "X-Evi-IdempotencyStatus": { "description": "Idempotency outcome for the submission request.", "schema": { "type": "string", "enum": [ "Conflict" ] } } } } } } }, "/v1/EviSms/Query": { "get": { "tags": [ "EviSMS" ], "summary": "Query certified SMS messages (GET)", "operationId": "eviSmsQueryGet", "security": [ { "basicAuth": [] } ], "parameters": [ { "name": "WithUniqueIds", "in": "query", "schema": { "type": "string" } }, { "name": "WithLookupKeys", "in": "query", "schema": { "type": "string" } }, { "name": "WithLinkedId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "OnState", "in": "query", "description": "Filters results by the current EviSMS state. `Replied` is not part of the current public EviSMS lifecycle.", "schema": { "type": "string", "enum": [ "Draft", "New", "Ready", "Sent", "Dispatched", "Delivered", "Read", "Closed", "Failed" ] } }, { "name": "WithOutcome", "in": "query", "schema": { "type": "string", "enum": [ "None", "Certified", "Sent", "Delivered", "Read", "Accepted", "Rejected", "Failed" ] } }, { "name": "OrderResultsBy", "in": "query", "schema": { "type": "string", "enum": [ "CreationDate" ] } }, { "name": "Limit", "in": "query", "description": "Maximum results to return. Defaults to 100; drops to 25 when affidavit metadata is included.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "Offset", "in": "query", "schema": { "type": "integer" } }, { "name": "IncludeAffidavits", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeAffidavitBlobs", "in": "query", "deprecated": true, "description": "Deprecated. When true with IncludeAffidavits, includes Base64 affidavit PDFs in affidavits[].bytes and limits the query to one message. Set false for metadata-only results and use /AffidavitsDownload for new integrations.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Query executed successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviSmsQueryResponse" } } } }, "401": { "description": "Authentication failed" } } } }, "/v2/EviSms/Batches": { "servers": [ { "url": "https://api.evicertia.com" }, { "url": "https://api.ecertia.com" } ], "post": { "tags": [ "EviSMS" ], "summary": "Create an SMS batch", "operationId": "eviSmsBatchCreate", "description": "Creates a new, empty SMS batch. Only a `Description` is required at creation; the message text, recipients, and options are set with the subsequent batch endpoints. Returns the `BatchId` used by all other batch operations.\n", "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviSmsBatchCreateRequest" }, "example": { "Description": "March 2026 customer SMS" } } } }, "responses": { "200": { "description": "Batch created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviSmsBatchCreateResponse" }, "example": { "BatchId": "550e8400-e29b-41d4-a716-446655440000" } } } }, "401": { "description": "Authentication failed" }, "500": { "description": "Internal server error" } } }, "get": { "tags": [ "EviSMS" ], "summary": "Query SMS batches (HTTP QUERY method)", "operationId": "eviSmsBatchesQuery", "description": "Lists SMS batches owned by the caller (or the caller's site), with cursor pagination.\n\n**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 filter fields as query parameters. In practice, send an HTTP `QUERY` request with the fields in a JSON body (`States`, `Cursor`, `Limit`, `SortBy`, `SortOrder`, `Direction`, `TextSearch`).\n", "security": [ { "basicAuth": [] } ], "parameters": [ { "name": "States", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "Draft", "Submitted", "Scheduled", "Processing", "Processed", "Invalid", "Failed" ] } } }, { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "SortBy", "in": "query", "schema": { "type": "string", "enum": [ "None", "LastUpdated", "ScheduledFor", "StartedOn" ], "default": "LastUpdated" } }, { "name": "SortOrder", "in": "query", "schema": { "type": "string", "enum": [ "None", "Ascending", "Descending" ], "default": "Ascending" } }, { "name": "Direction", "in": "query", "schema": { "type": "string", "enum": [ "None", "Forward", "Backward" ], "default": "Forward" } }, { "name": "TextSearch", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Query executed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviSmsBatchesQueryResponse" } } } }, "400": { "description": "Malformed request." }, "401": { "description": "Authentication failed" } } } }, "/v2/EviSms/Batches/{BatchId}": { "servers": [ { "url": "https://api.evicertia.com" }, { "url": "https://api.ecertia.com" } ], "parameters": [ { "name": "BatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "tags": [ "EviSMS" ], "summary": "Get an SMS batch", "operationId": "eviSmsBatchGet", "description": "Retrieves the full state of a batch, including its configured message template and processing progress.", "security": [ { "basicAuth": [] } ], "responses": { "200": { "description": "Batch retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviSmsBatchGetResponse" } } } }, "400": { "description": "BatchId is missing or a default (empty) UUID." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } }, "patch": { "tags": [ "EviSMS" ], "summary": "Update an SMS batch", "operationId": "eviSmsBatchPatch", "description": "Updates batch metadata and the message template options, including the SMS `Text`. All fields are optional; only the fields supplied are changed. Setting `State` transitions the batch (for example, to start processing). Setting `ScheduledDate` schedules the batch. Batch scheduling uses UTC. Specify `ScheduledDate` in UTC.\n", "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviSmsBatchPatchRequest" }, "example": { "Text": "We inform you that your request has been processed.", "IssuerName": "SendCo", "CertificationLevel": "Advanced_EU", "Language": "es", "State": "Submitted" } } } }, "responses": { "200": { "description": "Batch updated." }, "400": { "description": "Invalid request." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } }, "delete": { "tags": [ "EviSMS" ], "summary": "Delete an SMS batch", "operationId": "eviSmsBatchDelete", "description": "Removes a previously created batch.", "security": [ { "basicAuth": [] } ], "responses": { "204": { "description": "Batch deleted." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } } }, "/v2/EviSms/Batches/{BatchId}/Recipients": { "servers": [ { "url": "https://api.evicertia.com" }, { "url": "https://api.ecertia.com" } ], "parameters": [ { "name": "BatchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "post": { "tags": [ "EviSMS" ], "summary": "Add batch recipients (CSV)", "operationId": "eviSmsBatchRecipientsPost", "description": "Adds recipients to the batch by uploading a `text/csv` file. The CSV uses `;` as the column separator. Mandatory columns: `phonenumber`, `legalname`. Optional columns: `lookupkey`, `evidenceaccesscontrolchallenge`, `evidenceaccesscontrolchallengeresponse`. Custom per-recipient fields are added as extra columns prefixed with `*` (for example, `*orderid`).\n", "security": [ { "basicAuth": [] } ], "requestBody": { "required": true, "content": { "text/csv": { "schema": { "type": "string" }, "example": "phonenumber;legalname;lookupkey;*orderid\n+34600000000;Acme Corp;SMS-001;ORD-001\n+34600000001;Beta Ltd;SMS-002;ORD-002\n" } } }, "responses": { "200": { "description": "Recipients accepted. No response body is returned." }, "400": { "description": "The recipient payload is empty or the Content-Type is not `text/csv`." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." }, "409": { "description": "The recipient list failed validation (for example, missing mandatory columns)." } } }, "get": { "tags": [ "EviSMS" ], "summary": "Query batch recipients (HTTP QUERY method)", "operationId": "eviSmsBatchRecipientsQuery", "description": "Lists the recipients of a batch, with cursor pagination.\n\n**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 filter fields as query parameters. In practice, send an HTTP `QUERY` request with the fields (`Cursor`, `Limit`, `SortDirection`) in a JSON body.\n", "security": [ { "basicAuth": [] } ], "parameters": [ { "name": "Cursor", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000 } }, { "name": "SortDirection", "in": "query", "schema": { "type": "string", "enum": [ "None", "Ascending", "Descending" ] } } ], "responses": { "200": { "description": "Query executed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviSmsBatchRecipientsQueryResponse" } } } }, "400": { "description": "Malformed request." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } }, "delete": { "tags": [ "EviSMS" ], "summary": "Delete all batch recipients", "operationId": "eviSmsBatchRecipientsDelete", "description": "Removes all recipients from the batch.", "security": [ { "basicAuth": [] } ], "responses": { "204": { "description": "Recipients removed." }, "401": { "description": "Authentication failed" }, "404": { "description": "No batch with the given BatchId was found." } } } }, "/v1/EviPost/Submit": { "post": { "tags": [ "EviPost" ], "summary": "Submit a certified postal communication", "operationId": "eviPostSubmit", "security": [ { "basicAuth": [] } ], "parameters": [ { "name": "X-Evi-IdempotencyToken", "in": "header", "required": false, "description": "Optional idempotency token (GUID 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.\n", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EviPostSubmitRequest" }, "examples": { "registeredPost": { "summary": "Registered postal communication", "value": { "LookupKey": "a2R4S25kWiu79fsbubSXkw==", "Document": "