Getting Started Authentication Document Workflows Resources What's New in API v2

API version:

Documents
Retrieve Documents and data

Metadata

:author:
  :name: RightSignature
  :contact: support@rightsignature.com
:last_modified: 6-14-2016

Supported Formats

json
>>>

GET /public/v2/documents
Return a list of available Documents

Supported Formats

json

Errors

Code Description
400 invalid_scope
400 unauthorized_client
401 Could not find resource owner
401 Resource owner is not entitled
401 invalid_token
401 Must be authenticated.
401 Unauthorized application.
422 Bad input parameter. Error message should indicate which one and why.

Examples

GET /public/{version}/documents
200
{
  "documents": [],
  "meta": {
    "total_pages": 0
  }
}

Params

Param name Description
search
optional

A search token.

Validations:

  • Must be a String
template_id
optional

Documents from a specific template

Validations:

  • Must be a String
state
optional

The document state filter. Must be one of valid document states or comma seperated list of states. Valid document states are: draft, pending, executed, voided, expired, declined, editing
per_page
optional

The number of documents included per page. Max is 100.
page
optional

Specific page of results

Validations:

  • Must be a number.
>>>

GET /public/v2/documents/:id
Return data for a specific Document

Supported Formats

json

Errors

Code Description
400 invalid_scope
400 unauthorized_client
422 Bad input parameter. Error message should indicate which one and why.
401 Can't find document.
401 Can't find user.
401 No ACLs tying user to document.

Examples

GET /public/{version}/documents/4840dd4f-2c13-4395-a0e0-3577d1eed6fd
200
{
  "document": {
    "id": "4840dd4f-2c13-4395-a0e0-3577d1eed6fd",
    "current_signer_id": "248883ae-a840-479f-8c2e-04de584019f9",
    "name": "Test",
    "filename": "application.pdf",
    "executed_at": null,
    "expired_at": "2018-06-06T08:23:28.116-07:00",
    "sent_at": "2018-05-07T08:23:28.085-07:00",
    "state": "pending",
    "kba": false,
    "thumbnail_url": "https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/thumbnail_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793008&Signature=TiNQ%2BM%2BQrvpdAZ%2FmB97Qp3RChXA%3D",
    "sender": {
      "id": "b907e7ae-50f5-4a55-aa2d-166ac96b289e",
      "name": "Dr. Amos Kuhn",
      "email": "santos@tillman.org",
      "signer": false
    },
    "recipients": [
      {
        "role_name": "signer2",
        "name": "Susie Orange",
        "email": "susie@citrix.com",
        "status": "pending",
        "id": "c76fad94-749b-495b-b088-c184282072e4",
        "sign_url": "https://secure.rs.dev:3000/signers/c76fad94-749b-495b-b088-c184282072e4/sign?access_token=GyBD2At_UrapgeDkyccx",
        "remind_url": "https://api.rs.dev:3002/public/{version}/signers/c76fad94-749b-495b-b088-c184282072e4/reminders",
        "message": "Please sign.",
        "sequence": 1
      },
      {
        "role_name": "signer1",
        "name": "Joe Tangerine",
        "email": "joe@citrix.com",
        "status": "pending",
        "id": "248883ae-a840-479f-8c2e-04de584019f9",
        "sign_url": "https://secure.rs.dev:3000/signers/248883ae-a840-479f-8c2e-04de584019f9/sign?access_token=esLoh2_8AB3qk17Jrpmy",
        "remind_url": "https://api.rs.dev:3002/public/{version}/signers/248883ae-a840-479f-8c2e-04de584019f9/reminders",
        "message": "Please sign.",
        "sequence": 0
      }
    ],
    "audits": [],
    "page_image_urls": [
      "https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/original_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793008&Signature=tOMSxHCGo2Dt63xebsIlF5mzHeE%3D"
    ],
    "signed_pdf_url": null,
    "tags": {},
    "merge_field_values": [],
    "form_fields": [
      {
        "id": "c46aeb88-48db-417b-94e6-222662f8a2d8",
        "name": "Date Field 1",
        "role": "signer1",
        "value": "04/13/2020",
        "page": 1
      },
      {
        "id": "78795207-6411-4344-9d95-48fe20fdddb1",
        "name": "Text Field 1",
        "role": "signer1",
        "value": "FooBar",
        "page": 1
      }
    ],
    "embed_codes": null,
    "in_person": false,
    "shared_with": [
      "test@test.com"
    ],
    "identity_method": "email",
    "passcode_pin_enabled": false,
    "original_file_url": "https://rightsign-development.s3.amazonaws.com/base_files/original/78d43ec7-cd6d-4c98-9b87-8cae71a907b5/application.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793008&Signature=Fv%2FmnWCp2mk%2BIVysk0SynrpR9uc%3D&response-content-disposition=attachment%3B%20filename%3Dapplication.pdf",
    "signature_certificate_url": "https://rightsign-development.s3.amazonaws.com/certificates/f234d07-8545-4695-af69-e5480b56ccd6/certificate.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1533237278&Signature=ejY5en2rPPXPRPWIo50gWnZK%2F70%3D&response-content-disposition=attachment%3B%20filename%3Dhealth_insurance-certificate.pdf",
    "merged_document_certificate_url": "https://rightsign-development.s3.amazonaws.com/merged_doc_certificate/c4a2d073-145c-4c6a-b697-7ebb6cb78ce/signed-certificate.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1571378681&Signature=oEL38fvoU3LhlghNg4ndHquLXtM%3D&response-content-disposition=attachment%3B%20filename%3Ddoc-builder-signed-certificate.pdf"
  }
}

