Get order side letter

Returns the order's side letter status and the files of its latest version.

status is one of NOT_STARTED, IN_NEGOTIATION, AGREED, PENDING_SIGNATURE, SIGNED and COMPLETED, the same values as the GraphQL SideLetterStatus enum. An order whose side letter has not started returns NOT_STARTED with no latestVersion.

files lists the same files the app shows in the side letter's file list:

  • A file that was never e-signed appears as itself.
  • A file that was e-signed appears only as its newest signed copy. Its relatedFiles hold the rest of its signing history, newest first: for each signing round, the round's signing certificate, then the copy that round signed, ending with the original upload.

Each file has a type: DOCUMENT for an uploaded file, E_SIGNED for a copy produced by an e-signature, and CERTIFICATE for a signing certificate. tag is SIGNED_OFFLINE or FULLY_EXECUTED when the file was uploaded as signed, and is absent otherwise.

uploadedBy is always set: it is the account that created the file in Anduin. For an e-signed copy or a certificate this is not always the person who signed, for example a DocuSign certificate names the envelope's first recipient.

Every fileId works with GetFileDownloadUrl.

Returns 403 when the service account cannot access the order's side letter, and 400 when side letters are not enabled for the fund. To be told about changes, subscribe to the fundsub.order.side_letter.status.updated webhook. Side letter files are also reported by fundsub.order.document.uploaded with documentType SIDE_LETTER.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The Anduin ID of the Order object, or your custom ID

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json