Encrypted Messaging

Messaging API

Send encrypted messages with document attachments and signature requests to verified UIP users.

Overview

The Messaging API enables secure, encrypted communication between your application and UIP users. Send text messages, documents for signing, legal contracts, and other important communications with configurable notification priorities.

Message Types

✓ Text Messages - Secure notifications, alerts, communications
✓ Document Messages - Contracts, legal docs, files requiring signature

Pricing

$0.03 per text message
$0.10 per message with attachment

Notification Severity Levels

Control how urgently users are notified about your messages with four severity levels:

Low

No push notification - background delivery only. User sees message when they open the UIP app.

Medium

Standard push notification with default sound and vibration.

High

Priority notification with enhanced sound and persistent alert until acknowledged.

Extreme

Emergency-level notification with maximum alert intensity. Reserved for government/emergency use.

Note: Extreme severity is restricted to verified government and emergency service accounts.

Endpoint

API Endpoint

POST https://msg.api.uip.id/v1

Headers

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Request Parameters

Parameter	Type	Required	Description
recipient_uip_id	string	Yes	UIP ID of the message recipient
webhook_url	string	Yes	URL to receive message delivery and response events
subject	string	Yes	Message subject/title
message	string	Yes	Message content/body
severity	string	No	Notification priority: low, medium, high, extreme (default: medium)
attachment	object	No	Document attachment (up to 20MB)
requires_signature	boolean	No	Whether the message/document requires a signature (default: false)

Request Examples

Simple Text Message

{
  "recipient_uip_id": "uip_user_1234567890",
  "webhook_url": "https://mybank.com/webhooks/uip/msg",
  "subject": "Account Alert",
  "message": "Your account has been successfully verified. Welcome to MyBank!",
  "severity": "medium"
}

Cost: $0.03

Document Message with Signature Required

{
  "recipient_uip_id": "uip_user_1234567890",
  "webhook_url": "https://legalfirm.com/webhooks/uip/contracts",
  "subject": "Employment Contract - Please Review and Sign",
  "message": "Please review the attached employment contract and provide your signature if you agree to the terms.",
  "severity": "high",
  "attachment": {
    "filename": "employment_contract_2024.pdf",
    "content_type": "application/pdf",
    "data": "base64_encoded_pdf_data_here...",
    "size": 1048576
  },
  "requires_signature": true
}

Cost: $0.10 (includes document attachment)

Attachment Format

When including document attachments, use this format within the attachment object:

"attachment": {
  "filename": "contract.pdf",
  "content_type": "application/pdf",
  "data": "base64_encoded_file_data",
  "size": 1048576
}

Supported File Types

• PDF documents (application/pdf)
• Word documents (application/vnd.openxmlformats-officedocument.wordprocessingml.document)
• Images (image/jpeg, image/png)
• Text files (text/plain)
• CSV files (text/csv)

Limits

• Maximum file size: 20MB
• One attachment per message
• Base64 encoding required
• File size must match actual data

Ready to Get Started?

Start sending secure encrypted messages to your verified UIP users.

Get API Keys

Start integrating messaging

View Pricing

See usage-based costs