Back to top

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 of EnvelopeRecipient, each one including information about a recipient and his signature

  • documents (Array) An array of EnvelopeDocument, 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:

  1. User’s browser will be opened to /users/self/docusign/auth

  2. User’s browser will be redirected to Docusign

  3. User logs in and authorizes Rechat

  4. User’s browser will be redirected back to Rechat

  5. Control is given back to client (either using Browser’s postMessage mechanism or redirecting him to rechat:// on phones)

  6. Client tries again the initial action

Create a new Envelope without authentication

Create a new Envelope without authentication
POST/envelopes

In this example user has no Docusign authentication. Therefore will receicve a 412 error.

Example URI

POST /envelopes
Request
HideShow
Body
{
  "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
  "title": "This envelope is sent automatically from our test suite",
  "documents": [
    {
      "revision": null,
      "task": "9c5649b3-83b4-492d-9a2e-1fcee9239424"
    }
  ],
  "recipients": [
    {
      "role": "fbae7896-1055-4747-b7bd-9329d67eee8b",
      "envelope_recipient_type": "Signer"
    },
    {
      "role": "b21b49db-76b0-412d-bf9e-43d7bd3c4bb9",
      "envelope_recipient_type": "CarbonCopy"
    }
  ],
  "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
  "owner": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}
Response  412
HideShow
Body
{
  "trace": true,
  "http": 412,
  "message": "Invalid docusign authorization",
  "code": "DocusignAuthenticationRequired",
  "slack": false
}

Start authentication

Start authentication
GET/users/self/docusign/auth

Example URI

GET /users/self/docusign/auth

Create Envelope

Create Envelope
POST/envelopes

Example URI

POST /envelopes
Request
HideShow
Body
{
  "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
  "title": "This envelope is sent automatically from our test suite",
  "documents": [
    {
      "revision": null,
      "task": "9c5649b3-83b4-492d-9a2e-1fcee9239424"
    }
  ],
  "recipients": [
    {
      "role": "fbae7896-1055-4747-b7bd-9329d67eee8b",
      "envelope_recipient_type": "Signer"
    },
    {
      "role": "b21b49db-76b0-412d-bf9e-43d7bd3c4bb9",
      "envelope_recipient_type": "CarbonCopy"
    },
    {
      "role": "fbae7896-1055-4747-b7bd-9329d67eee8b",
      "envelope_recipient_type": "Signer"
    },
    {
      "role": "b21b49db-76b0-412d-bf9e-43d7bd3c4bb9",
      "envelope_recipient_type": "CarbonCopy"
    }
  ],
  "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
  "owner": "80a227b2-29a0-11e7-b636-e4a7a08e15d4"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "130bbf42-633b-467e-b027-aef22aeaa894",
    "created_at": 1765163542.418928,
    "updated_at": 1765163543.581506,
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
    "docusign_id": "0bd9ee91-0146-4268-8230-f8f4094935b5",
    "status": "Sent",
    "title": "This envelope is sent automatically from our test suite",
    "webhook_token": "b6ab1e6c-d3e3-11f0-ad27-5e29b9842fde",
    "auto_notify": true,
    "owner": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "type": "envelope",
    "recipients": [
      {
        "id": "428757fb-c523-478f-a814-6967651313ac",
        "created_at": 1765163542.434304,
        "updated_at": 1765163542.434304,
        "signed_at": null,
        "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
        "status": "Created",
        "role": {
          "id": "b21b49db-76b0-412d-bf9e-43d7bd3c4bb9",
          "created_at": 1765163541.722224,
          "updated_at": 1765163541.722224,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "role": "SellerAgent",
          "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
          "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": 1765163539.893705,
            "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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
            "current_time": "9:12 PM - Sunday Dec 07, 2025",
            "push_allowed": true,
            "agents": [
              {
                "id": "9e91bc22-dd83-4957-8c2b-4f16356bca8b",
                "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": 1765163540.021068,
                "deleted_at": null,
                "created_at": 1765163540.021069,
                "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": "4108758f-99d8-49d7-9707-ffa2fc8b82e4",
            "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": "7b015f4c-b353-44e8-bfb8-9ca9ed625b9d",
        "created_at": 1765163542.436144,
        "updated_at": 1765163542.436144,
        "signed_at": null,
        "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
        "status": "Created",
        "role": {
          "id": "b21b49db-76b0-412d-bf9e-43d7bd3c4bb9",
          "created_at": 1765163541.722224,
          "updated_at": 1765163541.722224,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "role": "SellerAgent",
          "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
          "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": 1765163539.893705,
            "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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
            "current_time": "9:12 PM - Sunday Dec 07, 2025",
            "push_allowed": true,
            "agents": [
              {
                "id": "9e91bc22-dd83-4957-8c2b-4f16356bca8b",
                "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": 1765163540.021068,
                "deleted_at": null,
                "created_at": 1765163540.021069,
                "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": "4108758f-99d8-49d7-9707-ffa2fc8b82e4",
            "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": "92ee262b-f610-40e5-89be-0ae4134898fd",
        "created_at": 1765163542.4373,
        "updated_at": 1765163542.4373,
        "signed_at": null,
        "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
        "status": "Created",
        "role": {
          "id": "fbae7896-1055-4747-b7bd-9329d67eee8b",
          "created_at": 1765163541.720172,
          "updated_at": 1765163541.720172,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "role": "BuyerAgent",
          "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
          "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": 1765163539.893705,
            "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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
            "current_time": "9:12 PM - Sunday Dec 07, 2025",
            "push_allowed": true,
            "agents": [
              {
                "id": "9e91bc22-dd83-4957-8c2b-4f16356bca8b",
                "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": 1765163540.021068,
                "deleted_at": null,
                "created_at": 1765163540.021069,
                "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": "4108758f-99d8-49d7-9707-ffa2fc8b82e4",
            "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": "c42e565c-6c4e-4176-8ba6-0a32e9180846",
        "created_at": 1765163542.438502,
        "updated_at": 1765163542.438502,
        "signed_at": null,
        "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
        "status": "Created",
        "role": {
          "id": "fbae7896-1055-4747-b7bd-9329d67eee8b",
          "created_at": 1765163541.720172,
          "updated_at": 1765163541.720172,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "role": "BuyerAgent",
          "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
          "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": 1765163539.893705,
            "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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
            "current_time": "9:12 PM - Sunday Dec 07, 2025",
            "push_allowed": true,
            "agents": [
              {
                "id": "9e91bc22-dd83-4957-8c2b-4f16356bca8b",
                "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": 1765163540.021068,
                "deleted_at": null,
                "created_at": 1765163540.021069,
                "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": "4108758f-99d8-49d7-9707-ffa2fc8b82e4",
            "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"
      }
    ],
    "documents": [
      {
        "id": "06184242-ebcc-4cbe-be05-b5d0fec2a4a7",
        "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
        "title": "Addendum for Back-Up Contract.pdf",
        "document_id": 1,
        "submission_revision": "d8f2cf12-861b-44ca-ab0e-6b90dd20b274",
        "file": null,
        "task": "9c5649b3-83b4-492d-9a2e-1fcee9239424",
        "submission": "102c548b-9712-4d8d-ab2b-a77ecdba27a3",
        "type": "envelope_document",
        "pdf": {
          "id": "a54eaaaa-cffc-4d76-8dc7-cd84bb591b5d",
          "created_at": 1765163543.623209,
          "updated_at": 1765163543.623209,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "path": "17cc1c1d-5148-431c-803c-d76fb3160d78/b761eb10-d3e3-11f0-a2d4-1bcac3894d4e.pdf",
          "name": "Addendum for Back-Up Contract.pdf.pdf",
          "public": false,
          "type": "file",
          "url": "https://private-cdn.irish.rechat.com/17cc1c1d-5148-431c-803c-d76fb3160d78/b761eb10-d3e3-11f0-a2d4-1bcac3894d4e.pdf?Expires=1765249943630&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=Oa2HehEw9Eb8RKlN9weVOgXJb4GhN5tJOIM9gfiyjZhhA4Pyeayfh7SUNIA0l2-XHjctMK0MAPKzi6RVseNxA8DTLMOGdVb~wmZ9LfXSVjeUwS9atSV~bY5BtgWl15NKwh~GUFYmDXeVSXODhiQUid8hqpFYD-OHfdiYmSClljqGNFKEomlEs3Xx0QtRjUJqxowTt0vQImBxM7J9-2SLNXpiPoVh6ezqSvGzSQOZdsznP2Ut-doarSb3Joq5szwJRkX3phO-gBtkUTC5PDJvWPRtFF7bEefyoFe7TIjMpJnxmLZMdTs5E5JAuJ69U2BOQKSCispBq3BtopwmMg9h6A__",
          "preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
          "mime": "application/pdf"
        }
      }
    ]
  }
}

Get Envelope

Get Envelope
GET/envelopes/:id

Example URI

GET /envelopes/:id
URI Parameters
HideShow
id
string (required) Example: 130bbf42-633b-467e-b027-aef22aeaa894
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "130bbf42-633b-467e-b027-aef22aeaa894",
    "created_at": 1765163542.418928,
    "updated_at": 1765163543.581506,
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
    "docusign_id": "0bd9ee91-0146-4268-8230-f8f4094935b5",
    "status": "Sent",
    "title": "This envelope is sent automatically from our test suite",
    "webhook_token": "b6ab1e6c-d3e3-11f0-ad27-5e29b9842fde",
    "auto_notify": true,
    "owner": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "type": "envelope",
    "recipients": [
      {
        "id": "428757fb-c523-478f-a814-6967651313ac",
        "created_at": 1765163542.434304,
        "updated_at": 1765163542.434304,
        "signed_at": null,
        "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
        "status": "Created",
        "role": {
          "id": "b21b49db-76b0-412d-bf9e-43d7bd3c4bb9",
          "created_at": 1765163541.722224,
          "updated_at": 1765163541.722224,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "role": "SellerAgent",
          "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
          "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": 1765163539.893705,
            "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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
            "current_time": "9:12 PM - Sunday Dec 07, 2025",
            "push_allowed": true,
            "agents": [
              {
                "id": "9e91bc22-dd83-4957-8c2b-4f16356bca8b",
                "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": 1765163540.021068,
                "deleted_at": null,
                "created_at": 1765163540.021069,
                "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": "4108758f-99d8-49d7-9707-ffa2fc8b82e4",
            "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": "7b015f4c-b353-44e8-bfb8-9ca9ed625b9d",
        "created_at": 1765163542.436144,
        "updated_at": 1765163542.436144,
        "signed_at": null,
        "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
        "status": "Created",
        "role": {
          "id": "b21b49db-76b0-412d-bf9e-43d7bd3c4bb9",
          "created_at": 1765163541.722224,
          "updated_at": 1765163541.722224,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "role": "SellerAgent",
          "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
          "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": 1765163539.893705,
            "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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
            "current_time": "9:12 PM - Sunday Dec 07, 2025",
            "push_allowed": true,
            "agents": [
              {
                "id": "9e91bc22-dd83-4957-8c2b-4f16356bca8b",
                "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": 1765163540.021068,
                "deleted_at": null,
                "created_at": 1765163540.021069,
                "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": "4108758f-99d8-49d7-9707-ffa2fc8b82e4",
            "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": "92ee262b-f610-40e5-89be-0ae4134898fd",
        "created_at": 1765163542.4373,
        "updated_at": 1765163542.4373,
        "signed_at": null,
        "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
        "status": "Created",
        "role": {
          "id": "fbae7896-1055-4747-b7bd-9329d67eee8b",
          "created_at": 1765163541.720172,
          "updated_at": 1765163541.720172,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "role": "BuyerAgent",
          "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
          "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": 1765163539.893705,
            "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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
            "current_time": "9:12 PM - Sunday Dec 07, 2025",
            "push_allowed": true,
            "agents": [
              {
                "id": "9e91bc22-dd83-4957-8c2b-4f16356bca8b",
                "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": 1765163540.021068,
                "deleted_at": null,
                "created_at": 1765163540.021069,
                "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": "4108758f-99d8-49d7-9707-ffa2fc8b82e4",
            "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": "c42e565c-6c4e-4176-8ba6-0a32e9180846",
        "created_at": 1765163542.438502,
        "updated_at": 1765163542.438502,
        "signed_at": null,
        "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
        "status": "Created",
        "role": {
          "id": "fbae7896-1055-4747-b7bd-9329d67eee8b",
          "created_at": 1765163541.720172,
          "updated_at": 1765163541.720172,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "role": "BuyerAgent",
          "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
          "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": 1765163539.893705,
            "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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
            "current_time": "9:12 PM - Sunday Dec 07, 2025",
            "push_allowed": true,
            "agents": [
              {
                "id": "9e91bc22-dd83-4957-8c2b-4f16356bca8b",
                "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": 1765163540.021068,
                "deleted_at": null,
                "created_at": 1765163540.021069,
                "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": "4108758f-99d8-49d7-9707-ffa2fc8b82e4",
            "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"
      }
    ],
    "documents": [
      {
        "id": "06184242-ebcc-4cbe-be05-b5d0fec2a4a7",
        "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
        "title": "Addendum for Back-Up Contract.pdf",
        "document_id": 1,
        "submission_revision": "d8f2cf12-861b-44ca-ab0e-6b90dd20b274",
        "file": null,
        "task": "9c5649b3-83b4-492d-9a2e-1fcee9239424",
        "submission": "102c548b-9712-4d8d-ab2b-a77ecdba27a3",
        "type": "envelope_document",
        "pdf": {
          "id": "a54eaaaa-cffc-4d76-8dc7-cd84bb591b5d",
          "created_at": 1765163543.623209,
          "updated_at": 1765163543.623209,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "path": "17cc1c1d-5148-431c-803c-d76fb3160d78/b761eb10-d3e3-11f0-a2d4-1bcac3894d4e.pdf",
          "name": "Addendum for Back-Up Contract.pdf.pdf",
          "public": false,
          "type": "file",
          "url": "https://private-cdn.irish.rechat.com/17cc1c1d-5148-431c-803c-d76fb3160d78/b761eb10-d3e3-11f0-a2d4-1bcac3894d4e.pdf?Expires=1765249943630&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=Oa2HehEw9Eb8RKlN9weVOgXJb4GhN5tJOIM9gfiyjZhhA4Pyeayfh7SUNIA0l2-XHjctMK0MAPKzi6RVseNxA8DTLMOGdVb~wmZ9LfXSVjeUwS9atSV~bY5BtgWl15NKwh~GUFYmDXeVSXODhiQUid8hqpFYD-OHfdiYmSClljqGNFKEomlEs3Xx0QtRjUJqxowTt0vQImBxM7J9-2SLNXpiPoVh6ezqSvGzSQOZdsznP2Ut-doarSb3Joq5szwJRkX3phO-gBtkUTC5PDJvWPRtFF7bEefyoFe7TIjMpJnxmLZMdTs5E5JAuJ69U2BOQKSCispBq3BtopwmMg9h6A__",
          "preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
          "mime": "application/pdf"
        }
      }
    ]
  }
}

Get Envelopes of a deal

Get Envelopes of a deal
GET/deals/:deal/envelopes

Example URI

GET /deals/:deal/envelopes
URI Parameters
HideShow
deal
string (required) Example: 17cc1c1d-5148-431c-803c-d76fb3160d78
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "130bbf42-633b-467e-b027-aef22aeaa894",
      "created_at": 1765163542.418928,
      "updated_at": 1765163543.581506,
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
      "docusign_id": "0bd9ee91-0146-4268-8230-f8f4094935b5",
      "status": "Sent",
      "title": "This envelope is sent automatically from our test suite",
      "webhook_token": "b6ab1e6c-d3e3-11f0-ad27-5e29b9842fde",
      "auto_notify": true,
      "owner": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "type": "envelope",
      "recipients": [
        {
          "id": "428757fb-c523-478f-a814-6967651313ac",
          "created_at": 1765163542.434304,
          "updated_at": 1765163542.434304,
          "signed_at": null,
          "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
          "status": "Created",
          "role": {
            "id": "b21b49db-76b0-412d-bf9e-43d7bd3c4bb9",
            "created_at": 1765163541.722224,
            "updated_at": 1765163541.722224,
            "deleted_at": null,
            "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
            "role": "SellerAgent",
            "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
            "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": 1765163539.893705,
              "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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
              "current_time": "9:12 PM - Sunday Dec 07, 2025",
              "push_allowed": true,
              "agents": [
                {
                  "id": "9e91bc22-dd83-4957-8c2b-4f16356bca8b",
                  "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": 1765163540.021068,
                  "deleted_at": null,
                  "created_at": 1765163540.021069,
                  "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": "4108758f-99d8-49d7-9707-ffa2fc8b82e4",
              "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": "7b015f4c-b353-44e8-bfb8-9ca9ed625b9d",
          "created_at": 1765163542.436144,
          "updated_at": 1765163542.436144,
          "signed_at": null,
          "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
          "status": "Created",
          "role": {
            "id": "b21b49db-76b0-412d-bf9e-43d7bd3c4bb9",
            "created_at": 1765163541.722224,
            "updated_at": 1765163541.722224,
            "deleted_at": null,
            "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
            "role": "SellerAgent",
            "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
            "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": 1765163539.893705,
              "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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
              "current_time": "9:12 PM - Sunday Dec 07, 2025",
              "push_allowed": true,
              "agents": [
                {
                  "id": "9e91bc22-dd83-4957-8c2b-4f16356bca8b",
                  "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": 1765163540.021068,
                  "deleted_at": null,
                  "created_at": 1765163540.021069,
                  "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": "4108758f-99d8-49d7-9707-ffa2fc8b82e4",
              "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": "92ee262b-f610-40e5-89be-0ae4134898fd",
          "created_at": 1765163542.4373,
          "updated_at": 1765163542.4373,
          "signed_at": null,
          "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
          "status": "Created",
          "role": {
            "id": "fbae7896-1055-4747-b7bd-9329d67eee8b",
            "created_at": 1765163541.720172,
            "updated_at": 1765163541.720172,
            "deleted_at": null,
            "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
            "role": "BuyerAgent",
            "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
            "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": 1765163539.893705,
              "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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
              "current_time": "9:12 PM - Sunday Dec 07, 2025",
              "push_allowed": true,
              "agents": [
                {
                  "id": "9e91bc22-dd83-4957-8c2b-4f16356bca8b",
                  "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": 1765163540.021068,
                  "deleted_at": null,
                  "created_at": 1765163540.021069,
                  "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": "4108758f-99d8-49d7-9707-ffa2fc8b82e4",
              "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": "c42e565c-6c4e-4176-8ba6-0a32e9180846",
          "created_at": 1765163542.438502,
          "updated_at": 1765163542.438502,
          "signed_at": null,
          "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
          "status": "Created",
          "role": {
            "id": "fbae7896-1055-4747-b7bd-9329d67eee8b",
            "created_at": 1765163541.720172,
            "updated_at": 1765163541.720172,
            "deleted_at": null,
            "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
            "role": "BuyerAgent",
            "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
            "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": 1765163539.893705,
              "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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
              "current_time": "9:12 PM - Sunday Dec 07, 2025",
              "push_allowed": true,
              "agents": [
                {
                  "id": "9e91bc22-dd83-4957-8c2b-4f16356bca8b",
                  "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": 1765163540.021068,
                  "deleted_at": null,
                  "created_at": 1765163540.021069,
                  "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": "4108758f-99d8-49d7-9707-ffa2fc8b82e4",
              "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"
        }
      ],
      "documents": [
        {
          "id": "06184242-ebcc-4cbe-be05-b5d0fec2a4a7",
          "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
          "title": "Addendum for Back-Up Contract.pdf",
          "document_id": 1,
          "submission_revision": "d8f2cf12-861b-44ca-ab0e-6b90dd20b274",
          "file": null,
          "task": "9c5649b3-83b4-492d-9a2e-1fcee9239424",
          "submission": "102c548b-9712-4d8d-ab2b-a77ecdba27a3",
          "type": "envelope_document",
          "pdf": {
            "id": "a54eaaaa-cffc-4d76-8dc7-cd84bb591b5d",
            "created_at": 1765163543.623209,
            "updated_at": 1765163543.623209,
            "deleted_at": null,
            "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
            "path": "17cc1c1d-5148-431c-803c-d76fb3160d78/b761eb10-d3e3-11f0-a2d4-1bcac3894d4e.pdf",
            "name": "Addendum for Back-Up Contract.pdf.pdf",
            "public": false,
            "type": "file",
            "url": "https://private-cdn.irish.rechat.com/17cc1c1d-5148-431c-803c-d76fb3160d78/b761eb10-d3e3-11f0-a2d4-1bcac3894d4e.pdf?Expires=1765249943630&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=Oa2HehEw9Eb8RKlN9weVOgXJb4GhN5tJOIM9gfiyjZhhA4Pyeayfh7SUNIA0l2-XHjctMK0MAPKzi6RVseNxA8DTLMOGdVb~wmZ9LfXSVjeUwS9atSV~bY5BtgWl15NKwh~GUFYmDXeVSXODhiQUid8hqpFYD-OHfdiYmSClljqGNFKEomlEs3Xx0QtRjUJqxowTt0vQImBxM7J9-2SLNXpiPoVh6ezqSvGzSQOZdsznP2Ut-doarSb3Joq5szwJRkX3phO-gBtkUTC5PDJvWPRtFF7bEefyoFe7TIjMpJnxmLZMdTs5E5JAuJ69U2BOQKSCispBq3BtopwmMg9h6A__",
            "preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
            "mime": "application/pdf"
          }
        }
      ]
    }
  ],
  "info": {
    "count": 1,
    "total": 0
  }
}

Sign an Envelope

Sign an Envelope
GET/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:

  1. User’s browser will be opened to /envelopes/:id/sign/:recipient

  2. User’s browser will be redirected to a page on Docusign where he can sign the document

  3. User’s browser will be sent back to Rechat

  4. Rechat updates the Envelope information

  5. Control is given back to client (either using Browser’s postMessage mechanism or redirecting him to rechat:// on phones)

  6. Client updates the envelope information

Example URI

GET /envelopes/:id:/sign/:recipient

Void an Envelope

Void an Envelope
PATCH/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
HideShow
id
string (required) Example: 130bbf42-633b-467e-b027-aef22aeaa894
Request
HideShow
Body
{
  "status": "Voided"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "130bbf42-633b-467e-b027-aef22aeaa894",
    "created_at": 1765163542.418928,
    "updated_at": 1765163544.344977,
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
    "docusign_id": "0bd9ee91-0146-4268-8230-f8f4094935b5",
    "status": "Voided",
    "title": "This envelope is sent automatically from our test suite",
    "webhook_token": "b6ab1e6c-d3e3-11f0-ad27-5e29b9842fde",
    "auto_notify": true,
    "owner": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "type": "envelope",
    "recipients": [
      {
        "id": "428757fb-c523-478f-a814-6967651313ac",
        "created_at": 1765163542.434304,
        "updated_at": 1765163542.434304,
        "signed_at": null,
        "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
        "status": "Created",
        "role": {
          "id": "b21b49db-76b0-412d-bf9e-43d7bd3c4bb9",
          "created_at": 1765163541.722224,
          "updated_at": 1765163541.722224,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "role": "SellerAgent",
          "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
          "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": 1765163539.893705,
            "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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
            "current_time": "9:12 PM - Sunday Dec 07, 2025",
            "push_allowed": true,
            "agents": [
              {
                "id": "9e91bc22-dd83-4957-8c2b-4f16356bca8b",
                "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": 1765163540.021068,
                "deleted_at": null,
                "created_at": 1765163540.021069,
                "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": "4108758f-99d8-49d7-9707-ffa2fc8b82e4",
            "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": "7b015f4c-b353-44e8-bfb8-9ca9ed625b9d",
        "created_at": 1765163542.436144,
        "updated_at": 1765163542.436144,
        "signed_at": null,
        "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
        "status": "Created",
        "role": {
          "id": "b21b49db-76b0-412d-bf9e-43d7bd3c4bb9",
          "created_at": 1765163541.722224,
          "updated_at": 1765163541.722224,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "role": "SellerAgent",
          "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
          "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": 1765163539.893705,
            "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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
            "current_time": "9:12 PM - Sunday Dec 07, 2025",
            "push_allowed": true,
            "agents": [
              {
                "id": "9e91bc22-dd83-4957-8c2b-4f16356bca8b",
                "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": 1765163540.021068,
                "deleted_at": null,
                "created_at": 1765163540.021069,
                "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": "4108758f-99d8-49d7-9707-ffa2fc8b82e4",
            "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": "92ee262b-f610-40e5-89be-0ae4134898fd",
        "created_at": 1765163542.4373,
        "updated_at": 1765163542.4373,
        "signed_at": null,
        "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
        "status": "Created",
        "role": {
          "id": "fbae7896-1055-4747-b7bd-9329d67eee8b",
          "created_at": 1765163541.720172,
          "updated_at": 1765163541.720172,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "role": "BuyerAgent",
          "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
          "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": 1765163539.893705,
            "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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
            "current_time": "9:12 PM - Sunday Dec 07, 2025",
            "push_allowed": true,
            "agents": [
              {
                "id": "9e91bc22-dd83-4957-8c2b-4f16356bca8b",
                "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": 1765163540.021068,
                "deleted_at": null,
                "created_at": 1765163540.021069,
                "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": "4108758f-99d8-49d7-9707-ffa2fc8b82e4",
            "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": "c42e565c-6c4e-4176-8ba6-0a32e9180846",
        "created_at": 1765163542.438502,
        "updated_at": 1765163542.438502,
        "signed_at": null,
        "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
        "status": "Created",
        "role": {
          "id": "fbae7896-1055-4747-b7bd-9329d67eee8b",
          "created_at": 1765163541.720172,
          "updated_at": 1765163541.720172,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "role": "BuyerAgent",
          "deal": "17cc1c1d-5148-431c-803c-d76fb3160d78",
          "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": 1765163539.893705,
            "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": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
            "current_time": "9:12 PM - Sunday Dec 07, 2025",
            "push_allowed": true,
            "agents": [
              {
                "id": "9e91bc22-dd83-4957-8c2b-4f16356bca8b",
                "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": 1765163540.021068,
                "deleted_at": null,
                "created_at": 1765163540.021069,
                "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": "4108758f-99d8-49d7-9707-ffa2fc8b82e4",
            "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"
      }
    ],
    "documents": [
      {
        "id": "06184242-ebcc-4cbe-be05-b5d0fec2a4a7",
        "envelope": "130bbf42-633b-467e-b027-aef22aeaa894",
        "title": "Addendum for Back-Up Contract.pdf",
        "document_id": 1,
        "submission_revision": "d8f2cf12-861b-44ca-ab0e-6b90dd20b274",
        "file": null,
        "task": "9c5649b3-83b4-492d-9a2e-1fcee9239424",
        "submission": "102c548b-9712-4d8d-ab2b-a77ecdba27a3",
        "type": "envelope_document",
        "pdf": {
          "id": "a54eaaaa-cffc-4d76-8dc7-cd84bb591b5d",
          "created_at": 1765163543.623209,
          "updated_at": 1765163543.623209,
          "deleted_at": null,
          "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
          "path": "17cc1c1d-5148-431c-803c-d76fb3160d78/b761eb10-d3e3-11f0-a2d4-1bcac3894d4e.pdf",
          "name": "Addendum for Back-Up Contract.pdf.pdf",
          "public": false,
          "type": "file",
          "url": "https://private-cdn.irish.rechat.com/17cc1c1d-5148-431c-803c-d76fb3160d78/b761eb10-d3e3-11f0-a2d4-1bcac3894d4e.pdf?Expires=1765249943630&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=Oa2HehEw9Eb8RKlN9weVOgXJb4GhN5tJOIM9gfiyjZhhA4Pyeayfh7SUNIA0l2-XHjctMK0MAPKzi6RVseNxA8DTLMOGdVb~wmZ9LfXSVjeUwS9atSV~bY5BtgWl15NKwh~GUFYmDXeVSXODhiQUid8hqpFYD-OHfdiYmSClljqGNFKEomlEs3Xx0QtRjUJqxowTt0vQImBxM7J9-2SLNXpiPoVh6ezqSvGzSQOZdsznP2Ut-doarSb3Joq5szwJRkX3phO-gBtkUTC5PDJvWPRtFF7bEefyoFe7TIjMpJnxmLZMdTs5E5JAuJ69U2BOQKSCispBq3BtopwmMg9h6A__",
          "preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
          "mime": "application/pdf"
        }
      }
    ]
  }
}

Generated by aglio on 08 Dec 2025