Passer au contenu

EviPost

Certified physical postal delivery with status tracking, cancellation requests for eligible items, and on-demand affidavits for open Letter and LetterLite items.

Submit a certified postal communication

Requête

Submit a Base64-encoded PDF smaller than 2,097,152 bytes before encoding. Acceptance does not confirm later PDF validation or postal delivery. A processing failure or postal-service rejection can close the communication with outcome Failed; use Query to check the outcome.

Sécurité
basicAuth
En-têtes
X-Evi-IdempotencyTokenstring

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.

Corpsapplication/jsonobligatoire
LookupKeystring

Optional identifier set by the issuer. Can be used later to locate the evidence via the Query endpoint.

Documentstringobligatoire

The document or letter to be sent, base64-encoded PDF.

RecipientNamestring\Sobligatoire

Non-blank display name of the recipient.

RecipientLegalNamestring

Legal name or corporate name of the recipient.

RecipientAddressobject(EviPostAddress)obligatoire
RecipientPhonestring

Recipient phone number. Use + followed by the country code and phone number, with digits only.

RecipientEmailstring, (email)

Email address of the recipient.

IssuerNamestring

Display name of the sender. Supply it explicitly to record it in the evidence.

IssuerLegalNamestring

Legal or corporate name of the sender. Supply it explicitly to record it in the evidence.

IssuerAddressobject(EviPostAddress)
IssuerPhonestring

Issuer phone number. Use + followed by the country code and phone number, with digits only.

IssuerEmailstring, (email)

Email address of the issuer.

IssuerCommentsstring

Optional additional comments from the issuer.

Optionsobject(EviPostOptions)
curl -i -X POST \
  -u '<username>:<password>' \
  https://api.evicertia.com/v1/EviPost/Submit \
  -H 'Content-Type: application/json' \
  -H 'X-Evi-IdempotencyToken: string' \
  -d '{
    "LookupKey": "a2R4S25kWiu79fsbubSXkw==",
    "Document": "<base64-encoded PDF>",
    "RecipientName": "Juan Valido",
    "RecipientLegalName": "Juan Valido",
    "RecipientAddress": {
      "StreetAddress": "Gran Via 74, 5 A",
      "PostalCode": "28014",
      "Locality": "Madrid",
      "Region": "Madrid",
      "Country": "ES"
    },
    "RecipientPhone": "+34677000111",
    "RecipientEmail": "recipient@example.com",
    "IssuerName": "Pedro Comprador",
    "IssuerLegalName": "Pedro Valido",
    "IssuerAddress": {
      "StreetAddress": "C/ Gran Via, 1, 1-A",
      "PostalCode": "28001",
      "Locality": "Madrid",
      "Region": "Madrid",
      "Country": "ES"
    },
    "IssuerPhone": "+34677888777",
    "IssuerEmail": "pedro.comprador@example.com",
    "IssuerComments": "Sending in March.",
    "Options": {
      "PostServiceType": "Registered",
      "Language": "es",
      "CertificationLevel": "Advanced_EU",
      "AffidavitProfile": "AdvancedContentOnSubmit",
      "AffidavitsOnDemandEnabled": false,
      "OnlineRetentionPeriod": 1,
      "NotaryRetentionPeriod": 5,
      "NotaryProfile": "notary:profile",
      "EvidenceAccessControlMethod": "AutoChallenge",
      "CostCentre": "dept-legal",
      "PushNotificationUrl": "https://your-server.example.com/callbacks/evipost",
      "PushNotificationFilter": [
        "Processed",
        "Sent",
        "Delivered",
        "Closed"
      ],
      "PushNotificationExtraData": "{\"myId\": \"order-12345\"}"
    }
  }'

Réponses

Postal communication accepted

En-têtes
X-Evi-IdempotencyStatusstring

Idempotency outcome for the submission request.

Value:"New"
Corpsapplication/json
uniqueIdstring^[0-9a-fA-F]{32}$obligatoire

Unique identifier of the submitted postal communication. Serialized as 32 hexadecimal characters without dashes.

Réponse
{ "uniqueId": "69819c3e0c0e42b3a792a33b014a13a2" }