API Documentation
Envelope ¶
Overview
All the above helps us to generate a PDF File. But the PDF files are legal documents. And therefore, must be signed. Rechat helps brokers to collect necessary signatures for a generated PDF File.
In order to do this, Rechat connects to a third party service called Docusign.
Docusign is a well-known service that allows anyone to collect signatures for legal documents. Most brokers already have Docusign accounts.
Therefore, in order for Rechat to be able to do anything in this section, the user would have to authenticate with his Docusign credentials.
An Envelope is a collection of PDF Files which have been sent to be signed.
So an envelope has the following attributes:
-
title(String) The title of the envelope which will appear in recipients’ email subject -
status(Enum) Which can be:Sent,Delivered,Completed,Declined,Voided -
recipients(Array) An array ofEnvelopeRecipient, each one including information about a recipient and his signature -
documents(Array) An array ofEnvelopeDocument, each one including information about a document that we’ve tried to collect signatures fo
Authentication
Any of the endpoints in below might return HTTP 412. That would mean we do not have authentication for this user
on Docusign or the Tokens we have for this user have been expired.
As a result of this, the authentication process described below must be restarted. If successful, the original action must be tried again.
The process of authenticating a user is as follows:
-
User’s browser will be opened to
/users/self/docusign/auth -
User’s browser will be redirected to Docusign
-
User logs in and authorizes Rechat
-
User’s browser will be redirected back to Rechat
-
Control is given back to client (either using Browser’s
postMessagemechanism or redirecting him torechat://on phones) -
Client tries again the initial action
Create a new Envelope without authentication ¶
Create a new Envelope without authenticationPOST/envelopes
In this example user has no Docusign authentication. Therefore will receicve a 412 error.
Example URI
POST /envelopes
Request
Body
{
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"title": "This envelope is sent automatically from our test suite",
"documents": [
{
"revision": null,
"task": "9b62e4e8-89f3-4932-858d-d5978241d990"
}
],
"recipients": [
{
"role": "e683276a-a72b-46d9-bb0c-2e8f808609f8",
"envelope_recipient_type": "Signer"
},
{
"role": "ee5a4cf9-bc5a-40ca-879c-9a1b45c46913",
"envelope_recipient_type": "CarbonCopy"
}
],
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"owner": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}Response
412Body
{
"trace": true,
"http": 412,
"message": "Invalid docusign authorization",
"code": "DocusignAuthenticationRequired",
"slack": false
}Start authentication ¶
Create Envelope ¶
Create EnvelopePOST/envelopes
Example URI
POST /envelopes
Request
Body
{
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"title": "This envelope is sent automatically from our test suite",
"documents": [
{
"revision": null,
"task": "9b62e4e8-89f3-4932-858d-d5978241d990"
}
],
"recipients": [
{
"role": "e683276a-a72b-46d9-bb0c-2e8f808609f8",
"envelope_recipient_type": "Signer"
},
{
"role": "ee5a4cf9-bc5a-40ca-879c-9a1b45c46913",
"envelope_recipient_type": "CarbonCopy"
},
{
"role": "e683276a-a72b-46d9-bb0c-2e8f808609f8",
"envelope_recipient_type": "Signer"
},
{
"role": "ee5a4cf9-bc5a-40ca-879c-9a1b45c46913",
"envelope_recipient_type": "CarbonCopy"
}
],
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"owner": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}Response
200Body
{
"code": "OK",
"data": {
"id": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"created_at": 1760470029.623944,
"updated_at": 1760470030.761903,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"docusign_id": "0bd9ee91-0146-4268-8230-f8f4094935b5",
"status": "Sent",
"title": "This envelope is sent automatically from our test suite",
"webhook_token": "c70a1b4e-a933-11f0-9403-f6bc7f79063b",
"auto_notify": true,
"owner": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"type": "envelope",
"recipients": [
{
"id": "a497b95e-f534-4f11-9891-39cc85ea553b",
"created_at": 1760470029.634438,
"updated_at": 1760470029.634438,
"signed_at": null,
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"status": "Created",
"role": {
"id": "e683276a-a72b-46d9-bb0c-2e8f808609f8",
"created_at": 1760470029.042009,
"updated_at": 1760470029.042009,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760470027.362956,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"current_time": "2:27 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "29895fb2-5ca7-4ae1-ba9e-5c0d8d82f8ec",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760470027.478587,
"deleted_at": null,
"created_at": 1760470027.478587,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "6cd9b5ef-8cd8-408c-a48c-d474961d52b7",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Wile",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':1 'coyot':4 'e':3 '[email protected]':5 'wile':2",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Wile E. Coyote"
},
"order": 1,
"envelope_recipient_type": "Signer",
"type": "envelope_recipient"
},
{
"id": "e393d5b8-47db-4511-ad57-5807d6ce0df5",
"created_at": 1760470029.635589,
"updated_at": 1760470029.635589,
"signed_at": null,
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"status": "Created",
"role": {
"id": "ee5a4cf9-bc5a-40ca-879c-9a1b45c46913",
"created_at": 1760470029.049155,
"updated_at": 1760470029.049155,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760470027.362956,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"current_time": "2:27 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "29895fb2-5ca7-4ae1-ba9e-5c0d8d82f8ec",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760470027.478587,
"deleted_at": null,
"created_at": 1760470027.478587,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "6cd9b5ef-8cd8-408c-a48c-d474961d52b7",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
},
"order": 1,
"envelope_recipient_type": "CarbonCopy",
"type": "envelope_recipient"
},
{
"id": "96284e14-f199-4e31-a6a3-cb8895812c8a",
"created_at": 1760470029.636235,
"updated_at": 1760470029.636235,
"signed_at": null,
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"status": "Created",
"role": {
"id": "e683276a-a72b-46d9-bb0c-2e8f808609f8",
"created_at": 1760470029.042009,
"updated_at": 1760470029.042009,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760470027.362956,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"current_time": "2:27 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "29895fb2-5ca7-4ae1-ba9e-5c0d8d82f8ec",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760470027.478587,
"deleted_at": null,
"created_at": 1760470027.478587,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "6cd9b5ef-8cd8-408c-a48c-d474961d52b7",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Wile",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':1 'coyot':4 'e':3 '[email protected]':5 'wile':2",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Wile E. Coyote"
},
"order": 1,
"envelope_recipient_type": "Signer",
"type": "envelope_recipient"
},
{
"id": "8e5f020c-565e-49bf-a200-d7a6190a11a8",
"created_at": 1760470029.636863,
"updated_at": 1760470029.636863,
"signed_at": null,
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"status": "Created",
"role": {
"id": "ee5a4cf9-bc5a-40ca-879c-9a1b45c46913",
"created_at": 1760470029.049155,
"updated_at": 1760470029.049155,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760470027.362956,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"current_time": "2:27 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "29895fb2-5ca7-4ae1-ba9e-5c0d8d82f8ec",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760470027.478587,
"deleted_at": null,
"created_at": 1760470027.478587,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "6cd9b5ef-8cd8-408c-a48c-d474961d52b7",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
},
"order": 1,
"envelope_recipient_type": "CarbonCopy",
"type": "envelope_recipient"
}
],
"documents": [
{
"id": "4c9b2294-862c-4e05-a51d-0f9bd7ef424f",
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"title": "Addendum for Back-Up Contract.pdf",
"document_id": 1,
"submission_revision": "afe2d55f-4bef-4853-9df1-4c4721633c01",
"file": null,
"task": "9b62e4e8-89f3-4932-858d-d5978241d990",
"submission": "e16d4758-79c1-48ef-928f-edd2e22bc84a",
"type": "envelope_document",
"pdf": {
"id": "f566e05e-22e7-44f9-ae1b-e18ef3c1ab30",
"created_at": 1760470030.79823,
"updated_at": 1760470030.79823,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4/c7bca2a0-a933-11f0-bdea-d5cf17ea076e.pdf",
"name": "Addendum for Back-Up Contract.pdf.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/6846afa3-2ff4-4bde-92d0-2ad60eb042c4/c7bca2a0-a933-11f0-bdea-d5cf17ea076e.pdf?Expires=1760556430802&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=UdGgX7GQeE4bEJrQmT86StvcNmA8DgXjMiU19Ukr5jGL6ZdDVw0-dtS~c0rfWAkB8Nn76mhl5Yi4BE3662M563SlqudZCCtUnG~bMA~tin3dCM7cXz4A5UFoi~KUKi2Yfs1ujLTW9gwvfq3~nVNjbbApm8erRq2aHl04Bbn4ouJu3PmYYdUnY6ZKyQHYcCGM6fNJ-550~i~MI0JFt-6X612srhOrTdJz042GzvbUL~B-WWcNNijWvg28q0~g-j4DqGr3R18H3JLv28VuaY4zUAPZR-P4GS7Dsx02MBFCYV-WTVbKPgot-aMKXu26OphtHz~ocPeWwBCe5CFtJCWSCQ__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
}
}
]
}
}Get Envelope ¶
Get EnvelopeGET/envelopes/:id
Example URI
GET /envelopes/:id
URI Parameters
- id
string(required) Example: 9544afa4-addc-451a-97fc-58a9ef3bf9d5
Response
200Body
{
"code": "OK",
"data": {
"id": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"created_at": 1760470029.623944,
"updated_at": 1760470030.761903,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"docusign_id": "0bd9ee91-0146-4268-8230-f8f4094935b5",
"status": "Sent",
"title": "This envelope is sent automatically from our test suite",
"webhook_token": "c70a1b4e-a933-11f0-9403-f6bc7f79063b",
"auto_notify": true,
"owner": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"type": "envelope",
"recipients": [
{
"id": "a497b95e-f534-4f11-9891-39cc85ea553b",
"created_at": 1760470029.634438,
"updated_at": 1760470029.634438,
"signed_at": null,
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"status": "Created",
"role": {
"id": "e683276a-a72b-46d9-bb0c-2e8f808609f8",
"created_at": 1760470029.042009,
"updated_at": 1760470029.042009,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760470027.362956,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"current_time": "2:27 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "29895fb2-5ca7-4ae1-ba9e-5c0d8d82f8ec",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760470027.478587,
"deleted_at": null,
"created_at": 1760470027.478587,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "6cd9b5ef-8cd8-408c-a48c-d474961d52b7",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Wile",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':1 'coyot':4 'e':3 '[email protected]':5 'wile':2",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Wile E. Coyote"
},
"order": 1,
"envelope_recipient_type": "Signer",
"type": "envelope_recipient"
},
{
"id": "e393d5b8-47db-4511-ad57-5807d6ce0df5",
"created_at": 1760470029.635589,
"updated_at": 1760470029.635589,
"signed_at": null,
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"status": "Created",
"role": {
"id": "ee5a4cf9-bc5a-40ca-879c-9a1b45c46913",
"created_at": 1760470029.049155,
"updated_at": 1760470029.049155,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760470027.362956,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"current_time": "2:27 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "29895fb2-5ca7-4ae1-ba9e-5c0d8d82f8ec",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760470027.478587,
"deleted_at": null,
"created_at": 1760470027.478587,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "6cd9b5ef-8cd8-408c-a48c-d474961d52b7",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
},
"order": 1,
"envelope_recipient_type": "CarbonCopy",
"type": "envelope_recipient"
},
{
"id": "96284e14-f199-4e31-a6a3-cb8895812c8a",
"created_at": 1760470029.636235,
"updated_at": 1760470029.636235,
"signed_at": null,
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"status": "Created",
"role": {
"id": "e683276a-a72b-46d9-bb0c-2e8f808609f8",
"created_at": 1760470029.042009,
"updated_at": 1760470029.042009,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760470027.362956,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"current_time": "2:27 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "29895fb2-5ca7-4ae1-ba9e-5c0d8d82f8ec",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760470027.478587,
"deleted_at": null,
"created_at": 1760470027.478587,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "6cd9b5ef-8cd8-408c-a48c-d474961d52b7",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Wile",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':1 'coyot':4 'e':3 '[email protected]':5 'wile':2",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Wile E. Coyote"
},
"order": 1,
"envelope_recipient_type": "Signer",
"type": "envelope_recipient"
},
{
"id": "8e5f020c-565e-49bf-a200-d7a6190a11a8",
"created_at": 1760470029.636863,
"updated_at": 1760470029.636863,
"signed_at": null,
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"status": "Created",
"role": {
"id": "ee5a4cf9-bc5a-40ca-879c-9a1b45c46913",
"created_at": 1760470029.049155,
"updated_at": 1760470029.049155,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760470027.362956,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"current_time": "2:27 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "29895fb2-5ca7-4ae1-ba9e-5c0d8d82f8ec",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760470027.478587,
"deleted_at": null,
"created_at": 1760470027.478587,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "6cd9b5ef-8cd8-408c-a48c-d474961d52b7",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
},
"order": 1,
"envelope_recipient_type": "CarbonCopy",
"type": "envelope_recipient"
}
],
"documents": [
{
"id": "4c9b2294-862c-4e05-a51d-0f9bd7ef424f",
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"title": "Addendum for Back-Up Contract.pdf",
"document_id": 1,
"submission_revision": "afe2d55f-4bef-4853-9df1-4c4721633c01",
"file": null,
"task": "9b62e4e8-89f3-4932-858d-d5978241d990",
"submission": "e16d4758-79c1-48ef-928f-edd2e22bc84a",
"type": "envelope_document",
"pdf": {
"id": "f566e05e-22e7-44f9-ae1b-e18ef3c1ab30",
"created_at": 1760470030.79823,
"updated_at": 1760470030.79823,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4/c7bca2a0-a933-11f0-bdea-d5cf17ea076e.pdf",
"name": "Addendum for Back-Up Contract.pdf.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/6846afa3-2ff4-4bde-92d0-2ad60eb042c4/c7bca2a0-a933-11f0-bdea-d5cf17ea076e.pdf?Expires=1760556430802&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=UdGgX7GQeE4bEJrQmT86StvcNmA8DgXjMiU19Ukr5jGL6ZdDVw0-dtS~c0rfWAkB8Nn76mhl5Yi4BE3662M563SlqudZCCtUnG~bMA~tin3dCM7cXz4A5UFoi~KUKi2Yfs1ujLTW9gwvfq3~nVNjbbApm8erRq2aHl04Bbn4ouJu3PmYYdUnY6ZKyQHYcCGM6fNJ-550~i~MI0JFt-6X612srhOrTdJz042GzvbUL~B-WWcNNijWvg28q0~g-j4DqGr3R18H3JLv28VuaY4zUAPZR-P4GS7Dsx02MBFCYV-WTVbKPgot-aMKXu26OphtHz~ocPeWwBCe5CFtJCWSCQ__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
}
}
]
}
}Get Envelopes of a deal ¶
Get Envelopes of a dealGET/deals/:deal/envelopes
Example URI
GET /deals/:deal/envelopes
URI Parameters
- deal
string(required) Example: 6846afa3-2ff4-4bde-92d0-2ad60eb042c4
Response
200Body
{
"code": "OK",
"data": [
{
"id": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"created_at": 1760470029.623944,
"updated_at": 1760470030.761903,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"docusign_id": "0bd9ee91-0146-4268-8230-f8f4094935b5",
"status": "Sent",
"title": "This envelope is sent automatically from our test suite",
"webhook_token": "c70a1b4e-a933-11f0-9403-f6bc7f79063b",
"auto_notify": true,
"owner": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"type": "envelope",
"recipients": [
{
"id": "a497b95e-f534-4f11-9891-39cc85ea553b",
"created_at": 1760470029.634438,
"updated_at": 1760470029.634438,
"signed_at": null,
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"status": "Created",
"role": {
"id": "e683276a-a72b-46d9-bb0c-2e8f808609f8",
"created_at": 1760470029.042009,
"updated_at": 1760470029.042009,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760470027.362956,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"current_time": "2:27 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "29895fb2-5ca7-4ae1-ba9e-5c0d8d82f8ec",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760470027.478587,
"deleted_at": null,
"created_at": 1760470027.478587,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "6cd9b5ef-8cd8-408c-a48c-d474961d52b7",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Wile",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':1 'coyot':4 'e':3 '[email protected]':5 'wile':2",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Wile E. Coyote"
},
"order": 1,
"envelope_recipient_type": "Signer",
"type": "envelope_recipient"
},
{
"id": "e393d5b8-47db-4511-ad57-5807d6ce0df5",
"created_at": 1760470029.635589,
"updated_at": 1760470029.635589,
"signed_at": null,
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"status": "Created",
"role": {
"id": "ee5a4cf9-bc5a-40ca-879c-9a1b45c46913",
"created_at": 1760470029.049155,
"updated_at": 1760470029.049155,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760470027.362956,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"current_time": "2:27 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "29895fb2-5ca7-4ae1-ba9e-5c0d8d82f8ec",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760470027.478587,
"deleted_at": null,
"created_at": 1760470027.478587,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "6cd9b5ef-8cd8-408c-a48c-d474961d52b7",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
},
"order": 1,
"envelope_recipient_type": "CarbonCopy",
"type": "envelope_recipient"
},
{
"id": "96284e14-f199-4e31-a6a3-cb8895812c8a",
"created_at": 1760470029.636235,
"updated_at": 1760470029.636235,
"signed_at": null,
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"status": "Created",
"role": {
"id": "e683276a-a72b-46d9-bb0c-2e8f808609f8",
"created_at": 1760470029.042009,
"updated_at": 1760470029.042009,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760470027.362956,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"current_time": "2:27 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "29895fb2-5ca7-4ae1-ba9e-5c0d8d82f8ec",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760470027.478587,
"deleted_at": null,
"created_at": 1760470027.478587,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "6cd9b5ef-8cd8-408c-a48c-d474961d52b7",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Wile",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':1 'coyot':4 'e':3 '[email protected]':5 'wile':2",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Wile E. Coyote"
},
"order": 1,
"envelope_recipient_type": "Signer",
"type": "envelope_recipient"
},
{
"id": "8e5f020c-565e-49bf-a200-d7a6190a11a8",
"created_at": 1760470029.636863,
"updated_at": 1760470029.636863,
"signed_at": null,
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"status": "Created",
"role": {
"id": "ee5a4cf9-bc5a-40ca-879c-9a1b45c46913",
"created_at": 1760470029.049155,
"updated_at": 1760470029.049155,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760470027.362956,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"current_time": "2:27 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "29895fb2-5ca7-4ae1-ba9e-5c0d8d82f8ec",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760470027.478587,
"deleted_at": null,
"created_at": 1760470027.478587,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "6cd9b5ef-8cd8-408c-a48c-d474961d52b7",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
},
"order": 1,
"envelope_recipient_type": "CarbonCopy",
"type": "envelope_recipient"
}
],
"documents": [
{
"id": "4c9b2294-862c-4e05-a51d-0f9bd7ef424f",
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"title": "Addendum for Back-Up Contract.pdf",
"document_id": 1,
"submission_revision": "afe2d55f-4bef-4853-9df1-4c4721633c01",
"file": null,
"task": "9b62e4e8-89f3-4932-858d-d5978241d990",
"submission": "e16d4758-79c1-48ef-928f-edd2e22bc84a",
"type": "envelope_document",
"pdf": {
"id": "f566e05e-22e7-44f9-ae1b-e18ef3c1ab30",
"created_at": 1760470030.79823,
"updated_at": 1760470030.79823,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4/c7bca2a0-a933-11f0-bdea-d5cf17ea076e.pdf",
"name": "Addendum for Back-Up Contract.pdf.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/6846afa3-2ff4-4bde-92d0-2ad60eb042c4/c7bca2a0-a933-11f0-bdea-d5cf17ea076e.pdf?Expires=1760556430802&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=UdGgX7GQeE4bEJrQmT86StvcNmA8DgXjMiU19Ukr5jGL6ZdDVw0-dtS~c0rfWAkB8Nn76mhl5Yi4BE3662M563SlqudZCCtUnG~bMA~tin3dCM7cXz4A5UFoi~KUKi2Yfs1ujLTW9gwvfq3~nVNjbbApm8erRq2aHl04Bbn4ouJu3PmYYdUnY6ZKyQHYcCGM6fNJ-550~i~MI0JFt-6X612srhOrTdJz042GzvbUL~B-WWcNNijWvg28q0~g-j4DqGr3R18H3JLv28VuaY4zUAPZR-P4GS7Dsx02MBFCYV-WTVbKPgot-aMKXu26OphtHz~ocPeWwBCe5CFtJCWSCQ__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
}
}
]
}
],
"info": {
"count": 1,
"total": 0
}
}Sign an Envelope ¶
Sign an EnvelopeGET/envelopes/:id:/sign/:recipient
If the current user is among envelope.recipients, it means he should be able to sign it as well.
The process of signing is as follows:
-
User’s browser will be opened to
/envelopes/:id/sign/:recipient -
User’s browser will be redirected to a page on Docusign where he can sign the document
-
User’s browser will be sent back to Rechat
-
Rechat updates the Envelope information
-
Control is given back to client (either using Browser’s
postMessagemechanism or redirecting him torechat://on phones) -
Client updates the envelope information
Example URI
GET /envelopes/:id:/sign/:recipient
Void an Envelope ¶
Void an EnvelopePATCH/envelopes/:id:/status
If for any reason (for example presence of an error in the legal documents) the agent decides that the envelope must not be legally binded, he can Void (Cancel) it.
If any of the recipients Voids the contract, that means he refuses to sign it. The envelope in question and all of its documents will not be legally binded and nobody can sign it anymore.
Example URI
PATCH /envelopes/:id:/status
URI Parameters
- id
string(required) Example: 9544afa4-addc-451a-97fc-58a9ef3bf9d5
Request
Body
{
"status": "Voided"
}Response
200Body
{
"code": "OK",
"data": {
"id": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"created_at": 1760470029.623944,
"updated_at": 1760470031.284489,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"docusign_id": "0bd9ee91-0146-4268-8230-f8f4094935b5",
"status": "Voided",
"title": "This envelope is sent automatically from our test suite",
"webhook_token": "c70a1b4e-a933-11f0-9403-f6bc7f79063b",
"auto_notify": true,
"owner": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"type": "envelope",
"recipients": [
{
"id": "a497b95e-f534-4f11-9891-39cc85ea553b",
"created_at": 1760470029.634438,
"updated_at": 1760470029.634438,
"signed_at": null,
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"status": "Created",
"role": {
"id": "e683276a-a72b-46d9-bb0c-2e8f808609f8",
"created_at": 1760470029.042009,
"updated_at": 1760470029.042009,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760470027.362956,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"current_time": "2:27 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "29895fb2-5ca7-4ae1-ba9e-5c0d8d82f8ec",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760470027.478587,
"deleted_at": null,
"created_at": 1760470027.478587,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "6cd9b5ef-8cd8-408c-a48c-d474961d52b7",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Wile",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':1 'coyot':4 'e':3 '[email protected]':5 'wile':2",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Wile E. Coyote"
},
"order": 1,
"envelope_recipient_type": "Signer",
"type": "envelope_recipient"
},
{
"id": "e393d5b8-47db-4511-ad57-5807d6ce0df5",
"created_at": 1760470029.635589,
"updated_at": 1760470029.635589,
"signed_at": null,
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"status": "Created",
"role": {
"id": "ee5a4cf9-bc5a-40ca-879c-9a1b45c46913",
"created_at": 1760470029.049155,
"updated_at": 1760470029.049155,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760470027.362956,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"current_time": "2:27 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "29895fb2-5ca7-4ae1-ba9e-5c0d8d82f8ec",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760470027.478587,
"deleted_at": null,
"created_at": 1760470027.478587,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "6cd9b5ef-8cd8-408c-a48c-d474961d52b7",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
},
"order": 1,
"envelope_recipient_type": "CarbonCopy",
"type": "envelope_recipient"
},
{
"id": "96284e14-f199-4e31-a6a3-cb8895812c8a",
"created_at": 1760470029.636235,
"updated_at": 1760470029.636235,
"signed_at": null,
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"status": "Created",
"role": {
"id": "e683276a-a72b-46d9-bb0c-2e8f808609f8",
"created_at": 1760470029.042009,
"updated_at": 1760470029.042009,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "BuyerAgent",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760470027.362956,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"current_time": "2:27 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "29895fb2-5ca7-4ae1-ba9e-5c0d8d82f8ec",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760470027.478587,
"deleted_at": null,
"created_at": 1760470027.478587,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "6cd9b5ef-8cd8-408c-a48c-d474961d52b7",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": null,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Wile",
"legal_middle_name": "E.",
"legal_last_name": "Coyote",
"company_title": "ACME",
"commission_percentage": 3,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": {
"city": "Los Angeles",
"full": "11687 Bellagio Rd, Los Angeles CA 90049",
"name": "Bellagio",
"type": "stdaddr",
"line1": "11687 Bellagio Rd",
"line2": "Los Angeles CA 90049",
"state": "CA",
"country": "USA",
"suftype": "Rd",
"postcode": "90049",
"house_num": "11687"
},
"searchable": "'acm':1 'coyot':4 'e':3 '[email protected]':5 'wile':2",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Wile E. Coyote"
},
"order": 1,
"envelope_recipient_type": "Signer",
"type": "envelope_recipient"
},
{
"id": "8e5f020c-565e-49bf-a200-d7a6190a11a8",
"created_at": 1760470029.636863,
"updated_at": 1760470029.636863,
"signed_at": null,
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"status": "Created",
"role": {
"id": "ee5a4cf9-bc5a-40ca-879c-9a1b45c46913",
"created_at": 1760470029.049155,
"updated_at": 1760470029.049155,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"role": "SellerAgent",
"deal": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4",
"user": {
"type": "user",
"username": null,
"first_name": "Unit",
"last_name": "Test",
"email": "[email protected]",
"phone_number": "+4368120265807",
"created_at": 1493115498.770362,
"id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"address_id": null,
"cover_image_url": null,
"profile_image_url": null,
"updated_at": 1760470027.362956,
"user_status": "Active",
"profile_image_thumbnail_url": null,
"cover_image_thumbnail_url": null,
"email_confirmed": true,
"timezone": "America/Chicago",
"user_type": "Agent",
"deleted_at": null,
"phone_confirmed": false,
"is_shadow": false,
"personal_room": null,
"brand": null,
"fake_email": false,
"features": [
"Deals"
],
"last_seen_at": null,
"email_signature": null,
"daily_enabled": true,
"email_quota": 30000,
"website": null,
"instagram": null,
"twitter": null,
"linkedin": null,
"youtube": null,
"facebook": null,
"designation": null,
"tiktok": null,
"mfa_enabled": false,
"xpressdocs_user_id": null,
"current_time": "2:27 PM - Tuesday Oct 14, 2025",
"push_allowed": true,
"agents": [
{
"id": "29895fb2-5ca7-4ae1-ba9e-5c0d8d82f8ec",
"email": "[email protected]",
"mlsid": "00920130",
"fax": "(972) 264-4703",
"full_name": "Gholi Sweet",
"first_name": "Gholi",
"last_name": "Sweet",
"middle_name": null,
"phone_number": "(972) 264-4703",
"nar_number": "797500044",
"office_mui": "15512742",
"status": "Active",
"office_mlsid": "RCHT01X",
"work_phone": "(469) 358-8080",
"generational_name": null,
"matrix_unique_id": "155155530",
"updated_at": 1760470027.478587,
"deleted_at": null,
"created_at": 1760470027.478587,
"mls": "NTREIS",
"license_number": null,
"designation": null,
"nrds": "01053140",
"type": "agent",
"office_id": null,
"secret_questions": [
"(972) XXX-XX03",
"jewellxxxxxxxxxxxxxal.net",
"(469) XXX-XX80"
]
}
],
"last_seen_type": null,
"active_brand": "6cd9b5ef-8cd8-408c-a48c-d474961d52b7",
"display_name": "Unit Test",
"abbreviated_display_name": "Unit",
"online_state": "Offline",
"has_password": true
},
"commission_dollar": 20000,
"brokerwolf_id": null,
"brokerwolf_row_version": null,
"legal_prefix": null,
"legal_first_name": "Imaginary",
"legal_middle_name": null,
"legal_last_name": "Agent",
"company_title": null,
"commission_percentage": null,
"email": "[email protected]",
"phone_number": null,
"checklist": null,
"role_type": "Person",
"agent": null,
"old_current_address": null,
"old_future_address": null,
"office_name": null,
"office_email": null,
"office_phone": null,
"office_fax": null,
"office_license_number": null,
"office_mls_id": null,
"office_address": null,
"searchable": "'agent':2 'imaginari':1 '[email protected]':3",
"current_address": null,
"future_address": null,
"type": "deal_role",
"mlsid": null,
"legal_full_name": "Imaginary Agent"
},
"order": 1,
"envelope_recipient_type": "CarbonCopy",
"type": "envelope_recipient"
}
],
"documents": [
{
"id": "4c9b2294-862c-4e05-a51d-0f9bd7ef424f",
"envelope": "9544afa4-addc-451a-97fc-58a9ef3bf9d5",
"title": "Addendum for Back-Up Contract.pdf",
"document_id": 1,
"submission_revision": "afe2d55f-4bef-4853-9df1-4c4721633c01",
"file": null,
"task": "9b62e4e8-89f3-4932-858d-d5978241d990",
"submission": "e16d4758-79c1-48ef-928f-edd2e22bc84a",
"type": "envelope_document",
"pdf": {
"id": "f566e05e-22e7-44f9-ae1b-e18ef3c1ab30",
"created_at": 1760470030.79823,
"updated_at": 1760470030.79823,
"deleted_at": null,
"created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"path": "6846afa3-2ff4-4bde-92d0-2ad60eb042c4/c7bca2a0-a933-11f0-bdea-d5cf17ea076e.pdf",
"name": "Addendum for Back-Up Contract.pdf.pdf",
"public": false,
"type": "file",
"url": "https://private-cdn.irish.rechat.com/6846afa3-2ff4-4bde-92d0-2ad60eb042c4/c7bca2a0-a933-11f0-bdea-d5cf17ea076e.pdf?Expires=1760556430802&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=UdGgX7GQeE4bEJrQmT86StvcNmA8DgXjMiU19Ukr5jGL6ZdDVw0-dtS~c0rfWAkB8Nn76mhl5Yi4BE3662M563SlqudZCCtUnG~bMA~tin3dCM7cXz4A5UFoi~KUKi2Yfs1ujLTW9gwvfq3~nVNjbbApm8erRq2aHl04Bbn4ouJu3PmYYdUnY6ZKyQHYcCGM6fNJ-550~i~MI0JFt-6X612srhOrTdJz042GzvbUL~B-WWcNNijWvg28q0~g-j4DqGr3R18H3JLv28VuaY4zUAPZR-P4GS7Dsx02MBFCYV-WTVbKPgot-aMKXu26OphtHz~ocPeWwBCe5CFtJCWSCQ__",
"preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
"mime": "application/pdf"
}
}
]
}
}