openapi: 3.0.3
info:
  title: 'fino.sign API v1'
  description: 'REST-API documentation of fino.sign API v1'
  version: 1.0.0
servers:
  -
    url: 'https://api.finosign.de'
paths:
  /v1/signatures:
    get:
      summary: 'List all signatures'
      operationId: listAllSignatures
      description: 'List all signatures created by the authenticated app.'
      parameters:
        -
          in: query
          name: page
          description: 'Page number. Defaults to `1`'
          example: 23
          required: false
          schema:
            type: string
            description: 'Page number. Defaults to `1`'
            example: 23
        -
          in: query
          name: sort
          description: "   Sort the result according to the provided fields. Prepend '-' to sort in descending order. Defaults to `created_at`.\n\n   Allowed sorting fields are: `created_at, updated_at`"
          example: 'created_at,updated_at'
          required: false
          schema:
            type: string
            description: "   Sort the result according to the provided fields. Prepend '-' to sort in descending order. Defaults to `created_at`.\n\n   Allowed sorting fields are: `created_at, updated_at`"
            example: 'created_at,updated_at'
      responses:
        200:
          description: 'An array containing the signatures of this page. Limited to 20 signatures per page.'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 7BcBmWTFqlBp
                      quality: SES
                      status: preparation
                      withdraw_reason: null
                      title: null
                      webhook_url: null
                      created_at: '2024-10-17T09:37:08.000000Z'
                      updated_at: '2024-10-17T09:37:08.000000Z'
                      signers:
                        -
                          id: CZX4DbC8ZDze
                          order: 1
                          title: null
                          firstname: Ana
                          lastname: Hagenes
                          fullname: 'Ana Hagenes'
                          email: casandra.gleichner@example.org
                          mobile_number: null
                          status: signed
                          decline_reason: null
                          signing_url: 'https://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/hEOY8PaAPo'
                          redirect_url_success: null
                          redirect_url_error: null
                          redirect_url_declined: null
                          certificate_serial_number: d65ffc
                          certificate_fingerprint: 146213f58062a2404589f3cf6992448259cf079c4e951d9af0da89dcc5979c48
                          created_at: '2024-10-17T09:37:08.000000Z'
                          updated_at: '2024-10-17T09:37:08.000000Z'
                        -
                          id: orsdB8j5FEi6
                          order: 1
                          title: null
                          firstname: Royal
                          lastname: Dach
                          fullname: 'Royal Dach'
                          email: justina12@example.net
                          mobile_number: null
                          status: open
                          decline_reason: null
                          signing_url: 'https://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/gJFvnRTplL'
                          redirect_url_success: null
                          redirect_url_error: null
                          redirect_url_declined: null
                          certificate_serial_number: 9eb60902990b80b0ece1e0d2b8f62f70f6
                          certificate_fingerprint: 669f8d74813f9a779c25ab1f90fb58c44407a5244423d6984250a19a2c71d112
                          created_at: '2024-10-17T09:37:08.000000Z'
                          updated_at: '2024-10-17T09:37:08.000000Z'
                    -
                      id: Uy3Vfi_EP6DH
                      quality: SES
                      status: preparation
                      withdraw_reason: null
                      title: null
                      webhook_url: null
                      created_at: '2024-10-17T09:37:08.000000Z'
                      updated_at: '2024-10-17T09:37:08.000000Z'
                      signers:
                        -
                          id: XpdKynzTyCcT
                          order: 1
                          title: null
                          firstname: Hollis
                          lastname: Conn
                          fullname: 'Hollis Conn'
                          email: ekuhlman@example.com
                          mobile_number: null
                          status: open
                          decline_reason: null
                          signing_url: 'https://api.finosign.de/v1/signatures/Uy3Vfi_EP6DH/sign/uSxydcKKsu'
                          redirect_url_success: null
                          redirect_url_error: null
                          redirect_url_declined: null
                          certificate_serial_number: b03bb1581f
                          certificate_fingerprint: 8bb12c697a102d58ba6880d00a5bc2730c7530e0dd152a128ba7930426e1dc55
                          created_at: '2024-10-17T09:37:08.000000Z'
                          updated_at: '2024-10-17T09:37:08.000000Z'
                        -
                          id: WFqqQYG5hLOo
                          order: 1
                          title: null
                          firstname: Roderick
                          lastname: Fisher
                          fullname: 'Roderick Fisher'
                          email: mertz.israel@example.org
                          mobile_number: null
                          status: open
                          decline_reason: null
                          signing_url: 'https://api.finosign.de/v1/signatures/Uy3Vfi_EP6DH/sign/VAv5WSHBkG'
                          redirect_url_success: null
                          redirect_url_error: null
                          redirect_url_declined: null
                          certificate_serial_number: b0781063
                          certificate_fingerprint: 0dec6d1e9dee9ec7bd1032ff880f7843b6782410dbc731a9d4b150ebbbe57e12
                          created_at: '2024-10-17T09:37:08.000000Z'
                          updated_at: '2024-10-17T09:37:08.000000Z'
                  links:
                    first: '/?page=1'
                    last: null
                    prev: null
                    next: null
                  meta:
                    current_page: 1
                    from: 1
                    path: /
                    per_page: 20
                    to: 2
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 7BcBmWTFqlBp
                        quality: SES
                        status: preparation
                        withdraw_reason: null
                        title: null
                        webhook_url: null
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                        signers:
                          -
                            id: CZX4DbC8ZDze
                            order: 1
                            title: null
                            firstname: Ana
                            lastname: Hagenes
                            fullname: 'Ana Hagenes'
                            email: casandra.gleichner@example.org
                            mobile_number: null
                            status: signed
                            decline_reason: null
                            signing_url: 'https://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/hEOY8PaAPo'
                            redirect_url_success: null
                            redirect_url_error: null
                            redirect_url_declined: null
                            certificate_serial_number: d65ffc
                            certificate_fingerprint: 146213f58062a2404589f3cf6992448259cf079c4e951d9af0da89dcc5979c48
                            created_at: '2024-10-17T09:37:08.000000Z'
                            updated_at: '2024-10-17T09:37:08.000000Z'
                          -
                            id: orsdB8j5FEi6
                            order: 1
                            title: null
                            firstname: Royal
                            lastname: Dach
                            fullname: 'Royal Dach'
                            email: justina12@example.net
                            mobile_number: null
                            status: open
                            decline_reason: null
                            signing_url: 'https://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/gJFvnRTplL'
                            redirect_url_success: null
                            redirect_url_error: null
                            redirect_url_declined: null
                            certificate_serial_number: 9eb60902990b80b0ece1e0d2b8f62f70f6
                            certificate_fingerprint: 669f8d74813f9a779c25ab1f90fb58c44407a5244423d6984250a19a2c71d112
                            created_at: '2024-10-17T09:37:08.000000Z'
                            updated_at: '2024-10-17T09:37:08.000000Z'
                      -
                        id: Uy3Vfi_EP6DH
                        quality: SES
                        status: preparation
                        withdraw_reason: null
                        title: null
                        webhook_url: null
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                        signers:
                          -
                            id: XpdKynzTyCcT
                            order: 1
                            title: null
                            firstname: Hollis
                            lastname: Conn
                            fullname: 'Hollis Conn'
                            email: ekuhlman@example.com
                            mobile_number: null
                            status: open
                            decline_reason: null
                            signing_url: 'https://api.finosign.de/v1/signatures/Uy3Vfi_EP6DH/sign/uSxydcKKsu'
                            redirect_url_success: null
                            redirect_url_error: null
                            redirect_url_declined: null
                            certificate_serial_number: b03bb1581f
                            certificate_fingerprint: 8bb12c697a102d58ba6880d00a5bc2730c7530e0dd152a128ba7930426e1dc55
                            created_at: '2024-10-17T09:37:08.000000Z'
                            updated_at: '2024-10-17T09:37:08.000000Z'
                          -
                            id: WFqqQYG5hLOo
                            order: 1
                            title: null
                            firstname: Roderick
                            lastname: Fisher
                            fullname: 'Roderick Fisher'
                            email: mertz.israel@example.org
                            mobile_number: null
                            status: open
                            decline_reason: null
                            signing_url: 'https://api.finosign.de/v1/signatures/Uy3Vfi_EP6DH/sign/VAv5WSHBkG'
                            redirect_url_success: null
                            redirect_url_error: null
                            redirect_url_declined: null
                            certificate_serial_number: b0781063
                            certificate_fingerprint: 0dec6d1e9dee9ec7bd1032ff880f7843b6782410dbc731a9d4b150ebbbe57e12
                            created_at: '2024-10-17T09:37:08.000000Z'
                            updated_at: '2024-10-17T09:37:08.000000Z'
                    description: 'An array containing the signatures of this page. Limited to 20 signatures per page.'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 7BcBmWTFqlBp
                        quality:
                          type: string
                          example: SES
                        status:
                          type: string
                          example: preparation
                        withdraw_reason:
                          type: string
                          example: null
                        title:
                          type: string
                          example: null
                        webhook_url:
                          type: string
                          example: null
                        created_at:
                          type: string
                          example: '2024-10-17T09:37:08.000000Z'
                        updated_at:
                          type: string
                          example: '2024-10-17T09:37:08.000000Z'
                        signers:
                          type: array
                          example:
                            -
                              id: CZX4DbC8ZDze
                              order: 1
                              title: null
                              firstname: Ana
                              lastname: Hagenes
                              fullname: 'Ana Hagenes'
                              email: casandra.gleichner@example.org
                              mobile_number: null
                              status: signed
                              decline_reason: null
                              signing_url: 'https://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/hEOY8PaAPo'
                              redirect_url_success: null
                              redirect_url_error: null
                              redirect_url_declined: null
                              certificate_serial_number: d65ffc
                              certificate_fingerprint: 146213f58062a2404589f3cf6992448259cf079c4e951d9af0da89dcc5979c48
                              created_at: '2024-10-17T09:37:08.000000Z'
                              updated_at: '2024-10-17T09:37:08.000000Z'
                            -
                              id: orsdB8j5FEi6
                              order: 1
                              title: null
                              firstname: Royal
                              lastname: Dach
                              fullname: 'Royal Dach'
                              email: justina12@example.net
                              mobile_number: null
                              status: open
                              decline_reason: null
                              signing_url: 'https://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/gJFvnRTplL'
                              redirect_url_success: null
                              redirect_url_error: null
                              redirect_url_declined: null
                              certificate_serial_number: 9eb60902990b80b0ece1e0d2b8f62f70f6
                              certificate_fingerprint: 669f8d74813f9a779c25ab1f90fb58c44407a5244423d6984250a19a2c71d112
                              created_at: '2024-10-17T09:37:08.000000Z'
                              updated_at: '2024-10-17T09:37:08.000000Z'
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: CZX4DbC8ZDze
                              order:
                                type: integer
                                example: 1
                              title:
                                type: string
                                example: null
                              firstname:
                                type: string
                                example: Ana
                              lastname:
                                type: string
                                example: Hagenes
                              fullname:
                                type: string
                                example: 'Ana Hagenes'
                              email:
                                type: string
                                example: casandra.gleichner@example.org
                              mobile_number:
                                type: string
                                example: null
                              status:
                                type: string
                                example: signed
                              decline_reason:
                                type: string
                                example: null
                              signing_url:
                                type: string
                                example: 'https://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/hEOY8PaAPo'
                              redirect_url_success:
                                type: string
                                example: null
                              redirect_url_error:
                                type: string
                                example: null
                              redirect_url_declined:
                                type: string
                                example: null
                              certificate_serial_number:
                                type: string
                                example: d65ffc
                              certificate_fingerprint:
                                type: string
                                example: 146213f58062a2404589f3cf6992448259cf079c4e951d9af0da89dcc5979c48
                              created_at:
                                type: string
                                example: '2024-10-17T09:37:08.000000Z'
                              updated_at:
                                type: string
                                example: '2024-10-17T09:37:08.000000Z'
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                        example: '/?page=1'
                        description: 'Link to the first page'
                      last:
                        type: string
                        example: null
                        description: 'Link to the last page'
                      prev:
                        type: string
                        example: null
                        description: 'Link to the previous page'
                      next:
                        type: string
                        example: null
                        description: 'Link to the next page'
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                        description: 'The current page'
                      from:
                        type: integer
                        example: 1
                        description: 'First item number in the current page (starting at 1)'
                      path:
                        type: string
                        example: /
                        description: 'The URL path that returns this pagination'
                      per_page:
                        type: integer
                        example: 20
                        description: 'The amount of items per page'
                      to:
                        type: integer
                        example: 2
                        description: 'The last item number in the current page'
      tags:
        - Signatures
    post:
      summary: 'Create signature'
      operationId: createSignature
      description: 'Create a new signature for starting a new signing process.'
      parameters: []
      responses:
        201:
          description: 'The created signature resource.'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: Cz7wWKv4ose9
                    quality: SES
                    status: preparation
                    withdraw_reason: null
                    title: null
                    webhook_url: null
                    created_at: '2024-10-17T09:37:08.000000Z'
                    updated_at: '2024-10-17T09:37:08.000000Z'
                    signers:
                      -
                        id: pTG41YEDE8bk
                        order: 1
                        title: null
                        firstname: Josiane
                        lastname: Schulist
                        fullname: 'Josiane Schulist'
                        email: fay.kane@example.org
                        mobile_number: null
                        status: signed
                        decline_reason: null
                        signing_url: 'http://api.finosign.de/v1/signatures/Cz7wWKv4ose9/sign/b7ejQZ2RZe'
                        redirect_url_success: null
                        redirect_url_error: null
                        redirect_url_declined: null
                        certificate_serial_number: 286d1184487d
                        certificate_fingerprint: 3e7320b60d3949f6b1a24ed3ac82b289fd9bdd8d0969ea6f455b9b0fb33c8285
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                      -
                        id: 6KiAliy0qCZX
                        order: 1
                        title: null
                        firstname: Jordi
                        lastname: Robel
                        fullname: 'Jordi Robel'
                        email: loren.schmidt@example.net
                        mobile_number: null
                        status: open
                        decline_reason: null
                        signing_url: 'http://api.finosign.de/v1/signatures/Cz7wWKv4ose9/sign/EFtPddjnJw'
                        redirect_url_success: null
                        redirect_url_error: null
                        redirect_url_declined: null
                        certificate_serial_number: 1622e23992d4208a4e6a336e0db5b82b1834eac1
                        certificate_fingerprint: f8096ea83498f4186aeadea6cd08e026d5c806bd1d494871f1e7c57df0a15b3b
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: Cz7wWKv4ose9
                        description: 'The public id of this signature.'
                      quality:
                        type: string
                        example: SES
                        description: 'The signature quality that will be used for this signature process.'
                      status:
                        type: string
                        example: preparation
                        description: 'The current status of this signature.'
                      withdraw_reason:
                        type: string
                        example: null
                        description: 'The reason of withdrawal when `status` is `withdrawn`.'
                      title:
                        type: string
                        example: null
                        description: 'The optional title of this signature that gets shown to signers.'
                      webhook_url:
                        type: string
                        example: null
                        description: 'An optional webhook URL that will be used instead of the webhook URL of the app.'
                      created_at:
                        type: string
                        example: '2024-10-17T09:37:08.000000Z'
                        description: 'ISO-8601 formatted timestamp of when this resource has been created.'
                      updated_at:
                        type: string
                        example: '2024-10-17T09:37:08.000000Z'
                        description: 'ISO-8601 formatted timestamp of when this resource has last been updated.'
                      signers:
                        type: array
                        example:
                          -
                            id: pTG41YEDE8bk
                            order: 1
                            title: null
                            firstname: Josiane
                            lastname: Schulist
                            fullname: 'Josiane Schulist'
                            email: fay.kane@example.org
                            mobile_number: null
                            status: signed
                            decline_reason: null
                            signing_url: 'http://api.finosign.de/v1/signatures/Cz7wWKv4ose9/sign/b7ejQZ2RZe'
                            redirect_url_success: null
                            redirect_url_error: null
                            redirect_url_declined: null
                            certificate_serial_number: 286d1184487d
                            certificate_fingerprint: 3e7320b60d3949f6b1a24ed3ac82b289fd9bdd8d0969ea6f455b9b0fb33c8285
                            created_at: '2024-10-17T09:37:08.000000Z'
                            updated_at: '2024-10-17T09:37:08.000000Z'
                          -
                            id: 6KiAliy0qCZX
                            order: 1
                            title: null
                            firstname: Jordi
                            lastname: Robel
                            fullname: 'Jordi Robel'
                            email: loren.schmidt@example.net
                            mobile_number: null
                            status: open
                            decline_reason: null
                            signing_url: 'http://api.finosign.de/v1/signatures/Cz7wWKv4ose9/sign/EFtPddjnJw'
                            redirect_url_success: null
                            redirect_url_error: null
                            redirect_url_declined: null
                            certificate_serial_number: 1622e23992d4208a4e6a336e0db5b82b1834eac1
                            certificate_fingerprint: f8096ea83498f4186aeadea6cd08e026d5c806bd1d494871f1e7c57df0a15b3b
                            created_at: '2024-10-17T09:37:08.000000Z'
                            updated_at: '2024-10-17T09:37:08.000000Z'
                        description: 'An array of signers associated with this signature.'
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: pTG41YEDE8bk
                            order:
                              type: integer
                              example: 1
                            title:
                              type: string
                              example: null
                            firstname:
                              type: string
                              example: Josiane
                            lastname:
                              type: string
                              example: Schulist
                            fullname:
                              type: string
                              example: 'Josiane Schulist'
                            email:
                              type: string
                              example: fay.kane@example.org
                            mobile_number:
                              type: string
                              example: null
                            status:
                              type: string
                              example: signed
                            decline_reason:
                              type: string
                              example: null
                            signing_url:
                              type: string
                              example: 'http://api.finosign.de/v1/signatures/Cz7wWKv4ose9/sign/b7ejQZ2RZe'
                            redirect_url_success:
                              type: string
                              example: null
                            redirect_url_error:
                              type: string
                              example: null
                            redirect_url_declined:
                              type: string
                              example: null
                            certificate_serial_number:
                              type: string
                              example: 286d1184487d
                            certificate_fingerprint:
                              type: string
                              example: 3e7320b60d3949f6b1a24ed3ac82b289fd9bdd8d0969ea6f455b9b0fb33c8285
                            created_at:
                              type: string
                              example: '2024-10-17T09:37:08.000000Z'
                            updated_at:
                              type: string
                              example: '2024-10-17T09:37:08.000000Z'
        422:
          description: 'Validation of request payload failed.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
      tags:
        - Signatures
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                quality:
                  type: string
                  description: 'The quality of this signature. Must be a quality supported by the currently authenticated app.'
                  example: !php/enum App\Enums\SignatureQuality::SES
                  enum:
                    - SES
                    - AES
                    - QES
                title:
                  type: string
                  description: 'An optional title for this signature that will be shown to users. Must be between 2 and 100 characters.'
                  example: 'My Signature Title'
                webhook_url:
                  type: string
                  description: 'An optional webhook URL that will be used instead of the webhook URL of the app. Must be a valid URL.'
                  example: 'https://myapp.test/webhook'
                signers:
                  type: array
                  description: 'An array of signer-resources that represents entities that are prompted to fulfill the signing process.'
                  example:
                    - []
                  items:
                    type: object
                    properties:
                      order:
                        type: integer
                        description: 'The order index that this signer belongs to (starting at 1). Signers with the same order index are able to sign in parallel. Must be between 1 and 255.'
                        example: 1
                      title:
                        type: string
                        description: 'The title of the signer. Must not be greater than 200 characters.'
                        example: Prof.
                      firstname:
                        type: string
                        description: 'The firstname of the signer. Must be between 2 and 200 characters.'
                        example: Katheryn
                      lastname:
                        type: string
                        description: 'The lastname of the signer. Must be between 2 and 200 characters.'
                        example: Langworth
                      email:
                        type: string
                        description: 'The E-Mail address of the signer. Mutually exclusive with <code>mobile_number</code> when signature quality is <code>SES</code>. This field is required when <code>signers.*.mobile_number</code> is not present.  Must be a valid email address. Must not be greater than 200 characters.'
                        example: kayla.wiegand@yahoo.com
                      mobile_number:
                        type: string
                        description: 'The mobile phone number of the signer. This number will be used for verification depending on the signature quality. Mutually exclusive with <code>email</code> when signature quality is <code>SES</code>. This field is required when <code>signers.*.email</code> is not present.'
                        example: '+4915228817386'
                      redirect_url_success:
                        type: string
                        description: 'A URL that the signer will be redirected to once the signature process has been finished successfully. Must use HTTPS protocol. Must be a valid URL.'
                        example: 'https://example.test/success'
                      redirect_url_error:
                        type: string
                        description: 'A URL that the signer will be redirected to in case an error occurred while signing the documents. Must use HTTPS protocol. Must be a valid URL.'
                        example: 'https://example.test/error'
                      redirect_url_declined:
                        type: string
                        description: 'A URL that the signer will be redirected to after they have declined their signature. Must use HTTPS protocol. Must be a valid URL.'
                        example: 'https://example.test/declined'
                    required:
                      - firstname
                      - lastname
                      - redirect_url_success
                      - redirect_url_error
                      - redirect_url_declined
              required:
                - quality
  '/v1/signatures/{signature}':
    get:
      summary: 'Show signature'
      operationId: showSignature
      description: 'Retrieve an existing signature by the provided ID.'
      parameters: []
      responses:
        200:
          description: 'The signature resource found by the provided ID.'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 7BcBmWTFqlBp
                    quality: SES
                    status: preparation
                    withdraw_reason: null
                    title: null
                    webhook_url: null
                    created_at: '2024-10-17T09:37:08.000000Z'
                    updated_at: '2024-10-17T09:37:08.000000Z'
                    signers:
                      -
                        id: DbC8ZDzeorsd
                        order: 1
                        title: null
                        firstname: Ana
                        lastname: Hagenes
                        fullname: 'Ana Hagenes'
                        email: agottlieb@example.org
                        mobile_number: null
                        status: open
                        decline_reason: null
                        signing_url: 'http://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/dtC4jIAfEc'
                        redirect_url_success: null
                        redirect_url_error: null
                        redirect_url_declined: null
                        certificate_serial_number: 1fcd18510b44b7
                        certificate_fingerprint: dd77a6742b7710baa9df1606a9c5368b5c6929d9c0b1feaa7c8df7f3f98817f8
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                      -
                        id: B8j5FEi6LaWl
                        order: 1
                        title: null
                        firstname: Justina
                        lastname: Gutmann
                        fullname: 'Justina Gutmann'
                        email: brendon.brakus@example.net
                        mobile_number: null
                        status: open
                        decline_reason: null
                        signing_url: 'http://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/Fkf06Gmy5d'
                        redirect_url_success: null
                        redirect_url_error: null
                        redirect_url_declined: null
                        certificate_serial_number: 795075b0ee6b19d99e
                        certificate_fingerprint: 77c8b9e27dad4a2aed0168df28a9c15e5a297c907d85e0a21d1f479e07550612
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 7BcBmWTFqlBp
                        description: 'The public id of this signature.'
                      quality:
                        type: string
                        example: SES
                        description: 'The signature quality that will be used for this signature process.'
                      status:
                        type: string
                        example: preparation
                        description: 'The current status of this signature.'
                      withdraw_reason:
                        type: string
                        example: null
                        description: 'The reason of withdrawal when `status` is `withdrawn`.'
                      title:
                        type: string
                        example: null
                        description: 'The optional title of this signature that gets shown to signers.'
                      webhook_url:
                        type: string
                        example: null
                        description: 'An optional webhook URL that will be used instead of the webhook URL of the app.'
                      created_at:
                        type: string
                        example: '2024-10-17T09:37:08.000000Z'
                        description: 'ISO-8601 formatted timestamp of when this resource has been created.'
                      updated_at:
                        type: string
                        example: '2024-10-17T09:37:08.000000Z'
                        description: 'ISO-8601 formatted timestamp of when this resource has last been updated.'
                      signers:
                        type: array
                        example:
                          -
                            id: DbC8ZDzeorsd
                            order: 1
                            title: null
                            firstname: Ana
                            lastname: Hagenes
                            fullname: 'Ana Hagenes'
                            email: agottlieb@example.org
                            mobile_number: null
                            status: open
                            decline_reason: null
                            signing_url: 'http://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/dtC4jIAfEc'
                            redirect_url_success: null
                            redirect_url_error: null
                            redirect_url_declined: null
                            certificate_serial_number: 1fcd18510b44b7
                            certificate_fingerprint: dd77a6742b7710baa9df1606a9c5368b5c6929d9c0b1feaa7c8df7f3f98817f8
                            created_at: '2024-10-17T09:37:08.000000Z'
                            updated_at: '2024-10-17T09:37:08.000000Z'
                          -
                            id: B8j5FEi6LaWl
                            order: 1
                            title: null
                            firstname: Justina
                            lastname: Gutmann
                            fullname: 'Justina Gutmann'
                            email: brendon.brakus@example.net
                            mobile_number: null
                            status: open
                            decline_reason: null
                            signing_url: 'http://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/Fkf06Gmy5d'
                            redirect_url_success: null
                            redirect_url_error: null
                            redirect_url_declined: null
                            certificate_serial_number: 795075b0ee6b19d99e
                            certificate_fingerprint: 77c8b9e27dad4a2aed0168df28a9c15e5a297c907d85e0a21d1f479e07550612
                            created_at: '2024-10-17T09:37:08.000000Z'
                            updated_at: '2024-10-17T09:37:08.000000Z'
                        description: 'An array of signers associated with this signature.'
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: DbC8ZDzeorsd
                            order:
                              type: integer
                              example: 1
                            title:
                              type: string
                              example: null
                            firstname:
                              type: string
                              example: Ana
                            lastname:
                              type: string
                              example: Hagenes
                            fullname:
                              type: string
                              example: 'Ana Hagenes'
                            email:
                              type: string
                              example: agottlieb@example.org
                            mobile_number:
                              type: string
                              example: null
                            status:
                              type: string
                              example: open
                            decline_reason:
                              type: string
                              example: null
                            signing_url:
                              type: string
                              example: 'http://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/dtC4jIAfEc'
                            redirect_url_success:
                              type: string
                              example: null
                            redirect_url_error:
                              type: string
                              example: null
                            redirect_url_declined:
                              type: string
                              example: null
                            certificate_serial_number:
                              type: string
                              example: 1fcd18510b44b7
                            certificate_fingerprint:
                              type: string
                              example: dd77a6742b7710baa9df1606a9c5368b5c6929d9c0b1feaa7c8df7f3f98817f8
                            created_at:
                              type: string
                              example: '2024-10-17T09:37:08.000000Z'
                            updated_at:
                              type: string
                              example: '2024-10-17T09:37:08.000000Z'
        403:
          description: 'Insufficient permissions.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
        404:
          description: 'Not found.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
      tags:
        - Signatures
    patch:
      summary: 'Update signature'
      operationId: updateSignature
      description: "Update an existing signature with the provided values.\n<aside>\n    <b>Note:</b> Updating a signature is no longer possible once the signature has left\n    <code>preparation</code> stage.\n</aside>"
      parameters: []
      responses:
        200:
          description: 'The updated signature resource.'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: Cz7wWKv4ose9
                    quality: SES
                    status: preparation
                    withdraw_reason: null
                    title: null
                    webhook_url: null
                    created_at: '2024-10-17T09:37:08.000000Z'
                    updated_at: '2024-10-17T09:37:08.000000Z'
                    signers:
                      -
                        id: YEDE8bk6KiAl
                        order: 1
                        title: null
                        firstname: Josiane
                        lastname: Schulist
                        fullname: 'Josiane Schulist'
                        email: eldridge.ankunding@example.com
                        mobile_number: null
                        status: signed
                        decline_reason: null
                        signing_url: 'http://api.finosign.de/v1/signatures/Cz7wWKv4ose9/sign/TvNHQSDb9L'
                        redirect_url_success: null
                        redirect_url_error: null
                        redirect_url_declined: null
                        certificate_serial_number: ea104b617e46509305feef1a93fe46d321a13748
                        certificate_fingerprint: 4bb02de1dabe2e27cf33ae3af57c0d1bcabea4fdfb9f2fdf4f415ed8149cdd4f
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                      -
                        id: iy0qCZX4DbC8
                        order: 1
                        title: null
                        firstname: Kirk
                        lastname: Zulauf
                        fullname: 'Kirk Zulauf'
                        email: haven33@example.com
                        mobile_number: null
                        status: signed
                        decline_reason: null
                        signing_url: 'http://api.finosign.de/v1/signatures/Cz7wWKv4ose9/sign/bArkDgPHoA'
                        redirect_url_success: null
                        redirect_url_error: null
                        redirect_url_declined: null
                        certificate_serial_number: b01f22390a42191b43fb
                        certificate_fingerprint: 97108345cd5f318242998cfe33e527819a35e5d4e4bf110c9cee09c89c9d2314
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: Cz7wWKv4ose9
                        description: 'The public id of this signature.'
                      quality:
                        type: string
                        example: SES
                        description: 'The signature quality that will be used for this signature process.'
                      status:
                        type: string
                        example: preparation
                        description: 'The current status of this signature.'
                      withdraw_reason:
                        type: string
                        example: null
                        description: 'The reason of withdrawal when `status` is `withdrawn`.'
                      title:
                        type: string
                        example: null
                        description: 'The optional title of this signature that gets shown to signers.'
                      webhook_url:
                        type: string
                        example: null
                        description: 'An optional webhook URL that will be used instead of the webhook URL of the app.'
                      created_at:
                        type: string
                        example: '2024-10-17T09:37:08.000000Z'
                        description: 'ISO-8601 formatted timestamp of when this resource has been created.'
                      updated_at:
                        type: string
                        example: '2024-10-17T09:37:08.000000Z'
                        description: 'ISO-8601 formatted timestamp of when this resource has last been updated.'
                      signers:
                        type: array
                        example:
                          -
                            id: YEDE8bk6KiAl
                            order: 1
                            title: null
                            firstname: Josiane
                            lastname: Schulist
                            fullname: 'Josiane Schulist'
                            email: eldridge.ankunding@example.com
                            mobile_number: null
                            status: signed
                            decline_reason: null
                            signing_url: 'http://api.finosign.de/v1/signatures/Cz7wWKv4ose9/sign/TvNHQSDb9L'
                            redirect_url_success: null
                            redirect_url_error: null
                            redirect_url_declined: null
                            certificate_serial_number: ea104b617e46509305feef1a93fe46d321a13748
                            certificate_fingerprint: 4bb02de1dabe2e27cf33ae3af57c0d1bcabea4fdfb9f2fdf4f415ed8149cdd4f
                            created_at: '2024-10-17T09:37:08.000000Z'
                            updated_at: '2024-10-17T09:37:08.000000Z'
                          -
                            id: iy0qCZX4DbC8
                            order: 1
                            title: null
                            firstname: Kirk
                            lastname: Zulauf
                            fullname: 'Kirk Zulauf'
                            email: haven33@example.com
                            mobile_number: null
                            status: signed
                            decline_reason: null
                            signing_url: 'http://api.finosign.de/v1/signatures/Cz7wWKv4ose9/sign/bArkDgPHoA'
                            redirect_url_success: null
                            redirect_url_error: null
                            redirect_url_declined: null
                            certificate_serial_number: b01f22390a42191b43fb
                            certificate_fingerprint: 97108345cd5f318242998cfe33e527819a35e5d4e4bf110c9cee09c89c9d2314
                            created_at: '2024-10-17T09:37:08.000000Z'
                            updated_at: '2024-10-17T09:37:08.000000Z'
                        description: 'An array of signers associated with this signature.'
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: YEDE8bk6KiAl
                            order:
                              type: integer
                              example: 1
                            title:
                              type: string
                              example: null
                            firstname:
                              type: string
                              example: Josiane
                            lastname:
                              type: string
                              example: Schulist
                            fullname:
                              type: string
                              example: 'Josiane Schulist'
                            email:
                              type: string
                              example: eldridge.ankunding@example.com
                            mobile_number:
                              type: string
                              example: null
                            status:
                              type: string
                              example: signed
                            decline_reason:
                              type: string
                              example: null
                            signing_url:
                              type: string
                              example: 'http://api.finosign.de/v1/signatures/Cz7wWKv4ose9/sign/TvNHQSDb9L'
                            redirect_url_success:
                              type: string
                              example: null
                            redirect_url_error:
                              type: string
                              example: null
                            redirect_url_declined:
                              type: string
                              example: null
                            certificate_serial_number:
                              type: string
                              example: ea104b617e46509305feef1a93fe46d321a13748
                            certificate_fingerprint:
                              type: string
                              example: 4bb02de1dabe2e27cf33ae3af57c0d1bcabea4fdfb9f2fdf4f415ed8149cdd4f
                            created_at:
                              type: string
                              example: '2024-10-17T09:37:08.000000Z'
                            updated_at:
                              type: string
                              example: '2024-10-17T09:37:08.000000Z'
        403:
          description: ''
          content:
            text/plain:
              schema:
                oneOf:
                  -
                    description: 'Insufficient permissions.'
                    type: string
                    example: ''
                  -
                    description: 'Signature is not in preparation stage.'
                    type: string
                    example: ''
        404:
          description: 'Not found.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
        422:
          description: 'Validation of request payload failed.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
      tags:
        - Signatures
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                quality:
                  type: string
                  description: 'The quality of this signature. Must be a quality supported by the currently authenticated app.'
                  example: !php/enum App\Enums\SignatureQuality::SES
                  enum:
                    - SES
                    - AES
                    - QES
                title:
                  type: string
                  description: 'An optional title for this signature that will be shown to users. Must be between 2 and 100 characters.'
                  example: 'My Signature Title'
                webhook_url:
                  type: string
                  description: 'An optional webhook URL that will be used instead of the webhook URL of the app. Must be a valid URL.'
                  example: 'https://myapp.test/webhook'
              required:
                - quality
    delete:
      summary: 'Delete signature'
      operationId: deleteSignature
      description: "Delete an existing signature and all its associated resources by the provided ID.\n<aside>\n    <b>Note:</b> Deleting a signature is no longer possible once the signature has reached\n    <code>signed</code> stage.\n</aside>"
      parameters: []
      responses:
        204:
          description: 'Signature deleted successfully.'
        403:
          description: ''
          content:
            text/plain:
              schema:
                oneOf:
                  -
                    description: 'Insufficient permissions.'
                    type: string
                    example: ''
                  -
                    description: 'Signature at current stage cannot be deleted.'
                    type: string
                    example: ''
        404:
          description: 'Not found.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
      tags:
        - Signatures
    parameters:
      -
        in: path
        name: signature
        description: 'The public ID of the signature resource.'
        example: zHQAQwQpBDmq
        required: true
        schema:
          type: string
  '/v1/signatures/{signature}/open':
    post:
      summary: 'Open Signature'
      operationId: openSignature
      description: "Finalizes the <code>preparation</code> stage, making the documents ready to be signed.\n\n<aside>\n    <b>Note:</b> To finalize the <code>preparation</code> stage, at least one document\n     and one signer is required.\n</aside>"
      parameters: []
      responses:
        200:
          description: 'The opened signature resource.'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 7BcBmWTFqlBp
                    quality: SES
                    status: preparation
                    withdraw_reason: null
                    title: null
                    webhook_url: null
                    created_at: '2024-10-17T09:37:08.000000Z'
                    updated_at: '2024-10-17T09:37:08.000000Z'
                    signers:
                      -
                        id: DzeorsdB8j5F
                        order: 1
                        title: null
                        firstname: Ana
                        lastname: Hagenes
                        fullname: 'Ana Hagenes'
                        email: gutmann.justina@example.org
                        mobile_number: null
                        status: signed
                        decline_reason: null
                        signing_url: 'http://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/GTKRugxdLw'
                        redirect_url_success: null
                        redirect_url_error: null
                        redirect_url_declined: null
                        certificate_serial_number: de1dd5839b5132
                        certificate_fingerprint: 5f28dd4e147ba15c7616d52cd9cfc5b2433b720323fe8b8dec2da793f83b141f
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                      -
                        id: Ei6LaWlEO_4B
                        order: 1
                        title: null
                        firstname: Keeley
                        lastname: Howell
                        fullname: 'Keeley Howell'
                        email: tyrel47@example.net
                        mobile_number: null
                        status: signed
                        decline_reason: null
                        signing_url: 'http://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/uaLc3SwLOc'
                        redirect_url_success: null
                        redirect_url_error: null
                        redirect_url_declined: null
                        certificate_serial_number: ecd2bc7529
                        certificate_fingerprint: 93a2dfbcafe8ef5c20157f8d041cf7596e69b5bd5bb25da7fc5aeeef74d768c9
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 7BcBmWTFqlBp
                        description: 'The public id of this signature.'
                      quality:
                        type: string
                        example: SES
                        description: 'The signature quality that will be used for this signature process.'
                      status:
                        type: string
                        example: preparation
                        description: 'The current status of this signature.'
                      withdraw_reason:
                        type: string
                        example: null
                        description: 'The reason of withdrawal when `status` is `withdrawn`.'
                      title:
                        type: string
                        example: null
                        description: 'The optional title of this signature that gets shown to signers.'
                      webhook_url:
                        type: string
                        example: null
                        description: 'An optional webhook URL that will be used instead of the webhook URL of the app.'
                      created_at:
                        type: string
                        example: '2024-10-17T09:37:08.000000Z'
                        description: 'ISO-8601 formatted timestamp of when this resource has been created.'
                      updated_at:
                        type: string
                        example: '2024-10-17T09:37:08.000000Z'
                        description: 'ISO-8601 formatted timestamp of when this resource has last been updated.'
                      signers:
                        type: array
                        example:
                          -
                            id: DzeorsdB8j5F
                            order: 1
                            title: null
                            firstname: Ana
                            lastname: Hagenes
                            fullname: 'Ana Hagenes'
                            email: gutmann.justina@example.org
                            mobile_number: null
                            status: signed
                            decline_reason: null
                            signing_url: 'http://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/GTKRugxdLw'
                            redirect_url_success: null
                            redirect_url_error: null
                            redirect_url_declined: null
                            certificate_serial_number: de1dd5839b5132
                            certificate_fingerprint: 5f28dd4e147ba15c7616d52cd9cfc5b2433b720323fe8b8dec2da793f83b141f
                            created_at: '2024-10-17T09:37:08.000000Z'
                            updated_at: '2024-10-17T09:37:08.000000Z'
                          -
                            id: Ei6LaWlEO_4B
                            order: 1
                            title: null
                            firstname: Keeley
                            lastname: Howell
                            fullname: 'Keeley Howell'
                            email: tyrel47@example.net
                            mobile_number: null
                            status: signed
                            decline_reason: null
                            signing_url: 'http://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/uaLc3SwLOc'
                            redirect_url_success: null
                            redirect_url_error: null
                            redirect_url_declined: null
                            certificate_serial_number: ecd2bc7529
                            certificate_fingerprint: 93a2dfbcafe8ef5c20157f8d041cf7596e69b5bd5bb25da7fc5aeeef74d768c9
                            created_at: '2024-10-17T09:37:08.000000Z'
                            updated_at: '2024-10-17T09:37:08.000000Z'
                        description: 'An array of signers associated with this signature.'
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: DzeorsdB8j5F
                            order:
                              type: integer
                              example: 1
                            title:
                              type: string
                              example: null
                            firstname:
                              type: string
                              example: Ana
                            lastname:
                              type: string
                              example: Hagenes
                            fullname:
                              type: string
                              example: 'Ana Hagenes'
                            email:
                              type: string
                              example: gutmann.justina@example.org
                            mobile_number:
                              type: string
                              example: null
                            status:
                              type: string
                              example: signed
                            decline_reason:
                              type: string
                              example: null
                            signing_url:
                              type: string
                              example: 'http://api.finosign.de/v1/signatures/7BcBmWTFqlBp/sign/GTKRugxdLw'
                            redirect_url_success:
                              type: string
                              example: null
                            redirect_url_error:
                              type: string
                              example: null
                            redirect_url_declined:
                              type: string
                              example: null
                            certificate_serial_number:
                              type: string
                              example: de1dd5839b5132
                            certificate_fingerprint:
                              type: string
                              example: 5f28dd4e147ba15c7616d52cd9cfc5b2433b720323fe8b8dec2da793f83b141f
                            created_at:
                              type: string
                              example: '2024-10-17T09:37:08.000000Z'
                            updated_at:
                              type: string
                              example: '2024-10-17T09:37:08.000000Z'
        403:
          description: 'Signature is not in preparation stage.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
        404:
          description: 'Signature not found.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
        409:
          description: ''
          content:
            text/plain:
              schema:
                oneOf:
                  -
                    description: 'Signature requires at least one document.'
                    type: string
                    example: ''
                  -
                    description: 'Signature requires at least one signer.'
                    type: string
                    example: ''
      tags:
        - Signatures
    parameters:
      -
        in: path
        name: signature
        description: 'The public ID of the signature resource.'
        example: zHQAQwQpBDmq
        required: true
        schema:
          type: string
  '/v1/signatures/{signature}/signers':
    get:
      summary: "List all signers\nList all signing entities associated with the provided signature ID."
      operationId: listAllSignersListAllSigningEntitiesAssociatedWithTheProvidedSignatureID
      description: ''
      parameters: []
      responses:
        200:
          description: 'An array containing all signers associated with the provided signature ID.'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 8bk6KiAliy0q
                      order: 1
                      title: null
                      firstname: Katheryn
                      lastname: Langworth
                      fullname: 'Katheryn Langworth'
                      email: abbigail.lehner@example.com
                      mobile_number: null
                      status: signed
                      decline_reason: null
                      signing_url: 'http://api.finosign.de/v1/signatures/qlBpTG41YEDE/sign/2w76PQHZwD'
                      redirect_url_success: null
                      redirect_url_error: null
                      redirect_url_declined: null
                      certificate_serial_number: 13ae1d7baf2859a8f23da0104d
                      certificate_fingerprint: 07bfa58f550c1f72a8b241c9d77fce60556abe15ce8b243c5c6136e9981a0e83
                      created_at: '2024-10-17T09:37:08.000000Z'
                      updated_at: '2024-10-17T09:37:08.000000Z'
                    -
                      id: U4Uy3Vfi_EP6
                      order: 1
                      title: null
                      firstname: Georgianna
                      lastname: Kiehn
                      fullname: 'Georgianna Kiehn'
                      email: satterfield.caitlyn@example.net
                      mobile_number: null
                      status: open
                      decline_reason: null
                      signing_url: 'http://api.finosign.de/v1/signatures/SoU2bGyyReuv/sign/ioOvOTeaCP'
                      redirect_url_success: null
                      redirect_url_error: null
                      redirect_url_declined: null
                      certificate_serial_number: 1a62a4dec9
                      certificate_fingerprint: f1d5a2bed27b8fc3af6d541e9757c3e8d70ddc46b3034a459c4b28517b2f35d5
                      created_at: '2024-10-17T09:37:08.000000Z'
                      updated_at: '2024-10-17T09:37:08.000000Z'
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 8bk6KiAliy0q
                        order: 1
                        title: null
                        firstname: Katheryn
                        lastname: Langworth
                        fullname: 'Katheryn Langworth'
                        email: abbigail.lehner@example.com
                        mobile_number: null
                        status: signed
                        decline_reason: null
                        signing_url: 'http://api.finosign.de/v1/signatures/qlBpTG41YEDE/sign/2w76PQHZwD'
                        redirect_url_success: null
                        redirect_url_error: null
                        redirect_url_declined: null
                        certificate_serial_number: 13ae1d7baf2859a8f23da0104d
                        certificate_fingerprint: 07bfa58f550c1f72a8b241c9d77fce60556abe15ce8b243c5c6136e9981a0e83
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                      -
                        id: U4Uy3Vfi_EP6
                        order: 1
                        title: null
                        firstname: Georgianna
                        lastname: Kiehn
                        fullname: 'Georgianna Kiehn'
                        email: satterfield.caitlyn@example.net
                        mobile_number: null
                        status: open
                        decline_reason: null
                        signing_url: 'http://api.finosign.de/v1/signatures/SoU2bGyyReuv/sign/ioOvOTeaCP'
                        redirect_url_success: null
                        redirect_url_error: null
                        redirect_url_declined: null
                        certificate_serial_number: 1a62a4dec9
                        certificate_fingerprint: f1d5a2bed27b8fc3af6d541e9757c3e8d70ddc46b3034a459c4b28517b2f35d5
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                    description: 'An array containing all signers associated with the provided signature ID.'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 8bk6KiAliy0q
                        order:
                          type: integer
                          example: 1
                        title:
                          type: string
                          example: null
                        firstname:
                          type: string
                          example: Katheryn
                        lastname:
                          type: string
                          example: Langworth
                        fullname:
                          type: string
                          example: 'Katheryn Langworth'
                        email:
                          type: string
                          example: abbigail.lehner@example.com
                        mobile_number:
                          type: string
                          example: null
                        status:
                          type: string
                          example: signed
                        decline_reason:
                          type: string
                          example: null
                        signing_url:
                          type: string
                          example: 'http://api.finosign.de/v1/signatures/qlBpTG41YEDE/sign/2w76PQHZwD'
                        redirect_url_success:
                          type: string
                          example: null
                        redirect_url_error:
                          type: string
                          example: null
                        redirect_url_declined:
                          type: string
                          example: null
                        certificate_serial_number:
                          type: string
                          example: 13ae1d7baf2859a8f23da0104d
                        certificate_fingerprint:
                          type: string
                          example: 07bfa58f550c1f72a8b241c9d77fce60556abe15ce8b243c5c6136e9981a0e83
                        created_at:
                          type: string
                          example: '2024-10-17T09:37:08.000000Z'
                        updated_at:
                          type: string
                          example: '2024-10-17T09:37:08.000000Z'
        403:
          description: 'Insufficient permissions.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
        404:
          description: 'Signature not found.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
      tags:
        - 'Signature Signers'
    post:
      summary: "Create signer(s)\nCreate one more multiple new signing entities for the signing process of the provided signature ID."
      operationId: createSignersCreateOneMoreMultipleNewSigningEntitiesForTheSigningProcessOfTheProvidedSignatureID
      description: "<aside>\n    <b>Note:</b> Creating new signers is no longer possible once the signature has left <code>preparation</code>\n    stage.\n</aside>"
      parameters: []
      responses:
        201:
          description: 'The created signer resource.'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: iB7BcBmWTFql
                      order: 1
                      title: null
                      firstname: Myron
                      lastname: Vandervort
                      fullname: 'Myron Vandervort'
                      email: mueller.nelle@example.org
                      mobile_number: null
                      status: signed
                      decline_reason: null
                      signing_url: 'http://api.finosign.de/v1/signatures/4ose9LJrby6-/sign/KPUlnGVzFG'
                      redirect_url_success: null
                      redirect_url_error: null
                      redirect_url_declined: null
                      certificate_serial_number: b13d8dd6
                      certificate_fingerprint: e0bd2ac1e95f2ee3131917eb40e4ef44c21b5e2deb057ba928ba6b139747aefa
                      created_at: '2024-10-17T09:37:08.000000Z'
                      updated_at: '2024-10-17T09:37:08.000000Z'
                    -
                      id: 0qgY5lgs5GiS
                      order: 1
                      title: null
                      firstname: Haven
                      lastname: Weber
                      fullname: 'Haven Weber'
                      email: dorris.heaney@example.org
                      mobile_number: null
                      status: open
                      decline_reason: null
                      signing_url: 'http://api.finosign.de/v1/signatures/4YYSruY1AqJ-/sign/4bW6j9RRbg'
                      redirect_url_success: null
                      redirect_url_error: null
                      redirect_url_declined: null
                      certificate_serial_number: 098300eab51c3e034463b899e7260ec3
                      certificate_fingerprint: 54ea3a4ee2fb2a1baf794cef5b3bc9dff84e7f60bf50a0b334630777be300bba
                      created_at: '2024-10-17T09:37:08.000000Z'
                      updated_at: '2024-10-17T09:37:08.000000Z'
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: iB7BcBmWTFql
                        order: 1
                        title: null
                        firstname: Myron
                        lastname: Vandervort
                        fullname: 'Myron Vandervort'
                        email: mueller.nelle@example.org
                        mobile_number: null
                        status: signed
                        decline_reason: null
                        signing_url: 'http://api.finosign.de/v1/signatures/4ose9LJrby6-/sign/KPUlnGVzFG'
                        redirect_url_success: null
                        redirect_url_error: null
                        redirect_url_declined: null
                        certificate_serial_number: b13d8dd6
                        certificate_fingerprint: e0bd2ac1e95f2ee3131917eb40e4ef44c21b5e2deb057ba928ba6b139747aefa
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                      -
                        id: 0qgY5lgs5GiS
                        order: 1
                        title: null
                        firstname: Haven
                        lastname: Weber
                        fullname: 'Haven Weber'
                        email: dorris.heaney@example.org
                        mobile_number: null
                        status: open
                        decline_reason: null
                        signing_url: 'http://api.finosign.de/v1/signatures/4YYSruY1AqJ-/sign/4bW6j9RRbg'
                        redirect_url_success: null
                        redirect_url_error: null
                        redirect_url_declined: null
                        certificate_serial_number: 098300eab51c3e034463b899e7260ec3
                        certificate_fingerprint: 54ea3a4ee2fb2a1baf794cef5b3bc9dff84e7f60bf50a0b334630777be300bba
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                    description: 'The created signer resource.'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: iB7BcBmWTFql
                        order:
                          type: integer
                          example: 1
                        title:
                          type: string
                          example: null
                        firstname:
                          type: string
                          example: Myron
                        lastname:
                          type: string
                          example: Vandervort
                        fullname:
                          type: string
                          example: 'Myron Vandervort'
                        email:
                          type: string
                          example: mueller.nelle@example.org
                        mobile_number:
                          type: string
                          example: null
                        status:
                          type: string
                          example: signed
                        decline_reason:
                          type: string
                          example: null
                        signing_url:
                          type: string
                          example: 'http://api.finosign.de/v1/signatures/4ose9LJrby6-/sign/KPUlnGVzFG'
                        redirect_url_success:
                          type: string
                          example: null
                        redirect_url_error:
                          type: string
                          example: null
                        redirect_url_declined:
                          type: string
                          example: null
                        certificate_serial_number:
                          type: string
                          example: b13d8dd6
                        certificate_fingerprint:
                          type: string
                          example: e0bd2ac1e95f2ee3131917eb40e4ef44c21b5e2deb057ba928ba6b139747aefa
                        created_at:
                          type: string
                          example: '2024-10-17T09:37:08.000000Z'
                        updated_at:
                          type: string
                          example: '2024-10-17T09:37:08.000000Z'
        403:
          description: 'Signature is not in preparation stage.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
        404:
          description: 'Signature not found.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
        422:
          description: 'Validation of request payload failed.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
      tags:
        - 'Signature Signers'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                signers:
                  type: array
                  description: 'An array of signer-resources that represents entities that are prompted to fulfill the signing process.'
                  example:
                    - []
                  items:
                    type: object
                    properties:
                      order:
                        type: integer
                        description: 'The order index that this signer belongs to (starting at 1). Signers with the same order index are able to sign in parallel. Must be between 1 and 255.'
                        example: 1
                      title:
                        type: string
                        description: 'The title of the signer. Must not be greater than 200 characters.'
                        example: Prof.
                      firstname:
                        type: string
                        description: 'The firstname of the signer. Must be between 2 and 200 characters.'
                        example: Katheryn
                      lastname:
                        type: string
                        description: 'The lastname of the signer. Must be between 2 and 200 characters.'
                        example: Langworth
                      email:
                        type: string
                        description: 'The E-Mail address of the signer. Mutually exclusive with <code>mobile_number</code> when signature quality is <code>SES</code>. This field is required when <code>signers.*.mobile_number</code> is not present.  Must be a valid email address. Must not be greater than 200 characters.'
                        example: kayla.wiegand@yahoo.com
                      mobile_number:
                        type: string
                        description: 'The mobile phone number of the signer. This number will be used for verification depending on the signature quality. Mutually exclusive with <code>email</code> when signature quality is <code>SES</code>. This field is required when <code>signers.*.two_factor_identifier</code> is not present.  This field is required when <code>signers.*.email</code> is not present.'
                        example: '+4915228817386'
                      two_factor_identifier:
                        type: string
                        description: 'The two factor identifier of the signer. This identifier will be placed onto the signature certificate. Usually a user id from your system. <strong>Requires activiation - contact support</strong>. This field is required when <code>signers.*.two_factor_method</code> or <code>signers.*.two_factor_confirmed_at</code> is present. Must be between 2 and 200 characters.'
                        example: '1'
                      two_factor_method:
                        type: string
                        description: 'The two factor method of the signer. <strong>Requires activiation - contact support</strong>. This field is required when <code>signers.*.two_factor_identifier</code> or <code>signers.*.two_factor_confirmed_at</code> is present. Must be between 2 and 200 characters.'
                        example: '2FA Authenticator'
                      two_factor_confirmed_at:
                        type: string
                        description: 'The two factor confirmation at date of the signer. Must be in the past. <strong>Requires activiation - contact support</strong>. This field is required when <code>signers.*.two_factor_identifier</code> or <code>signers.*.two_factor_method</code> is present.  Must be a valid date in the format <code>Y-m-d\TH:i:sP</code>. Must be a date before or equal to <code>now</code>.'
                        example: '2024-01-01T12:00:00+0000'
                      redirect_url_success:
                        type: string
                        description: 'A URL that the signer will be redirected to once the signature process has been finished successfully. Must use HTTPS protocol. Must be a valid URL.'
                        example: 'https://example.test/success'
                      redirect_url_error:
                        type: string
                        description: 'A URL that the signer will be redirected to in case an error occurred while signing the documents. Must use HTTPS protocol. Must be a valid URL.'
                        example: 'https://example.test/error'
                      redirect_url_declined:
                        type: string
                        description: 'A URL that the signer will be redirected to after they have declined their signature. Must use HTTPS protocol. Must be a valid URL.'
                        example: 'https://example.test/declined'
                    required:
                      - firstname
                      - lastname
    parameters:
      -
        in: path
        name: signature
        description: 'The public ID of the signature resource.'
        example: zHQAQwQpBDmq
        required: true
        schema:
          type: string
  '/v1/signatures/{signature}/signers/{signer}':
    get:
      summary: "Show signer\nRetrieve a single signer associated with the provided signature ID."
      operationId: showSignerRetrieveASingleSignerAssociatedWithTheProvidedSignatureID
      description: ''
      parameters: []
      responses:
        200:
          description: 'The signer resource found by the provided ID.'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: liy0qCZX4DbC
                    order: 1
                    title: null
                    firstname: Katheryn
                    lastname: Langworth
                    fullname: 'Katheryn Langworth'
                    email: merlin.gibson@example.org
                    mobile_number: null
                    status: signed
                    decline_reason: null
                    signing_url: 'http://api.finosign.de/v1/signatures/1YEDE8bk6KiA/sign/wwqGxGw5pA'
                    redirect_url_success: null
                    redirect_url_error: null
                    redirect_url_declined: null
                    certificate_serial_number: 1310d4
                    certificate_fingerprint: 3216f719a078681569bddb4ae416043d7faa19a506e938d1510f6c747a08cae4
                    created_at: '2024-10-17T09:37:08.000000Z'
                    updated_at: '2024-10-17T09:37:08.000000Z'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: liy0qCZX4DbC
                        description: 'The public ID of this signer.'
                      order:
                        type: integer
                        example: 1
                        description: "The order index that this signer belongs to (starting at 1). Signers with the same order\n                     index are able to sign in parallel."
                      title:
                        type: string
                        example: null
                        description: 'The title of the signer.'
                      firstname:
                        type: string
                        example: Katheryn
                        description: 'The firstname of the signer.'
                      lastname:
                        type: string
                        example: Langworth
                        description: 'The lastname of the signer.'
                      fullname:
                        type: string
                        example: 'Katheryn Langworth'
                      email:
                        type: string
                        example: merlin.gibson@example.org
                        description: 'The E-Mail address of the signer.'
                      mobile_number:
                        type: string
                        example: null
                        description: "The mobile phone number of the signer. This number will be used\n                             for verification depending on the signature quality."
                      status:
                        type: string
                        example: signed
                        description: 'The signature status for this signer.'
                      decline_reason:
                        type: string
                        example: null
                        description: "An optional reason of why the signer has declined their signature.\n                              <i>This value may still be <code>null</code> even if the status is\n                              <code>declined</code> indicating that the user did not provide a reason when\n                              declining.</i>"
                      signing_url:
                        type: string
                        example: 'http://api.finosign.de/v1/signatures/1YEDE8bk6KiA/sign/wwqGxGw5pA'
                      redirect_url_success:
                        type: string
                        example: null
                        description: "A URL that the signer will be redirected to once the signature process\n                                    has been finished successfully."
                      redirect_url_error:
                        type: string
                        example: null
                        description: "A URL that the signer will be redirected to in case an error occurred while\n                                  signing the documents."
                      redirect_url_declined:
                        type: string
                        example: null
                        description: "A URL that the signer will be redirected to after they have declined their\n                                     signature."
                      certificate_serial_number:
                        type: string
                        example: 1310d4
                        description: "The X.509 serial number of the certificate created after the\n                                         signer has finished signing the documents represented in hexadecimal.\n                                         This number should <b>not</b> be considered globally unique. For\n                                         identification purposes use the <code>certificate_fingerprint</code>."
                      certificate_fingerprint:
                        type: string
                        example: 3216f719a078681569bddb4ae416043d7faa19a506e938d1510f6c747a08cae4
                        description: "A SHA-256 fingerprint across the whole certificate created\n                                       after the signer has finished signing the documents. This fingerprint may\n                                       be used to uniquely identify the signer."
                      created_at:
                        type: string
                        example: '2024-10-17T09:37:08.000000Z'
                        description: 'ISO-8601 formatted timestamp of when this resource has been created.'
                      updated_at:
                        type: string
                        example: '2024-10-17T09:37:08.000000Z'
                        description: 'ISO-8601 formatted timestamp of when this resource has last been updated.'
        403:
          description: 'Insufficient permissions.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
        404:
          description: 'Signature or signer not found.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
      tags:
        - 'Signature Signers'
    patch:
      summary: "Update signer\nUpdate information of an existing signer associated with the provided signature ID."
      operationId: updateSignerUpdateInformationOfAnExistingSignerAssociatedWithTheProvidedSignatureID
      description: "<aside>\n    <b>Note:</b> Updating a signer is no longer possible once the associated signature has left\n    <code>preparation</code> stage.\n</aside>"
      parameters: []
      responses:
        200:
          description: 'The updated signer resource.'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: TFqlBpTG41YE
                    order: 1
                    title: null
                    firstname: Myron
                    lastname: Vandervort
                    fullname: 'Myron Vandervort'
                    email: winona.hermiston@example.com
                    mobile_number: null
                    status: signed
                    decline_reason: null
                    signing_url: 'http://api.finosign.de/v1/signatures/by6-iB7BcBmW/sign/anyui372GU'
                    redirect_url_success: null
                    redirect_url_error: null
                    redirect_url_declined: null
                    certificate_serial_number: 0562b6d2e130252a3c3c2699604983311dfdc2
                    certificate_fingerprint: 73b934e11a52b0611b1166b661e822cc471763028c7c56a9e3efc95fe08c73f2
                    created_at: '2024-10-17T09:37:08.000000Z'
                    updated_at: '2024-10-17T09:37:08.000000Z'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: TFqlBpTG41YE
                        description: 'The public ID of this signer.'
                      order:
                        type: integer
                        example: 1
                        description: "The order index that this signer belongs to (starting at 1). Signers with the same order\n                     index are able to sign in parallel."
                      title:
                        type: string
                        example: null
                        description: 'The title of the signer.'
                      firstname:
                        type: string
                        example: Myron
                        description: 'The firstname of the signer.'
                      lastname:
                        type: string
                        example: Vandervort
                        description: 'The lastname of the signer.'
                      fullname:
                        type: string
                        example: 'Myron Vandervort'
                      email:
                        type: string
                        example: winona.hermiston@example.com
                        description: 'The E-Mail address of the signer.'
                      mobile_number:
                        type: string
                        example: null
                        description: "The mobile phone number of the signer. This number will be used\n                             for verification depending on the signature quality."
                      status:
                        type: string
                        example: signed
                        description: 'The signature status for this signer.'
                      decline_reason:
                        type: string
                        example: null
                        description: "An optional reason of why the signer has declined their signature.\n                              <i>This value may still be <code>null</code> even if the status is\n                              <code>declined</code> indicating that the user did not provide a reason when\n                              declining.</i>"
                      signing_url:
                        type: string
                        example: 'http://api.finosign.de/v1/signatures/by6-iB7BcBmW/sign/anyui372GU'
                      redirect_url_success:
                        type: string
                        example: null
                        description: "A URL that the signer will be redirected to once the signature process\n                                    has been finished successfully."
                      redirect_url_error:
                        type: string
                        example: null
                        description: "A URL that the signer will be redirected to in case an error occurred while\n                                  signing the documents."
                      redirect_url_declined:
                        type: string
                        example: null
                        description: "A URL that the signer will be redirected to after they have declined their\n                                     signature."
                      certificate_serial_number:
                        type: string
                        example: 0562b6d2e130252a3c3c2699604983311dfdc2
                        description: "The X.509 serial number of the certificate created after the\n                                         signer has finished signing the documents represented in hexadecimal.\n                                         This number should <b>not</b> be considered globally unique. For\n                                         identification purposes use the <code>certificate_fingerprint</code>."
                      certificate_fingerprint:
                        type: string
                        example: 73b934e11a52b0611b1166b661e822cc471763028c7c56a9e3efc95fe08c73f2
                        description: "A SHA-256 fingerprint across the whole certificate created\n                                       after the signer has finished signing the documents. This fingerprint may\n                                       be used to uniquely identify the signer."
                      created_at:
                        type: string
                        example: '2024-10-17T09:37:08.000000Z'
                        description: 'ISO-8601 formatted timestamp of when this resource has been created.'
                      updated_at:
                        type: string
                        example: '2024-10-17T09:37:08.000000Z'
                        description: 'ISO-8601 formatted timestamp of when this resource has last been updated.'
        403:
          description: 'Signature is not in preparation stage.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
        404:
          description: 'Signature or signer not found.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
        422:
          description: 'Validation of request payload failed.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
      tags:
        - 'Signature Signers'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                order:
                  type: integer
                  description: 'The order index that this signer belongs to (starting at 1). Signers with the same order index are able to sign in parallel. Must be between 1 and 255.'
                  example: 1
                title:
                  type: string
                  description: 'The title of the signer. Must not be greater than 200 characters.'
                  example: Prof.
                firstname:
                  type: string
                  description: 'The firstname of the signer. Must be between 2 and 200 characters.'
                  example: Katheryn
                lastname:
                  type: string
                  description: 'The lastname of the signer. Must be between 2 and 200 characters.'
                  example: Langworth
                email:
                  type: string
                  description: 'The E-Mail address of the signer. Must be a valid email address. Must not be greater than 200 characters.'
                  example: kayla.wiegand@yahoo.com
                mobile_number:
                  type: string
                  description: 'The mobile phone number of the signer. This number will be used for verification depending on the signature quality. This field is required when <code>two_factor_identifier</code> is not present.'
                  example: '+4915228817386'
                two_factor_identifier:
                  type: string
                  description: 'The two factor identifier of the signer. This identifier will be placed onto the signature certificate. Usually a user id from your system. <strong>Requires activiation - contact support</strong>. This field is required when <code>two_factor_method</code> or <code>two_factor_confirmed_at</code> is present. Must be between 2 and 200 characters.'
                  example: '1'
                two_factor_method:
                  type: string
                  description: 'The two factor method of the signer. <strong>Requires activiation - contact support</strong>. This field is required when <code>two_factor_identifier</code> or <code>two_factor_confirmed_at</code> is present. Must be between 2 and 200 characters.'
                  example: '2FA Authenticator'
                two_factor_confirmed_at:
                  type: string
                  description: 'The two factor confirmation at date of the signer. Must be in the past. <strong>Requires activiation - contact support</strong>. This field is required when <code>two_factor_identifier</code> or <code>two_factor_method</code> is present.  Must be a valid date in the format <code>Y-m-d\TH:i:sP</code>. Must be a date before or equal to <code>now</code>.'
                  example: '2024-01-01T12:00:00+0000'
                redirect_url_success:
                  type: string
                  description: 'A URL that the signer will be redirected to once the signature process has been finished successfully. Must use HTTPS protocol. Must be a valid URL.'
                  example: 'https://example.test/success'
                redirect_url_error:
                  type: string
                  description: 'A URL that the signer will be redirected to in case an error occurred while signing the documents. Must use HTTPS protocol. Must be a valid URL.'
                  example: 'https://example.test/error'
                redirect_url_declined:
                  type: string
                  description: 'A URL that the signer will be redirected to after they have declined their signature. Must use HTTPS protocol. Must be a valid URL.'
                  example: 'https://example.test/declined'
    delete:
      summary: "Delete signer\nDeletes a signer associated with the provided signature ID."
      operationId: deleteSignerDeletesASignerAssociatedWithTheProvidedSignatureID
      description: "<aside>\n    <b>Note:</b> Deleting a signer is no longer possible once the associated signature has left\n    <code>preparation</code> stage.\n</aside>"
      parameters: []
      responses:
        204:
          description: 'Signer deleted successfully'
        403:
          description: 'Signature is not in preparation stage.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
        404:
          description: 'Signature or signer not found.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
      tags:
        - 'Signature Signers'
    parameters:
      -
        in: path
        name: signature
        description: 'The public ID of the signature resource.'
        example: zHQAQwQpBDmq
        required: true
        schema:
          type: string
      -
        in: path
        name: signer
        description: 'The public ID of the signer resource.'
        example: hT1XfmsMNvsy
        required: true
        schema:
          type: string
  '/v1/signatures/{signature}/documents':
    get:
      summary: 'List all documents'
      operationId: listAllDocuments
      description: 'List all documents associated with the provided signature ID.'
      parameters: []
      responses:
        200:
          description: 'An array containing all documents associated with the provided signature ID.'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: TG41YEDE8bk6
                      filename: UZW6YKmJvY
                      extension: pdf
                      name: UZW6YKmJvY.pdf
                      mime_type: application/pdf
                      bytes: 374363
                      file_hash: 123b4bb3e0669bbf2b1247903c00a702876c9f88338f5a4e3738f2318d1e26f6
                      created_at: '2024-10-17T09:37:08.000000Z'
                      updated_at: '2024-10-17T09:37:08.000000Z'
                    -
                      id: s5GiSoU2bGyy
                      filename: XBshJPECmE
                      extension: pdf
                      name: XBshJPECmE.pdf
                      mime_type: application/pdf
                      bytes: 648758
                      file_hash: 119148ec799432966de6fc43730a362a826c90d1f2e66e64c1a709b88209564c
                      created_at: '2024-10-17T09:37:08.000000Z'
                      updated_at: '2024-10-17T09:37:08.000000Z'
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: TG41YEDE8bk6
                        filename: UZW6YKmJvY
                        extension: pdf
                        name: UZW6YKmJvY.pdf
                        mime_type: application/pdf
                        bytes: 374363
                        file_hash: 123b4bb3e0669bbf2b1247903c00a702876c9f88338f5a4e3738f2318d1e26f6
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                      -
                        id: s5GiSoU2bGyy
                        filename: XBshJPECmE
                        extension: pdf
                        name: XBshJPECmE.pdf
                        mime_type: application/pdf
                        bytes: 648758
                        file_hash: 119148ec799432966de6fc43730a362a826c90d1f2e66e64c1a709b88209564c
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                    description: 'An array containing all documents associated with the provided signature ID.'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: TG41YEDE8bk6
                        filename:
                          type: string
                          example: UZW6YKmJvY
                        extension:
                          type: string
                          example: pdf
                        name:
                          type: string
                          example: UZW6YKmJvY.pdf
                        mime_type:
                          type: string
                          example: application/pdf
                        bytes:
                          type: integer
                          example: 374363
                        file_hash:
                          type: string
                          example: 123b4bb3e0669bbf2b1247903c00a702876c9f88338f5a4e3738f2318d1e26f6
                        created_at:
                          type: string
                          example: '2024-10-17T09:37:08.000000Z'
                        updated_at:
                          type: string
                          example: '2024-10-17T09:37:08.000000Z'
        404:
          description: 'Signature not found.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
      tags:
        - 'Signature Documents'
    post:
      summary: 'Upload document(s)'
      operationId: uploadDocuments
      description: "Upload one or multiple new documents that will become part of the signing process of the provided signature ID.\n\n<aside>\n    <b>Note:</b> Uploading new documents is no longer possible once the associated signature has left\n    <code>preparation</code> stage.\n</aside>\n\n<aside class=\"success\">\n    <b>Heads Up:</b> To save encoding overhead this endpoint only accepts <b><code>multipart/form-data</code></b>.\n</aside>"
      parameters: []
      responses:
        201:
          description: 'The created document resource.'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: Jrby6-iB7BcB
                      filename: J5PcqopqyS
                      extension: pdf
                      name: J5PcqopqyS.pdf
                      mime_type: application/pdf
                      bytes: 932763
                      file_hash: c23ead84681b271c452b1555345278f5dcf812e332069e82f757cfc3954b5b44
                      created_at: '2024-10-17T09:37:08.000000Z'
                      updated_at: '2024-10-17T09:37:08.000000Z'
                    -
                      id: YYSruY1AqJ-0
                      filename: niNO8DkIqF
                      extension: pdf
                      name: niNO8DkIqF.pdf
                      mime_type: application/pdf
                      bytes: 68120
                      file_hash: 413bafa18c77a5febddfb205ac565f65d43fdbc7ee32e636593fe9213bdd25a0
                      created_at: '2024-10-17T09:37:08.000000Z'
                      updated_at: '2024-10-17T09:37:08.000000Z'
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: Jrby6-iB7BcB
                        filename: J5PcqopqyS
                        extension: pdf
                        name: J5PcqopqyS.pdf
                        mime_type: application/pdf
                        bytes: 932763
                        file_hash: c23ead84681b271c452b1555345278f5dcf812e332069e82f757cfc3954b5b44
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                      -
                        id: YYSruY1AqJ-0
                        filename: niNO8DkIqF
                        extension: pdf
                        name: niNO8DkIqF.pdf
                        mime_type: application/pdf
                        bytes: 68120
                        file_hash: 413bafa18c77a5febddfb205ac565f65d43fdbc7ee32e636593fe9213bdd25a0
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                    description: 'The created document resource.'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: Jrby6-iB7BcB
                        filename:
                          type: string
                          example: J5PcqopqyS
                        extension:
                          type: string
                          example: pdf
                        name:
                          type: string
                          example: J5PcqopqyS.pdf
                        mime_type:
                          type: string
                          example: application/pdf
                        bytes:
                          type: integer
                          example: 932763
                        file_hash:
                          type: string
                          example: c23ead84681b271c452b1555345278f5dcf812e332069e82f757cfc3954b5b44
                        created_at:
                          type: string
                          example: '2024-10-17T09:37:08.000000Z'
                        updated_at:
                          type: string
                          example: '2024-10-17T09:37:08.000000Z'
        403:
          description: 'Signature is not in preparation stage.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
        404:
          description: 'Signature not found.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
        422:
          description: 'Validation of request payload failed.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
      tags:
        - 'Signature Documents'
      requestBody:
        required: false
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  description: 'The file representing the document that shall be uploaded. The filename must contain an extension. Must be a file. Must not be greater than 51200 kilobytes.'
                  items:
                    type: string
                    format: binary
    parameters:
      -
        in: path
        name: signature
        description: 'The public ID of the signature resource.'
        example: zHQAQwQpBDmq
        required: true
        schema:
          type: string
  '/v1/signatures/{signature}/documents/{document}':
    get:
      summary: 'Show document'
      operationId: showDocument
      description: "Retrieve information about a document associated with the provided signature ID.\n\n<aside>\n    <b>Note:</b> This endpoint exclusively offers information pertaining to the document as an API resource.\n    Retrieving the binary contents of the document is beyond the scope of this endpoint.\n</aside>"
      parameters: []
      responses:
        200:
          description: 'The document resource found by the provided ID.'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: TG41YEDE8bk6
                    filename: suwYjPTtZQ
                    extension: pdf
                    name: suwYjPTtZQ.pdf
                    mime_type: application/pdf
                    bytes: 374363
                    file_hash: 32058892680405bb7f13df7a7c4c0071eb314979209abb0b2338a9f5e781bd90
                    created_at: '2024-10-17T09:37:08.000000Z'
                    updated_at: '2024-10-17T09:37:08.000000Z'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: TG41YEDE8bk6
                        description: 'The public id of this document.'
                      filename:
                        type: string
                        example: suwYjPTtZQ
                        description: 'The name of the file of this document (without extension).'
                      extension:
                        type: string
                        example: pdf
                        description: 'The file extension of this document.'
                      name:
                        type: string
                        example: suwYjPTtZQ.pdf
                        description: '<code>filename</code> and <code>extension</code> combined forming the full filename.'
                      mime_type:
                        type: string
                        example: application/pdf
                        description: 'The MIME-Type of this document.'
                      bytes:
                        type: integer
                        example: 374363
                        description: 'The size of the document in bytes.'
                      file_hash:
                        type: string
                        example: 32058892680405bb7f13df7a7c4c0071eb314979209abb0b2338a9f5e781bd90
                        description: 'A SHA-256 hash of the file.'
                      created_at:
                        type: string
                        example: '2024-10-17T09:37:08.000000Z'
                        description: 'ISO-8601 formatted timestamp of when this resource has been created.'
                      updated_at:
                        type: string
                        example: '2024-10-17T09:37:08.000000Z'
                        description: 'ISO-8601 formatted timestamp of when this resource has last been updated.'
        403:
          description: 'Insufficient permissions'
          content:
            text/plain:
              schema:
                type: string
                example: ''
        404:
          description: 'Signature or document not found.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
      tags:
        - 'Signature Documents'
    delete:
      summary: 'Delete document'
      operationId: deleteDocument
      description: "Delete a document associated with the provided signature ID.\n\n<aside>\n    <b>Note:</b> Deleting a document is no longer possible once the associated signature has left\n    <code>preparation</code> stage.\n</aside>"
      parameters: []
      responses:
        204:
          description: 'Document deleted successfully'
        403:
          description: 'Signature is not in preparation stage.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
      tags:
        - 'Signature Documents'
    parameters:
      -
        in: path
        name: signature
        description: 'The public ID of the signature resource.'
        example: zHQAQwQpBDmq
        required: true
        schema:
          type: string
      -
        in: path
        name: document
        description: 'The public ID of the document resource.'
        example: hT1XfmsMNvsy
        required: true
        schema:
          type: string
  '/v1/signatures/{signature}/documents/{document}/download':
    get:
      summary: 'Download Document'
      operationId: downloadDocument
      description: "Retrieve a signed document of a completed signature process.\n\n<aside>\n     <b>Note:</b> Downloading a signed document is only allowed once the signature process\n     has been completed.\n </aside>"
      parameters: []
      responses:
        200:
          description: 'The requested document'
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        404:
          description: ''
          content:
            text/plain:
              schema:
                oneOf:
                  -
                    description: 'Signature not found.'
                    type: string
                    example: ''
                  -
                    description: 'Document not found.'
                    type: string
                    example: ''
        409:
          description: 'Signature is not in signed stage.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
      tags:
        - 'Signature Documents'
    parameters:
      -
        in: path
        name: signature
        description: 'The public ID of the signature resource.'
        example: zHQAQwQpBDmq
        required: true
        schema:
          type: string
      -
        in: path
        name: document
        description: 'The public ID of the document resource.'
        example: hT1XfmsMNvsy
        required: true
        schema:
          type: string
  '/v1/signatures/{signature}/logs':
    get:
      summary: 'List logs of Signature'
      operationId: listLogsOfSignature
      description: 'List all logs associated with the provided signature ID.'
      parameters: []
      responses:
        200:
          description: 'An array containing all logs associated with the provided signature ID.'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: dB8j5FEi6LaW
                      ip_address: '5e58:8b51:e6a5:4219:6b4d:9848:1b09:9794'
                      user_agent: 'Mozilla/5.0 (X11; Linux i686) AppleWebKit/536.1 (KHTML, like Gecko) Chrome/97.0.4631.50 Safari/536.1 EdgA/97.01095.73'
                      user_agent_hash: 5f47c1162a758cc1f6b6412f8dec7f96f1df0d2bf3c64a33cc14face823da083
                      message: signature_declined
                      data: {  }
                      created_at: '2024-10-17T09:37:08.000000Z'
                      updated_at: '2024-10-17T09:37:08.000000Z'
                    -
                      id: yfHJgXpdKynz
                      ip_address: 4.121.110.94
                      user_agent: 'Mozilla/5.0 (compatible; MSIE 7.0; Windows NT 6.0; Trident/5.0)'
                      user_agent_hash: 90163883f95ca8f099366c790343cdb2f7fad7fde5f66408181bb8372cb7ffde
                      message: signature_signed
                      data: {  }
                      created_at: '2024-10-17T09:37:08.000000Z'
                      updated_at: '2024-10-17T09:37:08.000000Z'
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: dB8j5FEi6LaW
                        ip_address: '5e58:8b51:e6a5:4219:6b4d:9848:1b09:9794'
                        user_agent: 'Mozilla/5.0 (X11; Linux i686) AppleWebKit/536.1 (KHTML, like Gecko) Chrome/97.0.4631.50 Safari/536.1 EdgA/97.01095.73'
                        user_agent_hash: 5f47c1162a758cc1f6b6412f8dec7f96f1df0d2bf3c64a33cc14face823da083
                        message: signature_declined
                        data: []
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                      -
                        id: yfHJgXpdKynz
                        ip_address: 4.121.110.94
                        user_agent: 'Mozilla/5.0 (compatible; MSIE 7.0; Windows NT 6.0; Trident/5.0)'
                        user_agent_hash: 90163883f95ca8f099366c790343cdb2f7fad7fde5f66408181bb8372cb7ffde
                        message: signature_signed
                        data: []
                        created_at: '2024-10-17T09:37:08.000000Z'
                        updated_at: '2024-10-17T09:37:08.000000Z'
                    description: 'An array containing all logs associated with the provided signature ID.'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: dB8j5FEi6LaW
                        ip_address:
                          type: string
                          example: '5e58:8b51:e6a5:4219:6b4d:9848:1b09:9794'
                        user_agent:
                          type: string
                          example: 'Mozilla/5.0 (X11; Linux i686) AppleWebKit/536.1 (KHTML, like Gecko) Chrome/97.0.4631.50 Safari/536.1 EdgA/97.01095.73'
                        user_agent_hash:
                          type: string
                          example: 5f47c1162a758cc1f6b6412f8dec7f96f1df0d2bf3c64a33cc14face823da083
                        message:
                          type: string
                          example: signature_declined
                        data:
                          type: object
                          properties: {  }
                        created_at:
                          type: string
                          example: '2024-10-17T09:37:08.000000Z'
                        updated_at:
                          type: string
                          example: '2024-10-17T09:37:08.000000Z'
        403:
          description: 'Insufficient permissions.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
        404:
          description: 'Signature not found.'
          content:
            text/plain:
              schema:
                type: string
                example: ''
      tags:
        - 'Signature Logs'
    parameters:
      -
        in: path
        name: signature
        description: 'The public ID of the signature resource.'
        example: zHQAQwQpBDmq
        required: true
        schema:
          type: string
  '/v1/signatures/{signature}/sign/{token}/message':
    get:
      summary: ''
      operationId: getV1SignaturesSignatureSignTokenMessage
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Endpoints
    parameters:
      -
        in: path
        name: signature
        description: 'The public ID of the signature resource.'
        example: zHQAQwQpBDmq
        required: true
        schema:
          type: string
      -
        in: path
        name: token
        description: ''
        example: illum
        required: true
        schema:
          type: string
tags:
  -
    name: Signatures
    description: "\nA Signature resource serves as the foundational element within the API, representing the process by which entities\naffix their signatures to documents. This resource forms the cornerstone of the signature API, and all other\nresources within this API are related to it."
  -
    name: 'Signature Signers'
    description: 'A signer is an entity that is able to sign the documents in a signature process.'
  -
    name: 'Signature Documents'
    description: 'A Signature Document represents any document that will be part of the signing process of the associated signature.'
  -
    name: 'Signature Logs'
    description: "\nActions performed in a signature process are logged per signature. A signature log represents a single action taken\nby an entity regarding a signature."
  -
    name: Endpoints
    description: ''
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: "To acquire an API token, please <a href=\"mailto:support@finosign.com\">contact us directly</a>, and our team\nwill be happy to assist you in obtaining the necessary credentials.<br />\n<br />\n<b>Note:</b> the API tokens used are considered confidential and must not be exposed to end users. If an\nAPI token is exposed by accident, it must be revoked immediately."
security:
  -
    default: []
