Jump to Content
API Reference
v1.0
v2
v5
v6
v7
Log In
API Reference
Log In
v1.0
API Reference
Using the HPD Search API
All
Pages
Start typing to search…
JUMP TO
Pre-Requisite
Before Getting Started
Direct Messaging API
Using the Direct Messaging API
Account
Get A Session Key
post
Get Your Account Details
get
Change Your Password
post
Logout
post
Folder
List All Folders
get
Create A New Folder
post
Delete A Folder
del
Message
Get Message Summaries
post
Get Unread Messages
get
Search the Inbox
post
Get A Message
get
Get Message Metadata
get
Get A MIME Message
get
Send A Message
post
Send A MIME Message
post
Move A Message
post
Delete A Message
del
Retract A Message
post
Group Mailboxes
Show Delegates
get
Add Delegates
put
Delete Delegates
del
Show Groupbox Membership
get
Get Group Inbox MID
post
Get Group Message Summaries
post
Get Group Inbox
get
Get Unread Group Inbox
get
Direct HPD Search API
Using the HPD Search API
Get A Session Key
post
Search The HPD
get
NPI Search
get
Direct Provisioning API
Using the Direct Provisioning API
Certificate
Request an Organizational Certificate
post
Request an Address Certificate
post
Request a Patient Certificate
post
Revoke a Certificate
post
Check Certificate Status
post
User
Provision A User
post
Delete A User
post
Check A User's Provisioning Status
post
Secure Messaging API V3
Using the Secure Messaging API (V3)
Account
Retrieves details about the current user's account.
get
Retrieves the current user's settings.
get
Retrieves a specified Cobrand. If the specified Cobrand is not found, default values are returned.
get
Changes a user's password.
put
Triggers the forgot password workflow for a user (first step in the forgot password process).
post
Resets a user's password. Last step of the forgot password workflow process.
put
Submits password reset security question answers. 2nd step of the forgot password workflow process (if security questions are required to be answered for the user).
post
Retrieves a list of security questions a user can choose from when selecting their password reset security questions and setting their answers.
get
Sets the password security question answers for the current user.
post
Contacts
Get a list of Address book contacts
get
Create a Address book contact
post
Get a contact information by the Id
get
File
Download a file for a given fileId.
get
DELETE A FILE
del
Upload a file to a new message (as an attachment).
post
Upload a file to an existing message (as an attachment).
post
Message
Get a MIME message for a given Message ID (MID)
get
GET MESSAGE METADATA
get
Generates a reply to a given message as the user associated with the access token.
post
Forwards a given message as the user associated with the access token.
post
Retracts a message from any recipients that have received the message.
patch
Move a particular message into a specific folder.
patch
Create new draft message.
post
Update a draft message.
put
Send a draft.
patch
Get a message.
get
Retrieves the message summary information of all messages using the specified criteria.
get
Send a new message.
post
Retrieves the unique messageIds of messages using the specified criteria.
get
Delete a message from a folder
del
Sends a formatted MIME message.
post
Folders
This method is used to retrieve a list of the user’s folders and corresponding statistics.
get
Create a folder
post
Update a folder
put
Delete a folder
del
Token
Retrieves an access token.
post
Revoke a token
del
Challenge endpoint to request MFA (via Email). Call this endpoint to MFA via email when you receive MFA required error in the token endpoint.
post
Secure Admin API
Using The Secure Admin API
Authentication
Get A Session Key
post
Get An Encryption Key
post
Create A New Encryption Key (PSK)
post
Account
List User Accounts
post
Create a User Account
post
View a User Account
post
Update a User Account
post
Delete a User Account
post
Get UserTypes
get
Secure Provisioning API
Using The Secure Provisioning API
Provision a Company
post
Get an Encryption Key
post
Create New Encryption Key
post
Secure Message Delivery
Using the Secure Message Delivery API
Send a Secure Message
post
Track a Secure Message
get
Retract a Secure Message
del
Clinical Message Delivery
Using the Clinical Message Delivery API
Send a Secure Message
post
Track a Secure Message
get
Powered by
Using the HPD Search API
Ask AI
This page will help you get started with the HPD Search API
