$schema: http://json-schema.org/draft-07/schema#
$id: https://raw.githubusercontent.com/api-evangelist/yousign/main/json-schema/yousign-json-schema.json
title: Yousign Public API v3 Schemas
description: JSON Schema definitions extracted from the Yousign Public API v3 OpenAPI
  specification.
definitions:
  UploadArchivedFile:
    properties:
      file:
        description: File to be uploaded
        format: binary
        type: string
      workspace_id:
        example: 69120884-d29a-4b1a-ac7b-a9e73a872795
        format: uuid
        nullable: true
        type: string
      archive_y:
        nullable: true
        pattern: ^(true|false)?$
        type: string
      tags:
        description: Tags for the file
        items:
          maxLength: 1000
          minLength: 1
          pattern: '[^\x00-\x1F\x7F]*'
          type: string
        nullable: true
        type: array
      expired_at:
        description: Expiration date of the file
        example: '2024-06-24 09:26:44'
        nullable: true
        pattern: ^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) ([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$
        type: string
    required:
    - file
    type: object
  ArchivedFile:
    description: ArchivedFile
    properties:
      id:
        example: 21ac9d25-e24d-4564-b964-d67eed561ca9
        format: uuid
        minLength: 1
        type: string
      sha256:
        description: Sha256 checksum
        example: 6ecf29381314217530c02c64a97050a0a6a0944bb974b6b417588277e289aef0
        maxLength: 64
        minLength: 64
        type: string
      filename:
        maxLength: 255
        minLength: 1
        type: string
      created_at:
        description: Creation date of the file
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      expired_at:
        description: Expiration date of the file
        example: '2025-01-18T22:59:00Z'
        format: date-time
        nullable: true
        type: string
      content_type:
        example: application/pdf
        type: string
      size:
        example: 123456
        minimum: 1
        type: integer
      archive_y_identifier:
        description: Identifier that allows to save the file in an additional storage.
        nullable: true
        type: string
      tags:
        description: Tags for the file
        items:
          maxLength: 1000
          minLength: 1
          pattern: '[^\x00-\x1F\x7F]*'
          type: string
        nullable: true
        type: array
      workspace_id:
        example: 528e2077-d0c1-4506-acd9-fac35a9cb7b4
        format: uuid
        minLength: 1
        type: string
    required:
    - archive_y_identifier
    - content_type
    - created_at
    - expired_at
    - filename
    - id
    - sha256
    - size
    - tags
    - workspace_id
    title: ArchivedFile
    type: object
  UUID:
    description: The unique identifier for a resource.
    example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
    format: uuid
    type: string
  DateYMD:
    example: '2022-12-10'
    format: date
    type: string
  Consumption:
    properties:
      app:
        $ref: '#/components/schemas/Consumption_app'
      api:
        $ref: '#/components/schemas/Consumption_api'
      connector:
        $ref: '#/components/schemas/Consumption_app'
    required:
    - api
    - app
    - connector
    type: object
  AddonConsumptionsName:
    enum:
    - bank_account_connection_verification
    - bank_account_lookup_verification
    - bank_account_verification
    - company_verification
    - company_de_verification
    - company_it_verification
    - document_analysis_verification
    - document_analysis_tax_notice_verification
    - document_trust_advanced_verification
    - identity_document_verification
    - identity_video_face_recognition_verification
    - certified_identity_pvid
    - identity_video_verification
    - proof_of_address_verification
    - watchlist_verification
    - advanced_electronic_seal
    - advanced_electronic_signature
    - advanced_electronic_signature_pre_verified
    - archiving
    - electronic_seal
    - electronic_signature
    - qualified_electronic_signature_identity_verification
    - qualified_electronic_signature_saved_identity
    type: string
  AddonConsumption:
    properties:
      name:
        $ref: '#/components/schemas/AddonConsumptionsName'
      start_at:
        description: Beginning of the addon subscription
        example: '2020-05-18T07:25:36Z'
        format: date-time
        type: string
      end_at:
        description: End of the addon subscription
        example: '2020-05-18T07:25:36Z'
        format: date-time
        type: string
      quota:
        minimum: 0
        type: integer
      consumed:
        minimum: 0
        type: integer
      provisioned:
        description: Only available for qualified_electronic_signature_identity_verification
          and qualified_electronic_signature_saved_identity addons
        minimum: 0
        type: integer
    required:
    - consumed
    - end_at
    - name
    - quota
    - start_at
    type: object
  PaginationWithUpdatedAt:
    description: Cursor based pagination
    properties:
      next_cursor:
        minLength: 1
        nullable: true
        type: string
      updated_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
    required:
    - next_cursor
    - updated_at
    type: object
  DetailedConsumption:
    properties:
      source:
        enum:
        - app
        - api
        - connector
        type: string
      type:
        enum:
        - invited_signers
        - electronic_seals
        - identification_attempts
        - archiving
        - verifications
        type: string
      level:
        description: 'Specifies the level of the consumed eSignature, eSeal and QES
          identification attempts: simple, advanced, or qualified.

          Only set when type is either `invited_signer`, `electronic_seals`, `identification_attempts`.

          '
        enum:
        - simple
        - advanced
        - qualified
        type: string
      verification_type:
        $ref: '#/components/schemas/KycAddonConsumptionsName'
      identification_mode:
        description: Only set if type is identification_attempts.
        enum:
        - identity_verification
        - saved_identity
        type: string
      workspace_id:
        description: Only set if breakdown is set on workspaces.
        example: 8b6ed2f3-244f-487a-baa1-bbe4f51c8744
        format: uuid
        minLength: 1
        type: string
      value:
        description: Count of items or file size in case of archiving.
        minimum: 1
        type: integer
    required:
    - source
    - type
    - value
    type: object
  Pagination:
    description: Metadata about the response.
    properties:
      next_cursor:
        description: 'Token to get the next page of results. If `null`, there are
          no more pages.

          '
        minLength: 1
        nullable: true
        type: string
    required:
    - next_cursor
    type: object
  ElectronicSealsConsumption:
    properties:
      seal_id:
        example: 0e8f7f8a-1b2c-4d3e-9f0a-b1c2d3e4f5a6
        format: uuid
        type: string
      document_id:
        example: 37646975-7e73-41f1-be7f-f4d85d181d03
        format: uuid
        type: string
      seal_level:
        description: Level of the Electronic Seal applied.
        enum:
        - electronic_signature
        - advanced_electronic_signature
        - qualified_electronic_signature_external
        example: electronic_signature
        type: string
      created_at:
        description: Creation time of the record
        example: '2024-05-01 12:00:00'
        type: string
      source:
        description: Origin of the operation.
        example: app
        type: string
      external_id:
        description: Optional user-defined identifier.
        example: ext-12345
        nullable: true
        type: string
      certificate_id:
        example: 6c82bd7a-d7f7-45e0-82f4-b92222567346
        format: uuid
        nullable: true
        type: string
      workspace_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      authentication_key:
        description: Identifier of the key used for the operation.
        example: authkey_live_2x1s3k9p
        nullable: true
        type: string
      workspace_name:
        description: Name of the workspace.
        example: My workspace
        type: string
      workspace_external_name:
        description: External name of the workspace.
        example: My workspace
        nullable: true
        type: string
    required:
    - authentication_key
    - certificate_id
    - created_at
    - document_id
    - external_id
    - seal_id
    - seal_level
    - source
    - workspace_external_name
    - workspace_id
    - workspace_name
    type: object
  IdentificationsConsumption:
    properties:
      created_at:
        description: Creation time of the record
        example: '2024-05-01 12:00:00'
        type: string
      signer_id:
        example: 0e8f7f8a-1b2c-4d3e-9f0a-b1c2d3e4f5a6
        format: uuid
        type: string
      signer_email:
        example: test@example.com
        type: string
      signature_request_id:
        example: 6c82bd7a-d7f7-45e0-82f4-b92222567346
        format: uuid
        nullable: true
        type: string
      signature_request_name:
        example: Signature Name
        type: string
      signature_level:
        description: Level of the Signature Request.
        enum:
        - simple_electronic_signature
        - advanced_electronic_signature
        - electronic_signature_with_qualified_certificate
        - qualified_electronic_signature
        example: simple_electronic_signature
        type: string
      signer_identification:
        description: Identification of the Signer.
        enum:
        - identity_verification
        - saved_identity
        type: string
      identified_at:
        description: Identification time of the signer
        example: '2024-05-01 12:00:00'
        type: string
      identification_status:
        description: Status of the identification.
        enum:
        - succeeded
        - rejected
        example: rejected
        type: string
      identification_reasons:
        example:
        - too_blury
        items:
          description: The reasons why the Signer failed to verify their identity.
          enum:
          - bad_internet_connection
          - document_expiry_date_missing
          - document_invalid_failed_owner
          - document_invalid_failed_rule
          - document_invalid_part_hidden
          - document_invalid_part_missing
          - face_identification_invalid
          - fraud_attempt_detected
          - identity_firstname_lastname_inversion
          - identity_firstname_mismatch
          - identity_firstname_missing
          - identity_lastname_mismatch
          - identity_probably_missing_firstname_parts
          - identity_probably_missing_lastname_parts
          - identity_probably_too_many_firstname_parts
          - identity_probably_too_many_lastname_parts
          - internal_error
          - video_quality_insufficient
          - too_blury
          - document_version_not_accepted
          - document_not_original
          - face_identity_inconsistency
          - altered_materials
          - unknown
          type: string
        nullable: true
        type: array
      sender_id:
        example: 0e8f7f8a-1b2c-4d3e-9f0a-b1c2d3e4f5a6
        format: uuid
        nullable: true
        type: string
      sender_email:
        example: test@example.com
        nullable: true
        type: string
      authentication_key:
        description: Identifier of the key used for the operation.
        example: authkey_live_2x1s3k9p
        nullable: true
        type: string
      authentication_key_description:
        description: Description of the key used for the operation.
        nullable: true
        type: string
      external_id:
        description: Optional user-defined identifier.
        example: ext-12345
        nullable: true
        type: string
      workspace_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        nullable: true
        type: string
      workspace_name:
        description: Name of the workspace.
        example: My workspace
        type: string
      signer_fullname:
        description: Full name of the signer.
        example: Jane Doe
        type: string
      workspace_external_name:
        description: External name of the workspace.
        example: My workspace
        nullable: true
        type: string
    required:
    - authentication_key
    - authentication_key_description
    - created_at
    - external_id
    - identification_reasons
    - identification_status
    - identified_at
    - sender_email
    - sender_id
    - signature_level
    - signature_request_id
    - signature_request_name
    - signer_email
    - signer_fullname
    - signer_id
    - signer_identification
    - workspace_external_name
    - workspace_id
    - workspace_name
    type: object
  InvitedSignersConsumption:
    properties:
      created_at:
        description: Creation time of the record
        example: '2024-05-01 12:00:00'
        type: string
      signer_id:
        example: 0e8f7f8a-1b2c-4d3e-9f0a-b1c2d3e4f5a6
        format: uuid
        type: string
      signer_email:
        example: test@example.com
        type: string
      signature_request_id:
        example: 6c82bd7a-d7f7-45e0-82f4-b92222567346
        format: uuid
        nullable: true
        type: string
      signature_request_name:
        example: Signature Name
        type: string
      signature_level:
        description: Level of the Signature Request.
        enum:
        - simple_electronic_signature
        - advanced_electronic_signature
        - electronic_signature_with_qualified_certificate
        - qualified_electronic_signature
        example: simple_electronic_signature
        type: string
      sender_id:
        example: 0e8f7f8a-1b2c-4d3e-9f0a-b1c2d3e4f5a6
        format: uuid
        nullable: true
        type: string
      sender_email:
        example: test@example.com
        nullable: true
        type: string
      source:
        description: Origin of the operation.
        example: app
        type: string
      connector:
        description: Signature request origin.
        enum:
        - app
        - public_api
        - connector_salesforce_api
        - hubspot_integration
        - connector_google_api
        - connector_zapier_api
        example: app
        nullable: true
        type: string
      authentication_key:
        description: Identifier of the key used for the operation.
        example: authkey_live_2x1s3k9p
        nullable: true
        type: string
      authentication_key_description:
        description: Description of the key used for the operation.
        nullable: true
        type: string
      external_id:
        description: Optional user-defined identifier.
        example: ext-12345
        nullable: true
        type: string
      workspace_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        nullable: true
        type: string
      workspace_name:
        description: Name of the workspace.
        example: My workspace
        type: string
      signer_fullname:
        description: Full name of the signer.
        example: Jane Doe
        type: string
      workspace_external_name:
        description: External name of the workspace.
        example: My workspace
        nullable: true
        type: string
    required:
    - authentication_key
    - authentication_key_description
    - connector
    - created_at
    - external_id
    - sender_email
    - sender_id
    - signature_level
    - signature_request_id
    - signature_request_name
    - signer_email
    - signer_fullname
    - signer_id
    - source
    - workspace_external_name
    - workspace_id
    - workspace_name
    type: object
  Contact:
    properties:
      id:
        format: uuid
        type: string
      first_name:
        type: string
      last_name:
        type: string
      email:
        format: email
        type: string
      locale:
        type: string
      phone_number:
        description: E.164 format
        nullable: true
        type: string
      company_name:
        nullable: true
        type: string
      job_title:
        nullable: true
        type: string
      address_line_1:
        nullable: true
        type: string
      address_line_2:
        nullable: true
        type: string
      address_city:
        nullable: true
        type: string
      address_postal_code:
        nullable: true
        type: string
      address_country:
        nullable: true
        type: string
      workspace_id:
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
    required:
    - address_city
    - address_country
    - address_line_1
    - address_line_2
    - address_postal_code
    - company_name
    - email
    - first_name
    - id
    - job_title
    - last_name
    - locale
    - phone_number
    title: Contact
    type: object
  CreateContact:
    properties:
      first_name:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        example: John
        maxLength: 255
        minLength: 1
        type: string
      last_name:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        example: Doe
        maxLength: 255
        minLength: 1
        type: string
      email:
        example: john.doe@example.com
        format: email
        type: string
      locale:
        $ref: '#/components/schemas/Locale'
      phone_number:
        description: E.164 format
        example: '+41446667700'
        minLength: 1
        type: string
      company_name:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: Yousign SAS
        format: safe-string
        maxLength: 255
        minLength: 1
        type: string
      job_title:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: Developer
        format: safe-string
        maxLength: 255
        minLength: 1
        type: string
      address_line_1:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: 34 Rue Malfilatre
        format: safe-string
        maxLength: 255
        minLength: 1
        type: string
      address_line_2:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: 1st floor
        format: safe-string
        maxLength: 255
        minLength: 1
        type: string
      address_city:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: Caen
        format: safe-string
        maxLength: 255
        minLength: 1
        type: string
      address_postal_code:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: '14000'
        format: safe-string
        maxLength: 255
        minLength: 1
        type: string
      address_country:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: France
        format: safe-string
        maxLength: 255
        minLength: 1
        type: string
      workspace_id:
        example: 69120884-d29a-4b1a-ac7b-a9e73a872795
        format: uuid
        nullable: true
        type: string
    required:
    - email
    - first_name
    - last_name
    - locale
    type: object
  UpdateContact:
    properties:
      first_name:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        example: John
        maxLength: 255
        minLength: 1
        type: string
      last_name:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        example: Doe
        maxLength: 255
        minLength: 1
        type: string
      email:
        example: john.doe@example.com
        format: email
        type: string
      locale:
        $ref: '#/components/schemas/Locale'
      phone_number:
        description: E.164 format
        example: '+41446667700'
        minLength: 1
        nullable: true
        type: string
      company_name:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: Yousign SAS
        format: safe-string
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      job_title:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: Developer
        format: safe-string
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      address_line_1:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: 34 Rue Malfilatre
        format: safe-string
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      address_line_2:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: 1st floor
        format: safe-string
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      address_city:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: Caen
        format: safe-string
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      address_postal_code:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: '14000'
        format: safe-string
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      address_country:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: France
        format: safe-string
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      workspace_id:
        example: 69120884-d29a-4b1a-ac7b-a9e73a872795
        format: uuid
        nullable: true
        type: string
    type: object
  CustomExperience:
    properties:
      id:
        format: uuid
        readOnly: true
        type: string
      name:
        type: string
      landing_page_disabled:
        type: boolean
      side_panel_disabled:
        type: boolean
      background_color:
        nullable: true
        type: string
      button_color:
        nullable: true
        type: string
      text_color:
        nullable: true
        type: string
      text_button_color:
        nullable: true
        type: string
      disabled_notifications:
        items:
          $ref: '#/components/schemas/CustomExperience_DisabledNotificationsType'
        type: array
      email_logo_disabled:
        type: boolean
      email_header_text_disabled:
        type: boolean
      email_footer_signature_disabled:
        type: boolean
      email_expiration_text_disabled:
        type: boolean
      recipients_activity_disabled:
        type: boolean
      download_documents_disabled:
        type: boolean
      document_navigation_disabled:
        type: boolean
      redirect_urls:
        $ref: '#/components/schemas/CustomExperience_redirect_urls'
      logo:
        example: https://yousign.com/custom_experience/89120884-d29a-4b1a-ac7b-a9e73a872795/logo
        format: uri
        nullable: true
        type: string
      source:
        $ref: '#/components/schemas/CustomExperience_Source'
      created_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
    required:
    - background_color
    - button_color
    - created_at
    - disabled_notifications
    - document_navigation_disabled
    - download_documents_disabled
    - email_expiration_text_disabled
    - email_footer_signature_disabled
    - email_header_text_disabled
    - email_logo_disabled
    - id
    - landing_page_disabled
    - logo
    - recipients_activity_disabled
    - redirect_urls
    - side_panel_disabled
    - source
    - text_button_color
    - text_color
    type: object
  CreateCustomExperience:
    properties:
      name:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        format: safe-string
        maxLength: 255
        minLength: 1
        type: string
      landing_page_disabled:
        default: false
        nullable: true
        type: boolean
      side_panel_disabled:
        default: false
        nullable: true
        type: boolean
      background_color:
        description: Hexadecimal color value
        example: '#ff0011'
        nullable: true
        pattern: ^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)
        type: string
      button_color:
        description: Hexadecimal color value
        example: '#ff0011'
        nullable: true
        pattern: ^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)
        type: string
      text_color:
        description: Hexadecimal color value
        example: '#ff0011'
        nullable: true
        pattern: ^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)
        type: string
      text_button_color:
        description: Hexadecimal color value
        example: '#ff0011'
        nullable: true
        pattern: ^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)
        type: string
      disabled_notifications:
        items:
          $ref: '#/components/schemas/CustomExperience_DisabledNotificationsType'
        nullable: true
        type: array
      email_logo_disabled:
        default: false
        nullable: true
        type: boolean
      email_header_text_disabled:
        default: false
        nullable: true
        type: boolean
      email_footer_signature_disabled:
        default: false
        nullable: true
        type: boolean
      email_expiration_text_disabled:
        default: false
        nullable: true
        type: boolean
      recipients_activity_disabled:
        default: true
        nullable: true
        type: boolean
      download_documents_disabled:
        default: false
        description: If true, signers won't be able to download documents before signing.
        nullable: true
        type: boolean
      document_navigation_disabled:
        default: false
        description: If true and the request contains more than 1 document, signers
          must read each document before moving to the next.
        nullable: true
        type: boolean
      redirect_urls:
        $ref: '#/components/schemas/CreateCustomExperience_redirect_urls'
      logo_layout:
        $ref: '#/components/schemas/LogoLayout'
    required:
    - name
    type: object
  UpdateCustomExperience:
    properties:
      name:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        format: safe-string
        type: string
      landing_page_disabled:
        nullable: true
        type: boolean
      side_panel_disabled:
        nullable: true
        type: boolean
      background_color:
        description: Hexadecimal color value
        example: '#ff0011'
        nullable: true
        pattern: ^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)
        type: string
      button_color:
        description: Hexadecimal color value
        example: '#ff0011'
        nullable: true
        pattern: ^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)
        type: string
      text_color:
        description: Hexadecimal color value
        example: '#ff0011'
        nullable: true
        pattern: ^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)
        type: string
      text_button_color:
        description: Hexadecimal color value
        example: '#ff0011'
        nullable: true
        pattern: ^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)
        type: string
      disabled_notifications:
        items:
          $ref: '#/components/schemas/CustomExperience_DisabledNotificationsType'
        nullable: true
        type: array
      email_logo_disabled:
        nullable: true
        type: boolean
      email_header_text_disabled:
        nullable: true
        type: boolean
      email_footer_signature_disabled:
        nullable: true
        type: boolean
      email_expiration_text_disabled:
        nullable: true
        type: boolean
      recipients_activity_disabled:
        nullable: true
        type: boolean
      download_documents_disabled:
        description: If true, signers won't be able to download documents before signing.
        nullable: true
        type: boolean
      document_navigation_disabled:
        default: false
        description: If true and the request contains more than 1 document, signers
          must read each document before moving to the next.
        nullable: true
        type: boolean
      redirect_urls:
        $ref: '#/components/schemas/UpdateCustomExperience_redirect_urls'
      logo_layout:
        $ref: '#/components/schemas/LogoLayout'
    type: object
  CustomPropertyType:
    enum:
    - text
    - list
    example: text
    type: string
  CustomPropertyList:
    properties:
      data:
        description: List of custom properties.
        items:
          $ref: '#/components/schemas/CustomProperty'
        type: array
      next_cursor:
        description: 'Cursor for the next page.

          Null if no more pages available.

          '
        nullable: true
        type: string
    required:
    - data
    title: CustomPropertyList
    type: object
  CreateCustomProperty:
    additionalProperties: false
    properties:
      name:
        description: Display name of the property.
        example: Document Type
        maxLength: 255
        minLength: 1
        type: string
      type:
        description: 'Field type. Cannot be changed after creation.

          '
        enum:
        - text
        - list
        example: list
        type: string
      multiple_answer_allowed:
        default: false
        description: 'For list type only. Whether multiple options can be selected.

          '
        type: boolean
      default_value:
        description: 'For text type only. Default text pre-filled on new SRs.

          '
        example: REF-001
        nullable: true
        type: string
      options:
        description: 'For list type only. Selectable options. At least one required.

          '
        items:
          $ref: '#/components/schemas/CustomPropertyOptionInput'
        minItems: 1
        type: array
      workspaces:
        description: 'List of Workspaces that define where the Custom Property is
          scoped. If the array is empty, the Custom Property is available to all Workspaces.

          '
        items:
          $ref: '#/components/schemas/UUID'
        minItems: 0
        type: array
        uniqueItems: true
    required:
    - name
    - type
    title: CreateCustomProperty
    type: object
  CustomProperty:
    properties:
      id:
        description: Unique identifier of the custom property.
        format: uuid
        type: string
      name:
        description: Display name of the property.
        type: string
      type:
        description: Field type.
        enum:
        - text
        - list
        type: string
      required:
        description: Whether users must fill this property before sending the SR via
          the application (not enforced via API).
        type: boolean
      multiple_answer_allowed:
        description: For list type only — whether multiple options can be selected.
          Null for text type.
        nullable: true
        type: boolean
      workspace_ids:
        description: List of workspace IDs where this property is applicable. Null
          means org-wide.
        items:
          $ref: '#/components/schemas/UUID'
        nullable: true
        type: array
      default_value:
        description: For text type only — default text pre-filled on new signature
          requests. Null for list type.
        maxLength: 1000
        nullable: true
        type: string
      options:
        description: 'For list type only: selectable options.

          Null for text type.

          '
        items:
          $ref: '#/components/schemas/CustomPropertyOption'
        nullable: true
        type: array
      created_at:
        description: Creation timestamp (ISO 8601).
        format: date-time
        type: string
      updated_at:
        description: Last update timestamp (ISO 8601).
        format: date-time
        type: string
    required:
    - created_at
    - id
    - name
    - type
    - updated_at
    title: CustomProperty
    type: object
  UpdateCustomProperty:
    additionalProperties: false
    properties:
      name:
        description: Display name of the property.
        example: Contract Type
        maxLength: 255
        minLength: 1
        type: string
      type:
        description: 'Cannot be changed after creation. If provided and different
          from current type, request is rejected with 400.

          '
        enum:
        - text
        - list
        type: string
      multiple_answer_allowed:
        description: 'For list type only. Whether multiple options can be selected.

          '
        type: boolean
      default_value:
        description: 'For text type only. Default text pre-filled on new SRs.

          '
        nullable: true
        type: string
      options:
        description: 'For list type only. Send the full array to replace all options.

          - Include id for existing options to preserve them (rename/reorder).

          - Omit id for new options.

          - Options not present in the array are removed.

          '
        items:
          $ref: '#/components/schemas/CustomPropertyOptionUpdate'
        type: array
      workspaces:
        description: 'List of Workspaces that define where the Custom Property is
          scoped. If the array is empty, the Custom Property is available to all Workspaces.

          '
        items:
          $ref: '#/components/schemas/UUID'
        minItems: 0
        type: array
        uniqueItems: true
    title: UpdateCustomProperty
    type: object
  DocumentAnalysisMeta:
    properties:
      id:
        $ref: '#/components/schemas/UUID'
      workspace_id:
        description: The Workspace ID in which the Document Analysis has been created.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      created_at:
        description: Creation date of the Document Analysis.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      updated_at:
        description: Update date of the Document Analysis.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      status:
        $ref: '#/components/schemas/DocumentAnalysisStatus'
      status_codes:
        description: 'List of status codes. Indicates the cause when the status is
          `failed`.


          `DA_1001` is **deprecated**: it is still emitted alongside more specific
          check-failure codes (e.g. `DA_2001`, `DA_2002`) for backward compatibility.
          New integrations should rely on the specific codes.

          '
        example: []
        items:
          enum:
          - DA_1001
          - DA_1002
          - DA_1003
          - DA_1004
          - DA_1100
          - DA_1201
          - DA_1202
          - DA_1301
          - DA_1302
          - DA_1303
          - DA_1304
          - DA_1401
          - DA_1402
          - DA_1403
          - DA_2001
          - DA_2002
          - DA_2301
          - DA_2302
          - DA_2401
          - DA_2402
          - DA_3001
          - DA_3003
          - DA_3004
          type: string
        type: array
      type:
        allOf:
        - $ref: '#/components/schemas/DocumentAnalysisType'
        description: 'Type of the analysed document.

          `null` for fraud-only analyses (`analysis_type.extraction` is `false`).

          '
        nullable: true
      country_code:
        description: 'The country code associated with the document analysis.

          Null for document types that don''t require a country code.

          '
        nullable: true
        type: string
        example: null
      data_anonymized:
        description: 'Indicates if the personal data extracted from the document has
          been anonymized.

          If set to `true`, the personal data has been anonymized and most fields
          will be NULL.

          '
        example: false
        type: boolean
      analysis_type:
        $ref: '#/components/schemas/AnalysisType'
      fraud_risk_analysis:
        $ref: '#/components/schemas/FraudRiskAnalysis'
    required:
    - country_code
    - created_at
    - data_anonymized
    - id
    - previous_attempt_id
    - status
    - status_codes
    - type
    - updated_at
    - workflow_session_id
    - workspace_id
    title: DocumentAnalysisMeta
    type: object
  InitiateDocumentAnalysisFromApplicant:
    additionalProperties: false
    properties:
      applicant_id:
        description: The Applicant ID linked to the Workflow Session.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      type:
        allOf:
        - $ref: '#/components/schemas/DocumentAnalysisType'
      analysis_type:
        $ref: '#/components/schemas/AnalysisType'
      country_code:
        description: 'The country code of the document.

          Required when `type` is `vehicle_registration_document` (accepted: `FR`,
          `IT`), `tax_notice` (accepted: `FR` only), `payslip` (accepted: `FR`, `IT`)
          or `invoice` (accepted: `FR` only).

          '
        enum:
        - FR
        - IT
        example: FR
        type: string
      checks:
        $ref: '#/components/schemas/InitiateDocumentAnalysisFromApplicant_checks'
    required:
    - applicant_id
    title: Attach a new Document Analysis to an Applicant
    type: object
  InitiateDocumentAnalysisFromMultipart:
    oneOf:
    - $ref: '#/components/schemas/InitiateSocialSecurity'
    - $ref: '#/components/schemas/InitiateCompanyCertificate'
    - $ref: '#/components/schemas/InitiateBusinessRegistrationCertificate'
    - $ref: '#/components/schemas/InitiateDriverLicence'
    - $ref: '#/components/schemas/InitiateRNECertificate'
    - $ref: '#/components/schemas/InitiateTemporaryVehicleRegistrationDocument'
    - $ref: '#/components/schemas/InitiateVehicleRegistrationDocument'
    - $ref: '#/components/schemas/InitiateAutoInsuranceClaimsHistory'
    - $ref: '#/components/schemas/InitiateTaxNotice'
    - $ref: '#/components/schemas/InitiatePayslip'
    - $ref: '#/components/schemas/InitiateInvoice'
    - $ref: '#/components/schemas/InitiateFraudOnly'
    type: object
  SocialSecurityFull:
    allOf:
    - $ref: '#/components/schemas/DocumentAnalysisMeta_1'
    - properties:
        type:
          enum:
          - social_security
          type: string
        extracted_from_document:
          $ref: '#/components/schemas/SocialSecurityExtraction'
        checks:
          $ref: '#/components/schemas/SocialSecurityCheck'
      type: object
    required:
    - checks
    - country_code
    - created_at
    - data_anonymized
    - extracted_from_document
    - id
    - previous_attempt_id
    - status
    - type
    - updated_at
    - workflow_session_id
    - workspace_id
    title: Social Security
    type: object
  CompanyCertificateFull:
    allOf:
    - $ref: '#/components/schemas/DocumentAnalysisMeta_1'
    - properties:
        type:
          enum:
          - company_certificate
          type: string
        extracted_from_document:
          $ref: '#/components/schemas/CompanyCertificateExtraction'
        checks:
          $ref: '#/components/schemas/CompanyCertificateCheck'
      type: object
    required:
    - checks
    - country_code
    - created_at
    - data_anonymized
    - extracted_from_document
    - id
    - previous_attempt_id
    - status
    - type
    - updated_at
    - workflow_session_id
    - workspace_id
    title: Company Certificate
    type: object
  BusinessRegistrationCertificateFull:
    allOf:
    - $ref: '#/components/schemas/DocumentAnalysisMeta_1'
    - properties:
        type:
          enum:
          - business_registration_certificate
          type: string
        extracted_from_document:
          $ref: '#/components/schemas/BusinessRegistrationCertificateExtraction'
        checks:
          $ref: '#/components/schemas/BusinessRegistrationCertificateCheck'
      type: object
    required:
    - checks
    - country_code
    - created_at
    - data_anonymized
    - extracted_from_document
    - id
    - previous_attempt_id
    - status
    - type
    - updated_at
    - workflow_session_id
    - workspace_id
    title: Business Registration Certificate
    type: object
  DriverLicenceFull:
    allOf:
    - $ref: '#/components/schemas/DocumentAnalysisMeta_1'
    - properties:
        type:
          enum:
          - driver_licence
          type: string
        extracted_from_document:
          $ref: '#/components/schemas/DriverLicenceExtraction'
        checks:
          $ref: '#/components/schemas/DriverLicenceCheck'
      type: object
    required:
    - checks
    - country_code
    - created_at
    - data_anonymized
    - extracted_from_document
    - id
    - previous_attempt_id
    - status
    - type
    - updated_at
    - workflow_session_id
    - workspace_id
    title: Driver Licence
    type: object
  RNECertificateFull:
    allOf:
    - $ref: '#/components/schemas/DocumentAnalysisMeta_1'
    - properties:
        type:
          enum:
          - rne_certificate
          type: string
        extracted_from_document:
          $ref: '#/components/schemas/RNECertificateExtraction'
        checks:
          $ref: '#/components/schemas/RNECertificateCheck'
      type: object
    required:
    - checks
    - country_code
    - created_at
    - data_anonymized
    - extracted_from_document
    - id
    - previous_attempt_id
    - status
    - type
    - updated_at
    - workflow_session_id
    - workspace_id
    title: RNE Certificate
    type: object
  TemporaryVehicleRegistrationDocumentFull:
    allOf:
    - $ref: '#/components/schemas/DocumentAnalysisMeta_1'
    - properties:
        type:
          enum:
          - temporary_vehicle_registration_document
          type: string
        country_code:
          enum:
          - IT
          type: string
        extracted_from_document:
          $ref: '#/components/schemas/TemporaryVehicleRegistrationDocumentExtraction'
        checks:
          $ref: '#/components/schemas/TemporaryVehicleRegistrationDocumentCheck'
      type: object
    required:
    - checks
    - country_code
    - created_at
    - data_anonymized
    - extracted_from_document
    - id
    - previous_attempt_id
    - status
    - type
    - updated_at
    - workflow_session_id
    - workspace_id
    title: Temporary Vehicle Registration Document
    type: object
  VehicleRegistrationDocumentFull:
    oneOf:
    - $ref: '#/components/schemas/French_Vehicle_Registration_Document'
    - $ref: '#/components/schemas/Italian_Vehicle_Registration_Document'
    title: Vehicle Registration Document
  AutoInsuranceClaimsHistoryFull:
    allOf:
    - $ref: '#/components/schemas/DocumentAnalysisMeta_1'
    - properties:
        type:
          enum:
          - auto_insurance_claims_history
          type: string
        extracted_from_document:
          $ref: '#/components/schemas/AutoInsuranceClaimsHistoryExtraction'
        checks:
          $ref: '#/components/schemas/AutoInsuranceClaimsHistoryCheck'
      type: object
    required:
    - checks
    - country_code
    - created_at
    - data_anonymized
    - extracted_from_document
    - id
    - previous_attempt_id
    - status
    - type
    - updated_at
    - workflow_session_id
    - workspace_id
    title: Auto Insurance Claims History
    type: object
  TaxNoticeFull:
    allOf:
    - $ref: '#/components/schemas/DocumentAnalysisMeta_1'
    - properties:
        type:
          enum:
          - tax_notice
          type: string
        extracted_from_document:
          $ref: '#/components/schemas/TaxNoticeExtraction'
        checks:
          $ref: '#/components/schemas/TaxNoticeCheck'
      type: object
    required:
    - checks
    - country_code
    - created_at
    - data_anonymized
    - extracted_from_document
    - id
    - previous_attempt_id
    - status
    - type
    - updated_at
    - workflow_session_id
    - workspace_id
    title: Tax Notice
    type: object
  PayslipFull:
    allOf:
    - $ref: '#/components/schemas/DocumentAnalysisMeta_1'
    - properties:
        type:
          enum:
          - payslip
          type: string
        extracted_from_document:
          $ref: '#/components/schemas/PayslipExtraction'
        checks:
          $ref: '#/components/schemas/PayslipCheck'
      type: object
    required:
    - checks
    - country_code
    - created_at
    - data_anonymized
    - extracted_from_document
    - id
    - previous_attempt_id
    - status
    - type
    - updated_at
    - workflow_session_id
    - workspace_id
    title: Payslip
    type: object
  InvoiceFull:
    allOf:
    - $ref: '#/components/schemas/DocumentAnalysisMeta_1'
    - properties:
        type:
          enum:
          - invoice
          type: string
        extracted_from_document:
          $ref: '#/components/schemas/FrenchInvoiceExtraction'
        checks:
          $ref: '#/components/schemas/InvoiceFull_allOf_checks'
      type: object
    required:
    - checks
    - country_code
    - created_at
    - data_anonymized
    - extracted_from_document
    - id
    - previous_attempt_id
    - status
    - type
    - updated_at
    - workflow_session_id
    - workspace_id
    title: French Invoice Document
    type: object
  FraudOnlyFull:
    allOf:
    - $ref: '#/components/schemas/DocumentAnalysisMeta_1'
    - properties:
        type:
          description: Always `null` for a fraud-only analysis (no document type).
          nullable: true
          type: string
          example: null
        analysis_type:
          $ref: '#/components/schemas/FraudOnlyFull_allOf_analysis_type'
        fraud_risk_analysis:
          $ref: '#/components/schemas/FraudRiskAnalysis'
      required:
      - analysis_type
      type: object
    description: 'Document Analysis run in fraud-only mode (`analysis_type.extraction`
      is `false`).

      No document `type` and no extracted data; only the fraud detection result is
      returned.

      '
    title: Fraud Only
    type: object
  CreateDocumentFromMultipart:
    properties:
      file:
        description: 'Binary file. Accepted formats: `PDF`, `DOCX`, `JPEG`, `JPG`
          and `PNG`. All files are converted to PDF upon upload.'
        format: binary
        type: string
      nature:
        description: 'Can take two values: `signable_document` or `attachment`. Files
          in `JPEG`, `JPG`, and `PNG` format can only be of `attachment` nature.'
        enum:
        - attachment
        - signable_document
        type: string
      insert_after_id:
        description: Insert just after the position of the specified document id.
        example: 8b6ed2f3-244f-487a-baa1-bbe4f51c8744
        format: uuid
        nullable: true
        type: string
      password:
        example: MyPa$$word
        type: string
      name:
        description: The document name. If not set, will use the uploaded document
          name. This value should contain any characters except "\", "/" and can\'t
          start and finish with a space.
        example: file1
        maxLength: 128
        minLength: 1
        pattern: ^(?!\s)[^\/\\]+(?<!\s)$
        type: string
      initials:
        allOf:
        - $ref: '#/components/schemas/InitialsArea'
        nullable: true
        type: object
      parse_anchors:
        default: false
        description: If true, the system will parse the document exclusively for Signature-type
          Smart Anchors and automatically generate the required fields.
        example: true
        nullable: true
        type: boolean
      excluded_approvers:
        $ref: '#/components/schemas/DocumentExcludedApprovers'
      excluded_signers:
        $ref: '#/components/schemas/DocumentExcludedSigners'
    required:
    - file
    - nature
    type: object
  Document:
    description: Document to attach to a Signature Request
    properties:
      id:
        example: 89120884-d29a-4b1a-ac7b-a9e73a872796
        format: uuid
        type: string
      filename:
        maxLength: 255
        minLength: 1
        type: string
      nature:
        enum:
        - attachment
        - signable_document
        type: string
      content_type:
        example: application/pdf
        type: string
      sha256:
        description: Sha256 checksum
        type: string
      is_protected:
        type: boolean
      is_signed:
        type: boolean
      created_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      total_pages:
        description: Number of pages for signable document
        minimum: 1
        nullable: true
        type: integer
      is_locked:
        description: If protected by password and not yet unlocked
        type: boolean
      initials:
        $ref: '#/components/schemas/Document_initials'
      total_anchors:
        description: Number of parsed anchors from the document.
        type: integer
      excluded_approvers:
        description: 'List of Approver IDs who cannot see this Document.

          '
        items:
          format: uuid
          type: string
        type: array
      excluded_signers:
        description: 'List of Signer IDs who cannot see this Document.

          '
        items:
          format: uuid
          type: string
        type: array
    required:
    - content_type
    - created_at
    - excluded_approvers
    - excluded_signers
    - filename
    - id
    - initials
    - is_locked
    - is_protected
    - is_signed
    - nature
    - sha256
    - total_anchors
    - total_pages
    title: Document
    type: object
  CreateElectronicSealDocument:
    properties:
      file:
        description: 'Binary file. Accepted formats: PDF.'
        format: binary
        type: string
      password:
        description: The password required to unlock the document if it is protected.
        example: MyPa$$word
        type: string
    required:
    - file
    type: object
  CreateElectronicSealDocumentFromJson:
    oneOf:
    - $ref: '#/components/schemas/From_Electronic_Seal_Document'
    - $ref: '#/components/schemas/From_Signature_Request_Document'
    type: object
  ElectronicSealDocument:
    properties:
      id:
        example: 1365283d-0ba5-4a08-9a58-9818ef428320
        format: uuid
        type: string
      total_pages:
        minimum: 1
        type: integer
      created_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      workspace_id:
        description: Unique identifier of the Workspace in which this Electronic Seal
          Document is scoped.
        example: ea11f308-4531-42f9-8218-96b37b7ebb19
        format: uuid
        type: string
    required:
    - created_at
    - id
    - total_pages
    - workspace_id
    type: object
  ElectronicSealImage:
    properties:
      id:
        example: 1365283d-0ba5-4a08-9a58-9818ef428320
        format: uuid
        type: string
      name:
        example: My seal image
        type: string
      created_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      workspace_id:
        description: Unique identifier of the Workspace in which this Electronic Seal
          Image is scoped.
        example: ea11f308-4531-42f9-8218-96b37b7ebb19
        format: uuid
        type: string
    required:
    - created_at
    - id
    - name
    - workspace_id
    type: object
  UploadElectronicSealImage:
    properties:
      file:
        description: 'Seal Image to be displayed on a sealed Document. Accepted formats:
          PNG/JPG/GIF, max 500 Ko.'
        format: binary
        type: string
      name:
        description: 'Name of the Seal Image.\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).

          '
        example: My seal image
        format: safe-string
        type: string
    required:
    - file
    - name
    type: object
  CreateElectronicSealImagePreviewPayload:
    additionalProperties: false
    properties:
      image_id:
        description: The ID of an existing Electronic Seal Image to use as the visual
          stamp.
        example: 04c9bf7e-e466-4204-97d2-d21cf5b314e4
        format: uuid
        nullable: true
        type: string
      field:
        $ref: '#/components/schemas/CreateElectronicSealImagePreviewPayload_field'
    required:
    - field
    title: CreateElectronicSealImagePreviewPayload
    type: object
  CreateElectronicSealPayload:
    properties:
      document_id:
        description: Specify which Electronic Seal Document to use for creating an
          Electronic Seal.
        example: 160473f9-156f-4583-848c-cbc3dec49b4a
        format: uuid
        type: string
      image_id:
        description: Specify which Electronic Seal Image to use for creating an Electronic
          Seal.
        example: 333fa90a-a629-4708-8fe9-160dcb055a9b
        format: uuid
        nullable: true
        type: string
      external_id:
        description: Store a custom id that will be added to webhooks
        example: externalId-123
        maxLength: 255
        nullable: true
        pattern: ^[\w\-@.%+]+$
        type: string
      fields:
        description: Fields you want to add to your Document. At least one Seal Field
          is mandatory.
        items:
          $ref: '#/components/schemas/CreateElectronicSealPayload_fields_inner'
        type: array
      signature_level:
        description: Level of Electronic Seal for your Document
        enum:
        - electronic_signature
        - advanced_electronic_signature
        nullable: true
        type: string
      certificate_id:
        description: Specify which certificate to use for creating an Electronic Seal
          (only available for advanced_electronic_signature level).
        example: a3d84df7-b45e-4321-ae9e-7f5397acb225
        format: uuid
        nullable: true
        type: string
    required:
    - document_id
    - fields
    title: CreateElectronicSealPayload
    type: object
  ElectronicSeal:
    properties:
      id:
        example: 1365283d-0ba5-4a08-9a58-9818ef428320
        format: uuid
        type: string
      status:
        enum:
        - pending
        - processing
        - done
        - error
        example: pending
        type: string
      created_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      document_id:
        example: 37646975-7e73-41f1-be7f-f4d85d181d03
        format: uuid
        type: string
      timestamp:
        type: boolean
      image_id:
        example: 6c82bd7a-d7f7-45e0-82f4-b92222567346
        format: uuid
        nullable: true
        type: string
      external_id:
        description: Store a custom id that will be added to webhooks
        example: externalId-123
        maxLength: 255
        nullable: true
        pattern: ^[\w\-@.%+]+$
        type: string
      signature_level:
        enum:
        - electronic_signature
        - advanced_electronic_signature
        example: electronic_signature
        type: string
      workspace_id:
        description: Unique identifier of the Workspace in which this Electronic Seal
          is scoped.
        example: 6c82bd7a-d7f7-45e0-82f4-b92222567346
        format: uuid
        type: string
    required:
    - created_at
    - document_id
    - external_id
    - id
    - image_id
    - signature_level
    - status
    - timestamp
    - workspace_id
    title: ElectronicSeal
    type: object
  ElectronicSealAuditTrail:
    properties:
      version:
        type: number
      classification:
        type: string
      organization:
        type: object
      seal:
        type: object
      document:
        type: object
    required:
    - classification
    - document
    - organization
    - seal
    - version
    type: object
    x-examples:
      example-1:
        version: 1
        classification: Confidential
        organization:
          id: d89a0f7b-bd3f-494d-ab61-71b69f24a3d9
          name: Universalt Music
        signer:
          id: 44e4b0f8-55c9-48a9-803f-d89957525270
          created_at: '2021-07-05 12:21:42.352630'
          seal_process_completed_at: '2021-07-05 12:21:43.656000'
          ip_address: 172.18.0.1
        documents:
          id: a9534a42-bbc1-4355-b270-58f315eda779
          initial_storage_id: fdad7bcf-73d5-4a73-945d-ba7b738c530b
          initial_hash:
            algorithm: sha256
            value: 8decc8571946d4cd70a024949e033a2a2a54377fe9f1c1b944c20f9ee11a9e51
          mime_type: application/pdf
          seals:
          - reason: Signed by Yousign
            hash:
              algorithm: sha256
              value: 4396f6a9f0554928f7bcc8e645a6441cb432c1606137ac8f3a735aef83946974
            timestamp: false
            certificate:
              dn: CN=Yousign, C=FR, O=Yousign, OU=794513986, serialNumber=2019-02-15
                10:07:35:938
              oid: 1.2.250.1.302.1.7.1.0
              generated_at: '2019-02-15 09:07:36.000000'
              hash:
                algorithm: sha256
                value: 69570e2d5cc2b352b2249ba32b16195722099a89aa35de71ee1e745f771d66c5
              content: '-----BEGIN CERTIFICATE-----

                MIIF8DCCA9igAwIBAgIIdfWiF8OAJo0wDQYJKoZIhvcNAQELBQAwfzEkMCIGA1UE

                AwwbWU9VU0lHTiBTQVMgLSBTSUdOMiBURVNUIENBMRIwEAYDVQQLDAk3OTQ1MTM5

                ODYxFDASBgNVBAoMC1lPVVNJR04gU0FTMQ0wCwYDVQQHDARDQUVOMREwDwYDVQQI

                DAhDQUxWQURPUzELMAkGA1UEBhMCRlIwHhcNMTkwMjE1MDg1NzM2WhcNMjIwMjE0

                MDkwNzAwWjBnMRAwDgYDVQQDDAdZb3VzaWduMSAwHgYDVQQFExcyMDE5LTAyLTE1

                IDEwOjA3OjM1OjkzODESMBAGA1UECwwJNzk0NTEzOTg2MRAwDgYDVQQKDAdZb3Vz

                aWduMQswCQYDVQQGEwJGUjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB

                AIWI+w9xQ9uSt4Lb/l14Yu8yRvCWer06bzm5RFvqgZRiD2Cq2Vx8LNzi0pGCxBdI

                Q9nlWcxCAh67Lp/OygCKpUN2DnNiIiORK5b283VKASlGMy5frVOCKiq2YCz0vA6k

                pIqzBP7DKV/CsZ3EqP0uw9C12EH3PrBJGQq4WOZI1Q5Fs2JAhOwfq/wq2orG424y

                0A9+smh8J3DjwSCoMQZrdHd/obK3w8AaTGI535dqWIZ0wKTZBZ7xahGAPGXo9cy9

                UXFtazxWGIcu5uYjRLtlUyialcUgB0db1eyOzFoRJCsaE6s7QgBhQUUfDkXs1UIp

                D0BfB/K2kPxGENm2Uk6WAfcCAwEAAaOCAYYwggGCMAwGA1UdEwEB/wQCMAAwHwYD

                VR0jBBgwFoAUzmRTx3jf2iI16mJGhB48l67NzPUwSwYDVR0gBEQwQjBABgoqgXoB

                gi4BBwEAMDIwMAYIKwYBBQUHAgEWJGh0dHA6Ly95b3VzaWduLmZyL2ZyL3B1Ymxp

                Yy9kb2N1bWVudDAgBgNVHSUEGTAXBgorBgEEAYI3CgMMBgkqhkiG9y8BAQUwgbIG

                A1UdHwSBqjCBpzA1oDOgMYYvaHR0cDovL3RtcC55b3VzaWduLmZyL2NybC95b3Vz

                aWduc2Fzc2lnbjJjYS5jcmwwNqA0oDKGMGh0dHA6Ly90bXAyLnlvdXNpZ24uZnIv

                Y3JsL3lvdXNpZ25zYXNzaWduMmNhLmNybDA2oDSgMoYwaHR0cDovL3RtcDMueW91

                c2lnbi5mci9jcmwveW91c2lnbnNhc3NpZ24yY2EuY3JsMB0GA1UdDgQWBBTgXAE8

                ONE89UOu8TjrtBH9cbd92jAOBgNVHQ8BAf8EBAMCBkAwDQYJKoZIhvcNAQELBQAD

                ggIBAAF+VPpcphjyoU8RvQO14ojWV51wJxsx5ShsvtXPsQ7dBws8XmthuTyyYxtM

                E3dldkJsaQt8vK7/AUURwO7YX7PHVlwIqm2kpNThZ4+sEib3SOivP8vpfIP3mD0+

                IFREI/8adIWYyiYzp1xjuuAoZ6lyg2JsOQ/67nyS+y7sUQ++GfQulb5yjkMytmYs

                PJ0uyjnNAI/+hy4okIY7qgHFZaDGBSqdGU28NZcCEeBLwjcH4ET2Q1LvJ7nkKQMM

                cxw+TXdy7cgIAjdfCymjJ701s43JKI01NFrNZ0I20jTOuh2qB4Kf8fQFwmutTnRM

                P4ZglXsXZkyL9snUWwMSAP9QP13fPD6EDTTshyijvwHb6zbrFg3U7J0m/Sjmqp2A

                zD+pj777dQ2jg0zTJ3WLOosE1/tt60ygK3HhiVnnyM8sdjTrZ6ca9++TgnRthKss

                R35c/1Be3RJtYnar2yn3bA2pklLcjnV8Q3ZSks4ll7XnEI9V8EQSNHkmno7k+asl

                WeQ8eC82fkwCwzXMLBTt1kN+0qXfpvVoSITPSVlOvdCsFCRSC3JMYHUY6c9oUUlV

                CCEBWxe/Vm8R+AG4i3zk9wIoLDLW2eeOx1G61QFtIlgJPbKRLiDZhaGZq1PN8T2o

                D/1S7m9PMISw1hrWHpJM+gZpRLsfRp5EH3ieRFzt24fpIosf

                -----END CERTIFICATE-----

                -----BEGIN CERTIFICATE-----

                MIIGnDCCBISgAwIBAgIIfVpT4jgxW6cwDQYJKoZIhvcNAQELBQAwfzEkMCIGA1UE

                AwwbWU9VU0lHTiBTQVMgLSBST09UMiBURVNUIENBMRIwEAYDVQQLDAk3OTQ1MTM5

                ODYxFDASBgNVBAoMC1lPVVNJR04gU0FTMQ0wCwYDVQQHDARDQUVOMREwDwYDVQQI

                DAhDQUxWQURPUzELMAkGA1UEBhMCRlIwHhcNMTYwMTI3MTYyODExWhcNMjYwMTI3

                MTYyODExWjB/MSQwIgYDVQQDDBtZT1VTSUdOIFNBUyAtIFNJR04yIFRFU1QgQ0Ex

                EjAQBgNVBAsMCTc5NDUxMzk4NjEUMBIGA1UECgwLWU9VU0lHTiBTQVMxDTALBgNV

                BAcMBENBRU4xETAPBgNVBAgMCENBTFZBRE9TMQswCQYDVQQGEwJGUjCCAiIwDQYJ

                KoZIhvcNAQEBBQADggIPADCCAgoCggIBALUsirI2GYG9qu3U2S4V4JI0V9ohNP3W

                EpssSBcepPBV4UPtwAbFGvJqtGO/0nNZO0J7UwUb0sZBnedFl96tRQff3PECyO9k

                1B1/8rK1TbLPQPhTYWlrvX69wHXJFPxf/JkL4l4Lp6nFS80SYlaRj2RHHJ8HDj8S

                P1oULnhW2f2i8AlJwFe34eLJbWgeI5D7UAo59GMQ6bO4aVMaaDWvXsKOn8qmCUwF

                gtQNOqtYyLgURr4qivbjsZEv5H4Ee+wR5J+U6wd9dpIoTV2g1mExNlKVoj9qX9rh

                4al4G80fKNUT8bVnzxmdkDZzuzKm+rNIN6Fnc5CTHu2IcMHcuvKMRvsSJ+0fiz1E

                b/xsKO18Aiy5XOEQFqDrXRKC5AMmF/zB9Fh1Xe7Bi6IQo15NOjOCHLiBTARsMBJ8

                RWTuTv89qnL1lECogFusbptDG4Gu7Y7M13V8gOoGAxBs6uALjoseFZcnLQlIjZCV

                L0xyhrXFCLFnv4gy2+xY1bJNueD3cLFkzaxiCJ4WKesmRIfc6vHaQNl5NpU+9tFb

                U6o01c3fjZUdIh/MR3GFIXNpPsilhl///5aT5h2L98Gmb2q7tqSbFqm5z17MG3uS

                e4zCt+UD7MI8oCF2CELo79xMjtmqEwIf0IU8MxaLaLSZ0J164ZyHwvfIewgBp8XF

                qLn0jrZNiocXAgMBAAGjggEaMIIBFjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQY

                MBaAFGXEFaTuRlW+zr11R8A0QEYcGvuRMIGyBgNVHR8EgaowgacwNaAzoDGGL2h0

                dHA6Ly90bXAueW91c2lnbi5mci9jcmwveW91c2lnbnNhc3Jvb3QyY2EuY3JsMDag

                NKAyhjBodHRwOi8vdG1wMi55b3VzaWduLmZyL2NybC95b3VzaWduc2Fzcm9vdDJj

                YS5jcmwwNqA0oDKGMGh0dHA6Ly90bXAzLnlvdXNpZ24uZnIvY3JsL3lvdXNpZ25z

                YXNyb290MmNhLmNybDAdBgNVHQ4EFgQUzmRTx3jf2iI16mJGhB48l67NzPUwDgYD

                VR0PAQH/BAQDAgEGMA0GCSqGSIb3DQEBCwUAA4ICAQBZ8ru8LEQ1qzQqG/Rx420f

                cN4YNM1cXV+DwpWOw46Oh9U7BG1i/wYPy6uEZvj/n+nm/MkbajrzTViZnKMRs7Wy

                CWBqvAfl4gcbWvrRzdVwsbd3UbsxD5UD1CkJYl5/4gPvCae6YVCF9WtnH2lSy/Gv

                5bbIfyXF++iNQn+lLe59EhA3WinTql/yk/SPUNVn4/IZ0UWrw1IPS3kmnIal1mk7

                pL45n5G51qAHpSbAoTsCeRBJZ6jr38n+FimZahnBZTu4+XycDVicrydpsopQiTt8

                ry+mP1b9Nd4eoHR4/F/82w1rNfAM0NJKL8w3qr8lMdxsbANMvW0ixgjRnBpuRRB4

                5iUA5Mb2DbiYJARBoruYqYGya317Gcvtk4w0O48CXR+HPXygHh/63De1JdOUjSc2

                Hagr6jp7NKbn/XmWBjWuoG9J9d9sC5U/mgjw5Xjf9jKGuUGz46EtlzzpojVB7fJA

                E2Ye0kOuLANpoTFAI4EJe5nTJz0HsFG3nDshsD9Mb1/kUBSGUDWijL5f0LDqf562

                kTioMpkK7ivZxQksF8+bMId5sUNrDVA/6lhn8tD5gzGacSU7IMfIH3EUKcI1NoWm

                hV+aI8EbXP6251cF74y/tejTUQLdOQ9ut3PsxYmTTDqr8RPI6UZeh2yibzSmgGwU

                fylsTiF/gVGm5cpWCrULCw==

                -----END CERTIFICATE-----

                -----BEGIN CERTIFICATE-----

                MIIGnDCCBISgAwIBAgIIT0TY3eM9ut0wDQYJKoZIhvcNAQELBQAwfzEkMCIGA1UE

                AwwbWU9VU0lHTiBTQVMgLSBST09UMiBURVNUIENBMRIwEAYDVQQLDAk3OTQ1MTM5

                ODYxFDASBgNVBAoMC1lPVVNJR04gU0FTMQ0wCwYDVQQHDARDQUVOMREwDwYDVQQI

                DAhDQUxWQURPUzELMAkGA1UEBhMCRlIwHhcNMTYwMTI3MTYyNjE2WhcNMzYwMTI3

                MTYyNjE2WjB/MSQwIgYDVQQDDBtZT1VTSUdOIFNBUyAtIFJPT1QyIFRFU1QgQ0Ex

                EjAQBgNVBAsMCTc5NDUxMzk4NjEUMBIGA1UECgwLWU9VU0lHTiBTQVMxDTALBgNV

                BAcMBENBRU4xETAPBgNVBAgMCENBTFZBRE9TMQswCQYDVQQGEwJGUjCCAiIwDQYJ

                KoZIhvcNAQEBBQADggIPADCCAgoCggIBALXMHUFwSacaI5TjtMRw4kJ9o1ve/IZo

                oj+2HOpW3iqs74cmsYjpHbJD0UAdh3SpdlLFK1/WBf0uEbzn6z7gRfUkEAo5EnHs

                M1iTfCXWDtA+xd9X4h2UAVEdXRzglvOvT275fjI1uj9Zi4Rz95drhlGkZVCDIMuv

                7fazkT868grWSfGSUc2C8d9+kOL4pCKuSanOc/nwD61F+oQ6KeEMtmpbr57Yy+qY

                taF6ieKiDGn0aDj3yImnA9YqfFlX4mCyn+LmiqrXyEn0Z5iYLbO0wXkyPqhcO9c9

                gS1Y8Y/1AEvxnaLlV3eG402ZYUS6tT27o+tpdCAIx+3zMhNsPI9wXUjlVr/8ts+/

                uOUUCUWoBK3J6R1zG3urCdnuor8xAaWK/OHtvg8rXoXEfi8ujWV3EbiwIwiUHVh4

                rJIE1vhsVPW/sTM9yEjRFks0swyoX6QupEuaZLV4DbmcEbmZ2XIH5Cw2c1qwUTk2

                8vQzKHszLdRb9scnjd3yHsef5ZAHS9hUoFIfG+MzINGm3U6v4exspSw/EshSavVj

                R+gL0l+sdK4L6xe++K++Gpp5xn5cZUJeg4YtdgGju7lMdGpJVVwl0Y8UAEJt9xgC

                MvGctrkoaUuBjOhrGQQITDMsNrtgi28s7rUB6k+yxcaGBBp2PyAIsIe0e1wKGm1N

                HjGtqY0IV1tFAgMBAAGjggEaMIIBFjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQY

                MBaAFGXEFaTuRlW+zr11R8A0QEYcGvuRMIGyBgNVHR8EgaowgacwNaAzoDGGL2h0

                dHA6Ly90bXAueW91c2lnbi5mci9jcmwveW91c2lnbnNhc3Jvb3QyY2EuY3JsMDag

                NKAyhjBodHRwOi8vdG1wMi55b3VzaWduLmZyL2NybC95b3VzaWduc2Fzcm9vdDJj

                YS5jcmwwNqA0oDKGMGh0dHA6Ly90bXAzLnlvdXNpZ24uZnIvY3JsL3lvdXNpZ25z

                YXNyb290MmNhLmNybDAdBgNVHQ4EFgQUZcQVpO5GVb7OvXVHwDRARhwa+5EwDgYD

                VR0PAQH/BAQDAgEGMA0GCSqGSIb3DQEBCwUAA4ICAQCuxOXQDSYF0RpYQWonRDlU

                Z64IaGJ5buU4tGzf7rAgIQdXbO/VjjfF9UsjnLopNwWkuSJvINm21obYHcoSwvpz

                lwS/3uJCLxaw5q4SVJ4x5rajh/2qtFzcThSh48rcXcqoxAmc6BzQuIOm9cFUD2Ri

                qUJmg5O+CoLuE1b4i+CsCFL3AoWnBHFZ4YtInQBFIRBhMNPICvYOCF6jjgmMxkWU

                M8SEp7FSFfsy/oPI1dt+k9JjHCXhtWO9ndLvvwvLcjqRO3ItiF9IazsNcNLhaIMA

                lvYiQ+jLpckAuTxj7XHQyJSEofTMPr+ZSgQwUc337MJyxPhTDkch5cQBfnC20Usk

                yjdwwaeiwnNMhESwgDa4Oqw5IOmq+VmqtR+9F9yxACrpyph593F1zYwv7ikik5dI

                IYACb2fKLQrcnCfhm0k1Nt9UXoc9mQzFUK0DWJNLeGJo0rfRQh5ZqhcBG2U0KZFQ

                RtQQEf3zXJxQJGlCn1UMZMJswAzfhMTdGPNzyDI2u+9Q8WT7M2f59Idiae2m79uG

                uStRwN7Vnrpa399YXixOpNTz6d0NFBOAq1Nfwy5cnQDCnT9JkrKidrFKyA21b67m

                SfJIpMSPfFbt3g0h7JPWK7OC4Ydydh92e7/IUhtkudKMoazlwSJ7484dE7NyTpol

                62H0sW/1gmFzE6/QmCUR+w==

                -----END CERTIFICATE-----'
  Label:
    properties:
      id:
        description: Unique identifier of the Label.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: false
        readOnly: true
        type: string
      name:
        description: Name of the Label.
        example: Contracts
        maxLength: 128
        minLength: 1
        nullable: false
        type: string
      created_at:
        description: Creation date of the Label.
        example: '2025-02-12T23:59:59Z'
        format: date-time
        nullable: false
        readOnly: true
        type: string
    required:
    - created_at
    - id
    - name
    title: Label
    type: object
  CreateLabel:
    properties:
      name:
        description: 'Name of the Label. Each Label name must be unique within the
          organization.\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email, HTML and URL.

          '
        example: Contracts
        format: safe-string
        maxLength: 128
        minLength: 1
        nullable: false
        title: Name of the Label.
        type: string
    required:
    - name
    title: A Label object
    type: object
  UpdateLabel:
    properties:
      name:
        description: 'Name of the Label. Each Label name must be unique within the
          organization.\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email, HTML and URL.

          '
        example: Contracts
        format: safe-string
        maxLength: 128
        minLength: 1
        nullable: false
        title: The name of your Label
        type: string
    required:
    - name
    title: A Label object
    type: object
  SignatureRequestInList:
    properties:
      id:
        example: 89120884-d29a-4b1a-ac7b-a9e73a872795
        minLength: 1
        type: string
      status:
        $ref: '#/components/schemas/SignatureRequestStatus'
      name:
        example: signature request name
        maxLength: 128
        minLength: 1
        type: string
      delivery_mode:
        enum:
        - email
        - none
        type: string
      created_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        minLength: 1
        type: string
      activated_at:
        description: 'Timestamp indicating when the Signature Request was activated
          and made available to its recipients.\

          Returns `null` if the Signature Request is still in `draft`.

          '
        example: '2024-01-18T22:59:00Z'
        format: date-time
        nullable: true
        readOnly: true
        type: string
      completed_at:
        description: 'Timestamp indicating when the Signature Request reached the
          `done` status, i.e. all required Signers have signed and all Approvers have
          approved.\

          Returns `null` if the Signature Request is not yet complete.

          '
        example: '2024-01-18T22:59:00Z'
        format: date-time
        nullable: true
        readOnly: true
        type: string
      approved_at:
        description: 'Timestamp indicating when all Approvers have approved the Signature
          Request when custom recipient flow is not enabled.\

          Returns `null` if no approvers are configured, or if at least one approver
          has not yet approved, or when `custom_recipient_order` is enabled.

          '
        example: '2024-01-18T22:59:00Z'
        format: date-time
        nullable: true
        readOnly: true
        type: string
      ordered_signers:
        description: Enable an ordered workflow, each Signer will be requested to
          sign in a sequential order
        type: boolean
      ordered_approvers:
        description: Enable an ordered workflow, each Approver will be requested to
          approve in a sequential order
        type: boolean
      reminder_settings:
        $ref: '#/components/schemas/SignatureRequestInList_reminder_settings'
      timezone:
        $ref: '#/components/schemas/SignatureRequestTimeZone'
      email_custom_note:
        deprecated: true
        example: Please sign these documents as soon as possible.
        nullable: true
        type: string
      expiration_date:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      source:
        enum:
        - app
        - public_api
        - hubspot_integration
        - connector_salesforce_api
        - connector_google_api
        - connector_zapier_api
        type: string
      signers:
        items:
          $ref: '#/components/schemas/SignatureRequestInList_signers_inner'
        type: array
      approvers:
        items:
          $ref: '#/components/schemas/SignatureRequestInList_approvers_inner'
        type: array
      labels:
        description: Labels associated to the Signature Request
        items:
          $ref: '#/components/schemas/SignatureRequestLabel'
        type: array
      documents:
        items:
          $ref: '#/components/schemas/SignatureRequestInList_documents_inner'
        type: array
      sender:
        $ref: '#/components/schemas/SignatureRequestInList_sender'
      external_id:
        example: An_external-ID
        nullable: true
        type: string
      branding_id:
        deprecated: true
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      custom_experience_id:
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      signers_allowed_to_decline:
        example: true
        type: boolean
      workspace_id:
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      audit_trail_locale:
        $ref: '#/components/schemas/AuditTrailLocale'
      bulk_send_batch_id:
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      custom_recipient_order:
        description: Enable a custom recipients order
        type: boolean
      custom_properties:
        description: Custom properties associated with the Signature Request.
        items:
          $ref: '#/components/schemas/CustomPropertyInList'
        type: array
    required:
    - activated_at
    - approved_at
    - audit_trail_locale
    - branding_id
    - bulk_send_batch_id
    - completed_at
    - created_at
    - custom_experience_id
    - custom_recipient_order
    - delivery_mode
    - documents
    - email_custom_note
    - expiration_date
    - external_id
    - id
    - name
    - ordered_approvers
    - ordered_signers
    - previous_attempt_id
    - reminder_settings
    - sender
    - signers
    - signers_allowed_to_decline
    - source
    - status
    - timezone
    - workflow_session_id
    title: SignatureRequest
    type: object
  CreateSignatureRequest:
    additionalProperties: false
    oneOf:
    - $ref: '#/components/schemas/New_Signature_Request_From_Scratch'
    - $ref: '#/components/schemas/Duplicate_a_Signature_Request'
    type: object
  SignatureRequest:
    properties:
      id:
        example: 89120884-d29a-4b1a-ac7b-a9e73a872795
        minLength: 1
        type: string
      status:
        $ref: '#/components/schemas/SignatureRequestStatus'
      name:
        example: signature request name
        maxLength: 128
        minLength: 1
        type: string
      delivery_mode:
        enum:
        - email
        - none
        type: string
      created_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        minLength: 1
        type: string
      activated_at:
        description: 'Timestamp indicating when the Signature Request was activated
          and made available to its recipients.\

          Returns `null` if the Signature Request is still in `draft`.

          '
        example: '2024-01-18T22:59:00Z'
        format: date-time
        nullable: true
        readOnly: true
        type: string
      completed_at:
        description: 'Timestamp indicating when the Signature Request reached the
          `done` status, i.e. all required Signers have signed and all Approvers have
          approved.\

          Returns `null` if the Signature Request is not yet complete.

          '
        example: '2024-01-18T22:59:00Z'
        format: date-time
        nullable: true
        readOnly: true
        type: string
      approved_at:
        description: 'Timestamp indicating when all Approvers have approved the Signature
          Request when custom recipient flow is not enabled.\

          Returns `null` if no approvers are configured, or if at least one approver
          has not yet approved, or when `custom_recipient_order` is enabled.

          '
        example: '2024-01-18T22:59:00Z'
        format: date-time
        nullable: true
        readOnly: true
        type: string
      ordered_signers:
        description: Enable an ordered workflow, each Signer will be requested to
          sign in a sequential order
        type: boolean
      ordered_approvers:
        description: Enable an ordered workflow, each Approver will be requested to
          approve in a sequential order
        type: boolean
      reminder_settings:
        $ref: '#/components/schemas/SignatureRequestInList_reminder_settings'
      timezone:
        $ref: '#/components/schemas/SignatureRequestTimeZone'
      email_custom_note:
        deprecated: true
        example: Please sign these documents as soon as possible.
        maxLength: 500
        nullable: true
        type: string
      expiration_date:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      source:
        enum:
        - app
        - public_api
        - hubspot_integration
        - connector_salesforce_api
        - connector_google_api
        - connector_zapier_api
        type: string
      signers:
        items:
          $ref: '#/components/schemas/SignatureRequestInList_signers_inner'
        type: array
      approvers:
        items:
          $ref: '#/components/schemas/SignatureRequestInList_approvers_inner'
        type: array
      labels:
        description: Labels associated to the Signature Request
        items:
          $ref: '#/components/schemas/SignatureRequestLabel'
        type: array
      documents:
        items:
          $ref: '#/components/schemas/SignatureRequestInList_documents_inner'
        type: array
      sender:
        $ref: '#/components/schemas/SignatureRequestInList_sender'
      external_id:
        example: An_external-ID
        nullable: true
        type: string
      branding_id:
        deprecated: true
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      custom_experience_id:
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      signers_allowed_to_decline:
        example: true
        type: boolean
      workspace_id:
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      audit_trail_locale:
        $ref: '#/components/schemas/AuditTrailLocale'
      email_notification:
        $ref: '#/components/schemas/SignatureRequest_email_notification'
      bulk_send_batch_id:
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      decline_information:
        $ref: '#/components/schemas/SignatureRequest_decline_information'
      rejection_information:
        $ref: '#/components/schemas/SignatureRequest_rejection_information'
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      custom_recipient_order:
        description: Enable a custom recipients order
        type: boolean
      custom_properties:
        description: Custom properties associated with the Signature Request.
        items:
          $ref: '#/components/schemas/CustomPropertyValue'
        type: array
    required:
    - activated_at
    - approved_at
    - audit_trail_locale
    - branding_id
    - bulk_send_batch_id
    - completed_at
    - created_at
    - custom_experience_id
    - custom_recipient_order
    - delivery_mode
    - documents
    - email_custom_note
    - email_notification
    - expiration_date
    - external_id
    - id
    - name
    - ordered_approvers
    - ordered_signers
    - previous_attempt_id
    - rejection_information
    - reminder_settings
    - sender
    - signers
    - signers_allowed_to_decline
    - source
    - status
    - timezone
    - workflow_session_id
    title: SignatureRequest
    type: object
  UpdateSignatureRequest:
    properties:
      name:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        format: safe-string
        maxLength: 128
        minLength: 1
        type: string
      delivery_mode:
        description: Delivery mode to notify signers.
        enum:
        - none
        - email
        type: string
      ordered_signers:
        description: Enable an ordered workflow, each signer will be requested to
          sign in a sequential order
        example: true
        type: boolean
      ordered_approvers:
        description: 'When enabled, Approvers are requested to approve sequentially.

          Each Approver will be invited to approve only once the previous one has
          completed their approval.

          '
        example: true
        type: boolean
      reminder_settings:
        $ref: '#/components/schemas/UpdateSignatureRequest_reminder_settings'
      timezone:
        $ref: '#/components/schemas/SignatureRequestTimeZone'
      email_custom_note:
        deprecated: true
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email.
        example: Please sign these documents as soon as possible.
        format: safe-string
        maxLength: 500
        nullable: true
        type: string
      expiration_date:
        description: 'Due date of the Signature Request (yyyy-mm-dd).

          The date cannot be in the past and cannot be more than one year after initiation.

          '
        format: date
        pattern: ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
        type: string
      external_id:
        maxLength: 255
        nullable: true
        pattern: ^[\w\-@.%+]+$
        type: string
      branding_id:
        deprecated: true
        example: 3a93d3b5-fb3b-4abf-9e70-26315b33506b
        format: uuid
        nullable: true
        type: string
      custom_experience_id:
        description: Use a specific Custom Experience to customize the signature experience.
        example: 3a93d3b5-fb3b-4abf-9e70-26315b33506b
        format: uuid
        nullable: true
        type: string
      signers_allowed_to_decline:
        default: false
        description: Allowing signers to decline to sign.
        example: true
        type: boolean
      workspace_id:
        description: Transfer the Signature Request into a given Workspace.
        example: 3a93d3b5-fb3b-4abf-9e70-26315b33506b
        format: uuid
        nullable: true
        type: string
      audit_trail_locale:
        allOf:
        - $ref: '#/components/schemas/AuditTrailLocale'
        description: Define the locale for the generated audit trail.
        nullable: true
        type: string
      email_notification:
        $ref: '#/components/schemas/SignatureRequest_EmailNotification'
      labels:
        description: List of Labels to associate with the Signature Request. Labels
          are identified by their ID.
        example:
        - 3a93d3b5-fb3b-4abf-9e70-26315b33506b
        - 89120884-d29a-4b1a-ac7b-a9e73a872795
        items:
          format: uuid
          type: string
        maxItems: 50
        type: array
    type: object
  ActivateSignatureRequest:
    properties:
      sender_id:
        description: 'The Id of the User that should be considered as the Signature
          Request sender.

          They must be part of the Workspace of the Signature Request and be active.

          Mandatory with `sender_type: "user"`, must be omitted otherwise.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
    type: object
  SignatureRequestActivated:
    properties:
      id:
        example: 89120884-d29a-4b1a-ac7b-a9e73a872795
        minLength: 1
        type: string
      status:
        enum:
        - ongoing
        - approval
        type: string
      name:
        example: signature request name
        maxLength: 128
        minLength: 1
        type: string
      delivery_mode:
        enum:
        - email
        - none
        type: string
      created_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        minLength: 1
        type: string
      activated_at:
        description: 'Timestamp indicating when the Signature Request was activated
          and made available to its recipients.\

          Returns `null` if the Signature Request is still in `draft`.

          '
        example: '2024-01-18T22:59:00Z'
        format: date-time
        nullable: true
        readOnly: true
        type: string
      completed_at:
        description: 'Timestamp indicating when the Signature Request reached the
          `done` status, i.e. all required Signers have signed and all Approvers have
          approved.\

          Returns `null` if the Signature Request is not yet complete.

          '
        example: '2024-01-18T22:59:00Z'
        format: date-time
        nullable: true
        readOnly: true
        type: string
      approved_at:
        description: 'Timestamp indicating when all Approvers have approved the Signature
          Request when custom recipient flow is not enabled.\

          Returns `null` if no approvers are configured, or if at least one approver
          has not yet approved, or when `custom_recipient_order` is enabled.

          '
        example: '2024-01-18T22:59:00Z'
        format: date-time
        nullable: true
        readOnly: true
        type: string
      ordered_signers:
        description: Enable an ordered workflow, each Signer will be requested to
          sign in a sequential order
        example: true
        type: boolean
      ordered_approvers:
        description: Enable an ordered workflow, each Approver will be requested to
          approve in a sequential order
        example: true
        type: boolean
      reminder_settings:
        $ref: '#/components/schemas/SignatureRequestInList_reminder_settings'
      timezone:
        $ref: '#/components/schemas/SignatureRequestTimeZone'
      email_custom_note:
        deprecated: true
        example: Please sign these documents as soon as possible.
        nullable: true
        type: string
      expiration_date:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      signers:
        items:
          $ref: '#/components/schemas/EmbeddedSignerWithSignatureLink'
        minItems: 1
        type: array
        uniqueItems: true
      approvers:
        items:
          $ref: '#/components/schemas/ApproverToNotify'
        type: array
        uniqueItems: true
      labels:
        description: Labels associated to the Signature Request
        items:
          $ref: '#/components/schemas/SignatureRequestLabel'
        type: array
      documents:
        items:
          $ref: '#/components/schemas/SignatureRequestActivated_documents_inner'
        type: array
      external_id:
        maxLength: 255
        nullable: true
        pattern: ^[\w\-@.%+]+$
        type: string
      branding_id:
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      custom_experience_id:
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      audit_trail_locale:
        $ref: '#/components/schemas/AuditTrailLocale'
      signers_allowed_to_decline:
        type: boolean
      rejection_information:
        $ref: '#/components/schemas/SignatureRequest_rejection_information'
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      custom_recipient_order:
        description: Enable a custom recipients order
        type: boolean
    required:
    - activated_at
    - approved_at
    - audit_trail_locale
    - branding_id
    - completed_at
    - created_at
    - custom_experience_id
    - custom_recipient_order
    - delivery_mode
    - documents
    - email_custom_note
    - expiration_date
    - external_id
    - id
    - name
    - ordered_approvers
    - ordered_signers
    - previous_attempt_id
    - rejection_information
    - reminder_settings
    - signers
    - signers_allowed_to_decline
    - status
    - timezone
    - workflow_session_id
    title: SignatureRequestActivated
    type: object
  CreateApprover:
    oneOf:
    - $ref: '#/components/schemas/New_Approver_From_Scratch'
    - $ref: '#/components/schemas/New_Approver_From_Existing_User'
    - $ref: '#/components/schemas/New_Approver_From_Existing_Contact'
    - $ref: '#/components/schemas/New_Approver_From_Existing_Signer'
    properties:
      custom_text:
        $ref: '#/components/schemas/CustomText'
      insert_after_id:
        description: 'ID of the recipient this one must follow in an ordered flow;
          they will only be asked to act after that recipient.

          When `custom_recipient_order` is enabled, this can reference any approver
          or signer.

          When `custom_recipient_order` is disabled, the referenced ID must be an
          approver. `ordered_approvers` must be enabled on the Signature Request.

          '
        example: 8b6ed2f3-244f-487a-baa1-bbe4f51c8744
        format: uuid
        nullable: true
        type: string
      group_with_id:
        description: 'ID of another recipient (Approver or Signer); both will be allowed
          to act in parallel in an ordered flow.

          Only available when `custom_recipient_order` is enabled.

          '
        example: 8b6ed2f3-244f-487a-baa1-bbe4f51c8744
        format: uuid
        nullable: true
        type: string
      excluded_documents:
        $ref: '#/components/schemas/ExcludedDocuments'
    type: object
  Approver:
    description: Approver
    properties:
      id:
        example: 8b6ed2f3-244f-487a-baa1-bbe4f51c8744
        format: uuid
        minLength: 1
        type: string
      status:
        enum:
        - initiated
        - notified
        - approved
        - rejected
        type: string
      info:
        $ref: '#/components/schemas/Approver_info'
      approval_link:
        format: uri
        minLength: 1
        nullable: true
        type: string
      approval_link_expiration_date:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        nullable: true
        type: string
      custom_text:
        $ref: '#/components/schemas/CustomText'
      approved_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        nullable: true
        type: string
      recipient_stage_index:
        description: Position of the recipient in the signing flow. Recipients with
          the same index are notified simultaneously.
        type: integer
      excluded_documents:
        description: 'List of Document IDs not visible to this Approver.

          '
        items:
          format: uuid
          type: string
        type: array
    required:
    - approved_at
    - custom_text
    - excluded_documents
    - id
    - info
    - recipient_stage_index
    - status
    title: Approver
    type: object
  UpdateApprover:
    properties:
      info:
        $ref: '#/components/schemas/UpdateApprover_info'
      custom_text:
        $ref: '#/components/schemas/CustomText'
      insert_after_id:
        description: 'ID of the recipient this one must follow in an ordered flow;
          they will only be asked to act after that recipient.

          When `custom_recipient_order` is enabled, this can reference any approver
          or signer.

          When `custom_recipient_order` is disabled, the referenced ID must be an
          approver. `ordered_approvers` must be enabled on the Signature Request.

          '
        example: 8b6ed2f3-244f-487a-baa1-bbe4f51c8744
        format: uuid
        nullable: true
        type: string
      group_with_id:
        description: 'ID of another recipient (Approver or Signer); both will be allowed
          to act in parallel in an ordered flow.

          Only available when `custom_recipient_order` is enabled.

          '
        example: 8b6ed2f3-244f-487a-baa1-bbe4f51c8744
        format: uuid
        nullable: true
        type: string
      excluded_documents:
        $ref: '#/components/schemas/ExcludedDocuments'
    type: object
  SignerConsentRequest:
    description: Signer Consent Request attached to a Signature Request
    properties:
      id:
        description: Unique identifier of the Signer Consent Request
        example: 69df8404-40d3-4686-887b-5678f46a0d9a
        format: uuid
        readOnly: true
        type: string
      type:
        description: Type of the Signer Consent Request
        enum:
        - checkbox
        - text_to_copy
        example: checkbox
        type: string
      settings:
        $ref: '#/components/schemas/SignerConsentRequest_settings'
      optional:
        description: Define if the Signer Consent Request is optional for Signers
        example: false
        type: boolean
      signer_ids:
        description: Ids of Signers to request a consent
        example:
        - 71517741-a4a8-4f25-8496-6e9c6d2b7791
        - 0c42e1ae-1cac-457b-9a09-5fda5f735bd8
        items:
          format: uuid
          type: string
        minItems: 1
        type: array
      document_id:
        description: The Document id to which it is linked.
        example: 9658867a-d2f3-46f0-9bce-36c45f42644e
        format: uuid
        nullable: true
        type: string
    required:
    - document_id
    - id
    - optional
    - settings
    - signer_ids
    - type
    type: object
  CreateSignerConsentRequest:
    properties:
      type:
        description: Type of the Signer Consent Request
        enum:
        - checkbox
        - text_to_copy
        example: checkbox
        type: string
      settings:
        $ref: '#/components/schemas/CreateSignerConsentRequest_settings'
      optional:
        description: Define if the Signer Consent Request is optional for Signers
        example: false
        type: boolean
      signer_ids:
        description: Ids of Signers to request a consent
        example:
        - 71517741-a4a8-4f25-8496-6e9c6d2b7791
        - 0c42e1ae-1cac-457b-9a09-5fda5f735bd8
        items:
          format: uuid
          type: string
        minItems: 1
        type: array
      insert_after_id:
        description: Insert just after the position of the specified Signer Consent
          Request id
        format: uuid
        nullable: true
        type: string
        example: null
      document_id:
        description: Link the Signer Consent Request to a given Document by its id.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
    required:
    - optional
    - settings
    - signer_ids
    - type
    title: CreateSignerConsentRequest
    type: object
  UpdateSignerConsentRequest:
    properties:
      settings:
        $ref: '#/components/schemas/CreateSignerConsentRequest_settings'
      optional:
        description: Define if the Signer Consent Request is optional for Signers
        example: false
        type: boolean
      insert_after_id:
        description: Insert just after the position of the specified Signer Consent
          Request id
        format: uuid
        nullable: true
        type: string
        example: null
      document_id:
        description: Link the Signer Consent Request to a given Document by its id.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
    title: UpdateSignerConsentRequest
    type: object
  SignerDocumentRequest:
    description: Signer Document Request attached to a Signature Request
    properties:
      id:
        description: Unique identifier of the Signer Document Request
        example: 69df8404-40d3-4686-887b-5678f46a0d9a
        format: uuid
        type: string
      title:
        description: Title of the document request
        example: Proof of address
        maxLength: 255
        minLength: 1
        type: string
      optional:
        description: Define if the document request is optional for the Signers
        type: boolean
      signer_ids:
        description: Ids of Signers to request a document
        items:
          example: 2fd4a3fb-a886-4c9d-ac49-ea6f759c0c64
          format: uuid
          type: string
        type: array
    required:
    - id
    - optional
    - signer_ids
    - title
    type: object
  CreateSignerDocumentRequest:
    example:
      title: Proof of address
      optional: true
      signer_ids:
      - 29f6049b-9c9d-4d1d-893c-be24e7d98d13
      - 7d938814-5492-4c02-806e-69c8fc1254ff
    properties:
      title:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        format: safe-string
        maxLength: 255
        minLength: 1
        type: string
      optional:
        type: boolean
      signer_ids:
        items:
          format: uuid
          type: string
        minItems: 1
        type: array
    required:
    - optional
    - signer_ids
    - title
    title: CreateSignerDocumentRequest
    type: object
  UpdateSignerDocumentRequest:
    properties:
      title:
        description: Title of the Signer Document Request.
        example: Proof of address
        maxLength: 255
        minLength: 1
        type: string
      optional:
        description: Define if the document request is optional for the Signers
        type: boolean
    type: object
  CreateDocumentFromJson:
    properties:
      electronic_seal_document_id:
        description: Id of the Electronic Seal Document. The Electronic Seal must
          be done to use its Electronic Seal Document.
        example: 672a5a0b-ac65-407e-9da9-d34402bae974
        format: uuid
        type: string
      name:
        example: file1
        maxLength: 128
        minLength: 1
        nullable: true
        pattern: ^(?!\s)[0-9A-Za-zĄÀÁÂÃÄÅÇĆÈÉÊËĘÌÍÎÏŁÑŃÒÓÔÕÖŚÙÚÛÜÝŹŻąàáâãäåæçćèéêëęìíîïłñńòóôõöśùúûüýÿźżß`'()
          -]+(?<!\s)$
        type: string
      nature:
        enum:
        - attachment
        - signable_document
        example: signable_document
        type: string
      insert_after_id:
        description: Insert just after the position of the specified Document id.
        example: 8b6ed2f3-244f-487a-baa1-bbe4f51c8744
        format: uuid
        nullable: true
        type: string
      parse_anchors:
        default: false
        description: If true, the system will parse the document exclusively for Signature-type
          Smart Anchors and automatically generate the required fields.
        example: true
        nullable: true
        type: boolean
      excluded_approvers:
        $ref: '#/components/schemas/DocumentExcludedApprovers'
      excluded_signers:
        $ref: '#/components/schemas/DocumentExcludedSigners'
    required:
    - electronic_seal_document_id
    - nature
    type: object
  UpdateDocument:
    properties:
      nature:
        description: Files in JPEG, JPG, and PNG format can only be of attachment
          nature.
        enum:
        - attachment
        - signable_document
        type: string
      insert_after_id:
        description: Insert just after the position of the specified document id
        example: 8b6ed2f3-244f-487a-baa1-bbe4f51c8744
        format: uuid
        nullable: true
        type: string
      password:
        description: The password required to unlock the document if it is protected
        example: MyPa$$word
        type: string
      name:
        description: The new name to be assigned to the document. This value should
          contain any characters except "\", "/" and can\'t start and finish with
          a space.
        example: file1
        maxLength: 128
        minLength: 1
        pattern: ^(?!\s)[^\/\\]+(?<!\s)$
        type: string
      initials:
        allOf:
        - $ref: '#/components/schemas/InitialsArea'
        nullable: true
        type: object
      excluded_approvers:
        $ref: '#/components/schemas/DocumentExcludedApprovers'
      excluded_signers:
        $ref: '#/components/schemas/DocumentExcludedSigners'
    type: object
  FieldSignature:
    properties:
      id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      document_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      signer_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      type:
        enum:
        - signature
        type: string
      height:
        format: int32
        maximum: 1000
        minimum: 37
        type: integer
      width:
        format: int32
        maximum: 2000
        minimum: 85
        type: integer
      page:
        format: int32
        minimum: 1
        type: integer
      x:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      y:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      reason:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        maxLength: 150
        nullable: true
        type: string
      display:
        $ref: '#/components/schemas/SignatureDisplay'
    required:
    - display
    - document_id
    - height
    - id
    - page
    - reason
    - signer_id
    - type
    - width
    - x
    - y
    title: Signature
    type: object
  FieldText:
    properties:
      id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      document_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      signer_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      type:
        enum:
        - text
        type: string
      width:
        description: If not set, the width is automatically calculated with the max_length
          value
        example: 90
        format: int32
        minimum: 24
        type: integer
      height:
        description: 'The height must be calculated using the formula: "height = number_of_lines
          \* font_size \* line_height", where the line height is always set to 1.5.'
        example: 150
        format: int32
        minimum: 1
        type: integer
      page:
        format: int32
        minimum: 1
        type: integer
      x:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      y:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      question:
        example: What is your job title?
        maxLength: 255
        type: string
      instruction:
        example: Your position in the company
        nullable: true
        type: string
      optional:
        type: boolean
      answer:
        example: Software Engineer
        nullable: true
        type: string
      max_length:
        maximum: 32767
        minimum: 1
        type: integer
      font:
        $ref: '#/components/schemas/Font'
      name:
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      default_value:
        maxLength: 32767
        minLength: 1
        nullable: true
        type: string
      read_only:
        type: boolean
    required:
    - answer
    - document_id
    - font
    - height
    - id
    - instruction
    - max_length
    - optional
    - page
    - question
    - signer_id
    - type
    - width
    - x
    - y
    title: Text
    type: object
  FieldMention:
    properties:
      id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      document_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      signer_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      type:
        enum:
        - mention
        type: string
      height:
        description: 'The height must be calculated using the formula: "height = number_of_lines
          \* font_size \* line_height", where the line height is always set to 1.5.'
        format: int32
        minimum: 1
        type: integer
      width:
        format: int32
        minimum: 24
        type: integer
      page:
        format: int32
        minimum: 1
        type: integer
      x:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      y:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      mention:
        type: string
      font:
        $ref: '#/components/schemas/Font'
      name:
        description: Name of the Field.
        example: Mention 1
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
    required:
    - document_id
    - font
    - height
    - id
    - mention
    - page
    - signer_id
    - type
    - width
    - x
    - y
    title: Mention
    type: object
  FieldCheckbox:
    properties:
      id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      document_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      signer_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      type:
        enum:
        - checkbox
        type: string
      name:
        description: Checkbox name
        example: Checkbox name
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      checked:
        description: Signer has checked the checkbox
        type: boolean
      page:
        format: int32
        minimum: 1
        type: integer
      optional:
        type: boolean
      x:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      y:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      size:
        description: The size determines both the width and height of the checkbox.
        format: int32
        maximum: 240
        minimum: 8
        type: integer
    required:
    - checked
    - document_id
    - id
    - name
    - optional
    - page
    - signer_id
    - type
    - x
    - y
    title: Checkbox
    type: object
  FieldRadioButtonGroup:
    properties:
      id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      document_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      signer_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      type:
        enum:
        - radio_group
        type: string
      page:
        format: int32
        minimum: 1
        type: integer
      optional:
        description: Does the Signer has to select one of the radio buttons from this
          group?
        type: boolean
      name:
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      radios:
        items:
          $ref: '#/components/schemas/FieldRadioButtonGroup_radios_inner'
        type: array
    required:
    - document_id
    - id
    - name
    - optional
    - page
    - radios
    - signer_id
    - type
    title: RadioGroup
    type: object
  FieldReadOnlyText:
    properties:
      id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      document_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      type:
        enum:
        - read_only_text
        type: string
      height:
        description: 'The height must be calculated using the formula: "height = number_of_lines
          \* font_size \* line_height", where the line height is always set to 1.5.'
        example: 150
        format: int32
        minimum: 1
        type: integer
      width:
        description: If not set, the width is automatically calculated with the max_length
          value
        example: 90
        format: int32
        minimum: 24
        type: integer
      page:
        format: int32
        minimum: 1
        type: integer
      x:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      y:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      text:
        description: This property holds the content displayed in the read-only text
          field.
        example: Please, read the whole document before to sign it.
        maxLength: 5000
        type: string
      font:
        $ref: '#/components/schemas/Font'
    required:
    - document_id
    - font
    - height
    - id
    - page
    - text
    - type
    - width
    - x
    - y
    title: ReadOnlyText
    type: object
  FieldSignatureDate:
    properties:
      id:
        example: 94de855c-21c5-4bde-b82c-745ce415b084
        format: uuid
        type: string
      document_id:
        example: 3218d951-3096-4145-8639-0054757ec223
        format: uuid
        type: string
      signer_id:
        example: 72cbe6fd-9225-460e-901c-94acf7a066bb
        format: uuid
        type: string
      type:
        enum:
        - signature_date
        type: string
      height:
        description: 'The height must be calculated using the formula: "height = number_of_lines
          \* font_size \* line_height", where the line height is always set to 1.5.'
        format: int32
        minimum: 1
        type: integer
      width:
        format: int32
        minimum: 24
        type: integer
      page:
        format: int32
        minimum: 1
        type: integer
      x:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      y:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      value:
        nullable: true
        type: string
      font:
        $ref: '#/components/schemas/Font'
      name:
        description: Name of the Field.
        example: Date 1
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      date_format:
        $ref: '#/components/schemas/CreateFieldDateFormat'
      time_format:
        $ref: '#/components/schemas/CreateFieldTimeFormat'
      show_timezone:
        default: false
        description: Boolean indicating whether to display the timezone abbreviation
          (e.g., `CEST`) next to the time.
        nullable: true
        type: boolean
      show_email:
        default: true
        description: Boolean indicating whether to display the signer's email address.
        nullable: false
        type: boolean
      offset_unit:
        $ref: '#/components/schemas/CreateFieldOffsetUnit'
      offset_value:
        default: 0
        description: 'Number of units to add to the signature date. Ignored if `offset_unit`
          is `null`. For example, use `offset_unit`: `"month"` and `offset_value:
          3` to display "signature date + 3 months"'
        example: 30
        minimum: 0
        nullable: true
        type: integer
    required:
    - document_id
    - font
    - height
    - id
    - page
    - signer_id
    - type
    - value
    - width
    - x
    - y
    title: SignatureDate
    type: object
  FieldSignerName:
    properties:
      id:
        example: 94de855c-21c5-4bde-b82c-745ce415b084
        format: uuid
        type: string
      document_id:
        example: 3218d951-3096-4145-8639-0054757ec223
        format: uuid
        type: string
      signer_id:
        example: 72cbe6fd-9225-460e-901c-94acf7a066bb
        format: uuid
        type: string
      type:
        enum:
        - signer_name
        type: string
      height:
        description: 'The height must be calculated using the formula: "height = number_of_lines
          \* font_size \* line_height", where the line height is always set to 1.5.'
        format: int32
        minimum: 1
        type: integer
      width:
        format: int32
        minimum: 24
        type: integer
      page:
        format: int32
        minimum: 1
        type: integer
      x:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      y:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      value:
        nullable: true
        type: string
      font:
        $ref: '#/components/schemas/Font'
      name:
        description: Name of the Field.
        example: Name 1
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      name_format:
        $ref: '#/components/schemas/CreateFieldNameFormat'
    required:
    - document_id
    - font
    - height
    - id
    - page
    - signer_id
    - type
    - value
    - width
    - x
    - y
    title: SignerName
    type: object
  FieldSignerEmail:
    properties:
      id:
        example: 94de855c-21c5-4bde-b82c-745ce415b084
        format: uuid
        type: string
      document_id:
        example: 3218d951-3096-4145-8639-0054757ec223
        format: uuid
        type: string
      signer_id:
        example: 72cbe6fd-9225-460e-901c-94acf7a066bb
        format: uuid
        type: string
      type:
        enum:
        - signer_email
        type: string
      height:
        description: 'The height must be calculated using the formula: "height = number_of_lines
          \* font_size \* line_height", where the line height is always set to 1.5.'
        format: int32
        minimum: 1
        type: integer
      width:
        format: int32
        minimum: 24
        type: integer
      page:
        format: int32
        minimum: 1
        type: integer
      x:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      y:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      value:
        nullable: true
        type: string
      font:
        $ref: '#/components/schemas/Font'
      name:
        description: Name of the Field.
        example: Email 1
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
    required:
    - document_id
    - font
    - height
    - id
    - page
    - signer_id
    - type
    - value
    - width
    - x
    - y
    title: SignerEmail
    type: object
  CreateField:
    oneOf:
    - $ref: '#/components/schemas/Signature'
    - $ref: '#/components/schemas/Mention'
    - $ref: '#/components/schemas/SignatureDate'
    - $ref: '#/components/schemas/Text'
    - $ref: '#/components/schemas/Checkbox'
    - $ref: '#/components/schemas/RadioGroup'
    - $ref: '#/components/schemas/ReadOnlyText'
    - $ref: '#/components/schemas/SignerName'
    - $ref: '#/components/schemas/SignerEmail'
    type: object
  UpdateField:
    anyOf:
    - $ref: '#/components/schemas/Signature_1'
    - $ref: '#/components/schemas/Mention_1'
    - $ref: '#/components/schemas/SignatureDate_1'
    - $ref: '#/components/schemas/Text_1'
    - $ref: '#/components/schemas/Checkbox_1'
    - $ref: '#/components/schemas/RadioGroup_1'
    - $ref: '#/components/schemas/ReadOnlyText_1'
    type: object
  FieldAnswer:
    properties:
      value:
        $ref: '#/components/schemas/FieldAnswer_value'
    required:
    - value
    type: object
  Follower:
    properties:
      email:
        example: john.doe@example.com
        format: email
        type: string
      locale:
        $ref: '#/components/schemas/Locale'
      follower_link:
        format: uri
        minLength: 1
        nullable: true
        type: string
    required:
    - email
    - follower_link
    - locale
    type: object
  CreateFollowers:
    description: A list of Follower objects to be added to the signature request.
    items:
      $ref: '#/components/schemas/CreateFollowers_inner'
    type: array
  SignatureRequestLabel:
    properties:
      id:
        description: Unique identifier of the Label.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: false
        readOnly: true
        type: string
      name:
        description: Name of the Label.
        example: Contracts
        maxLength: 128
        minLength: 1
        nullable: false
        type: string
    required:
    - id
    - name
    type: object
  Metadata:
    description: 'Metadata allows you to attach extra information to your Signature
      Requests.\

      This field must contain JSON data (key / value), with 10 nodes maximum.\

      Each node key can have 30 characters maximum.\

      Each node value can contain a string (limited to 255 characters), a boolean,
      an integer or a float.\

      This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
      allowing email and URL..

      '
    properties:
      data:
        additionalProperties:
          $ref: '#/components/schemas/Metadata_data_value'
        type: object
    title: Signature Request Metadata
    type: object
  Signer:
    description: Signer
    properties:
      id:
        format: uuid
        minLength: 1
        type: string
      info:
        $ref: '#/components/schemas/Signer_info'
      status:
        enum:
        - initiated
        - declined
        - notified
        - verified
        - processing
        - consent_given
        - signed
        - aborted
        - error
        minLength: 1
        type: string
      fields:
        items:
          $ref: '#/components/schemas/Signer_fields_inner'
        nullable: true
        type: array
      signature_level:
        default: electronic_signature
        enum:
        - electronic_signature
        - advanced_electronic_signature
        - qualified_electronic_signature
        type: string
      signature_authentication_mode:
        description: Method to authenticate the Signers. Authentication via SMS one-time
          password (otp_sms) is unavailable for phone numbers in China.
        enum:
        - null
        - otp_email
        - otp_sms
        - no_otp
        nullable: true
        type: string
      signature_link:
        format: uri
        minLength: 1
        nullable: true
        type: string
      signature_link_expiration_date:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        nullable: true
        type: string
      signature_image_preview:
        minLength: 1
        nullable: true
        type: string
      redirect_urls:
        $ref: '#/components/schemas/Signer_redirect_urls'
      custom_text:
        $ref: '#/components/schemas/CustomText'
      delivery_mode:
        enum:
        - email
        - none
        nullable: true
        type: string
      identification_attestation_id:
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      sms_notification:
        $ref: '#/components/schemas/SmsNotification'
      email_notification:
        $ref: '#/components/schemas/EmailNotification'
      pre_identity_verification_required:
        type: boolean
      verified_identity_id:
        format: uuid
        minLength: 1
        nullable: true
        type: string
      recipient_stage_index:
        description: Position of the recipient in the signing flow. Recipients with
          the same index are notified simultaneously.
        type: integer
      excluded_documents:
        description: 'List of Document IDs not visible to this Signer.

          '
        items:
          format: uuid
          type: string
        type: array
      signed_at:
        description: Timestamp indicating when the Signer completed their signature.
          Returns null otherwise.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        nullable: true
        type: string
    required:
    - custom_text
    - delivery_mode
    - email_notification
    - excluded_documents
    - fields
    - id
    - identification_attestation_id
    - info
    - pre_identity_verification_required
    - recipient_stage_index
    - redirect_urls
    - signature_authentication_mode
    - signature_image_preview
    - signature_level
    - signature_link
    - signature_link_expiration_date
    - signed_at
    - sms_notification
    - status
    - verified_identity_id
    title: Signer
    type: object
  CreateSigner:
    oneOf:
    - $ref: '#/components/schemas/New_Signer_From_Scratch'
    - $ref: '#/components/schemas/New_Signer_From_Existing_User'
    - $ref: '#/components/schemas/New_Signer_From_Existing_Contact'
    - $ref: '#/components/schemas/New_Signer_From_Identity_Verification'
    type: object
  UpdateSigner:
    properties:
      info:
        $ref: '#/components/schemas/UpdateSigner_info'
      insert_after_id:
        description: 'ID of the recipient this one must follow in an ordered flow;
          they will only be asked to act after that recipient.

          When `custom_recipient_order` is enabled, this can reference any approver
          or signer.

          When `custom_recipient_order` is disabled, the referenced ID must be a signer.
          `ordered_signers` must be enabled on the Signature Request.

          '
        example: 8b6ed2f3-244f-487a-baa1-bbe4f51c8744
        format: uuid
        nullable: true
        type: string
      group_with_id:
        description: 'ID of another recipient (Approver or Signer); both will be allowed
          to act in parallel in an ordered flow.

          Only available when `custom_recipient_order` is enabled.

          '
        example: 8b6ed2f3-244f-487a-baa1-bbe4f51c8744
        format: uuid
        nullable: true
        type: string
      signature_level:
        default: electronic_signature
        enum:
        - electronic_signature
        - advanced_electronic_signature
        - qualified_electronic_signature
        type: string
      signature_authentication_mode:
        description: 'Method to authenticate the Signers. Authentication via SMS one-time
          password (otp_sms) is unavailable for phone numbers in China.

          When the Signature Request in `draft` status, updating the authentication
          mode is available for all Signers, no matter their `signature_level`.\

          When the Signature Request is in `approval` or `ongoing` status, updating
          the authentication mode is only available for Simple Electronic Signature
          if Signers have an `initiated` or `notified` status.

          '
        enum:
        - otp_email
        - otp_sms
        - no_otp
        nullable: true
        type: string
      redirect_urls:
        $ref: '#/components/schemas/New_Signer_From_Scratch_redirect_urls'
      custom_text:
        $ref: '#/components/schemas/New_Signer_From_Scratch_custom_text'
      delivery_mode:
        $ref: '#/components/schemas/SignerDeliveryMode'
      identification_attestation_id:
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      email_notification:
        $ref: '#/components/schemas/EmailNotification_1'
      pre_identity_verification_required:
        description: Defines the way the Signer's Identity Documents will be uploaded
          for Verification. If set to `true`, `signature_level`should be equal to
          `advanced_electronic_signature` and `delivery_mode` set to `none`.
        type: boolean
      excluded_documents:
        $ref: '#/components/schemas/ExcludedDocuments'
    type: object
  SignerAuditTrail:
    example:
      sender:
        id: 3409ab3f-9295-4a69-9923-e9d32d9533d6
        type: User
        email: johnny.wallyday@example.com
        last_name: Wallyday
        first_name: Johnny
        ip_address: 172.18.0.1
        phone_number: '+447123456789'
      signer:
        id: 44e4b0f8-55c9-48a9-803f-d89957525270
        last_name: Wallyday
        first_name: Johnny
        ip_address: 172.18.0.1
        phone_number: '+447123456789'
        email_address: johnny.wallyday@example.com
        consent_given_at: '2021-07-05T12:21:42+00:00'
        signature_process_completed_at: '2021-07-05T12:21:43+00:00'
      version: 5
      documents:
      - id: a9534a42-bbc1-4355-b270-58f315eda779
        name: sample.pdf
        mime_type: application/pdf
        signatures:
        - hash: 4396f6a9f0554928f7bcc8e645a6441cb432c1606137ac8f3a735aef83946974
          reason: Signed by Johnny Wallyday
          certificate:
            dn: CN=Yousign, C=FR, O=Yousign, OU=794513986, serialNumber=2019-02-15
              10:07:35:938
            oid: 1.2.250.1.302.1.7.1.0
            hash: 69570e2d5cc2b352b2249ba32b16195722099a89aa35de71ee1e745f771d66c5
            content: '-----BEGIN CERTIFICATE-----

              MIIF8DCCA9igAwIBAgIIdfWiF8OAJo0wDQYJKoZIhvcNAQELBQAwfzEkMCIGA1UE

              AwwbWU9VU0lHTiBTQVMgLSBTSUdOMiBURVNUIENBMRIwEAYDVQQLDAk3OTQ1MTM5

              ODYxFDASBgNVBAoMC1lPVVNJR04gU0FTMQ0wCwYDVQQHDARDQUVOMREwDwYDVQQI

              DAhDQUxWQURPUzELMAkGA1UEBhMCRlIwHhcNMTkwMjE1MDg1NzM2WhcNMjIwMjE0

              MDkwNzAwWjBnMRAwDgYDVQQDDAdZb3VzaWduMSAwHgYDVQQFExcyMDE5LTAyLTE1

              IDEwOjA3OjM1OjkzODESMBAGA1UECwwJNzk0NTEzOTg2MRAwDgYDVQQKDAdZb3Vz

              aWduMQswCQYDVQQGEwJGUjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB

              AIWI+w9xQ9uSt4Lb/l14Yu8yRvCWer06bzm5RFvqgZRiD2Cq2Vx8LNzi0pGCxBdI

              Q9nlWcxCAh67Lp/OygCKpUN2DnNiIiORK5b283VKASlGMy5frVOCKiq2YCz0vA6k

              pIqzBP7DKV/CsZ3EqP0uw9C12EH3PrBJGQq4WOZI1Q5Fs2JAhOwfq/wq2orG424y

              0A9+smh8J3DjwSCoMQZrdHd/obK3w8AaTGI535dqWIZ0wKTZBZ7xahGAPGXo9cy9

              UXFtazxWGIcu5uYjRLtlUyialcUgB0db1eyOzFoRJCsaE6s7QgBhQUUfDkXs1UIp

              D0BfB/K2kPxGENm2Uk6WAfcCAwEAAaOCAYYwggGCMAwGA1UdEwEB/wQCMAAwHwYD

              VR0jBBgwFoAUzmRTx3jf2iI16mJGhB48l67NzPUwSwYDVR0gBEQwQjBABgoqgXoB

              gi4BBwEAMDIwMAYIKwYBBQUHAgEWJGh0dHA6Ly95b3VzaWduLmZyL2ZyL3B1Ymxp

              Yy9kb2N1bWVudDAgBgNVHSUEGTAXBgorBgEEAYI3CgMMBgkqhkiG9y8BAQUwgbIG

              A1UdHwSBqjCBpzA1oDOgMYYvaHR0cDovL3RtcC55b3VzaWduLmZyL2NybC95b3Vz

              aWduc2Fzc2lnbjJjYS5jcmwwNqA0oDKGMGh0dHA6Ly90bXAyLnlvdXNpZ24uZnIv

              Y3JsL3lvdXNpZ25zYXNzaWduMmNhLmNybDA2oDSgMoYwaHR0cDovL3RtcDMueW91

              c2lnbi5mci9jcmwveW91c2lnbnNhc3NpZ24yY2EuY3JsMB0GA1UdDgQWBBTgXAE8

              ONE89UOu8TjrtBH9cbd92jAOBgNVHQ8BAf8EBAMCBkAwDQYJKoZIhvcNAQELBQAD

              ggIBAAF+VPpcphjyoU8RvQO14ojWV51wJxsx5ShsvtXPsQ7dBws8XmthuTyyYxtM

              E3dldkJsaQt8vK7/AUURwO7YX7PHVlwIqm2kpNThZ4+sEib3SOivP8vpfIP3mD0+

              IFREI/8adIWYyiYzp1xjuuAoZ6lyg2JsOQ/67nyS+y7sUQ++GfQulb5yjkMytmYs

              PJ0uyjnNAI/+hy4okIY7qgHFZaDGBSqdGU28NZcCEeBLwjcH4ET2Q1LvJ7nkKQMM

              cxw+TXdy7cgIAjdfCymjJ701s43JKI01NFrNZ0I20jTOuh2qB4Kf8fQFwmutTnRM

              P4ZglXsXZkyL9snUWwMSAP9QP13fPD6EDTTshyijvwHb6zbrFg3U7J0m/Sjmqp2A

              zD+pj777dQ2jg0zTJ3WLOosE1/tt60ygK3HhiVnnyM8sdjTrZ6ca9++TgnRthKss

              R35c/1Be3RJtYnar2yn3bA2pklLcjnV8Q3ZSks4ll7XnEI9V8EQSNHkmno7k+asl

              WeQ8eC82fkwCwzXMLBTt1kN+0qXfpvVoSITPSVlOvdCsFCRSC3JMYHUY6c9oUUlV

              CCEBWxe/Vm8R+AG4i3zk9wIoLDLW2eeOx1G61QFtIlgJPbKRLiDZhaGZq1PN8T2o

              D/1S7m9PMISw1hrWHpJM+gZpRLsfRp5EH3ieRFzt24fpIosf

              -----END CERTIFICATE-----

              -----BEGIN CERTIFICATE-----

              MIIGnDCCBISgAwIBAgIIfVpT4jgxW6cwDQYJKoZIhvcNAQELBQAwfzEkMCIGA1UE

              AwwbWU9VU0lHTiBTQVMgLSBST09UMiBURVNUIENBMRIwEAYDVQQLDAk3OTQ1MTM5

              ODYxFDASBgNVBAoMC1lPVVNJR04gU0FTMQ0wCwYDVQQHDARDQUVOMREwDwYDVQQI

              DAhDQUxWQURPUzELMAkGA1UEBhMCRlIwHhcNMTYwMTI3MTYyODExWhcNMjYwMTI3

              MTYyODExWjB/MSQwIgYDVQQDDBtZT1VTSUdOIFNBUyAtIFNJR04yIFRFU1QgQ0Ex

              EjAQBgNVBAsMCTc5NDUxMzk4NjEUMBIGA1UECgwLWU9VU0lHTiBTQVMxDTALBgNV

              BAcMBENBRU4xETAPBgNVBAgMCENBTFZBRE9TMQswCQYDVQQGEwJGUjCCAiIwDQYJ

              KoZIhvcNAQEBBQADggIPADCCAgoCggIBALUsirI2GYG9qu3U2S4V4JI0V9ohNP3W

              EpssSBcepPBV4UPtwAbFGvJqtGO/0nNZO0J7UwUb0sZBnedFl96tRQff3PECyO9k

              1B1/8rK1TbLPQPhTYWlrvX69wHXJFPxf/JkL4l4Lp6nFS80SYlaRj2RHHJ8HDj8S

              P1oULnhW2f2i8AlJwFe34eLJbWgeI5D7UAo59GMQ6bO4aVMaaDWvXsKOn8qmCUwF

              gtQNOqtYyLgURr4qivbjsZEv5H4Ee+wR5J+U6wd9dpIoTV2g1mExNlKVoj9qX9rh

              4al4G80fKNUT8bVnzxmdkDZzuzKm+rNIN6Fnc5CTHu2IcMHcuvKMRvsSJ+0fiz1E

              b/xsKO18Aiy5XOEQFqDrXRKC5AMmF/zB9Fh1Xe7Bi6IQo15NOjOCHLiBTARsMBJ8

              RWTuTv89qnL1lECogFusbptDG4Gu7Y7M13V8gOoGAxBs6uALjoseFZcnLQlIjZCV

              L0xyhrXFCLFnv4gy2+xY1bJNueD3cLFkzaxiCJ4WKesmRIfc6vHaQNl5NpU+9tFb

              U6o01c3fjZUdIh/MR3GFIXNpPsilhl///5aT5h2L98Gmb2q7tqSbFqm5z17MG3uS

              e4zCt+UD7MI8oCF2CELo79xMjtmqEwIf0IU8MxaLaLSZ0J164ZyHwvfIewgBp8XF

              qLn0jrZNiocXAgMBAAGjggEaMIIBFjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQY

              MBaAFGXEFaTuRlW+zr11R8A0QEYcGvuRMIGyBgNVHR8EgaowgacwNaAzoDGGL2h0

              dHA6Ly90bXAueW91c2lnbi5mci9jcmwveW91c2lnbnNhc3Jvb3QyY2EuY3JsMDag

              NKAyhjBodHRwOi8vdG1wMi55b3VzaWduLmZyL2NybC95b3VzaWduc2Fzcm9vdDJj

              YS5jcmwwNqA0oDKGMGh0dHA6Ly90bXAzLnlvdXNpZ24uZnIvY3JsL3lvdXNpZ25z

              YXNyb290MmNhLmNybDAdBgNVHQ4EFgQUzmRTx3jf2iI16mJGhB48l67NzPUwDgYD

              VR0PAQH/BAQDAgEGMA0GCSqGSIb3DQEBCwUAA4ICAQBZ8ru8LEQ1qzQqG/Rx420f

              cN4YNM1cXV+DwpWOw46Oh9U7BG1i/wYPy6uEZvj/n+nm/MkbajrzTViZnKMRs7Wy

              CWBqvAfl4gcbWvrRzdVwsbd3UbsxD5UD1CkJYl5/4gPvCae6YVCF9WtnH2lSy/Gv

              5bbIfyXF++iNQn+lLe59EhA3WinTql/yk/SPUNVn4/IZ0UWrw1IPS3kmnIal1mk7

              pL45n5G51qAHpSbAoTsCeRBJZ6jr38n+FimZahnBZTu4+XycDVicrydpsopQiTt8

              ry+mP1b9Nd4eoHR4/F/82w1rNfAM0NJKL8w3qr8lMdxsbANMvW0ixgjRnBpuRRB4

              5iUA5Mb2DbiYJARBoruYqYGya317Gcvtk4w0O48CXR+HPXygHh/63De1JdOUjSc2

              Hagr6jp7NKbn/XmWBjWuoG9J9d9sC5U/mgjw5Xjf9jKGuUGz46EtlzzpojVB7fJA

              E2Ye0kOuLANpoTFAI4EJe5nTJz0HsFG3nDshsD9Mb1/kUBSGUDWijL5f0LDqf562

              kTioMpkK7ivZxQksF8+bMId5sUNrDVA/6lhn8tD5gzGacSU7IMfIH3EUKcI1NoWm

              hV+aI8EbXP6251cF74y/tejTUQLdOQ9ut3PsxYmTTDqr8RPI6UZeh2yibzSmgGwU

              fylsTiF/gVGm5cpWCrULCw==

              -----END CERTIFICATE-----

              -----BEGIN CERTIFICATE-----

              MIIGnDCCBISgAwIBAgIIT0TY3eM9ut0wDQYJKoZIhvcNAQELBQAwfzEkMCIGA1UE

              AwwbWU9VU0lHTiBTQVMgLSBST09UMiBURVNUIENBMRIwEAYDVQQLDAk3OTQ1MTM5

              ODYxFDASBgNVBAoMC1lPVVNJR04gU0FTMQ0wCwYDVQQHDARDQUVOMREwDwYDVQQI

              DAhDQUxWQURPUzELMAkGA1UEBhMCRlIwHhcNMTYwMTI3MTYyNjE2WhcNMzYwMTI3

              MTYyNjE2WjB/MSQwIgYDVQQDDBtZT1VTSUdOIFNBUyAtIFJPT1QyIFRFU1QgQ0Ex

              EjAQBgNVBAsMCTc5NDUxMzk4NjEUMBIGA1UECgwLWU9VU0lHTiBTQVMxDTALBgNV

              BAcMBENBRU4xETAPBgNVBAgMCENBTFZBRE9TMQswCQYDVQQGEwJGUjCCAiIwDQYJ

              KoZIhvcNAQEBBQADggIPADCCAgoCggIBALXMHUFwSacaI5TjtMRw4kJ9o1ve/IZo

              oj+2HOpW3iqs74cmsYjpHbJD0UAdh3SpdlLFK1/WBf0uEbzn6z7gRfUkEAo5EnHs

              M1iTfCXWDtA+xd9X4h2UAVEdXRzglvOvT275fjI1uj9Zi4Rz95drhlGkZVCDIMuv

              7fazkT868grWSfGSUc2C8d9+kOL4pCKuSanOc/nwD61F+oQ6KeEMtmpbr57Yy+qY

              taF6ieKiDGn0aDj3yImnA9YqfFlX4mCyn+LmiqrXyEn0Z5iYLbO0wXkyPqhcO9c9

              gS1Y8Y/1AEvxnaLlV3eG402ZYUS6tT27o+tpdCAIx+3zMhNsPI9wXUjlVr/8ts+/

              uOUUCUWoBK3J6R1zG3urCdnuor8xAaWK/OHtvg8rXoXEfi8ujWV3EbiwIwiUHVh4

              rJIE1vhsVPW/sTM9yEjRFks0swyoX6QupEuaZLV4DbmcEbmZ2XIH5Cw2c1qwUTk2

              8vQzKHszLdRb9scnjd3yHsef5ZAHS9hUoFIfG+MzINGm3U6v4exspSw/EshSavVj

              R+gL0l+sdK4L6xe++K++Gpp5xn5cZUJeg4YtdgGju7lMdGpJVVwl0Y8UAEJt9xgC

              MvGctrkoaUuBjOhrGQQITDMsNrtgi28s7rUB6k+yxcaGBBp2PyAIsIe0e1wKGm1N

              HjGtqY0IV1tFAgMBAAGjggEaMIIBFjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQY

              MBaAFGXEFaTuRlW+zr11R8A0QEYcGvuRMIGyBgNVHR8EgaowgacwNaAzoDGGL2h0

              dHA6Ly90bXAueW91c2lnbi5mci9jcmwveW91c2lnbnNhc3Jvb3QyY2EuY3JsMDag

              NKAyhjBodHRwOi8vdG1wMi55b3VzaWduLmZyL2NybC95b3VzaWduc2Fzcm9vdDJj

              YS5jcmwwNqA0oDKGMGh0dHA6Ly90bXAzLnlvdXNpZ24uZnIvY3JsL3lvdXNpZ25z

              YXNyb290MmNhLmNybDAdBgNVHQ4EFgQUZcQVpO5GVb7OvXVHwDRARhwa+5EwDgYD

              VR0PAQH/BAQDAgEGMA0GCSqGSIb3DQEBCwUAA4ICAQCuxOXQDSYF0RpYQWonRDlU

              Z64IaGJ5buU4tGzf7rAgIQdXbO/VjjfF9UsjnLopNwWkuSJvINm21obYHcoSwvpz

              lwS/3uJCLxaw5q4SVJ4x5rajh/2qtFzcThSh48rcXcqoxAmc6BzQuIOm9cFUD2Ri

              qUJmg5O+CoLuE1b4i+CsCFL3AoWnBHFZ4YtInQBFIRBhMNPICvYOCF6jjgmMxkWU

              M8SEp7FSFfsy/oPI1dt+k9JjHCXhtWO9ndLvvwvLcjqRO3ItiF9IazsNcNLhaIMA

              lvYiQ+jLpckAuTxj7XHQyJSEofTMPr+ZSgQwUc337MJyxPhTDkch5cQBfnC20Usk

              yjdwwaeiwnNMhESwgDa4Oqw5IOmq+VmqtR+9F9yxACrpyph593F1zYwv7ikik5dI

              IYACb2fKLQrcnCfhm0k1Nt9UXoc9mQzFUK0DWJNLeGJo0rfRQh5ZqhcBG2U0KZFQ

              RtQQEf3zXJxQJGlCn1UMZMJswAzfhMTdGPNzyDI2u+9Q8WT7M2f59Idiae2m79uG

              uStRwN7Vnrpa399YXixOpNTz6d0NFBOAq1Nfwy5cnQDCnT9JkrKidrFKyA21b67m

              SfJIpMSPfFbt3g0h7JPWK7OC4Ydydh92e7/IUhtkudKMoazlwSJ7484dE7NyTpol

              62H0sW/1gmFzE6/QmCUR+w==

              -----END CERTIFICATE-----'
            generated_at: '2019-02-15T09:07:36+00:00'
        initial_hash: 8decc8571946d4cd70a024949e033a2a2a54377fe9f1c1b944c20f9ee11a9e51
        initial_storage_id: fdad7bcf-73d5-4a73-945d-ba7b738c530b
      organization:
        id: d89a0f7b-bd3f-494d-ab61-71b69f24a3d9
        name: Universalt Music
      authentication:
        mode: sms
        message: 'eSIGNATURE: 791994 is your security code to confirm the signature
          of your documents.'
        validated_at: '2021-07-05T12:21:40+00:00'
      signature_request:
        id: 4d164217-60e7-4733-b56c-65ad637eadce
        name: My new request
        sent_at: '2021-07-05T12:21:21+00:00'
        expired_at: '2022-01-05T22:59:00+00:00'
      electronic_signature_level:
        level: Simple electronic signature
    properties:
      version:
        type: number
      signature_request:
        type: object
      sender:
        type: object
      signer:
        type: object
      documents:
        items:
          type: object
        minItems: 1
        type: array
        uniqueItems: true
      organization:
        type: object
      authentication:
        type: object
      electronic_signature_level:
        type: object
    required:
    - authentication
    - documents
    - organization
    - sender
    - signature_request
    - signer
    - version
    type: object
  SignerDocument:
    description: Signer Document
    properties:
      id:
        description: Unique identifier of the signer document
        example: 69df8404-40d3-4686-887b-5678f46a0d9a
        format: uuid
        type: string
      title:
        description: Title of the document request
        example: Proof of address
        maxLength: 255
        minLength: 1
        type: string
      filename:
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
    required:
    - filename
    - id
    - title
    type: object
  SignerIdentityVerification:
    additionalProperties: false
    properties:
      type:
        description: Type of document you are looking to verify. Only passports, id
          and resident permits are accepted.
        enum:
        - id_card
        - passport
        - residence_permit
        example: id_card
        type: string
      recto:
        description: 'Front of the identity document file to verify.

          Accepted formats: PNG, JPEG, JPG, PDF.

          Max size: 10 MB. Max resolution: 20 mpx.

          '
        format: binary
        type: string
      verso:
        description: 'Back of the identity document file to verify.

          Accepted formats: PNG, JPEG, JPG, PDF.

          Max size: 10 MB. Max resolution: 20 mpx.

          '
        format: binary
        type: string
    required:
    - recto
    - type
    type: object
  SignerSign:
    properties:
      otp:
        example: '231457'
        nullable: true
        pattern: ^[0-9]{6}$
        title: One-Time Password (OTP) sent to the Signer
        type: string
      ip_address:
        $ref: '#/components/schemas/Signer_s_IP_address'
      consent_given_at:
        description: UTC date. Must be in format `2024-01-18T22:00:00+00:00`
        example: '2024-01-18T22:00:00Z'
        format: date-time
        title: Signer's consent date
        type: string
    required:
    - consent_given_at
    - ip_address
    type: object
  SignerSignWithUploadedSignatureImage:
    properties:
      otp:
        example: '231457'
        nullable: true
        pattern: ^[0-9]{6}$
        title: One-Time Password (OTP) sent to the Signer
        type: string
      ip_address:
        $ref: '#/components/schemas/Signer_s_IP_address'
      consent_given_at:
        description: UTC date. Must be in format `2024-01-18T22:00:00+00:00`
        example: '2024-01-18T22:00:00Z'
        format: date-time
        title: Signer's consent date
        type: string
      signature_image:
        description: Signature image of the Signer to be displayed on the signed Document.
        format: binary
        title: Image to use as signature
        type: string
    required:
    - consent_given_at
    - ip_address
    - signature_image
    type: object
  Template:
    properties:
      id:
        example: 89120884-d29a-4b1a-ac7b-a9e73a872795
        format: uuid
        readOnly: true
        type: string
      name:
        readOnly: true
        type: string
      description:
        nullable: true
        readOnly: true
        type: string
      status:
        enum:
        - draft
        - active
        readOnly: true
        type: string
      created_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        readOnly: true
        type: string
      workspace_id:
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
    required:
    - created_at
    - description
    - id
    - name
    - status
    title: Template
    type: object
  User:
    properties:
      id:
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      first_name:
        example: John
        nullable: true
        type: string
      last_name:
        example: Doe
        nullable: true
        type: string
      email:
        example: email@example.com
        format: email
        type: string
      phone_number:
        description: E.164 format
        example: '+447123456789'
        nullable: true
        type: string
      locale:
        example: en
        type: string
      avatar:
        example: https://example.com/users/123456/avatar
        nullable: true
        type: string
      job_title:
        example: Worker
        nullable: true
        type: string
      is_active:
        type: boolean
      created_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        readOnly: true
        type: string
      role:
        $ref: '#/components/schemas/UserRole'
      workspaces:
        items:
          $ref: '#/components/schemas/User_workspaces_inner'
        type: array
      status:
        $ref: '#/components/schemas/UserStatus'
      source:
        description: The application used to create the `User`
        enum:
        - app
        - public_api
        example: public_api
        nullable: false
        type: string
    required:
    - avatar
    - created_at
    - email
    - first_name
    - id
    - is_active
    - job_title
    - last_name
    - locale
    - phone_number
    - role
    - source
    - status
    - workspaces
    title: User
    type: object
  CreateUser:
    properties:
      email:
        description: 'The email address must not match any existing User''s email.

          '
        example: john.doe@example.com
        format: email
        title: User's email address
        type: string
      role:
        description: 'Role assigned to the User in the Organization.

          '
        enum:
        - admin
        - member
        title: User's role
        type: string
      locale:
        $ref: '#/components/schemas/Locale'
      workspaces:
        description: 'The new User must be associated with at least one Workspace
          in the Organization.

          '
        items:
          $ref: '#/components/schemas/UUID'
        minItems: 1
        title: User's Workspace
        type: array
        uniqueItems: true
      first_name:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        description: User's first name
        example: John
        maxLength: 255
        minLength: 1
        nullable: true
        title: First name
        type: string
      last_name:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        description: User's last name
        example: Doe
        maxLength: 255
        minLength: 1
        nullable: true
        title: Last name
        type: string
      phone_number:
        description: E.164 format
        example: '+41446667700'
        minLength: 1
        nullable: true
        title: User's phone number
        type: string
      job_title:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: Employee
        format: safe-string
        maxLength: 255
        minLength: 1
        nullable: true
        title: User's job title
        type: string
    required:
    - email
    - locale
    - role
    - workspaces
    title: A User object
    type: object
  UserInvitation:
    properties:
      id:
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        readOnly: true
        type: string
      email:
        example: email@example.com
        format: email
        readOnly: true
        type: string
      role:
        $ref: '#/components/schemas/ManageableRole'
      workspaces:
        items:
          $ref: '#/components/schemas/User_workspaces_inner'
        readOnly: true
        type: array
      expired_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        readOnly: true
        type: string
      created_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        readOnly: true
        type: string
    required:
    - created_at
    - email
    - expired_at
    - id
    - role
    - workspaces
    title: Invitation
    type: object
  UpdateUser:
    properties:
      role:
        description: New role assigned to the User. It can be `member` or `admin`.
        enum:
        - admin
        - member
        type: string
      active:
        description: If `true`, the User will be activated; if `false`, the User will
          be suspended.
        type: boolean
    type: object
  BankAccountLookupMeta:
    properties:
      id:
        $ref: '#/components/schemas/UUID'
      workspace_id:
        description: The Workspace ID in which the verification has been created.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      created_at:
        description: Creation date of the Bank Account Lookup Verification.
        example: '2025-07-23T18:22:00Z'
        format: date-time
        type: string
      updated_at:
        description: Update date of the Bank Account Lookup Verification.
        example: '2025-07-23T18:22:00Z'
        format: date-time
        type: string
      status:
        description: Status of the Bank Account Lookup Verification.
        enum:
        - pending
        - awaiting_data
        - verified
        - failed
        - inconclusive
        example: verified
        type: string
      status_codes:
        description: List of status codes. Indicates the cause when the status is
          `failed` or `inconclusive`.
        example:
        - BALV_1101
        items:
          type: string
        type: array
      data_anonymized:
        description: 'Indicates if the Bank Account Lookup Verification data has been
          anonymized.

          If set to `true`, all fields in the `data` field are set to NULL.

          '
        example: false
        nullable: false
        type: boolean
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
    required:
    - created_at
    - data_anonymized
    - id
    - previous_attempt_id
    - status
    - status_codes
    - updated_at
    - workflow_session_id
    - workspace_id
    title: BankAccountLookupMeta
    type: object
  InitiateBankAccountLookupWithNaturalPerson:
    additionalProperties: false
    properties:
      iban:
        description: 'The International Bank Account Number (IBAN) to verify.

          The IBAN must be a valid IBAN starting with "FR".

          The IBAN must belong to a bank that is a member of the SEPAmail DIAMOND
          network.

          '
        example: FR7630006000011234567890189
        type: string
      natural_person:
        $ref: '#/components/schemas/InitiateBankAccountLookupWithNaturalPerson_natural_person'
      workspace_id:
        description: 'Scopes the verification to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9412b83b-b4b9-4a94-97b5-2b43dfa4cde3
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
    required:
    - iban
    - natural_person
    title: Initiate a new Bank Account Lookup Verification with natural person
    type: object
  InitiateBankAccountLookupFromApplicant:
    additionalProperties: false
    properties:
      applicant_id:
        description: The Applicant ID linked to the Workflow Session.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
    required:
    - applicant_id
    title: Attach a new Bank Account Lookup Verification to an Applicant
    type: object
  InitiateBankAccountLookupWithNaturalPersonFromFile:
    additionalProperties: false
    properties:
      file:
        description: 'The file containing the IBAN number.

          Accepted formats: PDF.

          Max size: 10 MB.

          '
        example: Binary file
        format: binary
        type: string
      natural_person:
        $ref: '#/components/schemas/InitiateBankAccountLookupWithNaturalPerson_natural_person'
      workspace_id:
        description: 'Scopes the verification to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9412b83b-b4b9-4a94-97b5-2b43dfa4cde3
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
    required:
    - file
    - natural_person
    title: Initiate a new Bank Account Lookup Verification with natural person
    type: object
  BankAccountLookupFull:
    properties:
      id:
        $ref: '#/components/schemas/UUID'
      workspace_id:
        description: The Workspace ID in which the verification has been created.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      created_at:
        description: Creation date of the Bank Account Lookup Verification.
        example: '2025-07-23T18:22:00Z'
        format: date-time
        type: string
      updated_at:
        description: Update date of the Bank Account Lookup Verification.
        example: '2025-07-23T18:22:00Z'
        format: date-time
        type: string
      status:
        description: Status of the Bank Account Lookup Verification.
        enum:
        - pending
        - verified
        - failed
        - inconclusive
        example: verified
        type: string
      status_codes:
        description: List of status codes. Indicates the cause when the status is
          `failed` or `inconclusive`.
        example:
        - BALV_1101
        items:
          type: string
        type: array
      data_anonymized:
        description: 'Indicates if the Bank Account Lookup Verification data has been
          anonymized.

          If set to `true`, all fields in the `data` field are set to NULL.

          '
        example: false
        nullable: false
        type: boolean
      applicant_id:
        $ref: '#/components/schemas/WorkflowSessionApplicantId'
      data:
        $ref: '#/components/schemas/BankAccountLookupFull_data'
    required:
    - applicant_id
    - created_at
    - data
    - data_anonymized
    - id
    - previous_attempt_id
    - status
    - status_codes
    - updated_at
    - workflow_session_id
    - workspace_id
    title: BankAccountLookupFull
    type: object
  BankAccountMeta:
    properties:
      id:
        $ref: '#/components/schemas/UUID'
      workspace_id:
        description: The Workspace ID in which the verification has been created.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      created_at:
        description: Creation date of the Bank Account Verification.
        example: '2025-02-12T23:59:59Z'
        format: date-time
        type: string
      updated_at:
        description: Update date of the Bank Account Verification.
        example: '2025-02-12T23:59:59Z'
        format: date-time
        type: string
      status:
        $ref: '#/components/schemas/BankAccountStatus'
      status_codes:
        description: List of status codes. Indicates the cause when the status is
          `failed` or `inconclusive`.
        example:
        - BAV_1604
        - BAV_1611
        items:
          type: string
        type: array
      data_anonymized:
        description: 'Indicates if the personal data extracted from the document has
          been anonymized.

          If set to `true`, the personal data has been anonymized and most fields
          will be NULL.

          '
        type: boolean
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      applicant_id:
        $ref: '#/components/schemas/WorkflowSessionApplicantId'
    required:
    - applicant_id
    - created_at
    - data_anonymized
    - id
    - previous_attempt_id
    - status
    - status_codes
    - updated_at
    - workflow_session_id
    title: BankAccountMeta
    type: object
  InitiateBankAccountFromApplicant:
    additionalProperties: false
    properties:
      applicant_id:
        description: The Applicant ID linked to the Workflow Session.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
    required:
    - applicant_id
    title: Attach a new Bank Account Verification to an Applicant
    type: object
  InitiateBankAccount:
    additionalProperties: false
    properties:
      file:
        description: 'The file containing the bank account details.

          Accepted formats: PNG, JPEG, JPG, PDF.

          Max size: 10 MB. Max resolution: 20 mpx.

          '
        format: binary
        type: string
      iban:
        $ref: '#/components/schemas/IBAN'
      bic:
        $ref: '#/components/schemas/BIC'
      workspace_id:
        description: 'Scopes the verification to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9412b83b-b4b9-4a94-97b5-2b43dfa4cde3
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
    required:
    - file
    title: Initiate Bank Account Verification
    type: object
  InitiateBankAccountWithLegalPerson:
    additionalProperties: false
    properties:
      file:
        description: 'The file containing the bank account details.

          Accepted formats: PNG, JPEG, JPG, PDF.

          Max size: 10 MB. Max resolution: 20 mpx.

          '
        format: binary
        type: string
      iban:
        $ref: '#/components/schemas/IBAN'
      bic:
        $ref: '#/components/schemas/BIC'
      legal_person:
        $ref: '#/components/schemas/InitiateBankAccountWithLegalPerson_legal_person'
      workspace_id:
        description: 'Scopes the verification to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9412b83b-b4b9-4a94-97b5-2b43dfa4cde3
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
    required:
    - file
    - legal_person
    title: Initiate Bank Account Verification with legal person
    type: object
  InitiateBankAccountWithNaturalPerson:
    additionalProperties: false
    properties:
      file:
        description: 'The file containing the bank account details.

          Accepted formats: PNG, JPEG, JPG, PDF.

          Max size: 10 MB. Max resolution: 20 mpx.

          '
        format: binary
        type: string
      iban:
        $ref: '#/components/schemas/IBAN'
      bic:
        $ref: '#/components/schemas/BIC'
      natural_person:
        $ref: '#/components/schemas/InitiateBankAccountWithNaturalPerson_natural_person'
      workspace_id:
        description: 'Scopes the verification to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9412b83b-b4b9-4a94-97b5-2b43dfa4cde3
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
    required:
    - file
    - natural_person
    title: Initiate Bank Account Verification with natural person
    type: object
  BankAccountFull:
    allOf:
    - $ref: '#/components/schemas/BankAccountMeta'
    - properties:
        data:
          $ref: '#/components/schemas/BankAccountFull_allOf_data'
      required:
      - data
      type: object
    title: BankAccountFull
    type: object
  CompanyMeta:
    properties:
      id:
        $ref: '#/components/schemas/UUID'
      workspace_id:
        description: The Workspace ID in which the verification has been created.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      created_at:
        description: Creation date of the Company Verification.
        example: '2023-01-01T12:00:00Z'
        format: date-time
        type: string
      updated_at:
        description: Update date of the Company Verification.
        example: '2023-01-01T12:00:00Z'
        format: date-time
        type: string
      status:
        description: Status of the Company Verification.
        enum:
        - pending
        - awaiting_data
        - verified
        - failed
        - inconclusive
        example: verified
        type: string
      data_anonymized:
        description: 'Indicates if the company data has been anonymized.

          If set to `true`, all fields in the `data` field are set to NULL.

          '
        example: false
        nullable: false
        type: boolean
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      applicant_id:
        $ref: '#/components/schemas/WorkflowSessionApplicantId'
    required:
    - applicant_id
    - created_at
    - id
    - previous_attempt_id
    - status
    - updated_at
    - workflow_session_id
    - workspace_id
    title: CompanyMeta
    type: object
  InitiateCompanyFromJson:
    properties:
      company_number:
        description: 'Please provide the exact company number depending on the country
          format.

          For any doubt, consult the Company Verification [guide](https://developers.yousign.com/docs/company-verification).

          '
        example: '794513986'
        minLength: 1
        type: string
      country_code:
        description: Defines the country where the company is registered.
        enum:
        - FR
        - GB
        - BE
        - CH
        - NL
        - ES
        - LU
        - IT
        - DE
        example: FR
        maxLength: 2
        minLength: 2
        type: string
      workspace_id:
        description: 'Scopes the verification to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      company_name:
        description: 'The company name. Required for German (DE) companies.\

          When country_code is DE, this field must be provided.\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).

          '
        example: Test Company GmbH
        format: safe-string
        maxLength: 255
        nullable: true
        type: string
      zip_code:
        description: 'Additional search field. Only accepted when country_code is
          DE.\

          For DE, it must be a 5-digit Postleitzahl (e.g. "10115").\

          Helps narrow the company lookup when several companies share similar names.\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).

          '
        example: '10115'
        format: safe-string
        maxLength: 10
        nullable: true
        type: string
      street:
        description: 'Additional search field. Only accepted when country_code is
          DE.\

          Helps narrow the company lookup when several companies share similar names.\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).

          '
        example: Unter den Linden 1
        format: safe-string
        maxLength: 255
        nullable: true
        type: string
      city:
        description: 'Additional search field. Only accepted when country_code is
          DE.\

          Helps narrow the company lookup when several companies share similar names.\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).

          '
        example: Berlin
        format: safe-string
        maxLength: 255
        nullable: true
        type: string
      register_court:
        description: 'Additional search field. Only accepted when country_code is
          DE.\

          The German commercial register court (Registergericht) handling the company.\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).

          '
        example: Amtsgericht Berlin (Charlottenburg)
        format: safe-string
        maxLength: 255
        nullable: true
        type: string
    required:
    - company_number
    - country_code
    title: Initiate Company Verification from company number
    type: object
  InitiateCompanyFromApplicant:
    additionalProperties: false
    properties:
      applicant_id:
        description: The Applicant ID linked to the Workflow Session.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
    required:
    - applicant_id
    title: Attach a new Company Verification to an Applicant
    type: object
  InitiateCompanyFromFile:
    properties:
      file:
        description: 'The file containing the company details mostly known as Kbis.

          Accepted formats: PDF.

          Max size: 10 MB.

          '
        example: Binary file
        format: binary
        type: string
      country_code:
        enum:
        - FR
        example: FR
        maxLength: 2
        minLength: 2
        type: string
      workspace_id:
        description: 'Scopes the verification to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
    required:
    - country_code
    - file
    title: Initiate Company Verification from Kbis
    type: object
  CompanyFull:
    allOf:
    - $ref: '#/components/schemas/CompanyMeta'
    - properties:
        data:
          $ref: '#/components/schemas/CompanyFull_allOf_data'
      required:
      - data
      type: object
    title: CompanyFull
    type: object
  IdentityDocumentMeta:
    properties:
      id:
        $ref: '#/components/schemas/UUID'
      workspace_id:
        description: The Workspace ID in which the verification has been created.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      created_at:
        description: Creation date of the Identity Document Verification.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      updated_at:
        description: Update date of the Identity Document Verification.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      status:
        $ref: '#/components/schemas/IdentityDocumentStatus'
      status_codes:
        description: List of status codes. Indicates the cause when the status is
          `failed` or `inconclusive`.
        example:
        - IDDV_1706
        - IDDV_1707
        items:
          type: string
        type: array
      data_anonymized:
        description: 'Indicates if the personal data extracted from the document has
          been anonymized.

          If set to `true`, the personal data has been anonymized and most fields
          will be NULL.

          '
        example: false
        type: boolean
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      applicant_id:
        $ref: '#/components/schemas/WorkflowSessionApplicantId'
    required:
    - applicant_id
    - created_at
    - data_anonymized
    - id
    - previous_attempt_id
    - status
    - status_codes
    - updated_at
    - workflow_session_id
    - workspace_id
    title: IdentityDocumentMeta
    type: object
  InitiateIdentityDocumentFromApplicant:
    additionalProperties: false
    properties:
      applicant_id:
        description: The Applicant ID linked to the Workflow Session.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
    required:
    - applicant_id
    title: Attach a new Identity Document Verification to an Applicant
    type: object
  InitiateIdentityDocument:
    additionalProperties: false
    properties:
      first_name:
        description: 'Please provide the holder first name, exactly as it appears
          on the ID document.

          Please match it exactly, with the same characters, same case.

          One exception: if the document mentions an honorary title, please don''t
          provide it as part of the name.

          '
        example: John
        maxLength: 255
        minLength: 1
        nullable: false
        type: string
      last_name:
        description: 'Please provide the holder last name, exactly as it appears on
          the ID document birth name.

          Please match it exactly, with the same characters, same case.

          One exception: if the document mentions an honorary title, please don''t
          provide it as part of the name.

          '
        example: Doe
        maxLength: 255
        minLength: 1
        nullable: false
        type: string
      type:
        description: The document type to verify
        enum:
        - id_card
        - passport
        - residence_permit
        - ita_ts_cns
        example: id_card
        type: string
      file:
        description: 'The identity document file to verify.

          Accepted formats: PNG, JPEG, JPG, PDF.

          Max size: 10 MB. Max resolution: 20 mpx.

          '
        format: binary
        type: string
      additional_file:
        description: 'Additional document file, such as the back side of an identity
          card.

          Accepted formats: PNG, JPEG, JPG, PDF.

          Max size: 10 MB. Max resolution: 20 mpx.

          '
        format: binary
        type: string
      workspace_id:
        description: 'Scopes the verification to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9412b83b-b4b9-4a94-97b5-2b43dfa4cde3
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      min_age:
        description: Minimum age required for the document holder.
        example: 18
        minimum: 1
        nullable: true
        type: integer
      max_age:
        description: Maximum age allowed for the document holder.
        example: 65
        minimum: 1
        nullable: true
        type: integer
      prohibited_countries:
        description: List of prohibited issuing countries (ISO 3166-1 alpha-2).
        example:
        - RU
        - KP
        items:
          pattern: ^[A-Z]{2}$
          type: string
        minItems: 1
        nullable: true
        type: array
    required:
    - file
    - first_name
    - last_name
    title: Initiate an Identity Document Verification with names
    type: object
  InitiateIdentityDocumentWithoutName:
    additionalProperties: false
    properties:
      type:
        description: The document type to verify
        enum:
        - id_card
        - passport
        - residence_permit
        - ita_ts_cns
        example: id_card
        type: string
      file:
        description: 'The identity document file to verify.

          Accepted formats: PNG, JPEG, JPG, PDF.

          Max size: 10 MB. Max resolution: 20 mpx.

          '
        format: binary
        type: string
      additional_file:
        description: 'Additional document file, such as the back side of an identity
          card.

          Accepted formats: PNG, JPEG, JPG, PDF.

          Max size: 10 MB. Max resolution: 20 mpx.

          '
        format: binary
        type: string
      workspace_id:
        description: 'Scopes the verification to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9412b83b-b4b9-4a94-97b5-2b43dfa4cde3
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      min_age:
        description: Minimum age required for the document holder.
        example: 18
        minimum: 1
        nullable: true
        type: integer
      max_age:
        description: Maximum age allowed for the document holder.
        example: 65
        minimum: 1
        nullable: true
        type: integer
      prohibited_countries:
        description: List of prohibited issuing countries (ISO 3166-1 alpha-2).
        example:
        - RU
        - KP
        items:
          pattern: ^[A-Z]{2}$
          type: string
        minItems: 1
        nullable: true
        type: array
    required:
    - file
    title: Initiate an Identity Document Verification without names
    type: object
  IdentityDocumentFull:
    allOf:
    - $ref: '#/components/schemas/IdentityDocumentMeta'
    - properties:
        data:
          $ref: '#/components/schemas/IdentityDocumentFull_allOf_data'
      required:
      - data
      type: object
    title: IdentityDocumentFull
    type: object
  IdentityVideoMeta:
    properties:
      id:
        $ref: '#/components/schemas/UUID'
      workspace_id:
        description: The Workspace ID in which the verification has been created.
        example: 9412b83b-b4b9-4a94-97b5-2b43dfa4cde3
        format: uuid
        type: string
      created_at:
        description: Creation date of the Identity Video Verification.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      updated_at:
        description: Update date of the Identity Video Verification.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      status:
        $ref: '#/components/schemas/IdentityVideoStatus'
      status_codes:
        description: List of status codes. Indicates the cause when the status is
          `failed` or `inconclusive`.
        example:
        - IDVV_1112
        items:
          type: string
        type: array
      data_anonymized:
        description: 'Indicates if the personal data extracted has been anonymized.

          If set to `true`, the personal data has been anonymized and most fields
          will be NULL.

          '
        example: false
        type: boolean
      face_recognition:
        description: Indicates if face recognition was enabled during the verification
          process.
        example: false
        type: boolean
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
    required:
    - created_at
    - data_anonymized
    - face_recognition
    - id
    - previous_attempt_id
    - status
    - status_codes
    - updated_at
    - workflow_session_id
    - workspace_id
    title: IdentityVideoMeta
    type: object
  InitiateIdentityVideo:
    additionalProperties: false
    properties:
      first_name:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        description: The first name provided must match exactly as it appears on the
          ID document, as a consistency check will be performed. If multiple given
          names are listed on the document, you must provide only one of them.
        example: John
        maxLength: 255
        minLength: 1
        type: string
      last_name:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        description: The last name provided must match exactly as it appears on the
          ID document, as a consistency check will be performed. If both a birth name
          and a usage name are listed on the document, you must provide one of them,
          but not both.
        example: Doe
        maxLength: 255
        minLength: 1
        type: string
      redirection_url:
        description: The URL to redirect the person back to your application or website
          after the identity verification flow is complete.
        example: https://example.com/
        format: uri
        maxLength: 2000
        minLength: 1
        type: string
      face_recognition:
        default: false
        description: Enable face recognition step in the identity verification flow.
        example: false
        type: boolean
      pvid:
        default: false
        description: Enable PVID mode in the identity verification flow.
        example: false
        type: boolean
      workspace_id:
        description: 'Scopes the verification to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9412b83b-b4b9-4a94-97b5-2b43dfa4cde3
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      min_age:
        description: Minimum age required for the document holder.
        example: 18
        minimum: 1
        nullable: true
        type: integer
      max_age:
        description: Maximum age allowed for the document holder.
        example: 65
        minimum: 1
        nullable: true
        type: integer
      prohibited_countries:
        description: List of prohibited issuing countries (ISO 3166-1 alpha-2).
        example:
        - RU
        - KP
        items:
          pattern: ^[A-Z]{2}$
          type: string
        minItems: 1
        nullable: true
        type: array
      pre_selected_residence_country_code:
        description: Pre-fill the residence country in the verification flow (ISO
          3166-1 alpha-2, uppercase).
        example: FR
        format: ISO 3166-1 alpha-2
        nullable: true
        pattern: ^[A-Z]{2}$
        type: string
      pre_selected_document_issuing_country_code:
        description: Pre-fill the document issuing country in the verification flow
          (ISO 3166-1 alpha-2, uppercase).
        example: FR
        format: ISO 3166-1 alpha-2
        nullable: true
        pattern: ^[A-Z]{2}$
        type: string
      pre_selected_document_type:
        description: Pre-fill the document type in the verification flow.
        enum:
        - id_card
        - passport
        - residence_permit
        - driver_license
        - travel_document
        example: id_card
        nullable: true
        type: string
      pre_selected_locale:
        description: Pre-fill the UI language of the verification flow (ISO 639-1,
          lowercase 2-letter code).
        example: fr
        format: ISO 639-1
        nullable: true
        pattern: ^[a-z]{2}$
        type: string
    required:
    - first_name
    - last_name
    - redirection_url
    title: Initiate Identity Video Verification
    type: object
  IdentityVideoFull:
    allOf:
    - $ref: '#/components/schemas/IdentityVideoMeta'
    - properties:
        verification_url:
          description: The URL of the verification page that the user used to begin
            the verification process.
          example: https://id.ubble.ai/2f3e833c-6cf8-4c39-9004-cfb0e048ef63
          format: uri
          minLength: 1
          nullable: true
          type: string
        data:
          $ref: '#/components/schemas/IdentityVideoFull_allOf_data'
      required:
      - data
      - verification_url
      type: object
    title: IdentityVideoFull
    type: object
  ProofOfAddressMeta:
    properties:
      id:
        $ref: '#/components/schemas/UUID'
      workspace_id:
        description: The Workspace ID in which the Proof of Address Verification has
          been created.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      created_at:
        description: Creation date of the Proof of Address Verification.
        example: '2025-02-12T23:59:59Z'
        format: date-time
        type: string
      updated_at:
        description: Update date of the Proof of Address Verification.
        example: '2025-02-12T23:59:59Z'
        format: date-time
        type: string
      status:
        description: Status of the verification
        enum:
        - pending
        - awaiting_data
        - verified
        - failed
        - inconclusive
        example: failed
        type: string
      status_codes:
        description: List of status codes. Indicates the cause when the status is
          `failed` or `inconclusive`.
        example:
        - POAV_1611
        - POAV_1612
        items:
          type: string
        type: array
      data_anonymized:
        description: 'Indicates if the data related to the ProofOfAddress Verification
          has been anonymized.

          If set to `true`, the data are removed and most fields will be NULL.

          '
        example: false
        type: boolean
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      applicant_id:
        $ref: '#/components/schemas/WorkflowSessionApplicantId'
    required:
    - applicant_id
    - created_at
    - data_anonymized
    - id
    - previous_attempt_id
    - status
    - status_codes
    - updated_at
    - workflow_session_id
    - workspace_id
    title: ProofOfAddressMeta
    type: object
  InitiateProofOfAddressFromApplicant:
    additionalProperties: false
    properties:
      applicant_id:
        description: The Applicant ID linked to the Workflow Session.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
    required:
    - applicant_id
    title: Attach a new Proof of Address Verification to an Applicant
    type: object
  InitiateProofOfAddress:
    additionalProperties: false
    properties:
      file:
        description: 'The proof of address document.

          Accepted formats: PNG, JPEG, JPG, PDF.

          Max size: 10 MB. Max resolution: 20 mpx.

          '
        format: binary
        type: string
      natural_person:
        $ref: '#/components/schemas/InitiateProofOfAddress_natural_person'
      workspace_id:
        description: 'Scopes the verification to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9412b83b-b4b9-4a94-97b5-2b43dfa4cde3
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
    required:
    - file
    title: Create Proof of Address Verification
    type: object
  ProofOfAddressFull:
    allOf:
    - $ref: '#/components/schemas/ProofOfAddressMeta'
    - properties:
        data:
          $ref: '#/components/schemas/ProofOfAddressFull_allOf_data'
      required:
      - data
      type: object
    title: ProofOfAddressFull
    type: object
  WatchlistMeta:
    properties:
      id:
        $ref: '#/components/schemas/UUID'
      workspace_id:
        description: The Workspace ID in which the verification has been created.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      created_at:
        description: Creation date of the Watchlist Verification.
        example: '2025-02-12T23:59:59Z'
        format: date-time
        type: string
      updated_at:
        description: Update date of the Watchlist Verification.
        example: '2025-02-12T23:59:59Z'
        format: date-time
        type: string
      status:
        $ref: '#/components/schemas/WatchlistStatus'
      data_anonymized:
        description: 'Indicates if the data related to the Watchlist Verification
          has been anonymized.

          If set to `true`, the data are removed and most fields will be NULL.

          '
        example: false
        type: boolean
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
    required:
    - created_at
    - data_anonymized
    - id
    - previous_attempt_id
    - status
    - updated_at
    - workflow_session_id
    - workspace_id
    title: WatchlistMeta
    type: object
  InitiateWatchlist:
    additionalProperties: false
    properties:
      workspace_id:
        description: 'Scopes the verification to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9412b83b-b4b9-4a94-97b5-2b43dfa4cde3
        format: uuid
        nullable: true
        type: string
      natural_person:
        $ref: '#/components/schemas/InitiateWatchlist_natural_person'
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
    required:
    - natural_person
    title: Initiate Watchlist Verification
    type: object
  WatchlistFull:
    allOf:
    - $ref: '#/components/schemas/WatchlistMeta'
    - properties:
        data:
          $ref: '#/components/schemas/WatchlistFull_allOf_data'
      required:
      - data
      type: object
    title: WatchlistFull
    type: object
  WebhookSubscription:
    properties:
      id:
        example: 89120884-d29a-4b1a-ac7b-a9e73a872795
        format: uuid
        type: string
      endpoint:
        description: HTTPS target URL that will receive webhook POST requests. It
          must be publicly accessible and may include a specified port.
        example: https://example.com:port/my-endpoint
        format: uri
        maxLength: 1024
        type: string
      description:
        description: Short description of the webhook
        example: Lorem Ipsum
        maxLength: 128
        nullable: true
        type: string
      sandbox:
        example: false
        type: boolean
      subscribed_events:
        $ref: '#/components/schemas/WebhookSubscription_subscribed_events'
      secret_key:
        description: Autogenerated 32 bytes key
        type: string
      scopes:
        $ref: '#/components/schemas/WebhookSubscription_scopes'
      workspaces:
        $ref: '#/components/schemas/WebhookSubscription_workspaces'
      auto_retry:
        description: 'If a Webhook request fails for any reason, Yousign will retry
          the request 8 times using a back-off mechanism after: 2, 6, 30, 60, 300,
          1080, 1440, 2880 min'
        type: boolean
      enabled:
        description: Is the webhook enabled?
        type: boolean
      created_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      updated_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        nullable: true
        type: string
    required:
    - auto_retry
    - created_at
    - description
    - enabled
    - endpoint
    - id
    - sandbox
    - scopes
    - secret_key
    - subscribed_events
    - updated_at
    - workspaces
    title: WebhookSubscription Response
    type: object
  CreateWebhookSubscription:
    properties:
      endpoint:
        description: HTTPS target URL that will receive webhook POST requests. It
          must be publicly accessible and may include a specified port.
        example: https://example.com:port/my-endpoint
        format: uri
        maxLength: 1024
        type: string
      description:
        description: 'Short description of the webhook.\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).

          '
        example: Lorem Ipsum
        format: safe-string
        maxLength: 128
        nullable: true
        type: string
      sandbox:
        example: true
        type: boolean
      subscribed_events:
        $ref: '#/components/schemas/CreateWebhookSubscription_subscribed_events'
      secret_key:
        description: Autogenerated 32 bytes key
        maxLength: 32
        minLength: 32
        nullable: true
        type: string
      scopes:
        $ref: '#/components/schemas/CreateWebhookSubscription_scopes'
      workspaces:
        $ref: '#/components/schemas/CreateWebhookSubscription_workspaces'
      auto_retry:
        description: 'If a Webhook request fails for any reason, Yousign will retry
          the request 8 times using a back-off mechanism after: 2, 6, 30, 60, 300,
          1080, 1440, 2880 min'
        type: boolean
      enabled:
        description: Choose whether the webhook is enabled or not.
        type: boolean
    required:
    - auto_retry
    - description
    - enabled
    - endpoint
    - sandbox
    - scopes
    - subscribed_events
    title: CreateWebhookSubscription Request Body
    type: object
  UpdateWebhookSubscription:
    properties:
      endpoint:
        description: HTTPS target URL that will receive webhook POST requests. It
          must be publicly accessible and may include a specified port.
        example: https://example.com:port/my-endpoint
        format: uri
        maxLength: 1024
        type: string
      description:
        description: 'Short description of the webhook.\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).

          '
        example: Lorem Ipsum
        format: safe-string
        maxLength: 128
        nullable: true
        type: string
      sandbox:
        example: true
        type: boolean
      subscribed_events:
        $ref: '#/components/schemas/CreateWebhookSubscription_subscribed_events'
      secret_key:
        description: Autogenerated 32 bytes key
        maxLength: 32
        minLength: 32
        nullable: true
        type: string
      scopes:
        $ref: '#/components/schemas/CreateWebhookSubscription_scopes'
      workspaces:
        $ref: '#/components/schemas/CreateWebhookSubscription_workspaces'
      auto_retry:
        description: 'If a Webhook request fails for any reason, Yousign will retry
          the request 8 times using a back-off mechanism after: 2, 6, 30, 60, 300,
          1080, 1440, 2880 min'
        type: boolean
      enabled:
        description: Choose whether the webhook is enabled or not.
        type: boolean
    title: UpdateWebhookSubscription Request Body
    type: object
  WorkflowSession:
    additionalProperties: false
    properties:
      id:
        description: Unique identifier of the Workflow Session.
        example: 0ef334d2-7f36-4643-8a2a-4283b4a3e4a4
        format: uuid
        type: string
      created_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      updated_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      name:
        description: Name given to the Workflow Session. Used to easily find it in
          the application.
        example: Customer onboarding of John Doe
        type: string
      workflow_template_id:
        description: Unique identifier of the Workflow Template from which this Workflow
          Session was created.
        example: 0ef334d2-7f36-4643-8a2a-4283b4a3e4a4
        format: uuid
        type: string
      workspace_id:
        description: Unique identifier of the Workspace in which this Workflow Session
          is scoped.
        example: 0ef334d2-7f36-4643-8a2a-4283b4a3e4a4
        format: uuid
        type: string
      status:
        description: Status of the Workflow Session.
        enum:
        - awaiting
        - ongoing
        - blocked
        - done
        example: ongoing
        type: string
      action_groups:
        description: List of the Action Groups contained in the Workflow Session.
        items:
          $ref: '#/components/schemas/WorkflowSession_action_groups_inner'
        type: array
    required:
    - action_groups
    - created_at
    - id
    - name
    - status
    - updated_at
    - workflow_template_id
    - workspace_id
    title: Workflow Session
    type: object
  CreateWorkflowSession:
    additionalProperties: false
    properties:
      workflow_template_id:
        description: Unique ID of the Workflow Template from which to create the new
          Workflow Session.
        example: 0ef334d2-7f36-4643-8a2a-4283b4a3e4a4
        format: uuid
        type: string
      workspace_id:
        description: Unique ID of the Workspace in which to scope the Workflow Session.
        example: 0ef334d2-7f36-4643-8a2a-4283b4a3e4a4
        format: uuid
        type: string
      name:
        description: 'Name given to the Workflow Session. Enter a meaningful, descriptive
          name to help you easily find this Workflow Session in the application.\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).

          '
        example: Customer onboarding of John Doe.
        format: safe-string
        maxLength: 128
        minLength: 1
        type: string
    required:
    - name
    - workflow_template_id
    type: object
  WorkflowSessionApplicantListItem:
    additionalProperties: false
    description: An Applicant associated with a Workflow Session (list view).
    properties:
      id:
        description: Unique identifier of the Applicant.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      workflow_session_id:
        description: Unique identifier of the Workflow Session.
        example: 0ef334d2-7f36-4643-8a2a-4283b4a3e4a4
        format: uuid
        type: string
      status:
        description: Status of the Applicant.
        enum:
        - initiated
        - notified
        - processed
        example: initiated
        type: string
      label:
        description: Label of the Applicant.
        example: John Doe
        type: string
      reference_id:
        description: Unique applicant identifier as registered on your side.
        example: REF-12345
        nullable: true
        type: string
      created_at:
        description: Creation date of the Applicant.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      updated_at:
        description: Last update date of the Applicant.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      type:
        description: Type of the Applicant.
        enum:
        - natural_person
        - legal_person
        example: natural_person
        type: string
    required:
    - created_at
    - id
    - label
    - reference_id
    - status
    - type
    - updated_at
    - workflow_session_id
    title: Applicant List Item
    type: object
  CreateWorkflowSessionApplicant:
    description: Request body to create a new Applicant for a Workflow Session.
    discriminator:
      propertyName: type
    oneOf:
    - $ref: '#/components/schemas/CreateWorkflowSessionApplicantNaturalPerson'
    - $ref: '#/components/schemas/CreateWorkflowSessionApplicantLegalPerson'
    title: Create Applicant
  WorkflowSessionApplicant:
    description: An Applicant associated with a Workflow Session (full view).
    discriminator:
      propertyName: type
    oneOf:
    - $ref: '#/components/schemas/Natural_Person_Applicant'
    - $ref: '#/components/schemas/Legal_Person_Applicant'
    title: Applicant
  UpdateWorkflowSessionApplicant:
    additionalProperties: false
    description: Update an Applicant associated with a Workflow Session (PATCH).
    properties:
      label:
        description: Label of the Applicant.
        example: John Doe
        maxLength: 255
        minLength: 1
        type: string
      reference_id:
        description: Unique applicant identifier as registered on your side.
        example: REF-12345
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      natural_person:
        $ref: '#/components/schemas/UpdateNaturalPerson'
      legal_person:
        $ref: '#/components/schemas/UpdateLegalPerson'
    title: Update Applicant
    type: object
  WorkflowSessionLinks:
    additionalProperties: false
    description: Portal links for Workflow Session Applicants.
    properties:
      applicants:
        description: List of Applicants with their portal links.
        items:
          $ref: '#/components/schemas/WorkflowSessionLinks_applicants_inner'
        type: array
    required:
    - applicants
    title: Workflow Session Links
    type: object
  ResolveWorkflowSessionAction:
    additionalProperties: false
    properties:
      resource:
        $ref: '#/components/schemas/ResolveWorkflowSessionAction_resource'
      reason:
        description: 'The reason why the Action is marked as resolved.\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).

          '
        example: Manual verification.
        format: safe-string
        maxLength: 150
        nullable: true
        type: string
    required:
    - resource
    type: object
  WorkflowTemplate:
    properties:
      id:
        description: Unique identifier of the Workflow Template.
        example: 0ef334d2-7f36-4643-8a2a-4283b4a3e4a4
        format: uuid
        type: string
      name:
        description: Name of the Workflow Template.
        example: Customer Onboarding
        type: string
      action_groups:
        description: List of the Action Groups contained in the Workflow Template.
          The Action Groups will determine what Actions the end users will have to
          go through to complete the Workflow Session.
        items:
          $ref: '#/components/schemas/WorkflowTemplate_action_groups_inner'
        type: array
      workspaces:
        description: List of Workspaces that define where the Workflow Template is
          scoped. The scoping determines which Workspace a Workflow Session created
          from this Template will belong to. Behavior varies depending on whether
          the Template is scoped to one, multiple, or no Workspaces.
        items:
          $ref: '#/components/schemas/WorkflowTemplate_workspaces_inner'
        type: array
    required:
    - action_groups
    - id
    - name
    - workspaces
    title: A Workflow Template
    type: object
  Workspace:
    properties:
      id:
        example: 89120884-d29a-4b1a-ac7b-a9e73a872795
        format: uuid
        readOnly: true
        type: string
      name:
        type: string
      external_name:
        nullable: true
        type: string
      default:
        type: boolean
      created_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        readOnly: true
        type: string
      updated_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        readOnly: true
        type: string
      deleted_at:
        format: date-time
        nullable: true
        readOnly: true
        type: string
      users:
        items:
          $ref: '#/components/schemas/Workspace_users_inner'
        type: array
    required:
    - created_at
    - default
    - deleted_at
    - external_name
    - id
    - name
    - updated_at
    - users
    title: Workspace
    type: object
  CreateWorkspace:
    additionalProperties: false
    properties:
      name:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: Sales
        format: safe-string
        maxLength: 200
        type: string
      external_name:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: UK Sales
        format: safe-string
        maxLength: 200
        nullable: true
        type: string
    required:
    - name
    type: object
  MarkWorkspaceAsDefault:
    additionalProperties: false
    properties:
      workspace_id:
        description: The workspace you want to mark as the default one
        format: uuid
        type: string
    required:
    - workspace_id
    type: object
  DeleteWorkspace:
    additionalProperties: false
    properties:
      workspace_id:
        description: The target workspace where resources are migrated in.
        format: uuid
        type: string
    required:
    - workspace_id
    type: object
  UpdateWorkspace:
    properties:
      name:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: Sales
        format: safe-string
        maxLength: 200
        type: string
      external_name:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        example: UK Sales
        format: safe-string
        maxLength: 200
        nullable: true
        type: string
    type: object
  KycAddonConsumptionsName:
    enum:
    - bank_account_connection_verification
    - bank_account_lookup_verification
    - bank_account_verification
    - company_verification
    - company_de_verification
    - company_it_verification
    - document_analysis_verification
    - document_analysis_tax_notice_verification
    - document_trust_advanced_verification
    - identity_document_verification
    - identity_video_face_recognition_verification
    - certified_identity_pvid
    - identity_video_verification
    - proof_of_address_verification
    - watchlist_verification
    type: string
  HumanName:
    pattern: ^(?!\s)[0-9A-Za-zĄÀÁÂÃÄÅÇĆÈÉÊËĘÌÍÎÏŁÑŃÒÓÔÕÖŚÙÚÛÜÝŹŻąàáâãäåæçćèéêëęìíîïłñńòóôõöśùúûüýÿźżßĀāĂăĈĉĊċČčĎďĐđĒēĔĕĖėĚěĜĝĞğĠġĢģĤĥĦħĨĩĪīĬĭĮįİıIJijĴĵĶķĸĹĺĻļĽľĿŀŅņŇňʼnŊŋŌōŎŏŐőŒœŔŕŖŗŘřŜŝŞşŠšŢţŤťŦŧŨũŪūŬŭŮůŰűŲųŴŵŶŷŸŽžſøØÆȘșȚț`'()
      -]+(?<!\s)$
    type: string
  Locale:
    description: Locale settings used for communication.
    enum:
    - en
    - fr
    - de
    - it
    - nl
    - es
    - pl
    minLength: 1
    title: Locale
    type: string
  CustomExperience_DisabledNotificationsType:
    enum:
    - approver.expiration_date_reminder
    - approver.canceled
    - approver.expiration_date_updated
    - approver.notified
    - approver.approved
    - approver.rejected
    - approver.declined
    - follower.approved
    - follower.canceled
    - follower.completed
    - follower.expired
    - follower.rejected
    - follower.activated
    - follower.signed
    - follower.declined
    - sender.approved
    - sender.canceled
    - sender.completed
    - sender.rejected
    - sender.signed
    - sender.declined
    - signer.expiration_date_reminder
    - signer.canceled
    - signer.completed
    - signer.signed
    - signer.expiration_date_updated
    - signer.signature_requested
    - signer.declined
    example: approver.canceled
    type: string
  CustomExperience_Source:
    description: Custom Experience Source
    enum:
    - app
    - public_api
    example: app
    nullable: true
    type: string
  LogoLayout:
    description: 'Determines the display layout of the logo. Possible values are:

      - `round`: Displays the logo in a circular format.

      - `original`: Displays the logo in its original shape.

      '
    enum:
    - round
    - original
    example: round
    title: LogoLayout
    type: string
  CustomPropertyOptionInput:
    properties:
      value:
        description: Display text of the option.
        example: Quote
        maxLength: 255
        minLength: 1
        type: string
      is_default:
        default: false
        description: 'Whether this option is pre-selected on new SRs.

          Multiple defaults allowed if multiple_answer_allowed is true.

          '
        type: boolean
      position:
        description: 'Sort order (0-based). If omitted, values are ordered as provided.

          '
        example: 0
        minimum: 0
        type: integer
    required:
    - value
    title: CustomPropertyOptionInput
    type: object
  CustomPropertyOption:
    properties:
      id:
        description: Unique identifier of the option
        format: uuid
        type: string
      value:
        description: Display text of the option
        type: string
      is_default:
        description: Whether this option is pre-selected on new SRs
        type: boolean
      position:
        description: Sort order
        type: integer
    required:
    - id
    - is_default
    - position
    - value
    title: CustomPropertyOption
    type: object
  CustomPropertyOptionUpdate:
    properties:
      id:
        description: 'Include for existing options to preserve them.

          Omit for new options (a new id will be generated).

          '
        example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        format: uuid
        type: string
      value:
        description: Display text of the option.
        example: Sales Quote
        maxLength: 255
        minLength: 1
        type: string
      is_default:
        default: false
        description: 'Whether this option is pre-selected on new SRs.

          Multiple defaults allowed if multiple_answer_allowed is true.

          '
        type: boolean
      position:
        description: 'Sort order (0-based). If omitted, values are ordered as provided.

          '
        example: 0
        minimum: 0
        type: integer
    required:
    - value
    title: CustomPropertyOptionUpdate
    type: object
  WorkflowSessionId:
    description: 'Unique identifier of a Workflow Session. When provided, an Action
      is created in the Workflow Session, and this resource is associated with that
      Action.

      '
    example: 0ef334d2-7f36-4643-8a2a-4283b4a3e4a4
    format: uuid
    nullable: true
    title: Workflow Session identifier
    type: string
  PreviousAttemptId:
    description: 'ID of the previous attempt within the same `workflow_session_id`.

      Allows continuity between multiple attempts of the same Action.

      Null if this is the first attempt.

      '
    example: 9412b83b-b4b9-4a94-97b5-2b43dfa4cde4
    format: uuid
    nullable: true
    title: Previous Attempt identifier
    type: string
  DocumentAnalysisStatus:
    description: Status of the Document Analysis.
    enum:
    - pending
    - awaiting_data
    - done
    - inconclusive
    - failed
    example: done
    type: string
  DocumentAnalysisType:
    description: Type of document you want to analyze. Will be used to match the detected
      document type.
    enum:
    - social_security
    - company_certificate
    - business_registration_certificate
    - driver_licence
    - rne_certificate
    - temporary_vehicle_registration_document
    - vehicle_registration_document
    - auto_insurance_claims_history
    - tax_notice
    - payslip
    - invoice
    example: social_security
    type: string
  AnalysisType:
    additionalProperties: false
    description: 'Controls what the Document Analysis performs.


      - When `extraction` is `true` (default), data is extracted from the document
      and a document `type` is **required**.

      - When `extraction` is `false` (fraud-only), no `type` must be provided and
      `fraud_level` must be `advanced`.

      '
    properties:
      extraction:
        default: true
        description: 'Whether to extract data from the document. Defaults to `true`
          when omitted.

          Set to `false` to run a fraud-only analysis (no data extraction).

          '
        example: true
        type: boolean
      fraud_level:
        description: 'Level of fraud detection to run. `null` (default) disables fraud
          detection.

          Not supported for type `tax_notice`. Must be `advanced` when `extraction`
          is `false`.

          '
        enum:
        - none
        - advanced
        example: advanced
        nullable: true
        type: string
    title: AnalysisType
    type: object
  FraudRiskAnalysis:
    additionalProperties: false
    description: 'Result of the fraud detection analysis. `null` when no fraud detection
      verdict is available

      (e.g. fraud detection was not requested, or is still in progress).

      '
    nullable: true
    properties:
      risk_level:
        description: Overall fraud risk level of the document. `null` when not yet
          determined.
        enum:
        - high
        - medium
        - low
        - trusted
        example: low
        nullable: true
        type: string
      indicators:
        description: List of fraud indicators detected on the document.
        items:
          $ref: '#/components/schemas/FraudRiskAnalysis_indicators_inner'
        type: array
    required:
    - indicators
    - risk_level
    title: FraudRiskAnalysis
    type: object
  InitiateSocialSecurity:
    additionalProperties: false
    properties:
      file:
        description: 'The file containing the data to extract.

          Accepted formats: PDF, PNG, JPG, JPEG.

          Max size: 25 MB.

          Max number of pages per PDF: 10.

          '
        example: Binary file
        format: binary
        type: string
      type:
        description: Type of document you want to analyze. Will be used to match the
          detected document type.
        enum:
        - social_security
        example: social_security
        type: string
      workspace_id:
        description: 'Scopes the Document Analysis to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      analysis_type:
        $ref: '#/components/schemas/AnalysisTypeMultipart'
      checks:
        $ref: '#/components/schemas/InitiateSocialSecurity_checks'
    required:
    - file
    - type
    title: Initiate Social Security
    type: object
  InitiateCompanyCertificate:
    additionalProperties: false
    properties:
      file:
        description: 'The file containing the data to extract.

          Accepted formats: PDF, PNG, JPG, JPEG.

          Max size: 25 MB.

          Max number of pages per PDF: 10.

          '
        example: Binary file
        format: binary
        type: string
      type:
        description: Type of document you want to analyze. Will be used to match the
          detected document type.
        enum:
        - company_certificate
        example: company_certificate
        type: string
      workspace_id:
        description: 'Scopes the Document Analysis to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      analysis_type:
        $ref: '#/components/schemas/AnalysisTypeMultipart'
      checks:
        $ref: '#/components/schemas/InitiateCompanyCertificate_checks'
    required:
    - file
    - type
    title: Initiate Company Certificate
    type: object
  InitiateBusinessRegistrationCertificate:
    additionalProperties: false
    properties:
      file:
        description: 'The file containing the data to extract.

          Accepted formats: PDF, PNG, JPG, JPEG.

          Max size: 25 MB.

          Max number of pages per PDF: 10.

          '
        example: Binary file
        format: binary
        type: string
      type:
        description: Type of document you want to analyze. Will be used to match the
          detected document type.
        enum:
        - business_registration_certificate
        example: business_registration_certificate
        type: string
      workspace_id:
        description: 'Scopes the Document Analysis to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      analysis_type:
        $ref: '#/components/schemas/AnalysisTypeMultipart'
      checks:
        $ref: '#/components/schemas/InitiateSocialSecurity_checks'
    required:
    - file
    - type
    title: Initiate Business Registration Certificate
    type: object
  InitiateDriverLicence:
    additionalProperties: false
    properties:
      file:
        description: 'The file containing the data to extract.

          Accepted formats: PDF, PNG, JPG, JPEG.

          Max size: 25 MB.

          Max number of pages per PDF: 10.

          '
        example: Binary file
        format: binary
        type: string
      type:
        description: Type of document you want to analyze. Will be used to match the
          detected document type.
        enum:
        - driver_licence
        example: driver_licence
        type: string
      workspace_id:
        description: 'Scopes the Document Analysis to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      analysis_type:
        $ref: '#/components/schemas/AnalysisTypeMultipart'
      checks:
        $ref: '#/components/schemas/InitiateSocialSecurity_checks'
    required:
    - file
    - type
    title: Initiate Driver Licence
    type: object
  InitiateRNECertificate:
    additionalProperties: false
    properties:
      file:
        description: 'The file containing the data to extract.

          Accepted formats: PDF, PNG, JPG, JPEG.

          Max size: 25 MB.

          Max number of pages per PDF: 10.

          '
        example: Binary file
        format: binary
        type: string
      type:
        description: Type of document you want to analyze. Will be used to match the
          detected document type.
        enum:
        - rne_certificate
        example: rne_certificate
        type: string
      workspace_id:
        description: 'Scopes the Document Analysis to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      analysis_type:
        $ref: '#/components/schemas/AnalysisTypeMultipart'
      checks:
        $ref: '#/components/schemas/InitiateCompanyCertificate_checks'
    required:
    - file
    - type
    title: Initiate RNE Certificate
    type: object
  InitiateTemporaryVehicleRegistrationDocument:
    additionalProperties: false
    properties:
      file:
        description: 'The file containing the data to extract.

          Accepted formats: PDF, PNG, JPG, JPEG.

          Max size: 25 MB.

          Max number of pages per PDF: 10.

          '
        example: Binary file
        format: binary
        type: string
      type:
        description: Type of document you want to analyze. Will be used to match the
          detected document type.
        enum:
        - temporary_vehicle_registration_document
        example: temporary_vehicle_registration_document
        type: string
      country_code:
        description: 'The country code of the document.

          Currently only Italian temporary vehicle registration documents are supported.

          '
        enum:
        - IT
        example: IT
        type: string
      workspace_id:
        description: 'Scopes the Document Analysis to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      analysis_type:
        $ref: '#/components/schemas/AnalysisTypeMultipart'
      checks:
        $ref: '#/components/schemas/InitiateTemporaryVehicleRegistrationDocument_checks'
    required:
    - country_code
    - file
    - type
    title: Initiate Temporary Vehicle Registration Document
    type: object
  InitiateVehicleRegistrationDocument:
    additionalProperties: false
    properties:
      file:
        description: 'The file containing the data to extract.

          Accepted formats: PDF, PNG, JPG, JPEG.

          Max size: 25 MB.

          Max number of pages per PDF: 10.

          '
        example: Binary file
        format: binary
        type: string
      type:
        description: Type of document you want to analyze. Will be used to match the
          detected document type.
        enum:
        - vehicle_registration_document
        example: vehicle_registration_document
        type: string
      country_code:
        description: The country code of the vehicle registration document.
        enum:
        - FR
        - IT
        example: FR
        type: string
      workspace_id:
        description: 'Scopes the Document Analysis to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      analysis_type:
        $ref: '#/components/schemas/AnalysisTypeMultipart'
      checks:
        $ref: '#/components/schemas/InitiateVehicleRegistrationDocument_checks'
    required:
    - country_code
    - file
    - type
    title: Initiate Vehicle Registration Document
    type: object
  InitiateAutoInsuranceClaimsHistory:
    additionalProperties: false
    properties:
      file:
        description: 'The file containing the data to extract.

          Accepted formats: PDF, PNG, JPG, JPEG.

          Max size: 25 MB.

          Max number of pages per PDF: 10.

          '
        example: Binary file
        format: binary
        type: string
      type:
        description: Type of document you want to analyze. Will be used to match the
          detected document type.
        enum:
        - auto_insurance_claims_history
        example: auto_insurance_claims_history
        type: string
      workspace_id:
        description: 'Scopes the Document Analysis to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      analysis_type:
        $ref: '#/components/schemas/AnalysisTypeMultipart'
      checks:
        $ref: '#/components/schemas/InitiateAutoInsuranceClaimsHistory_checks'
    required:
    - file
    - type
    title: Initiate Auto Insurance Claims History
    type: object
  InitiateTaxNotice:
    additionalProperties: false
    properties:
      file:
        description: 'The file containing the data to extract.

          Accepted formats: PDF, PNG, JPG, JPEG.

          Max size: 25 MB.

          Max number of pages per PDF: 10.

          '
        example: Binary file
        format: binary
        type: string
      type:
        description: Type of document you want to analyze. Will be used to match the
          detected document type.
        enum:
        - tax_notice
        example: tax_notice
        type: string
      country_code:
        description: The country code of the tax notice.
        enum:
        - FR
        example: FR
        type: string
      workspace_id:
        description: 'Scopes the Document Analysis to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      analysis_type:
        $ref: '#/components/schemas/AnalysisTypeMultipart'
      checks:
        $ref: '#/components/schemas/InitiateTaxNotice_checks'
    required:
    - country_code
    - file
    - type
    title: Initiate Tax Notice
    type: object
  InitiatePayslip:
    additionalProperties: false
    properties:
      file:
        description: 'The file containing the data to extract.

          Accepted formats: PDF, PNG, JPG, JPEG.

          Max size: 25 MB.

          Max number of pages per PDF: 10.

          '
        example: Binary file
        format: binary
        type: string
      type:
        description: Type of document you want to analyze. Will be used to match the
          detected document type.
        enum:
        - payslip
        example: payslip
        type: string
      country_code:
        description: The country code of the payslip.
        enum:
        - FR
        - IT
        example: FR
        type: string
      workspace_id:
        description: 'Scopes the Document Analysis to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      analysis_type:
        $ref: '#/components/schemas/AnalysisTypeMultipart'
      checks:
        $ref: '#/components/schemas/InitiatePayslip_checks'
    required:
    - country_code
    - file
    - type
    title: Initiate Payslip
    type: object
  InitiateInvoice:
    additionalProperties: false
    properties:
      file:
        description: 'The file containing the data to extract.

          Accepted formats: PDF, PNG, JPG, JPEG.

          Max size: 10 MB.

          Max number of pages for PDF: 3.

          '
        example: Binary file
        format: binary
        type: string
      type:
        description: Type of document you want to analyze. Will be used to match the
          detected document type.
        enum:
        - invoice
        example: invoice
        type: string
      country_code:
        description: The country code of the invoice.
        enum:
        - FR
        example: FR
        type: string
      workspace_id:
        description: 'Scopes the Document Analysis to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
    required:
    - country_code
    - file
    - type
    title: Initiate Invoice Document
    type: object
  InitiateFraudOnly:
    additionalProperties: false
    description: 'Fraud-only Document Analysis (no data extraction).

      Send `analysis_type[extraction]=false` and `analysis_type[fraud_level]=advanced`,
      with no `type`.

      '
    properties:
      file:
        description: 'The file to run fraud detection on.

          Accepted formats: PDF, PNG, JPG, JPEG.

          Max size: 10 MB.

          Max number of pages for PDF: 2.

          '
        example: Binary file
        format: binary
        type: string
      analysis_type:
        $ref: '#/components/schemas/InitiateFraudOnly_analysis_type'
      workspace_id:
        description: 'Scopes the Document Analysis to a specific workspace.

          Defaults to the default workspace if not specified.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
    required:
    - analysis_type
    - file
    title: Initiate Fraud Only
    type: object
  DocumentAnalysisMeta_1:
    properties:
      id:
        $ref: '#/components/schemas/UUID'
      workspace_id:
        description: The Workspace ID in which the Document Analysis has been created.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
      created_at:
        description: Creation date of the Document Analysis.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      updated_at:
        description: Update date of the Document Analysis.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      status:
        $ref: '#/components/schemas/DocumentAnalysisStatus'
      status_codes:
        description: 'List of status codes. Indicates the cause when the status is
          `failed`.


          `DA_1001` is **deprecated**: it is still emitted alongside more specific
          check-failure codes (e.g. `DA_2001`, `DA_2002`) for backward compatibility.
          New integrations should rely on the specific codes.

          '
        example: []
        items:
          enum:
          - DA_1001
          - DA_1002
          - DA_1003
          - DA_1004
          - DA_1100
          - DA_1201
          - DA_1202
          - DA_1301
          - DA_1302
          - DA_1303
          - DA_1304
          - DA_1401
          - DA_1402
          - DA_1403
          - DA_2001
          - DA_2002
          - DA_2301
          - DA_2302
          - DA_2401
          - DA_2402
          - DA_3001
          - DA_3003
          - DA_3004
          type: string
        type: array
      country_code:
        description: 'The country code associated with the document analysis.

          Null for document types that don''t require a country code.

          '
        nullable: true
        type: string
        example: null
      applicant_id:
        $ref: '#/components/schemas/WorkflowSessionApplicantId'
      data_anonymized:
        description: 'Indicates if the personal data extracted from the document has
          been anonymized.

          If set to `true`, the personal data has been anonymized and most fields
          will be NULL.

          '
        example: false
        type: boolean
      analysis_type:
        $ref: '#/components/schemas/AnalysisType'
      fraud_risk_analysis:
        $ref: '#/components/schemas/FraudRiskAnalysis'
    required:
    - applicant_id
    - country_code
    - created_at
    - data_anonymized
    - id
    - previous_attempt_id
    - status
    - status_codes
    - updated_at
    - workflow_session_id
    - workspace_id
    title: DocumentAnalysisMeta
    type: object
  SocialSecurityExtraction:
    additionalProperties: false
    description: Extracted data from the document.
    example:
      social_security_number: '1234567890123'
      first_name: John
      last_name: Doe
      full_name: John Doe
      document_type: carte vitale
    properties:
      social_security_number:
        description: Social Security number extracted from the document.
        nullable: true
        type: string
      first_name:
        description: First name of the individual.
        nullable: true
        type: string
      last_name:
        description: Last name of the individual.
        nullable: true
        type: string
      full_name:
        description: Full name of the individual.
        nullable: true
        type: string
      document_type:
        description: Classification label extracted from the document.
        nullable: true
        type: string
    required:
    - document_type
    - first_name
    - full_name
    - last_name
    - social_security_number
    title: Social Security Extraction
    type: object
  SocialSecurityCheck:
    additionalProperties: false
    description: Checks performed on the document.
    example:
      full_name:
        extracted: John Doe
        expected: John Doe
        match_level: exact
    nullable: true
    properties:
      full_name:
        $ref: '#/components/schemas/DocumentAnalysisCheck'
    required:
    - full_name
    title: Social Security Checks
    type: object
  CompanyCertificateExtraction:
    additionalProperties: false
    description: Extracted data from the document.
    example:
      verification_number: '1234567890123'
      company_name: Acme
      company_number: '1234567890'
      registered_address: 1 rue de la paix, 75000 Paris
      issuance_date: '2025-01-01'
      legal_representatives:
      - type: natural_person
        first_name: John
        last_name: Doe
        full_name: John Doe
        function: Président
        company_name: null
        company_number: null
      - type: legal_person
        first_name: null
        last_name: null
        full_name: null
        company_name: Acme Studio
        company_number: 0987654321
        function: Dirigeant
      document_type: Kbis
    properties:
      verification_number:
        description: Verification number extracted from the document.
        nullable: true
        type: string
      company_name:
        description: Company name extracted from the document.
        nullable: true
        type: string
      company_number:
        description: Company number extracted from the document.
        nullable: true
        type: string
      registered_address:
        description: Registered address extracted from the document.
        nullable: true
        type: string
      issuance_date:
        description: Issuance date extracted from the document.
        nullable: true
        type: string
      legal_representatives:
        description: List of legal representatives extracted from the document.
        items:
          $ref: '#/components/schemas/CompanyCertificateExtraction_legal_representatives_inner'
        type: array
      document_type:
        description: Classification label extracted from the document.
        nullable: true
        type: string
    required:
    - company_name
    - company_number
    - document_type
    - issuance_date
    - legal_representatives
    - registered_address
    - verification_number
    title: Company Certificate Extraction
    type: object
  CompanyCertificateCheck:
    additionalProperties: false
    description: Checks performed on the document.
    example:
      legal_representatives:
      - full_name:
          extracted: John Doe
          expected: John Doe
          match_level: exact
    nullable: true
    properties:
      legal_representatives:
        items:
          $ref: '#/components/schemas/CompanyCertificateCheck_legal_representatives_inner'
        nullable: true
        type: array
    required:
    - legal_representatives
    title: Company Certificate Checks
    type: object
  BusinessRegistrationCertificateExtraction:
    additionalProperties: false
    description: Extracted data from the document.
    example:
      issuance_date: '2025-01-01'
      company_description:
        active: true
        legal_form: Entreprise individuelle
        company_name: null
        company_number: 123 4567 890
        headquarter_company_number: 123 4567 890 12345
        first_name: John
        last_name: Doe
        full_name: John Doe
      branch_description:
        active: true
        branch_company_number: 123 4567 890 12345
        address: 1 rue de la paix, 75000 Paris
        city: Paris
        postal_code: '75000'
      document_type: Avis de situation
    properties:
      issuance_date:
        description: Issuance date extracted from the document.
        nullable: true
        type: string
      company_description:
        $ref: '#/components/schemas/BusinessRegistrationCertificateExtraction_company_description'
      branch_description:
        $ref: '#/components/schemas/BusinessRegistrationCertificateExtraction_branch_description'
      document_type:
        description: Classification label extracted from the document.
        nullable: true
        type: string
    required:
    - branch_description
    - company_description
    - document_type
    - issuance_date
    title: Business Registration Certificate Extraction
    type: object
  BusinessRegistrationCertificateCheck:
    additionalProperties: false
    description: Checks performed on the document.
    example:
      full_name:
        extracted: John Doe
        expected: John Doe
        match_level: exact
    nullable: true
    properties:
      full_name:
        $ref: '#/components/schemas/DocumentAnalysisCheck'
    required:
    - full_name
    title: Business Registration Certificate Checks
    type: object
  DriverLicenceExtraction:
    additionalProperties: false
    example:
      first_name: John
      last_name: Doe
      full_name: John Doe
      born_on: '1990-01-15'
      expired_on: '2030-12-31'
      license_type:
      - B
      - A1
      document_type: permis de conduire français
    properties:
      first_name:
        description: First name of the individual.
        nullable: true
        type: string
      last_name:
        description: Last name of the individual.
        nullable: true
        type: string
      full_name:
        description: Full name of the individual.
        nullable: true
        type: string
      born_on:
        description: Date of birth of the individual.
        format: date
        nullable: true
        type: string
      expired_on:
        description: Expiration date of the driver licence.
        format: date
        nullable: true
        type: string
      license_type:
        description: List of license types.
        items:
          type: string
        nullable: true
        type: array
      document_type:
        description: Classification label extracted from the document.
        nullable: true
        type: string
    required:
    - born_on
    - document_type
    - expired_on
    - first_name
    - full_name
    - last_name
    - license_type
    title: Driver Licence Extraction
    type: object
  DriverLicenceCheck:
    additionalProperties: false
    description: Checks performed on the document.
    example:
      full_name:
        extracted: John Doe
        expected: John Doe
        match_level: exact
    nullable: true
    properties:
      full_name:
        $ref: '#/components/schemas/DocumentAnalysisCheck'
    required:
    - full_name
    title: Driver Licence Checks
    type: object
  RNECertificateExtraction:
    additionalProperties: false
    description: Extracted data from the document.
    example:
      company_name: ACME Corp
      company_number: '123456789'
      registered_address: 1 rue de la paix, 75000 Paris
      issuance_date: '2024-01-15'
      legal_representatives:
      - type: natural_person
        first_name: John
        last_name: Doe
        full_name: John Doe
        function: President
        company_name: null
        company_number: null
      - type: legal_person
        first_name: null
        last_name: null
        full_name: null
        company_name: ACME Studio
        company_number: 0987654321
        function: Statutory Auditor
      document_type: Attestation RNE
    properties:
      company_name:
        description: Company name extracted from the document.
        nullable: true
        type: string
      company_number:
        description: Company number extracted from the document.
        nullable: true
        type: string
      registered_address:
        description: Registered address extracted from the document.
        nullable: true
        type: string
      issuance_date:
        description: Issuance date extracted from the document.
        format: date
        nullable: true
        type: string
      legal_representatives:
        description: List of legal representatives extracted from the document.
        items:
          $ref: '#/components/schemas/CompanyCertificateExtraction_legal_representatives_inner'
        type: array
      document_type:
        description: Classification label extracted from the document.
        nullable: true
        type: string
    required:
    - company_name
    - company_number
    - document_type
    - issuance_date
    - legal_representatives
    - registered_address
    title: RNE Certificate Extraction
    type: object
  RNECertificateCheck:
    additionalProperties: false
    description: Checks performed on the document.
    example:
      legal_representatives:
      - full_name:
          extracted: John Doe
          expected: John Doe
          match_level: exact
    nullable: true
    properties:
      legal_representatives:
        items:
          $ref: '#/components/schemas/CompanyCertificateCheck_legal_representatives_inner'
        nullable: true
        type: array
    required:
    - legal_representatives
    title: RNE Certificate Checks
    type: object
  TemporaryVehicleRegistrationDocumentExtraction:
    additionalProperties: false
    description: Extracted data from the document.
    example:
      vehicle_category: M1
      vehicle_license_number: DH000SJ
      vehicle_identification_number: ZFA19900001244827
      vehicle_purpose: PROPRIO
      vehicle_first_registration_year: '2018'
      vehicle_owner_information:
        vehicle_owner_full_name: DOE JOHN
        vehicle_owner_birth_date: '1985-06-15'
        vehicle_owner_address: VIA ROMA 10, 00100 ROMA RM
      other_details: Veicolo ad uso privato
      issuance_date: '2024-03-15'
      document_reason: PASSAGGIO DI PROPRIETA
      document_recipient_information:
        document_recipient_full_name: DOE JOHN
        document_recipient_address: VIA ROMA 10, 00100 ROMA RM
        document_recipient_birth_date: '1985-06-15'
        document_recipient_birth_city: ROMA
    properties:
      vehicle_category:
        description: Vehicle category extracted from the document.
        nullable: true
        type: string
      vehicle_license_number:
        description: Vehicle license plate number extracted from the document.
        nullable: true
        type: string
      vehicle_identification_number:
        description: Vehicle identification number (VIN) extracted from the document.
        nullable: true
        type: string
      vehicle_purpose:
        description: Vehicle purpose extracted from the document.
        nullable: true
        type: string
      vehicle_first_registration_year:
        description: Year of the vehicle's first registration extracted from the document.
        nullable: true
        type: string
      vehicle_owner_information:
        $ref: '#/components/schemas/TemporaryVehicleRegistrationDocumentExtraction_vehicle_owner_information'
      other_details:
        description: Other details extracted from the document.
        nullable: true
        type: string
      issuance_date:
        description: Issuance date extracted from the document.
        format: date
        nullable: true
        type: string
      document_reason:
        description: Document reason extracted from the document.
        nullable: true
        type: string
      document_recipient_information:
        $ref: '#/components/schemas/TemporaryVehicleRegistrationDocumentExtraction_document_recipient_information'
    required:
    - document_reason
    - document_recipient_information
    - issuance_date
    - other_details
    - vehicle_category
    - vehicle_first_registration_year
    - vehicle_identification_number
    - vehicle_license_number
    - vehicle_owner_information
    - vehicle_purpose
    title: Temporary Vehicle Registration Document Extraction
    type: object
  TemporaryVehicleRegistrationDocumentCheck:
    additionalProperties: false
    description: Checks performed on the document.
    example:
      vehicle_owner:
        owner_name:
          extracted: DOE JOHN
          expected: Doe John
          match_level: exact
    nullable: true
    properties:
      vehicle_owner:
        $ref: '#/components/schemas/TemporaryVehicleRegistrationDocumentCheck_vehicle_owner'
    required:
    - vehicle_owner
    title: Temporary Vehicle Registration Document Checks
    type: object
  FrenchVehicleRegistrationDocumentExtraction:
    additionalProperties: false
    description: Extracted data from a French vehicle registration document.
    properties:
      licence_plate_number:
        description: Licence plate number of the vehicle.
        nullable: true
        type: string
      first_registration_date:
        description: Date of first registration of the vehicle.
        format: date
        nullable: true
        type: string
      owner_information:
        $ref: '#/components/schemas/FrenchVehicleRegistrationDocumentExtraction_owner_information'
      co_owner_information:
        description: List of co-owners of the vehicle.
        items:
          $ref: '#/components/schemas/FrenchVehicleRegistrationDocumentExtraction_co_owner_information_inner'
        type: array
      vehicle_information:
        $ref: '#/components/schemas/FrenchVehicleRegistrationDocumentExtraction_vehicle_information'
      vehicle_identification_number:
        description: Vehicle Identification Number (VIN).
        nullable: true
        type: string
      vehicle_max_weight:
        description: Maximum weight of the vehicle.
        nullable: true
        type: number
      vehicle_motor_information:
        $ref: '#/components/schemas/FrenchVehicleRegistrationDocumentExtraction_vehicle_motor_information'
      document_number:
        description: Document number.
        nullable: true
        type: string
      issuance_date:
        description: Issuance date of the document.
        format: date
        nullable: true
        type: string
      vehicle_next_inspection_date:
        description: Date of the next vehicle inspection.
        format: date
        nullable: true
        type: string
      mrz_line_1:
        description: First line of the Machine Readable Zone (MRZ).
        nullable: true
        type: string
      mrz_line_2:
        description: Second line of the Machine Readable Zone (MRZ).
        nullable: true
        type: string
      document_type:
        description: Classification label extracted from the document.
        nullable: true
        type: string
    required:
    - co_owner_information
    - document_number
    - document_type
    - first_registration_date
    - issuance_date
    - licence_plate_number
    - mrz_line_1
    - mrz_line_2
    - owner_information
    - vehicle_identification_number
    - vehicle_information
    - vehicle_max_weight
    - vehicle_motor_information
    - vehicle_next_inspection_date
    title: French Vehicle Registration Document Extraction
    type: object
  VehicleRegistrationDocumentCheck:
    additionalProperties: false
    description: Checks performed on the document.
    example:
      vehicle_owner:
        owner_name:
          extracted: John Doe
          expected: John Doe
          match_level: exact
    nullable: true
    properties:
      vehicle_owner:
        $ref: '#/components/schemas/TemporaryVehicleRegistrationDocumentCheck_vehicle_owner'
    required:
    - vehicle_owner
    title: Vehicle Registration Document Checks
    type: object
  ItalianVehicleRegistrationDocumentExtraction:
    additionalProperties: false
    description: Extracted data from an Italian vehicle registration document.
    properties:
      licence_plate_number:
        description: Licence plate number of the vehicle.
        nullable: true
        type: string
      first_registration_date:
        description: Date of first registration of the vehicle.
        format: date
        nullable: true
        type: string
      owner_information:
        $ref: '#/components/schemas/ItalianVehicleRegistrationDocumentExtraction_owner_information'
      co_owner_information:
        description: List of co-owners of the vehicle.
        items:
          $ref: '#/components/schemas/FrenchVehicleRegistrationDocumentExtraction_co_owner_information_inner'
        type: array
      deed_informations:
        description: List of deed informations related to the vehicle.
        items:
          $ref: '#/components/schemas/ItalianVehicleRegistrationDocumentExtraction_deed_informations_inner'
        type: array
      vehicle_information:
        $ref: '#/components/schemas/FrenchVehicleRegistrationDocumentExtraction_vehicle_information'
      vehicle_body:
        description: Body type of the vehicle.
        nullable: true
        type: string
      vehicle_identification_number:
        description: Vehicle Identification Number (VIN).
        nullable: true
        type: string
      vehicle_total_mass:
        description: Total mass of the vehicle.
        nullable: true
        type: number
      vehicle_motor_information:
        $ref: '#/components/schemas/ItalianVehicleRegistrationDocumentExtraction_vehicle_motor_information'
      document_type:
        description: Classification label extracted from the document.
        nullable: true
        type: string
      issuance_date:
        description: Issuance date of the document.
        format: date
        nullable: true
        type: string
      vehicle_approval_number:
        description: Vehicle approval number.
        nullable: true
        type: string
      vehicle_destination_and_use:
        description: Destination and use of the vehicle.
        nullable: true
        type: string
      international_vehicle_category:
        description: International vehicle category.
        nullable: true
        type: string
      mass_of_the_vehicle_in_service:
        description: Mass of the vehicle in service.
        nullable: true
        type: number
      vehicle_maximum_technical_mass:
        description: Maximum technical mass of the vehicle.
        nullable: true
        type: number
      vehicle_maximum_permissible_mass:
        description: Maximum permissible mass of the vehicle.
        nullable: true
        type: number
    required:
    - co_owner_information
    - deed_informations
    - document_type
    - first_registration_date
    - international_vehicle_category
    - issuance_date
    - licence_plate_number
    - mass_of_the_vehicle_in_service
    - owner_information
    - vehicle_approval_number
    - vehicle_body
    - vehicle_destination_and_use
    - vehicle_identification_number
    - vehicle_information
    - vehicle_maximum_permissible_mass
    - vehicle_maximum_technical_mass
    - vehicle_motor_information
    - vehicle_total_mass
    title: Italian Vehicle Registration Document Extraction
    type: object
  AutoInsuranceClaimsHistoryExtraction:
    additionalProperties: false
    description: Extracted data from the document.
    example:
      policy_holder_full_name: John Doe
      policy_holder_address: 1 rue de la Paix, 75001 Paris
      policy_holder_birth_date: '1990-01-01'
      insurance_score: '0.50'
      issuance_date: '2024-01-15'
      effective_start_date: '2023-01-01'
      active_contract: true
      contract_cancellation_date: null
      vehicle_model: Renault Clio
      vehicle_license_plate: AB-123-CD
      drivers_information:
      - driver_full_name: John Doe
        driver_birth_date: '1990-01-01'
        coverage_start_date: '2023-01-01'
        coverage_end_date: null
        driver_license_number: '12345678'
        driver_license_category: B
        driver_license_issuance_date: '2010-06-15'
      incidents_information: []
    properties:
      policy_holder_full_name:
        description: Full name of the policy holder extracted from the document.
        nullable: true
        type: string
      policy_holder_address:
        description: Address of the policy holder extracted from the document.
        nullable: true
        type: string
      policy_holder_birth_date:
        description: Birth date of the policy holder extracted from the document.
        format: date
        nullable: true
        type: string
      insurance_score:
        description: Insurance score (bonus/malus coefficient) extracted from the
          document.
        nullable: true
        type: string
      issuance_date:
        description: Issuance date of the document.
        format: date
        nullable: true
        type: string
      effective_start_date:
        description: Effective start date of the insurance contract.
        format: date
        nullable: true
        type: string
      active_contract:
        description: Whether the insurance contract is currently active.
        nullable: true
        type: boolean
      contract_cancellation_date:
        description: Cancellation date of the insurance contract, if applicable.
        format: date
        nullable: true
        type: string
      vehicle_model:
        description: Model of the insured vehicle extracted from the document.
        nullable: true
        type: string
      vehicle_license_plate:
        description: License plate number of the insured vehicle extracted from the
          document.
        nullable: true
        type: string
      drivers_information:
        description: List of drivers covered by the insurance policy.
        items:
          $ref: '#/components/schemas/AutoInsuranceClaimsHistoryExtraction_drivers_information_inner'
        nullable: true
        type: array
      incidents_information:
        description: List of incidents (claims) recorded in the insurance history.
        items:
          $ref: '#/components/schemas/AutoInsuranceClaimsHistoryExtraction_incidents_information_inner'
        nullable: true
        type: array
    required:
    - active_contract
    - contract_cancellation_date
    - drivers_information
    - effective_start_date
    - incidents_information
    - insurance_score
    - issuance_date
    - policy_holder_address
    - policy_holder_birth_date
    - policy_holder_full_name
    - vehicle_license_plate
    - vehicle_model
    title: Auto Insurance Claims History Extraction
    type: object
  AutoInsuranceClaimsHistoryCheck:
    additionalProperties: false
    description: Checks performed on the document.
    example:
      policy_holder:
        owner_name:
          extracted: Doe John
          expected: Doe John
          match_level: exact
    nullable: true
    properties:
      policy_holder:
        $ref: '#/components/schemas/AutoInsuranceClaimsHistoryCheck_policy_holder'
    required:
    - policy_holder
    title: Auto Insurance Claims History Checks
    type: object
  TaxNoticeExtraction:
    additionalProperties: false
    description: Extracted data from the document.
    properties:
      full_name:
        description: The holder full name extracted from the document.
        example: Doe John
        nullable: true
        type: string
      fiscal_number_1:
        description: The fiscal number of the first declarant extracted from the document.
        example: 0312345678901
        nullable: true
        type: string
      fiscal_number_2:
        description: The fiscal number of the second declarant extracted from the
          document.
        example: 0398765432109
        nullable: true
        type: string
      tax_notice_reference:
        description: The tax notice reference number extracted from the document.
        example: 2412B01234567
        nullable: true
        type: string
      issuance_date:
        description: The tax notice issuance date extracted from the document.
        example: '2025-08-15'
        format: date
        nullable: true
        type: string
      income_year:
        description: Year of incomes (usually the year before document issuance) extracted
          from the document.
        example: 2024
        nullable: true
        type: integer
      reference_income:
        description: The fiscal reference income extracted from the document.
        example: 30000
        nullable: true
        type: integer
      document_type:
        description: The document type extracted from the document.
        enum:
        - Avis d'impôts sur le revenu
        example: Avis d'impôts sur le revenu
        nullable: true
        type: string
      2d_doc:
        $ref: '#/components/schemas/TaxNoticeExtraction_2d_doc'
    required:
    - 2d_doc
    - document_type
    - fiscal_number_1
    - fiscal_number_2
    - full_name
    - income_year
    - issuance_date
    - reference_income
    - tax_notice_reference
    title: Tax Notice Extraction
    type: object
  TaxNoticeCheck:
    additionalProperties: false
    description: Checks performed on the document.
    example:
      full_name:
        extracted: John Doe
        expected: John Doe
        match_level: exact
      income_year:
        extracted: 2024
        expected: 2024
        match_level: exact
    nullable: true
    properties:
      full_name:
        $ref: '#/components/schemas/DocumentAnalysisCheck'
      income_year:
        $ref: '#/components/schemas/TaxNoticeCheck_income_year'
    title: Tax Notice Checks
    type: object
  PayslipExtraction:
    additionalProperties: false
    description: Extracted data from the document.
    properties:
      first_name:
        description: The employee first name extracted from the document.
        example: Marie
        nullable: true
        type: string
      last_name:
        description: The employee last name extracted from the document.
        example: DUPONT
        nullable: true
        type: string
      full_name:
        description: The employee full name extracted from the document.
        example: MARIE DUPONT
        nullable: true
        type: string
      employer_name:
        description: The employer name extracted from the document.
        example: SNCF Réseau
        nullable: true
        type: string
      pay_period_start_date:
        description: The pay period start date extracted from the document.
        example: '2026-03-01'
        format: date
        nullable: true
        type: string
      pay_period_end_date:
        description: The pay period end date extracted from the document.
        example: '2026-03-31'
        format: date
        nullable: true
        type: string
      net_pay:
        description: The net salary extracted from the document.
        example: 2382.4
        nullable: true
        type: number
      gross_pay:
        description: The gross salary extracted from the document.
        example: 3150
        nullable: true
        type: number
      document_type:
        description: The document type extracted from the document.
        example: Payslip
        nullable: true
        type: string
    required:
    - document_type
    - employer_name
    - first_name
    - full_name
    - gross_pay
    - last_name
    - net_pay
    - pay_period_end_date
    - pay_period_start_date
    title: Payslip Extraction
    type: object
  PayslipCheck:
    additionalProperties: false
    description: Checks performed on the document.
    example:
      full_name:
        extracted: MARIE DUPONT
        expected: Marie Dupont
        match_level: exact
    nullable: true
    properties:
      full_name:
        $ref: '#/components/schemas/DocumentAnalysisCheck'
    title: Payslip Checks
    type: object
  FrenchInvoiceExtraction:
    additionalProperties: false
    description: Extracted data from the document.
    properties:
      issuance_date:
        description: The date the invoice was issued, extracted from the document.
        example: '2026-03-15'
        format: date
        nullable: true
        type: string
      invoice_number:
        description: The invoice number extracted from the document.
        example: FA-2026-0042
        nullable: true
        type: string
      invoice_date:
        description: The date of the sale or service, extracted from the document.
        example: '2026-03-15'
        format: date
        nullable: true
        type: string
      seller_name:
        description: The seller (issuer) name extracted from the document.
        example: Acme SAS
        nullable: true
        type: string
      seller_address:
        description: The seller (issuer) postal address extracted from the document.
        example: 12 rue de la République 75001 Paris
        nullable: true
        type: string
      seller_company_number:
        description: The seller SIREN or SIRET number extracted from the document.
        example: '882533086'
        nullable: true
        type: string
      vat_identification_number:
        description: The seller intra-community VAT number extracted from the document.
        example: FR81882533086
        nullable: true
        type: string
      billing_address:
        description: The billing address extracted from the document, when distinct.
        nullable: true
        type: string
        example: null
      shipping_address:
        description: The shipping address extracted from the document, when distinct.
        nullable: true
        type: string
        example: null
      buyer_name:
        description: The buyer (customer) name extracted from the document.
        example: Marie Dupont
        nullable: true
        type: string
      buyer_address:
        description: The buyer (customer) postal address extracted from the document.
        example: 59 avenue Ernest Renan 93100 Montreuil
        nullable: true
        type: string
      total_excluding_taxes:
        description: The total amount excluding taxes extracted from the document.
        example: 1127.5
        nullable: true
        type: number
      total_including_taxes:
        description: The total amount including taxes extracted from the document.
        example: 1353
        nullable: true
        type: number
      document_type:
        description: The document type extracted from the document.
        example: Facture
        nullable: true
        type: string
    required:
    - billing_address
    - buyer_address
    - buyer_name
    - document_type
    - invoice_date
    - invoice_number
    - issuance_date
    - seller_address
    - seller_company_number
    - seller_name
    - shipping_address
    - total_excluding_taxes
    - total_including_taxes
    - vat_identification_number
    title: French Invoice Extraction
    type: object
  InitialsArea:
    properties:
      alignment:
        description: Alignment of the Initials on the document. The `left`, `right`
          and `center` options are aligned on top of the page by default.
        enum:
        - left
        - right
        - center
        - top-left
        - top-right
        - top-center
        - bottom-left
        - bottom-right
        - bottom-center
        type: string
      y:
        description: Offset of the initials from the edge of the page (in pixels).
          The offset is from the top or bottom of the page, depending on what has
          been defined in the `alignment` attribute.
        example: 10
        minimum: 0
        type: integer
    required:
    - alignment
    - y
    title: InitialsArea
    type: object
  DocumentExcludedApprovers:
    description: 'List of Approver IDs who cannot see this Document. When omitted,
      all Approvers can see it (default). Only available when the document_visibility
      feature is enabled on the organization.

      '
    example:
    - 550e8400-e29b-41d4-a716-446655440000
    - 6ba7b810-9dad-11d1-80b4-00c04fd430c8
    items:
      format: uuid
      type: string
    type: array
  DocumentExcludedSigners:
    description: 'List of Signer IDs who cannot see this Document. When omitted, all
      Signers can see it (default). Requires the document_visibility feature to be
      enabled on the organization.

      '
    example:
    - 550e8400-e29b-41d4-a716-446655440000
    - 6ba7b810-9dad-11d1-80b4-00c04fd430c8
    items:
      format: uuid
      type: string
    type: array
  CreateElectronicSealFieldSealPayload:
    properties:
      type:
        enum:
        - seal
        - read_only_text
        example: seal
        type: string
      height:
        example: 200
        maximum: 32767
        minimum: 1
        type: integer
      width:
        example: 250
        maximum: 32767
        minimum: 1
        type: integer
      page:
        example: 1
        maximum: 32767
        minimum: 1
        type: integer
      x:
        example: 0
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 0
        maximum: 32767
        minimum: 0
        type: integer
      reason:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        maxLength: 200
        nullable: true
        type: string
      captions:
        description: Optional captions to display on the seal image. Limited to one
          caption per field.
        items:
          $ref: '#/components/schemas/CreateElectronicSealFieldSealPayload_captions_inner'
        maxItems: 1
        nullable: true
        type: array
    required:
    - height
    - page
    - type
    - width
    - x
    - y
    title: Seal
    type: object
  CreateElectronicSealFieldReadOnlyTextPayload:
    properties:
      type:
        enum:
        - read_only_text
        example: read_only_text
        type: string
      height:
        example: 200
        maximum: 32767
        minimum: 1
        type: integer
      width:
        example: 250
        maximum: 32767
        minimum: 1
        type: integer
      page:
        example: 1
        maximum: 32767
        minimum: 1
        type: integer
      x:
        example: 0
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 0
        maximum: 32767
        minimum: 0
        type: integer
      text:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        format: safe-string
        maxLength: 80
        type: string
    required:
    - height
    - page
    - type
    - width
    - x
    - y
    title: Read Only Text
    type: object
  SignatureRequestStatus:
    enum:
    - draft
    - ongoing
    - done
    - deleted
    - expired
    - canceled
    - approval
    - rejected
    - declined
    - paused
    type: string
  SignatureRequestTimeZone:
    default: Europe/Paris
    description: 'Time zone of the dates and times displayed in emails, the Signature
      Request expiration date, and the PDF Audit Trail. Format: tz database. Default
      is set to Europe/Paris.'
    example: Europe/Paris
    type: string
  AuditTrailLocale:
    enum:
    - de
    - en
    - es
    - fr
    - it
    - pt
    - ro
    example: en
    type: string
  CustomPropertyInList:
    properties:
      id:
        description: Unique identifier of the custom property.
        format: uuid
        type: string
      name:
        description: Display name of the property.
        type: string
      type:
        $ref: '#/components/schemas/CustomPropertyType'
      required:
        description: Whether users must fill this property before sending the SR via
          the application (not enforced via API).
        type: boolean
      multiple_answer_allowed:
        description: For list type only — whether multiple options can be selected.
          Null for text type.
        nullable: true
        type: boolean
      workspace_ids:
        description: List of workspace IDs where this property is applicable. Null
          means org-wide.
        items:
          $ref: '#/components/schemas/UUID'
        nullable: true
        type: array
      default_value:
        description: For text type only — default text pre-filled on new signature
          requests. Null for list type.
        nullable: true
        type: string
      options:
        description: 'For list type only: selectable options.

          Null for text type.

          '
        items:
          $ref: '#/components/schemas/CustomPropertyOption'
        nullable: true
        type: array
    required:
    - id
    - name
    - type
    title: CustomPropertyInList
    type: object
  SignatureRequest_SignerFromInfoInput:
    additionalProperties: false
    description: Create a signer from info
    properties:
      info:
        $ref: '#/components/schemas/SignatureRequest_SignerFromInfoInput_info'
      fields:
        items:
          $ref: '#/components/schemas/FieldsInput'
        type: array
      signature_level:
        default: electronic_signature
        enum:
        - electronic_signature
        - advanced_electronic_signature
        - qualified_electronic_signature
        type: string
      signature_authentication_mode:
        description: Method to authenticate the Signers. Authentication via SMS one-time
          password (otp_sms) is unavailable for phone numbers in China.
        enum:
        - null
        - otp_email
        - otp_sms
        - no_otp
        nullable: true
        type: string
      redirect_urls:
        $ref: '#/components/schemas/SignatureRequest_SignerFromInfoInput_redirect_urls'
      custom_text:
        $ref: '#/components/schemas/SignatureRequest_SignerFromInfoInput_custom_text'
      pre_identity_verification_required:
        description: Defines the way the Signer's Identity Documents will be uploaded
          for Verification. If set to `true`, `signature_level`should be equal to
          `advanced_electronic_signature` and `delivery_mode` set to `none`.
        type: boolean
    required:
    - info
    - signature_level
    title: From Scratch
    type: object
  SignatureRequest_SignerFromUserIdInput:
    additionalProperties: false
    description: Create a signer from a user
    properties:
      user_id:
        description: Create signer from an existing user
        example: 8b6ed2f3-244f-487a-baa1-bbe4f51c8744
        format: uuid
        type: string
      fields:
        items:
          $ref: '#/components/schemas/FieldsInput'
        type: array
      signature_level:
        default: electronic_signature
        enum:
        - electronic_signature
        - advanced_electronic_signature
        - qualified_electronic_signature
        type: string
      signature_authentication_mode:
        description: Method to authenticate the Signers. Authentication via SMS one-time
          password (otp_sms) is unavailable for phone numbers in China.
        enum:
        - null
        - otp_email
        - otp_sms
        - no_otp
        nullable: true
        type: string
      redirect_urls:
        $ref: '#/components/schemas/SignatureRequest_SignerFromInfoInput_redirect_urls'
      custom_text:
        $ref: '#/components/schemas/SignatureRequest_SignerFromInfoInput_custom_text'
      pre_identity_verification_required:
        description: Defines the way the Signer's Identity Documents will be uploaded
          for Verification. If set to `true`, `signature_level`should be equal to
          `advanced_electronic_signature` and `delivery_mode` set to `none`.
        type: boolean
    required:
    - signature_level
    - user_id
    title: From Existing User
    type: object
  SignatureRequest_SignerFromContactIdInput:
    additionalProperties: false
    description: Create signer from a contact
    properties:
      contact_id:
        description: Create signer from an existing contact
        example: ddecfb85-8a45-4254-b940-6171b8df0a90
        format: uuid
        type: string
      fields:
        items:
          $ref: '#/components/schemas/FieldsInput'
        type: array
      signature_level:
        default: electronic_signature
        enum:
        - electronic_signature
        - advanced_electronic_signature
        - qualified_electronic_signature
        type: string
      signature_authentication_mode:
        description: Method to authenticate the Signers. Authentication via SMS one-time
          password (otp_sms) is unavailable for phone numbers in China.
        enum:
        - null
        - otp_email
        - otp_sms
        - no_otp
        nullable: true
        type: string
      redirect_urls:
        $ref: '#/components/schemas/SignatureRequest_SignerFromInfoInput_redirect_urls'
      custom_text:
        $ref: '#/components/schemas/SignatureRequest_SignerFromInfoInput_custom_text'
      pre_identity_verification_required:
        description: Defines the way the Signer's Identity Documents will be uploaded
          for Verification. If set to `true`, `signature_level`should be equal to
          `advanced_electronic_signature` and `delivery_mode` set to `none`.
        type: boolean
    required:
    - contact_id
    - signature_level
    title: From Existing Contact
    type: object
  SignatureRequest_EmailNotification:
    additionalProperties: false
    minProperties: 1
    nullable: true
    properties:
      sender:
        $ref: '#/components/schemas/SignatureRequest_EmailNotification_Sender'
      custom_note:
        deprecated: true
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.
        example: Please sign these documents as soon as possible.
        format: safe-string
        maxLength: 2000
        nullable: true
        type: string
      custom_text:
        $ref: '#/components/schemas/SignatureRequest_EmailNotification_custom_text'
    title: SignatureRequest_EmailNotification
    type: object
  SignatureRequest_PlaceholderSignerSubstituteFromInfoInput:
    additionalProperties: false
    description: Create a placeholder signer substitute from info
    properties:
      label:
        example: Employee
        maxLength: 64
        minLength: 1
        type: string
      info:
        $ref: '#/components/schemas/SignatureRequest_PlaceholderSignerSubstituteFromInfoInput_info'
      signature_level:
        default: electronic_signature
        enum:
        - electronic_signature
        - advanced_electronic_signature
        - qualified_electronic_signature
        type: string
      signature_authentication_mode:
        description: Method to authenticate the Signers. Authentication via SMS one-time
          password (otp_sms) is unavailable for phone numbers in China.
        enum:
        - null
        - otp_email
        - otp_sms
        - no_otp
        nullable: true
        type: string
      redirect_urls:
        $ref: '#/components/schemas/SignatureRequest_PlaceholderSignerSubstituteFromInfoInput_redirect_urls'
      custom_text:
        $ref: '#/components/schemas/SignatureRequest_SignerFromInfoInput_custom_text'
      delivery_mode:
        $ref: '#/components/schemas/SignerDeliveryMode'
    required:
    - info
    - label
    title: From Scratch
    type: object
  SignatureRequest_PlaceholderSignerSubstituteFromUserIdInput:
    additionalProperties: false
    description: Create a placeholder signer substitute from a user
    properties:
      label:
        example: Employee
        maxLength: 64
        minLength: 1
        type: string
      user_id:
        description: Create signer from an existing user
        example: 8b6ed2f3-244f-487a-baa1-bbe4f51c8744
        format: uuid
        type: string
      signature_level:
        default: electronic_signature
        enum:
        - electronic_signature
        - advanced_electronic_signature
        - qualified_electronic_signature
        type: string
      signature_authentication_mode:
        description: Method to authenticate the Signers. Authentication via SMS one-time
          password (otp_sms) is unavailable for phone numbers in China.
        enum:
        - null
        - otp_email
        - otp_sms
        - no_otp
        nullable: true
        type: string
      redirect_urls:
        $ref: '#/components/schemas/SignatureRequest_PlaceholderSignerSubstituteFromInfoInput_redirect_urls'
      custom_text:
        $ref: '#/components/schemas/SignatureRequest_SignerFromInfoInput_custom_text'
      delivery_mode:
        $ref: '#/components/schemas/SignerDeliveryMode'
    required:
    - label
    - user_id
    title: From Existing User
    type: object
  SignatureRequest_PlaceholderSignerSubstituteFromContactIdInput:
    additionalProperties: false
    description: Create a placeholder signer substitute from a contact
    properties:
      label:
        example: Employee
        maxLength: 64
        minLength: 1
        type: string
      contact_id:
        description: Create signer from an existing contact
        example: ddecfb85-8a45-4254-b940-6171b8df0a90
        format: uuid
        type: string
      signature_level:
        default: electronic_signature
        enum:
        - electronic_signature
        - advanced_electronic_signature
        - qualified_electronic_signature
        type: string
      signature_authentication_mode:
        description: Method to authenticate the Signers. Authentication via SMS one-time
          password (otp_sms) is unavailable for phone numbers in China.
        enum:
        - null
        - otp_email
        - otp_sms
        - no_otp
        nullable: true
        type: string
      redirect_urls:
        $ref: '#/components/schemas/SignatureRequest_PlaceholderSignerSubstituteFromInfoInput_redirect_urls'
      custom_text:
        $ref: '#/components/schemas/SignatureRequest_SignerFromInfoInput_custom_text'
      delivery_mode:
        $ref: '#/components/schemas/SignerDeliveryMode'
    required:
    - contact_id
    - label
    title: From Existing Contact
    type: object
  SignatureRequest_PlaceholderReadOnlyTextFieldSubstituteInput:
    additionalProperties: false
    description: Create a placeholder read_only_text field substitute
    properties:
      label:
        example: Employee
        maxLength: 64
        minLength: 1
        type: string
      text:
        example: This is my read_only_text
        maxLength: 5000
        minLength: 1
        type: string
    required:
    - label
    - text
    type: object
  Archiving:
    deprecated: true
    description: Once the signature request completed, archive its documents in a
      secure digital safe
    enum:
    - archive
    - archive_y
    nullable: true
    title: Archiving
    type: string
  CustomPropertyValue:
    properties:
      id:
        description: ID of the Custom Property.
        format: uuid
        type: string
      name:
        description: Name of the Custom Property.
        type: string
      type:
        enum:
        - text
        - list
        type: string
      value:
        description: Text value for text properties.
        nullable: true
        type: string
      value_ids:
        description: Array of option ids for list properties.
        items:
          format: uuid
          type: string
        nullable: true
        type: array
      values:
        description: Array of option values for list properties.
        items:
          type: string
        nullable: true
        type: array
    required:
    - id
    - name
    - type
    title: CustomPropertyValue
    type: object
  EmbeddedSignerWithSignatureLink:
    description: ''
    properties:
      id:
        format: uuid
        minLength: 1
        type: string
      status:
        enum:
        - initiated
        - notified
        - verified
        - processing
        - consent_given
        - signed
        - aborted
        - error
        minLength: 1
        type: string
      signature_link:
        format: uri
        minLength: 1
        nullable: true
        type: string
      signature_link_expiration_date:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        nullable: true
        type: string
    required:
    - id
    - signature_link
    - signature_link_expiration_date
    - status
    type: object
  ApproverToNotify:
    description: ''
    properties:
      id:
        format: uuid
        minLength: 1
        type: string
      status:
        enum:
        - initiated
        - notified
        - approved
        - rejected
        minLength: 1
        type: string
      approval_link:
        format: uri
        minLength: 1
        nullable: true
        type: string
      approval_link_expiration_date:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        nullable: true
        type: string
    required:
    - approval_link
    - approval_link_expiration_date
    - id
    - status
    type: object
  CustomText:
    description: Custom Text
    properties:
      request_subject:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.
        format: safe-string
        maxLength: 512
        minLength: 1
        nullable: true
        type: string
      request_body:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.
        format: safe-string
        maxLength: 2000
        minLength: 1
        nullable: true
        type: string
      reminder_subject:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.
        format: safe-string
        maxLength: 512
        minLength: 1
        nullable: true
        type: string
      reminder_body:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.
        format: safe-string
        maxLength: 2000
        minLength: 1
        nullable: true
        type: string
    required:
    - reminder_body
    - reminder_subject
    - request_body
    - request_subject
    type: object
  ExcludedDocuments:
    description: 'List of Document IDs not visible to this Recipient. When omitted,
      the Recipient can see all Documents. Only available when the document_visibility
      feature is enabled on the organization.

      '
    example:
    - 89120884-d29a-4b1a-ac7b-a9e73a872796
    - 7c0c2d1e-3f4a-5b6c-8d9e-0f1a2b3c4d5e
    items:
      format: uuid
      type: string
    type: array
  SignatureDisplay:
    description: Controls what is shown within the signature field.
    example:
      layout: detailed
      options:
        date_format: dd/MM/yyyy
        time_format: HH:mm
        show_timezone: true
        show_email: false
    oneOf:
    - $ref: '#/components/schemas/SignatureDisplay_oneOf'
    - $ref: '#/components/schemas/SignatureDisplay_oneOf_1'
    title: SignatureDisplay
    type: object
  Font:
    example:
      family: Inconsolata
      color: '#F53D1E'
      size: 12
      variants:
        bold: true
        italic: false
    properties:
      family:
        $ref: '#/components/schemas/FontFamily'
      color:
        pattern: ^#([a-f0-9]{6}|[A-F0-9]{6})$
        type: string
      size:
        maximum: 96
        minimum: 7
        type: integer
      variants:
        $ref: '#/components/schemas/FontVariants'
    required:
    - color
    - family
    - size
    - variants
    title: Font
    type: object
  CreateFieldDateFormat:
    default: dd/MM/yyyy
    description: Format used to display the date (e.g., `dd/MM/yyyy`, `MM/dd/yyyy`)
    enum:
    - dd/MM/yyyy
    - dd-MM-yyyy
    - dd.MM.yyyy
    - yyyy-MM-dd
    - MM/dd/yyyy
    - dd MMMM yyyy
    - MMMM dd, yyyy
    - MMM dd, yyyy
    example: dd/MM/yyyy
    title: date_format
    type: string
  CreateFieldTimeFormat:
    description: Format used to display the time. Can be null to display only the
      date, or a format like `HH:mm` or `hh:mm a`
    enum:
    - null
    - HH:mm
    - hh:mm a
    example: HH:mm
    nullable: true
    title: time_format
    type: string
  CreateFieldOffsetUnit:
    default: days
    description: Unit of time used to offset the signature date. When `null`, the
      field will display the exact signature date.
    enum:
    - days
    - weeks
    - months
    - years
    example: months
    nullable: true
    title: offset_unit
    type: string
  CreateFieldNameFormat:
    default: full_name
    description: Format used to display the signer's name.
    enum:
    - full_name
    - first_name
    - last_name
    example: full_name
    title: name_format
    type: string
  SignatureDisplay_1:
    description: Controls what is shown within the signature field.
    nullable: true
    oneOf:
    - $ref: '#/components/schemas/Minimal_layout'
    - $ref: '#/components/schemas/Detailed_layout'
    title: SignatureDisplay
    type: object
  CreateFieldFont:
    description: If set, **width** and **height** properties become required. Otherwise,
      if not set or null, the default font will be used.
    example:
      family: Inconsolata
      color: '#F53D1E'
      size: 12
      variants:
        bold: true
        italic: false
    nullable: true
    properties:
      family:
        $ref: '#/components/schemas/FontFamily'
      color:
        default: '#000000'
        pattern: ^#([a-f0-9]{6}|[A-F0-9]{6})$
        type: string
      size:
        default: 12
        maximum: 96
        minimum: 7
        type: integer
      variants:
        $ref: '#/components/schemas/FontVariants'
    required:
    - color
    - family
    - size
    - variants
    title: Font
    type: object
  CreateSignatureDateFieldFont:
    description: Font configuration (family, size, color, style variants).
    example:
      family: Inconsolata
      color: '#F53D1E'
      size: 12
      variants:
        bold: true
        italic: false
    nullable: true
    properties:
      family:
        $ref: '#/components/schemas/FontFamily'
      color:
        default: '#000000'
        pattern: ^#([a-f0-9]{6}|[A-F0-9]{6})$
        type: string
      size:
        default: 12
        maximum: 96
        minimum: 7
        type: integer
      variants:
        $ref: '#/components/schemas/FontVariants'
    required:
    - color
    - family
    - size
    - variants
    title: Font
    type: object
  UpdateFieldFont:
    description: If set, **width** and **height** properties become required. Otherwise,
      if not set the font will not be changed, and if set to null the default font
      will be used.
    example:
      family: Inconsolata
      color: '#F53D1E'
      size: 12
      variants:
        bold: true
        italic: false
    nullable: true
    properties:
      family:
        $ref: '#/components/schemas/FontFamily'
      color:
        default: '#000000'
        pattern: ^#([a-f0-9]{6}|[A-F0-9]{6})$
        type: string
      size:
        default: 12
        maximum: 22
        minimum: 8
        type: integer
      variants:
        $ref: '#/components/schemas/FontVariants'
    required:
    - color
    - family
    - size
    - variants
    title: Font
    type: object
  SmsNotification:
    properties:
      otp_message:
        $ref: '#/components/schemas/OtpMessage'
    required:
    - otp_message
    title: SMS Notification
    type: object
  EmailNotification:
    properties:
      disabled:
        description: List of disabled email notifications
        items:
          enum:
          - signer.signature_request_canceled_due_to_an_error.signer_who_has_not_signed
          - signer.signature_request_canceled_due_to_an_error.signer_who_has_already_signed
          - signer.signature_request_canceled_by_sender.signer_who_has_not_signed
          - signer.signature_request_canceled_by_sender.signer_who_has_already_signed
          - signer.signature_request_done.signature_request_contains_one_signer
          - signer.signature_request_done.signature_request_contains_multiple_signers
          - signer.signature_request_with_multiple_signers_signed.signed_by_a_signer
          - signer.signature_request_updated.new_expiration_date
          - signer.signature_request_updated_by_sender.new_signer_details
          - signer.signature_request_signature_requested.first_notification
          - signer.signature_request_signature_requested.reminder_to_sign
          type: string
        title: Disabled email notifications
        type: array
    required:
    - disabled
    title: Email Notification
    type: object
  FieldsInput:
    oneOf:
    - $ref: '#/components/schemas/Signature_2'
    - $ref: '#/components/schemas/Mention_2'
    - $ref: '#/components/schemas/Text_2'
    - $ref: '#/components/schemas/Checkbox_2'
    - $ref: '#/components/schemas/RadioGroup_2'
    type: object
  SignerDeliveryMode:
    description: Override the delivery mode of the Signature Request for this Signer
    enum:
    - email
    - none
    nullable: true
    type: string
  SmsNotification_1:
    nullable: true
    properties:
      otp_message:
        $ref: '#/components/schemas/OTP_Message'
    required:
    - otp_message
    title: SMS Notification
    type: object
  EmailNotification_1:
    nullable: true
    properties:
      disabled:
        items:
          description: If the delivery mode is "email" for the Signer, you can list
            all the emails you don't want them to receive.
          enum:
          - signer.signature_request_canceled_due_to_an_error.signer_who_has_not_signed
          - signer.signature_request_canceled_due_to_an_error.signer_who_has_already_signed
          - signer.signature_request_canceled_by_sender.signer_who_has_not_signed
          - signer.signature_request_canceled_by_sender.signer_who_has_already_signed
          - signer.signature_request_done.signature_request_contains_one_signer
          - signer.signature_request_done.signature_request_contains_multiple_signers
          - signer.signature_request_with_multiple_signers_signed.signed_by_a_signer
          - signer.signature_request_updated.new_expiration_date
          - signer.signature_request_updated_by_sender.new_signer_details
          - signer.signature_request_signature_requested.first_notification
          - signer.signature_request_signature_requested.reminder_to_sign
          type: string
        title: Disabled Email Notification
        type: array
    required:
    - disabled
    title: Email Notification
    type: object
  UserRole:
    enum:
    - owner
    - admin
    - member
    title: User Role
    type: string
  UserStatus:
    enum:
    - invited
    - signed_up
    - verified
    - completed
    minLength: 1
    title: User Status
    type: string
  ManageableRole:
    enum:
    - admin
    - member
    title: Manageable Role
    type: string
  WorkflowSessionApplicantId:
    description: 'Unique identifier of an Applicant.

      '
    example: 0ef334d2-7f36-4643-8a2a-4283b4a3e4a4
    format: uuid
    nullable: true
    title: Applicant
    type: string
  BankAccountStatus:
    description: Status of the Bank Account Verification.
    enum:
    - pending
    - awaiting_data
    - verified
    - failed
    - inconclusive
    example: verified
    type: string
  IBAN:
    description: International Bank Account Number (IBAN)
    example: FR7610278030060001478474080
    maxLength: 34
    minLength: 14
    pattern: ^([A-Z]{2}[ \-]?[0-9]{2})(?=(?:[ \-]?[A-Z0-9]){9,30}$)((?:[ \-]?[A-Z0-9]{3,5}){2,7})([
      \-]?[A-Z0-9]{1,3})?$
    type: string
  BIC:
    description: Business Identifier Codes (BIC)
    example: CMCIFR2A
    maxLength: 11
    minLength: 8
    pattern: ^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$
    type: string
  NullableIBAN:
    description: International Bank Account Number (IBAN)
    example: FR7610278030060001478474080
    maxLength: 34
    minLength: 14
    nullable: true
    pattern: ^([A-Z]{2}[ \-]?[0-9]{2})(?=(?:[ \-]?[A-Z0-9]){9,30}$)((?:[ \-]?[A-Z0-9]{3,5}){2,7})([
      \-]?[A-Z0-9]{1,3})?$
    type: string
  NullableBIC:
    description: Business Identifier Codes (BIC)
    example: CMCIFR2A
    maxLength: 11
    minLength: 8
    nullable: true
    pattern: ^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$
    type: string
  IdentityDocumentStatus:
    description: Status of the Identity Document Verification
    enum:
    - pending
    - awaiting_data
    - verified
    - failed
    - inconclusive
    example: verified
    type: string
  IdentityVideoStatus:
    description: Status of the Identity Video Verification
    enum:
    - pending
    - verified
    - failed
    - inconclusive
    example: verified
    type: string
  IdentityVideoDocument:
    additionalProperties: false
    description: Includes all information that has been extracted from the document,
      as well as the best images of the document.
    nullable: true
    properties:
      full_name:
        description: Full name of the document holder as it appears on the identity
          document
        example: David Vincent
        maxLength: 510
        nullable: true
        type: string
      born_on:
        description: Date of birth on the document
        example: '2024-01-18'
        format: date
        nullable: true
        type: string
      type:
        description: Type of document.
        enum:
        - null
        - driver_license
        - id_card
        - passport
        - residence_permit
        - travel_document
        nullable: true
        type: string
      issuing_country_code:
        example: US
        format: ISO 3166-1 alpha-2
        nullable: true
        pattern: ^[A-Z]{2}$
        type: string
      national_identification_number:
        description: 'Some documents may contain a national identification number.

          For example, Italian ID cards contain the Codice Fiscale on the back of
          the document.

          When this data is available on the document, it will be returned here, otherwise
          it will be NULL.

          Consult our [guide](https://developers.yousign.com/docs/video-based-identity-verification)
          for more details and examples.

          '
        example: MLLSNT82P65Z404U
        nullable: true
        type: string
    required:
    - born_on
    - full_name
    - issuing_country_code
    - national_identification_number
    - type
    title: IdentityVideoDocument
    type: object
  WatchlistStatus:
    description: Status of the Watchlist Verification.
    enum:
    - pending
    - verified
    - failed
    - inconclusive
    example: verified
    type: string
  WebhookWildcardSubscribedEvent:
    deprecated: true
    description: Allows you to subscribe to all events currently existing.
    items:
      enum:
      - '*'
      type: string
    title: All Events
    type: array
  WebhookSubscribedEvents:
    description: List of specific webhook events to subscribe to.
    items:
      enum:
      - document_analysis.done
      - signer.notified
      - signer.declined
      - signer.done
      - signer.link_opened
      - signer.identification_failed
      - signer.identification_succeeded
      - signer.identification_blocked
      - signer.identification_expired
      - signer.identity_saved
      - signer.sender_contacted
      - signer.error
      - signer.notification_delivery_failed
      - signature_request.activated
      - signature_request.declined
      - signature_request.canceled
      - signature_request.done
      - signature_request.expired
      - signature_request.reminder_executed
      - signature_request.automatic_reminder_executed
      - signature_request.approved
      - signature_request.deleted
      - signature_request.permanently_deleted
      - signature_request.reactivated
      - signature_request.rejected
      - signature_request.paused
      - signature_request.resumed
      - contact.created
      - approver.notified
      - approver.approved
      - approver.rejected
      - approver.notification_delivery_failed
      - electronic_seal.done
      - electronic_seal.error
      - user.completed
      - verification.identity_video.done
      - verification.bank_account.done
      - verification.bank_account_connection.done
      - verification.bank_account_lookup.done
      - verification.identity_document.done
      - verification.company.done
      - verification.watchlist.done
      - verification.proof_of_address.done
      - workflow_action_group.started
      - workflow_action_group.blocked
      - workflow_action_group.done
      - workflow_session.started
      - workflow_session.blocked
      - workflow_session.done
      - applicant.notified
      - applicant.processed
      - applicant.session_blocked
      type: string
    title: Specific Webhook Events
    type: array
  WebhookWildcardScope:
    description: Wildcard scope to subscribe to all scopes.
    items:
      enum:
      - '*'
      type: string
    title: All Scopes
    type: array
  WebhookScopes:
    description: One or multiple specific scopes to subscribe.
    items:
      enum:
      - app
      - public_api
      - connector_zapier_api
      type: string
    title: Specific Scopes
    type: array
  WebhookWildcardWorkspace:
    description: Allows you to select all Workspaces.
    items:
      enum:
      - '*'
      type: string
    title: All Workspaces
    type: array
  WebhookWorkspaces:
    description: List of Workspace UUIDs.
    items:
      $ref: '#/components/schemas/UUID'
    title: Workspace UUIDs
    type: array
  WorkflowSessionActionResource:
    description: The resource associated with this Action.
    example:
      id: 0ef334d2-7f36-4643-8a2a-4283b4a3e4a4
      created_at: '2025-02-12T23:59:59+00:00'
      type: identity_video_verification
      status: verified
      previous_attempt_id: null
    properties:
      id:
        description: Unique identifier of the Action. Corresponds to the ID of the
          resources associated with this Workflow Session (Signature Request, Identity
          Document Verification, etc.).
        example: 0ef334d2-7f36-4643-8a2a-4283b4a3e4a4
        format: uuid
        type: string
      created_at:
        description: Creation date of the Action Resource.
        example: '2025-02-12T23:59:59Z'
        format: date-time
        type: string
      type:
        description: Type of the Action.
        enum:
        - signature_request
        - identity_document_verification
        - identity_video_verification
        - proof_of_address_verification
        - company_verification
        - watchlist_verification
        - bank_account_verification
        - bank_account_connection_verification
        - bank_account_lookup_verification
        - social_security_document_analysis
        - company_certificate_document_analysis
        - business_registration_certificate_document_analysis
        - driver_licence_document_analysis
        - rne_certificate_document_analysis
        - temporary_vehicle_registration_document_analysis
        - vehicle_registration_document_analysis
        - auto_insurance_claims_history_document_analysis
        - payslip_document_analysis
        - invoice_document_analysis
        example: identity_document_verification
        type: string
      status:
        description: Status of the Action. Corresponds to the status of the resources
          associated with this Workflow Session (Signature Request, Identity Document
          Verification, etc.).
        example: verified
        type: string
      previous_attempt_id:
        description: ID of the previous attempt if this Action is a retry.
        example: 0ef334d2-7f36-4643-8a2a-4283b4a3e4a4
        format: uuid
        nullable: true
        type: string
    required:
    - created_at
    - id
    - previous_attempt_id
    - status
    - type
    title: Workflow Session Action Resource
    type: object
  CreateWorkflowSessionApplicantNaturalPerson:
    additionalProperties: false
    description: Contains information that describe the applicant. This data is used
      for cross-validation with the data Yousign extracts from the applicant documents
      and verifications.
    properties:
      label:
        description: Label of the Applicant.
        example: John Doe
        maxLength: 255
        minLength: 1
        type: string
      reference_id:
        description: Unique applicant identifier as registered on your side.
        example: REF-12345
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      type:
        description: Type of the Applicant.
        enum:
        - natural_person
        type: string
      natural_person:
        $ref: '#/components/schemas/CreateNaturalPerson'
    required:
    - label
    - type
    title: Create Natural Person Applicant
    type: object
  CreateWorkflowSessionApplicantLegalPerson:
    additionalProperties: false
    description: Create a legal person Applicant.
    properties:
      label:
        description: Label of the Applicant.
        example: Acme Corp
        maxLength: 255
        minLength: 1
        type: string
      reference_id:
        description: Unique applicant identifier as registered on your side.
        example: REF-12345
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      type:
        description: Type of the Applicant.
        enum:
        - legal_person
        type: string
      legal_person:
        $ref: '#/components/schemas/CreateLegalPerson'
    required:
    - label
    - type
    title: Create Legal Person Applicant
    type: object
  NaturalPerson:
    additionalProperties: false
    description: Contains information that describe the applicant. This data is used
      for cross-validation with the data Yousign extracts from the applicant documents
      and verifications.
    properties:
      identity:
        allOf:
        - $ref: '#/components/schemas/Identity'
        description: Identity of the natural person.
        nullable: true
        type: object
      address:
        allOf:
        - $ref: '#/components/schemas/Address'
        description: Postal address of the natural person.
        nullable: true
        type: object
      bank_account:
        allOf:
        - $ref: '#/components/schemas/BankAccount'
        description: Bank account of the natural person.
        nullable: true
        type: object
    required:
    - address
    - bank_account
    - identity
    type: object
  LegalPerson:
    additionalProperties: false
    description: Contains information that describe the applicant. This data is used
      for cross-validation with the data Yousign extracts from the applicant documents
      and verifications.
    properties:
      company_name:
        description: Name of the company.
        example: Acme
        nullable: true
        type: string
      country_code:
        description: Country code of the company (ISO 3166-1 alpha-2).
        example: FR
        nullable: true
        type: string
      bank_account:
        allOf:
        - $ref: '#/components/schemas/BankAccount'
        description: Bank account of the legal person.
        nullable: true
        type: object
      legal_representatives:
        description: Legal representatives of the company.
        items:
          $ref: '#/components/schemas/Identity'
        type: array
    required:
    - bank_account
    - company_name
    - country_code
    - legal_representatives
    type: object
  UpdateNaturalPerson:
    additionalProperties: false
    description: Contains information that describe the applicant. This data is used
      for cross-validation with the data Yousign extracts from the applicant documents
      and verifications.
    properties:
      identity:
        $ref: '#/components/schemas/Identity'
      address:
        $ref: '#/components/schemas/Address'
      bank_account:
        $ref: '#/components/schemas/BankAccount'
    title: Natural Person
    type: object
  UpdateLegalPerson:
    additionalProperties: false
    description: Contains information that describe the applicant. This data is used
      for cross-validation with the data Yousign extracts from the applicant documents
      and verifications.
    properties:
      company_name:
        description: Name of the company.
        example: Acme
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      country_code:
        description: Country code of the company (ISO 3166-1 alpha-2).
        enum:
        - FR
        - null
        example: FR
        nullable: true
        type: string
      bank_account:
        $ref: '#/components/schemas/BankAccount'
      legal_representatives:
        description: Legal representatives of the company.
        items:
          $ref: '#/components/schemas/Identity'
        type: array
    title: Legal Person
    type: object
  AnalysisTypeMultipart:
    additionalProperties: false
    description: 'Same as `analysis_type` on the JSON path, but sent as `multipart/form-data`.

      Because form-data has no native boolean, `extraction` is a string (`"true"`/`"false"`).


      - When `extraction` is `"true"` (default), data is extracted from the document
      and a document `type` is **required**.

      - When `extraction` is `"false"` (fraud-only), no `type` must be provided and
      `fraud_level` must be `advanced`.

      '
    properties:
      extraction:
        default: 'true'
        description: 'Whether to extract data from the document. Defaults to `"true"`
          when omitted.

          Set to `"false"` to run a fraud-only analysis (no data extraction).

          '
        enum:
        - 'true'
        - 'false'
        example: 'true'
        type: string
      fraud_level:
        description: 'Level of fraud detection to run. `null` (default) disables fraud
          detection.

          Not supported for type `tax_notice`. Must be `advanced` when `extraction`
          is `"false"`.

          '
        enum:
        - none
        - advanced
        example: advanced
        nullable: true
        type: string
    title: AnalysisType
    type: object
  DocumentAnalysisCheck:
    additionalProperties: false
    description: Represents the result of checking if an extracted value matches an
      expected value with different levels of match (exact, close, or no match).
    example:
      extracted: John Doe
      expected: John Doe
      match_level: exact
    properties:
      extracted:
        description: The extracted value from the document.
        nullable: true
        type: string
      expected:
        description: The expected value for the check.
        type: string
      match_level:
        $ref: '#/components/schemas/DocumentAnalysisMatchLevel'
    required:
    - expected
    - extracted
    - match_level
    title: Document Analysis Check
    type: object
  DocumentAnalysisMatchLevel:
    description: Level of match between extracted and expected value.
    enum:
    - exact
    - close
    - no_match
    example: exact
    title: MatchLevel
    type: string
  SignatureRequest_EmailNotification_Sender:
    properties:
      type:
        enum:
        - organization
        - workspace
        - custom
        - user
        type: string
      custom_name:
        description: 'To use in association with sender type custom to precise the
          name.\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).

          '
        format: safe-string
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
    title: SignatureRequest_Sender
    type: object
  FontFamily:
    enum:
    - Inconsolata
    - Open Sans
    - Lato
    - Raleway
    - Merriweather
    - EB Garamond
    - Comic Neue
    - Monaco
    - Helvetica
    - Courier
    - Times Roman
    title: FontFamily
    type: string
  FontVariants:
    properties:
      italic:
        default: false
        type: boolean
      bold:
        default: false
        type: boolean
    required:
    - bold
    - italic
    title: FontVariants
    type: object
  OtpMessage:
    properties:
      custom_text:
        description: Custom text contained is the one-time password SMS sent to the
          Signer. This feature is available from SCALE plan, and disabled by default.
          Please contact [customer support](https://yousign.app/auth/workspace/help)
          to request an activation.
        minLength: 1
        nullable: true
        type: string
    required:
    - custom_text
    title: OTP Message
    type: object
  CreateNaturalPerson:
    additionalProperties: false
    description: Contains information that describe the applicant. This data is used
      for cross-validation with the data Yousign extracts from the applicant documents
      and verifications.
    properties:
      identity:
        $ref: '#/components/schemas/Identity'
      address:
        $ref: '#/components/schemas/Address'
      bank_account:
        $ref: '#/components/schemas/BankAccount'
    title: Natural Person
    type: object
  CreateLegalPerson:
    additionalProperties: false
    description: Contains information that describe the applicant. This data is used
      for cross-validation with the data Yousign extracts from the applicant documents
      and verifications.
    properties:
      company_name:
        description: Name of the company.
        example: Acme
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      country_code:
        description: Country code of the company (ISO 3166-1 alpha-2).
        enum:
        - FR
        example: FR
        nullable: true
        type: string
      bank_account:
        $ref: '#/components/schemas/BankAccount'
      legal_representatives:
        description: Legal representatives of the company.
        items:
          $ref: '#/components/schemas/Identity'
        type: array
    title: Legal Person
    type: object
  Identity:
    additionalProperties: false
    description: Describes the Applicant.
    properties:
      first_name:
        description: First name of the person.
        example: John
        maxLength: 255
        minLength: 1
        type: string
      last_name:
        description: Last name of the person.
        example: Doe
        maxLength: 255
        minLength: 1
        type: string
    required:
    - first_name
    - last_name
    title: Identity
    type: object
  Address:
    additionalProperties: false
    description: Provide the Applicants full address.
    properties:
      line1:
        description: The first line of the address, typically the street name and
          number.
        example: 1 rue de la Paix
        maxLength: 500
        minLength: 1
        type: string
      line2:
        description: If needed, the second line of the address, typically an apartment
          or suite number.
        maxLength: 500
        minLength: 1
        nullable: true
        type: string
        example: null
      postal_code:
        description: The postal code of the address.
        example: '75002'
        maxLength: 10
        minLength: 1
        type: string
      city:
        description: The city of the address.
        example: Paris
        maxLength: 200
        minLength: 1
        type: string
    required:
    - city
    - line1
    - postal_code
    title: Address
    type: object
  BankAccount:
    additionalProperties: false
    description: Bank account details.
    properties:
      iban:
        description: International Bank Account Number.
        example: FR7630001007941234567890185
        minLength: 1
        type: string
      bic:
        description: Business Identifier Code.
        example: BDFEFR2L
        nullable: true
        type: string
    required:
    - iban
    title: Bank Account
    type: object
  BadRequestResponse:
    properties:
      type:
        type: string
      detail:
        type: string
    required:
    - detail
    - type
    title: BadRequestResponse
    type: object
  UnauthorizedResponse:
    properties:
      type:
        type: string
      detail:
        type: string
    required:
    - detail
    - type
    title: UnauthorizedResponse
    type: object
  ForbiddenResponse:
    properties:
      type:
        type: string
      detail:
        type: string
    required:
    - detail
    - type
    title: ForbiddenResponse
    type: object
  NotFoundResponse:
    properties:
      type:
        type: string
      detail:
        type: string
    required:
    - detail
    - type
    title: NotFoundResponse
    type: object
  MethodNotAllowed:
    properties:
      message:
        type: string
    required:
    - message
    title: MethodNotAllowed
    type: object
  UnsupportedMediaTypeResponse:
    properties:
      type:
        type: string
      detail:
        type: string
    required:
    - detail
    - type
    title: UnsupportedMediaTypeResponse
    type: object
  TooManyRequestsResponse:
    properties:
      message:
        type: string
    required:
    - message
    title: TooManyRequestsResponse
    type: object
  InternalServerError:
    properties:
      type:
        example: about:blank
        type: string
      detail:
        example: Something wrong occurred.
        type: string
    required:
    - detail
    - type
    title: InternalServerError
    type: object
  get_consumption_addon_200_response:
    properties:
      data:
        items:
          $ref: '#/components/schemas/AddonConsumption'
        type: array
    required:
    - data
    type: object
  get_consumption_detail_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/PaginationWithUpdatedAt'
      data:
        items:
          $ref: '#/components/schemas/DetailedConsumption'
        type: array
    type: object
  get_consumptions_records_electronic_seals_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/ElectronicSealsConsumption'
        type: array
    required:
    - data
    - meta
    type: object
  get_consumptions_records_identifications_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/IdentificationsConsumption'
        type: array
    required:
    - data
    - meta
    type: object
  get_consumptions_records_invited_signers_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/InvitedSignersConsumption'
        type: array
    required:
    - data
    - meta
    type: object
  get_contacts_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/Contact'
        type: array
    type: object
  get_custom_experiences_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/CustomExperience'
        type: array
    type: object
  patch_custom_experience_logo_request:
    description: Upload a file
    properties:
      file:
        example: Binary file
        format: binary
        type: string
    required:
    - file
    type: object
  get_document_analyses_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/DocumentAnalysisMeta'
        type: array
    type: object
  post_document_analyses_201_response:
    oneOf:
    - $ref: '#/components/schemas/SocialSecurityFull'
    - $ref: '#/components/schemas/CompanyCertificateFull'
    - $ref: '#/components/schemas/BusinessRegistrationCertificateFull'
    - $ref: '#/components/schemas/DriverLicenceFull'
    - $ref: '#/components/schemas/RNECertificateFull'
    - $ref: '#/components/schemas/TemporaryVehicleRegistrationDocumentFull'
    - $ref: '#/components/schemas/VehicleRegistrationDocumentFull'
    - $ref: '#/components/schemas/AutoInsuranceClaimsHistoryFull'
    - $ref: '#/components/schemas/TaxNoticeFull'
    - $ref: '#/components/schemas/PayslipFull'
    - $ref: '#/components/schemas/InvoiceFull'
    - $ref: '#/components/schemas/FraudOnlyFull'
  list_electronic_seal_images_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/ElectronicSealImage'
        type: array
    type: object
  get_labels_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/Label'
        type: array
    type: object
  get_signature_requests_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/SignatureRequestInList'
        type: array
    type: object
  post_signature_requests_signatureRequestId_cancel_request:
    properties:
      reason:
        enum:
        - contractualization_aborted
        - errors_in_document
        - other
        type: string
      custom_note:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).
        format: safe-string
        maxLength: 500
        nullable: true
        type: string
    required:
    - reason
    type: object
  get_signature_requests_signatureRequestId_signer_consent_requests_200_response:
    properties:
      data:
        items:
          $ref: '#/components/schemas/SignerConsentRequest'
        type: array
    type: object
  get_signature_requests_signatureRequestId_signer_document_requests_200_response:
    properties:
      data:
        items:
          $ref: '#/components/schemas/SignerDocumentRequest'
        type: array
    type: object
  get_signature_requests_signatureRequestId_documents_documentId_fields_200_response_data_inner:
    oneOf:
    - $ref: '#/components/schemas/FieldSignature'
    - $ref: '#/components/schemas/FieldText'
    - $ref: '#/components/schemas/FieldMention'
    - $ref: '#/components/schemas/FieldCheckbox'
    - $ref: '#/components/schemas/FieldRadioButtonGroup'
    - $ref: '#/components/schemas/FieldReadOnlyText'
    - $ref: '#/components/schemas/FieldSignatureDate'
    - $ref: '#/components/schemas/FieldSignerName'
    - $ref: '#/components/schemas/FieldSignerEmail'
  get_signature_requests_signatureRequestId_documents_documentId_fields_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/get_signature_requests_signatureRequestId_documents_documentId_fields_200_response_data_inner'
        type: array
    type: object
  post_signature_requests_signatureRequestId_documents_documentId_replace_request:
    properties:
      file:
        description: 'Accepted formats: PDF, DOCX, JPEG, JPG and PNG. All files are
          converted to PDF upon upload.

          If the Document nature is signable_document, only PDF or DOCX file formats
          are allowed.

          '
        format: binary
        type: string
      name:
        description: The document name. If not set, will use the uploaded document
          name. This value should contain any characters except "\", "/" and can\'t
          start and finish with a space.
        example: file1
        maxLength: 128
        minLength: 1
        pattern: ^(?!\s)[^\/\\]+(?<!\s)$
        type: string
    required:
    - file
    type: object
  get_signature_requests_signatureRequestId_followers_200_response:
    description: A list of Followers added to the Signature Request.
    properties:
      data:
        items:
          $ref: '#/components/schemas/Follower'
        type: array
    type: object
  get_signature_requests_id_labels_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/SignatureRequestLabel'
        type: array
    type: object
  post_signature_requests_signatureRequestId_reactivate_request:
    properties:
      expiration_date:
        description: 'Due date of the Signature Request (yyyy-mm-dd).

          The date cannot be in the past and cannot be more than one year after initiation.

          '
        format: date
        pattern: ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
        type: string
    required:
    - expiration_date
    type: object
  get_signature_requests_signatureRequestId_signers_signerId_documents_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/SignerDocument'
        type: array
    type: object
  get_templates_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/Template'
        type: array
    type: object
  get_users_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/User'
        type: array
    required:
    - data
    - meta
    type: object
  get_invitations_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/UserInvitation'
        type: array
    type: object
  get_verifications_bank_account_lookups_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/BankAccountLookupMeta'
        type: array
    type: object
  post_verifications_bank_account_lookups_request:
    oneOf:
    - $ref: '#/components/schemas/InitiateBankAccountLookupWithNaturalPerson'
    - $ref: '#/components/schemas/InitiateBankAccountLookupFromApplicant'
  get_verifications_bank_accounts_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/BankAccountMeta'
        type: array
    type: object
  post_verifications_bank_accounts_request:
    anyOf:
    - $ref: '#/components/schemas/InitiateBankAccount'
    - $ref: '#/components/schemas/InitiateBankAccountWithLegalPerson'
    - $ref: '#/components/schemas/InitiateBankAccountWithNaturalPerson'
    type: object
  get_verifications_companies_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/CompanyMeta'
        type: array
    type: object
  post_verifications_companies_request:
    oneOf:
    - $ref: '#/components/schemas/InitiateCompanyFromJson'
    - $ref: '#/components/schemas/InitiateCompanyFromApplicant'
  get_verifications_identity_documents_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/IdentityDocumentMeta'
        type: array
    type: object
  post_verifications_identity_documents_request:
    anyOf:
    - $ref: '#/components/schemas/InitiateIdentityDocument'
    - $ref: '#/components/schemas/InitiateIdentityDocumentWithoutName'
    type: object
  get_verifications_identity_videos_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/IdentityVideoMeta'
        type: array
    type: object
  get_verifications_proofs_of_address_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/ProofOfAddressMeta'
        type: array
    type: object
  get_verifications_watchlists_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/WatchlistMeta'
        type: array
    type: object
  get_workflow_sessions_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/WorkflowSession'
        type: array
    type: object
  get_workflow_sessions_id_applicants_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/WorkflowSessionApplicantListItem'
        type: array
    type: object
  get_workflow_templates_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/WorkflowTemplate'
        type: array
    type: object
  get_workspaces_200_response:
    properties:
      meta:
        $ref: '#/components/schemas/Pagination'
      data:
        items:
          $ref: '#/components/schemas/Workspace'
        type: array
    type: object
  Consumption_app_qualified_electronic_signature_identification_mode_identity_verification:
    properties:
      succeeded:
        minimum: 0
        type: integer
      rejected:
        minimum: 0
        type: integer
    required:
    - rejected
    - succeeded
    type: object
  Consumption_app_qualified_electronic_signature_identification_mode:
    properties:
      identity_verification:
        $ref: '#/components/schemas/Consumption_app_qualified_electronic_signature_identification_mode_identity_verification'
      saved_identity:
        minimum: 0
        type: integer
    required:
    - identity_verification
    - saved_identity
    type: object
  Consumption_app:
    properties:
      electronic_signature:
        minimum: 0
        type: integer
      advanced_electronic_signature:
        minimum: 0
        type: integer
      advanced_electronic_signature_with_qualified_certificate:
        minimum: 0
        type: integer
      qualified_electronic_signature_identification_mode:
        $ref: '#/components/schemas/Consumption_app_qualified_electronic_signature_identification_mode'
    required:
    - advanced_electronic_signature
    - advanced_electronic_signature_with_qualified_certificate
    - electronic_signature
    - qualified_electronic_signature_identification_mode
    type: object
  Consumption_api:
    properties:
      electronic_signature:
        minimum: 0
        type: integer
      advanced_electronic_signature:
        minimum: 0
        type: integer
      advanced_electronic_signature_with_qualified_certificate:
        minimum: 0
        type: integer
      electronic_seal:
        minimum: 0
        type: integer
      advanced_electronic_seal:
        minimum: 0
        type: integer
      qualified_electronic_signature_identification_mode:
        $ref: '#/components/schemas/Consumption_app_qualified_electronic_signature_identification_mode'
    required:
    - advanced_electronic_signature
    - advanced_electronic_signature_with_qualified_certificate
    - electronic_signature
    - qualified_electronic_signature_identification_mode
    type: object
  CustomExperience_redirect_urls:
    properties:
      success:
        example: https://example.com/success
        format: uri
        nullable: true
        type: string
      error:
        example: https://example.com/error
        format: uri
        nullable: true
        type: string
      decline:
        example: https://example.com/decline
        format: uri
        nullable: true
        type: string
    required:
    - decline
    - error
    - success
    type: object
  CreateCustomExperience_redirect_urls:
    nullable: true
    properties:
      success:
        example: https://example.com/success
        format: uri
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      error:
        example: https://example.com/error
        format: uri
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      decline:
        example: https://example.com/decline
        format: uri
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
    type: object
  UpdateCustomExperience_redirect_urls:
    nullable: true
    properties:
      success:
        example: https://example.com/success
        format: uri
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      error:
        example: https://example.com/error
        format: uri
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      decline:
        example: https://example.com/decline
        format: uri
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
    required:
    - decline
    - error
    - success
    type: object
  InitiateDocumentAnalysisFromApplicant_checks_income_year_check:
    additionalProperties: false
    description: Expected income year to check against the document.
    properties:
      income_year:
        description: The expected income year to check against the tax notice document.
        example: 2024
        type: integer
    required:
    - income_year
    type: object
  InitiateDocumentAnalysisFromApplicant_checks:
    additionalProperties: false
    description: 'Checks to perform on the document.

      Only accepted when `type` is `tax_notice`.

      '
    nullable: true
    properties:
      income_year_check:
        $ref: '#/components/schemas/InitiateDocumentAnalysisFromApplicant_checks_income_year_check'
    type: object
  French_Vehicle_Registration_Document:
    allOf:
    - $ref: '#/components/schemas/DocumentAnalysisMeta_1'
    - properties:
        type:
          enum:
          - vehicle_registration_document
          type: string
        country_code:
          enum:
          - FR
          type: string
        extracted_from_document:
          $ref: '#/components/schemas/FrenchVehicleRegistrationDocumentExtraction'
        checks:
          $ref: '#/components/schemas/VehicleRegistrationDocumentCheck'
      type: object
    required:
    - checks
    - country_code
    - created_at
    - data_anonymized
    - extracted_from_document
    - id
    - previous_attempt_id
    - status
    - type
    - updated_at
    - workflow_session_id
    - workspace_id
    title: French Vehicle Registration Document
    type: object
  Italian_Vehicle_Registration_Document:
    allOf:
    - $ref: '#/components/schemas/DocumentAnalysisMeta_1'
    - properties:
        type:
          enum:
          - vehicle_registration_document
          type: string
        country_code:
          enum:
          - IT
          type: string
        extracted_from_document:
          $ref: '#/components/schemas/ItalianVehicleRegistrationDocumentExtraction'
        checks:
          $ref: '#/components/schemas/VehicleRegistrationDocumentCheck'
      type: object
    required:
    - checks
    - country_code
    - created_at
    - data_anonymized
    - extracted_from_document
    - id
    - previous_attempt_id
    - status
    - type
    - updated_at
    - workflow_session_id
    - workspace_id
    title: Italian Vehicle Registration Document
    type: object
  InvoiceFull_allOf_checks:
    description: Checks performed on the document. Always null for invoices.
    nullable: true
    type: object
  FraudOnlyFull_allOf_analysis_type:
    properties:
      extraction:
        description: Always `false` for a fraud-only analysis.
        example: false
        type: boolean
      fraud_level:
        description: Always `advanced` for a fraud-only analysis.
        enum:
        - advanced
        example: advanced
        type: string
    required:
    - extraction
    - fraud_level
    type: object
  Document_initials_per_page_inner:
    properties:
      page:
        description: Page number.
        minimum: 1
        type: integer
      y:
        description: Y-axis position of the initials on the page.
        minimum: 0
        type: integer
    required:
    - page
    - y
    type: object
  Document_initials:
    nullable: true
    properties:
      alignment:
        description: Alignment of the initials on the document’s pages.
        enum:
        - left
        - center
        - right
        type: string
      y:
        description: Y-axis position of the initials on the first page of the document.
        minimum: 0
        type: integer
      per_page:
        items:
          $ref: '#/components/schemas/Document_initials_per_page_inner'
        type: array
    required:
    - alignment
    - per_page
    - y
    type: object
  From_Electronic_Seal_Document:
    description: Create an Electronic Seal Document from a previously sealed document.
    properties:
      electronic_seal_document_id:
        description: Id of the Electronic Seal Document. The Electronic Seal must
          be done to use its Electronic Seal Document.
        example: 672a5a0b-ac65-407e-9da9-d34402bae974
        format: uuid
        type: string
    required:
    - electronic_seal_document_id
    title: From Electronic Seal Document
    type: object
  From_Signature_Request_Document:
    description: Create an Electronic Seal Document from a Signature Request Document
      already signed.
    properties:
      signature_request_document_id:
        description: Id of the Signature Request Document, the Signature Request must
          be Done.
        example: 672a5a0b-ac65-407e-9da9-d34402bae974
        format: uuid
        type: string
    required:
    - signature_request_document_id
    title: From Signature Request Document
    type: object
  CreateElectronicSealImagePreviewPayload_field_captions_inner:
    additionalProperties: false
    properties:
      text:
        description: The caption text to display on the seal image.
        example: Lorem Ipsum is simply dummy text of the printing and typesetting
          industry.
        maxLength: 150
        type: string
    required:
    - text
    type: object
  CreateElectronicSealImagePreviewPayload_field:
    additionalProperties: false
    description: The seal field dimensions and optional caption.
    properties:
      width:
        description: Width of the seal field in pixels.
        example: 150
        maximum: 32767
        minimum: 1
        type: integer
      height:
        description: Height of the seal field in pixels.
        example: 100
        maximum: 32767
        minimum: 1
        type: integer
      captions:
        description: Optional captions to display on the seal image. Limited to one
          caption per field.
        items:
          $ref: '#/components/schemas/CreateElectronicSealImagePreviewPayload_field_captions_inner'
        maxItems: 1
        nullable: true
        type: array
    required:
    - height
    - width
    type: object
  CreateElectronicSealPayload_fields_inner:
    anyOf:
    - $ref: '#/components/schemas/CreateElectronicSealFieldSealPayload'
    - $ref: '#/components/schemas/CreateElectronicSealFieldReadOnlyTextPayload'
    type: object
  SignatureRequestInList_reminder_settings:
    nullable: true
    properties:
      interval_in_days:
        enum:
        - 1
        - 2
        - 7
        - 14
        format: int32
        type: integer
      max_occurrences:
        format: int32
        maximum: 10
        minimum: 1
        type: integer
    required:
    - interval_in_days
    - max_occurrences
    type: object
  SignatureRequestInList_signers_inner:
    properties:
      id:
        type: string
      status:
        enum:
        - initiated
        - declined
        - notified
        - verified
        - processing
        - consent_given
        - signed
        - aborted
        - error
        type: string
    required:
    - id
    - status
    type: object
  SignatureRequestInList_approvers_inner:
    properties:
      id:
        type: string
      status:
        enum:
        - initiated
        - notified
        - approved
        - rejected
        type: string
    required:
    - id
    - status
    type: object
  SignatureRequestInList_documents_inner:
    properties:
      id:
        type: string
      nature:
        enum:
        - attachment
        - signable_document
        type: string
    required:
    - id
    - nature
    type: object
  SignatureRequestInList_sender:
    nullable: true
    properties:
      id:
        type: string
      email:
        type: string
    type: object
  New_Signature_Request_From_Scratch_reminder_settings:
    additionalProperties: false
    description: Enable automatic reminders for pending Signers.
    nullable: true
    properties:
      interval_in_days:
        enum:
        - 1
        - 2
        - 7
        - 14
        format: int32
        type: integer
      max_occurrences:
        example: 5
        format: int32
        maximum: 10
        minimum: 1
        type: integer
    required:
    - interval_in_days
    - max_occurrences
    type: object
  New_Signature_Request_From_Scratch_signers_inner:
    anyOf:
    - $ref: '#/components/schemas/SignatureRequest_SignerFromInfoInput'
    - $ref: '#/components/schemas/SignatureRequest_SignerFromUserIdInput'
    - $ref: '#/components/schemas/SignatureRequest_SignerFromContactIdInput'
    description: Create signers
  New_Signature_Request_From_Scratch_template_placeholders_signers_inner:
    anyOf:
    - $ref: '#/components/schemas/SignatureRequest_PlaceholderSignerSubstituteFromInfoInput'
    - $ref: '#/components/schemas/SignatureRequest_PlaceholderSignerSubstituteFromUserIdInput'
    - $ref: '#/components/schemas/SignatureRequest_PlaceholderSignerSubstituteFromContactIdInput'
  New_Signature_Request_From_Scratch_template_placeholders:
    additionalProperties: false
    description: When creating a signature request from a template, all substituting
      data for placeholders defined in the given template.
    nullable: true
    properties:
      signers:
        description: Substituting data for placeholder signers.
        items:
          $ref: '#/components/schemas/New_Signature_Request_From_Scratch_template_placeholders_signers_inner'
        maxItems: 100
        type: array
      read_only_text_fields:
        description: Substituting data for placeholder read_only_text fields.
        items:
          $ref: '#/components/schemas/SignatureRequest_PlaceholderReadOnlyTextFieldSubstituteInput'
        maxItems: 500
        type: array
    type: object
  New_Signature_Request_From_Scratch:
    description: Create a new Signature Request from scratch
    properties:
      name:
        description: 'Name of the signature request.\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).

          '
        format: safe-string
        maxLength: 128
        minLength: 1
        type: string
      delivery_mode:
        description: Delivery mode to notify Signers.
        enum:
        - none
        - email
        type: string
      ordered_signers:
        description: Enable an ordered workflow, each Signer will be requested to
          sign in a sequential order
        example: true
        type: boolean
      ordered_approvers:
        description: 'When enabled, Approvers are requested to approve sequentially.

          Each Approver will be invited to approve only once the previous one has
          completed their approval.

          '
        example: true
        type: boolean
      custom_recipient_order:
        description: 'When enabled, Approvers and Signers are requested to approve
          depending of a sequence composed of stages.

          Every recipients present in a stage will be invited to approve or sign parallelly,
          and stages are sequential each other.

          When `custom_recipient_order` is enabled, `ordered_approvers` and `ordered_signers`
          are ignored.

          '
        example: true
        type: boolean
      reminder_settings:
        $ref: '#/components/schemas/New_Signature_Request_From_Scratch_reminder_settings'
      timezone:
        $ref: '#/components/schemas/SignatureRequestTimeZone'
      email_custom_note:
        deprecated: true
        description: 'A custom note added to emails sent to signers.\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.

          '
        example: Please sign these documents as soon as possible.
        format: safe-string
        maxLength: 500
        nullable: true
        type: string
      expiration_date:
        description: 'Due date of the Signature Request (yyyy-mm-dd). Defaults to
          6 months after initiation.

          The date cannot be in the past and cannot be more than one year after initiation.

          '
        format: date
        pattern: ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
        type: string
      template_id:
        description: Create a Signature Request from an existing template.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      external_id:
        description: Store a custom id that will be added to webhooks & appended to
          redirect urls.
        maxLength: 255
        nullable: true
        pattern: ^[\w\-@.%+]+$
        type: string
      branding_id:
        deprecated: true
        description: Use a specific branding to customize the signature experience.
        example: 3a93d3b5-fb3b-4abf-9e70-26315b33506b
        format: uuid
        nullable: true
        type: string
      custom_experience_id:
        description: Use a specific Custom Experience to customize the signature experience.
        example: 3a93d3b5-fb3b-4abf-9e70-26315b33506b
        format: uuid
        nullable: true
        type: string
      documents:
        deprecated: true
        description: You can directly attach orphan Documents to the Signature Request.
        items:
          example: 89120884-d29a-4b1a-ac7b-a9e73a872795
          format: uuid
          type: string
        maxItems: 5
        type: array
        uniqueItems: true
      signers:
        deprecated: true
        description: Can only be used if you add documents at the same time.
        items:
          $ref: '#/components/schemas/New_Signature_Request_From_Scratch_signers_inner'
        type: array
      workspace_id:
        description: Scope the signature request to a specific workspace. If template_id
          is filled and Template is already linked to a Workspace, keep this field
          to null ; the created Signature Request will be scoped to Template's Workspace.
        example: 89120884-d29a-4b1a-ac7b-a9e73a872795
        format: uuid
        nullable: true
        type: string
      audit_trail_locale:
        allOf:
        - $ref: '#/components/schemas/AuditTrailLocale'
        description: Define the locale for the generated audit trail.
        nullable: true
        type: string
      signers_allowed_to_decline:
        default: false
        description: Allowing signers to decline to sign.
        example: true
        type: boolean
      email_notification:
        $ref: '#/components/schemas/SignatureRequest_EmailNotification'
      template_placeholders:
        $ref: '#/components/schemas/New_Signature_Request_From_Scratch_template_placeholders'
      archiving:
        $ref: '#/components/schemas/Archiving'
      labels:
        description: List of Labels to associate with the Signature Request. Labels
          are identified by their ID.
        example:
        - 3a93d3b5-fb3b-4abf-9e70-26315b33506b
        - 89120884-d29a-4b1a-ac7b-a9e73a872795
        items:
          format: uuid
          type: string
        maxItems: 50
        type: array
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
    required:
    - delivery_mode
    - name
    title: New Signature Request From Scratch
    type: object
  Duplicate_a_Signature_Request:
    description: Duplicate a Signature Request. It will be added to the same workspace
      as the original.
    properties:
      signature_request_id:
        description: ID of the signature request to duplicate.
        example: 6c82bd7a-d7f7-45e0-82f4-b92222567346
        format: uuid
        title: Signature Request ID
        type: string
      name:
        description: The name of the new Signature Request.
        example: My duplicated Signature Request
        maxLength: 128
        minLength: 1
        type: string
      workflow_session_id:
        $ref: '#/components/schemas/WorkflowSessionId'
      previous_attempt_id:
        $ref: '#/components/schemas/PreviousAttemptId'
    required:
    - signature_request_id
    title: Duplicate a Signature Request
    type: object
  SignatureRequest_email_notification_sender:
    properties:
      type:
        enum:
        - organization
        - workspace
        - user
        - custom
        type: string
      custom_name:
        description: To use in association with sender type custom to precise the
          name
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
    required:
    - custom_name
    - type
    type: object
  SignatureRequest_email_notification:
    properties:
      sender:
        $ref: '#/components/schemas/SignatureRequest_email_notification_sender'
      custom_note:
        example: Please sign these documents as soon as possible.
        maxLength: 2000
        nullable: true
        type: string
    required:
    - custom_note
    - sender
    type: object
  SignatureRequest_decline_information:
    nullable: true
    properties:
      signer_id:
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      reason:
        type: string
      declined_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
    type: object
  SignatureRequest_rejection_information:
    description: Information related to the rejection of a Signature Request by an
      Approver.
    nullable: true
    properties:
      approver_id:
        description: Id of the Approver who rejected the Signature Request.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      reason:
        description: Reason provided by the Approver explaining why they rejected
          the Signature Request.
        example: I don't agree with the terms in the document.
        type: string
      rejected_at:
        description: Timestamp indicating when the Approver rejected the Signature
          Request.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
    readOnly: true
    type: object
  UpdateSignatureRequest_reminder_settings:
    nullable: true
    properties:
      interval_in_days:
        enum:
        - 1
        - 2
        - 7
        - 14
        format: int32
        type: integer
      max_occurrences:
        example: 5
        format: int32
        maximum: 10
        minimum: 1
        type: integer
    required:
    - interval_in_days
    - max_occurrences
    type: object
  SignatureRequestActivated_documents_inner:
    properties:
      id:
        type: string
      nature:
        type: string
    required:
    - id
    - nature
    type: object
  New_Approver_From_Scratch_info:
    properties:
      first_name:
        maxLength: 255
        minLength: 1
        type: string
      last_name:
        maxLength: 255
        minLength: 1
        type: string
      email:
        maxLength: 100
        minLength: 1
        type: string
      phone_number:
        description: E.164 format.
        example: '+41446667700'
        minLength: 1
        nullable: true
        type: string
      locale:
        $ref: '#/components/schemas/Locale'
    required:
    - email
    - first_name
    - last_name
    - locale
    type: object
  New_Approver_From_Scratch:
    description: Create a new Approver from scratch.
    properties:
      info:
        $ref: '#/components/schemas/New_Approver_From_Scratch_info'
    required:
    - info
    title: New Approver From Scratch
    type: object
  New_Approver_From_Existing_User:
    description: Create a new Approver from an existing User.
    properties:
      user_id:
        example: 8b6ed2f3-244f-487a-baa1-bbe4f51c8744
        format: uuid
        type: string
    required:
    - user_id
    title: New Approver From Existing User
    type: object
  New_Approver_From_Existing_Contact:
    description: Create a new Approver from an existing Contact.
    properties:
      contact_id:
        example: 8b6ed2f3-244f-487a-baa1-bbe4f51c8744
        format: uuid
        type: string
    required:
    - contact_id
    title: New Approver From Existing Contact
    type: object
  New_Approver_From_Existing_Signer:
    description: Create a new Approver from an existing Signer.
    properties:
      signer_id:
        example: 8b6ed2f3-244f-487a-baa1-bbe4f51c8744
        format: uuid
        type: string
    required:
    - signer_id
    title: New Approver From Existing Signer
    type: object
  Approver_info:
    properties:
      first_name:
        minLength: 1
        type: string
      last_name:
        minLength: 1
        type: string
      email:
        format: email
        minLength: 1
        type: string
      phone_number:
        description: E.164 format.
        minLength: 1
        nullable: true
        type: string
      locale:
        $ref: '#/components/schemas/Locale'
    required:
    - email
    - first_name
    - last_name
    - locale
    - phone_number
    type: object
  UpdateApprover_info:
    nullable: true
    properties:
      first_name:
        maxLength: 255
        minLength: 1
        type: string
      last_name:
        maxLength: 255
        minLength: 1
        type: string
      email:
        format: email
        maxLength: 100
        minLength: 1
        type: string
      phone_number:
        description: E.164 format
        example: '+41446667700'
        minLength: 1
        nullable: true
        type: string
      locale:
        $ref: '#/components/schemas/Locale'
    type: object
  SignerConsentRequest_settings:
    description: Settings relative to Signer Consent Request's type
    properties:
      text:
        description: Text associated to the checkbox or text_to_copy
        example: I agree with...
        maxLength: 1000
        minLength: 1
        type: string
    required:
    - text
    type: object
  CreateSignerConsentRequest_settings:
    description: Settings relative to Signer Consent Request's type
    properties:
      text:
        description: 'Text associated to the checkbox or the text_to_copy.\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing URL.

          '
        example: I agree with...
        format: safe-string
        maxLength: 1000
        minLength: 1
        type: string
    required:
    - text
    type: object
  FieldRadioButtonGroup_radios_inner:
    properties:
      name:
        description: Radio button's name.
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      x:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      y:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      size:
        description: The size determines both the width and height of the radio button.
        format: int32
        maximum: 240
        minimum: 8
        type: integer
      checked:
        description: Signer has checked the radio button.
        type: boolean
    required:
    - checked
    - name
    - size
    - x
    - y
    type: object
  Signature:
    properties:
      signer_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      type:
        enum:
        - signature
        type: string
      page:
        example: 1
        minimum: 1
        type: integer
      x:
        example: 200
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      height:
        description: Default value is 37
        example: 37
        maximum: 1000
        minimum: 37
        type: integer
      width:
        description: Default value is 85
        example: 150
        maximum: 2000
        minimum: 85
        type: integer
      reason:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        description: 'Provide extra context to explain why the Document is being signed.
          Once the Document is signed, the custom reason is stored in the Audit Trail
          and is included in the signature certificate.


          The default value is: "Signed by [Signer first name] [Signer last name]".


          This parameter is only available for users with a `pro` or `scale` plan.

          '
        example: Signed by John Doe
        maxLength: 150
        nullable: true
        type: string
      display:
        $ref: '#/components/schemas/SignatureDisplay_1'
    required:
    - page
    - signer_id
    - type
    - x
    - y
    title: Signature
    type: object
  Mention:
    properties:
      signer_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      type:
        enum:
        - mention
        type: string
      page:
        example: 1
        minimum: 1
        type: integer
      x:
        example: 200
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      width:
        description: If not set, the width is automatically calculated with the mention
          length.
        example: 250
        minimum: 24
        type: integer
      height:
        description: 'The height must be calculated using the formula: "height = number_of_lines
          \* font_size \* line_height", where the line height is always set to 1.5.'
        example: 150
        minimum: 1
        nullable: true
        type: integer
      mention:
        description: 'Content of the Mention.\

          You can use dynamic tags when creating the Mention:\

          • `%date%` will display the current date when the Signer sign the Signature
          Request (eg. "24-03-2025")\

          • `%datetime%` will display the current date and time when the Signer signs
          the Signature Request (eg. "24-03-2025 10:30 UTC+0")\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email.

          '
        example: Signed on %date%
        format: safe-string
        maxLength: 255
        minLength: 1
        type: string
      font:
        $ref: '#/components/schemas/CreateFieldFont'
      name:
        description: Name of the Field.
        example: Mention 1
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
    required:
    - mention
    - page
    - signer_id
    - type
    - x
    - y
    title: Mention
    type: object
  SignatureDate:
    properties:
      signer_id:
        example: b9142070-7039-4c19-ae30-67ac3e72ee7e
        format: uuid
        type: string
      type:
        enum:
        - signature_date
        type: string
      page:
        example: 1
        minimum: 1
        type: integer
      x:
        example: 200
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      font:
        $ref: '#/components/schemas/CreateSignatureDateFieldFont'
      name:
        description: Name of the Field.
        example: Date 1
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      date_format:
        $ref: '#/components/schemas/CreateFieldDateFormat'
      time_format:
        $ref: '#/components/schemas/CreateFieldTimeFormat'
      show_timezone:
        default: false
        description: Boolean indicating whether to display the timezone abbreviation
          (e.g., `CEST`) next to the time.
        nullable: true
        type: boolean
      show_email:
        default: true
        description: Boolean indicating whether to display the signer's email address.
        nullable: false
        type: boolean
      offset_unit:
        $ref: '#/components/schemas/CreateFieldOffsetUnit'
      offset_value:
        default: 0
        description: 'Number of units to add to the signature date. Ignored if `offset_unit`
          is `null`. For example, use `offset_unit`: `"month"` and `offset_value:
          3` to display "signature date + 3 months"'
        example: 30
        minimum: 0
        nullable: true
        type: integer
    required:
    - page
    - signer_id
    - type
    - x
    - y
    title: SignatureDate
    type: object
  Text:
    properties:
      signer_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      type:
        enum:
        - text
        type: string
      page:
        example: 1
        minimum: 1
        type: integer
      x:
        example: 200
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      width:
        description: If not set, the width is automatically calculated with the max_length
          value
        example: 90
        minimum: 24
        type: integer
      height:
        description: 'The height must be calculated using the formula: "height = number_of_lines
          \* font_size \* line_height", where the line height is always set to 1.5.'
        example: 150
        minimum: 1
        type: integer
      max_length:
        example: 120
        maximum: 32767
        minimum: 1
        type: integer
      question:
        description: If you don't want any question, you can give an empty string.
        example: What is your job title?
        maxLength: 255
        type: string
      instruction:
        example: Your position in the company
        nullable: true
        type: string
      optional:
        default: false
        type: boolean
      font:
        $ref: '#/components/schemas/CreateFieldFont'
      name:
        description: Name of the Field.
        example: Job Title
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      default_value:
        description: If a default value is provided, the Field will be pre-filled
          with this value. The Signer can modify it before signing unless the Field
          is set to `read-only`.
        example: Software Engineer
        maxLength: 32767
        minLength: 1
        nullable: true
        type: string
      read_only:
        default: false
        description: If set to `true`, the Signer cannot modify the Field and the
          default value (if provided) will remain unchanged.
        type: boolean
    required:
    - max_length
    - page
    - question
    - signer_id
    - type
    - x
    - y
    title: Text
    type: object
  Checkbox:
    properties:
      signer_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      type:
        enum:
        - checkbox
        type: string
      page:
        example: 1
        minimum: 1
        type: integer
      x:
        example: 200
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      size:
        default: 24
        example: 24
        maximum: 240
        minimum: 8
        type: integer
      optional:
        default: false
        type: boolean
      name:
        example: Checkbox 1
        nullable: true
        type: string
      checked:
        default: false
        type: boolean
      read_only:
        default: false
        description: If set to `true`, the checkbox cannot be modified by the signer.
        type: boolean
    required:
    - page
    - signer_id
    - type
    - x
    - y
    title: Checkbox
    type: object
  RadioGroup_radios_inner:
    properties:
      name:
        description: Radio button's name
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      x:
        example: 200
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      size:
        default: 24
        example: 24
        maximum: 240
        minimum: 8
        type: integer
      default_checked:
        default: false
        description: Indicates whether the radio is initially checked (`true`) or
          unchecked (`false`).
        type: boolean
    required:
    - x
    - y
    type: object
  RadioGroup:
    properties:
      signer_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      type:
        enum:
        - radio_group
        type: string
      page:
        example: 1
        minimum: 1
        type: integer
      optional:
        default: false
        type: boolean
      name:
        description: Radio group's name
        example: radio_group_name_1
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      read_only:
        default: false
        description: If set to `true`, the radio button cannot be modified by the
          Signer.
        type: boolean
      radios:
        items:
          $ref: '#/components/schemas/RadioGroup_radios_inner'
        type: array
    required:
    - page
    - radios
    - signer_id
    - type
    title: RadioGroup
    type: object
  ReadOnlyText:
    properties:
      type:
        enum:
        - read_only_text
        type: string
      page:
        example: 1
        minimum: 1
        type: integer
      x:
        example: 200
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      width:
        description: If not set, the width is automatically calculated with the read
          only text length.
        example: 250
        minimum: 24
        nullable: true
        type: integer
      height:
        description: 'The height must be calculated using the formula: "height = number_of_lines
          \* font_size \* line_height", where the line height is always set to 1.5.'
        example: 150
        minimum: 1
        nullable: true
        type: integer
      text:
        example: Order n°12345
        maxLength: 5000
        type: string
      font:
        $ref: '#/components/schemas/CreateFieldFont'
    required:
    - page
    - text
    - type
    - x
    - y
    title: ReadOnlyText
    type: object
  SignerName:
    properties:
      signer_id:
        example: b0745f33-23d1-41c0-832e-27b968207cb9
        format: uuid
        type: string
      type:
        enum:
        - signer_name
        type: string
      page:
        example: 1
        minimum: 1
        type: integer
      x:
        example: 200
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      font:
        $ref: '#/components/schemas/CreateFieldFont'
      name:
        description: Name of the Field.
        example: Name 1
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      name_format:
        $ref: '#/components/schemas/CreateFieldNameFormat'
    required:
    - page
    - signer_id
    - type
    - x
    - y
    title: SignerName
    type: object
  SignerEmail:
    properties:
      signer_id:
        example: f5939433-43f0-423d-87d5-9ee80042fb0d
        format: uuid
        type: string
      type:
        enum:
        - signer_email
        type: string
      page:
        example: 1
        minimum: 1
        type: integer
      x:
        example: 200
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      font:
        $ref: '#/components/schemas/CreateFieldFont'
      name:
        description: Name of the Field.
        example: Email 1
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
    required:
    - page
    - signer_id
    - type
    - x
    - y
    title: SignerEmail
    type: object
  Signature_1:
    properties:
      signer_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      page:
        example: 1
        minimum: 1
        type: integer
      x:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      height:
        description: Default value is 37
        example: 50
        maximum: 1000
        minimum: 37
        type: integer
      width:
        description: Default value is 85
        example: 200
        maximum: 2000
        minimum: 85
        type: integer
      reason:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        description: 'Provide extra context to explain why the Document is being signed.
          Once the Document is signed, the custom reason is stored in the Audit Trail
          and is included in the signature certificate.

          The default value is: "Signed by [Signer first name] [Signer last name]".

          '
        example: Signed by John Doe
        maxLength: 150
        nullable: true
        type: string
      display:
        $ref: '#/components/schemas/SignatureDisplay_1'
    title: Signature
    type: object
  Mention_1:
    properties:
      signer_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      page:
        example: 1
        minimum: 1
        type: integer
      x:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      width:
        description: If not set, the width is automatically calculated with the read
          only text length.
        example: 200
        minimum: 24
        type: integer
      height:
        description: The height must be 24 or a multiple of 15 greater than 24. If
          height is not provided, it will be calculated depending on the number of
          newlines in the read only text.
        example: 150
        minimum: 24
        nullable: true
        type: integer
      mention:
        description: 'Content of the Mention.

          You can use dynamic tags when creating the Mention:

          • %date% will display the current date when the Signer sign the Signature
          Request (eg. "24-03-2025")

          • %datetime% will display the current date and time when the Signer signs
          the Signature Request (eg. "24-03-2025 10:30 UTC+0")

          '
        example: Signed on %date%
        maxLength: 255
        minLength: 1
        type: string
      font:
        $ref: '#/components/schemas/UpdateFieldFont'
      name:
        description: Name of the Field.
        example: Text 1
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
    title: Mention
    type: object
  SignatureDate_1:
    properties:
      signer_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      page:
        example: 1
        minimum: 1
        type: integer
      x:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      font:
        $ref: '#/components/schemas/UpdateFieldFont'
      name:
        description: Name of the Field.
        example: Date 1
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      date_format:
        $ref: '#/components/schemas/CreateFieldDateFormat'
      time_format:
        $ref: '#/components/schemas/CreateFieldTimeFormat'
      show_timezone:
        default: false
        description: Boolean indicating whether to display the timezone abbreviation
          (e.g., `CEST`) next to the time.
        nullable: true
        type: boolean
      show_email:
        default: true
        description: Boolean indicating whether to display the signer's email address.
        nullable: false
        type: boolean
      offset_unit:
        $ref: '#/components/schemas/CreateFieldOffsetUnit'
      offset_value:
        default: 0
        description: 'Number of units to add to the signature date. Ignored if `offset_unit`
          is `null`. For example, use `offset_unit`: `"month"` and `offset_value:
          3` to display "signature date + 3 months"'
        example: 30
        minimum: 0
        nullable: true
        type: integer
    title: SignatureDate
    type: object
  Text_1:
    properties:
      signer_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      page:
        example: 1
        minimum: 1
        type: integer
      x:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      width:
        description: If not set, the width is automatically calculated with the max_length
          value
        example: 200
        minimum: 24
        type: integer
      height:
        description: The height must be 24 or a multiple of 15 greater than 24.
        example: 150
        minimum: 24
        type: integer
      max_length:
        example: 150
        maximum: 32767
        minimum: 1
        type: integer
      question:
        description: If you don't want any question, you can give an empty string.
        example: What is your job title?
        maxLength: 255
        type: string
      instruction:
        example: Your position in the company
        nullable: true
        type: string
      optional:
        default: false
        type: boolean
      font:
        $ref: '#/components/schemas/UpdateFieldFont'
      name:
        description: Name of the Field.
        example: Job Title
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      default_value:
        description: If a default value is provided, the Field will be pre-filled
          with this value. The Signer can modify it before signing unless the Field
          is set to `read-only`.
        example: Software Engineer
        maxLength: 32767
        minLength: 1
        nullable: true
        type: string
      read_only:
        default: false
        description: If set to `true`, the Signer cannot modify the Field and the
          default value (if provided) will remain unchanged.
        type: boolean
    title: Text
    type: object
  Checkbox_1:
    properties:
      signer_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      page:
        example: 1
        minimum: 1
        type: integer
      x:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      size:
        default: 24
        example: 24
        maximum: 240
        minimum: 8
        type: integer
      optional:
        default: false
        type: boolean
      name:
        example: Checkbox 1
        nullable: true
        type: string
      checked:
        default: false
        type: boolean
      read_only:
        default: false
        description: If set to `true`, the checkbox cannot be modified by the Signer.
        type: boolean
    title: Checkbox
    type: object
  RadioGroup_1_radios_inner:
    properties:
      name:
        description: Radio button's name
        example: My radio group
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      x:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      size:
        default: 24
        example: 24
        maximum: 240
        minimum: 8
        type: integer
    required:
    - x
    - y
    type: object
  RadioGroup_1:
    properties:
      signer_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      page:
        example: 1
        minimum: 1
        type: integer
      optional:
        default: false
        type: boolean
      name:
        description: Radio group's name
        example: radio_group_name_1
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      read_only:
        default: false
        description: If set to `true`, the radio button cannot be modified by the
          Signer.
        type: boolean
      radios:
        items:
          $ref: '#/components/schemas/RadioGroup_1_radios_inner'
        type: array
    title: RadioGroup
    type: object
  ReadOnlyText_1:
    properties:
      page:
        example: 1
        minimum: 1
        type: integer
      x:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      y:
        example: 400
        maximum: 32767
        minimum: 0
        type: integer
      width:
        description: If not set, the width is automatically calculated with the mention
          length.
        example: 24
        minimum: 24
        nullable: true
        type: integer
      height:
        description: The height must be 24 or a multiple of 15 greater than 24. If
          height is not provided, it will be calculated depending on the number of
          newlines in the mention.
        example: 150
        minimum: 24
        nullable: true
        type: integer
      text:
        example: Order n°12345
        maxLength: 5000
        type: string
      font:
        $ref: '#/components/schemas/UpdateFieldFont'
    title: ReadOnlyText
    type: object
  FieldAnswer_value:
    oneOf:
    - description: 'The answer value for a text field. Can be null if the field is
        not required.

        The selected radio name in a radio group.

        '
      example: My custom answer or my radio name in the group
      maxLength: 32767
      minLength: 1
      title: Answer Text or a Radio Group Field
      type: string
    - description: The answer value for a checkbox field.
      example: true
      title: Answer Checkbox Field
      type: boolean
  CreateFollowers_inner:
    properties:
      email:
        example: john.doe@example.com
        format: email
        maxLength: 100
        minLength: 1
        type: string
      locale:
        $ref: '#/components/schemas/Locale'
    required:
    - email
    - locale
    type: object
  Metadata_data_value:
    oneOf:
    - description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
        allowing email, URL and leading or trailing whitespaces.
      format: safe-string
      maxLength: 255
      minLength: 1
      type: string
    - type: number
    - type: boolean
  Signer_info:
    properties:
      first_name:
        minLength: 1
        type: string
      last_name:
        minLength: 1
        type: string
      email:
        format: email
        minLength: 1
        type: string
      phone_number:
        description: E.164 format. Becomes mandatory if `signature_authentication_mode`
          requires a phone number.
        minLength: 1
        nullable: true
        type: string
      locale:
        $ref: '#/components/schemas/Locale'
    required:
    - email
    - first_name
    - last_name
    - locale
    - phone_number
    type: object
  Signer_fields_inner:
    oneOf:
    - $ref: '#/components/schemas/FieldSignature'
    - $ref: '#/components/schemas/FieldText'
    - $ref: '#/components/schemas/FieldMention'
    - $ref: '#/components/schemas/FieldCheckbox'
    - $ref: '#/components/schemas/FieldRadioButtonGroup'
  Signer_redirect_urls:
    description: ''
    properties:
      success:
        example: https://example.com/success
        format: uri
        minLength: 1
        nullable: true
        type: string
      error:
        example: https://example.com/error
        format: uri
        minLength: 1
        nullable: true
        type: string
      decline:
        example: https://example.com/decline
        format: uri
        minLength: 1
        nullable: true
        type: string
    required:
    - decline
    - error
    - success
    type: object
  New_Signer_From_Scratch_info:
    properties:
      first_name:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        example: John
        maxLength: 255
        minLength: 1
        type: string
      last_name:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        example: Doe
        maxLength: 255
        minLength: 1
        type: string
      email:
        format: email
        maxLength: 100
        minLength: 1
        type: string
      phone_number:
        description: E.164 format. Becomes mandatory if `signature_authentication_mode`
          requires a phone number.
        example: '+41446667700'
        minLength: 1
        nullable: true
        type: string
      locale:
        $ref: '#/components/schemas/Locale'
    required:
    - email
    - first_name
    - last_name
    - locale
    type: object
  New_Signer_From_Scratch_redirect_urls:
    properties:
      success:
        example: https://example.com/success
        format: uri
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      error:
        example: https://example.com/error
        format: uri
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      decline:
        example: https://example.com/decline
        format: uri
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
    type: object
  New_Signer_From_Scratch_custom_text:
    properties:
      request_subject:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.
        format: safe-string
        maxLength: 512
        minLength: 1
        nullable: true
        type: string
      request_body:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.
        format: safe-string
        maxLength: 2000
        minLength: 1
        nullable: true
        type: string
      reminder_subject:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.
        format: safe-string
        maxLength: 512
        minLength: 1
        nullable: true
        type: string
      reminder_body:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.
        format: safe-string
        maxLength: 2000
        minLength: 1
        nullable: true
        type: string
    type: object
  New_Signer_From_Scratch:
    description: Create a new signer from scratch
    properties:
      info:
        $ref: '#/components/schemas/New_Signer_From_Scratch_info'
      fields:
        description: Fields to assign to the Signer. Multiple Fields can be added
          simultaneously.
        items:
          $ref: '#/components/schemas/FieldsInput'
        type: array
      insert_after_id:
        description: 'ID of the recipient this one must follow in an ordered flow;
          they will only be asked to act after that recipient.

          When `custom_recipient_order` is enabled, this can reference any approver
          or signer.

          When `custom_recipient_order` is disabled, the referenced ID must be a signer.
          `ordered_signers` must be enabled on the Signature Request.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      group_with_id:
        description: 'ID of another recipient (Approver or Signer); both will be allowed
          to act in parallel in an ordered flow.

          Only available when `custom_recipient_order` is enabled.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      signature_level:
        enum:
        - electronic_signature
        - advanced_electronic_signature
        - qualified_electronic_signature
        type: string
      signature_authentication_mode:
        description: Method to authenticate the Signers. Authentication via SMS one-time
          password (otp_sms) is unavailable for phone numbers in China.
        enum:
        - otp_email
        - otp_sms
        - no_otp
        nullable: true
        type: string
      redirect_urls:
        $ref: '#/components/schemas/New_Signer_From_Scratch_redirect_urls'
      custom_text:
        $ref: '#/components/schemas/New_Signer_From_Scratch_custom_text'
      delivery_mode:
        $ref: '#/components/schemas/SignerDeliveryMode'
      identification_attestation_id:
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      sms_notification:
        $ref: '#/components/schemas/SmsNotification_1'
      email_notification:
        $ref: '#/components/schemas/EmailNotification_1'
      pre_identity_verification_required:
        description: Defines the way the Signer's Identity Documents will be uploaded
          for Verification. If set to `true`, `signature_level`should be equal to
          `advanced_electronic_signature` and `delivery_mode` set to `none`.
        type: boolean
      excluded_documents:
        $ref: '#/components/schemas/ExcludedDocuments'
    required:
    - info
    - signature_level
    title: New Signer From Scratch
    type: object
  New_Signer_From_Existing_User_custom_text:
    properties:
      request_subject:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.
        format: safe-string
        maxLength: 150
        minLength: 1
        nullable: true
        type: string
      request_body:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.
        format: safe-string
        maxLength: 2000
        minLength: 1
        nullable: true
        type: string
      reminder_subject:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.
        format: safe-string
        maxLength: 150
        minLength: 1
        nullable: true
        type: string
      reminder_body:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.
        format: safe-string
        maxLength: 2000
        minLength: 1
        nullable: true
        type: string
    type: object
  New_Signer_From_Existing_User:
    description: Create a new signer from an existing user
    properties:
      user_id:
        description: Create signer from an existing user
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      fields:
        items:
          $ref: '#/components/schemas/FieldsInput'
        type: array
      insert_after_id:
        description: 'ID of the recipient this one must follow in an ordered flow;
          they will only be asked to act after that recipient.

          When `custom_recipient_order` is enabled, this can reference any approver
          or signer.

          When `custom_recipient_order` is disabled, the referenced ID must be a signer.
          `ordered_signers` must be enabled on the Signature Request.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      group_with_id:
        description: 'ID of another recipient (Approver or Signer); both will be allowed
          to act in parallel in an ordered flow.

          Only available when `custom_recipient_order` is enabled.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      signature_level:
        enum:
        - electronic_signature
        - advanced_electronic_signature
        - qualified_electronic_signature
        type: string
      signature_authentication_mode:
        description: Method to authenticate the Signers. Authentication via SMS one-time
          password (otp_sms) is unavailable for phone numbers in China.
        enum:
        - otp_email
        - otp_sms
        - no_otp
        nullable: true
        type: string
      redirect_urls:
        $ref: '#/components/schemas/New_Signer_From_Scratch_redirect_urls'
      custom_text:
        $ref: '#/components/schemas/New_Signer_From_Existing_User_custom_text'
      delivery_mode:
        $ref: '#/components/schemas/SignerDeliveryMode'
      identification_attestation_id:
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      sms_notification:
        $ref: '#/components/schemas/SmsNotification_1'
      email_notification:
        $ref: '#/components/schemas/EmailNotification_1'
      pre_identity_verification_required:
        description: Defines the way the Signer's Identity Documents will be uploaded
          for Verification. If set to `true`, `signature_level`should be equal to
          `advanced_electronic_signature` and `delivery_mode` set to `none`.
        nullable: false
        type: boolean
      excluded_documents:
        $ref: '#/components/schemas/ExcludedDocuments'
    required:
    - signature_level
    - user_id
    title: New Signer From Existing User
    type: object
  New_Signer_From_Existing_Contact:
    description: Create a new signer from an existing contact
    properties:
      contact_id:
        description: Create signer from an existing contact
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      fields:
        items:
          $ref: '#/components/schemas/FieldsInput'
        type: array
      insert_after_id:
        description: 'ID of the recipient this one must follow in an ordered flow;
          they will only be asked to act after that recipient.

          When `custom_recipient_order` is enabled, this can reference any approver
          or signer.

          When `custom_recipient_order` is disabled, the referenced ID must be a signer.
          `ordered_signers` must be enabled on the Signature Request.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      group_with_id:
        description: 'ID of another recipient (Approver or Signer); both will be allowed
          to act in parallel in an ordered flow.

          Only available when `custom_recipient_order` is enabled.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      signature_level:
        enum:
        - electronic_signature
        - advanced_electronic_signature
        - qualified_electronic_signature
        type: string
      signature_authentication_mode:
        description: Method to authenticate the Signers. Authentication via SMS one-time
          password (otp_sms) is unavailable for phone numbers in China.
        enum:
        - otp_email
        - otp_sms
        - no_otp
        nullable: true
        type: string
      redirect_urls:
        $ref: '#/components/schemas/New_Signer_From_Scratch_redirect_urls'
      custom_text:
        $ref: '#/components/schemas/New_Signer_From_Existing_User_custom_text'
      delivery_mode:
        $ref: '#/components/schemas/SignerDeliveryMode'
      identification_attestation_id:
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      sms_notification:
        $ref: '#/components/schemas/SmsNotification_1'
      email_notification:
        $ref: '#/components/schemas/EmailNotification_1'
      pre_identity_verification_required:
        description: Defines the way the Signer's Identity Documents will be uploaded
          for Verification. If set to `true`, `signature_level`should be equal to
          `advanced_electronic_signature` and `delivery_mode` set to `none`.
        nullable: false
        type: boolean
      excluded_documents:
        $ref: '#/components/schemas/ExcludedDocuments'
    required:
    - contact_id
    - signature_level
    title: New Signer From Existing Contact
    type: object
  New_Signer_From_Identity_Verification_info:
    properties:
      email:
        format: email
        maxLength: 100
        minLength: 1
        type: string
      phone_number:
        description: E.164 format. Becomes mandatory if `signature_authentication_mode`
          requires a phone number.
        example: '+41446667700'
        minLength: 1
        type: string
      locale:
        $ref: '#/components/schemas/Locale'
    required:
    - email
    - locale
    - phone_number
    type: object
  New_Signer_From_Identity_Verification_custom_text:
    properties:
      request_subject:
        maxLength: 512
        minLength: 1
        nullable: true
        type: string
      request_body:
        maxLength: 2000
        minLength: 1
        nullable: true
        type: string
      reminder_subject:
        maxLength: 512
        minLength: 1
        nullable: true
        type: string
      reminder_body:
        maxLength: 2000
        minLength: 1
        nullable: true
        type: string
    type: object
  New_Signer_From_Identity_Verification:
    description: Create a new signer from an identity verification
    properties:
      verified_identity_id:
        description: Create a signer from an identity verification. The signature
          level must be set to `advanced_electronic_signature`.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      info:
        $ref: '#/components/schemas/New_Signer_From_Identity_Verification_info'
      fields:
        description: Fields to assign to the Signer. Multiple Fields can be added
          simultaneously.
        items:
          $ref: '#/components/schemas/FieldsInput'
        type: array
      insert_after_id:
        description: 'ID of the recipient this one must follow in an ordered flow;
          they will only be asked to act after that recipient.

          When `custom_recipient_order` is enabled, this can reference any approver
          or signer.

          When `custom_recipient_order` is disabled, the referenced ID must be a signer.
          `ordered_signers` must be enabled on the Signature Request.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      group_with_id:
        description: 'ID of another recipient (Approver or Signer); both will be allowed
          to act in parallel in an ordered flow.

          Only available when `custom_recipient_order` is enabled.

          '
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        nullable: true
        type: string
      signature_level:
        enum:
        - advanced_electronic_signature
        type: string
      signature_authentication_mode:
        description: Method to authenticate the Signers. Authentication via SMS one-time
          password (otp_sms) is unavailable for phone numbers in China.
        enum:
        - otp_sms
        type: string
      redirect_urls:
        $ref: '#/components/schemas/New_Signer_From_Scratch_redirect_urls'
      custom_text:
        $ref: '#/components/schemas/New_Signer_From_Identity_Verification_custom_text'
      delivery_mode:
        $ref: '#/components/schemas/SignerDeliveryMode'
      sms_notification:
        $ref: '#/components/schemas/SmsNotification_1'
      email_notification:
        $ref: '#/components/schemas/EmailNotification_1'
      excluded_documents:
        $ref: '#/components/schemas/ExcludedDocuments'
    required:
    - info
    - signature_authentication_mode
    - signature_level
    - verified_identity_id
    title: New Signer From Identity Verification
    type: object
  UpdateSigner_info:
    nullable: true
    properties:
      first_name:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        example: John
        maxLength: 255
        minLength: 1
        type: string
      last_name:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        example: Doe
        maxLength: 255
        minLength: 1
        type: string
      email:
        format: email
        maxLength: 100
        minLength: 1
        type: string
      phone_number:
        description: E.164 format
        example: '+41446667700'
        minLength: 1
        nullable: true
        type: string
      locale:
        $ref: '#/components/schemas/Locale'
    type: object
  Signer_s_IP_address:
    description: Signer's public IP address at the time of signing. Private IP addresses
      (e.g. 10.x.x.x, 172.16-31.x.x, 192.168.x.x) are not accepted, as a public IP
      is required to be recorded in the Audit Trail.
    oneOf:
    - example: 192.0.2.146
      format: ipv4
      title: IPv4
      type: string
    - example: 2001:0000:130F:0000:0000:09C0:876A:130B
      format: ipv6
      title: IPv6
      type: string
    title: Signer's IP address
  User_workspaces_inner:
    properties:
      id:
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
    required:
    - id
    type: object
  InitiateBankAccountLookupWithNaturalPerson_natural_person:
    description: Information about the natural person who owns the bank account
    properties:
      first_name:
        description: First name of the person
        example: John
        maxLength: 255
        nullable: false
        type: string
      last_name:
        description: Last name of the person
        example: Doe
        maxLength: 255
        nullable: false
        type: string
    required:
    - first_name
    - last_name
    type: object
  BankAccountLookupFull_data_extracted_from_document:
    nullable: true
    properties:
      iban:
        description: The IBAN number extracted from the document.
        example: FR7630006000011234567890189
        nullable: true
        type: string
    type: object
  BankAccountLookupFull_data:
    properties:
      extracted_from_document:
        $ref: '#/components/schemas/BankAccountLookupFull_data_extracted_from_document'
    required:
    - extracted_from_document
    type: object
  InitiateBankAccountWithLegalPerson_legal_person:
    additionalProperties: false
    description: The field can not be submitted if field "natural_person" is provided.
    properties:
      name:
        description: 'Please provide the legal entity name, exactly as it appears
          on the bank account document.

          Please match it exactly, with the same characters, same case.

          '
        example: Foundation Teaming
        maxLength: 128
        minLength: 1
        type: string
    type: object
  InitiateBankAccountWithNaturalPerson_natural_person:
    additionalProperties: false
    description: The field can not be submitted if field "legal_person" is provided.
    properties:
      first_name:
        description: 'Please provide the holder first name, exactly as it appears
          on the bank account document.

          Please match it exactly, with the same characters, same case.

          One exception: if the document mentions an honorary title, please don''t
          provide it as part of the name.

          '
        example: John
        maxLength: 255
        minLength: 1
        type: string
      last_name:
        description: 'Please provide the holder last name, exactly as it appears on
          the bank account document.

          Please match it exactly, with the same characters, same case.

          One exception: if the document mentions an honorary title, please don''t
          provide it as part of the name.

          '
        example: Doe
        maxLength: 255
        minLength: 1
        type: string
    type: object
  BankAccountFull_allOf_data_extracted_from_document:
    description: Data extracted from the provided bank account document
    properties:
      iban:
        $ref: '#/components/schemas/NullableIBAN'
      bic:
        $ref: '#/components/schemas/NullableBIC'
    required:
    - bic
    - iban
    type: object
  BankAccountFull_allOf_data:
    properties:
      extracted_from_document:
        $ref: '#/components/schemas/BankAccountFull_allOf_data_extracted_from_document'
    required:
    - extracted_from_document
    type: object
  CompanyFull_allOf_data_extracted_from_document:
    properties:
      company_number:
        description: Company number extracted from the document.
        nullable: true
        type: string
      issued_on:
        description: Date when the document was issued.
        format: date
        nullable: true
        type: string
    type: object
  CompanyFull_allOf_data_company_information_legal_form:
    properties:
      code:
        description: Legal form code (ISO 20275).
        example: 6CHY
        nullable: true
        type: string
      description:
        description: Local legal form name.
        example: SAS, société par actions simplifiée
        nullable: true
        type: string
    required:
    - code
    - description
    type: object
  CompanyFull_allOf_data_company_information_activities:
    properties:
      code:
        description: Activity code.
        example: '62.01'
        nullable: true
        type: string
      description:
        description: Activity name.
        example: Computer programming activities
        nullable: true
        type: string
      classification:
        description: Activity classification.
        example: NACE
        nullable: true
        type: string
    required:
    - classification
    - code
    - description
    type: object
  CompanyFull_allOf_data_company_information_commercial_registration:
    properties:
      location:
        description: Indicates the location of the company's commercial register.
        example: CAEN
        nullable: true
        type: string
      registered_on:
        description: Indicates the company's registration date in the commercial register.
        example: '2013-08-01'
        format: date
        nullable: true
        type: string
    required:
    - location
    - registered_on
    type: object
  CompanyFull_allOf_data_company_information:
    properties:
      name:
        description: Denomination of the company.
        example: YOUSIGN
        nullable: true
        type: string
      trade_name:
        description: Trade name of the company.
        nullable: true
        type: string
      company_number:
        description: The number of the company entity.
        example: '794513986'
        nullable: true
        type: string
      partial_data:
        description: 'Describes if a company has declined to make some of her data
          public (ie : legal representatives personal data), when true data might
          be missing from the response'
        example: true
        nullable: true
        type: boolean
      required_document_type:
        description: 'Provides the right document type to request for a given company
          based on its registry. ie: company_certificate, rne_certificate or business_registration_certificate.
          You can use those types when calling Document Analysis.'
        example:
        - company_certificate
        items:
          enum:
          - company_certificate
          - business_registration_certificate
          - rne_certificate
          type: string
        type: array
      legal_form:
        $ref: '#/components/schemas/CompanyFull_allOf_data_company_information_legal_form'
      vat_number:
        description: Tax number of the company.
        example: FR61794513986
        nullable: true
        type: string
      activities:
        items:
          $ref: '#/components/schemas/CompanyFull_allOf_data_company_information_activities'
        type: array
      founded_on:
        description: Company's creation date.
        example: '2013-07-24'
        format: date
        nullable: true
        type: string
      ceased_on:
        description: Indicates the company's cessation date if company is inactive,
          otherwise null.
        format: date
        nullable: true
        type: string
      active:
        description: Indicates whether or not the company is still active.
        nullable: true
        type: boolean
      commercial_registration:
        $ref: '#/components/schemas/CompanyFull_allOf_data_company_information_commercial_registration'
      has_workforce:
        description: True if the company has at least one employee.
        nullable: true
        type: boolean
    type: object
  CompanyFull_allOf_data_headquarter:
    properties:
      address_line_1:
        example: AVENUE PIERRE BERTHELOT
        nullable: true
        type: string
      address_line_2:
        nullable: true
        type: string
      postal_code:
        example: '14000'
        nullable: true
        type: string
      city:
        example: CAEN
        nullable: true
        type: string
      country_code:
        example: FR
        nullable: true
        type: string
    required:
    - address_line_1
    - address_line_2
    - city
    - country_code
    - postal_code
    type: object
  CompanyFull_allOf_data_legal_representatives:
    properties:
      title:
        description: The representative's role within the company.
        example: Président
        nullable: true
        type: string
      type:
        description: Indicates whether the representative is a natural person or a
          legal entity.
        enum:
        - natural_person
        - legal_person
        nullable: true
        type: string
      first_name:
        description: The representative's first name in case of a natural person,
          otherwise null.
        example: John
        nullable: true
        type: string
      last_name:
        description: The representative's last name in case of a natural person, otherwise
          null.
        example: Doe
        nullable: true
        type: string
      birth_name:
        description: The representative's birth name in case of a natural person,
          otherwise null.
        example: Doe
        nullable: true
        type: string
      born_on:
        description: The representative's birthdate in case of a natural person, otherwise
          null.
        example: '1994-04-20'
        format: date
        nullable: true
        type: string
      company_name:
        description: The representative's company name in case of a legal person,
          otherwise null.
        nullable: true
        type: string
      company_number:
        description: The representative's company number in case of a legal person,
          otherwise null.
        nullable: true
        type: string
    required:
    - birth_name
    - born_on
    - company_name
    - company_number
    - first_name
    - last_name
    - title
    - type
    type: object
  CompanyFull_allOf_data:
    properties:
      extracted_from_document:
        $ref: '#/components/schemas/CompanyFull_allOf_data_extracted_from_document'
      company_information:
        $ref: '#/components/schemas/CompanyFull_allOf_data_company_information'
      headquarter:
        $ref: '#/components/schemas/CompanyFull_allOf_data_headquarter'
      legal_representatives:
        items:
          $ref: '#/components/schemas/CompanyFull_allOf_data_legal_representatives'
        type: array
    type: object
  IdentityDocumentFull_allOf_data_extracted_from_document_mrz:
    description: Machine Readable Zone content
    properties:
      line1:
        description: MRZ line 1
        example: IDFRASIAGRA<<<<<<<<<<<<<<<<<<<133039
        nullable: true
        type: string
      line2:
        description: MRZ line 2
        example: 1002133008071GREGOIRE<<REMY8110228M4
        nullable: true
        type: string
      line3:
        description: MRZ line 3
        example: <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
        nullable: true
        type: string
    required:
    - line1
    - line2
    - line3
    type: object
  IdentityDocumentFull_allOf_data_extracted_from_document:
    description: Information extracted from the verified identity document
    properties:
      first_name:
        description: The document holder's first name as it appears on the identity
          document
        example: John
        minLength: 1
        nullable: true
        type: string
      birth_name:
        description: The document holder's birth name (family name at birth)
        example: Doe
        minLength: 1
        nullable: true
        type: string
      last_name:
        description: The document holder's current last name (may differ from birth
          name)
        example: Doe
        minLength: 1
        nullable: true
        type: string
      born_on:
        description: The document holder's date of birth as it appears on the document
        example: '2024-01-18'
        format: date
        nullable: true
        type: string
      birth_location:
        description: The holder's place of birth as it appears on the document
        example: Paris
        minLength: 1
        nullable: true
        type: string
      gender:
        description: The holder's gender as it appears on the document. "m" for Male,
          "f" for Female, "x" for Non-binary or unspecified.
        enum:
        - f
        - m
        - x
        - null
        example: f
        nullable: true
        type: string
      full_address:
        description: The holder's complete postal address as it appears on the document
        example: '13 RUE SAINT MARCELIN

          MARSEILLE 10E (13)'
        minLength: 1
        nullable: true
        type: string
      type:
        description: The type of identity document that was verified
        enum:
        - id_card
        - passport
        - residence_permit
        - ita_ts_cns
        - null
        example: id_card
        nullable: true
        type: string
      issuing_country_code:
        description: The country that issued the document (ISO 3166-1 alpha-2 code)
        example: US
        format: ISO 3166-1 alpha-2
        nullable: true
        pattern: ^[A-Za-z]{2}$
        type: string
      issued_on:
        description: The date when the document was issued
        example: '2024-01-18'
        format: date
        nullable: true
        pattern: ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
        type: string
      expired_on:
        description: The date when the document legally expires
        example: '2024-01-18'
        format: date
        nullable: true
        pattern: ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$
        type: string
      document_number:
        description: Document identifier number (may contain letters)
        example: X4RTBPFW4
        nullable: true
        type: string
      mrz:
        $ref: '#/components/schemas/IdentityDocumentFull_allOf_data_extracted_from_document_mrz'
      national_identification_number:
        description: 'Some documents may contain a national identification number.

          For example, Italian ID cards contain the Codice Fiscale on the back of
          the document.

          When this data is available on the document, it will be returned here, otherwise
          it will be NULL.

          Consult our [guide](https://developers.yousign.com/docs/identity-document-verification)
          for more details and examples.

          '
        example: MLLSNT82P65Z404U
        nullable: true
        type: string
    required:
    - birth_location
    - birth_name
    - born_on
    - document_number
    - expired_on
    - first_name
    - full_address
    - gender
    - issued_on
    - issuing_country_code
    - last_name
    - mrz
    - national_identification_number
    - type
    type: object
  IdentityDocumentFull_allOf_data:
    properties:
      extracted_from_document:
        $ref: '#/components/schemas/IdentityDocumentFull_allOf_data_extracted_from_document'
    required:
    - extracted_from_document
    type: object
  IdentityVideoFull_allOf_data_evidence:
    description: Documentary evidence captured during the verification process
    properties:
      document_front_image_url:
        description: Temporary public link to the front image. Available for 10 minutes
          after the user completed the verification.
        example: https://storage-b.env.ubble.ai/ubble-ai/88bf48f0-ce4a-449c-9af1-f138a7e09392/ae1f813a-02cf-4ffc-bf71-d823ed74dc8d/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/aaa.png?X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=xxx
        format: uri
        minLength: 1
        nullable: true
        type: string
      document_back_image_url:
        description: Temporary public link to the back image. Available for 10 minutes
          after the user completed the verification.
        example: https://storage-b.env.ubble.ai/ubble-ai/88bf48f0-ce4a-449c-9af1-f138a7e09392/ae1f813a-02cf-4ffc-bf71-d823ed74dc8d/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/bbb.png?X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=xxx
        format: uri
        minLength: 1
        nullable: true
        type: string
      face_image_url:
        description: Temporary public link to the face image. Available for 10 minutes
          after the user completed the verification.
        example: https://storage-b.ubble.ai/11-production-ubble-ai/CKQNCMWHRPGT/idv_01jezpmz01mvn7r1n9eg596v5k/9a873da8-2395-4b05-b9a6-56644dfe2e06/9dc6948e-23b8-4405-81f2-28dccc0d9a71/face_asset_generation_0_rtc_face_0_rtc_face/face_crop_41.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=h6aivdggwQIvVyGWnAEw%2F20241216%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20241216T100820Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=xxx
        format: uri
        minLength: 1
        nullable: true
        type: string
    required:
    - document_back_image_url
    - document_front_image_url
    - face_image_url
    type: object
  IdentityVideoFull_allOf_data:
    properties:
      extracted_from_document:
        $ref: '#/components/schemas/IdentityVideoDocument'
      evidence:
        $ref: '#/components/schemas/IdentityVideoFull_allOf_data_evidence'
    required:
    - evidence
    - extracted_from_document
    type: object
  InitiateProofOfAddress_natural_person_address:
    additionalProperties: false
    description: Provide the holder full address, exactly as it should appear on the
      proof of address document.
    nullable: true
    properties:
      line1:
        description: The first line of the address, typically the street name and
          number.
        example: Rue De Suède
        maxLength: 500
        minLength: 1
        type: string
      line2:
        description: If needed, the second line of the address, typically an apartment
          or suite number.
        maxLength: 500
        minLength: 1
        nullable: true
        type: string
        example: null
      postal_code:
        description: The postal code of the address.
        example: '14000'
        maxLength: 10
        minLength: 1
        type: string
      city:
        description: The city of the address.
        example: CAEN
        maxLength: 200
        minLength: 1
        type: string
    required:
    - city
    - line1
    - postal_code
    type: object
  InitiateProofOfAddress_natural_person:
    additionalProperties: false
    properties:
      first_name:
        description: 'Provide the holder first name, exactly as it should appear on
          the proof of address document.

          Please match it exactly, with the same characters, same case.

          One exception: if the document mentions an honorary title, please don''t
          provide it as part of the name.

          This field can not be submitted without field "last_name".

          '
        example: John
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      last_name:
        description: 'Provide the holder last name, exactly as it should appear on
          the proof of address document.

          Please match it exactly, with the same characters, same case.

          One exception: if the document mentions an honorary title, please don''t
          provide it as part of the name.

          This field can not be submitted without field "first_name".

          '
        example: Doe
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      address:
        $ref: '#/components/schemas/InitiateProofOfAddress_natural_person_address'
    type: object
  ProofOfAddressFull_allOf_data_extracted_from_document_2d_doc_address:
    description: If found, the address extracted from the 2D-Doc.
    properties:
      line1:
        description: The street type, name and number.
        example: 18 rue de Londres
        minLength: 1
        nullable: true
        type: string
      postal_code:
        description: The postal code.
        example: '75008'
        minLength: 1
        nullable: true
        type: string
      city:
        description: The city name.
        example: Paris
        minLength: 1
        nullable: true
        type: string
      country_code:
        example: FR
        format: ISO 3166-1 alpha-2
        maxLength: 2
        minLength: 1
        nullable: true
        pattern: ^[A-Za-z]{2}$
        type: string
    required:
    - city
    - country_code
    - line1
    - postal_code
    type: object
  ProofOfAddressFull_allOf_data_extracted_from_document_2d_doc:
    description: Data extracted from the 2D-Doc if the document has one.
    properties:
      full_name:
        description: If found, the full name extracted from the 2D-Doc.
        example: John Doe
        minLength: 1
        nullable: true
        type: string
      address:
        $ref: '#/components/schemas/ProofOfAddressFull_allOf_data_extracted_from_document_2d_doc_address'
    required:
    - address
    - full_name
    type: object
  ProofOfAddressFull_allOf_data_extracted_from_document:
    description: Data extracted from the provided proof of address document
    properties:
      first_name:
        description: If found, the first name as it appeared on the document.
        example: John
        minLength: 1
        nullable: true
        type: string
      last_name:
        description: If found, the last name as it appeared on the document.
        example: Doe
        minLength: 1
        nullable: true
        type: string
      full_address:
        description: If found, the address as it appeared on the document.
        example: Rue De Suède Av Pierre Berthelot 14000 CAEN
        minLength: 1
        nullable: true
        type: string
      issued_on:
        description: If found, the document's issuance date as it appeared on the
          document.
        example: '2022-01-01'
        format: date
        nullable: true
        type: string
      document_type:
        description: The type of document that was verified
        enum:
        - driver_license
        - energy_invoice
        - energy_schedule
        - family_allowance
        - id_card
        - insurance_attestation
        - italian_national_service_card
        - local_residence_tax_notice
        - passport
        - payslip
        - photograph
        - phone_invoice
        - property_tax_notice
        - provider_attestation
        - residence_permit
        - retirement_pension
        - rib
        - tax_justification
        - tax_notice
        - vehicle_registration_certificate
        example: tax_notice
        nullable: true
        type: string
      2d_doc:
        $ref: '#/components/schemas/ProofOfAddressFull_allOf_data_extracted_from_document_2d_doc'
    required:
    - 2d_doc
    - first_name
    - full_address
    - issued_on
    - last_name
    type: object
  ProofOfAddressFull_allOf_data:
    properties:
      extracted_from_document:
        $ref: '#/components/schemas/ProofOfAddressFull_allOf_data_extracted_from_document'
    required:
    - extracted_from_document
    type: object
  InitiateWatchlist_natural_person:
    description: Information about the person to check
    properties:
      first_name:
        description: First name of the person
        example: Emmanuel
        nullable: false
        type: string
      last_name:
        description: Last name of the person
        example: Macron
        nullable: false
        type: string
      born_on:
        description: Date of birth of the person (YYYY-MM-DD)
        example: '1977-12-21'
        format: date
        nullable: false
        type: string
    required:
    - born_on
    - first_name
    - last_name
    type: object
  WatchlistFull_allOf_data_politically_exposed_person_sources:
    properties:
      name:
        description: Name of the source
        example: Wikidata Politically Exposed Persons
        nullable: true
        type: string
      url:
        description: URL of the source
        example: https://www.opensanctions.org/datasets/wd_peps
        nullable: true
        type: string
    required:
    - name
    - url
    type: object
  WatchlistFull_allOf_data_politically_exposed_person_positions:
    properties:
      title:
        description: Title of the political position
        example: Minister of Finance
        nullable: true
        type: string
      active:
        description: Whether the person is currently politically exposed
        example: false
        type: boolean
      country_code:
        description: ISO country code where the position is held
        example: FR
        format: ISO 3166-1 alpha-2
        nullable: true
        type: string
      started_on:
        description: Date when the position started
        example: '2020-01-01'
        nullable: true
        type: string
      ended_on:
        description: Date when the position ended − null if ongoing
        example: '2021-01-01'
        nullable: true
        type: string
      sources:
        description: Sources of this information
        items:
          $ref: '#/components/schemas/WatchlistFull_allOf_data_politically_exposed_person_sources'
        type: array
    required:
    - active
    - country_code
    - ended_on
    - sources
    - started_on
    - title
    type: object
  WatchlistFull_allOf_data_politically_exposed_person:
    description: Information about politically exposed person status
    properties:
      active:
        description: Whether the person is currently politically exposed
        type: boolean
      positions:
        items:
          $ref: '#/components/schemas/WatchlistFull_allOf_data_politically_exposed_person_positions'
        type: array
    required:
    - active
    - positions
    type: object
  WatchlistFull_allOf_data_sanctions_sources:
    properties:
      name:
        description: Name of the source
        example: CIA World Factbook heads of state and government
        nullable: true
        type: string
      url:
        description: URL of the source
        example: https://www.opensanctions.org/datasets/us_cia_world_factbook
        nullable: true
        type: string
    required:
    - name
    - url
    type: object
  WatchlistFull_allOf_data_sanctions_records:
    properties:
      description:
        description: Description of the sanction
        example: Management ban
        nullable: true
        type: string
      authority:
        description: Authority that issued the sanction
        example: Commercial Court of Paris
        nullable: true
        type: string
      country_code:
        description: ISO country code where the sanction is applicable
        example: FR
        format: ISO 3166-1 alpha-2
        nullable: true
        type: string
      active:
        description: Whether the sanction is currently active
        example: false
        type: boolean
      started_on:
        description: Date when the sanction started
        example: '2020-01-01'
        nullable: true
        type: string
      ended_on:
        description: Date when the sanction ended − null if ongoing
        example: '2021-01-01'
        nullable: true
        type: string
      sources:
        description: Sources of this information
        items:
          $ref: '#/components/schemas/WatchlistFull_allOf_data_sanctions_sources'
        type: array
    required:
    - active
    - authority
    - country_code
    - description
    - ended_on
    - sources
    - started_on
    type: object
  WatchlistFull_allOf_data_sanctions:
    description: List of sanctions against the person
    properties:
      active:
        description: Whether the person is currently sanctioned.
        type: boolean
      records:
        items:
          $ref: '#/components/schemas/WatchlistFull_allOf_data_sanctions_records'
        type: array
    required:
    - active
    - records
    type: object
  WatchlistFull_allOf_data:
    description: Verification result data
    properties:
      politically_exposed_person:
        $ref: '#/components/schemas/WatchlistFull_allOf_data_politically_exposed_person'
      sanctions:
        $ref: '#/components/schemas/WatchlistFull_allOf_data_sanctions'
    required:
    - politically_exposed_person
    - sanctions
    type: object
  WebhookSubscription_subscribed_events:
    description: Choose between a wildcard symbol to select all Workspaces or specify
      a list of specific Workspace UUIDs.
    oneOf:
    - $ref: '#/components/schemas/WebhookWildcardSubscribedEvent'
    - $ref: '#/components/schemas/WebhookSubscribedEvents'
  WebhookSubscription_scopes:
    oneOf:
    - $ref: '#/components/schemas/WebhookWildcardScope'
    - $ref: '#/components/schemas/WebhookScopes'
  WebhookSubscription_workspaces:
    oneOf:
    - $ref: '#/components/schemas/WebhookWildcardWorkspace'
    - $ref: '#/components/schemas/WebhookWorkspaces'
  CreateWebhookSubscription_subscribed_events:
    description: Select all the events to subscribe to.
    oneOf:
    - $ref: '#/components/schemas/WebhookSubscribedEvents'
    - $ref: '#/components/schemas/WebhookWildcardSubscribedEvent'
  CreateWebhookSubscription_scopes:
    description: Choose between a wildcard symbol to select all scopes or specify
      a list of specific scopes.
    oneOf:
    - $ref: '#/components/schemas/WebhookScopes'
    - $ref: '#/components/schemas/WebhookWildcardScope'
  CreateWebhookSubscription_workspaces:
    description: Choose between a wildcard symbol to select all Workspaces or specify
      a list of specific Workspace UUIDs. The association of specific Workspaces with
      Webhook is temporarily restricted in the sandbox environment, only the value
      wildcard ("*") for Workspaces is allowed in this context.
    oneOf:
    - $ref: '#/components/schemas/WebhookWorkspaces'
    - $ref: '#/components/schemas/WebhookWildcardWorkspace'
  WorkflowSession_action_groups_inner_actions_inner_resolution:
    description: The resource associated with this Action.
    nullable: true
    properties:
      reason:
        description: The reason why the Action is marked as resolved.
        example: Manual verification.
        maxLength: 150
        nullable: true
        type: string
      resolved_at:
        example: '2024-01-18T22:59:00Z'
        format: date-time
        readOnly: true
        type: string
    required:
    - reason
    - resolved_at
    type: object
  WorkflowSession_action_groups_inner_actions_inner_previous_attempts_inner:
    properties:
      resource:
        $ref: '#/components/schemas/WorkflowSessionActionResource'
    required:
    - resource
    type: object
  WorkflowSession_action_groups_inner_actions_inner:
    description: An Action.
    properties:
      resource:
        $ref: '#/components/schemas/WorkflowSessionActionResource'
      resolution:
        $ref: '#/components/schemas/WorkflowSession_action_groups_inner_actions_inner_resolution'
      previous_attempts:
        description: List of previous attempts for this action. Each one contains
          a resource with its associated details.
        items:
          $ref: '#/components/schemas/WorkflowSession_action_groups_inner_actions_inner_previous_attempts_inner'
        type: array
    required:
    - previous_attempts
    - resolution
    - resource
    type: object
  WorkflowSession_action_groups_inner:
    description: An Action Group.
    properties:
      type:
        description: Type of the Action Group.
        enum:
        - signature_request
        - identity_verification
        - proof_of_address_verification
        - company_verification
        - watchlist_verification
        - bank_account_verification
        - document_analysis
        example: identity_verification
        type: string
      status:
        description: Status of the Action Group.
        enum:
        - awaiting
        - ongoing
        - blocked
        - done
        example: ongoing
        type: string
      actions:
        description: Actions represent the resources associated with this Workflow
          Session, such as a Signature Request, Identity Document Verification, or
          other types of verifications. Actions of the same type are gathered in the
          same Action Group.
        items:
          $ref: '#/components/schemas/WorkflowSession_action_groups_inner_actions_inner'
        type: array
    required:
    - actions
    - status
    - type
    type: object
  Natural_Person_Applicant:
    additionalProperties: false
    description: A natural person Applicant.
    properties:
      id:
        description: Unique identifier of the Applicant.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      workflow_session_id:
        description: Unique identifier of the Workflow Session.
        example: 0ef334d2-7f36-4643-8a2a-4283b4a3e4a4
        format: uuid
        type: string
      status:
        description: Status of the Applicant.
        enum:
        - initiated
        - notified
        - processed
        example: initiated
        type: string
      label:
        description: Label of the Applicant.
        example: John Doe
        type: string
      reference_id:
        description: Unique applicant identifier as registered on your side.
        example: REF-12345
        nullable: true
        type: string
      created_at:
        description: Creation date of the Applicant.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      updated_at:
        description: Last update date of the Applicant.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      type:
        description: Type of the Applicant.
        enum:
        - natural_person
        type: string
      natural_person:
        $ref: '#/components/schemas/NaturalPerson'
    required:
    - created_at
    - id
    - label
    - natural_person
    - reference_id
    - status
    - type
    - updated_at
    - workflow_session_id
    title: Natural Person Applicant
    type: object
  Legal_Person_Applicant:
    additionalProperties: false
    description: A legal person Applicant.
    properties:
      id:
        description: Unique identifier of the Applicant.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      workflow_session_id:
        description: Unique identifier of the Workflow Session.
        example: 0ef334d2-7f36-4643-8a2a-4283b4a3e4a4
        format: uuid
        type: string
      status:
        description: Status of the Applicant.
        enum:
        - initiated
        - notified
        - processed
        example: initiated
        type: string
      label:
        description: Label of the Applicant.
        example: Acme Corp
        type: string
      reference_id:
        description: Unique applicant identifier as registered on your side.
        example: REF-12345
        nullable: true
        type: string
      created_at:
        description: Creation date of the Applicant.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      updated_at:
        description: Last update date of the Applicant.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      type:
        description: Type of the Applicant.
        enum:
        - legal_person
        type: string
      legal_person:
        $ref: '#/components/schemas/LegalPerson'
    required:
    - created_at
    - id
    - label
    - legal_person
    - reference_id
    - status
    - type
    - updated_at
    - workflow_session_id
    title: Legal Person Applicant
    type: object
  WorkflowSessionLinks_applicants_inner:
    additionalProperties: false
    properties:
      id:
        description: Unique identifier of the Applicant.
        example: 9a93d3b5-fb3b-4abf-9e70-26315b33506c
        format: uuid
        type: string
      workflow_session_id:
        description: Unique identifier of the Workflow Session.
        example: 0ef334d2-7f36-4643-8a2a-4283b4a3e4a4
        format: uuid
        type: string
      workflow_session_link_url:
        description: URL of the portal link for this Applicant.
        example: https://portal.yousign.app/workflow_sessions/abc123
        type: string
      workflow_session_link_expires_at:
        description: Expiration date of the portal link.
        example: '2024-01-25T22:59:00Z'
        format: date-time
        type: string
      status:
        description: Status of the Applicant.
        enum:
        - initiated
        - notified
        - processed
        example: notified
        type: string
      label:
        description: Label of the Applicant.
        example: John Doe
        type: string
      reference_id:
        description: Unique applicant identifier as registered on your side.
        nullable: true
        type: string
        example: null
      created_at:
        description: Creation date of the Applicant.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      updated_at:
        description: Last update date of the Applicant.
        example: '2024-01-18T22:59:00Z'
        format: date-time
        type: string
      type:
        description: Type of the Applicant.
        enum:
        - natural_person
        - legal_person
        example: natural_person
        type: string
    required:
    - created_at
    - id
    - label
    - reference_id
    - status
    - type
    - updated_at
    - workflow_session_id
    - workflow_session_link_expires_at
    - workflow_session_link_url
    type: object
  ResolveWorkflowSessionAction_resource:
    properties:
      id:
        description: Unique ID of the resource used in the Workflow Session Action.
        example: 0ef334d2-7f36-4643-8a2a-4283b4a3e4a4
        format: uuid
        type: string
      type:
        description: The type of resource used in the Workflow Session Action.
        enum:
        - bank_account_verification
        - bank_account_connection_verification
        - bank_account_lookup_verification
        - business_registration_certificate_document_analysis
        - company_certificate_document_analysis
        - company_verification
        - driver_licence_document_analysis
        - identity_document_verification
        - identity_video_verification
        - proof_of_address_verification
        - rne_certificate_document_analysis
        - social_security_document_analysis
        - temporary_vehicle_registration_document_analysis
        - vehicle_registration_document_analysis
        - watchlist_verification
        - auto_insurance_claims_history_document_analysis
        - payslip_document_analysis
        - invoice_document_analysis
        example: bank_account_verification
        type: string
    required:
    - id
    - type
    type: object
  WorkflowTemplate_action_groups_inner:
    properties:
      type:
        description: Type of the Action Group.
        enum:
        - signature_request
        - identity_verification
        - proof_of_address_verification
        - company_verification
        - watchlist_verification
        - bank_account_verification
        - document_analysis
        example: identity_verification
        type: string
    required:
    - type
    type: object
  WorkflowTemplate_workspaces_inner:
    properties:
      id:
        description: Unique identifier of the Workspace.
        example: 0ef334d2-7f36-4643-8a2a-4283b4a3e4a4
        format: uuid
        type: string
    required:
    - id
    type: object
  Workspace_users_inner:
    properties:
      id:
        example: 89120884-d29a-4b1a-ac7b-a9e73a872795
        format: uuid
        readOnly: true
        type: string
    type: object
  FraudRiskAnalysis_indicators_inner:
    additionalProperties: false
    properties:
      indicator:
        description: Machine-readable identifier of the detected indicator.
        example: document_metadata_modified
        type: string
      type:
        description: Type of the indicator.
        example: metadata
        type: string
      category:
        description: Category the indicator belongs to.
        example: tampering
        type: string
      title:
        description: Human-readable title of the indicator.
        example: Document metadata has been modified
        type: string
      description:
        description: Human-readable description of the indicator.
        example: The document metadata shows signs of modification by an editing tool.
        type: string
    required:
    - category
    - description
    - indicator
    - title
    - type
    type: object
  InitiateSocialSecurity_checks:
    additionalProperties: false
    description: Checks to perform on the document.
    example:
      first_name: John
      last_name: Doe
    nullable: true
    properties:
      first_name:
        description: Expected first name extracted from the document.
        nullable: false
        type: string
      last_name:
        description: Expected last name extracted from the document.
        nullable: false
        type: string
    required:
    - first_name
    - last_name
    type: object
  InitiateCompanyCertificate_checks_legal_representatives_inner:
    properties:
      first_name:
        description: Expected first name extracted from the document.
        nullable: false
        type: string
      last_name:
        description: Expected last name extracted from the document.
        nullable: false
        type: string
    required:
    - first_name
    - last_name
    type: object
  InitiateCompanyCertificate_checks:
    additionalProperties: false
    description: Checks to perform on the document.
    example:
      legal_representatives:
      - first_name: John
        last_name: Doe
    nullable: true
    properties:
      legal_representatives:
        description: Expected list of legal representatives extracted from the document.
        items:
          $ref: '#/components/schemas/InitiateCompanyCertificate_checks_legal_representatives_inner'
        type: array
    required:
    - legal_representatives
    type: object
  InitiateTemporaryVehicleRegistrationDocument_checks_vehicle_owner:
    description: Expected vehicle owner information.
    properties:
      type:
        description: Type of the vehicle owner.
        enum:
        - natural_person
        - legal_person
        type: string
      first_name:
        description: Expected first name of the vehicle owner.
        nullable: false
        type: string
      last_name:
        description: Expected last name of the vehicle owner.
        nullable: false
        type: string
      company_name:
        description: Expected company name of the vehicle owner. Required when type
          is `legal_person`.
        nullable: false
        type: string
    required:
    - type
    type: object
  InitiateTemporaryVehicleRegistrationDocument_checks:
    additionalProperties: false
    description: Checks to perform on the document.
    example:
      vehicle_owner:
        type: natural_person
        first_name: John
        last_name: Doe
    nullable: true
    properties:
      vehicle_owner:
        $ref: '#/components/schemas/InitiateTemporaryVehicleRegistrationDocument_checks_vehicle_owner'
    required:
    - vehicle_owner
    type: object
  InitiateVehicleRegistrationDocument_checks_vehicle_owner:
    additionalProperties: false
    description: Vehicle owner information to check against the document.
    properties:
      type:
        description: Type of the vehicle owner.
        enum:
        - natural_person
        - legal_person
        type: string
      first_name:
        description: Expected first name of the vehicle owner. Required for natural
          persons.
        nullable: true
        type: string
      last_name:
        description: Expected last name of the vehicle owner. Required for natural
          persons.
        nullable: true
        type: string
      company_name:
        description: Expected company name of the vehicle owner. Required when type
          is `legal_person`.
        nullable: true
        type: string
    required:
    - first_name
    - last_name
    - type
    type: object
  InitiateVehicleRegistrationDocument_checks:
    additionalProperties: false
    description: Checks to perform on the document.
    example:
      vehicle_owner:
        type: natural_person
        first_name: John
        last_name: Doe
    nullable: true
    properties:
      vehicle_owner:
        $ref: '#/components/schemas/InitiateVehicleRegistrationDocument_checks_vehicle_owner'
    required:
    - vehicle_owner
    type: object
  InitiateAutoInsuranceClaimsHistory_checks_policy_holder:
    description: Expected policy holder information.
    properties:
      type:
        description: Type of the policy holder.
        enum:
        - natural_person
        - legal_person
        type: string
      first_name:
        description: Expected first name of the policy holder.
        nullable: false
        type: string
      last_name:
        description: Expected last name of the policy holder.
        nullable: false
        type: string
      company_name:
        description: Expected company name of the policy holder.
        nullable: false
        type: string
    required:
    - type
    type: object
  InitiateAutoInsuranceClaimsHistory_checks:
    additionalProperties: false
    description: Checks to perform on the document.
    example:
      policy_holder:
        type: natural_person
        first_name: John
        last_name: Doe
    nullable: true
    properties:
      policy_holder:
        $ref: '#/components/schemas/InitiateAutoInsuranceClaimsHistory_checks_policy_holder'
    required:
    - policy_holder
    type: object
  InitiateTaxNotice_checks_full_name_check:
    additionalProperties: false
    description: Expected full name to check against the document.
    properties:
      first_name:
        description: Expected first name to check against the document.
        nullable: false
        type: string
      last_name:
        description: Expected last name to check against the document.
        nullable: false
        type: string
    required:
    - first_name
    - last_name
    type: object
  InitiateTaxNotice_checks_income_year_check:
    additionalProperties: false
    description: Expected income year to check against the document.
    properties:
      income_year:
        description: Expected income year to check against the document.
        pattern: ^[0-9]{4}$
        type: string
    required:
    - income_year
    type: object
  InitiateTaxNotice_checks:
    additionalProperties: false
    description: Checks to perform on the document.
    example:
      full_name_check:
        first_name: John
        last_name: Doe
      income_year_check:
        income_year: '2024'
    nullable: true
    properties:
      full_name_check:
        $ref: '#/components/schemas/InitiateTaxNotice_checks_full_name_check'
      income_year_check:
        $ref: '#/components/schemas/InitiateTaxNotice_checks_income_year_check'
    type: object
  InitiatePayslip_checks_full_name_check:
    additionalProperties: false
    description: Expected full name to check against the document.
    properties:
      first_name:
        description: Expected first name to check against the document.
        type: string
      last_name:
        description: Expected last name to check against the document.
        type: string
    required:
    - first_name
    - last_name
    type: object
  InitiatePayslip_checks:
    additionalProperties: false
    description: Checks to perform on the document.
    example:
      full_name_check:
        first_name: Marie
        last_name: Dupont
    nullable: true
    properties:
      full_name_check:
        $ref: '#/components/schemas/InitiatePayslip_checks_full_name_check'
    type: object
  InitiateFraudOnly_analysis_type:
    additionalProperties: false
    properties:
      extraction:
        description: Must be `"false"` for a fraud-only analysis.
        enum:
        - 'false'
        example: 'false'
        type: string
      fraud_level:
        description: Must be `advanced` for a fraud-only analysis.
        enum:
        - advanced
        example: advanced
        type: string
    required:
    - extraction
    - fraud_level
    type: object
  CompanyCertificateExtraction_legal_representatives_inner:
    properties:
      type:
        description: Type of the legal representative extracted from the list of legal
          representatives in the document.
        enum:
        - natural_person
        - legal_person
        type: string
      function:
        description: Function of the individual extracted from the list of legal representatives
          in the document.
        nullable: true
        type: string
      first_name:
        description: First name of the individual extracted from the list of legal
          representatives in the document.
        nullable: true
        type: string
      last_name:
        description: Last name of the individual extracted from the list of legal
          representatives in the document.
        nullable: true
        type: string
      full_name:
        description: Full name of the individual extracted from the list of legal
          representatives in the document.
        nullable: true
        type: string
      company_name:
        description: Company name extracted from the list of legal representatives
          in the document.
        nullable: true
        type: string
      company_number:
        description: Company number extracted from the list of legal representatives
          in the document.
        nullable: true
        type: string
    required:
    - company_name
    - company_number
    - first_name
    - full_name
    - function
    - last_name
    - type
    type: object
  CompanyCertificateCheck_legal_representatives_inner:
    properties:
      full_name:
        $ref: '#/components/schemas/DocumentAnalysisCheck'
    required:
    - full_name
    type: object
  BusinessRegistrationCertificateExtraction_company_description:
    properties:
      active:
        description: Indicates whether the company is active or not.
        nullable: true
        type: boolean
      legal_form:
        description: Legal form extracted from the document.
        nullable: true
        type: string
      company_name:
        description: Company name extracted from the document.
        nullable: true
        type: string
      company_number:
        description: Company number extracted from the document.
        nullable: true
        type: string
      headquarter_company_number:
        description: Headquarter company number extracted from the document.
        nullable: true
        type: string
      first_name:
        description: First name of the individual extracted from the document. Null
          if not a sole proprietor.
        nullable: true
        type: string
      last_name:
        description: Last name of the individual extracted from the document. Null
          if not a sole proprietor.
        nullable: true
        type: string
      full_name:
        description: Full name of the individual extracted from the document. Null
          if not a sole proprietor.
        nullable: true
        type: string
    required:
    - active
    - company_name
    - company_number
    - first_name
    - full_name
    - headquarter_company_number
    - last_name
    - legal_form
    type: object
  BusinessRegistrationCertificateExtraction_branch_description:
    properties:
      address:
        description: Address extracted from the document.
        nullable: true
        type: string
      city:
        description: City extracted from the document.
        nullable: true
        type: string
      postal_code:
        description: Postal code extracted from the document.
        nullable: true
        type: string
      active:
        description: Indicates whether the branch is active or not.
        nullable: true
        type: boolean
      branch_company_number:
        description: Branch company number extracted from the document.
        nullable: true
        type: string
    required:
    - active
    - address
    - branch_company_number
    - city
    - postal_code
    type: object
  TemporaryVehicleRegistrationDocumentExtraction_vehicle_owner_information:
    description: Vehicle owner information extracted from the document.
    properties:
      vehicle_owner_full_name:
        description: Full name of the vehicle owner extracted from the document.
        nullable: true
        type: string
      vehicle_owner_birth_date:
        description: Birth date of the vehicle owner extracted from the document.
        nullable: true
        type: string
      vehicle_owner_address:
        description: Address of the vehicle owner extracted from the document.
        nullable: true
        type: string
    required:
    - vehicle_owner_address
    - vehicle_owner_birth_date
    - vehicle_owner_full_name
    type: object
  TemporaryVehicleRegistrationDocumentExtraction_document_recipient_information:
    description: Document recipient information extracted from the document.
    properties:
      document_recipient_full_name:
        description: Full name of the document recipient extracted from the document.
        nullable: true
        type: string
      document_recipient_address:
        description: Address of the document recipient extracted from the document.
        nullable: true
        type: string
      document_recipient_birth_date:
        description: Birth date of the document recipient extracted from the document.
        nullable: true
        type: string
      document_recipient_birth_city:
        description: Birth city of the document recipient extracted from the document.
        nullable: true
        type: string
    required:
    - document_recipient_address
    - document_recipient_birth_city
    - document_recipient_birth_date
    - document_recipient_full_name
    type: object
  TemporaryVehicleRegistrationDocumentCheck_vehicle_owner:
    additionalProperties: false
    description: Check result for the vehicle owner.
    properties:
      owner_name:
        $ref: '#/components/schemas/DocumentAnalysisCheck'
    required:
    - owner_name
    type: object
  FrenchVehicleRegistrationDocumentExtraction_owner_information:
    additionalProperties: false
    properties:
      owner_full_name:
        description: Full name of the vehicle owner.
        nullable: true
        type: string
      owner_address:
        description: Address of the vehicle owner.
        nullable: true
        type: string
      owner_type:
        description: Type of the vehicle owner.
        enum:
        - natural_person
        - legal_person
        nullable: true
        type: string
    required:
    - owner_address
    - owner_full_name
    - owner_type
    type: object
  FrenchVehicleRegistrationDocumentExtraction_co_owner_information_inner:
    additionalProperties: false
    properties:
      co_owner_full_name:
        description: Full name of the co-owner.
        nullable: true
        type: string
    required:
    - co_owner_full_name
    type: object
  FrenchVehicleRegistrationDocumentExtraction_vehicle_information:
    additionalProperties: false
    properties:
      vehicle_brand:
        description: Brand of the vehicle.
        nullable: true
        type: string
      vehicle_version:
        description: Version of the vehicle.
        nullable: true
        type: string
      vehicle_model:
        description: Model of the vehicle.
        nullable: true
        type: string
    required:
    - vehicle_brand
    - vehicle_model
    - vehicle_version
    type: object
  FrenchVehicleRegistrationDocumentExtraction_vehicle_motor_information:
    additionalProperties: false
    properties:
      vehicle_fuel_type:
        description: Type of fuel used by the vehicle.
        nullable: true
        type: string
      vehicle_fiscal_power:
        description: Fiscal power of the vehicle.
        nullable: true
        type: number
      vehicle_max_power:
        description: Maximum power of the vehicle engine.
        nullable: true
        type: number
      vehicle_power:
        description: Power of the vehicle engine.
        nullable: true
        type: number
    required:
    - vehicle_fiscal_power
    - vehicle_fuel_type
    - vehicle_max_power
    - vehicle_power
    type: object
  ItalianVehicleRegistrationDocumentExtraction_owner_information:
    additionalProperties: false
    properties:
      owner_full_name:
        description: Full name of the vehicle owner.
        nullable: true
        type: string
      owner_address:
        description: Address of the vehicle owner.
        nullable: true
        type: string
      owner_type:
        description: Type of the vehicle owner.
        enum:
        - natural_person
        - legal_person
        nullable: true
        type: string
      owner_birth_date:
        description: Birth date of the vehicle owner.
        format: date
        nullable: true
        type: string
    required:
    - owner_address
    - owner_birth_date
    - owner_full_name
    - owner_type
    type: object
  ItalianVehicleRegistrationDocumentExtraction_deed_informations_inner:
    additionalProperties: false
    properties:
      deed_date:
        description: Date of the deed.
        nullable: true
        type: string
      deed_type:
        description: Type of the deed.
        nullable: true
        type: string
      liens_encumbrances:
        description: Liens or encumbrances on the vehicle.
        nullable: true
        type: string
      previous_owner_full_name:
        description: Full name of the previous owner.
        nullable: true
        type: string
    required:
    - deed_date
    - deed_type
    - liens_encumbrances
    - previous_owner_full_name
    type: object
  ItalianVehicleRegistrationDocumentExtraction_vehicle_motor_information:
    additionalProperties: false
    properties:
      vehicle_fuel_type:
        description: Type of fuel used by the vehicle.
        nullable: true
        type: string
      vehicle_max_power:
        description: Maximum power of the vehicle engine.
        nullable: true
        type: number
      vehicle_displacement_type:
        description: Displacement type of the vehicle engine.
        nullable: true
        type: number
    required:
    - vehicle_displacement_type
    - vehicle_fuel_type
    - vehicle_max_power
    type: object
  AutoInsuranceClaimsHistoryExtraction_drivers_information_inner:
    additionalProperties: false
    properties:
      driver_full_name:
        description: Full name of the driver.
        nullable: true
        type: string
      driver_birth_date:
        description: Birth date of the driver.
        format: date
        nullable: true
        type: string
      coverage_start_date:
        description: Start date of the driver's coverage.
        format: date
        nullable: true
        type: string
      coverage_end_date:
        description: End date of the driver's coverage, if applicable.
        format: date
        nullable: true
        type: string
      driver_license_number:
        description: License number of the driver.
        nullable: true
        type: string
      driver_license_category:
        description: License category of the driver.
        nullable: true
        type: string
      driver_license_issuance_date:
        description: Issuance date of the driver's license.
        format: date
        nullable: true
        type: string
    required:
    - coverage_end_date
    - coverage_start_date
    - driver_birth_date
    - driver_full_name
    - driver_license_category
    - driver_license_issuance_date
    - driver_license_number
    type: object
  AutoInsuranceClaimsHistoryExtraction_incidents_information_inner:
    additionalProperties: false
    properties:
      incident_date:
        description: Date of the incident.
        format: date
        nullable: true
        type: string
      incident_description:
        description: Description of the incident.
        nullable: true
        type: string
      incident_type:
        description: Type of the incident.
        nullable: true
        type: string
      incident_responsability:
        description: Responsibility level for the incident.
        nullable: true
        type: string
      drivers_full_name:
        description: Full name of the driver involved in the incident.
        nullable: true
        type: string
    required:
    - drivers_full_name
    - incident_date
    - incident_description
    - incident_responsability
    - incident_type
    type: object
  AutoInsuranceClaimsHistoryCheck_policy_holder:
    additionalProperties: false
    description: Check result for the policy holder.
    properties:
      owner_name:
        $ref: '#/components/schemas/DocumentAnalysisCheck'
    required:
    - owner_name
    type: object
  TaxNoticeExtraction_2d_doc:
    additionalProperties: false
    description: The 2D document extracted from the document.
    nullable: false
    properties:
      full_name_1:
        description: The holder full name of the first declarant extracted from the
          2D document.
        example: Doe John
        nullable: true
        type: string
      fiscal_number_1:
        description: The fiscal number of the first declarant extracted from the 2D
          document.
        example: 0312345678901
        nullable: true
        type: string
      full_name_2:
        description: The holder full name of the second declarant extracted from the
          2D document.
        example: Doe Jane
        nullable: true
        type: string
      fiscal_number_2:
        description: The fiscal number of the second declarant extracted from the
          2D document.
        example: 0398765432109
        nullable: true
        type: string
      tax_notice_reference:
        description: The tax notice reference number extracted from the 2D document.
        example: 2412B01234567
        nullable: true
        type: string
      income_year:
        description: Year of incomes (usually the year before document issuance) extracted
          from the 2D document.
        example: 2024
        nullable: true
        type: integer
      reference_income:
        description: The fiscal reference income extracted from the 2D document.
        example: 30000
        nullable: true
        type: integer
      parts_count:
        description: Number of parts in the household extracted from the 2D document.
        example: 1
        nullable: true
        type: integer
    required:
    - fiscal_number_1
    - fiscal_number_2
    - full_name_1
    - full_name_2
    - income_year
    - parts_count
    - reference_income
    - tax_notice_reference
    type: object
  TaxNoticeCheck_income_year:
    additionalProperties: false
    example:
      extracted: 2024
      expected: 2024
      match_level: exact
    properties:
      extracted:
        description: The extracted value from the document.
        nullable: true
        type: integer
      expected:
        description: The expected value for the check.
        type: integer
      match_level:
        $ref: '#/components/schemas/DocumentAnalysisMatchLevel'
    required:
    - expected
    - extracted
    - match_level
    type: object
  CreateElectronicSealFieldSealPayload_captions_inner:
    additionalProperties: false
    properties:
      text:
        description: The caption text to display on the seal image.
        maxLength: 150
        type: string
    required:
    - text
    type: object
  SignatureRequest_SignerFromInfoInput_info:
    additionalProperties: false
    description: create new signer
    properties:
      first_name:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        example: John
        maxLength: 255
        minLength: 1
        type: string
      last_name:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        example: Doe
        maxLength: 255
        minLength: 1
        type: string
      email:
        format: email
        maxLength: 100
        minLength: 1
        type: string
      phone_number:
        description: E.164 format. Becomes mandatory if `signature_authentication_mode`
          requires a phone number.
        example: '+41446667700'
        minLength: 1
        nullable: true
        type: string
      locale:
        $ref: '#/components/schemas/Locale'
    required:
    - email
    - first_name
    - last_name
    - locale
    type: object
  SignatureRequest_SignerFromInfoInput_redirect_urls:
    additionalProperties: false
    properties:
      success:
        example: https://example.com/success
        format: uri
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      error:
        example: https://example.com/error
        format: uri
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
    type: object
  SignatureRequest_SignerFromInfoInput_custom_text:
    additionalProperties: false
    properties:
      request_subject:
        maxLength: 512
        minLength: 1
        nullable: true
        type: string
      request_body:
        maxLength: 2000
        minLength: 1
        nullable: true
        type: string
      reminder_subject:
        maxLength: 512
        minLength: 1
        nullable: true
        type: string
      reminder_body:
        maxLength: 2000
        minLength: 1
        nullable: true
        type: string
    type: object
  SignatureRequest_EmailNotification_custom_text:
    additionalProperties: false
    nullable: true
    properties:
      request_subject:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.
        format: safe-string
        maxLength: 512
        minLength: 1
        nullable: true
        type: string
      request_body:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.
        format: safe-string
        maxLength: 2000
        minLength: 1
        nullable: true
        type: string
      reminder_subject:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.
        format: safe-string
        maxLength: 512
        minLength: 1
        nullable: true
        type: string
      reminder_body:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email and leading or trailing whitespaces.
        format: safe-string
        maxLength: 2000
        minLength: 1
        nullable: true
        type: string
    type: object
  SignatureRequest_PlaceholderSignerSubstituteFromInfoInput_info:
    additionalProperties: false
    description: Create new signer
    properties:
      first_name:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        example: John
        maxLength: 255
        minLength: 1
        type: string
      last_name:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        example: Doe
        maxLength: 255
        minLength: 1
        type: string
      email:
        format: email
        maxLength: 100
        minLength: 1
        type: string
      phone_number:
        description: E.164 format. Becomes mandatory if `signature_authentication_mode`
          requires a phone number.
        example: '+41446667700'
        minLength: 1
        nullable: true
        type: string
      locale:
        $ref: '#/components/schemas/Locale'
    required:
    - email
    - first_name
    - last_name
    - locale
    type: object
  SignatureRequest_PlaceholderSignerSubstituteFromInfoInput_redirect_urls:
    additionalProperties: false
    properties:
      success:
        example: https://example.com/success
        format: uri
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      error:
        example: https://example.com/error
        format: uri
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
      decline:
        example: https://example.com/decline
        format: uri
        maxLength: 255
        minLength: 1
        nullable: true
        type: string
    type: object
  SignatureDisplay_oneOf:
    properties:
      layout:
        description: '• `minimal` (default): Only shows the signer’s signature visual.

          • `detailed`: Adds extra detail to the signature field, including the signer’s
          full name, email, and the date of signature.

          '
        enum:
        - minimal
        - legacy
        type: string
    required:
    - layout
    type: object
  SignatureDisplay_oneOf_1_options:
    description: Only applicable when `display.layout = detailed`.
    properties:
      date_format:
        $ref: '#/components/schemas/CreateFieldDateFormat'
      time_format:
        $ref: '#/components/schemas/CreateFieldTimeFormat'
      show_timezone:
        default: false
        description: Boolean indicating whether to display the timezone abbreviation
          (e.g., `CEST`) next to the time.
        nullable: true
        type: boolean
      show_email:
        default: true
        description: Boolean indicating whether to display the signer's email address.
        nullable: false
        type: boolean
    type: object
  SignatureDisplay_oneOf_1:
    properties:
      layout:
        description: '• `minimal` (default): Only shows the signer’s signature visual.

          • `detailed`: Adds extra detail to the signature field, including the signer’s
          full name, email, and the date of signature.

          '
        enum:
        - detailed
        type: string
      options:
        $ref: '#/components/schemas/SignatureDisplay_oneOf_1_options'
    required:
    - layout
    - options
    type: object
  Minimal_layout:
    properties:
      layout:
        description: '`minimal` (default): Only shows the signer’s signature visual.

          `detailed`: Adds extra detail to the signature field, including the signer’s
          full name, email, and the date of signature.

          '
        enum:
        - minimal
        type: string
    required:
    - layout
    title: Minimal layout
    type: object
  Detailed_layout:
    example:
      layout: detailed
      options:
        date_format: dd/MM/yyyy
        time_format: HH:mm
        show_timezone: true
        show_email: false
    properties:
      layout:
        description: '`minimal` (default): Only shows the signer’s signature visual.

          `detailed`: Adds extra detail to the signature field, including the signer’s
          full name, email, and the date of signature.

          '
        enum:
        - detailed
        type: string
      options:
        $ref: '#/components/schemas/SignatureDisplay_oneOf_1_options'
    required:
    - layout
    - options
    title: Detailed layout
    type: object
  Signature_2:
    properties:
      document_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      type:
        enum:
        - signature
        type: string
      page:
        format: int32
        minimum: 1
        type: integer
      x:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      y:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      height:
        description: Default value is 37
        format: int32
        maximum: 1000
        minimum: 37
        type: integer
      width:
        description: Default value is 85
        format: int32
        maximum: 2000
        minimum: 85
        type: integer
      reason:
        allOf:
        - $ref: '#/components/schemas/HumanName'
        description: 'Provide extra context to explain why the Document is being signed.
          Once the Document is signed, the custom reason is stored in the Audit Trail
          and is included in the signature certificate.

          The default value is: "Signed by [Signer first name] [Signer last name]".

          '
        example: Signed by John Doe
        maxLength: 150
        nullable: true
        type: string
    required:
    - document_id
    - page
    - type
    - x
    - y
    title: Signature
    type: object
  Mention_2:
    properties:
      document_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      type:
        enum:
        - mention
        type: string
      page:
        format: int32
        minimum: 1
        type: integer
      x:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      y:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      width:
        description: If not set, the width is automatically calculated with the mention
          length
        format: int32
        minimum: 24
        type: integer
      height:
        description: The height must be 24 or a multiple of 15 greater than 24. If
          height is not provided, it will be calculated depending on the number of
          newlines in the mention
        example: 150
        format: int32
        minimum: 24
        nullable: true
        type: integer
      mention:
        description: This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string)
          allowing email.
        format: safe-string
        type: string
      name:
        description: Name of the Field.
        example: Job Title
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
    required:
    - document_id
    - mention
    - page
    - type
    - x
    - y
    title: Mention
    type: object
  Text_2:
    properties:
      document_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      type:
        enum:
        - text
        type: string
      page:
        format: int32
        minimum: 1
        type: integer
      x:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      y:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      width:
        description: If not set, the width is automatically calculated with the max_length
          value
        example: 90
        format: int32
        minimum: 24
        type: integer
      height:
        description: The height must be 24 or a multiple of 15 greater than 24.
        example: 150
        format: int32
        minimum: 24
        type: integer
      max_length:
        maximum: 32767
        minimum: 1
        type: integer
      question:
        example: What is your job title?
        maxLength: 255
        type: string
      instruction:
        example: Your position in the company
        nullable: true
        type: string
      optional:
        type: boolean
      name:
        description: Name of the Field.
        example: Job Title
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      default_value:
        description: If a default value is provided, the Field will be pre-filled
          with this value. The Signer can modify it before signing unless the Field
          is set to `read-only`.
        example: Software Engineer
        maxLength: 32767
        minLength: 1
        nullable: true
        type: string
      read_only:
        default: false
        description: If set to `true`, the Signer cannot modify the Field and the
          default value (if provided) will remain unchanged.
        type: boolean
    required:
    - document_id
    - max_length
    - optional
    - page
    - question
    - type
    - x
    - y
    title: Text
    type: object
  Checkbox_2:
    properties:
      document_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      type:
        enum:
        - checkbox
        type: string
      page:
        format: int32
        minimum: 1
        type: integer
      x:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      y:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      size:
        description: The omission of size parameter is considered as deprecated. The
          size determines both the width and height of the checkbox.
        format: int32
        maximum: 240
        minimum: 8
        type: integer
      optional:
        type: boolean
      name:
        example: Checkbox 1
        nullable: true
        type: string
      checked:
        type: boolean
      default_checked:
        type: boolean
      read_only:
        default: false
        description: If set to `true`, the checkbox cannot be modified by the signer.
        type: boolean
    required:
    - checked
    - document_id
    - optional
    - page
    - type
    - x
    - y
    title: Checkbox
    type: object
  RadioGroup_2_radios_inner:
    properties:
      name:
        description: Radio button's name
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      x:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      y:
        format: int32
        maximum: 32767
        minimum: 0
        type: integer
      size:
        description: The omission of size parameter is considered as deprecated. The
          size determines both the width and height of the checkbox.
        format: int32
        maximum: 240
        minimum: 8
        type: integer
      default_checked:
        default: false
        description: Indicates whether the radio is initially checked (`true`) or
          unchecked (`false`).
        type: boolean
    required:
    - x
    - y
    type: object
  RadioGroup_2:
    properties:
      document_id:
        example: 9b6ed2f3-244f-487a-baa1-bbe4f51c8748
        format: uuid
        type: string
      type:
        enum:
        - radio_group
        type: string
      page:
        format: int32
        minimum: 1
        type: integer
      optional:
        type: boolean
      name:
        description: Radio group's name
        example: radio_group_name_1
        maxLength: 128
        minLength: 1
        nullable: true
        type: string
      read_only:
        default: false
        description: If set to `true`, the radio button cannot be modified by the
          Signer.
        type: boolean
      radios:
        items:
          $ref: '#/components/schemas/RadioGroup_2_radios_inner'
        type: array
    required:
    - document_id
    - optional
    - page
    - radios
    - type
    title: RadioGroup
    type: object
  OTP_Message:
    properties:
      custom_text:
        description: 'Custom text contained is the one-time password SMS sent to the
          Signer. This feature is available from SCALE plan, and disabled by default.
          Please contact [customer support](https://yousign.app/auth/workspace/help)
          to request an activation. This value is a string composed of GSM characters
          supported by 7-bit encoding, must contain "{code}", the length must be less
          than 105 and cannot contain URL, email, phone number and IP address.\

          This property is a [Safe String](https://developers.yousign.com/reference/oas-specification#safe-string).

          '
        format: safe-string
        minLength: 1
        type: string
    required:
    - custom_text
    title: OTP Message
    type: object