{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/namirialnotify/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"API reference overview","description":"Integration and usage documentation.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-reference-overview","__idx":0},"children":["API reference overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Namirial Notify provides REST APIs for sending certified communications and"," ","retrieving related evidence. Service APIs let you submit messages or notices,"," ","query their status, and receive real-time callbacks when their state changes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"available-apis","__idx":1},"children":["Available APIs"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API"},"children":["API"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Service"},"children":["Service"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Use case"},"children":["Use case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Version"},"children":["Version"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evimail-api"},"children":["EviMail API"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Certified email"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Send legally binding emails with proof of delivery and read receipts"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["v1"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evinotice-api"},"children":["EviNotice API"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hosted notices"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Send notices with hosted content, digital signatures, and commitment tracking"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["v2"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evisms-api"},"children":["EviSMS API"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SMS & RCS"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Send certified SMS messages with optional RCS enhancements"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["v1"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evipost-api"},"children":["EviPost API"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Physical postal"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Send certified physical postal communications (burofax equivalent) with delivery tracking"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["v1"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/downloads-api"},"children":["Shared download APIs"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attachments"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Download attachments directly when you already have their IDs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["v1"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each reference page includes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Complete endpoint descriptions with request/response examples"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Key request and response fields"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["State and outcome tables"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Links to the full OpenAPI 3.0.3 specification"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the unified ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/oas/namirialnotify-api"},"children":["Namirial Notify OpenAPI"]}," page to browse all documented service endpoints in one place."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-patterns","__idx":2},"children":["Common patterns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Service APIs share these fundamental patterns:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Submit"]}," — POST a message with metadata, recipients, options, and optional attachments. Returns a unique ID."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query"]}," — GET or POST to retrieve the status of one or many submitted messages, filtered by ID, state, outcome, or lookup key."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Callbacks"]}," — Configure ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationUrl"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]}," to receive real-time webhooks when messages change state."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["States & outcomes"]}," — Submitted messages move through a service-specific lifecycle, with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]}," as the terminal state. Intermediate milestones such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]}," appear only when the corresponding event is recorded; at closure, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Outcome"]}," reports the final result."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Affidavits"]}," — Request evidence records (affidavits) to be generated for"," ","key events. Retrieve them from query results or dedicated download endpoints,"," ","depending on the service."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"getting-started","__idx":3},"children":["Getting started"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"authentication","__idx":4},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All APIs require ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HTTP Basic authentication"]},". Include your Namirial Notify credentials (username and password) in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Authorization: Basic <base64(username:password)>\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Contact your Namirial Notify account manager if you don't have credentials yet."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"environments","__idx":5},"children":["Environments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Test in pre-production before switching to production:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Environment"},"children":["Environment"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Base URL"},"children":["Base URL"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Use"},"children":["Use"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Production"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.evicertia.com"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Live certified communications"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Pre-production / QA"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.ecertia.com"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Testing and integration"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the public Namirial Notify API environments, EviMail, EviSMS, and EviPost are exposed under the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1"]}," base path."," ","Use public routes such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/EviMail/Submit"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/EviSms/Submit"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/EviPost/Submit"]},". Shared download source contracts expose routes such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/AttachmentDownload"]},"; use the route style shown in the relevant reference page for that API."," ","EviNotice uses the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/"]}," path prefix. The legacy ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v2/..."]}," form is still accepted for backward compatibility."," ","Some lower-level technical artifacts may show V1 routes without the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1"]}," prefix. For customer integrations, use the public paths shown in this documentation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-and-response-format","__idx":6},"children":["Request and response format"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All APIs accept ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["JSON"]}," for requests and return ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["JSON"]}," for most responses. The exceptions are download endpoints, such as EviNotice attachment and affidavit downloads, which return binary files or ZIP packages. Timestamps are ISO 8601 format. Large payloads (query results) may be paginated using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Limit"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Offset"]}," (EviMail, EviSMS, EviPost) or cursors (EviNotice)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":7},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Choose your API"]}," — Read the use case table above and pick the service that matches your need. Then dive into its reference page."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Set up integration"]}," — See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev"},"children":["Development and integration guides"]}," for API collections, callback setup, and best practices."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Handle failures consistently"]}," — Use the shared ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/error-handling"},"children":["Error handling"]}," guide."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Follow end-to-end patterns"]}," — Use ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/integration-patterns"},"children":["Integration workflows"]}," for submit, track, and evidence retrieval flows."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Harden your integration"]}," — Review ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/security-best-practices"},"children":["Security and authentication"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Plan for scale"]}," — Review ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/performance-guidelines"},"children":["Performance and scaling"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Understand lifecycle"]}," — Every message has a state and an outcome. Learn the difference in ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/user-guides/states-outcomes"},"children":["States and outcomes"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get evidence"]}," — Understand how to request and use affidavits in ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/user-guides/evidences-affidavits"},"children":["Evidence and affidavits"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Real-time updates"]}," — Set up webhooks and read about callback payload structure in ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/callbacks"},"children":["Callbacks and webhooks"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related","__idx":8},"children":["Related"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/api-documentation"},"children":["API documentation"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev"},"children":["Development and integration guides"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/error-handling"},"children":["Error handling"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/integration-patterns"},"children":["Integration workflows"]}]}]}]},"headings":[{"value":"API reference overview","id":"api-reference-overview","depth":1},{"value":"Available APIs","id":"available-apis","depth":2},{"value":"Common patterns","id":"common-patterns","depth":2},{"value":"Getting started","id":"getting-started","depth":2},{"value":"Authentication","id":"authentication","depth":3},{"value":"Environments","id":"environments","depth":3},{"value":"Request and response format","id":"request-and-response-format","depth":3},{"value":"Next steps","id":"next-steps","depth":2},{"value":"Related","id":"related","depth":2}],"frontmatter":{"title":"API reference overview","description":"Overview of the Namirial Notify REST APIs for EviNotice, EviMail, EviSMS, EviPost, and shared downloads.","layout":"doc","outline":"deep","keywords":["namirial notify api","evinotice api","evimail api","evisms api","evipost api","rest api","openapi"],"seo":{"title":"API reference overview"}},"lastModified":"2026-08-03T09:35:33.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/namirialnotify/apis/overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}