RightSignature

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/v1/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",
    "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/v1/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/v1/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": [],
    "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"
  }
}

Params

Param name Description
id
required

Document ID

Validations:

  • Must be a String