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": "27c3df33-a712-460d-bb9e-08e9582d6e01",
  "title": "This envelope is sent automatically from our test suite",
  "documents": [
    {
      "revision": null,
      "task": "b855b62a-2de0-4e8d-8c57-bfdd8b3c1f6a"
    }
  ],
  "recipients": [
    {
      "role": "c7071b26-265b-42df-9ad1-33ff4ba92bbf",
      "envelope_recipient_type": "Signer"
    },
    {
      "role": "dab4e95d-d22e-4408-ac31-926d1b395264",
      "envelope_recipient_type": "CarbonCopy"
    }
  ],
  "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
  "owner": "d543fcb4-d39e-464b-8480-caad5ea24153"
}
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": "27c3df33-a712-460d-bb9e-08e9582d6e01",
  "title": "This envelope is sent automatically from our test suite",
  "documents": [
    {
      "revision": null,
      "task": "b855b62a-2de0-4e8d-8c57-bfdd8b3c1f6a"
    }
  ],
  "recipients": [
    {
      "role": "c7071b26-265b-42df-9ad1-33ff4ba92bbf",
      "envelope_recipient_type": "Signer"
    },
    {
      "role": "dab4e95d-d22e-4408-ac31-926d1b395264",
      "envelope_recipient_type": "CarbonCopy"
    },
    {
      "role": "c7071b26-265b-42df-9ad1-33ff4ba92bbf",
      "envelope_recipient_type": "Signer"
    },
    {
      "role": "dab4e95d-d22e-4408-ac31-926d1b395264",
      "envelope_recipient_type": "CarbonCopy"
    }
  ],
  "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
  "owner": "d543fcb4-d39e-464b-8480-caad5ea24153"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
    "created_at": 1791656472.317403,
    "updated_at": 1791656472.78176,
    "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
    "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
    "docusign_id": "0bd9ee91-0146-4268-8230-f8f4094935b5",
    "status": "Sent",
    "title": "This envelope is sent automatically from our test suite",
    "webhook_token": "5f6ccc96-c4d7-11f1-a240-ea05dd1fc3a8",
    "auto_notify": true,
    "owner": "d543fcb4-d39e-464b-8480-caad5ea24153",
    "type": "envelope",
    "recipients": [
      {
        "id": "d4d3937d-c600-4e5c-8377-4a52463e7eee",
        "created_at": 1791656472.320802,
        "updated_at": 1791656472.320802,
        "signed_at": null,
        "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
        "status": "Created",
        "role": {
          "id": "c7071b26-265b-42df-9ad1-33ff4ba92bbf",
          "created_at": 1791656472.065578,
          "updated_at": 1791656472.065578,
          "deleted_at": null,
          "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
          "role": "BuyerAgent",
          "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
          "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": 1493115498.770744,
            "user_status": "Active",
            "profile_image_thumbnail_url": null,
            "cover_image_thumbnail_url": null,
            "email_confirmed": true,
            "timezone": "America/Chicago",
            "user_type": "Admin",
            "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": false,
            "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",
            "bio": null,
            "current_time": "1:21 PM - Saturday Oct 10, 2026",
            "push_allowed": true,
            "agents": null,
            "last_seen_type": null,
            "active_brand": null,
            "display_name": "Unit Test",
            "abbreviated_display_name": "Unit",
            "online_state": "Offline",
            "has_password": true
          },
          "commission_dollar": 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,
          "origin": "rechat",
          "skyslope_role": null,
          "type": "deal_role",
          "mlsid": null,
          "legal_full_name": "Wile E. Coyote"
        },
        "order": 1,
        "envelope_recipient_type": "Signer",
        "type": "envelope_recipient"
      },
      {
        "id": "898428d4-8af3-4649-95ed-15915432e7bd",
        "created_at": 1791656472.321561,
        "updated_at": 1791656472.321561,
        "signed_at": null,
        "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
        "status": "Created",
        "role": {
          "id": "dab4e95d-d22e-4408-ac31-926d1b395264",
          "created_at": 1791656472.066282,
          "updated_at": 1791656472.066282,
          "deleted_at": null,
          "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
          "role": "SellerAgent",
          "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
          "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": 1493115498.770744,
            "user_status": "Active",
            "profile_image_thumbnail_url": null,
            "cover_image_thumbnail_url": null,
            "email_confirmed": true,
            "timezone": "America/Chicago",
            "user_type": "Admin",
            "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": false,
            "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",
            "bio": null,
            "current_time": "1:21 PM - Saturday Oct 10, 2026",
            "push_allowed": true,
            "agents": null,
            "last_seen_type": null,
            "active_brand": null,
            "display_name": "Unit Test",
            "abbreviated_display_name": "Unit",
            "online_state": "Offline",
            "has_password": true
          },
          "commission_dollar": 20000,
          "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,
          "origin": "rechat",
          "skyslope_role": null,
          "type": "deal_role",
          "mlsid": null,
          "legal_full_name": "Imaginary Agent"
        },
        "order": 1,
        "envelope_recipient_type": "CarbonCopy",
        "type": "envelope_recipient"
      },
      {
        "id": "d81e6263-06ff-4c55-bf9c-c5bbe22eeb7c",
        "created_at": 1791656472.321795,
        "updated_at": 1791656472.321795,
        "signed_at": null,
        "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
        "status": "Created",
        "role": {
          "id": "c7071b26-265b-42df-9ad1-33ff4ba92bbf",
          "created_at": 1791656472.065578,
          "updated_at": 1791656472.065578,
          "deleted_at": null,
          "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
          "role": "BuyerAgent",
          "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
          "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": 1493115498.770744,
            "user_status": "Active",
            "profile_image_thumbnail_url": null,
            "cover_image_thumbnail_url": null,
            "email_confirmed": true,
            "timezone": "America/Chicago",
            "user_type": "Admin",
            "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": false,
            "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",
            "bio": null,
            "current_time": "1:21 PM - Saturday Oct 10, 2026",
            "push_allowed": true,
            "agents": null,
            "last_seen_type": null,
            "active_brand": null,
            "display_name": "Unit Test",
            "abbreviated_display_name": "Unit",
            "online_state": "Offline",
            "has_password": true
          },
          "commission_dollar": 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,
          "origin": "rechat",
          "skyslope_role": null,
          "type": "deal_role",
          "mlsid": null,
          "legal_full_name": "Wile E. Coyote"
        },
        "order": 1,
        "envelope_recipient_type": "Signer",
        "type": "envelope_recipient"
      },
      {
        "id": "7fee1357-96b8-4308-939a-707a697cbb99",
        "created_at": 1791656472.321966,
        "updated_at": 1791656472.321966,
        "signed_at": null,
        "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
        "status": "Created",
        "role": {
          "id": "dab4e95d-d22e-4408-ac31-926d1b395264",
          "created_at": 1791656472.066282,
          "updated_at": 1791656472.066282,
          "deleted_at": null,
          "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
          "role": "SellerAgent",
          "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
          "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": 1493115498.770744,
            "user_status": "Active",
            "profile_image_thumbnail_url": null,
            "cover_image_thumbnail_url": null,
            "email_confirmed": true,
            "timezone": "America/Chicago",
            "user_type": "Admin",
            "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": false,
            "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",
            "bio": null,
            "current_time": "1:21 PM - Saturday Oct 10, 2026",
            "push_allowed": true,
            "agents": null,
            "last_seen_type": null,
            "active_brand": null,
            "display_name": "Unit Test",
            "abbreviated_display_name": "Unit",
            "online_state": "Offline",
            "has_password": true
          },
          "commission_dollar": 20000,
          "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,
          "origin": "rechat",
          "skyslope_role": null,
          "type": "deal_role",
          "mlsid": null,
          "legal_full_name": "Imaginary Agent"
        },
        "order": 1,
        "envelope_recipient_type": "CarbonCopy",
        "type": "envelope_recipient"
      }
    ],
    "documents": [
      {
        "id": "d6825028-eae6-46cc-beef-4be930218e57",
        "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
        "title": "Addendum for Back-Up Contract.pdf",
        "document_id": 1,
        "submission_revision": "a6bb7f7a-4fe2-4810-9857-822c7a333559",
        "file": null,
        "task": "b855b62a-2de0-4e8d-8c57-bfdd8b3c1f6a",
        "submission": "c9269438-74ad-4daf-b788-ff060c7a90fe",
        "type": "envelope_document",
        "pdf": {
          "id": "7f9644a7-2b41-4a68-b4fa-5364914f32a4",
          "created_at": 1791656472.794716,
          "updated_at": 1791656472.794716,
          "deleted_at": null,
          "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
          "path": "27c3df33-a712-460d-bb9e-08e9582d6e01/5fb55c90-c4d7-11f1-89da-fb554657817f.pdf",
          "name": "Addendum for Back-Up Contract.pdf.pdf",
          "public": false,
          "type": "file",
          "url": "https://private-cdn.irish.rechat.com/27c3df33-a712-460d-bb9e-08e9582d6e01/5fb55c90-c4d7-11f1-89da-fb554657817f.pdf?Expires=1791742872796&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=MH21RXvwAqC7lvqLW8lOwtSIApXf9LgLwu1p-BnQmpppUfnDTHSWMNBkgSEAVkI3q3iFwYbLqdC8CfcwM9Lxtjt-StYcjJhFz3AN6MQt4T40Caky8oSWu703qaAT1ew4PgI1X23w1J3Bal61CdxoNcDE1OEjUq~LTtjyxJM-djLyfVv-ouuXu90Nh4RK0Oj5LUawJLbXGuRz3WmB7gtUiRqwpHGM9-dTuMbL6o4e4zF8o6~azfzJ0juivGs3KLvi2-jnUSEf1v-S7eOZ48Xj9bMYeVBe-hgZbh5r4l6NCAq~Swdb6TuwD~gi~Ds2nxSPcr0wvYuEFKSBRLyIzVPh7w__",
          "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: 3e4a39e4-d2e3-4476-8c53-341ea59f96e8
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
    "created_at": 1791656472.317403,
    "updated_at": 1791656472.78176,
    "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
    "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
    "docusign_id": "0bd9ee91-0146-4268-8230-f8f4094935b5",
    "status": "Sent",
    "title": "This envelope is sent automatically from our test suite",
    "webhook_token": "5f6ccc96-c4d7-11f1-a240-ea05dd1fc3a8",
    "auto_notify": true,
    "owner": "d543fcb4-d39e-464b-8480-caad5ea24153",
    "type": "envelope",
    "recipients": [
      {
        "id": "d4d3937d-c600-4e5c-8377-4a52463e7eee",
        "created_at": 1791656472.320802,
        "updated_at": 1791656472.320802,
        "signed_at": null,
        "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
        "status": "Created",
        "role": {
          "id": "c7071b26-265b-42df-9ad1-33ff4ba92bbf",
          "created_at": 1791656472.065578,
          "updated_at": 1791656472.065578,
          "deleted_at": null,
          "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
          "role": "BuyerAgent",
          "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
          "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": 1493115498.770744,
            "user_status": "Active",
            "profile_image_thumbnail_url": null,
            "cover_image_thumbnail_url": null,
            "email_confirmed": true,
            "timezone": "America/Chicago",
            "user_type": "Admin",
            "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": false,
            "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",
            "bio": null,
            "current_time": "1:21 PM - Saturday Oct 10, 2026",
            "push_allowed": true,
            "agents": null,
            "last_seen_type": null,
            "active_brand": null,
            "display_name": "Unit Test",
            "abbreviated_display_name": "Unit",
            "online_state": "Offline",
            "has_password": true
          },
          "commission_dollar": 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,
          "origin": "rechat",
          "skyslope_role": null,
          "type": "deal_role",
          "mlsid": null,
          "legal_full_name": "Wile E. Coyote"
        },
        "order": 1,
        "envelope_recipient_type": "Signer",
        "type": "envelope_recipient"
      },
      {
        "id": "898428d4-8af3-4649-95ed-15915432e7bd",
        "created_at": 1791656472.321561,
        "updated_at": 1791656472.321561,
        "signed_at": null,
        "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
        "status": "Created",
        "role": {
          "id": "dab4e95d-d22e-4408-ac31-926d1b395264",
          "created_at": 1791656472.066282,
          "updated_at": 1791656472.066282,
          "deleted_at": null,
          "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
          "role": "SellerAgent",
          "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
          "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": 1493115498.770744,
            "user_status": "Active",
            "profile_image_thumbnail_url": null,
            "cover_image_thumbnail_url": null,
            "email_confirmed": true,
            "timezone": "America/Chicago",
            "user_type": "Admin",
            "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": false,
            "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",
            "bio": null,
            "current_time": "1:21 PM - Saturday Oct 10, 2026",
            "push_allowed": true,
            "agents": null,
            "last_seen_type": null,
            "active_brand": null,
            "display_name": "Unit Test",
            "abbreviated_display_name": "Unit",
            "online_state": "Offline",
            "has_password": true
          },
          "commission_dollar": 20000,
          "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,
          "origin": "rechat",
          "skyslope_role": null,
          "type": "deal_role",
          "mlsid": null,
          "legal_full_name": "Imaginary Agent"
        },
        "order": 1,
        "envelope_recipient_type": "CarbonCopy",
        "type": "envelope_recipient"
      },
      {
        "id": "d81e6263-06ff-4c55-bf9c-c5bbe22eeb7c",
        "created_at": 1791656472.321795,
        "updated_at": 1791656472.321795,
        "signed_at": null,
        "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
        "status": "Created",
        "role": {
          "id": "c7071b26-265b-42df-9ad1-33ff4ba92bbf",
          "created_at": 1791656472.065578,
          "updated_at": 1791656472.065578,
          "deleted_at": null,
          "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
          "role": "BuyerAgent",
          "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
          "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": 1493115498.770744,
            "user_status": "Active",
            "profile_image_thumbnail_url": null,
            "cover_image_thumbnail_url": null,
            "email_confirmed": true,
            "timezone": "America/Chicago",
            "user_type": "Admin",
            "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": false,
            "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",
            "bio": null,
            "current_time": "1:21 PM - Saturday Oct 10, 2026",
            "push_allowed": true,
            "agents": null,
            "last_seen_type": null,
            "active_brand": null,
            "display_name": "Unit Test",
            "abbreviated_display_name": "Unit",
            "online_state": "Offline",
            "has_password": true
          },
          "commission_dollar": 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,
          "origin": "rechat",
          "skyslope_role": null,
          "type": "deal_role",
          "mlsid": null,
          "legal_full_name": "Wile E. Coyote"
        },
        "order": 1,
        "envelope_recipient_type": "Signer",
        "type": "envelope_recipient"
      },
      {
        "id": "7fee1357-96b8-4308-939a-707a697cbb99",
        "created_at": 1791656472.321966,
        "updated_at": 1791656472.321966,
        "signed_at": null,
        "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
        "status": "Created",
        "role": {
          "id": "dab4e95d-d22e-4408-ac31-926d1b395264",
          "created_at": 1791656472.066282,
          "updated_at": 1791656472.066282,
          "deleted_at": null,
          "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
          "role": "SellerAgent",
          "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
          "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": 1493115498.770744,
            "user_status": "Active",
            "profile_image_thumbnail_url": null,
            "cover_image_thumbnail_url": null,
            "email_confirmed": true,
            "timezone": "America/Chicago",
            "user_type": "Admin",
            "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": false,
            "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",
            "bio": null,
            "current_time": "1:21 PM - Saturday Oct 10, 2026",
            "push_allowed": true,
            "agents": null,
            "last_seen_type": null,
            "active_brand": null,
            "display_name": "Unit Test",
            "abbreviated_display_name": "Unit",
            "online_state": "Offline",
            "has_password": true
          },
          "commission_dollar": 20000,
          "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,
          "origin": "rechat",
          "skyslope_role": null,
          "type": "deal_role",
          "mlsid": null,
          "legal_full_name": "Imaginary Agent"
        },
        "order": 1,
        "envelope_recipient_type": "CarbonCopy",
        "type": "envelope_recipient"
      }
    ],
    "documents": [
      {
        "id": "d6825028-eae6-46cc-beef-4be930218e57",
        "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
        "title": "Addendum for Back-Up Contract.pdf",
        "document_id": 1,
        "submission_revision": "a6bb7f7a-4fe2-4810-9857-822c7a333559",
        "file": null,
        "task": "b855b62a-2de0-4e8d-8c57-bfdd8b3c1f6a",
        "submission": "c9269438-74ad-4daf-b788-ff060c7a90fe",
        "type": "envelope_document",
        "pdf": {
          "id": "7f9644a7-2b41-4a68-b4fa-5364914f32a4",
          "created_at": 1791656472.794716,
          "updated_at": 1791656472.794716,
          "deleted_at": null,
          "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
          "path": "27c3df33-a712-460d-bb9e-08e9582d6e01/5fb55c90-c4d7-11f1-89da-fb554657817f.pdf",
          "name": "Addendum for Back-Up Contract.pdf.pdf",
          "public": false,
          "type": "file",
          "url": "https://private-cdn.irish.rechat.com/27c3df33-a712-460d-bb9e-08e9582d6e01/5fb55c90-c4d7-11f1-89da-fb554657817f.pdf?Expires=1791742872796&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=MH21RXvwAqC7lvqLW8lOwtSIApXf9LgLwu1p-BnQmpppUfnDTHSWMNBkgSEAVkI3q3iFwYbLqdC8CfcwM9Lxtjt-StYcjJhFz3AN6MQt4T40Caky8oSWu703qaAT1ew4PgI1X23w1J3Bal61CdxoNcDE1OEjUq~LTtjyxJM-djLyfVv-ouuXu90Nh4RK0Oj5LUawJLbXGuRz3WmB7gtUiRqwpHGM9-dTuMbL6o4e4zF8o6~azfzJ0juivGs3KLvi2-jnUSEf1v-S7eOZ48Xj9bMYeVBe-hgZbh5r4l6NCAq~Swdb6TuwD~gi~Ds2nxSPcr0wvYuEFKSBRLyIzVPh7w__",
          "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: 27c3df33-a712-460d-bb9e-08e9582d6e01
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
      "created_at": 1791656472.317403,
      "updated_at": 1791656472.78176,
      "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
      "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
      "docusign_id": "0bd9ee91-0146-4268-8230-f8f4094935b5",
      "status": "Sent",
      "title": "This envelope is sent automatically from our test suite",
      "webhook_token": "5f6ccc96-c4d7-11f1-a240-ea05dd1fc3a8",
      "auto_notify": true,
      "owner": "d543fcb4-d39e-464b-8480-caad5ea24153",
      "type": "envelope",
      "recipients": [
        {
          "id": "d4d3937d-c600-4e5c-8377-4a52463e7eee",
          "created_at": 1791656472.320802,
          "updated_at": 1791656472.320802,
          "signed_at": null,
          "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
          "status": "Created",
          "role": {
            "id": "c7071b26-265b-42df-9ad1-33ff4ba92bbf",
            "created_at": 1791656472.065578,
            "updated_at": 1791656472.065578,
            "deleted_at": null,
            "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
            "role": "BuyerAgent",
            "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
            "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": 1493115498.770744,
              "user_status": "Active",
              "profile_image_thumbnail_url": null,
              "cover_image_thumbnail_url": null,
              "email_confirmed": true,
              "timezone": "America/Chicago",
              "user_type": "Admin",
              "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": false,
              "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",
              "bio": null,
              "current_time": "1:21 PM - Saturday Oct 10, 2026",
              "push_allowed": true,
              "agents": null,
              "last_seen_type": null,
              "active_brand": null,
              "display_name": "Unit Test",
              "abbreviated_display_name": "Unit",
              "online_state": "Offline",
              "has_password": true
            },
            "commission_dollar": 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,
            "origin": "rechat",
            "skyslope_role": null,
            "type": "deal_role",
            "mlsid": null,
            "legal_full_name": "Wile E. Coyote"
          },
          "order": 1,
          "envelope_recipient_type": "Signer",
          "type": "envelope_recipient"
        },
        {
          "id": "898428d4-8af3-4649-95ed-15915432e7bd",
          "created_at": 1791656472.321561,
          "updated_at": 1791656472.321561,
          "signed_at": null,
          "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
          "status": "Created",
          "role": {
            "id": "dab4e95d-d22e-4408-ac31-926d1b395264",
            "created_at": 1791656472.066282,
            "updated_at": 1791656472.066282,
            "deleted_at": null,
            "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
            "role": "SellerAgent",
            "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
            "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": 1493115498.770744,
              "user_status": "Active",
              "profile_image_thumbnail_url": null,
              "cover_image_thumbnail_url": null,
              "email_confirmed": true,
              "timezone": "America/Chicago",
              "user_type": "Admin",
              "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": false,
              "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",
              "bio": null,
              "current_time": "1:21 PM - Saturday Oct 10, 2026",
              "push_allowed": true,
              "agents": null,
              "last_seen_type": null,
              "active_brand": null,
              "display_name": "Unit Test",
              "abbreviated_display_name": "Unit",
              "online_state": "Offline",
              "has_password": true
            },
            "commission_dollar": 20000,
            "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,
            "origin": "rechat",
            "skyslope_role": null,
            "type": "deal_role",
            "mlsid": null,
            "legal_full_name": "Imaginary Agent"
          },
          "order": 1,
          "envelope_recipient_type": "CarbonCopy",
          "type": "envelope_recipient"
        },
        {
          "id": "d81e6263-06ff-4c55-bf9c-c5bbe22eeb7c",
          "created_at": 1791656472.321795,
          "updated_at": 1791656472.321795,
          "signed_at": null,
          "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
          "status": "Created",
          "role": {
            "id": "c7071b26-265b-42df-9ad1-33ff4ba92bbf",
            "created_at": 1791656472.065578,
            "updated_at": 1791656472.065578,
            "deleted_at": null,
            "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
            "role": "BuyerAgent",
            "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
            "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": 1493115498.770744,
              "user_status": "Active",
              "profile_image_thumbnail_url": null,
              "cover_image_thumbnail_url": null,
              "email_confirmed": true,
              "timezone": "America/Chicago",
              "user_type": "Admin",
              "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": false,
              "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",
              "bio": null,
              "current_time": "1:21 PM - Saturday Oct 10, 2026",
              "push_allowed": true,
              "agents": null,
              "last_seen_type": null,
              "active_brand": null,
              "display_name": "Unit Test",
              "abbreviated_display_name": "Unit",
              "online_state": "Offline",
              "has_password": true
            },
            "commission_dollar": 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,
            "origin": "rechat",
            "skyslope_role": null,
            "type": "deal_role",
            "mlsid": null,
            "legal_full_name": "Wile E. Coyote"
          },
          "order": 1,
          "envelope_recipient_type": "Signer",
          "type": "envelope_recipient"
        },
        {
          "id": "7fee1357-96b8-4308-939a-707a697cbb99",
          "created_at": 1791656472.321966,
          "updated_at": 1791656472.321966,
          "signed_at": null,
          "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
          "status": "Created",
          "role": {
            "id": "dab4e95d-d22e-4408-ac31-926d1b395264",
            "created_at": 1791656472.066282,
            "updated_at": 1791656472.066282,
            "deleted_at": null,
            "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
            "role": "SellerAgent",
            "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
            "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": 1493115498.770744,
              "user_status": "Active",
              "profile_image_thumbnail_url": null,
              "cover_image_thumbnail_url": null,
              "email_confirmed": true,
              "timezone": "America/Chicago",
              "user_type": "Admin",
              "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": false,
              "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",
              "bio": null,
              "current_time": "1:21 PM - Saturday Oct 10, 2026",
              "push_allowed": true,
              "agents": null,
              "last_seen_type": null,
              "active_brand": null,
              "display_name": "Unit Test",
              "abbreviated_display_name": "Unit",
              "online_state": "Offline",
              "has_password": true
            },
            "commission_dollar": 20000,
            "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,
            "origin": "rechat",
            "skyslope_role": null,
            "type": "deal_role",
            "mlsid": null,
            "legal_full_name": "Imaginary Agent"
          },
          "order": 1,
          "envelope_recipient_type": "CarbonCopy",
          "type": "envelope_recipient"
        }
      ],
      "documents": [
        {
          "id": "d6825028-eae6-46cc-beef-4be930218e57",
          "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
          "title": "Addendum for Back-Up Contract.pdf",
          "document_id": 1,
          "submission_revision": "a6bb7f7a-4fe2-4810-9857-822c7a333559",
          "file": null,
          "task": "b855b62a-2de0-4e8d-8c57-bfdd8b3c1f6a",
          "submission": "c9269438-74ad-4daf-b788-ff060c7a90fe",
          "type": "envelope_document",
          "pdf": {
            "id": "7f9644a7-2b41-4a68-b4fa-5364914f32a4",
            "created_at": 1791656472.794716,
            "updated_at": 1791656472.794716,
            "deleted_at": null,
            "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
            "path": "27c3df33-a712-460d-bb9e-08e9582d6e01/5fb55c90-c4d7-11f1-89da-fb554657817f.pdf",
            "name": "Addendum for Back-Up Contract.pdf.pdf",
            "public": false,
            "type": "file",
            "url": "https://private-cdn.irish.rechat.com/27c3df33-a712-460d-bb9e-08e9582d6e01/5fb55c90-c4d7-11f1-89da-fb554657817f.pdf?Expires=1791742872796&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=MH21RXvwAqC7lvqLW8lOwtSIApXf9LgLwu1p-BnQmpppUfnDTHSWMNBkgSEAVkI3q3iFwYbLqdC8CfcwM9Lxtjt-StYcjJhFz3AN6MQt4T40Caky8oSWu703qaAT1ew4PgI1X23w1J3Bal61CdxoNcDE1OEjUq~LTtjyxJM-djLyfVv-ouuXu90Nh4RK0Oj5LUawJLbXGuRz3WmB7gtUiRqwpHGM9-dTuMbL6o4e4zF8o6~azfzJ0juivGs3KLvi2-jnUSEf1v-S7eOZ48Xj9bMYeVBe-hgZbh5r4l6NCAq~Swdb6TuwD~gi~Ds2nxSPcr0wvYuEFKSBRLyIzVPh7w__",
            "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: 3e4a39e4-d2e3-4476-8c53-341ea59f96e8
Request
HideShow
Body
{
  "status": "Voided"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
    "created_at": 1791656472.317403,
    "updated_at": 1791656472.918217,
    "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
    "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
    "docusign_id": "0bd9ee91-0146-4268-8230-f8f4094935b5",
    "status": "Voided",
    "title": "This envelope is sent automatically from our test suite",
    "webhook_token": "5f6ccc96-c4d7-11f1-a240-ea05dd1fc3a8",
    "auto_notify": true,
    "owner": "d543fcb4-d39e-464b-8480-caad5ea24153",
    "type": "envelope",
    "recipients": [
      {
        "id": "d4d3937d-c600-4e5c-8377-4a52463e7eee",
        "created_at": 1791656472.320802,
        "updated_at": 1791656472.320802,
        "signed_at": null,
        "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
        "status": "Created",
        "role": {
          "id": "c7071b26-265b-42df-9ad1-33ff4ba92bbf",
          "created_at": 1791656472.065578,
          "updated_at": 1791656472.065578,
          "deleted_at": null,
          "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
          "role": "BuyerAgent",
          "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
          "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": 1493115498.770744,
            "user_status": "Active",
            "profile_image_thumbnail_url": null,
            "cover_image_thumbnail_url": null,
            "email_confirmed": true,
            "timezone": "America/Chicago",
            "user_type": "Admin",
            "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": false,
            "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",
            "bio": null,
            "current_time": "1:21 PM - Saturday Oct 10, 2026",
            "push_allowed": true,
            "agents": null,
            "last_seen_type": null,
            "active_brand": null,
            "display_name": "Unit Test",
            "abbreviated_display_name": "Unit",
            "online_state": "Offline",
            "has_password": true
          },
          "commission_dollar": 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,
          "origin": "rechat",
          "skyslope_role": null,
          "type": "deal_role",
          "mlsid": null,
          "legal_full_name": "Wile E. Coyote"
        },
        "order": 1,
        "envelope_recipient_type": "Signer",
        "type": "envelope_recipient"
      },
      {
        "id": "898428d4-8af3-4649-95ed-15915432e7bd",
        "created_at": 1791656472.321561,
        "updated_at": 1791656472.321561,
        "signed_at": null,
        "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
        "status": "Created",
        "role": {
          "id": "dab4e95d-d22e-4408-ac31-926d1b395264",
          "created_at": 1791656472.066282,
          "updated_at": 1791656472.066282,
          "deleted_at": null,
          "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
          "role": "SellerAgent",
          "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
          "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": 1493115498.770744,
            "user_status": "Active",
            "profile_image_thumbnail_url": null,
            "cover_image_thumbnail_url": null,
            "email_confirmed": true,
            "timezone": "America/Chicago",
            "user_type": "Admin",
            "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": false,
            "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",
            "bio": null,
            "current_time": "1:21 PM - Saturday Oct 10, 2026",
            "push_allowed": true,
            "agents": null,
            "last_seen_type": null,
            "active_brand": null,
            "display_name": "Unit Test",
            "abbreviated_display_name": "Unit",
            "online_state": "Offline",
            "has_password": true
          },
          "commission_dollar": 20000,
          "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,
          "origin": "rechat",
          "skyslope_role": null,
          "type": "deal_role",
          "mlsid": null,
          "legal_full_name": "Imaginary Agent"
        },
        "order": 1,
        "envelope_recipient_type": "CarbonCopy",
        "type": "envelope_recipient"
      },
      {
        "id": "d81e6263-06ff-4c55-bf9c-c5bbe22eeb7c",
        "created_at": 1791656472.321795,
        "updated_at": 1791656472.321795,
        "signed_at": null,
        "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
        "status": "Created",
        "role": {
          "id": "c7071b26-265b-42df-9ad1-33ff4ba92bbf",
          "created_at": 1791656472.065578,
          "updated_at": 1791656472.065578,
          "deleted_at": null,
          "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
          "role": "BuyerAgent",
          "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
          "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": 1493115498.770744,
            "user_status": "Active",
            "profile_image_thumbnail_url": null,
            "cover_image_thumbnail_url": null,
            "email_confirmed": true,
            "timezone": "America/Chicago",
            "user_type": "Admin",
            "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": false,
            "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",
            "bio": null,
            "current_time": "1:21 PM - Saturday Oct 10, 2026",
            "push_allowed": true,
            "agents": null,
            "last_seen_type": null,
            "active_brand": null,
            "display_name": "Unit Test",
            "abbreviated_display_name": "Unit",
            "online_state": "Offline",
            "has_password": true
          },
          "commission_dollar": 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,
          "origin": "rechat",
          "skyslope_role": null,
          "type": "deal_role",
          "mlsid": null,
          "legal_full_name": "Wile E. Coyote"
        },
        "order": 1,
        "envelope_recipient_type": "Signer",
        "type": "envelope_recipient"
      },
      {
        "id": "7fee1357-96b8-4308-939a-707a697cbb99",
        "created_at": 1791656472.321966,
        "updated_at": 1791656472.321966,
        "signed_at": null,
        "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
        "status": "Created",
        "role": {
          "id": "dab4e95d-d22e-4408-ac31-926d1b395264",
          "created_at": 1791656472.066282,
          "updated_at": 1791656472.066282,
          "deleted_at": null,
          "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
          "role": "SellerAgent",
          "deal": "27c3df33-a712-460d-bb9e-08e9582d6e01",
          "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": 1493115498.770744,
            "user_status": "Active",
            "profile_image_thumbnail_url": null,
            "cover_image_thumbnail_url": null,
            "email_confirmed": true,
            "timezone": "America/Chicago",
            "user_type": "Admin",
            "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": false,
            "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",
            "bio": null,
            "current_time": "1:21 PM - Saturday Oct 10, 2026",
            "push_allowed": true,
            "agents": null,
            "last_seen_type": null,
            "active_brand": null,
            "display_name": "Unit Test",
            "abbreviated_display_name": "Unit",
            "online_state": "Offline",
            "has_password": true
          },
          "commission_dollar": 20000,
          "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,
          "origin": "rechat",
          "skyslope_role": null,
          "type": "deal_role",
          "mlsid": null,
          "legal_full_name": "Imaginary Agent"
        },
        "order": 1,
        "envelope_recipient_type": "CarbonCopy",
        "type": "envelope_recipient"
      }
    ],
    "documents": [
      {
        "id": "d6825028-eae6-46cc-beef-4be930218e57",
        "envelope": "3e4a39e4-d2e3-4476-8c53-341ea59f96e8",
        "title": "Addendum for Back-Up Contract.pdf",
        "document_id": 1,
        "submission_revision": "a6bb7f7a-4fe2-4810-9857-822c7a333559",
        "file": null,
        "task": "b855b62a-2de0-4e8d-8c57-bfdd8b3c1f6a",
        "submission": "c9269438-74ad-4daf-b788-ff060c7a90fe",
        "type": "envelope_document",
        "pdf": {
          "id": "7f9644a7-2b41-4a68-b4fa-5364914f32a4",
          "created_at": 1791656472.794716,
          "updated_at": 1791656472.794716,
          "deleted_at": null,
          "created_by": "d543fcb4-d39e-464b-8480-caad5ea24153",
          "path": "27c3df33-a712-460d-bb9e-08e9582d6e01/5fb55c90-c4d7-11f1-89da-fb554657817f.pdf",
          "name": "Addendum for Back-Up Contract.pdf.pdf",
          "public": false,
          "type": "file",
          "url": "https://private-cdn.irish.rechat.com/27c3df33-a712-460d-bb9e-08e9582d6e01/5fb55c90-c4d7-11f1-89da-fb554657817f.pdf?Expires=1791742872796&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=MH21RXvwAqC7lvqLW8lOwtSIApXf9LgLwu1p-BnQmpppUfnDTHSWMNBkgSEAVkI3q3iFwYbLqdC8CfcwM9Lxtjt-StYcjJhFz3AN6MQt4T40Caky8oSWu703qaAT1ew4PgI1X23w1J3Bal61CdxoNcDE1OEjUq~LTtjyxJM-djLyfVv-ouuXu90Nh4RK0Oj5LUawJLbXGuRz3WmB7gtUiRqwpHGM9-dTuMbL6o4e4zF8o6~azfzJ0juivGs3KLvi2-jnUSEf1v-S7eOZ48Xj9bMYeVBe-hgZbh5r4l6NCAq~Swdb6TuwD~gi~Ds2nxSPcr0wvYuEFKSBRLyIzVPh7w__",
          "preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
          "mime": "application/pdf"
        }
      }
    ]
  }
}

Generated by aglio on 10 Oct 2026