Params

Param name Description
id
required

Document ID

Validations:

  • Must be a String
>>>

POST /public/v2/documents/:id/share
Share document. All old email recipients are removed.

Supported Formats

json

Errors

Code Description
400 invalid_scope
400 unauthorized_client
401 Can't find document.
401 Can't find user.
401 No ACLs tying user to document.
422 shared_with contains invalid email address

Examples

POST /public/{version}/documents/3831ebf2-8540-4269-bcd1-3981fa908bea/share
{
  "access_token": "a6c7d01bd1c06f24d1d40b1c1946c36762852068ed03aeb0668a4431366e1f8e",
  "shared_with": [
    "one@e.mail",
    "two@e.mail"
  ],
  "document": {}
}
200
{
  "document": {
    "id": "3831ebf2-8540-4269-bcd1-3981fa908bea",
    "current_signer_id": "4825c9b4-8f01-4bca-b2e7-8d7158d35388",
    "name": "Test",
    "filename": "application.pdf",
    "executed_at": null,
    "expired_at": "2018-06-06T08:23:29.323-07:00",
    "sent_at": "2018-05-07T08:23:29.307-07:00",
    "state": "pending",
    "thumbnail_url": "https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/thumbnail_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793009&Signature=j%2FKSG%2BHyxNiqJ5dJ3m9qSqDMvf8%3D",
    "sender": {
      "id": "433ec691-b661-4103-9721-e12a81f43ded",
      "name": "King Lind",
      "email": "alphonso@kihn.io",
      "signer": false
    },
    "recipients": [
      {
        "role_name": "signer2",
        "name": "Susie Orange",
        "email": "susie@citrix.com",
        "status": "pending",
        "id": "821e0abc-48d0-4ab5-9ea8-133a3dddfcf9",
        "sign_url": "https://secure.rs.dev:3000/signers/821e0abc-48d0-4ab5-9ea8-133a3dddfcf9/sign?access_token=yG2Pkkz3FvhuxKnPqNAf",
        "remind_url": "https://api.rs.dev:3002/public/{version}/signers/821e0abc-48d0-4ab5-9ea8-133a3dddfcf9/reminders",
        "message": "Please sign.",
        "sequence": 1
      },
      {
        "role_name": "signer1",
        "name": "Joe Tangerine",
        "email": "joe@citrix.com",
        "status": "pending",
        "id": "4825c9b4-8f01-4bca-b2e7-8d7158d35388",
        "sign_url": "https://secure.rs.dev:3000/signers/4825c9b4-8f01-4bca-b2e7-8d7158d35388/sign?access_token=VySRyWxzdsrh5mA7p88A",
        "remind_url": "https://api.rs.dev:3002/public/{version}/signers/4825c9b4-8f01-4bca-b2e7-8d7158d35388/reminders",
        "message": "Please sign.",
        "sequence": 0
      }
    ],
    "audits": [],
    "page_image_urls": [
      "https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/original_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793009&Signature=MhjGt7MiHDHwzEG4AdZ2vJTzKhg%3D"
    ],
    "signed_pdf_url": null,
    "tags": {},
    "merge_field_values": [],
    "embed_codes": null,
    "in_person": false,
    "shared_with": [
      "one@e.mail",
      "two@e.mail"
    ],
    "identity_method": "email",
    "passcode_pin_enabled": false,
    "original_file_url": "https://rightsign-development.s3.amazonaws.com/base_files/original/59748f53-c244-4c05-8a42-a325e0570bf3/application.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793009&Signature=Xc6dIN5FsZAKVpCF8anl91Zt0cI%3D&response-content-disposition=attachment%3B%20filename%3Dapplication.pdf"
  }
}

