Skip to content

Latest commit

 

History

History
52 lines (46 loc) · 11.6 KB

recipientcreatedocumentrecipientresponsebody.md

File metadata and controls

52 lines (46 loc) · 11.6 KB

RecipientCreateDocumentRecipientResponseBody

Successful response

Example Usage

import { RecipientCreateDocumentRecipientResponseBody } from "@documenso/sdk-typescript/models/operations";

let value: RecipientCreateDocumentRecipientResponseBody = {
  role: "SIGNER",
  readStatus: "OPENED",
  signingStatus: "NOT_SIGNED",
  sendStatus: "SENT",
  id: 230571,
  documentId: 268709,
  templateId: 800256,
  email: "[email protected]",
  name: "<value>",
  token: "<value>",
  documentDeletedAt: "<value>",
  expired: "<value>",
  signedAt: "<value>",
  authOptions: {
    accessAuth: "ACCOUNT",
    actionAuth: "PASSKEY",
  },
  signingOrder: 8927.08,
  rejectionReason: "<value>",
};

Fields

Field Type Required Description
role operations.RecipientCreateDocumentRecipientDocumentsRecipientsRole ✔️ N/A
readStatus operations.RecipientCreateDocumentRecipientReadStatus ✔️ N/A
signingStatus operations.RecipientCreateDocumentRecipientSigningStatus ✔️ N/A
sendStatus operations.RecipientCreateDocumentRecipientSendStatus ✔️ N/A
id number ✔️ N/A
documentId number ✔️ N/A
templateId number ✔️ N/A
email string ✔️ N/A
name string ✔️ N/A
token string ✔️ N/A
documentDeletedAt string ✔️ N/A
expired string ✔️ N/A
signedAt string ✔️ N/A
authOptions operations.RecipientCreateDocumentRecipientAuthOptions ✔️ N/A
signingOrder number ✔️ The order in which the recipient should sign the document. Only works if the document is set to sequential signing.
rejectionReason string ✔️ N/A