Guides
Start typing to search…

Sending messages

Unimaze enables secure exchange of business documents through the Messaging API (MAPI). This page helps you choose the correct implementation approach and directs you to guided, step-by-step documentation.

Recommended starting point

If this is your first integration, start with one of the guided tours:

These guides walk you through authentication, message creation, and delivery step by step.

Choose your implementation approach

Unimaze supports three ways of sending content. The correct choice depends on how standardized your documents are and how much control you need.

Overview

ApproachRecommended forKey characteristics
JSON metadata (recommended)Faster integration, support for dynamic changes in multiple markets.Automatic lookups and format handling.
Native XMLUse of already existing implementations of local syntaxes.Full control over XML payload. Requires knowledge of local technical syntax specifications.
Raw documentsNon-standard contentNo automation; manual coordination between sender and receiver required

Implementation options

Metadata-driven (recommended)

You send structured JSON metadata describing the business document.
Unimaze automatically performs:

  • Participant and capability lookups.
  • Document type and profile resolution.
  • Conversion to the correct underlying format (for example UBL).

Use this when:

  • You want the simplest and safest integration.
  • You want Unimaze to manage standards and interoperability across networks.

Typical use cases:

  • Invoices, orders, order responses.
  • Other standard business document flows.
📘

Best paired with the Transaction-based Guided Tour.

Native XML

You send or receive a fully constructed XML document (for example UBL).

Use this when:

  • Your system already produces compliant XML.
  • You require full control over the XML structure.
  • You understand the applicable business profiles.

Important considerations:

  • You are responsible for XML correctness.
  • Validation errors will be surfaced by the platform.

Raw documents (advanced / special use)

You send arbitrary document content such as PDFs, images, or custom formats.

⚠️

Important
Raw documents do not use any automatic lookups or document resolution.

This means:

  • No participant or capability lookups
  • No document type or profile resolution
  • No semantic understanding of the content

Sender and receiver must manually agree on:

  • Document meaning
  • Processing rules
  • Any identifiers or conventions used

Unimaze only transports the payload securely.

Use this only when:

  • The document is non-standard or binary
  • Both parties have explicitly coordinated the integration

Where to Go Next

Updated 7 days ago