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": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
  "title": "This envelope is sent automatically from our test suite",
  "documents": [
    {
      "revision": null,
      "task": "5f5e379d-c820-4d29-ac8c-8d6201e83a77"
    }
  ],
  "recipients": [
    {
      "role": "558c7cf8-865b-4fcf-97ff-5586935734ec",
      "envelope_recipient_type": "Signer"
    },
    {
      "role": "a2bb78cd-60b6-4bd4-8a20-913dea95bfbc",
      "envelope_recipient_type": "CarbonCopy"
    }
  ],
  "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
  "owner": "0efc43de-2c1d-4826-9acf-9a7157cdaaec"
}
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": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
  "title": "This envelope is sent automatically from our test suite",
  "documents": [
    {
      "revision": null,
      "task": "5f5e379d-c820-4d29-ac8c-8d6201e83a77"
    }
  ],
  "recipients": [
    {
      "role": "558c7cf8-865b-4fcf-97ff-5586935734ec",
      "envelope_recipient_type": "Signer"
    },
    {
      "role": "a2bb78cd-60b6-4bd4-8a20-913dea95bfbc",
      "envelope_recipient_type": "CarbonCopy"
    },
    {
      "role": "558c7cf8-865b-4fcf-97ff-5586935734ec",
      "envelope_recipient_type": "Signer"
    },
    {
      "role": "a2bb78cd-60b6-4bd4-8a20-913dea95bfbc",
      "envelope_recipient_type": "CarbonCopy"
    }
  ],
  "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
  "owner": "0efc43de-2c1d-4826-9acf-9a7157cdaaec"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "681c069f-0e74-452b-87f8-2e514e6c0924",
    "created_at": 1783014844.20963,
    "updated_at": 1783014845.030511,
    "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
    "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
    "docusign_id": "0bd9ee91-0146-4268-8230-f8f4094935b5",
    "status": "Sent",
    "title": "This envelope is sent automatically from our test suite",
    "webhook_token": "03b044be-763f-11f1-a9fa-76a72ce311da",
    "auto_notify": true,
    "owner": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
    "type": "envelope",
    "recipients": [
      {
        "id": "8b3fc797-e78f-4103-819b-b21fb44fcafb",
        "created_at": 1783014844.218745,
        "updated_at": 1783014844.218745,
        "signed_at": null,
        "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
        "status": "Created",
        "role": {
          "id": "558c7cf8-865b-4fcf-97ff-5586935734ec",
          "created_at": 1783014843.719387,
          "updated_at": 1783014843.719387,
          "deleted_at": null,
          "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
          "role": "BuyerAgent",
          "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
          "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": "12:54 PM - Thursday Jul 02, 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,
          "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": "71499061-9ad7-4d08-b4fa-9df3e56a4e0a",
        "created_at": 1783014844.220144,
        "updated_at": 1783014844.220144,
        "signed_at": null,
        "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
        "status": "Created",
        "role": {
          "id": "a2bb78cd-60b6-4bd4-8a20-913dea95bfbc",
          "created_at": 1783014843.722424,
          "updated_at": 1783014843.722424,
          "deleted_at": null,
          "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
          "role": "SellerAgent",
          "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
          "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": "12:54 PM - Thursday Jul 02, 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,
          "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": "9a6da746-1813-4197-9f84-987e1e79a3f8",
        "created_at": 1783014844.220836,
        "updated_at": 1783014844.220836,
        "signed_at": null,
        "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
        "status": "Created",
        "role": {
          "id": "558c7cf8-865b-4fcf-97ff-5586935734ec",
          "created_at": 1783014843.719387,
          "updated_at": 1783014843.719387,
          "deleted_at": null,
          "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
          "role": "BuyerAgent",
          "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
          "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": "12:54 PM - Thursday Jul 02, 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,
          "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": "9959cc70-f068-47f0-a16c-f0ea13f0bcec",
        "created_at": 1783014844.221496,
        "updated_at": 1783014844.221496,
        "signed_at": null,
        "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
        "status": "Created",
        "role": {
          "id": "a2bb78cd-60b6-4bd4-8a20-913dea95bfbc",
          "created_at": 1783014843.722424,
          "updated_at": 1783014843.722424,
          "deleted_at": null,
          "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
          "role": "SellerAgent",
          "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
          "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": "12:54 PM - Thursday Jul 02, 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,
          "brokerwolf_id": null,
          "brokerwolf_row_version": null,
          "legal_prefix": null,
          "legal_first_name": "Imaginary",
          "legal_middle_name": null,
          "legal_last_name": "Agent",
          "company_title": null,
          "commission_percentage": null,
          "email": "[email protected]",
          "phone_number": null,
          "checklist": null,
          "role_type": "Person",
          "agent": null,
          "old_current_address": null,
          "old_future_address": null,
          "office_name": null,
          "office_email": null,
          "office_phone": null,
          "office_fax": null,
          "office_license_number": null,
          "office_mls_id": null,
          "office_address": null,
          "searchable": "'agent':2 'imaginari':1 '[email protected]':3",
          "current_address": null,
          "future_address": null,
          "type": "deal_role",
          "mlsid": null,
          "legal_full_name": "Imaginary Agent"
        },
        "order": 1,
        "envelope_recipient_type": "CarbonCopy",
        "type": "envelope_recipient"
      }
    ],
    "documents": [
      {
        "id": "ae8d9c8f-c4db-4d26-ba1a-691ac9479c47",
        "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
        "title": "Addendum for Back-Up Contract.pdf",
        "document_id": 1,
        "submission_revision": "b901d67c-37d8-4670-8187-5d395f3c33f5",
        "file": null,
        "task": "5f5e379d-c820-4d29-ac8c-8d6201e83a77",
        "submission": "e1929158-b0fb-4135-988a-4953f092828f",
        "type": "envelope_document",
        "pdf": {
          "id": "bee5e2b9-2341-4582-a95b-0ed1f9974636",
          "created_at": 1783014845.062613,
          "updated_at": 1783014845.062613,
          "deleted_at": null,
          "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
          "path": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0/0431b620-763f-11f1-94b5-7519f45a456b.pdf",
          "name": "Addendum for Back-Up Contract.pdf.pdf",
          "public": false,
          "type": "file",
          "url": "https://private-cdn.irish.rechat.com/9ed8239a-0b80-472b-9994-9d71ed2ebdb0/0431b620-763f-11f1-94b5-7519f45a456b.pdf?Expires=1783101245066&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=Ddc5nZPO3nK9slErGtateLeL7sGZBw9nzD3lPGU3HDu3ftaLEg3AkavQygzz~chDwrNYCKIAZ6AVX-90p6iZSYwllwAdbKFqiKc~Jou6Vf2HsFLrZCZSYkL~QuT3Dpxwaov7RzOG6TxncpQi3vbPR4Kl4qAWyue40cXj~NxyLeFY0i~IDOgRAcMRaZs5lcKPZ7ZAyMHJ6yQGD5MGYOzhl9wLeXvixiCeZi1bEOmRlB5iju6fzHKJoCR~pNVQFoogrPWfg9ed57mFTREgIiJhtk9BgUM7kle~JwmTXkIRup0j1dVOlrH3NRIDo4K2225uDjFHHG1Pz9Lm~eB1ZSj4wQ__",
          "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: 681c069f-0e74-452b-87f8-2e514e6c0924
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "681c069f-0e74-452b-87f8-2e514e6c0924",
    "created_at": 1783014844.20963,
    "updated_at": 1783014845.030511,
    "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
    "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
    "docusign_id": "0bd9ee91-0146-4268-8230-f8f4094935b5",
    "status": "Sent",
    "title": "This envelope is sent automatically from our test suite",
    "webhook_token": "03b044be-763f-11f1-a9fa-76a72ce311da",
    "auto_notify": true,
    "owner": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
    "type": "envelope",
    "recipients": [
      {
        "id": "8b3fc797-e78f-4103-819b-b21fb44fcafb",
        "created_at": 1783014844.218745,
        "updated_at": 1783014844.218745,
        "signed_at": null,
        "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
        "status": "Created",
        "role": {
          "id": "558c7cf8-865b-4fcf-97ff-5586935734ec",
          "created_at": 1783014843.719387,
          "updated_at": 1783014843.719387,
          "deleted_at": null,
          "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
          "role": "BuyerAgent",
          "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
          "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": "12:54 PM - Thursday Jul 02, 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,
          "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": "71499061-9ad7-4d08-b4fa-9df3e56a4e0a",
        "created_at": 1783014844.220144,
        "updated_at": 1783014844.220144,
        "signed_at": null,
        "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
        "status": "Created",
        "role": {
          "id": "a2bb78cd-60b6-4bd4-8a20-913dea95bfbc",
          "created_at": 1783014843.722424,
          "updated_at": 1783014843.722424,
          "deleted_at": null,
          "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
          "role": "SellerAgent",
          "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
          "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": "12:54 PM - Thursday Jul 02, 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,
          "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": "9a6da746-1813-4197-9f84-987e1e79a3f8",
        "created_at": 1783014844.220836,
        "updated_at": 1783014844.220836,
        "signed_at": null,
        "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
        "status": "Created",
        "role": {
          "id": "558c7cf8-865b-4fcf-97ff-5586935734ec",
          "created_at": 1783014843.719387,
          "updated_at": 1783014843.719387,
          "deleted_at": null,
          "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
          "role": "BuyerAgent",
          "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
          "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": "12:54 PM - Thursday Jul 02, 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,
          "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": "9959cc70-f068-47f0-a16c-f0ea13f0bcec",
        "created_at": 1783014844.221496,
        "updated_at": 1783014844.221496,
        "signed_at": null,
        "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
        "status": "Created",
        "role": {
          "id": "a2bb78cd-60b6-4bd4-8a20-913dea95bfbc",
          "created_at": 1783014843.722424,
          "updated_at": 1783014843.722424,
          "deleted_at": null,
          "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
          "role": "SellerAgent",
          "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
          "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": "12:54 PM - Thursday Jul 02, 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,
          "brokerwolf_id": null,
          "brokerwolf_row_version": null,
          "legal_prefix": null,
          "legal_first_name": "Imaginary",
          "legal_middle_name": null,
          "legal_last_name": "Agent",
          "company_title": null,
          "commission_percentage": null,
          "email": "[email protected]",
          "phone_number": null,
          "checklist": null,
          "role_type": "Person",
          "agent": null,
          "old_current_address": null,
          "old_future_address": null,
          "office_name": null,
          "office_email": null,
          "office_phone": null,
          "office_fax": null,
          "office_license_number": null,
          "office_mls_id": null,
          "office_address": null,
          "searchable": "'agent':2 'imaginari':1 '[email protected]':3",
          "current_address": null,
          "future_address": null,
          "type": "deal_role",
          "mlsid": null,
          "legal_full_name": "Imaginary Agent"
        },
        "order": 1,
        "envelope_recipient_type": "CarbonCopy",
        "type": "envelope_recipient"
      }
    ],
    "documents": [
      {
        "id": "ae8d9c8f-c4db-4d26-ba1a-691ac9479c47",
        "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
        "title": "Addendum for Back-Up Contract.pdf",
        "document_id": 1,
        "submission_revision": "b901d67c-37d8-4670-8187-5d395f3c33f5",
        "file": null,
        "task": "5f5e379d-c820-4d29-ac8c-8d6201e83a77",
        "submission": "e1929158-b0fb-4135-988a-4953f092828f",
        "type": "envelope_document",
        "pdf": {
          "id": "bee5e2b9-2341-4582-a95b-0ed1f9974636",
          "created_at": 1783014845.062613,
          "updated_at": 1783014845.062613,
          "deleted_at": null,
          "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
          "path": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0/0431b620-763f-11f1-94b5-7519f45a456b.pdf",
          "name": "Addendum for Back-Up Contract.pdf.pdf",
          "public": false,
          "type": "file",
          "url": "https://private-cdn.irish.rechat.com/9ed8239a-0b80-472b-9994-9d71ed2ebdb0/0431b620-763f-11f1-94b5-7519f45a456b.pdf?Expires=1783101245066&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=Ddc5nZPO3nK9slErGtateLeL7sGZBw9nzD3lPGU3HDu3ftaLEg3AkavQygzz~chDwrNYCKIAZ6AVX-90p6iZSYwllwAdbKFqiKc~Jou6Vf2HsFLrZCZSYkL~QuT3Dpxwaov7RzOG6TxncpQi3vbPR4Kl4qAWyue40cXj~NxyLeFY0i~IDOgRAcMRaZs5lcKPZ7ZAyMHJ6yQGD5MGYOzhl9wLeXvixiCeZi1bEOmRlB5iju6fzHKJoCR~pNVQFoogrPWfg9ed57mFTREgIiJhtk9BgUM7kle~JwmTXkIRup0j1dVOlrH3NRIDo4K2225uDjFHHG1Pz9Lm~eB1ZSj4wQ__",
          "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: 9ed8239a-0b80-472b-9994-9d71ed2ebdb0
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "681c069f-0e74-452b-87f8-2e514e6c0924",
      "created_at": 1783014844.20963,
      "updated_at": 1783014845.030511,
      "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
      "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
      "docusign_id": "0bd9ee91-0146-4268-8230-f8f4094935b5",
      "status": "Sent",
      "title": "This envelope is sent automatically from our test suite",
      "webhook_token": "03b044be-763f-11f1-a9fa-76a72ce311da",
      "auto_notify": true,
      "owner": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
      "type": "envelope",
      "recipients": [
        {
          "id": "8b3fc797-e78f-4103-819b-b21fb44fcafb",
          "created_at": 1783014844.218745,
          "updated_at": 1783014844.218745,
          "signed_at": null,
          "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
          "status": "Created",
          "role": {
            "id": "558c7cf8-865b-4fcf-97ff-5586935734ec",
            "created_at": 1783014843.719387,
            "updated_at": 1783014843.719387,
            "deleted_at": null,
            "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
            "role": "BuyerAgent",
            "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
            "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": "12:54 PM - Thursday Jul 02, 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,
            "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": "71499061-9ad7-4d08-b4fa-9df3e56a4e0a",
          "created_at": 1783014844.220144,
          "updated_at": 1783014844.220144,
          "signed_at": null,
          "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
          "status": "Created",
          "role": {
            "id": "a2bb78cd-60b6-4bd4-8a20-913dea95bfbc",
            "created_at": 1783014843.722424,
            "updated_at": 1783014843.722424,
            "deleted_at": null,
            "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
            "role": "SellerAgent",
            "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
            "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": "12:54 PM - Thursday Jul 02, 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,
            "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": "9a6da746-1813-4197-9f84-987e1e79a3f8",
          "created_at": 1783014844.220836,
          "updated_at": 1783014844.220836,
          "signed_at": null,
          "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
          "status": "Created",
          "role": {
            "id": "558c7cf8-865b-4fcf-97ff-5586935734ec",
            "created_at": 1783014843.719387,
            "updated_at": 1783014843.719387,
            "deleted_at": null,
            "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
            "role": "BuyerAgent",
            "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
            "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": "12:54 PM - Thursday Jul 02, 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,
            "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": "9959cc70-f068-47f0-a16c-f0ea13f0bcec",
          "created_at": 1783014844.221496,
          "updated_at": 1783014844.221496,
          "signed_at": null,
          "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
          "status": "Created",
          "role": {
            "id": "a2bb78cd-60b6-4bd4-8a20-913dea95bfbc",
            "created_at": 1783014843.722424,
            "updated_at": 1783014843.722424,
            "deleted_at": null,
            "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
            "role": "SellerAgent",
            "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
            "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": "12:54 PM - Thursday Jul 02, 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,
            "brokerwolf_id": null,
            "brokerwolf_row_version": null,
            "legal_prefix": null,
            "legal_first_name": "Imaginary",
            "legal_middle_name": null,
            "legal_last_name": "Agent",
            "company_title": null,
            "commission_percentage": null,
            "email": "[email protected]",
            "phone_number": null,
            "checklist": null,
            "role_type": "Person",
            "agent": null,
            "old_current_address": null,
            "old_future_address": null,
            "office_name": null,
            "office_email": null,
            "office_phone": null,
            "office_fax": null,
            "office_license_number": null,
            "office_mls_id": null,
            "office_address": null,
            "searchable": "'agent':2 'imaginari':1 '[email protected]':3",
            "current_address": null,
            "future_address": null,
            "type": "deal_role",
            "mlsid": null,
            "legal_full_name": "Imaginary Agent"
          },
          "order": 1,
          "envelope_recipient_type": "CarbonCopy",
          "type": "envelope_recipient"
        }
      ],
      "documents": [
        {
          "id": "ae8d9c8f-c4db-4d26-ba1a-691ac9479c47",
          "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
          "title": "Addendum for Back-Up Contract.pdf",
          "document_id": 1,
          "submission_revision": "b901d67c-37d8-4670-8187-5d395f3c33f5",
          "file": null,
          "task": "5f5e379d-c820-4d29-ac8c-8d6201e83a77",
          "submission": "e1929158-b0fb-4135-988a-4953f092828f",
          "type": "envelope_document",
          "pdf": {
            "id": "bee5e2b9-2341-4582-a95b-0ed1f9974636",
            "created_at": 1783014845.062613,
            "updated_at": 1783014845.062613,
            "deleted_at": null,
            "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
            "path": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0/0431b620-763f-11f1-94b5-7519f45a456b.pdf",
            "name": "Addendum for Back-Up Contract.pdf.pdf",
            "public": false,
            "type": "file",
            "url": "https://private-cdn.irish.rechat.com/9ed8239a-0b80-472b-9994-9d71ed2ebdb0/0431b620-763f-11f1-94b5-7519f45a456b.pdf?Expires=1783101245066&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=Ddc5nZPO3nK9slErGtateLeL7sGZBw9nzD3lPGU3HDu3ftaLEg3AkavQygzz~chDwrNYCKIAZ6AVX-90p6iZSYwllwAdbKFqiKc~Jou6Vf2HsFLrZCZSYkL~QuT3Dpxwaov7RzOG6TxncpQi3vbPR4Kl4qAWyue40cXj~NxyLeFY0i~IDOgRAcMRaZs5lcKPZ7ZAyMHJ6yQGD5MGYOzhl9wLeXvixiCeZi1bEOmRlB5iju6fzHKJoCR~pNVQFoogrPWfg9ed57mFTREgIiJhtk9BgUM7kle~JwmTXkIRup0j1dVOlrH3NRIDo4K2225uDjFHHG1Pz9Lm~eB1ZSj4wQ__",
            "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: 681c069f-0e74-452b-87f8-2e514e6c0924
Request
HideShow
Body
{
  "status": "Voided"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "681c069f-0e74-452b-87f8-2e514e6c0924",
    "created_at": 1783014844.20963,
    "updated_at": 1783014845.378362,
    "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
    "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
    "docusign_id": "0bd9ee91-0146-4268-8230-f8f4094935b5",
    "status": "Voided",
    "title": "This envelope is sent automatically from our test suite",
    "webhook_token": "03b044be-763f-11f1-a9fa-76a72ce311da",
    "auto_notify": true,
    "owner": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
    "type": "envelope",
    "recipients": [
      {
        "id": "8b3fc797-e78f-4103-819b-b21fb44fcafb",
        "created_at": 1783014844.218745,
        "updated_at": 1783014844.218745,
        "signed_at": null,
        "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
        "status": "Created",
        "role": {
          "id": "558c7cf8-865b-4fcf-97ff-5586935734ec",
          "created_at": 1783014843.719387,
          "updated_at": 1783014843.719387,
          "deleted_at": null,
          "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
          "role": "BuyerAgent",
          "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
          "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": "12:54 PM - Thursday Jul 02, 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,
          "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": "71499061-9ad7-4d08-b4fa-9df3e56a4e0a",
        "created_at": 1783014844.220144,
        "updated_at": 1783014844.220144,
        "signed_at": null,
        "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
        "status": "Created",
        "role": {
          "id": "a2bb78cd-60b6-4bd4-8a20-913dea95bfbc",
          "created_at": 1783014843.722424,
          "updated_at": 1783014843.722424,
          "deleted_at": null,
          "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
          "role": "SellerAgent",
          "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
          "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": "12:54 PM - Thursday Jul 02, 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,
          "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": "9a6da746-1813-4197-9f84-987e1e79a3f8",
        "created_at": 1783014844.220836,
        "updated_at": 1783014844.220836,
        "signed_at": null,
        "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
        "status": "Created",
        "role": {
          "id": "558c7cf8-865b-4fcf-97ff-5586935734ec",
          "created_at": 1783014843.719387,
          "updated_at": 1783014843.719387,
          "deleted_at": null,
          "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
          "role": "BuyerAgent",
          "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
          "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": "12:54 PM - Thursday Jul 02, 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,
          "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": "9959cc70-f068-47f0-a16c-f0ea13f0bcec",
        "created_at": 1783014844.221496,
        "updated_at": 1783014844.221496,
        "signed_at": null,
        "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
        "status": "Created",
        "role": {
          "id": "a2bb78cd-60b6-4bd4-8a20-913dea95bfbc",
          "created_at": 1783014843.722424,
          "updated_at": 1783014843.722424,
          "deleted_at": null,
          "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
          "role": "SellerAgent",
          "deal": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0",
          "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": "12:54 PM - Thursday Jul 02, 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,
          "brokerwolf_id": null,
          "brokerwolf_row_version": null,
          "legal_prefix": null,
          "legal_first_name": "Imaginary",
          "legal_middle_name": null,
          "legal_last_name": "Agent",
          "company_title": null,
          "commission_percentage": null,
          "email": "[email protected]",
          "phone_number": null,
          "checklist": null,
          "role_type": "Person",
          "agent": null,
          "old_current_address": null,
          "old_future_address": null,
          "office_name": null,
          "office_email": null,
          "office_phone": null,
          "office_fax": null,
          "office_license_number": null,
          "office_mls_id": null,
          "office_address": null,
          "searchable": "'agent':2 'imaginari':1 '[email protected]':3",
          "current_address": null,
          "future_address": null,
          "type": "deal_role",
          "mlsid": null,
          "legal_full_name": "Imaginary Agent"
        },
        "order": 1,
        "envelope_recipient_type": "CarbonCopy",
        "type": "envelope_recipient"
      }
    ],
    "documents": [
      {
        "id": "ae8d9c8f-c4db-4d26-ba1a-691ac9479c47",
        "envelope": "681c069f-0e74-452b-87f8-2e514e6c0924",
        "title": "Addendum for Back-Up Contract.pdf",
        "document_id": 1,
        "submission_revision": "b901d67c-37d8-4670-8187-5d395f3c33f5",
        "file": null,
        "task": "5f5e379d-c820-4d29-ac8c-8d6201e83a77",
        "submission": "e1929158-b0fb-4135-988a-4953f092828f",
        "type": "envelope_document",
        "pdf": {
          "id": "bee5e2b9-2341-4582-a95b-0ed1f9974636",
          "created_at": 1783014845.062613,
          "updated_at": 1783014845.062613,
          "deleted_at": null,
          "created_by": "0efc43de-2c1d-4826-9acf-9a7157cdaaec",
          "path": "9ed8239a-0b80-472b-9994-9d71ed2ebdb0/0431b620-763f-11f1-94b5-7519f45a456b.pdf",
          "name": "Addendum for Back-Up Contract.pdf.pdf",
          "public": false,
          "type": "file",
          "url": "https://private-cdn.irish.rechat.com/9ed8239a-0b80-472b-9994-9d71ed2ebdb0/0431b620-763f-11f1-94b5-7519f45a456b.pdf?Expires=1783101245066&Key-Pair-Id=APKAIIRG223GKFAC4MHA&Signature=Ddc5nZPO3nK9slErGtateLeL7sGZBw9nzD3lPGU3HDu3ftaLEg3AkavQygzz~chDwrNYCKIAZ6AVX-90p6iZSYwllwAdbKFqiKc~Jou6Vf2HsFLrZCZSYkL~QuT3Dpxwaov7RzOG6TxncpQi3vbPR4Kl4qAWyue40cXj~NxyLeFY0i~IDOgRAcMRaZs5lcKPZ7ZAyMHJ6yQGD5MGYOzhl9wLeXvixiCeZi1bEOmRlB5iju6fzHKJoCR~pNVQFoogrPWfg9ed57mFTREgIiJhtk9BgUM7kle~JwmTXkIRup0j1dVOlrH3NRIDo4K2225uDjFHHG1Pz9Lm~eB1ZSj4wQ__",
          "preview_url": "http://assets.rechat.com/mimes/application-pdf.png",
          "mime": "application/pdf"
        }
      }
    ]
  }
}

Generated by aglio on 02 Jul 2026