Params

Param name Description
shared_with
required

List of email recipients to share the document with
>>>

POST /public/v2/documents/:id/update_tags
Update the tags on a given document. All old tags are removed.

Supported Formats

json

Errors

Code Description
400 invalid_scope
400 unauthorized_client
401 Can't find document.
401 Can't find user.
401 No ACLs tying user to document.
422 Hash contains empty keys

Examples

POST /public/{version}/documents/8e6f2e54-dd6e-4a7a-97bc-cf00ee042e5b/update_tags
{
  "access_token": "f60307b600e8bd2dfaba3a106d54bfbbfd0782cf9d819e27bce9d2fd7cb65226",
  "tags": {
    "testing": "one",
    "single": null
  },
  "document": {
    "tags": {
      "testing": "one",
      "single": null
    }
  }
}
200
{
  "document": {
    "id": "8e6f2e54-dd6e-4a7a-97bc-cf00ee042e5b",
    "current_signer_id": "e33b0297-9896-4d29-8257-926ecc973da8",
    "name": "Test",
    "filename": "application.pdf",
    "executed_at": null,
    "expired_at": "2018-06-06T08:23:29.880-07:00",
    "sent_at": "2018-05-07T08:23:29.861-07:00",
    "state": "pending",
    "thumbnail_url": "https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/thumbnail_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793010&Signature=ZzZMm4z8qO2nyp2CeIcwae6TJXY%3D",
    "sender": {
      "id": "a0068e99-8b25-4f43-ad2f-0fd4f06aac9d",
      "name": "Remington Lubowitz",
      "email": "lon@carroll.co",
      "signer": false
    },
    "recipients": [
      {
        "role_name": "signer2",
        "name": "Susie Orange",
        "email": "susie@citrix.com",
        "status": "pending",
        "id": "cb6f89ab-181f-485e-8d51-eadff36dbd71",
        "sign_url": "https://secure.rs.dev:3000/signers/cb6f89ab-181f-485e-8d51-eadff36dbd71/sign?access_token=xKTvz4bynLVoBHrNnLRx",
        "remind_url": "https://api.rs.dev:3002/public/{version}/signers/cb6f89ab-181f-485e-8d51-eadff36dbd71/reminders",
        "message": "Please sign.",
        "sequence": 1
      },
      {
        "role_name": "signer1",
        "name": "Joe Tangerine",
        "email": "joe@citrix.com",
        "status": "pending",
        "id": "e33b0297-9896-4d29-8257-926ecc973da8",
        "sign_url": "https://secure.rs.dev:3000/signers/e33b0297-9896-4d29-8257-926ecc973da8/sign?access_token=SBH7ZiLa3D4kZRahjTE6",
        "remind_url": "https://api.rs.dev:3002/public/{version}/signers/e33b0297-9896-4d29-8257-926ecc973da8/reminders",
        "message": "Please sign.",
        "sequence": 0
      }
    ],
    "audits": [],
    "page_image_urls": [
      "https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/original_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793010&Signature=xdXJz%2F7TzDSzGI3FmGnJ2FQHNQI%3D"
    ],
    "signed_pdf_url": null,
    "tags": {
      "testing": "one",
      "single": null
    },
    "merge_field_values": [],
    "embed_codes": null,
    "in_person": false,
    "shared_with": [
      "test@test.com"
    ],
    "identity_method": "email",
    "passcode_pin_enabled": false,
    "original_file_url": "https://rightsign-development.s3.amazonaws.com/base_files/original/5b73cc43-0f3f-4f2f-9b02-a617fa6b1f72/application.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793010&Signature=F5WeH34v5jPGbrtVEe96D%2F%2FPXMw%3D&response-content-disposition=attachment%3B%20filename%3Dapplication.pdf"
  }
}

Params

Param name Description
tags
required

Key value tags for categorization
>>>

POST /public/v2/documents/:id/void
Void a Document

