{"info":{"_postman_id":"8e8009d8-1435-408e-af17-7b42009c66dd","name":"RDocs™ Document Security REST APIs by RPost®","description":"

Introduction

RDocs™ allows you to share documents (for example, related to a financial transaction) with your network in a secure manner, and control every aspect of who is reading what, where, when, how many times, for how long, and even revoke access temporarily or permanently after the send.
The RDocs™ service converts any document or presentation into an RPD™ (Rights Protected Document) file type, which displays to the reader as a simple .html file that can be opened in any browser, and on any device.

With RPD™s, the security features selected by the document originator are prescribed in the file itself. This means that there is no storage of content anywhere; pure compliance bliss.

To learn more visit us at https://rpostdocs.io/

Environments

Production environment

Website: https://app.rdocs.io/

In case you need to use this API, request the API endpoints to your RPost® representative.

Core Concepts

RPD™: Rights Protected Document. A file format used by RDocs™ as the base for all the features.

RDocs™ Specifications

To get the latest updates on the below items please refer to: Our RDocs™ Specifications and our Service Level Agreement.

Supported file types

PDF.
\n
Microsoft Word, Excel, and PowerPoint.
\n
Images (PNG, JPG, BMP and TIFF).
\n

Rate limit

Default 60 API submissions per minute, other enterprise parameters and configurations available.

Limitations

Password-protected .pdf files are not permitted to be uploaded

For further details and parameter descriptions, refer to the RPost® Standard Service Level Agreement: https://rpost.com/legal-notices/service-level-agreement

Getting Started

Prerequisites

The following items are required before starting to use the RDocs™ API:

An active RDocs™ Account with single or Enterprise credentials.

Authentication

RDocs™ API uses a token-based authentication, meaning that a unique hash named AuthToken needs to be sent as part of the headers in every one of your subsequent requests.

To get an access token, you need to send an HTTP POST request to the following URI:

If you don't count with this value, please contact your RPost® representative./api/v1/auth/login

Providing your RDocs™ user credentials. In return, you will receive an AuthToken.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"25212244","collectionId":"8e8009d8-1435-408e-af17-7b42009c66dd","publishedId":"2s9YRDzACB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF3C33"},"publishDate":"2023-10-24T16:35:59.000Z"},"item":[{"name":"RDocs™ API Documentation","item":[{"name":"Authentication","item":[{"name":"Get User Authorization Token","event":[{"listen":"test","script":{"exec":["const jsonData = pm.response.json();\r","pm.collectionVariables.set(\"token\", jsonData.jwt);\r",""],"type":"text/javascript","id":"041fb56b-04b8-46ab-835f-583cf08959c1"}}],"id":"3f03376e-538c-4906-90e9-55eeefd1a6a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"Register at https://rpostdocs.io/\",\r\n \"password\": \"Register at https://rpostdocs.io/\"\r\n}","options":{"raw":{"language":"json"}}},"url":"If you don't count with this value, please contact your RPost® representative./api/v1/auth/login","description":"

Description

This request allows RDocs™ users to retrieve an Auth Token.

Note: Auth Tokens are required for authenticating each following request to the RDocs™ API. It expires after 40 min of being issued.

Request

Request Headers

Content-Type: application/json

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter Name	Type	Description	Required?	Example
email	String	Email of the user authenticating to the API.	Yes	myname@mydomain.com
password	String	Password of the user authenticating to the API.	Yes	**123

Sample Request

{\n  \"email\": \"myname@mydomain.com\",\n  \"password\": \"pass123\"\n}\n\n

Response

Response Headers

No response headers

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter Name	Type	Description	Example
jwt	String	Authentication token to be used as a header for subsequent API calls.	NgAxADYANAAxAEIAQgBxB
email	String	Email address of the authenticated user.	username@domain.com
language	String	App Language configured in the User Settings.	en-us
dateControlFormat	Boolean	Do not use.	false
userRole	String	Do not use.	null
companyName	String	Name of the Company to which the user belongs.	Company Name
landingPage	String	Indicates the value that the authenticated user has for the setting \"Landing Page\" in RDocs™ settings. This setting determines to which RDocs™ tab the user is redirected once they log in to the application. Possible values are: send, generate, manage, settings.	send

Response codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Message
200	Token obtained successfully.
401	Username or Password is invalid.

Sample Response

{\n    \"jwt\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdXRoVG9rZW4i\",\n    \"email\": \"username@domain.com\"\n    \"language\": \"en-us\",\n    \"dateControlFormat\": false,\n    \"userRole\": null,\n    \"companyname\": \"Company Name\",\n    \"landingPage\": \"send\"\n}\n\n

\n","urlObject":{"path":["api","v1","auth","login"],"host":["If you don't count with this value, please contact your RPost® representative."],"query":[],"variable":[]}},"response":[{"id":"b1dfcc71-cd7b-438e-bff1-c99bae477563","name":"200 - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"Register at https://rpostdocs.io/\",\r\n \"password\": \"Register at https://rpostdocs.io/\"\r\n}","options":{"raw":{"language":"json"}}},"url":"If you don't count with this value, please contact your RPost® representative./api/v1/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Jul 2025 15:35:31 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=oiRpKfDJZEsEiIJOMB7CGY3aA0QaDFtNoJ3TqkKIhJ0pahg9LeAnZrq8Hi++8K/EKbnn6ROt48q+++kY6OTtR4whgOxRtOntWbcRM4gWLHIDojlO7fg/JSp7tbWg; Expires=Thu, 31 Jul 2025 15:35:22 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=oiRpKfDJZEsEiIJOMB7CGY3aA0QaDFtNoJ3TqkKIhJ0pahg9LeAnZrq8Hi++8K/EKbnn6ROt48q+++kY6OTtR4whgOxRtOntWbcRM4gWLHIDojlO7fg/JSp7tbWg; Expires=Thu, 31 Jul 2025 15:35:22 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"jwt\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdXRoVG9rZW4iOiJleUpoYkdjaU9pSklVekkxTmlJc0luUjVjQ0k2SWtwWFZDSjkuZXlKVFpYTnphVzl1U1dRaU9pSXlOakV4TWpBelppMDJPR1JsTFRSaU1qUXRPRFF6TkMwek1qa3dNMkZtTTJSbE4yUWlMQ0p1WVcxbGFXUWlPaUpoWVd4bWIyNXpiMEJ5Y0c5emRDNWpiMjBpTENKMWJtbHhkV1ZmYm1GdMExtTnZiU0lzSW01aVppSTZNVGMxTXpNM01UTXlNeXdpWlhod0lqb3hOelV6TXpjek56SXpMQ0pwWVhRaU9qRTNOVE16TnpFek1qTXNJbWx6Y3lJNkltaDBkSEJ6T2k4dmQyVmlZWEJwTG5JeExuSndiM04wTG01bGRDSXNJbUYxWkNJNkltTnZjbVYzWldKaGNHa2lmUS5SZHZvNXRwQVVicWd1UWRnc1F2MzdQQ0ZFS2xVOFoxTGZqeTZQX2p5TkRZIiwicmVmcmVzaFRva2VuIjoiUGpHR1ZrNlZFRW4rbHNZbjAvNkEwbTNZVkpwZk1NdFVDNCsxdDlPVWx0RT0iLCJpZCI6IjY0ODIzN2QzZTE3ODMyMTM3NmYwNmRiMSIsImV4cGlyZXMiOiI3LzI0LzIwMjUgNDoxNTozMCBQTSIsIm5iZiI6MTc1MzM3MTMzMSwiZXhwIjoxNzUzNDU3NzMxLCJpYXQiOjE3NTMzNzEzMzF9.7EZx15eWzz_5NlhzyTxsd0etbCJmFNBnqc44gjZEuqk\",\n \"email\": \"name@domain.com\",\n \"language\": \"en-us\",\n \"dateControlFormat\": false,\n \"userRole\": \"RDocsUser\",\n \"companyname\": \"My RPost Company Account\",\n \"landingPage\": \"Send\"\n}"},{"id":"6453438d-b417-420e-a07b-f567c55a57c9","name":"400 - Failure (Invalid credentials)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"Register at https://rpostdocs.io/\",\r\n \"password\": \"Register at https://rpostdocs.io/\"\r\n}","options":{"raw":{"language":"json"}}},"url":"If you don't count with this value, please contact your RPost® representative./api/v1/auth/login"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Jul 2025 15:40:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=a/TUvprryLny59OeBzzyTx8YhlxnuR7bj+h+Zzwrb/TrGEqH+WtyIIhgiuUaQNfHqOR60sSkqDUAgsuf4oMgx8OgpGoAfVp8uwbfcWyn2yg+ZwI8+cYZymeLLoW/; Expires=Thu, 31 Jul 2025 15:40:57 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=a/TUvprryLny59OeBzzyTx8YhlxnuR7bj+h+Zzwrb/TrGEqH+WtyIIhgiuUaQNfHqOR60sSkqDUAgsuf4oMgx8OgpGoAfVp8uwbfcWyn2yg+ZwI8+cYZymeLLoW/; Expires=Thu, 31 Jul 2025 15:40:57 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"The email address or password is incorrect.\",\n \"referenceId\": \"49576EAB2354106B88C92E0B8217032FD7ABF860\"\n}"}],"_postman_id":"3f03376e-538c-4906-90e9-55eeefd1a6a9"}],"id":"0fcb45c0-5eed-48c5-9bfb-2d4b6b6c1139","description":"

In order to access the RDocs™ services and resources the user is required to follow an authentication process.

RDocs™ authentication consists on performing a Log In call with user or enterprise credentials. This process will return a token that can, later on, be used for subsequent token-based requests.

\n","_postman_id":"0fcb45c0-5eed-48c5-9bfb-2d4b6b6c1139"},{"name":"Documents","item":[{"name":"Get a RPD™ document record by ID","id":"eb1d86fe-50d6-4ee1-b9ee-e8630c9c306d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"If you don't count with this value, please contact your RPost® representative./api/v1/docs/:Id","description":"

Description

This endpoint retrieves an RPD™ document record using the document ID.

The document record contains information about:

Features used on the RPD™ document.
\n
Recipients/readers of the RPD™ document.
\n
Original and modified file name of the documents contained on the RPD™ document.
\n
Open records of the RPD™ document (with information about location, IP, time read per reader, reader's email address, etc.).
\n
And more.
\n

To see all the information this request provides, refer to section \"Response Body\".

Note: RPD™ documents are not stored by the RDocs™ service. Only the document records are stored.

Request

Request Headers

Authorization: Bearer {token}

Response

Response Headers

No response headers

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter Name	Type	Description	Example
id	String	ID that represents the RDocs™ transaction.	64877b7b311dasdsa806as
documentId	String	ID that represents the RDocs™ RPD™ document (RPost® Protected Document).	553521120870BEAF3506DAAD
ownerId	String	ID that represents the RDocs™ user that generated the RPD™ document (RPost® Protected Document).	64877b7b311dasdsa806as
fileName	String	Name of the RPD™ file.	My file.pdf
senderAddress	String	Email of the end user who is requesting the RPD™ document to be created.	myname@mydomain.com
documentOptions.recipients	Array	User list of email addresses who will receive the RPD™ document by email and/or are the pre-authorized viewer (required) for Level 3 and editable after the send or create. Maximum recipients per email are 99. Available for Security Levels 1, 2 and 3.	N/A
documentOptions.recipients.email	String	Email address of the recipient of the RPD™ document.	myname@mydomain.com
documentOptions.recipients.id	String	Recipient ID.	0e85adc2-3e88-4084-b386-7ea1e7d21bdd
documentOptions.recipients.code	String	Recipient verification code. This will be sent to the recipient email to access the RPD™ document.	oPKX0kZaQCZF
documentOptions.recipients.readCount	Integer	Indicates how many times the recipient viewed the RPD™ document.	1
documentOptions.recipients.enabled	Boolean	Indicates if the recipient is enabled or banned from seeing the RPD™ document.	true
documentOptions.recipients.vote	Integer	Indicates if the recipient voted on the RPD™ document.	1 (The recipient voted) -1 (The recipient didn't vote)
documentOptions.recipients.status	String	Indicates the status of the recipient (whether they have access to the RPD™ document or not). Possible values: - Active - Banned - Pause	Active
documentOptions.recipients.recipientType	String	Do not use.	To
documentOptions.recipients.firstName	String	First name of the recipient.	John
documentOptions.recipients.lastName	String	Last name of the recipient.	Doe
documentOptions.recipients.mobileCountryCode	String	Country code of the recipient's mobile number. Possible values are: +54 (Argentina) +501 (Belize) +1 (Canada) +49 (Germany) +33 (France) +44 (United Kingdom) +91 (India) + 1 (United States)	+1
documentOptions.recipients.mobileNumber	String	Mobile number of the recipient. The passcode to access the RPD™ document is sent to this mobile number.	5551234567
documentOptions.subject	String	Subject of the email sent if RPD™ document was sent via email at the moment of creation. Maximum length is 100 characters.	Please review the attached document.
documentOptions.subject	String	Description of the RPD™ document set at the moment of creation of the document. Maximum length is 100 characters.	This is my first RPD™ document generated using RDocs™.
documentOptions.message	String	The body of the email sent if the RPD™ document was created and sent via email. If the RPD™ document was created without having sent it as an email, this will be blank. Maximum length is 1024 characters.	Hey everyone!
documentOptions.sideNote	String	Describes the text sent on the SideNote®, if the RPD™ document contains one. Maximum length is 512 characters.	Please review and send feedback via email.
documentOptions.enabled	Boolean	Indicates if the RPD™ document is active (the document is available for viewing) or expired (the document is unavailable for viewing) for the recipients specified in the response body (Level 3) or any potential viewer (Level 1 and 2).	true (active) false (expired)
documentOptions.openRecord	Boolean	Indicates if the feature \"Opening times recorded\" is enabled. This feature records the 1st read for each reader.	true
documentOptions.geolocation	Boolean	Indicates if the feature \"Geo-location\" is active. This feature records the geo-location of each reader for every read.	true
documentOptions.verifyCode	Boolean	Indicates if the feature \"Email verification code\" is active. If TRUE, the access code will be emailed to the recipient’s email address as a separate email at the time of generating and sending the RPD™ document. If FALSE, the code will not be sent and will need to be retrieved by the recipient at the moment of accessing the document. Available for Security Level 2 and 3.	true
documentOptions.proofOfSending	Boolean	Indicates if the feature \"Proof of sending\" is active for the RPD™ document. When enabled, the sender will receive an email with proof that their document has been sent. Available for Security Level 1, 2 and 3.	true
documentOptions.readNotification	Boolean	Indicates if the feature \"Notification of reading\" is active. If true, the RPD™ document Owner will receive confirmation emails when recipients open the RPD™ document for the first time. Available for Security Level 2 and 3.	true
documentOptions.readerIp	Boolean	Indicates if the feature \"Reader IP recorded\" is active. This feature allows to record the IP address of each reader for every read.	true
documentOptions.readerEmail	Boolean	Indicates if the feature \"Reader email addresses recorded\" is active. If true, the reader's email address is required to be authenticated (and will be recorded and visible to the RPD™ document Owner) to access the document. Available for Security Level 2 and 3.	true
documentOptions.readTimes	Boolean	If true, read times (date/time of each unique document view) will be recorded per reader and visible to the RPD™ document Owner. Available for Security Level 2 and 3.	true
documentOptions.readTiming	Boolean	If true, reading session duration per session will be recorded per reader and visible to the RPD™ document Owner. If false, reading session duration will not be recorded. The open time is returned as a value in seconds added as a property in the “Open Record” response parameter.	true
documentOptions.voting	Boolean	Indicates if the feature \"Voting\" is enabled. This feature allows readers to like of dislike within the RPD™ document. Available for Security Level 2 and 3.	true
documentOptions.voteSharing	Boolean	Indicates if the feature \"Share votes\" is active. This allows readers to see how other readers voted. Available for Security Level 2 and 3.	true
documentOptions.distRestriction	Boolean	Indicates if the feature \"Restricted distribution\" is active. This allows to restrict the access to the RPD™ document to a list of authorized readers. If true, the document will only permit authentication with the email address that the document owner identified for permitted access (by sending the document to them or identifying the email address in the Create stage as permitted; or if edited after the send).	true
documentOptions.distributionList	Boolean	Indicates if the feature \"Display distribution list\" is enabled. This feature allows readers to see the list of authorized readers. This includes those new persons at Level 2 that the RPD™ document was shared with, not only the original ‘recipients list’. At a minimum, the reader will see the original ‘recipient list’ of a SEND transaction. Available for Security Level 2 and 3.	true
documentOptions.domains	String	Indicates if the feature \"Restrict to domains\" is active. This feature indicates that only readers within these domains will be able to access the RPD™ document. If there's no restriction by domain, this will be blank. Add up to 10 domains separated by comma, no wild cards. Available for Security Level 2 and 3.	domain.com, domain1.com
documentOptions.watermark	Integer	Indicates if a watermark is present in the RPD™ document. 0 -- No watermark 1 -- Watermark: \"Confidential\" 2 -- Watermark: \"Draft\"	2
documentOptions.maxReads	Integer	Defines how many times the reader will be able to open the RPD™ document for reading before access is disabled for that specific reader. The default value is 0 which means unlimited reads. Available for Security Level 2 and 3.	5
documentOptions.steganography	Boolean	If TRUE, the RPD™ document will contain a dynamic tag with the readers’ email address bouncing around the screen. On RDocs™ web, this feature is called \"Identify leakers\". Available for Security Level 2 and 3.	true
documentOptions.timestamp	Boolean	If true, the RPD™ document will be stamped with a watermark on the bottom of the document with the original time and date sent.	true
documentOptions.print	Boolean	Indicates if the reader is able to print the RPD™ document or not.	true
documentOptions.regions	Integer	Array containing the allowed regions in which the readers will have access to the RPD™ document. Readers outside of these regions will not be able to access the RPD™ document, regardless of whether their email addresses have been whitelisted. 0 -- Europe 1 -- Africa 2 -- North America 3 -- South America 4 -- North Asia 5 -- South Asia	[2]
documentOptions.ips	String	It's an array of IP addresses in CIDR format that are authorized to access the RPD™ document. Readers outside of those ranges will not be able to access the RPD™ document, regardless of whether their email addresses have been whitelisted.	192.0.2.0/24
documentOptions.startTime	String	Indicates the date (UTC time format) from when the RPD™ document can be accessed by readers.	2023-07-28T00:00:00Z
documentOptions.expiryTime	String	Indicates the date (UTC time format) when the RPD™ document will automatically expire and will no longer be accessible for readers.	2023-07-31T23:59:59Z
documentOptions.allowResponsesTo	String	Email address to send response from RPD™ document by viewer.	myname@domain.com
documentOptions.language	String	This is the language in which the system will send email notifications related to the RPD™ document. Possible values: en-us - (English) ca-ES - (Catalan) cs-CZ - (Czech) da-DK - (Danish) de-DE - (German) el-GR - (Greek) es-ES - (Spanish) fi-FI - ( Finnish) fr-FR - (French) hu-HU - (Hungarian) it-IT - (Italian) nb-NO - (Norwegian) nl-NL - (Dutch) pl-PL - (Polish) pt-BR - (Portuguese) ro-RO - (Romanian) ru-RU - (Russian) sv-SE - (Swedish) tr-TR - (Turkish) pt-PT - (Portuguese) Note: The language the reader sees when viewing the RPD™ document is solely determined by the reader’s browser setting.	en-us
documentOptions.source	String	Indicates the application from where the RPD™ document was created.	UI
documentOptions.maxViewsPerDocument	Integer	Indicates the maximum reads per document before the document expires for all readers.	8
documentOptions.pageLevelRestriction	Boolean	Indicates if the feature \"Page level restrictions\" is enabled for the RPD™ document.	true
documentOptions.isSMS	Boolean	Specifies whether the verification code for accessing the RPD™ document is sent to readers via SMS in addition to email.	true
inputFiles.fileName	String	Original file name of the document uploaded to create the RPD™ document.	my-document.docx
inputFiles.modifiedFileName	String	New file name of the document uploaded to create the RPD™ document (modified by the sender).	new-title.docx
inputFiles.fileSize	String	File size of the uploaded file.	17 KB
inputFiles.order	Integer	Order in which the file was uploaded upon creation of the RPD™ document.	0
distributions.email	String	Email address to which the RPD™ document was distributed to. If the document was created and not sent via email, the only distribution information will be the one of the sender.	myname@domain.com
distributions.id	String	ID of the recipient/sender of the RPD™ document.	dd6adbc0-f704-490d-9880-126796bf8be1
distributions.enabled	Boolean	Indicates if the specified email is enabled/authorized to access the RPD™ document.	true
openRecords	Array	The list of records of the opening events of the RPD™ document.	N/A
openRecords.id	String	ID that represents the open record of the document.	958f5b9a-48a2-4cd3-aebd-52baf5f4fd51
openRecords.email	String	The RPD™ document reader' email.	myname@domain.com
openRecords.opened	String	Date and time in which the document was opened.	2023-07-28T20:01:12.979Z
openRecords.ip	String	The IP address of the reader's access location.	180.00.000.01
openRecords.geolocation.ip	String	Reader's IP address.	180.00.000.01
openRecords.geolocation.network	String	Do not use.	182.64.127.0/20
openRecords.geolocation.version	String	It's the Internet Protocol version used by the reader.	IPv4
openRecords.geolocation.city	String	Name of the city in which the document was opened.	New York
openRecords.geolocation.region	String	Name of the region in which the document was opened.	New York
openRecords.geolocation.region_code	String	Code of the region in which the document was opened.	A
openRecords.geolocation.country	String	Country in which the document was opened.	US
openRecords.geolocation.country_code	String	Code of the country in which the document was opened.	US
openRecords.geolocation.country_name	String	Full name of the country in which the document was opened.	United States of America
openRecords.geolocation.country_capital	String	Capital of the country in which the document was opened.	Washington DC
openRecords.geolocation.country_tld	String	Country code top-level domain of the country in which the document was opened.	.us
openRecords.geolocation.country_code_iso3	String	ISO 3 code of the country in which the document was opened.	USA
openRecords.geolocation.continent_code	String	Continent code of the country in which the document was opened.	NA
openRecords.geolocation.postal	String	Postal code of the city in which the document was opened.	2098
openRecords.geolocation.latitude	Integer	Latitude of the location in which the document was opened.	-40.8512
openRecords.geolocation.longitude	Integer	Longitude of the location in which the document was opened.	-26.3531
openRecords.geolocation.timezone	String	Timezone of the location in which the document was opened.	America/United States/Eastern_Coast
openRecords.geolocation.utc_offset	String	UTC offset of the location in which the document was opened.	-0300
openRecords.geolocation.country_calling_code	String	Calling code of the country in which the document was opened.	+54
openRecords.geolocation.in_eu	Boolean	Do not use.	true
openRecords.geolocation.currency	String	Currency of the country in which the document was opened.	USD
openRecords.geolocation.currency_name	String	Currency name of the country in which the document was opened.	United States Dollars
openRecords.geolocation.languages	String	Languages of the country in which the document was opened.	en-US,it,de,fr,es
openRecords.geolocation.country_area	Integer	Area coverage of the country on square kilometers.	2766890
openRecords.geolocation.country_population	Integer	Total population of the country.	44494502
openRecords.geolocation.asn	String	ASN number of the local network with which the document was opened.	AS27645
openRecords.geolocation.org	String	Reader’s internet service provider.	Company S.A
openRecords.activityTime	Integer	Total time in seconds of user document reading activity.	600
openRecords.client	String	Reading client browser info.	Chrome 115.
data	String	Do not use.	1KUASDVASUGADV23RK3HUGUO322
rpd	String	It's the RPD™ document (HTML file) in a Base64 encoded string. Will contain information when creating an RPD™ document. On this request, will always be null.	1KUASDVASUGADV23RK3HUGUO322
pages	Integer	Amount of pages on the RPD™ document.	1
created	String	Indicates the date in which the RPD™ document was created.	2023-07-21T17:41:10.656Z
modified	String	Indicates when was the last time the RPD™ document was modified by the sender.	2023-07-24T20:58:52.893Z
rpdType	String	If the RPD™ document was created only (\"Create\"), or if it was created and sent via email (\"Send\").	Create
isPermanentExpire	Boolean	Do not use.	false
isKilled	Boolean	Do not use.	false
permanentExpiredDate	String	Do not use.	null
killDate	String	Do not use.	null
pageLevelRestrictionSetting	Boolean	Indicates if the setting \"Page level restrictions\" was set to \"Yes\" at a personal level when the RPD™ document was created.	true

Response codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Message
200	OK. RPD™ document record returned.
401	Unauthorized.
404	RPD™ document ID not found.

Response Sample

{\n    \"id\": \"transactionId\",\n    \"documentId\": \"documentId\",\n    \"ownerId\": \"ownerId\",\n    \"fileName\": \"Sample RDP™ document\",\n    \"senderAddress\": \"myname@domain.com\",\n    \"documentOptions\": {\n        \"recipients\": [\n            {\n                \"email\": \"recipient1@domain.com\",\n                \"id\": \"a312d096-c694-4a4d-bb0b-85fce28c511e\",\n                \"code\": \"yI8DSCNO0FP5\",\n                \"readCount\": 2,\n                \"enabled\": true,\n                \"vote\": -1,\n                \"status\": \"Active\",\n                \"recipientType\": \"To\",\n                \"firstName\": \"John\",\n                \"lastName\": \"Doe\"\n            }\n        ],\n        \"subject\": \"Sending you an RPD™ document.\",\n        \"message\": \"Not share.\",\n        \"sideNote\": \"This is a SideNote®.\",\n        \"enabled\": true,\n        \"openRecord\": true,\n        \"geolocation\": true,\n        \"verifyCode\": true,\n        \"proofOfSending\": false,\n        \"readNotification\": false,\n        \"readerIp\": true,\n        \"readerEmail\": true,\n        \"readTimes\": true,\n        \"readTiming\": true,\n        \"voting\": true,\n        \"voteSharing\": false,\n        \"distRestriction\": false,\n        \"distributionList\": false,\n        \"domains\": \"\",\n        \"watermark\": 0,\n        \"maxReads\": 0,\n        \"steganography\": false,\n        \"timestamp\": false,\n        \"print\": false,\n        \"regions\": [\n            1,\n            3,\n            0,\n            4,\n            2,\n            5\n        ],\n        \"ips\": [\n            \"\"\n        ],\n        \"startTime\": \"2023-07-21T20:55:25.666Z\",\n        \"expiryTime\": null,\n        \"allowResponsesTo\": \"myname@domain.com\",\n        \"language\": \"en-us\",\n        \"source\": \"API/RmailOutlookplugin/UI\",\n        \"maxViewsPerDocument\": 0\n    },\n    \"inputFiles\": [\n        {\n            \"fileName\": \"Sample-RPD™file.docx\",\n            \"modifiedFileName\": \"Final-RPD™file.docx\",\n            \"fileSize\": \"18 KB\",\n            \"order\": 0\n        }\n    ],\n    \"distributions\": [\n        {\n            \"email\": \"myname@domain.com\",\n            \"id\": \"4e3f3e9b-8fcb-429e-84d0-18e263f9e03a\",\n            \"enabled\": true\n        },\n        {\n            \"email\": \"recipient1@domain.com\",\n            \"id\": \"f68f375d-6c15-4d1b-a70d-2268fc84efec\",\n            \"enabled\": true\n        }\n    ],\n    \"openRecords\": [\n        {\n            \"id\": \"8264ad95-dd0e-43c8-807f-136aa2021282\",\n            \"email\": \"recipient1@domain.com\",\n            \"opened\": \"2023-07-21T20:56:17.645Z\",\n            \"ip\": \"180.00.000.01\",\n            \"geolocation\": {\n                \"ip\": \"180.00.000.01\",\n                \"network\": \"180.00.000.0/24\",\n                \"version\": \"IPv4\",\n                \"city\": \"New York\",\n                \"region\": \"New York\",\n                \"region_code\": \"A\",\n                \"country\": \"US\",\n                \"country_code\": \"US\",\n                \"country_name\": \"United States of America\",\n                \"country_capital\": \"Washington DC\",\n                \"country_tld\": \".us\",\n                \"country_code_iso3\": \"USA\",\n                \"continent_code\": \"NA\",\n                \"postal\": \"1890\",\n                \"latitude\": -14.751100,\n                \"longitude\": -98.629100,\n                \"timezone\": \"America/United States of America/Eastern_Coast\",\n                \"utc_offset\": \"-0300\",\n                \"country_calling_code\": \"+54\",\n                \"in_eu\": false,\n                \"currency\": \"USD\",\n                \"currency_name\": \"United States Dollar\",\n                \"languages\": \"en-US,it,de,fr,es\",\n                \"country_area\": 2766890,\n                \"country_population\": 44494502,\n                \"asn\": \"AS29749\",\n                \"org\": \"Company S.A.\"\n            },\n            \"activityTime\": null,\n            \"client\": \"Chrome 115\"\n        },\n        {\n            \"id\": \"e98d027a-6edb-4350-9539-96f61f8e9b83\",\n            \"email\": \"recipient1@domain.com\",\n            \"opened\": \"2023-07-21T20:57:13.635Z\",\n            \"ip\": \"181.00.000.01\",\n            \"geolocation\": {\n                \"ip\": \"181.00.000.01\",\n                \"network\": \"181.00.000.0/22\",\n                \"version\": \"IPv4\",\n                \"city\": \"New York\",\n                \"region\": \"New York\",\n                \"region_code\": \"A\",\n                \"country\": \"US\",\n                \"country_code\": \"US\",\n                \"country_name\": \"United States of America\",\n                \"country_capital\": \"Washington DC\",\n                \"country_tld\": \".us\",\n                \"country_code_iso3\": \"USA\",\n                \"continent_code\": \"NA\",\n                \"postal\": \"1890\",\n                \"latitude\": -14.751100,\n                \"longitude\": -98.629100,\n                \"timezone\": \"America/United States of America/Eastern_Coast\",\n                \"utc_offset\": \"-0300\",\n                \"country_calling_code\": \"+54\",\n                \"in_eu\": false,\n                \"currency\": \"USD\",\n                \"currency_name\": \"United States Dollar\",\n                \"languages\": \"en-US,it,de,fr,es\",\n                \"country_area\": 2766890,\n                \"country_population\": 44494502,\n                \"asn\": \"AS11111\",\n                \"org\": \"Company S.A.\"\n            },\n            \"activityTime\": null,\n            \"client\": \"Chrome 115\"\n        }\n    ],\n    \"data\": null,\n    \"rpd\": null,\n    \"pages\": 1,\n    \"created\": \"2023-07-21T20:55:27.492Z\",\n    \"modified\": null,\n    \"rpdType\": \"Send\",\n    \"isPermanentExpire\": false,\n    \"isKilled\": false,\n    \"permanentExpiredDate\": null,\n    \"killDate\": null\n}\n\n

\n","urlObject":{"path":["api","v1","docs",":Id"],"host":["If you don't count with this value, please contact your RPost® representative."],"query":[],"variable":[{"type":"any","value":"Insert here the document ID","key":"Id"}]}},"response":[{"id":"64f51a9c-b6d3-4930-9527-d06ca74ff2f1","name":"200 - OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://base_url/api/v1/docs/:Id","protocol":"https","host":["base_url"],"path":["api","v1","docs",":Id"],"variable":[{"key":"Id","value":"175431400293DBEC3512FEBF"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 31 Jul 2023 21:07:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=SU833ZdfoKAJF1vD8KSjrUaXHDH+1vjSLFjbe3WILIrudHJ3ICYnzLUOm9tUNOhBgUx2TsN5zbVx2GhNPik5OgyniOpYeIFBW4hoKGt154PNn+uIEzD8epsHu4zf; Expires=Mon, 07 Aug 2023 21:07:41 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=SU833ZdfoKAJF1vD8KSjrUaXHDH+1vjSLFjbe3WILIrudHJ3ICYnzLUOm9tUNOhBgUx2TsN5zbVx2GhNPik5OgyniOpYeIFBW4hoKGt154PNn+uIEzD8epsHu4zf; Expires=Mon, 07 Aug 2023 21:07:41 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"64c448445542c4b2a5f7fc58\",\n \"documentId\": \"175431400293DBEC3512FEBF\",\n \"ownerId\": \"6455341ba2673623f84738a7\",\n \"fileName\": \"Test RPD™ document\",\n \"senderAddress\": \"myname@domain.com\",\n \"documentOptions\": {\n \"recipients\": [\n {\n \"email\": \"recipient1@domain.com\",\n \"id\": \"7d31aa20-d40c-491e-92e1-a33d22056589\",\n \"code\": \"yzml8BH0XhCU\",\n \"readCount\": 1,\n \"enabled\": true,\n \"vote\": -1\n }\n ],\n \"subject\": \"Description of the RPD™ document.\",\n \"message\": \"\",\n \"sideNote\": \"This is a SideNote®.\",\n \"enabled\": true,\n \"openRecord\": true,\n \"geolocation\": true,\n \"verifyCode\": true,\n \"proofOfSending\": false,\n \"readNotification\": false,\n \"readerIp\": true,\n \"readerEmail\": true,\n \"readTimes\": true,\n \"readTiming\": true,\n \"voting\": false,\n \"voteSharing\": false,\n \"distRestriction\": false,\n \"distributionList\": false,\n \"domains\": \"\",\n \"watermark\": 0,\n \"maxReads\": 0,\n \"steganography\": false,\n \"timestamp\": false,\n \"print\": false,\n \"regions\": [\n 1,\n 3,\n 0,\n 4,\n 2,\n 5\n ],\n \"ips\": [\n \"\"\n ],\n \"startTime\": \"2023-07-28T22:59:16.504Z\",\n \"expiryTime\": null,\n \"allowResponsesTo\": \"myname@domain.com\",\n \"language\": \"en-us\",\n \"maxViewsPerDocument\": 0\n },\n \"inputFiles\": [\n {\n \"fileName\": \"Document1.docx\",\n \"modifiedFileName\": \"file1.docx\",\n \"fileSize\": \"14 KB\",\n \"order\": 0\n },\n {\n \"fileName\": \"Document2.docx\",\n \"modifiedFileName\": \"file2.docx\",\n \"fileSize\": \"17 KB\",\n \"order\": 1\n }\n ],\n \"distributions\": [\n {\n \"email\": \"myname@domain.com\",\n \"id\": \"637dc224-a18e-452e-a6b1-871ae577f711\",\n \"enabled\": true\n },\n {\n \"email\": \"recipient1@domain.com\",\n \"id\": \"287277ef-54bd-4f3b-8992-1977f1eb0c35\",\n \"enabled\": true\n }\n ],\n \"openRecords\": [\n {\n \"id\": \"13579c2f-11fa-4b9c-8118-51d185c79789\",\n \"email\": \"recipient1@domain.com\",\n \"opened\": \"2023-07-31T18:59:50.974Z\",\n \"ip\": \"180.00.000.00\",\n \"geolocation\": {\n \"ip\": \"180.00.000.00\",\n \"network\": \"180.00.000.0/22\",\n \"version\": \"IPv4\",\n \"city\": \"New York\",\n \"region\": \"New York\",\n \"region_code\": \"A\",\n \"country\": \"US\",\n \"country_code\": \"US\",\n \"country_name\": \"United States of America\",\n \"country_capital\": \"Washington DC\",\n \"country_tld\": \".us\",\n \"country_code_iso3\": \"USA\",\n \"continent_code\": \"NA\",\n \"postal\": \"1890\",\n \"latitude\": -14.751100,\n \"longitude\": -98.629100,\n \"timezone\": \"America/United States of America/Eastern_Coast\",\n \"utc_offset\": \"-0300\",\n \"country_calling_code\": \"+54\",\n \"in_eu\": false,\n \"currency\": \"USD\",\n \"currency_name\": \"United States Dollar\",\n \"languages\": \"en-US,it,de,fr,es\",\n \"country_area\": 2766890,\n \"country_population\": 44494502,\n \"asn\": \"AS11111\",\n \"org\": \"Company S.A.\"\n },\n \"activityTime\": 600,\n \"client\": \"Chrome 115\"\n }\n ],\n \"data\": null,\n \"rpd\": null,\n \"pages\": 3,\n \"created\": \"2023-07-28T22:59:16.601Z\",\n \"modified\": null,\n \"rpdType\": \"Create\"\n}"},{"id":"3b7ee41f-7cf0-4bd4-9e6c-48e728b3636c","name":"401 - Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://If you don't count with this value, please contact your RPost® representative./api/v1/docs/:Id","protocol":"https","host":["If you don't count with this value, please contact your RPost® representative."],"path":["api","v1","docs",":Id"],"variable":[{"key":"Id","value":"175431400293DBEC3512FEBF"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 31 Jul 2023 21:17:58 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=b5UOP69CrrpkDdZZev8PSwr6EJJZeR03KWk0ef9Qhh/yJE76QPbVMaXZ+chkUCYHjKixrp7OnCFiOeNG/5UqlR6aEuJpC6NAaGWj0CeZbB3sMrxLig8pE9DZYE75; Expires=Mon, 07 Aug 2023 21:17:58 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=b5UOP69CrrpkDdZZev8PSwr6EJJZeR03KWk0ef9Qhh/yJE76QPbVMaXZ+chkUCYHjKixrp7OnCFiOeNG/5UqlR6aEuJpC6NAaGWj0CeZbB3sMrxLig8pE9DZYE75; Expires=Mon, 07 Aug 2023 21:17:58 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '07/22/2023 17:58:18'\""},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":""},{"id":"49cada5e-b11c-42a4-bd61-92db63ef66fb","name":"404 - Document not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://If you don't count with this value, please contact your RPost® representative./api/v1/docs/:Id","protocol":"https","host":["If you don't count with this value, please contact your RPost® representative."],"path":["api","v1","docs",":Id"],"variable":[{"key":"Id","value":"175431400293DBEC3412FEBD"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 31 Jul 2023 21:19:00 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=7zJuHmALRgKMN0/thwc59b/63GOPQG44q5w3BAVFru9R/d0VyojuPJi+SG2u7UKqz0NQGc2QIr3Ox2wNe+cZbLdELDH4ymrolhNEtcLzT96BXVqVkLIEmFhJGGSq; Expires=Mon, 07 Aug 2023 21:19:00 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=7zJuHmALRgKMN0/thwc59b/63GOPQG44q5w3BAVFru9R/d0VyojuPJi+SG2u7UKqz0NQGc2QIr3Ox2wNe+cZbLdELDH4ymrolhNEtcLzT96BXVqVkLIEmFhJGGSq; Expires=Mon, 07 Aug 2023 21:19:00 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"eb1d86fe-50d6-4ee1-b9ee-e8630c9c306d"},{"name":"Get all RPD™ document records by sender","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","id":"f4ad88cd-afb6-47b5-a119-d8351f47f7ce"}}],"id":"51c9d626-f7c1-4518-89ef-ccbfdc45808b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"password","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"sender\": \"myname@domain.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"If you don't count with this value, please contact your RPost® representative./api/v1/docs","description":"

Description

This request allows RDocs™ users to get all the RDocs™ document records of the authenticated user upon document creation.

The document record contains information about:

Features used on the RPD™ document.
\n
Original and modified file name of the documents contained on the RPD™ document.
\n
Recipients of the RPD™ document, if any.
\n
Open records of the RPD™ document (with information about location, IP, time read, email, etc.).
\n
And more.
\n

Request

Request Headers

Authorization: Bearer {token}

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter Name	Type	Description	Required?	Example
sender	String	It can be used as a filter. It displays the list of RPD™ documents created by this email address.	No	myname@domain.com

Response

Response Headers

No response headers

Response Body

Parameter Name	Type	Description	Example
id	String	ID that represents the RDocs™ transaction.	64877b7b311dasdsa806as
documentId	String	ID that represents the RDocs™ RPD™ document (RPost® Protected Document).	553521120870BEAF3506DAAD
ownerId	String	ID that represents the RDocs™ user that generated the RPD™ document (RPost® Protected Document).	64877b7b311dasdsa806as
fileName	String	Name of the RPD™ file.	My file.pdf
senderAddress	String	Email of the end user who is requesting the RPD™ document to be created.	myname@mydomain.com
documentOptions.recipients	Array	User list of email addresses who will receive the RPD™ document by email and/or are the pre-authorized viewer (required) for Level 3 and editable after the send or create. Maximum recipients per email are 99. Available for Security Levels 1, 2 and 3.	N/A
documentOptions.recipients.email	String	Email address of the recipient of the RPD™ document.	myname@mydomain.com
documentOptions.recipients.id	String	Recipient ID.	0e85adc2-3e88-4084-b386-7ea1e7d21bdd
documentOptions.recipients.code	String	Recipient verification code. This will be sent to the recipient email to access the RPD™ document.	oPKX0kZaQCZF
documentOptions.recipients.readCount	Integer	Indicates how many times the recipient viewed the RPD™ document.	1
documentOptions.recipients.enabled	Boolean	Indicates if the recipient is enabled or banned from seeing the RPD™ document.	true
documentOptions.recipients.vote	Integer	Indicates if the recipient voted on the RPD™ document.	1 (The recipient voted) -1 (The recipient didn't vote)
documentOptions.recipients.status	String	Indicates the status of the recipient (whether they have access to the RPD™ document or not). Possible values: - Active - Banned - Pause	Active
documentOptions.recipients.recipientType	String	Do not use.	To
documentOptions.recipients.firstName	String	First name of the recipient.	John
documentOptions.recipients.lastName	String	Last name of the recipient.	Doe
documentOptions.recipients.mobileCountryCode	String	Country code of the recipient's mobile number. Possible values are: +54 (Argentina) +501 (Belize) +1 (Canada) +49 (Germany) +33 (France) +44 (United Kingdom) +91 (India) + 1 (United States)	+1
documentOptions.recipients.mobileNumber	String	Mobile number of the recipient. The passcode to access the RPD™ document is sent to this mobile number.	5551234567
documentOptions.subject	String	Subject of the email sent if RPD™ document was sent via email at the moment of creation. Maximum length is 100 characters.	Please review the attached document.
documentOptions.subject	String	Description of the RPD™ document set at the moment of creation of the document. Maximum length is 100 characters.	This is my first RPD™ document generated using RDocs™.
documentOptions.message	String	The body of the email sent if the RPD™ document was created and sent via email. If the RPD™ document was created without having sent it as an email, this will be blank. Maximum length is 1024 characters.	Hey everyone!
documentOptions.sideNote	String	Describes the text sent on the SideNote®, if the RPD™ document contains one. Maximum length is 512 characters.	Please review and send feedback via email.
documentOptions.enabled	Boolean	Indicates if the RPD™ document is active (the document is available for viewing) or expired (the document is unavailable for viewing) for the recipients specified in the response body (Level 3) or any potential viewer (Level 1 and 2).	true (active) false (expired)
documentOptions.openRecord	Boolean	Indicates if the feature \"Opening times recorded\" is enabled. This feature records the 1st read for each reader.	true
documentOptions.geolocation	Boolean	Indicates if the feature \"Geo-location\" is active. This feature records the geo-location of each reader for every read.	true
documentOptions.verifyCode	Boolean	Indicates if the feature \"Email verification code\" is active. If TRUE, the access code will be emailed to the recipient’s email address as a separate email at the time of generating and sending the RPD™ document. If FALSE, the code will not be sent and will need to be retrieved by the recipient at the moment of accessing the document. Available for Security Level 2 and 3.	true
documentOptions.proofOfSending	Boolean	Indicates if the feature \"Proof of sending\" is active for the RPD™ document. When enabled, the sender will receive an email with proof that their document has been sent. Available for Security Level 1, 2 and 3.	true
documentOptions.readNotification	Boolean	Indicates if the feature \"Notification of reading\" is active. If true, the RPD™ document Owner will receive confirmation emails when recipients open the RPD™ document for the first time. Available for Security Level 2 and 3.	true
documentOptions.readerIp	Boolean	Indicates if the feature \"Reader IP recorded\" is active. This feature allows to record the IP address of each reader for every read.	true
documentOptions.readerEmail	Boolean	Indicates if the feature \"Reader email addresses recorded\" is active. If true, the reader's email address is required to be authenticated (and will be recorded and visible to the RPD™ document Owner) to access the document. Available for Security Level 2 and 3.	true
documentOptions.readTimes	Boolean	If true, read times (date/time of each unique document view) will be recorded per reader and visible to the RPD™ document Owner. Available for Security Level 2 and 3.	true
documentOptions.readTiming	Boolean	If true, reading session duration per session will be recorded per reader and visible to the RPD™ document Owner. If false, reading session duration will not be recorded. The open time is returned as a value in seconds added as a property in the “Open Record” response parameter.	true
documentOptions.voting	Boolean	Indicates if the feature \"Voting\" is enabled. This feature allows readers to like of dislike within the RPD™ document. Available for Security Level 2 and 3.	true
documentOptions.voteSharing	Boolean	Indicates if the feature \"Share votes\" is active. This allows readers to see how other readers voted. Available for Security Level 2 and 3.	true
documentOptions.distRestriction	Boolean	Indicates if the feature \"Restricted distribution\" is active. This allows to restrict the access to the RPD™ document to a list of authorized readers. If true, the document will only permit authentication with the email address that the document owner identified for permitted access (by sending the document to them or identifying the email address in the Create stage as permitted; or if edited after the send).	true
documentOptions.distributionList	Boolean	Indicates if the feature \"Display distribution list\" is enabled. This feature allows readers to see the list of authorized readers. This includes those new persons at Level 2 that the RPD™ document was shared with, not only the original ‘recipients list’. At a minimum, the reader will see the original ‘recipient list’ of a SEND transaction. Available for Security Level 2 and 3.	true
documentOptions.domains	String	Indicates if the feature \"Restrict to domains\" is active. This feature indicates that only readers within these domains will be able to access the RPD™ document. If there's no restriction by domain, this will be blank. Add up to 10 domains separated by comma, no wild cards. Available for Security Level 2 and 3.	domain.com, domain1.com
documentOptions.watermark	Integer	Indicates if a watermark is present in the RPD™ document. 0 -- No watermark 1 -- Watermark: \"Confidential\" 2 -- Watermark: \"Draft\"	2
documentOptions.maxReads	Integer	Defines how many times the reader will be able to open the RPD™ document for reading before access is disabled for that specific reader. The default value is 0 which means unlimited reads. Available for Security Level 2 and 3.	5
documentOptions.steganography	Boolean	If TRUE, the RPD™ document will contain a dynamic tag with the readers’ email address bouncing around the screen. On RDocs™ web, this feature is called \"Identify leakers\". Available for Security Level 2 and 3.	true
documentOptions.timestamp	Boolean	If true, the RPD™ document will be stamped with a watermark on the bottom of the document with the original time and date sent.	true
documentOptions.print	Boolean	Indicates if the reader is able to print the RPD™ document or not.	true
documentOptions.regions	Integer	Array containing the allowed regions in which the readers will have access to the RPD™ document. Readers outside of these regions will not be able to access the RPD™ document, regardless of whether their email addresses have been whitelisted. 0 -- Europe 1 -- Africa 2 -- North America 3 -- South America 4 -- North Asia 5 -- South Asia	[2]
documentOptions.ips	String	It's an array of IP addresses in CIDR format that are authorized to access the RPD™ document. Readers outside of those ranges will not be able to access the RPD™ document, regardless of whether their email addresses have been whitelisted.	192.0.2.0/24
documentOptions.startTime	String	Indicates the date (UTC time format) from when the RPD™ document can be accessed by readers.	2023-07-28T00:00:00Z
documentOptions.expiryTime	String	Indicates the date (UTC time format) when the RPD™ document will automatically expire and will no longer be accessible for readers.	2023-07-31T23:59:59Z
documentOptions.allowResponsesTo	String	Email address to send response from RPD™ document by viewer.	myname@domain.com
documentOptions.documentTemplateId	String	Do not use.	N/A
documentOptions.language	String	This is the language in which the system will send email notifications related to the RPD™ document. Possible values: en-us - (English) ca-ES - (Catalan) cs-CZ - (Czech) da-DK - (Danish) de-DE - (German) el-GR - (Greek) es-ES - (Spanish) fi-FI - ( Finnish) fr-FR - (French) hu-HU - (Hungarian) it-IT - (Italian) nb-NO - (Norwegian) nl-NL - (Dutch) pl-PL - (Polish) pt-BR - (Portuguese) ro-RO - (Romanian) ru-RU - (Russian) sv-SE - (Swedish) tr-TR - (Turkish) pt-PT - (Portuguese) Note: The language the Reader sees when viewing the RPD™ document is solely determined by the Reader’s browser setting.	en-us
documentOptions.source	String	Indicates the application from where the RPD™ document was created.	UI
documentOptions.maxViewsPerDocument	Integer	Indicates the maximum reads per document before the document expires for all readers.	8
documentOptions.pageLevelRestriction	Boolean	Indicates if the feature \"Page level restrictions\" is enabled for the RPD™ document.	true
documentOptions.isSMS	Boolean	Specifies whether the verification code for accessing the RPD™ document is sent to readers via SMS in addition to email.	true
inputFiles.fileName	String	Original file name of the document uploaded to create the RPD™ document.	my-document.docx
inputFiles.modifiedFileName	String	New file name of the document uploaded to create the RPD™ document (modified by the sender).	new-title.docx
inputFiles.fileSize	String	File size of the uploaded file.	17 KB
inputFiles.order	Integer	Order in which the file was uploaded upon creation of the RPD™ document.	0
distributions.email	String	Email address to which the RPD™ document was distributed to. If the document was created and not sent via email, the only distribution information will be the one of the sender.	myname@domain.com
distributions.id	String	ID of the recipient/sender of the RPD™ document.	dd6adbc0-f704-490d-9880-126796bf8be1
distributions.enabled	Boolean	Indicates if the specified email is enabled/authorized to access the RPD™ document.	true
openRecords	Array	The list of records of the opening events of the RPD™ document.	N/A
openRecords.id	String	ID that represents the open record of the document.	958f5b9a-48a2-4cd3-aebd-52baf5f4fd51
openRecords.email	String	The RPD™ document reader' email.	myname@domain.com
openRecords.opened	String	Date and time in which the document was opened.	2023-07-28T20:01:12.979Z
openRecords.ip	String	The IP address of the reader's access location.	180.00.000.01
openRecords.geolocation.ip	String	Reader's IP address.	180.00.000.01
openRecords.geolocation.network	String	Do not use.	182.64.127.0/20
openRecords.geolocation.version	String	It's the Internet Protocol version used by the reader.	IPv4
openRecords.geolocation.city	String	Name of the city in which the document was opened.	New York
openRecords.geolocation.region	String	Name of the region in which the document was opened.	New York
openRecords.geolocation.region_code	String	Code of the region in which the document was opened.	B
openRecords.geolocation.country	String	Country in which the document was opened.	US
openRecords.geolocation.country_code	String	Code of the country in which the document was opened.	US
openRecords.geolocation.country_name	String	Full name of the country in which the document was opened.	United States of America
openRecords.geolocation.country_capital	String	Capital of the country in which the document was opened.	Washington DC
openRecords.geolocation.country_tld	String	Country code top-level domain of the country in which the document was opened.	.us
openRecords.geolocation.country_code_iso3	String	ISO 3 code of the country in which the document was opened.	USA
openRecords.geolocation.continent_code	String	Continent code of the country in which the document was opened.	NA
openRecords.geolocation.postal	String	Postal code of the city in which the document was opened.	2098
openRecords.geolocation.latitude	Integer	Latitude of the location in which the document was opened.	-40.8512
openRecords.geolocation.longitude	Integer	Longitude of the location in which the document was opened.	-26.3531
openRecords.geolocation.timezone	String	Timezone of the location in which the document was opened.	America/United States of America/Eastern_Coast
openRecords.geolocation.utc_offset	String	UTC offset of the location in which the document was opened.	-0300
openRecords.geolocation.country_calling_code	String	Calling code of the country in which the document was opened.	+54
openRecords.geolocation.in_eu	Boolean	Do not use.	true
openRecords.geolocation.currency	String	Currency of the country in which the document was opened.	USD
openRecords.geolocation.currency_name	String	Currency name of the country in which the document was opened.	United States Dollar
openRecords.geolocation.languages	String	Languages of the country in which the document was opened.	en-US,it,de,fr,es
openRecords.geolocation.country_area	Integer	Area coverage of the country on square kilometers.	2766890
openRecords.geolocation.country_population	Integer	Total population of the country.	44494502
openRecords.geolocation.asn	String	ASN number of the local network with which the document was opened.	AS27645
openRecords.geolocation.org	String	Reader’s internet service provider.	Company S.A
openRecords.activityTime	Integer	Total time in seconds of user document reading activity.	600
openRecords.client	String	Reading client browser info.	Chrome 115.
data	String	Do not use.	ASCLHASVCASUID83EYIF324H3KHLV
rpd	String	It's the RPD™ document (HTML file) in a Base64 encoded string. Will contain information when creating an RPD™ document. On this request, will always be null.	ADCVILAUUADSVASADVUUUADVADSUUVAS978ADSCASC
pages	Integer	Amount of pages on the RPD™ document.	1
created	String	Indicates the date in which the RPD™ document was created.	2023-07-21T17:41:10.656Z
modified	String	Indicates when was the last time the RPD™ document was modified by the sender.	2023-07-24T20:58:52.893Z
rpdType	String	If the RPD™ document was created only (\"Create\"), or if it was created and sent via email (\"Send\").	Create
isPermanentExpire	Boolean	Do not use.	false
isKilled	Boolean	Do not use.	false
permanentExpiredDate	String	Do not use.	null
killDate	String	Do not use.	null
pageLevelRestrictionSetting	Boolean	Indicates if the setting \"Page level restrictions\" was set to \"Yes\" at a personal level when the RPD™ document was created.	true

Response codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Message
200	Success. Document records displayed.
401	Unauthorized.

Response Sample

[ \n {\n        \"id\": \"64877b7b311dasdsa806as\",\n        \"documentId\": \"64877b7b311dasdsa806as\",\n        \"ownerId\": \"64877b7b311dasdsa806as\",\n        \"fileName\": \"My file.pdf\",\n        \"senderAddress\": \"myname@mydomain.com\",\n        \"documentOptions\": {\n            \"recipients\": [\n                {\n                    \"email\": \"myname@mydomain.com\",\n                    \"id\": \"0e85adc2-3e88-4084-b386-7ea1e7d21bdd\",\n                    \"code\": \"oPKX0kZaQCZF\",\n                    \"readCount\": 1,\n                    \"enabled\": true,\n                    \"vote\": 1,\n                    \"status\": \"Active\",\n                    \"recipientType\": \"To\",\n                    \"firstName\": \"John\",\n                    \"lastName\": \"Doe\"\n                }\n            ],\n            \"subject\": \"My RPD™ document\",\n            \"message\": \"This is my first RPD™ document generated using RDocs™.\",\n            \"sideNote\": \"Hey everyone!\",\n            \"enabled\": true,\n            \"openRecord\": true,\n            \"geolocation\": true,\n            \"verifyCode\": true,\n            \"proofOfSending\": true,\n            \"readNotification\": true,\n            \"readerIp\": true,\n            \"readerEmail\": true,\n            \"readTimes\": true,\n            \"readTiming\": true,\n            \"voting\": true,\n            \"voteSharing\": true,\n            \"distRestriction\": true,\n            \"distributionList\": true,\n            \"domains\": \"\",\n            \"watermark\": 0,\n            \"maxReads\": 0,\n            \"steganography\": true,\n            \"timestamp\": true,\n            \"print\": false,\n            \"regions\": [\n                3\n            ],\n            \"ips\": [\n                \"\"\n            ],\n            \"startTime\": \"2023-06-12T20:09:29.97Z\",\n            \"expiryTime\": null,\n            \"allowResponsesTo\": \"myname@mydomain.com\",\n            \"language\": \"en-us\",\n            \"source\": \"API/RmailOutlookplugin/UI\",\n            \"maxViewsPerDocument\": 0\n        },\n        \"inputFiles\": [\n            {\n                \"fileName\": \"My file.pdf\",\n                \"modifiedFileName\": null,\n                \"fileSize\": null,\n                \"order\": 1\n            }\n        ],\n        \"distributions\": [\n            {\n                \"email\": \"myname@mydomain.com\",\n                \"id\": \"dc9d7f23-5f83-45b3-994b-abb7d546e2e3\",\n                \"enabled\": true\n            },\n            {\n                \"email\": \"myname@mydomain.com\",\n                \"id\": \"38e145e3-e217-4d3d-994b-caa87baa3a1a\",\n                \"enabled\": true\n            }\n        ],\n        \"openRecords\": [\n            {\n                \"id\": \"261e2b3a-72cd-4e24-8397-9fe069d9cd8d\",\n                \"email\": \"myname@mydomain.com\",\n                \"opened\": \"2023-06-12T20:12:44.301Z\",\n                \"ip\": \"180.0.1.205\",\n                \"geolocation\": {\n                    \"ip\": \"180.0.1.205\",\n                    \"network\": \"181.0.0.0/23\",\n                    \"version\": \"IPv4\",\n                    \"city\": \"New York\",\n                    \"region\": \"New York\",\n                    \"region_code\": \"A\",\n                    \"country\": \"US\",\n                    \"country_code\": \"US\",\n                    \"country_name\": \"United States of America\",\n                    \"country_capital\": \"Washington DC\",\n                    \"country_tld\": \".us\",\n                    \"country_code_iso3\": \"USA\",\n                    \"continent_code\": \"NA\",\n                    \"postal\": \"1890\",\n                    \"latitude\": -14.751100,\n                    \"longitude\": -98.629100,\n                    \"timezone\": \"America/United States of America/Eastern_Coast\",\n                    \"utc_offset\": \"-0300\",\n                    \"country_calling_code\": \"+54\",\n                    \"in_eu\": false,\n                    \"currency\": \"USD\",\n                    \"currency_name\": \"United States Dollar\",\n                    \"languages\": \"en-US,it,de,fr,es\",\n                    \"country_area\": 2766890,\n                    \"country_population\": 44494502,\n                    \"asn\": \"AS111111\",\n                    \"org\": \"Company S.A.\"\n                },\n                \"activityTime\": 600,\n                \"client\": \"Chrome 114\"\n            }\n        ],\n        \"data\": null,\n        \"rpd\": null,\n        \"pages\": 5,\n        \"created\": \"2023-06-12T20:09:31.637Z\",\n        \"modified\": null,\n        \"rpdType\": \"Send\",\n        \"isPermanentExpire\": false,\n        \"isKilled\": false,\n        \"permanentExpiredDate\": null,\n        \"killDate\": null\n    }\n]\n\n

\n","urlObject":{"path":["api","v1","docs"],"host":["If you don't count with this value, please contact your RPost® representative."],"query":[],"variable":[]}},"response":[{"id":"6a5fe9fe-dd73-4350-86a6-723d6b7acf3e","name":"200 - OK","originalRequest":{"method":"GET","header":[],"url":"https://base_url/api/v1/docs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 01 Aug 2023 18:55:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"close"},{"key":"Set-Cookie","value":"AWSALB=/yZw+r9ORm8FNulbb6QX/hu1eUZS19/kg+d0E0nC3+cTg2uABBKxUEGIvvpaYUWD29BgDACK3F8QROuVdBMOWlLT8nuR+F295CSDMV0fctpXEKRKtpHC/i+Gvsp8; Expires=Tue, 08 Aug 2023 18:55:32 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=/yZw+r9ORm8FNulbb6QX/hu1eUZS19/kg+d0E0nC3+cTg2uABBKxUEGIvvpaYUWD29BgDACK3F8QROuVdBMOWlLT8nuR+F295CSDMV0fctpXEKRKtpHC/i+Gvsp8; Expires=Tue, 08 Aug 2023 18:55:32 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"64c448445542c4b2a5f7fc58\",\n \"documentId\": \"175431400293DBEC3512FEBF\",\n \"ownerId\": \"6455341ba2673623f84738a7\",\n \"fileName\": \"My RPD™ document\",\n \"senderAddress\": \"myname@domain.com\",\n \"documentOptions\": {\n \"recipients\": [\n {\n \"email\": \"recipient1@domain.com\",\n \"id\": \"7d31aa20-d40c-491e-92e1-a33d22056589\",\n \"code\": \"yzml8BH0XhCU\",\n \"readCount\": 1,\n \"enabled\": true,\n \"vote\": -1\n }\n ],\n \"subject\": \"Description of this RPD™ document.\",\n \"message\": \"\",\n \"sideNote\": \"This is a SideNote®.\",\n \"enabled\": true,\n \"openRecord\": true,\n \"geolocation\": true,\n \"verifyCode\": true,\n \"proofOfSending\": false,\n \"readNotification\": false,\n \"readerIp\": true,\n \"readerEmail\": true,\n \"readTimes\": true,\n \"readTiming\": true,\n \"voting\": false,\n \"voteSharing\": false,\n \"distRestriction\": false,\n \"distributionList\": false,\n \"domains\": \"\",\n \"watermark\": 0,\n \"maxReads\": 0,\n \"steganography\": false,\n \"timestamp\": false,\n \"print\": false,\n \"regions\": [\n 1,\n 0,\n 4,\n 2\n ],\n \"ips\": [\n \"\"\n ],\n \"startTime\": \"2023-07-28T22:59:16.504Z\",\n \"expiryTime\": null,\n \"allowResponsesTo\": \"myname@domain.com\",\n \"language\": \"en-us\",\n \"maxViewsPerDocument\": 10\n },\n \"inputFiles\": [\n {\n \"fileName\": \"file1.docx\",\n \"modifiedFileName\": \"RPD1.docx\",\n \"fileSize\": \"14 KB\",\n \"order\": 0\n },\n {\n \"fileName\": \"file2.docx\",\n \"modifiedFileName\": \"RPD2.docx\",\n \"fileSize\": \"17 KB\",\n \"order\": 1\n }\n ],\n \"distributions\": [\n {\n \"email\": \"myname@domain.com\",\n \"id\": \"637dc224-a18e-452e-a6b1-871ae577f711\",\n \"enabled\": true\n },\n {\n \"email\": \"recipient1@domain.com\",\n \"id\": \"287277ef-54bd-4f3b-8992-1977f1eb0c35\",\n \"enabled\": true\n }\n ],\n \"openRecords\": [\n {\n \"id\": \"13579c2f-11fa-4b9c-8118-51d185c79789\",\n \"email\": \"recipient1@domain.com\",\n \"opened\": \"2023-07-31T18:59:50.974Z\",\n \"ip\": \"180.00.000.00\",\n \"geolocation\": {\n \"ip\": \"180.00.000.00\",\n \"network\": \"180.00.000.0/22\",\n \"version\": \"IPv4\",\n \"city\": \"New York\",\n \"region\": \"New York\",\n \"region_code\": \"A\",\n \"country\": \"US\",\n \"country_code\": \"US\",\n \"country_name\": \"United States of America\",\n \"country_capital\": \"Washington DC\",\n \"country_tld\": \".us\",\n \"country_code_iso3\": \"USA\",\n \"continent_code\": \"NA\",\n \"postal\": \"1890\",\n \"latitude\": -14.751100,\n \"longitude\": -98.629100,\n \"timezone\": \"America/United States of America/Eastern_Coast\",\n \"utc_offset\": \"-0300\",\n \"country_calling_code\": \"+54\",\n \"in_eu\": false,\n \"currency\": \"USD\",\n \"currency_name\": \"United States Dollar\",\n \"languages\": \"en-US,it,de,fr,es\",\n \"country_area\": 2766890,\n \"country_population\": 44494502,\n \"asn\": \"AS11111\",\n \"org\": \"Company S.A.\"\n },\n \"activityTime\": 600,\n \"client\": \"Chrome 115\"\n }\n ],\n \"data\": null,\n \"rpd\": null,\n \"pages\": 3,\n \"created\": \"2023-07-28T22:59:16.601Z\",\n \"modified\": null,\n \"rpdType\": \"Create\"\n }\n]"},{"id":"a9a5a89a-f622-42fd-820d-f83d82866553","name":"401 - Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://base_url/api/v1/docs"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 31 Jul 2023 21:17:58 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=b5UOP69CrrpkDdZZev8PSwr6EJJZeR03KWk0ef9Qhh/yJE76QPbVMaXZ+chkUCYHjKixrp7OnCFiOeNG/5UqlR6aEuJpC6NAaGWj0CeZbB3sMrxLig8pE9DZYE75; Expires=Mon, 07 Aug 2023 21:17:58 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=b5UOP69CrrpkDdZZev8PSwr6EJJZeR03KWk0ef9Qhh/yJE76QPbVMaXZ+chkUCYHjKixrp7OnCFiOeNG/5UqlR6aEuJpC6NAaGWj0CeZbB3sMrxLig8pE9DZYE75; Expires=Mon, 07 Aug 2023 21:17:58 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"WWW-Authenticate","value":"Bearer error=\"invalid_token\", error_description=\"The token expired at '07/22/2023 17:58:18'\""},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"51c9d626-f7c1-4518-89ef-ccbfdc45808b"},{"name":"Create and Send a RPD™ document","id":"894244b9-b211-4e82-beab-50f3fadcf0b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","description":"

File/s to be used for creating the RPD™ document.

\n","type":"file"},{"key":"senderAddress","value":"sender@domain.com","description":"

Email address of the creator/sender of the RPD™ document. It can also be used to send/create RPD™ documents on behalf of other users under the same company.

\n","type":"text"},{"key":"documentOptions","value":"","description":"

JSON object where RPD™ document features are set.

\n","type":"text"},{"key":"generateMultipleRPD","value":"false","description":"

If true, it sends/creates multiple RPD™ documents based on the files attached. If false, it sends/creates a single RPD™ document with all of the files attached combined.

\n","type":"text"}]},"url":"If you don't count with this value, please contact your RPost® representative./api/v1/docs/send?html=true&sendEmail=1","description":"

Description

This request allows to upload a file to the RDocs™ service for creating an RPD™ document, with the possibility of also sending it via email to recipients.

Along with the file, document properties are sent in the request form-data body that will allow you to set the features you wish the RPD™ document to have. The RPD™ document will be sent to recipients listed in the documentOptions object, if any.

A document model will be returned with the information about the RPD™ document, and the RPD™ Base64 encoded file itself, if selected that way.

The input file formats can be:

PDF
\n
Microsoft Word and Powerpoint
\n
Images (PNG, JPG, JPEG)
\n

Request

Request Headers

Content-Type: multipart/form-data
\n
Authorization: Bearer {token}
\n

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter Name	Type	Description	Required?	Example
html	query	If true, the request returns the RPD™ document (HTML file) in a string in Base64 format. Default value: false.	No	true
sendEmail	query	If 1, the request will send the RPD™ document via email based on the given recipients on the documentOptions object sent on the body. If 0, the RPD™ document will not be sent via email to the recipients. Default value: 1.	No	0
data	query	Do not use.	No	false

Request Body

Content-Type: multipart/form-data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value	Type	Description	Required?	Example
file	{document}	Array	File/s to be used for creating the RPD™ document.	Yes	N/A
senderAddress	{emailAddress}	String	Email address of the creator/sender of the RPD™ document. It can also be used to send/create RPD™ documents on behalf of other users under the same company.	Yes	myname@domain.com
documentOptions	{Serialized documentOptions object}	Object	JSON object string where RPD™ document features are set.	Yes	{\"Recipients\":[{\"Email\":\"recipient1@domain.com\"},{\"Email\":\"recipient2@domain.com\"}],\"subject\":\"RPD™ - test via API\",\"message\":\"This is a Security Level 2 RPD™.\",\"enabled\":true,\"openRecord\":true,\"geolocation\":true,\"verifyCode\":true,\"proofOfSending\":true,\"readNotification\":true,\"readerIp\":true,\"readerEmail\":true,\"readTimes\":true,\"readTiming\":true,\"voting\":true,\"voteSharing\":true,\"distRestriction\":false,\"distributionList\":true,\"watermark\":1,\"maxReads\":0,\"steganography\":true,\"timestamp\":true,\"print\":true,\"regions\":[],\"ips\":[],\"sidenote\":\"This is the text on the SideNote™\",\"allowResponsesTo\":\"sender@domain.com\"}
generateMultipleRPD	{true/false}	Boolean	If true, it sends/creates multiple RPD™ documents based on the files attached. For example, if you attach 3 files, 3 RPD™ documents will be created/sent to the recipients. If false, it sends/creates a single RPD™ document with all of the files attached combined.	No	true

Object documentOptions Parameters

The following parameters can be included in the request based on the need. If, for example, you don't need to set a maximum of views allowed for the RPD™ document, then you can skip adding the \"maxViewsPerDocument\" parameter to the object.

Parameter Name	Type	Description	Example
documentOptions.recipients	Array	User list of email addresses who will receive the RPD™ document by email and/or are the pre-authorized viewer (required) for Level 3 and editable after the send or create. Maximum recipients per email are 99. Available for Security Levels 1, 2 and 3.	[]
documentOptions.recipients.email	String	Email address of the recipient of the RPD™ document.	myname@mydomain.com
documentOptions.recipients.firstName	String	First name of the recipient.	John
documentOptions.recipients.lastName	String	Last name of the recipient.	Doe
documentOptions.recipients.mobileCountryCode	String	Country code of the recipient's mobile number. Possible values are: +54 (Argentina) +501 (Belize) +1 (Canada) +49 (Germany) +33 (France) +44 (United Kingdom) +91 (India) + 1 (United States)	+1
documentOptions.recipients.mobileNumber	String	Mobile number of the recipient. The passcode to access the RPD™ document is sent to this mobile number.	5551234567
documentOptions.subject	String	If sent: Subject of the email to be sent if RPD™ document is sent via email at the moment of creation. Maximum length is 100 characters.	Please review the attached document.
documentOptions.subject	String	If created: Description of the RPD™ document set at the moment of creation of the document. Maximum length is 100 characters.	This is my first RPD™ document generated using RDocs™.
documentOptions.message	String	The body of the email if the RPD™ document is being created and sent via email. If the RPD™ document is created without sending it via email, this can be blank. Maximum length is 1024 characters.	Hey everyone!
documentOptions.sideNote	String	Describes the content of the SideNote®. If you wish to not add a SideNote® to the RPD™ document, it can be left blank. Maximum length is 512 characters.	Please review and send feedback via email.
documentOptions.enabled	Boolean	Indicates if the RPD™ document is active (the document is available for viewing) or expired (the document is unavailable for viewing) for the recipients specified (Level 3) or any potential viewer (Level 1 and 2).	true (active) false (expired)
documentOptions.openRecord	Boolean	Indicates if the feature \"Opening times recorded\" is enabled. This feature records the 1st read for each reader.	true
documentOptions.geolocation	Boolean	Indicates if the feature \"Geo-location\" is active. This feature records the geo-location of each reader for every read.	true
documentOptions.verifyCode	Boolean	Indicates if the feature \"Email verification code\" is active. If TRUE, the access code will be emailed to the recipient’s email address as a separate email at the time of generating and sending the RPD™ document. If FALSE, the code will not be sent and will need to be retrieved by the recipient at the moment of accessing the document. Available for Security Level 2 and 3.	true
documentOptions.proofOfSending	Boolean	Indicates if the feature \"Proof of sending\" is active for the RPD™ document. When enabled, the sender will receive an email with proof that their document has been sent. Available for Security Level 1, 2 and 3.	true
documentOptions.readNotification	Boolean	Indicates if the feature \"Notification of reading\" is active. If true, the RPD™ document Owner will receive confirmation emails when recipients open the RPD™ document for the first time. Available for Security Level 2 and 3.	true
documentOptions.readerIp	Boolean	Indicates if the feature \"Reader IP recorded\" is active. This feature allows to record the IP address of each reader for every read.	true
documentOptions.readerEmail	Boolean	Indicates if the feature \"Reader email addresses recorded\" is active. If true, the reader's email address is required to be authenticated (and will be recorded and visible to the RPD™ document Owner) to access the document. Available for Security Level 2 and 3.	true
documentOptions.readTimes	Boolean	If true, read times (date/time of each unique document view) will be recorded per reader and visible to the RPD™ document Owner. Available for Security Level 2 and 3.	true
documentOptions.readTiming	Boolean	If true, reading session duration per session will be recorded per reader and visible to the RPD™ document Owner. If false, reading session duration will not be recorded. The open time is returned as a value in seconds added as a property in the “Open Record” response parameter.	true
documentOptions.voting	Boolean	Indicates if the feature \"Voting\" is enabled. This feature allows readers to like of dislike within the RPD™ document. Available for Security Level 2 and 3.	true
documentOptions.voteSharing	Boolean	Indicates if the feature \"Share votes\" is active. This allows readers to see how other readers voted. Available for Security Level 2 and 3.	true
documentOptions.distRestriction	Boolean	Indicates if the feature \"Restricted distribution\" is active. This allows to restrict the access to the RPD™ document to a list of authorized readers. If true, the document will only permit authentication with the email address that the document owner identified for permitted access (by sending the document to them or identifying the email address in the Create stage as permitted; or if edited after the send).	true
documentOptions.distributionList	Boolean	Indicates if the feature \"Display distribution list\" is enabled. This feature allows readers to see the list of authorized readers. This includes those new persons at Level 2 that the RPD™ document was shared with, not only the original ‘recipients list’. At a minimum, the reader will see the original ‘recipient list’ of a SEND transaction. Available for Security Level 2 and 3.	true
documentOptions.domains	String	Indicates if the feature \"Restrict to domains\" is active. This feature indicates that only readers within these domains will be able to access the RPD™ document. If there's no restriction by domain, this will be blank. Add up to 10 domains separated by comma, no wild cards. Available for Security Level 2 and 3.	domain.com, domain1.com
documentOptions.watermark	Integer	Indicates if a watermark is present in the RPD™ document. 0 -- No watermark 1 -- Watermark: \"Confidential\" 2 -- Watermark: \"Draft\"	2
documentOptions.maxReads	Integer	Defines how many times the reader will be able to open the RPD™ document for reading before access is disabled for that specific reader. The default value is 0 which means unlimited reads. Available for Security Level 2 and 3.	5
documentOptions.steganography	Boolean	If TRUE, the RPD™ document will contain a dynamic tag with the readers’ email address bouncing around the screen. On RDocs™ Web, this feature is called \"Identify leakers\". Available for Security Level 2 and 3.	true
documentOptions.timestamp	Boolean	If true, the RPD™ document will be stamped with a watermark on the bottom of the document with the original time and date sent.	true
documentOptions.print	Boolean	Indicates if the reader is able to print the RPD™ document or not.	true
documentOptions.regions	Integer	Array containing the allowed regions in which the readers will have access to the RPD™ document. Readers outside of these regions will not be able to access the RPD™ document, regardless of whether their email addresses have been whitelisted. 0 -- Europe 1 -- Africa 2 -- North America 3 -- South America 4 -- North Asia 5 -- South Asia	[2]
documentOptions.ips	String	It's an array of IP addresses in CIDR format that are authorized to access the RPD™ document. Readers outside of those ranges will not be able to access the RPD™ document, regardless of whether their email addresses have been whitelisted.	192.0.2.0/24
documentOptions.startTime	String	Indicates the date (UTC time format) from when the RPD™ document can be accessed by readers.	2023-07-28T00:00:00Z
documentOptions.expiryTime	String	Indicates the date (UTC time format) when the RPD™ document will automatically expire and will no longer be accessible for readers.	2023-07-31T23:59:59Z
documentOptions.allowResponsesTo	String	Email address to send response from RPD™ document by viewer.	myname@domain.com
documentOptions.language	String	This is the language in which the system will send email notifications related to the RPD™ document. Possible values: en-us - (English) ca-ES - (Catalan) cs-CZ - (Czech) da-DK - (Danish) de-DE - (German) el-GR - (Greek) es-ES - (Spanish) fi-FI - ( Finnish) fr-FR - (French) hu-HU - (Hungarian) it-IT - (Italian) nb-NO - (Norwegian) nl-NL - (Dutch) pl-PL - (Polish) pt-BR - (Portuguese) ro-RO - (Romanian) ru-RU - (Russian) sv-SE - (Swedish) tr-TR - (Turkish) pt-PT - (Portuguese) Note: The language the Reader sees when viewing the RPD™ document is solely determined by the Reader’s browser setting.	en-us
documentOptions.maxViewsPerDocument	Integer	Indicates the maximum reads per document before the RPD™ document expires for all readers.	8
documentOptions.pageLevelRestriction	Boolean	Indicates if the feature \"Page level restrictions\" should be enabled for the RPD™ document. You can only use this feature if you have the setting set to \"Yes\" at personal level in RDocs™.	true
documentOptions.isSMS	Boolean	Specifies whether the verification code for accessing the RPD™ document is sent to readers via SMS in addition to email. You can only use this feature if you have the setting \"Text Authentication\" set to \"Yes\" at personal level in RDocs™.	true

Response

Response Headers

No response headers

Response Body

Parameter Name	Type	Description	Example
id	String	ID that represents the RDocs™ transaction.	64877b7b311dasdsa806as
documentId	String	ID that represents the RDocs™ RPD™ document (RPost® Protected Document).	553521120870BEAF3506DAAD
ownerId	String	ID that represents the RDocs™ user that generated the RPD™ document (RPost® Protected Document).	64877b7b311dasdsa806as
fileName	String	Name of the RPD™ document.	My file.pdf
senderAddress	String	Email of the end user who requested the RPD™ document to be created.	myname@mydomain.com
documentOptions.recipients	Array	User list of email addresses who received the RPD™ document by email and/or are the pre-authorized viewer (required) for Level 3 and editable after the send or create. Maximum recipients per email are 99. Available for Security Levels 1, 2 and 3.	N/A
documentOptions.recipients.email	String	Email address of the recipient of the RPD™ document.	myname@mydomain.com
documentOptions.recipients.id	String	Recipient ID.	0e85adc2-3e88-4084-b386-7ea1e7d21bdd
documentOptions.recipients.code	String	Recipient verification code. This will be sent to the recipient email to access the RPD™ document.	oPKX0kZaQCZF
documentOptions.recipients.readCount	Integer	Indicates how many times the recipient viewed the RPD™ document.	1
documentOptions.recipients.enabled	Boolean	Indicates if the recipient is enabled or banned from seeing the RPD™ document.	true
documentOptions.recipients.vote	Integer	Indicates if the recipient voted on the RPD™ document.	1 (The recipient voted) -1 (The recipient didn't vote)
documentOptions.recipients.status	String	Indicates the status of the recipient (whether they have access to the RPD™ document or not). Possible values: - Active - Banned - Pause	Active
documentOptions.recipients.recipientType	String	Do not use.	To
documentOptions.recipients.firstName	String	First name of the recipient.	John
documentOptions.recipients.lastName	String	Last name of the recipient.	Doe
documentOptions.recipients.mobileCountryCode	String	Country code of the recipient's mobile number. Possible values are: +54 (Argentina) +501 (Belize) +1 (Canada) +49 (Germany) +33 (France) +44 (United Kingdom) +91 (India) + 1 (United States)	+1
documentOptions.recipients.mobileNumber	String	Mobile number of the recipient. The passcode to access the RPD™ document is sent to this mobile number.	5551234567
documentOptions.subject	String	Subject of the email sent if RPD™ document was sent via email at the moment of creation. Maximum length is 100 characters.	Please review the attached document.
documentOptions.subject	String	Description of the RPD™ document set at the moment of creation of the document. Maximum length is 100 characters.	This is my first RPD™ document generated using RDocs™.
documentOptions.message	String	The body of the email sent if the RPD™ document was created and sent via email. If the RPD™ document was created without having sent it as an email, this will be blank. Maximum length is 1024 characters.	Hey everyone!
documentOptions.sideNote	String	Describes the text sent on the SideNote®, if the RPD™ document contains one. Maximum length is 512 characters.	Please review and send feedback via email.
documentOptions.enabled	Boolean	Indicates if the RPD™ document is active (the document is available for viewing) or expired (the document is unavailable for viewing) for the recipients specified in the response body (Level 3) or any potential viewer (Level 1 and 2).	true (active) false (expired)
documentOptions.openRecord	Boolean	Indicates if the feature \"Opening times recorded\" is enabled. This feature records the 1st read for each reader.	true
documentOptions.geolocation	Boolean	Indicates if the feature \"Geo-location\" is active. This feature records the geo-location of each reader for every read.	true
documentOptions.verifyCode	Boolean	Indicates if the feature \"Email verification code\" is active. If TRUE, the access code will be emailed to the recipient’s email address as a separate email at the time of generating and sending the RPD™ document. If FALSE, the code will not be sent and will need to be retrieved by the recipient at the moment of accessing the document. Available for Security Level 2 and 3.	true
documentOptions.proofOfSending	Boolean	Indicates if the feature \"Proof of sending\" is active for the RPD™ document. When enabled, the sender will receive an email with proof that their document has been sent. Available for Security Level 1, 2 and 3.	true
documentOptions.readNotification	Boolean	Indicates if the feature \"Notification of reading\" is active. If true, the RPD™ document Owner will receive confirmation emails when recipients open the RPD™ document for the first time. Available for Security Level 2 and 3.	true
documentOptions.readerIp	Boolean	Indicates if the feature \"Reader IP recorded\" is active. This feature allows to record the IP address of each reader for every read.	true
documentOptions.readerEmail	Boolean	Indicates if the feature \"Reader email addresses recorded\" is active. If true, the reader's email address is required to be authenticated (and will be recorded and visible to the RPD™ document Owner) to access the document. Available for Security Level 2 and 3.	true
documentOptions.readTimes	Boolean	If true, read times (date/time of each unique document view) will be recorded per reader and visible to the RPD™ document Owner. Available for Security Level 2 and 3.	true
documentOptions.readTiming	Boolean	If true, reading session duration per session will be recorded per reader and visible to the RPD™ document Owner. If false, reading session duration will not be recorded. The open time is returned as a value in seconds added as a property in the “Open Record” response parameter.	true
documentOptions.voting	Boolean	Indicates if the feature \"Voting\" is enabled for the RPD™ document. This feature allows readers to like or dislike within the RPD™ document. Available for Security Level 2 and 3.	true
documentOptions.voteSharing	Boolean	Indicates if the feature \"Share votes\" is active. This allows readers to see how other readers voted. Available for Security Level 2 and 3.	true
documentOptions.distRestriction	Boolean	Indicates if the feature \"Restricted distribution\" is active. This allows to restrict the access to the RPD™ document to a list of authorized readers. If true, the document will only permit authentication with the email address that the document owner identified for permitted access (by sending the document to them or identifying the email address in the Create stage as permitted; or if edited after the send).	true
documentOptions.distributionList	Boolean	Indicates if the feature \"Display distribution list\" is enabled. This feature allows readers to see the list of authorized readers. This includes those new persons at Level 2 that the RPD™ document was shared with, not only the original ‘recipients list’. At a minimum, the reader will see the original ‘recipient list’ of a SEND transaction. Available for Security Level 2 and 3.	true
documentOptions.domains	String	Indicates if the feature \"Restrict to domains\" is active. This feature indicates that only readers within these domains will be able to access the RPD™ document. If there's no restriction by domain, this will be blank. Add up to 10 domains separated by comma, no wild cards. Available for Security Level 2 and 3.	domain.com, domain1.com
documentOptions.watermark	Integer	Indicates if a watermark is present in the RPD™ document. 0 -- No watermark 1 -- Watermark: \"Confidential\" 2 -- Watermark: \"Draft\"	2
documentOptions.maxReads	Integer	Defines how many times the reader will be able to open the RPD™ document for reading before access is disabled for that specific reader. The default value is 0 which means unlimited reads. Available for Security Level 2 and 3.	5
documentOptions.steganography	Boolean	If TRUE, the RPD™ document will contain a dynamic tag with the readers’ email address bouncing around the screen. On RDocs™ Web, this feature is called \"Identify leakers\". Available for Security Level 2 and 3.	true
documentOptions.timestamp	Boolean	If true, the RPD™ document will be stamped with a watermark on the bottom of the document with the original time and date sent.	true
documentOptions.print	Boolean	Indicates if the reader is able to print the RPD™ document or not.	true
documentOptions.regions	Integer	Array containing the allowed regions in which the readers will have access to the RPD™ document. Readers outside of these regions will not be able to access the RPD™ document, regardless of whether their email addresses have been whitelisted. 0 -- Europe 1 -- Africa 2 -- North America 3 -- South America 4 -- North Asia 5 -- South Asia	[2]
documentOptions.ips	String	It's an array of IP addresses in CIDR format that are authorized to access the RPD™ document. Readers outside of those ranges will not be able to access the RPD™ document, regardless of whether their email addresses have been whitelisted.	192.0.2.0/24
documentOptions.startTime	String	Indicates the date (UTC time format) from when the RPD™ document can be accessed by readers.	2023-07-28T00:00:00Z
documentOptions.expiryTime	String	Indicates the date (UTC time format) when the RPD™ document will automatically expire and will no longer be accessible for readers.	2023-07-31T23:59:59Z
documentOptions.allowResponsesTo	String	Email address to send response from RPD™ document by viewer.	myname@domain.com
documentOptions.documentTemplateId	String	Do not use.	N/A
documentOptions.language	String	This is the language in which the system will send email notifications related to the RPD™ document. Possible values: en-us - (English) ca-ES - (Catalan) cs-CZ - (Czech) da-DK - (Danish) de-DE - (German) el-GR - (Greek) es-ES - (Spanish) fi-FI - ( Finnish) fr-FR - (French) hu-HU - (Hungarian) it-IT - (Italian) nb-NO - (Norwegian) nl-NL - (Dutch) pl-PL - (Polish) pt-BR - (Portuguese) ro-RO - (Romanian) ru-RU - (Russian) sv-SE - (Swedish) tr-TR - (Turkish) pt-PT - (Portuguese) Note: The language the Reader sees when viewing the RPD™ document is solely determined by the Reader’s browser setting.	en-us
documentOptions.source	String	Indicates the application from where the RPD™ document was created.	UI
documentOptions.maxViewsPerDocument	Integer	Indicates the maximum reads per document before the document expires for all readers.	8
documentOptions.pageLevelRestriction	Boolean	Indicates if the feature \"Page level restrictions\" is enabled for the RPD™ document.	true
documentOptions.isSMS	Boolean	Specifies whether the verification code for accessing the RPD™ document is sent to readers via SMS in addition to email.	true
inputFiles.fileName	String	Original file name of the document uploaded to create the RPD™ document.	my-document.docx
inputFiles.modifiedFileName	String	New file name of the document uploaded to create the RPD™ document (modified by the sender).	new-title.docx
inputFiles.fileSize	String	File size of the uploaded file.	17 KB
inputFiles.order	Integer	Order in which the file was uploaded upon creation of the RPD™ document.	0
distributions.id	String	ID of the recipient/sender of the RPD™ document.	dd6adbc0-f704-490d-9880-126796bf8be1
distributions.enabled	Boolean	Indicates if the specified email is enabled/authorized to access the RPD™ document.	true
openRecords	Array	The list of records of the opening events of the RPD™ document. Here will be blank because the RPD™ document was just created and no reader opened it yet.	N/A
data	String	Do not use.	null
rpd	String	It's the RPD™ document (HTML file) in a Base64 encoded string.	null
pages	Integer	Amount of pages on the RPD™ document.	1
created	String	Indicates the date in which the RPD™ document was created.	2023-07-21T17:41:10.656Z
modified	String	Indicates when was the last time the RPD™ document was modified by the sender.	2023-07-24T20:58:52.893Z
rpdType	String	If the RPD™ document was created only (\"Create\"), or if it was created and sent via email (\"Send\").	Create
isPermanentExpire	Boolean	Do not use.	false
isKilled	Boolean	Do not use.	false
permanentExpiredDate	String	Do not use.	null
killDate	String	Do not use.	null
pageLevelRestrictionSetting	Boolean	Indicates if the setting \"Page level restrictions\" was set to \"Yes\" at a personal level when the RPD™ document was created.	true

Response codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Message
200	Success. RPD™ document created.
401	Unauthorized.
400	Bad request.

Response Sample

{\n    \"id\": \"64e7c6733b7e5816098823a2\",\n    \"documentId\": \"602864297721ECAF4908CBFA\",\n    \"ownerId\": \"6455341ba2673623f84738a7\",\n    \"fileName\": \"test.docx\",\n    \"senderAddress\": \"sender@domain.com\",\n    \"documentOptions\": {\n        \"recipients\": [\n            {\n                \"email\": \"recipient1@domain.com\",\n                \"id\": \"ab136584-e070-49c6-8284-535ad30c1f97\",\n                \"code\": \"SmXuI0EMehvZ\",\n                \"readCount\": 0,\n                \"enabled\": true,\n                \"vote\": -1,\n                \"status\": \"Active\",\n                \"recipientType\": \"To\",\n                \"firstName\": \"John\",\n                \"lastName\": \"Doe\"\n            }\n        ],\n        \"subject\": \"test - RPD™ file sent via email to recipient\",\n        \"message\": \"This is the body of the email\",\n        \"sideNote\": \"This is a SideNote®.\",\n        \"enabled\": true,\n        \"openRecord\": true,\n        \"geolocation\": true,\n        \"verifyCode\": true,\n        \"proofOfSending\": true,\n        \"readNotification\": true,\n        \"readerIp\": true,\n        \"readerEmail\": true,\n        \"readTimes\": true,\n        \"readTiming\": true,\n        \"voting\": false,\n        \"voteSharing\": true,\n        \"distRestriction\": false,\n        \"distributionList\": true,\n        \"domains\": \"\",\n        \"watermark\": 1,\n        \"maxReads\": 0,\n        \"steganography\": true,\n        \"timestamp\": true,\n        \"print\": true,\n        \"regions\": [],\n        \"ips\": [],\n        \"startTime\": \"2023-08-24T21:06:59.0952012Z\",\n        \"expiryTime\": null,\n        \"allowResponsesTo\": \"sender@domain.com\",\n        \"language\": \"en-US\",\n        \"source\": \"API/RmailOutlookplugin/UI\",\n        \"maxViewsPerDocument\": 0\n    },\n    \"inputFiles\": [\n        {\n            \"fileName\": \"test.docx\",\n            \"modifiedFileName\": \"test.docx\",\n            \"fileSize\": null,\n            \"order\": 1\n        }\n    ],\n    \"distributions\": [\n        {\n            \"email\": \"sender@domain.com\",\n            \"id\": \"c19a220e-fd9b-4b24-a15a-10c57de289aa\",\n            \"enabled\": true\n        },\n        {\n            \"email\": \"recipient1@domain.com\",\n            \"id\": \"6b6a5dc4-780a-4204-bcc8-6f48147608d4\",\n            \"enabled\": true\n        }\n    ],\n    \"openRecords\": [],\n    \"data\": null,\n    \"rpd\": \"PCFkb2N0eXBlIGh0bWw+DQo8aHRtbCBsYW5nP=\",\n    \"pages\": 2,\n    \"created\": \"2023-08-24T21:06:59.3424586Z\",\n    \"modified\": null,\n    \"rpdType\": \"Create\",\n    \"isPermanentExpire\": false,\n    \"isKilled\": false,\n    \"permanentExpiredDate\": null,\n    \"killDate\": null\n}\n\n

\n","urlObject":{"path":["api","v1","docs","send"],"host":["If you don't count with this value, please contact your RPost® representative."],"query":[{"description":{"content":"

If true, the request returns the RPD™ document (HTML file) in a Base64 string. Default value: false.

\n","type":"text/plain"},"key":"html","value":"true"},{"description":{"content":"

If 1, the request will send the RPD™ document via email based on the given recipients. If 0, the RPD™ document will not be sent via email to the recipients. Default value: 1.

\n","type":"text/plain"},"key":"sendEmail","value":"1"}],"variable":[]}},"response":[{"id":"8266830e-56d4-493b-beba-2b2bc736335f","name":"200 OK - RPD™ file created and not sent via email","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","description":"File to be used for creating the RPD™ document.","type":"file"},{"key":"senderAddress","value":"sender@domain.com","description":"Email address of the creator/sender of the RPD™ document. It can also be used to send/create RPD™ documents on behalf of other users under the same company.","type":"text"},{"key":"documentOptions","value":"{\"Recipients\":[],\"subject\":\"test - RPD™\",\"message\":\"\",\"enabled\":true,\"openRecord\":true,\"geolocation\":true,\"verifyCode\":true,\"proofOfSending\":true,\"readNotification\":true,\"readerIp\":true,\"readerEmail\":true,\"readTimes\":true,\"readTiming\":true,\"voting\":true,\"voteSharing\":true,\"distRestriction\":false,\"distributionList\":true,\"watermark\":1,\"maxReads\":0,\"steganography\":true,\"timestamp\":true,\"print\":true,\"regions\":[],\"ips\":[],\"sidenote\":\"This is a SideNote™\",\"allowResponsesTo\":\"sender@domain.com\"}","description":"JSON object string where RPD™ document features are set.","type":"text"},{"key":"generateMultipleRPD","value":"false","description":"If true, it sends/creates multiple RPD™ documents based on the files attached. If false, it sends/creates a single RPD™ document with all of the files attached combined.","type":"text"}]},"url":{"raw":"https://api.rdocs.io/api/v1/docs/send?html=true&sendEmail=0","protocol":"https","host":["api","rdocs","io"],"path":["api","v1","docs","send"],"query":[{"key":"html","value":"true","description":"If true, the request returns the RPD™ document (HTML file) in a Base64 string. Default value: false."},{"key":"sendEmail","value":"0","description":"If 1, the request will send the RPD™ document via email based on the given recipients. If 0, the RPD™ document will not be sent via email to the recipients. Default value: 1."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Aug 2023 20:34:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=S4kuFXe2L14MgiaWxJZnQiizM4v6aMAnKBDO19LHey8rUvYYT+jcJBM+SVq19CGuUH+dwU6/3gahBIv1Tzn/Df5UpUmMsUPIv9t6WAd3tjrBHmyFTZOGGA7LVYw7; Expires=Thu, 31 Aug 2023 20:34:49 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=S4kuFXe2L14MgiaWxJZnQiizM4v6aMAnKBDO19LHey8rUvYYT+jcJBM+SVq19CGuUH+dwU6/3gahBIv1Tzn/Df5UpUmMsUPIv9t6WAd3tjrBHmyFTZOGGA7LVYw7; Expires=Thu, 31 Aug 2023 20:34:49 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"64e7beea3b7e581609882397\",\n \"documentId\": \"456951835970CFBF5546ABDD\",\n \"ownerId\": \"6455341ba5173623b84738a6\",\n \"fileName\": \"test.docx\",\n \"senderAddress\": \"sender@domain.com\",\n \"documentOptions\": {\n \"recipients\": [],\n \"subject\": \"test - RPD™ document\",\n \"message\": \"\",\n \"sideNote\": \"This is a SideNote®.\",\n \"enabled\": true,\n \"openRecord\": true,\n \"geolocation\": true,\n \"verifyCode\": true,\n \"proofOfSending\": true,\n \"readNotification\": true,\n \"readerIp\": true,\n \"readerEmail\": true,\n \"readTimes\": true,\n \"readTiming\": true,\n \"voting\": true,\n \"voteSharing\": true,\n \"distRestriction\": false,\n \"distributionList\": true,\n \"domains\": \"\",\n \"watermark\": 1,\n \"maxReads\": 0,\n \"steganography\": true,\n \"timestamp\": true,\n \"print\": true,\n \"regions\": [],\n \"ips\": [],\n \"startTime\": \"2023-08-24T20:34:49.8505614Z\",\n \"expiryTime\": null,\n \"allowResponsesTo\": \"sender@domain.com\",\n \"language\": \"en-US\",\n \"maxViewsPerDocument\": 0\n },\n \"inputFiles\": [\n {\n \"fileName\": \"test.docx\",\n \"modifiedFileName\": \"test.docx\",\n \"fileSize\": null,\n \"order\": 1\n }\n ],\n \"distributions\": [\n {\n \"email\": \"sender@domain.com\",\n \"id\": \"b07d7c10-da52-4b9c-b3be-0c5e7b71d79a\",\n \"enabled\": true\n }\n ],\n \"openRecords\": [],\n \"data\": null,\n \"rpd\": \"PCFkb2N0eXBlIGh0bWw+DQo8aHRtbCBsY==\",\n \"pages\": 4,\n \"created\": \"2023-08-24T20:34:50.0224413Z\",\n \"modified\": null,\n \"rpdType\": \"Create\"\n}"},{"id":"ab75d723-b5d2-4db9-87fb-28e52739d6a1","name":"200 OK - RPD™ file created and sent via email","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","description":"File to be used for creating the RPD™ document","type":"file"},{"key":"senderAddress","value":"agodoy@rpost.com","description":"Email address of the creator/sender of the RPD™ document. It can also be used to send/create RPD™ documents on behalf of other users under the same company.","type":"text"},{"key":"documentOptions","value":"{\"Recipients\":[{\"Email\":\"recipient1@domain.com\"}],\"subject\":\"test - RPD™ sent via email to recipient\",\"message\":\"This is the body of the email\",\"enabled\":true,\"openRecord\":true,\"geolocation\":true,\"verifyCode\":true,\"proofOfSending\":true,\"readNotification\":true,\"readerIp\":true,\"readerEmail\":true,\"readTimes\":true,\"readTiming\":true,\"voting\":false,\"voteSharing\":true,\"distRestriction\":false,\"distributionList\":true,\"watermark\":1,\"maxReads\":0,\"steganography\":true,\"timestamp\":true,\"print\":true,\"regions\":[],\"ips\":[],\"sidenote\":\"This is a SideNote™\",\"allowResponsesTo\":\"sender@domain.com\"}","description":"JSON object string where RPD™ document features are set.","type":"text"},{"key":"generateMultipleRPD","value":"false","description":"If true, it sends/creates multiple RPD™ documents based on the files attached. If false, it sends/creates a single RPD™ document with all of the files attached combined.","type":"text"}]},"url":{"raw":"https://If you don't count with this value, please contact your RPost® representative./api/v1/docs/send?html=true&sendEmail=1","protocol":"https","host":["If you don't count with this value, please contact your RPost® representative."],"path":["api","v1","docs","send"],"query":[{"key":"html","value":"true","description":"If true, the request returns the RPD™ document (HTML file) in a Base64 string. Default value: false."},{"key":"sendEmail","value":"1","description":"If 1, the request will send the RPD™ document via email based on the given recipients. If 0, the RPD™ document will not be sent via email to the recipients. Default value: 1."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Aug 2023 21:07:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=FVpO8LAlJlDDrUsbiAsl5BKPovqVJbSFKN2SnDfHZATx+xkoDC3CwQwLbRoDoajYSPERIU3O68g9mKT+uBlWYVEBMFhWvh4MHBuYgJUUpTkvqSudww45OZzVAWQM; Expires=Thu, 31 Aug 2023 21:06:58 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=FVpO8LAlJlDDrUsbiAsl5BKPovqVJbSFKN2SnDfHZATx+xkoDC3CwQwLbRoDoajYSPERIU3O68g9mKT+uBlWYVEBMFhWvh4MHBuYgJUUpTkvqSudww45OZzVAWQM; Expires=Thu, 31 Aug 2023 21:06:58 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"64e7c6733b7e5816098823a2\",\n \"documentId\": \"602864297721ECAF4908CBFA\",\n \"ownerId\": \"6455341ba2673623f84738a7\",\n \"fileName\": \"test.docx\",\n \"senderAddress\": \"sender@domain.com\",\n \"documentOptions\": {\n \"recipients\": [\n {\n \"email\": \"recipient1@domain.com\",\n \"id\": \"ab136584-e070-49c6-8284-535ad30c1f97\",\n \"code\": \"SmXuI0EMehvZ\",\n \"readCount\": 0,\n \"enabled\": true,\n \"vote\": -1\n }\n ],\n \"subject\": \"test - RPD™ sent via email to recipient\",\n \"message\": \"This is the body of the email\",\n \"sideNote\": \"This is a SideNote®.\",\n \"enabled\": true,\n \"openRecord\": true,\n \"geolocation\": true,\n \"verifyCode\": true,\n \"proofOfSending\": true,\n \"readNotification\": true,\n \"readerIp\": true,\n \"readerEmail\": true,\n \"readTimes\": true,\n \"readTiming\": true,\n \"voting\": false,\n \"voteSharing\": true,\n \"distRestriction\": false,\n \"distributionList\": true,\n \"domains\": \"\",\n \"watermark\": 1,\n \"maxReads\": 0,\n \"steganography\": true,\n \"timestamp\": true,\n \"print\": true,\n \"regions\": [],\n \"ips\": [],\n \"startTime\": \"2023-08-24T21:06:59.0952012Z\",\n \"expiryTime\": null,\n \"allowResponsesTo\": \"sender@domain.com\",\n \"language\": \"en-US\",\n \"maxViewsPerDocument\": 0\n },\n \"inputFiles\": [\n {\n \"fileName\": \"test.docx\",\n \"modifiedFileName\": \"test.docx\",\n \"fileSize\": null,\n \"order\": 1\n }\n ],\n \"distributions\": [\n {\n \"email\": \"sender@domain.com\",\n \"id\": \"c19a220e-fd9b-4b24-a15a-10c57de289aa\",\n \"enabled\": true\n },\n {\n \"email\": \"recipient1@domain.com\",\n \"id\": \"6b6a5dc4-780a-4204-bcc8-6f48147608d4\",\n \"enabled\": true\n }\n ],\n \"openRecords\": [],\n \"data\": null,\n \"rpd\": \"PCFkb2N0eXBlIGh0bWw+DQo8aHRtbCBsYW5nP=\",\n \"pages\": 2,\n \"created\": \"2023-08-24T21:06:59.3424586Z\",\n \"modified\": null,\n \"rpdType\": \"Create\"\n}"},{"id":"1f5f1fdb-f9ee-411e-b285-7fa77b79f01e","name":"400 Bad request - documentOptions not set correctly","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","description":"File to be used for creating the RPD™ document","type":"file"},{"key":"senderAddress","value":"sender@domain.com","description":"Email address of the creator/sender of the RPD™ document. It can also be used to send/create RPD™ documents on behalf of other users under the same company.","type":"text"},{"key":"documentOptions","value":"{\"Recipients\":\"}],\"subject\":\"test - RPD™ sent via email to recipient\",\"message\":\"This is the body of the email\",\"enabled\":true,\"openRecord\":true,\"geolocation\":true,\"verifyCode\":true,\"proofOfSending\":true,\"readNotification\":true,\"readerIp\":true,\"readerEmail\":true,\"readTimes\":true,\"readTiming\":true,\"voting\":false,\"voteSharing\":true,\"distRestriction\":false,\"distributionList\":true,\"watermark\":1,\"maxReads\":0,\"steganography\":true,\"timestamp\":true,\"print\":true,\"regions\":[],\"ips\":[],\"sidenote\":\"This is a SideNote™\",\"allowResponsesTo\":\"sender@domain.com\"}","description":"JSON object string where RPD's features are set.","type":"text"},{"key":"generateMultipleRPD","value":"false","description":"If true, it sends/creates multiple RPD™ documents based on the files attached. If false, it sends/creates a single RPD™ with all of the files attached combined.","type":"text"}]},"url":{"raw":"https://If you don't count with this value, please contact your RPost® representative./api/v1/docs/send?html=true&sendEmail=1","protocol":"https","host":["If you don't count with this value, please contact your RPost® representative."],"path":["api","v1","docs","send"],"query":[{"key":"html","value":"true","description":"If true, the request returns the RPD™ document (HTML file) in a Base64 string. Default value: false."},{"key":"sendEmail","value":"1","description":"If 1, the request will send the RPD™ document via email based on the given recipients. If 0, the RPD™ document will not be sent via email to the recipients. Default value: 1."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Aug 2023 21:35:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=oG+ZxAYBz2naq6niLBhCuDERlMGKw0gBfP1V7d31REIaZ2GQ9pX8mCPrcxM+YClBDE+QH+OGOoJjUZgTrpCXtLdHebL9RV3on0UH60ssWsQsyItYSLFvGIdO19CK; Expires=Thu, 31 Aug 2023 21:35:16 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=oG+ZxAYBz2naq6niLBhCuDERlMGKw0gBfP1V7d31REIaZ2GQ9pX8mCPrcxM+YClBDE+QH+OGOoJjUZgTrpCXtLdHebL9RV3on0UH60ssWsQsyItYSLFvGIdO19CK; Expires=Thu, 31 Aug 2023 21:35:16 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"Unexpected character encountered while parsing value: :. Path 'Recipients', line 1, position 14.\"\n}"}],"_postman_id":"894244b9-b211-4e82-beab-50f3fadcf0b1"},{"name":"Update a RPD™ document","id":"f0d31969-05f4-4850-86a5-3cb42534a56f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"6557b968f00d37280f4335ed\",\r\n \"documentId\": \"379211367842BBDC5638CCED\",\r\n \"ownerId\": \"6455341ba2673623f84738a7\",\r\n \"fileName\": \"Sample RPD document\",\r\n \"senderAddress\": \"sender@domain.com\",\r\n \"documentOptions\": {\r\n \"recipients\": [\r\n {\r\n \"email\": \"recipient@domain.com\",\r\n \"id\": \"4c496f7d-cb53-473f-b5cd-bff77bc91809\",\r\n \"code\": \"12345\",\r\n \"readCount\": 0,\r\n \"enabled\": true,\r\n \"vote\": -1\r\n }\r\n ],\r\n \"subject\": \"Test Subject\",\r\n \"message\": \"Test Email Body\",\r\n \"sideNote\": \"\",\r\n \"enabled\": true,\r\n \"openRecord\": true,\r\n \"geolocation\": true,\r\n \"verifyCode\": true,\r\n \"proofOfSending\": false,\r\n \"readNotification\": false,\r\n \"readerIp\": true,\r\n \"readerEmail\": true,\r\n \"readTimes\": true,\r\n \"readTiming\": true,\r\n \"voting\": false,\r\n \"voteSharing\": false,\r\n \"distRestriction\": true,\r\n \"distributionList\": false,\r\n \"domains\": \"\",\r\n \"watermark\": 0,\r\n \"maxReads\": 0,\r\n \"steganography\": false,\r\n \"timestamp\": false,\r\n \"print\": false,\r\n \"regions\": [\r\n 1,\r\n 3,\r\n 0,\r\n 4,\r\n 2,\r\n 5\r\n ],\r\n \"ips\": [\r\n \"\"\r\n ],\r\n \"startTime\": \"2023-11-16T00:00:00Z\",\r\n \"expiryTime\": \"2023-11-30T00:00:00Z\",\r\n \"allowResponsesTo\": \"sender@domain.com\",\r\n \"language\": \"en-us\",\r\n \"maxViewsPerDocument\": 10\r\n },\r\n \"inputFiles\": [\r\n {\r\n \"fileName\": \"SampleDoc.docx\",\r\n \"modifiedFileName\": \"SampleDoc.docx\",\r\n \"fileSize\": \"15 KB\",\r\n \"order\": 0\r\n }\r\n ],\r\n \"distributions\": [\r\n {\r\n \"email\": \"sender@domain.com\",\r\n \"id\": \"6f9f6415-1422-4a13-bd12-382348347400\",\r\n \"enabled\": true\r\n },\r\n {\r\n \"email\": \"recipient@domain.com\",\r\n \"id\": \"bc214678-c567-47f5-a7ae-400b7e8b25ce\",\r\n \"enabled\": true\r\n }\r\n ],\r\n \"openRecords\": [],\r\n \"data\": null,\r\n \"rpd\": null,\r\n \"pages\": 2,\r\n \"created\": \"2023-11-17T19:18:05.521Z\",\r\n \"modified\": \"2023-11-17T21:25:41.52Z\",\r\n \"rpdType\": \"Send\"\r\n}","options":{"raw":{"language":"json"}}},"url":"If you don't count with this value, please contact your RPost® representative./api/v1/docs/:ID","description":"

Description

This request allows to update the properties of a RPD™ document based on the ID.

To use this API, first you need to make a request to the \"Get RPD™ document record by ID\" API with the ID of the RPD™ document you wish to update, and copy and paste the response on the body of this request. Then, update the required properties.

Note: Only some properties of the RPD™ document can be updated via API. Others are restricted. To get a list of all available properties to edit, see the \"Request Body\" section.

Request

Request Headers

Authorization: Bearer {token}

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter Name	Type	Description	Required?	Example
ID	string (url-encoded)	ID of the RPD™ document to be updated.	Yes	240131844035EACA4354BCBA

Request Body

The body must contain the full list of properties returned by the \"Get RPD™ document record by ID\" API, but only the properties on the following list can be updated using this API.

Parameter Name	Type	Description	Example
documentOptions.recipients	Array	User list of email addresses who received the RPD™ document by email and/or are the pre-authorized viewer (required) for Level 3 and editable after the send or create. The maximum number of recipients per email is 99. Available for Security Levels 1, 2, and 3. It can be used for updating the information of an already existing reader, or for adding a new reader.	[]
documentOptions.recipients.email	String	Email address of the recipient of the RPD™ document.	reader@domain.com
documentOptions.recipients.id	String	Recipient ID.	0e85adc2-3e88-4084-b386-7ea1e7d21bdd
documentOptions.recipients.code	String	Recipient verification code. This will be sent to the recipient's email address to access the RPD™ document.	oPKX0kZaQCZF
documentOptions.recipients.readCount	Integer	Indicates how many times the recipient viewed the RPD™ document.	1
documentOptions.recipients.enabled	Boolean	Indicates if the recipient is enabled or banned from seeing the RPD™ document.	true
documentOptions.recipients.vote	Integer	Indicates if the recipient voted on the RPD™ document.	1 (The recipient voted) -1 (The recipient didn't vote)
documentOptions.recipients.status	String	Indicates the status of the recipient (whether they have access to the RPD™ document or not). Possible values: - Active - Banned - Pause	Active
documentOptions.recipients.firstName	String	First name of the recipient.	John
documentOptions.recipients.lastName	String	Last name of the recipient.	Doe
documentOptions.recipients.mobileCountryCode	String	Country code of the recipient's mobile number. Possible values are: +54 (Argentina) +501 (Belize) +1 (Canada) +49 (Germany) +33 (France) +44 (United Kingdom) +91 (India) + 1 (United States)	+1
documentOptions.recipients.mobileNumber	String	Mobile number of the recipient. The passcode to access the RPD™ document is sent to this mobile number.	5551234567
documentOptions.enabled	Boolean	Indicates if the RPD™ document is active (the document is available for viewing) or expired (the document is unavailable for viewing) for the recipients specified in the response body (Level 3) or any potential viewer (Level 1 and 2).	true (active) false (expired)
documentOptions.geolocation	Boolean	Indicates if the feature \"Geo-location\" is active. This feature records the geo-location of each reader for every read.	true
documentOptions.verifyCode	Boolean	Indicates if the feature \"Email verification code\" is active. If TRUE, the access code will be emailed to the recipient’s email address as a separate email at the time of generating and sending the RPD™ document. If FALSE, the code will not be sent and will need to be retrieved by the recipient at the moment of accessing the document. Available for Security Level 2 and 3.	true
documentOptions.proofOfSending	Boolean	Indicates if the feature \"Proof of sending\" is active for the RPD™ document. When enabled, the sender will receive an email with proof that their document has been sent. Available for Security Level 1, 2 and 3.	true
documentOptions.readNotification	Boolean	Indicates if the feature \"Notification of reading\" is active. If true, the RPD™ document Owner will receive confirmation emails when recipients open the RPD™ document for the first time. Available for Security Level 2 and 3.	true
documentOptions.readerIp	Boolean	Indicates if the feature \"Reader IP recorded\" is active. This feature allows to record the IP address of each reader for every read.	true
documentOptions.readerEmail	Boolean	Indicates if the feature \"Reader email addresses recorded\" is active. If true, the reader's email address is required to be authenticated (and will be recorded and visible to the RPD™ document Owner) to access the document. Available for Security Level 2 and 3.	true
documentOptions.readTimes	Boolean	If true, read times (date/time of each unique document view) will be recorded per reader and visible to the RPD™ document Owner. Available for Security Level 2 and 3.	true
documentOptions.readTiming	Boolean	If true, the reading session duration per session will be recorded per reader and visible to the RPD™ document Owner. If false, the reading session duration will not be recorded. The open time is returned as a value in seconds added as a property in the “Open Record” response parameter.	true
documentOptions.voting	Boolean	Indicates if the feature \"Voting\" is enabled. This feature allows readers to decide if they like or dislike the RPD™ document. Available for Security Level 2 and 3.	true
documentOptions.voteSharing	Boolean	Indicates if the feature \"Share votes\" is active. This allows readers to see how other readers voted. Available for Security Level 2 and 3.	true
documentOptions.distRestriction	Boolean	Indicates if the feature \"Restricted distribution\" is active. This allows to restrict the access to the RPD™ document to a list of authorized readers. If true, the document will only permit authentication with the email address that the document owner identified for permitted access (by sending the document to them or identifying the email address in the Create stage as permitted; or if edited after the send).	true
documentOptions.distributionList	Boolean	Indicates if the feature \"Display distribution list\" is enabled. This feature allows readers to see the list of authorized readers. This includes those new persons at Level 2 that the RPD™ document was shared with, not only the original ‘recipients list’. At a minimum, the reader will see the original ‘recipient list’ of a SEND transaction. Available for Security Level 2 and 3.	true
documentOptions.domains	String	Indicates if the feature \"Restrict to domains\" is active. This feature indicates that only readers within these domains will be able to access the RPD™ document. If there's no restriction by domain, this will be blank. Add up to 10 domains separated by comma, no wild cards. Available for Security Level 2 and 3.	domain.com, domain1.com
documentOptions.maxReads	Integer	Defines how many times the reader will be able to open the RPD™ document for reading before access is disabled for that specific reader. The default value is 0 which means unlimited reads. Available for Security Level 2 and 3.	5
documentOptions.steganography	Boolean	If true, the RPD™ document will contain a dynamic tag with the readers’ email address bouncing around the screen. On RDocs™ web, this feature is called \"Identify leakers\". Available for Security Level 2 and 3.	true
documentOptions.print	Boolean	Indicates if the reader is able to print the RPD™ document or not.	true
documentOptions.regions	Array [Integer]	Array containing the allowed regions in which the readers will have access to the RPD™ document. Readers outside of these regions will not be able to access the RPD™ document, regardless of whether their email addresses have been whitelisted. 0 -- Europe 1 -- Africa 2 -- North America 3 -- South America 4 -- North Asia 5 -- South Asia	[2]
documentOptions.ips	String	It's an array of IP addresses in CIDR format that are authorized to access the RPD™ document. Readers outside of those ranges will not be able to access the RPD™ document, regardless of whether their email addresses have been whitelisted.	192.0.2.0/24
documentOptions.startTime	String	Indicates the date (UTC time format) from when the RPD™ document can be accessed by readers.	2023-11-28T00:00:00-04:00
documentOptions.expiryTime	String	Indicates the date (UTC time format) when the RPD™ document will automatically expire and will no longer be accessible for readers.	2023-11-30T00:00:00-04:00
documentOptions.allowResponsesTo	String	Email address to send the responses from RPD™ document viewers.	myname@domain.com
documentOptions.language	String	This is the language in which the system will send email notifications related to the RPD™ document. Possible values: en-us - (English) ca-ES - (Catalan) cs-CZ - (Czech) da-DK - (Danish) de-DE - (German) el-GR - (Greek) es-ES - (Spanish) fi-FI - ( Finnish) fr-FR - (French) hu-HU - (Hungarian) it-IT - (Italian) nb-NO - (Norwegian) nl-NL - (Dutch) pl-PL - (Polish) pt-BR - (Portuguese) ro-RO - (Romanian) ru-RU - (Russian) sv-SE - (Swedish) tr-TR - (Turkish) pt-PT - (Portuguese) Note: The language the reader sees when viewing the RPD™ document is solely determined by the reader’s browser setting.	en-us
documentOptions.maxViewsPerDocument	Integer	Indicates the maximum reads per document before the document expires for all readers.	8
documentOptions.pageLevelRestriction	Boolean	Indicates if the feature \"Page level restrictions\" should be enabled for the RPD™ document. You can only modify this feature if you had the setting set to \"Yes\" at personal level in RDocs™ when you created the RPD™ document.	true
documentOptions.isSMS	Boolean	Specifies whether the verification code for accessing the RPD™ document is sent to readers via SMS in addition to email. You can only use this feature if you have the setting \"Text Authentication\" set to \"Yes\" at personal level in RDocs™.	true

Response

Response Headers

No response headers

Response Body

No response body

Response codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Message
200	Success. RPD™ document updated.
400	Bad request.
404	Not found.

","urlObject":{"path":["api","v1","docs",":ID"],"host":["If you don't count with this value, please contact your RPost® representative."],"query":[],"variable":[{"type":"any","value":"Insert here Document ID","key":"ID"}]}},"response":[{"id":"eab0c202-fb62-4a3e-9b1e-fe285e9488a0","name":"200 OK - RPD™ document updated","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"6557b968f00d37280f4335ed\",\r\n \"documentId\": \"379211367842BBDC5638CCED\",\r\n \"ownerId\": \"6455341ba2673623f84738a7\",\r\n \"fileName\": \"Sample RPD document\",\r\n \"senderAddress\": \"sender@domain.com\",\r\n \"documentOptions\": {\r\n \"recipients\": [\r\n {\r\n \"email\": \"recipient@domain.com\",\r\n \"id\": \"4c496f7d-cb53-473f-b5cd-bff77bc91809\",\r\n \"code\": \"12345\",\r\n \"readCount\": 0,\r\n \"enabled\": true,\r\n \"vote\": -1\r\n },\r\n {\r\n \"email\": \"recipient2@domain.com\",\r\n \"id\": \"4c496f7d-cb53-473f-b5cd-bff77bc91810\",\r\n \"code\": \"54321\",\r\n \"readCount\": 0,\r\n \"enabled\": true,\r\n \"vote\": -1\r\n }\r\n ],\r\n \"subject\": \"Test Subject\",\r\n \"message\": \"Test Email Body\",\r\n \"sideNote\": \"\",\r\n \"enabled\": true,\r\n \"openRecord\": true,\r\n \"geolocation\": true,\r\n \"verifyCode\": true,\r\n \"proofOfSending\": false,\r\n \"readNotification\": true,\r\n \"readerIp\": true,\r\n \"readerEmail\": true,\r\n \"readTimes\": true,\r\n \"readTiming\": true,\r\n \"voting\": true,\r\n \"voteSharing\": false,\r\n \"distRestriction\": true,\r\n \"distributionList\": false,\r\n \"domains\": \"\",\r\n \"watermark\": 0,\r\n \"maxReads\": 10,\r\n \"steganography\": false,\r\n \"timestamp\": false,\r\n \"print\": false,\r\n \"regions\": [\r\n 1,\r\n 3,\r\n 0,\r\n 4,\r\n 2,\r\n 5\r\n ],\r\n \"ips\": [\r\n \"\"\r\n ],\r\n \"startTime\": \"2023-11-16T00:00:00Z\",\r\n \"expiryTime\": \"2023-11-30T00:00:00Z\",\r\n \"allowResponsesTo\": \"admin@domain.com\",\r\n \"language\": \"en-us\",\r\n \"maxViewsPerDocument\": 40\r\n },\r\n \"inputFiles\": [\r\n {\r\n \"fileName\": \"SampleDoc.docx\",\r\n \"modifiedFileName\": \"SampleDoc.docx\",\r\n \"fileSize\": \"15 KB\",\r\n \"order\": 0\r\n }\r\n ],\r\n \"distributions\": [\r\n {\r\n \"email\": \"sender@domain.com\",\r\n \"id\": \"6f9f6415-1422-4a13-bd12-382348347400\",\r\n \"enabled\": true\r\n },\r\n {\r\n \"email\": \"recipient@domain.com\",\r\n \"id\": \"bc214678-c567-47f5-a7ae-400b7e8b25ce\",\r\n \"enabled\": true\r\n }\r\n ],\r\n \"openRecords\": [],\r\n \"data\": null,\r\n \"rpd\": null,\r\n \"pages\": 2,\r\n \"created\": \"2023-11-17T19:18:05.521Z\",\r\n \"modified\": \"2023-11-17T21:25:41.52Z\",\r\n \"rpdType\": \"Send\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"If you don't count with this value, please contact your RPost® representative./api/v1/docs/:ID","host":["If you don't count with this value, please contact your RPost® representative."],"path":["api","v1","docs",":ID"],"variable":[{"key":"ID","value":"739817945535AAEF9550DFBE"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 29 Nov 2023 20:11:51 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=Yp1xVrDzeyHF8WNYGaVW015FAOMqrxACz82DkhDzaHcU7dq+zq3Z9+kGjqljwYTtHGhKUNbbCl/0MWJm7+FtnecpLI6niUN/AzAzJThOz3ByLnbstG14QbUs+pzc; Expires=Wed, 06 Dec 2023 20:11:51 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=Yp1xVrDzeyHF8WNYGaVW015FAOMqrxACz82DkhDzaHcU7dq+zq3Z9+kGjqljwYTtHGhKUNbbCl/0MWJm7+FtnecpLI6niUN/AzAzJThOz3ByLnbstG14QbUs+pzc; Expires=Wed, 06 Dec 2023 20:11:51 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":null},{"id":"5d5bf04a-c0ef-492a-8364-485f8b7248f9","name":"400 Bad Request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"documentOptions\": {\r\n \"recipients\": [\r\n {\r\n \"email\": \"recipient@domain.com\",\r\n \"id\": \"4c496f7d-cb53-473f-b5cd-bff77bc91809\",\r\n \"code\": \"12345\",\r\n \"readCount\": 0,\r\n \"enabled\": true,\r\n \"vote\": -1\r\n },\r\n {\r\n \"email\": \"recipient2@domain.com\",\r\n \"id\": \"4c496f7d-cb53-473f-b5cd-bff77bc91810\",\r\n \"code\": \"54321\",\r\n \"readCount\": 0,\r\n \"enabled\": true,\r\n \"vote\": -1\r\n }\r\n ],\r\n \"subject\": \"Test Subject\",\r\n \"message\": \"Test Email Body\",\r\n \"sideNote\": \"\",\r\n \"enabled\": true,\r\n \"openRecord\": true,\r\n \"geolocation\": true,\r\n \"verifyCode\": true,\r\n \"proofOfSending\": false,\r\n \"readNotification\": true,\r\n \"readerIp\": true,\r\n \"readerEmail\": true,\r\n \"readTimes\": true,\r\n \"readTiming\": true,\r\n \"voting\": true,\r\n \"voteSharing\": false,\r\n \"distRestriction\": true,\r\n \"distributionList\": false,\r\n \"domains\": \"\",\r\n \"watermark\": 0,\r\n \"maxReads\": 10,\r\n \"steganography\": false,\r\n \"timestamp\": false,\r\n \"print\": false,\r\n \"regions\": [\r\n 1,\r\n 3,\r\n 0,\r\n 4,\r\n 2,\r\n 5\r\n ],\r\n \"ips\": [\r\n \"\"\r\n ],\r\n \"startTime\": \"2023-11-16T00:00:00Z\",\r\n \"expiryTime\": \"2023-11-30T00:00:00Z\",\r\n \"allowResponsesTo\": \"admin@domain.com\",\r\n \"language\": \"en-us\",\r\n \"maxViewsPerDocument\": 40\r\n },\r\n \"inputFiles\": [\r\n {\r\n \"fileName\": \"SampleDoc.docx\",\r\n \"modifiedFileName\": \"SampleDoc.docx\",\r\n \"fileSize\": \"15 KB\",\r\n \"order\": 0\r\n }\r\n ],\r\n \"distributions\": [\r\n {\r\n \"email\": \"sender@domain.com\",\r\n \"id\": \"6f9f6415-1422-4a13-bd12-382348347400\",\r\n \"enabled\": true\r\n },\r\n {\r\n \"email\": \"recipient@domain.com\",\r\n \"id\": \"bc214678-c567-47f5-a7ae-400b7e8b25ce\",\r\n \"enabled\": true\r\n }\r\n ],\r\n \"openRecords\": [],\r\n \"data\": null,\r\n \"rpd\": null,\r\n \"pages\": 2,\r\n \"created\": \"2023-11-17T19:18:05.521Z\",\r\n \"modified\": \"2023-11-17T21:25:41.52Z\",\r\n \"rpdType\": \"Send\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"If you don't count with this value, please contact your RPost® representative./api/v1/docs/:ID","host":["If you don't count with this value, please contact your RPost® representative."],"path":["api","v1","docs",":ID"],"variable":[{"key":"ID","value":"739817945535AAEF9550D"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 29 Nov 2023 20:15:28 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=K54TKDjYy+cSjgne9kHFrWY4wd8jiqfFKeaA0LPsLART5amx1mV2lAnmLVaLplMe5paEPHST0yJB07NrFfywSG+wmLV6EY+cPKdkrWg1fVpfzBb7JRba2LXl4Uwr; Expires=Wed, 06 Dec 2023 20:15:28 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=K54TKDjYy+cSjgne9kHFrWY4wd8jiqfFKeaA0LPsLART5amx1mV2lAnmLVaLplMe5paEPHST0yJB07NrFfywSG+wmLV6EY+cPKdkrWg1fVpfzBb7JRba2LXl4Uwr; Expires=Wed, 06 Dec 2023 20:15:28 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f0d31969-05f4-4850-86a5-3cb42534a56f"},{"name":"Delete a RPD™ document","id":"209d757a-2ad5-42de-9dd5-24028733a848","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}],"advancedConfig":[{"key":"password","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"If you don't count with this value, please contact your RPost® representative./api/v1/docs/:Id/:Note","description":"

Description

This request allows to delete a RPD™ document based on the ID.

Note: After record/document deletion, the RPD™ HTML document will no longer be valid and can not be decrypted and accessed by anyone.

Request

Request Headers

Authorization: Bearer {token}

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter Name	Type	Description	Required?	Example
Id	String	Unique identifier of the RDocs™ RPD™ document (RPost® Protected Document).	Yes	180817445898FCEC6068FDFA
Note	String	String that indicates the reason for the RPD™ document deletion.	Yes	Deleting this RPD™ document since it's not longer required.

Response

Response Headers

No response headers

Response codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Message
200	Success. RPD™ document deleted.
401	Unauthorized.
404	RPD™ document not found.

Response Sample

{\n    \"errorMessage\": \"':ID' is not a valid 24 digit hex string.\"\n}\n\n

\n","urlObject":{"path":["api","v1","docs",":Id",":Note"],"host":["If you don't count with this value, please contact your RPost® representative."],"query":[],"variable":[{"description":{"content":"

Unique identifier of the RDocs™ RPD™ document (RPost® Protected Document).

\n","type":"text/plain"},"type":"any","value":"","key":"Id"},{"description":{"content":"

String that indicates the reason for the RPD™ document deletion.

\n","type":"text/plain"},"type":"any","value":"","key":"Note"}]}},"response":[{"id":"c1ac75b8-9219-46a1-85a5-1e8a138d43b0","name":"200 - RPD™ file deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https/If you don't count with this value, please contact your RPost® representative./api/v1/docs/:Id","host":["https"],"path":["If you don't count with this value, please contact your RPost® representative.","api","v1","docs",":Id"],"variable":[{"key":"Id","value":"123666674780AEBF6490BAFF"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Fri, 25 Aug 2023 20:45:22 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=bAMZ9j2HW5kcaannqXsz6AtsPJnprirozVc9nZpzH1FWruKC4MJbMwwxwoe24LmkDjRPkUB6greMY5b17o4xPRSbMJkjdrov7j7/QNmEHeJzAs1FuVHsdlTKo0ix; Expires=Fri, 01 Sep 2023 20:45:21 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=bAMZ9j2HW5kcaannqXsz6AtsPJnprirozVc9nZpzH1FWruKC4MJbMwwxwoe24LmkDjRPkUB6greMY5b17o4xPRSbMJkjdrov7j7/QNmEHeJzAs1FuVHsdlTKo0ix; Expires=Fri, 01 Sep 2023 20:45:21 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":""},{"id":"74123976-6e92-4fef-8ad0-135f5bb07934","name":"400 - RPD™ file not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://If you don't count with this value, please contact your RPost® representative./api/v1/docs/:Id","protocol":"https","host":["If you don't count with this value, please contact your RPost® representative."],"path":["api","v1","docs",":Id"],"variable":[{"key":"Id","value":"123666674780AEBF6490AAFB"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 25 Aug 2023 20:46:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=K3dDuEjnuyVfRH0Czl8bXcPPE6faG+xBvOxv4YD/FuF4yKtCw4BEVLDg+sVPgSep06+4gLkFWOazHZIyUTBL1bduP1T37U3le5mHlcPwL+wAjjCCV6TyYj7CciM3; Expires=Fri, 01 Sep 2023 20:46:42 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=K3dDuEjnuyVfRH0Czl8bXcPPE6faG+xBvOxv4YD/FuF4yKtCw4BEVLDg+sVPgSep06+4gLkFWOazHZIyUTBL1bduP1T37U3le5mHlcPwL+wAjjCCV6TyYj7CciM3; Expires=Fri, 01 Sep 2023 20:46:42 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"Object reference not set to an instance of an object.\"\n}"},{"id":"afbd0b31-6d21-4599-9269-024d8de52c71","name":"400 - Invalid Document Id","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://If you don't count with this value, please contact your RPost® representative./api/v1/docs/:Id","protocol":"https","host":["If you don't count with this value, please contact your RPost® representative."],"path":["api","v1","docs",":Id"],"variable":[{"key":"Id","value":"123666674780"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 25 Aug 2023 20:47:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=LvRxTOMQ3/WwpV7ha+LjVaQDnATo2Ht1mvwYXxwxOV06Fj6leA250fYyjVtUcpvynZ5wQ9k5PZNF9qj/c8zTt/V/RNnaB8LhQ6qdpIVb6434RCGr4wY9M2ity1Qp; Expires=Fri, 01 Sep 2023 20:47:16 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=LvRxTOMQ3/WwpV7ha+LjVaQDnATo2Ht1mvwYXxwxOV06Fj6leA250fYyjVtUcpvynZ5wQ9k5PZNF9qj/c8zTt/V/RNnaB8LhQ6qdpIVb6434RCGr4wY9M2ity1Qp; Expires=Fri, 01 Sep 2023 20:47:16 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"'123666674780' is not a valid 24 digit hex string.\"\n}"}],"_postman_id":"209d757a-2ad5-42de-9dd5-24028733a848"},{"name":"Add a new recipient to a RPD™ document","id":"3983aa2a-9d4a-4acf-8d84-cfacf54071ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"Insert here Document ID\",\r\n \"recipients\": [\r\n {\r\n \"email\": \"reader@domain.com\",\r\n \"firstName\": \"Insert here First Name\",\r\n \"lastName\": \"Insert here Last Name\",\r\n \"mobileCountryCode\": \"Insert here Country Code\",\r\n \"mobileNumber\": \"Insert here Mobile Number\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"rpostraptorai.com/api/v1/docs/addrecipient","description":"

Description

This request allows to add new recipients to a RDP™ document.

Can only be used on RPD™ documents with Security Level 3.

Request

Request Headers

Authorization: Bearer {token}

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter Name	Type	Description	Required?	Example
id	String	ID of the RPD™ document for which you want to add a recipient/reader.	Yes	273596698181ADBF7328EDBB
recipients.email	String	Email address of the reader to be added to the list of authorized readers of the RPD™ document.	Yes	recipient@domain.com
recipients.firstName	String	First name of the recipient.	No	John
recipients.lastName	String	Last name of the recipient.	No	Doe
recipients.mobileCountryCode	String	Country code of the recipient's mobile number. Possible values are: +54 (Argentina) +501 (Belize) +1 (Canada) +49 (Germany) +33 (France) +44 (United Kingdom) +91 (India) + 1 (United States)	No	+1
recipients.mobileNumber	String	Mobile number of the recipient. The passcode to access the RPD™ document is sent to this mobile number.	No	5551234567

Response

Response Headers

No response headers

Response Body

No response body

Response codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Message
200	Success. New authorized reader added.
400	Bad request.
401	Unauthorized.

","urlObject":{"path":["api","v1","docs","addrecipient"],"host":["rpostraptorai","com"],"query":[],"variable":[]}},"response":[{"id":"f9c7b815-b4b9-48a1-a97d-27494a51b59d","name":"200 - OK","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"039302760532BDAB8403FAAB\",\r\n \"recipients\": [\r\n {\r\n \"email\": \"recipient2@domain.com\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"If you don't count with this value, please contact your RPost® representative./api/v1/docs/addrecipient"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 18 Oct 2023 16:37:17 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=UVTDKDCpxtqZ828G7TWZR+TZgruLT+XUqSq4g2DekDfBphK4iaqw2gaQ237DHSwi9PZVSOknSzWui8+BVTiGujNObCLL2HZ/PEB/oezNN4oDoynafnHx31jDD+G3; Expires=Wed, 25 Oct 2023 16:37:17 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=UVTDKDCpxtqZ828G7TWZR+TZgruLT+XUqSq4g2DekDfBphK4iaqw2gaQ237DHSwi9PZVSOknSzWui8+BVTiGujNObCLL2HZ/PEB/oezNN4oDoynafnHx31jDD+G3; Expires=Wed, 25 Oct 2023 16:37:17 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":null},{"id":"a4b83558-c65d-406b-a2e2-a4802abce889","name":"400 - RPD™ not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"27359669818EB\",\r\n \"recipients\": [\r\n {\r\n \"email\": \"recipient2@domain.com\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"If you don't count with this value, please contact your RPost® representative./api/v1/docs/addrecipient"},"status":"Bad Request","code":400,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 18 Oct 2023 16:48:51 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=eMJDiJdkadLgvfVZUY146qf0nHpYCDpuwnEz/stWGfuO/qrZ8b+QM3LFruuNPx9I2s2pAj/0r2XomUFiTK4+dlm1MFF2F7FAkI2+C+Ucr7EKTCU2rCLnC/4WWYFo; Expires=Wed, 25 Oct 2023 16:48:51 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=eMJDiJdkadLgvfVZUY146qf0nHpYCDpuwnEz/stWGfuO/qrZ8b+QM3LFruuNPx9I2s2pAj/0r2XomUFiTK4+dlm1MFF2F7FAkI2+C+Ucr7EKTCU2rCLnC/4WWYFo; Expires=Wed, 25 Oct 2023 16:48:51 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":null},{"id":"eba1eaa4-1635-4e38-aa2b-9859acbbdbc7","name":"400 - Not applicable for this Security Level","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"273596698181ADBF7328EDBB\",\r\n \"recipients\": [\r\n {\r\n \"email\": \"recipient2@domain.com\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"If you don't count with this value, please contact your RPost® representative./api/v1/docs/addrecipient"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 18 Oct 2023 16:51:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=Kavhuw2INQdiaEf3L4Vkx0dVbT/DHkJmwjgSojUXEGal0vpKdleSg6YGazHGImHTTKWzqbRDzrTJPctrH16SS8Cgop2EDx5zRMpux/ATuL3IB1Pdkkkyifo+lCdh; Expires=Wed, 25 Oct 2023 16:51:30 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=Kavhuw2INQdiaEf3L4Vkx0dVbT/DHkJmwjgSojUXEGal0vpKdleSg6YGazHGImHTTKWzqbRDzrTJPctrH16SS8Cgop2EDx5zRMpux/ATuL3IB1Pdkkkyifo+lCdh; Expires=Wed, 25 Oct 2023 16:51:30 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"Not applicable for Level 1.\"\n}"}],"_postman_id":"3983aa2a-9d4a-4acf-8d84-cfacf54071ad"}],"id":"fcce8d15-1118-4407-a4a2-5c7e8c7e9416","description":"

The docs resource is used for managing documents using RDocs™ functionalities.

\n","_postman_id":"fcce8d15-1118-4407-a4a2-5c7e8c7e9416"}],"id":"1f37a38f-3883-49fe-a334-2eeb3dad49ab","description":"

The present folder allows users to review each resource and parameter within the RDocs™ API.

API Usage

RDocs™ provides the following resources:

Authentication
Documents
Images

\n","_postman_id":"1f37a38f-3883-49fe-a334-2eeb3dad49ab"}],"event":[{"listen":"prerequest","script":{"id":"281a8316-2d4e-4e58-9860-89cfa93e8a00","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"1a1a894f-5804-4eb7-9d9c-a358efb448fe","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"base_url","value":"If you don't count with this value, please contact your RPost® representative."},{"key":"urlAuthentication","value":""},{"key":"username","value":"Register at https://rpostdocs.io/"},{"key":"password","value":"Register at https://rpostdocs.io/"},{"key":"token","value":""},{"key":"sample_object","value":""},{"key":"refreshToken","value":""},{"key":"accessToken","value":""},{"key":"clientID","value":"If you don't count with this value, please contact your RPost® representative."}]}