POST Endpoint

POST /message

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

Endpoint

API Endpoint

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

Headers

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Request Body

{
  "recipient_uip_id": "uip_user_1234567890",
  "webhook_url": "https://yourapp.com/webhooks/uip/msg",
  "subject": "Employment Contract Review",
  "message": "Please review and sign the attached contract.",
  "severity": "high",
  "requires_signature": true,
  "attachment": {
    "filename": "contract.pdf",
    "content_type": "application/pdf",
    "data": "base64_encoded_pdf_data",
    "size": 1048576
  }
}

Parameters

Parameter	Type	Required	Description
recipient_uip_id	string	Yes	UIP ID of the message recipient
webhook_url	string	Yes	URL to receive 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 document requires signature (default: false)

Response

{
  "message_id": "msg_1234567890abcdef",
  "status": "sent",
  "recipient_uip_id": "uip_user_1234567890",
  "estimated_delivery": "2024-01-15T10:30:00Z",
  "requires_signature": true,
  "cost": 0.10
}

Related Endpoints

Messaging API Overview

Learn about messaging

Get API Keys

Start building with UIP