Supported Formats

json

Errors

Code Description
400 invalid_scope
400 unauthorized_client
422 Bad input parameter. Error message should indicate which one and why.
401 Can't find document.
401 Can't find user.
401 No ACLs tying user to document.
401 Cannot void a document that is not pending or draft.

Examples

POST /public/{version}/documents/e1858e4b-a378-40b3-b505-ad7ce18aa11f/void
{
  "document": {}
}
200
{
  "document": {
    "status": "Voided draft document."
  }
}
>>>

PUT /public/v2/documents/:id/update_pin
Updates the document PIN

Supported Formats

json

Errors

Code Description
400 invalid_scope
400 unauthorized_client
401 Can't find document.
401 Can't find user.
401 No ACLs tying user to document.
422 Hash contains empty keys

Examples

POST /public/{version}/documents/37f8bf7f-b57a-4774-998a-cbf7a8cd8367/update_pin
{
  "access_token": "bec095efd15e463077ae678b4a6ac4d3b07961be58d7f8e1216a573c3be71aaf",
  "pin": "12345",
  "document": {}
}
200
{
  "document": {
    "id": "37f8bf7f-b57a-4774-998a-cbf7a8cd8367",
    "current_signer_id": "f55f6dfc-2acd-488f-a386-9e5b98ed5a11",
    "name": "Test",
    "filename": "application.pdf",
    "executed_at": null,
    "expired_at": "2018-06-06T08:23:30.517-07:00",
    "sent_at": "2018-05-07T08:23:30.493-07:00",
    "state": "pending",
    "thumbnail_url": "https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/thumbnail_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793010&Signature=ZzZMm4z8qO2nyp2CeIcwae6TJXY%3D",
    "sender": {
      "id": "bb1853a5-6e20-49d0-80fd-618b4743639b",
      "name": "Elizabeth Sauer",
      "email": "kaylee@daniel.biz",
      "signer": false
    },
    "recipients": [
      {
        "role_name": "signer2",
        "name": "Susie Orange",
        "email": "susie@citrix.com",
        "status": "pending",
        "id": "4ab3c881-3654-4e45-a889-a972a803bca8",
        "sign_url": "https://secure.rs.dev:3000/signers/4ab3c881-3654-4e45-a889-a972a803bca8/sign?access_token=n1zQmxzV3qbcoU4kmP-n",
        "remind_url": "https://api.rs.dev:3002/public/{version}/signers/4ab3c881-3654-4e45-a889-a972a803bca8/reminders",
        "message": "Please sign.",
        "sequence": 1
      },
      {
        "role_name": "signer1",
        "name": "Joe Tangerine",
        "email": "joe@citrix.com",
        "status": "pending",
        "id": "f55f6dfc-2acd-488f-a386-9e5b98ed5a11",
        "sign_url": "https://secure.rs.dev:3000/signers/f55f6dfc-2acd-488f-a386-9e5b98ed5a11/sign?access_token=nys8UFjgFrPoypgD5oYf",
        "remind_url": "https://api.rs.dev:3002/public/{version}/signers/f55f6dfc-2acd-488f-a386-9e5b98ed5a11/reminders",
        "message": "Please sign.",
        "sequence": 0
      }
    ],
    "audits": [],
    "page_image_urls": [
      "https://rightsign-development.s3.amazonaws.com/base_files/processed/b4cbbcd26be61d830bace968d28bad7c1046c1f759a5f40b7e01da4fbccac152_123_0_wi/original_p1.png?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793010&Signature=xdXJz%2F7TzDSzGI3FmGnJ2FQHNQI%3D"
    ],
    "signed_pdf_url": null,
    "tags": {},
    "merge_field_values": [],
    "embed_codes": null,
    "in_person": false,
    "shared_with": [
      "test@test.com"
    ],
    "identity_method": "email",
    "passcode_pin_enabled": false,
    "original_file_url": "https://rightsign-development.s3.amazonaws.com/base_files/original/eb29e5cf-e952-4904-91b3-9a554d68b963/application.pdf?AWSAccessKeyId=AKIAJSRMQNOZ6XOBJZ4A&Expires=1525793010&Signature=0e49QufHCocBjl3AuN%2FUSwD%2B0Qw%3D&response-content-disposition=attachment%3B%20filename%3Dapplication.pdf"
  }
}

Params

Param name Description
pin
required

Document pin. Must be between 10000 and 99999