{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/namirialnotify/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"API documentation","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-documentation","__idx":0},"children":["API documentation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Start here for the Namirial Notify API references."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use these APIs to submit certified communications, query their status, and retrieve related evidence according to the service you are integrating with."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"available-apis","__idx":1},"children":["Available APIs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following API references are available:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evinotice-api"},"children":["EviNotice API"]}," — submit, query, and retrieve certified hosted notices"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evimail-api"},"children":["EviMail API"]}," — submit and query certified emails"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evisms-api"},"children":["EviSMS API"]}," — submit and query certified SMS messages"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evipost-api"},"children":["EviPost API"]}," — submit and query certified physical postal communications"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/downloads-api"},"children":["Shared download APIs"]}," — download attachments by ID"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/oas/namirialnotify-api"},"children":["Namirial Notify OpenAPI"]}," — unified OpenAPI reference for the documented Notify APIs"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each reference page includes an overview of the service, authentication details, base URLs, and a link to the OpenAPI specification."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":2},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These APIs use ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HTTP Basic authentication"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the credentials provided for your Namirial Notify environment and organisation. Authentication requirements can vary depending on the environment and the services enabled for your account."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Always confirm the credentials, enabled services, and environment details with your Namirial Notify technical contact before starting an integration."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"environments","__idx":3},"children":["Environments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The OpenAPI specifications currently reference these environments:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Production"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.evicertia.com"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Pre-production / QA"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.ecertia.com"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Environment availability can depend on your organisation setup and service activation."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"recommended-reading-order","__idx":4},"children":["Recommended reading order"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open the API reference for the service you want to integrate with."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Review the authentication method and available environments."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Check the request and response models for the operations you need."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Read the shared guides for ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/error-handling"},"children":["error handling"]},","," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/integration-patterns"},"children":["integration workflows"]},","," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/security-best-practices"},"children":["security and authentication"]},", and"," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/performance-guidelines"},"children":["performance and scaling"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Validate field values, enum values, and workflow assumptions with your"," ","Namirial Notify SME before going live."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-reference-scope","__idx":5},"children":["API reference scope"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These API references document service-specific REST operations for:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["submitting certified communications"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["querying transactions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["retrieving transaction-related data, where supported"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Callbacks, webhooks, API collections, and no-code options are documented in"," ","their dedicated guides."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"cross-service-guides","__idx":6},"children":["Cross-service guides"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use these shared guides alongside the service reference pages:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$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":"a","attributes":{"href":"/products/namirialnotify/user-guides/evidences-affidavits"},"children":["Evidence and affidavits"]}]},{"$$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"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$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":"a","attributes":{"href":"/products/namirialnotify/dev/performance-guidelines"},"children":["Performance and scaling"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/callbacks"},"children":["Callbacks and webhooks"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/postman-collections"},"children":["API collections"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/no-code-certificame"},"children":["No-code integration"]}]}]}]},"headings":[{"value":"API documentation","id":"api-documentation","depth":1},{"value":"Available APIs","id":"available-apis","depth":2},{"value":"Authentication","id":"authentication","depth":2},{"value":"Environments","id":"environments","depth":2},{"value":"Recommended reading order","id":"recommended-reading-order","depth":2},{"value":"API reference scope","id":"api-reference-scope","depth":2},{"value":"Cross-service guides","id":"cross-service-guides","depth":2}],"frontmatter":{"title":"API documentation","description":"Overview of the Namirial Notify APIs for EviNotice, EviMail, EviSMS, EviPost, and shared downloads, including authentication, environments, and reference links.","layout":"doc","outline":"deep","keywords":["api documentation","namirial notify api","evinotice api","evimail api","evisms api","rest api","openapi","integration"],"seo":{"title":"API documentation"}},"lastModified":"2026-07-28T10:32:13.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/namirialnotify/dev/api-documentation","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}