> ## Documentation Index
> Fetch the complete documentation index at: https://docs.salvy.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Simular assinatura do termo

> Simula a assinatura de um termo pelo colaborador: o termo passa para `signed`, o PDF assinado fica disponível e o webhook `asset-statement.signed` é disparado. Disponível apenas no ambiente sandbox.



## OpenAPI

````yaml api-reference/v3/openapi.json POST /api/v3/asset-statements/{id}/simulate-signature
openapi: 3.1.0
info:
  version: v3
  title: Salvy API
  x-logo:
    url: web/logo.png
servers:
  - url: https://api.salvy.com.br
    description: Salvy API URL
security:
  - bearerAuth: []
tags:
  - name: Public API
  - name: Outgoing Webhooks
paths:
  /api/v3/asset-statements/{id}/simulate-signature:
    post:
      tags:
        - Public API
      description: >-
        Simula a assinatura de um termo pelo colaborador: o termo passa para
        `signed`, o PDF assinado fica disponível e o webhook
        `asset-statement.signed` é disparado. Disponível apenas no ambiente
        sandbox.
      operationId: publicSimulateAssetStatementSignatureV3
      parameters:
        - name: id
          in: path
          required: true
          schema:
            $schema: https://json-schema.org/draft/2020-12/schema
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  id:
                    description: Identificador do termo na plataforma Salvy.
                    example: 123e4567-e89b-12d3-a456-426614174000
                    title: UUID
                    type: string
                    examples:
                      - 123e4567-e89b-12d3-a456-426614174000
                      - 123e4567-e89b-12d3-a456-426614174001
                  companyId:
                    description: ID da empresa dona do termo.
                    example: 123e4567-e89b-12d3-a456-426614174000
                    title: UUID
                    type: string
                    examples:
                      - 123e4567-e89b-12d3-a456-426614174000
                      - 123e4567-e89b-12d3-a456-426614174001
                  type:
                    type: string
                    enum:
                      - responsibility
                      - return
                    description: >-
                      Tipo do termo: `responsibility` (termo de
                      responsabilidade, na entrega dos equipamentos) ou `return`
                      (termo de devolução).
                    example: responsibility
                  status:
                    type: string
                    enum:
                      - pending-signature
                      - signed
                      - canceled
                    description: >-
                      Situação do termo. `pending-signature` enquanto o
                      colaborador não assina, `signed` depois de assinado e
                      `canceled` quando cancelado ou substituído por um termo
                      mais novo.
                    example: signed
                  employeeId:
                    description: ID do colaborador que assina o termo.
                    example: 123e4567-e89b-12d3-a456-426614174000
                    title: UUID
                    type: string
                    examples:
                      - 123e4567-e89b-12d3-a456-426614174000
                      - 123e4567-e89b-12d3-a456-426614174001
                  assetIds:
                    type: array
                    items:
                      title: UUID
                      type: string
                      description: A valid UUID string, in any version.
                      examples:
                        - 123e4567-e89b-12d3-a456-426614174000
                        - 123e4567-e89b-12d3-a456-426614174001
                    description: IDs dos equipamentos listados no termo.
                    example:
                      - 123e4567-e89b-12d3-a456-426614174000
                  createdAt:
                    type: string
                    format: date-time
                    pattern: >-
                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                    description: Data de envio do termo para assinatura.
                    example: '2025-01-01T00:00:00.000Z'
                  signedAt:
                    anyOf:
                      - type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                      - type: 'null'
                    description: >-
                      Data de assinatura. Nulo enquanto o termo não foi
                      assinado.
                    example: '2025-01-02T00:00:00.000Z'
                  canceledAt:
                    anyOf:
                      - type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                      - type: 'null'
                    description: >-
                      Data de cancelamento. Nulo quando o termo não foi
                      cancelado.
                    example: null
                  cancelReason:
                    anyOf:
                      - type: string
                        enum:
                          - client-request
                          - replaced-by-new-document
                          - content-outdated
                          - signer-refused
                      - type: 'null'
                    description: >-
                      Motivo do cancelamento: `replaced-by-new-document` quando
                      um termo de responsabilidade mais novo foi enviado para
                      algum dos mesmos equipamentos, `content-outdated` quando
                      um equipamento do termo de responsabilidade passou para
                      outro colaborador antes da assinatura, `client-request`
                      quando a empresa cancelou o termo e `signer-refused`
                      quando o colaborador recusou a assinatura. Nulo quando o
                      termo não foi cancelado.
                    example: null
                  replacedById:
                    anyOf:
                      - title: UUID
                        type: string
                        description: A valid UUID string, in any version.
                        examples:
                          - 123e4567-e89b-12d3-a456-426614174000
                          - 123e4567-e89b-12d3-a456-426614174001
                      - type: 'null'
                    description: >-
                      ID do termo que substituiu este. Nulo quando o termo não
                      foi substituído.
                    example: null
                required:
                  - id
                  - companyId
                  - type
                  - status
                  - employeeId
                  - assetIds
                  - createdAt
                  - signedAt
                  - canceledAt
                  - cancelReason
                  - replacedById
                additionalProperties: false
        '401':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - unauthorized
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '403':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - forbidden
                      - insufficient-scope
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - resource-not-found
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '413':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - payload-too-large
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '422':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - input-validation-error
                      - unprocessable-entity
                      - asset-statement-signature-simulation-invalid
                      - company-not-active
                  message:
                    type: string
                  details:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        message:
                          type: string
                      required:
                        - key
                        - message
                      additionalProperties: false
                required:
                  - code
                  - message
                additionalProperties: {}
        '429':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - too-many-attempts
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - unknown
                  message:
                    type: string
                required:
                  - code
                  - message
                additionalProperties: {}
      deprecated: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.