v3

latestSwagger 2.02026-08-067506752.0 MB

signature-request

Retrieve an individual signature request on an existing file

get/v1/org/{orgId}/signature-request/file/{fileId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

fileIdstring required

File identifier

Response

successful operation

idstring required

globally unique id of signature request

orgIdstring required

parent org id

fileIdstring required

file id that is being signed

fileVersionIdstring

file version id that is being signed

fileHashstring required

SHA-256 hash of the contents of the file

fileTemplateIdstring

template id that was used to generate the file, if applicable

externalIdstring

external id, if an external signature service is used

externalServicestring

external signature service name (e.g. boldsign)

standard'QES'

signature standard used, defaults to SES if not specified

fileEntityIdstring required

the entity that stores the signed file

fileEntityType'PERSON' | 'USER' | 'ORG' required

the entity that stores the signed file

status'PENDING' | 'SIGNED' | 'DECLINED' | 'CANCELED' required

the overall status of this signature request

requestAtstring required

the timestamp that the request was made

requestUserIdstring required

the user who made the request to sign

notifyUserIdsstring[]

additional user ids to notify on signature events

signAtstring

the timestamp that it was signed, if it was signed

cancelAtstring

the timestamp that it was canceled, if it was canceled

declineAtstring

the timestamp that it was declined, if it was declined

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "fileId": "588f7ee98f138b19220041a7",
  "fileVersionId": "588f7ee98f138b19220041a7",
  "fileTemplateId": "588f7ee98f138b19220041a7",
  "fileEntityId": "588f7ee98f138b19220041a7",
  "signers": [
    {
      "userId": "588f7ee98f138b19220041a7"
    }
  ],
  "requestUserId": "588f7ee98f138b19220041a7",
  "notifyUserIds": [
    "588f7ee98f138b19220041a7"
  ],
  "createId": "588f7ee98f138b19220041a7",
  "createBehalfId": "588f7ee98f138b19220041a7",
  "createAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateBehalfId": "588f7ee98f138b19220041a7",
  "updateAttribution": {
    "principalUserId": "588f7ee98f138b19220041a7",
    "agentUserIds": [
      "588f7ee98f138b19220041a7"
    ],
    "eventId": "588f7ee98f138b19220041a7",
    "aiChatId": "588f7ee98f138b19220041a7"
  },
  "updateAt": "2017-01-24T13:57:52Z"
}