---
title: "DocumentResponse"
url: "https://devportal.jilson.dev/apis/document-generator-pkce-flow-1/versions/c7bf5731-4982-4310-bcfe-512415c7d543/schemas/DocumentResponse"
---

> Full API specification: https://devportal.jilson.dev/apis/document-generator-pkce-flow-1/versions/c7bf5731-4982-4310-bcfe-512415c7d543.md

# DocumentResponse

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Document Generator API
  version: "1.0"
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: string
          nullable: true
        firstName:
          type: string
          nullable: true
        lastName:
          type: string
          nullable: true
        emailAddress:
          type: string
          nullable: true
      additionalProperties: false
    File:
      type: object
      properties:
        fileRID:
          type: string
          nullable: true
        fileContainerRID:
          type: string
          nullable: true
        fileId:
          type: string
          nullable: true
        fileName:
          type: string
          nullable: true
        eTag:
          type: string
          nullable: true
        fileSource:
          $ref: "#/components/schemas/FileSource"
        shareFileStreamId:
          type: string
          nullable: true
        createdById:
          type: string
          nullable: true
        createdOnUtc:
          type: string
          format: date-time
        deletedOnUtc:
          type: string
          format: date-time
          nullable: true
        deletedById:
          type: string
          nullable: true
      additionalProperties: false
    Role:
      type: object
      properties:
        id:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        sequence:
          type: integer
          format: int32
        isSender:
          type: boolean
      additionalProperties: false
    Field:
      type: object
      properties:
        id:
          type: string
          nullable: true
        type:
          $ref: "#/components/schemas/FieldType"
        x:
          type: number
          format: double
          nullable: true
        y:
          type: number
          format: double
          nullable: true
        height:
          type: number
          format: double
          nullable: true
        width:
          type: number
          format: double
          nullable: true
        isRequired:
          type: boolean
          nullable: true
        groupRequirement:
          $ref: "#/components/schemas/GroupRequirement"
        fontSize:
          type: integer
          format: int32
          nullable: true
        multiline:
          type: boolean
          nullable: true
        transparent:
          type: boolean
          nullable: true
        textAlign:
          $ref: "#/components/schemas/TextAlignment"
        selectOptions:
          type: array
          items:
            type: string
          nullable: true
        chargeAfterExecuted:
          type: boolean
          nullable: true
        paymentAmount:
          type: integer
          format: int32
          nullable: true
        helpText:
          type: string
          nullable: true
        page:
          type: integer
          format: int32
          nullable: true
        name:
          type: string
          nullable: true
        isDateSigned:
          type: boolean
          nullable: true
        dateFormat:
          type: string
          nullable: true
        signatureImage:
          type: string
          nullable: true
        signatureText:
          type: string
          nullable: true
        signatureType:
          $ref: "#/components/schemas/SignatureType"
        signatureJsonData:
          type: string
          nullable: true
        groupId:
          type: string
          nullable: true
        signatureId:
          type: string
          nullable: true
        assignedTo:
          $ref: "#/components/schemas/Role"
        dataPreFilledType:
          $ref: "#/components/schemas/DataPreFilledType"
        variableId:
          type: string
          nullable: true
        attributePath:
          type: string
          nullable: true
        value:
          type: string
          nullable: true
        fullyQualifiedPath:
          type: string
          nullable: true
      additionalProperties: false
    DocumentSettings:
      type: object
      properties:
        isKbaEnabled:
          type: boolean
          nullable: true
        isPasscodeEnabled:
          type: boolean
          nullable: true
      additionalProperties: false
    SignatureSettings:
      type: object
      properties:
        expiresInDays:
          type: integer
          format: int32
          nullable: true
        storageLocation:
          type: string
          nullable: true
        signerMessage:
          type: string
          nullable: true
        passcode:
          type: string
          nullable: true
        recipients:
          type: array
          items:
            $ref: "#/components/schemas/Recipient"
          nullable: true
      additionalProperties: false
    Variable:
      type: object
      properties:
        id:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        provider:
          type: string
          nullable: true
        entity:
          type: string
          nullable: true
        connectionRID:
          type: string
          nullable: true
        entityId:
          type: string
          nullable: true
        version:
          type: string
          nullable: true
      additionalProperties: false
    FileSource:
      enum:
        - ShareFile
        - Base64String
        - RemoteUrl
      type: string
    FieldType:
      enum:
        - SignatureComponent
        - InitialsComponent
        - DateComponent
        - TextComponent
        - SelectComponent
        - CheckComponent
        - CheckGroupComponent
        - AttachmentComponent
        - SignatureAnnotationComponent
        - TextAnnotationComponent
        - CheckmarkAnnotationComponent
        - PaymentComponent
      type: string
    GroupRequirement:
      enum:
        - OnlyOne
        - OneOrMore
      type: string
    TextAlignment:
      enum:
        - Left
        - Right
        - Center
      type: string
    SignatureType:
      enum:
        - Typed
        - Drawn
      type: string
    DataPreFilledType:
      enum:
        - None
        - Manual
        - SourceMapped
      type: string
    Recipient:
      type: object
      properties:
        name:
          type: string
          nullable: true
        email:
          type: string
          nullable: true
        roleId:
          type: string
          nullable: true
      additionalProperties: false
    DocumentResponse:
      type: object
      properties:
        rid:
          type: string
          nullable: true
        containerRID:
          type: string
          nullable: true
        templateRID:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        creator:
          $ref: "#/components/schemas/User"
        parentId:
          type: string
          nullable: true
        accountId:
          type: string
          nullable: true
        file:
          $ref: "#/components/schemas/File"
        roles:
          type: array
          items:
            $ref: "#/components/schemas/Role"
          nullable: true
        fields:
          type: array
          items:
            $ref: "#/components/schemas/Field"
          nullable: true
        settings:
          $ref: "#/components/schemas/DocumentSettings"
        signatureSettings:
          $ref: "#/components/schemas/SignatureSettings"
        signerSequencing:
          type: boolean
          nullable: true
        createdAt:
          type: string
          format: date-time
          nullable: true
        updatedAt:
          type: string
          format: date-time
          nullable: true
        variables:
          type: array
          items:
            $ref: "#/components/schemas/Variable"
          nullable: true
      additionalProperties: false
```