find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/signdocs-com-br:signdocs-com-br-document-groups-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Signdocs Com Br Document Groups API
  version: 1.4.0
  contact:
    name: SignDocs Brasil API Support
    email: suporte@signdocs.com.br
  license:
    name: Proprietary
    url: https://www.signdocs.com.br/termos-de-uso.html
  description: 'Operations tagged DocumentGroups across 2 of this provider''s published API definitions: openapi.yaml, signdocs-com-br-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.signdocs.com.br
  description: Produção
- url: https://api-hml.signdocs.com.br
  description: Homologação
- url: https://mtls-api.signdocs.com.br
  description: Produção (mTLS)
- url: https://mtls-api-hml.signdocs.com.br
  description: Homologação (mTLS)
security:
- bearerJwt: []
tags:
- name: Document Groups
  description: Operações em grupos de documentos com múltiplos signatários.
paths:
  /v1/document-groups/{groupId}/combined-stamp:
    post:
      operationId: generateCombinedStamp
      tags:
      - Document Groups
      summary: Gerar carimbo combinado do grupo
      description: 'Gera o documento com carimbo visual combinado para todas as assinaturas do grupo de documentos (PDF: carimbo visual; outros formatos: .p7s combinado).

        Retorna URL pré-assinada para download do PDF gerado.


        Requer scope `transactions:write`.'
      security:
      - bearerJwt: []
      parameters:
      - name: groupId
        in: path
        required: true
        description: Identificador do grupo de documentos.
        schema:
          type: string
      responses:
        '200':
          description: Carimbo combinado gerado com sucesso.
          headers:
            Strict-Transport-Security:
              $ref: '#/components/headers/Strict-Transport-Security'
            X-Content-Type-Options:
              $ref: '#/components/headers/X-Content-Type-Options'
            X-Frame-Options:
              $ref: '#/components/headers/X-Frame-Options'
            Referrer-Policy:
              $ref: '#/components/headers/Referrer-Policy'
            Cache-Control:
              $ref: '#/components/headers/Cache-Control'
            API-Version:
              $ref: '#/components/headers/API-Version'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CombinedStampResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    servers:
    - url: https://api.signdocs.com.br
      description: Produção
    - url: https://api-hml.signdocs.com.br
      description: Homologação
    - url: https://mtls-api.signdocs.com.br
      description: Produção (mTLS)
    - url: https://mtls-api-hml.signdocs.com.br
      description: Homologação (mTLS)
components:
  headers:
    Cache-Control:
      description: Controle de cache.
      schema:
        type: string
        example: no-store
    API-Version:
      description: Versão da API.
      schema:
        type: string
        example: '1.0'
    X-Content-Type-Options:
      description: Prevenção de MIME sniffing.
      schema:
        type: string
        example: nosniff
    Referrer-Policy:
      description: Política de referrer.
      schema:
        type: string
        example: strict-origin-when-cross-origin
    Strict-Transport-Security:
      description: Política HSTS.
      schema:
        type: string
        example: max-age=31536000; includeSubDomains
    X-Frame-Options:
      description: Prevenção de clickjacking.
      schema:
        type: string
        example: DENY
  responses:
    NotFound:
      description: Recurso não encontrado.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
          example:
            type: https://api.signdocs.com.br/errors/not-found
            title: Not Found
            status: 404
            detail: Transaction not found
    Conflict:
      description: Conflito de estado — a operação não pode ser realizada no estado atual do recurso.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
          example:
            type: https://api.signdocs.com.br/errors/conflict
            title: Conflict
            status: 409
            detail: Transaction already finalized
    Forbidden:
      description: 'Permissões insuficientes para a operação solicitada.


        Inclui `purpose: "ACTION_AUTHENTICATION"` sem `featureFlags.trustSessionsEnabled`. A

        verificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,

        `/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.

        O remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.

        '
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
          example:
            type: https://api.signdocs.com.br/errors/forbidden
            title: Forbidden
            status: 403
            detail: Insufficient permissions
    Unauthorized:
      description: Autenticação ausente ou inválida.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
          example:
            type: https://api.signdocs.com.br/errors/unauthorized
            title: Unauthorized
            status: 401
            detail: Invalid or missing authentication
    InternalServerError:
      description: Erro interno do servidor.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
          example:
            type: https://api.signdocs.com.br/errors/internal-server-error
            title: Internal Server Error
            status: 500
  schemas:
    CombinedStampResponse:
      type: object
      description: Resposta de geração de carimbo combinado.
      required:
      - groupId
      - signerCount
      - downloadUrl
      - expiresIn
      properties:
        groupId:
          type: string
        signerCount:
          type: integer
          description: Número de signatários incluídos no carimbo.
        downloadUrl:
          type: string
          format: uri
          description: URL pré-assinada para download do documento com carimbo combinado.
        expiresIn:
          type: integer
          description: Tempo de expiração da URL em segundos.
          example: 3600
    ProblemDetail:
      type: object
      description: Formato de erro RFC 7807 Problem Details.
      required:
      - type
      - title
      - status
      properties:
        type:
          type: string
          format: uri
          description: URI que identifica o tipo de erro.
          example: https://api.signdocs.com.br/errors/bad-request
        title:
          type: string
          description: Resumo legível do tipo de erro.
          example: Bad Request
        status:
          type: integer
          description: Código de status HTTP.
          example: 400
        detail:
          type: string
          description: Explicação específica da ocorrência do erro.
          example: O campo 'purpose' é obrigatório.
        instance:
          type: string
          description: URI que identifica a ocorrência específica do erro (path da requisição).
          example: /v1/transactions
        code:
          type: string
          description: 'Código estável e legível por máquina para o caso específico, quando houver (ex.:

            `SIGNER_TURN`, `TIMESTAMP_UNAVAILABLE`). Prefira tratar o erro por `code` a interpretar `detail`.

            '
          example: TIMESTAMP_UNAVAILABLE
        retryable:
          type: boolean
          description: Presente quando a API afirma que reenviar a mesma requisição é seguro.
      additionalProperties: true
  securitySchemes:
    bearerJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token de acesso OAuth2 obtido via `POST /oauth2/token`.
    embedToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Token de sessão (clientSecret) retornado por `POST /v1/signing-sessions`.

        Usado pelos endpoints advance/get/resend-otp para autenticar a sessão.

        Contém claims: sub (sessionId), tenantId, transactionId, purpose: signing_session_embed.

        '
x-refined-from:
- openapi.yaml
- signdocs-com-br-openapi.yaml