Nossa documentação de ciclo de vida lista todas as alterações introduzidas por uma versão de API. Use-as para verificar se sua integração é compatível com uma versão de API e quais alterações você pode precisar fazer antes de migrar sua integração.

Todas as atualizações dos serviços serão reportadas nesse portal quando necessário, que podem envolver: novas rotas, novas versões de API, depreciações e descontinuações, etc.

Documentação completa das apis: Introdução

Após a depreciação de uma API é recomendado que as integrações atualizem suas implementações para obter mais desempenho e segurança. Sendo assim, sempre que se deparar com a expressão depreciada/deprecated dentro desta documentação (ou Swagger), saiba que esta rota será descontinuada em breve. Rotas depreciadas permanecerão funcionais por no mínimo 12 meses. Após esse período poderão ser inativadas.

A lista abaixo contém as rotas/ APIs que serão desativadas a partir de 01/11/26 em diante; é importante que todos os produtos se programem para evitar impactos nos clientes!

DescriçãoAPI/ ServiçoRota depreciadaRota atualDepreciada emDescontinua emObservações

Autenticação de usuário integrador

IdentityIntegration

POST

/v2/auth/login

POST

/identityintegration/v3/auth/login

21/08/25

21/08/26

(Breaking Change) Rota depreciada devido a nova regra incluída que considera o parâmetro de obrigatoriedade de autenticação por SSO para realização do login. Caso o parâmetro esteja ativo, não será possível usuários comuns se autenticarem via rota de integração.


A configuração de permissões dos Usuários de Serviço pode ajudar a contornar essa quebra de fluxo.

Obter dados do usuário(por id e por email)
IdentityIntegration

GET

/v1/administrators/user

GET

/identityintegration/v2/administrators/user

19/05/25

19/05/26


Manipulação de anexos da publicação
SignIntegration 

GET

/v2/Anexos/{idArquivo}

GET

/documents/v1/publicacoes/{idDocumento}/anexos

10/02/25

10/02/26


Manipulação de anexos da publicaçãoSignIntegration

POST

/v2/Anexos/{idArquivo}

POST

/documents/v1/publicacoes/{idDocumento}/anexos

10/02/25

10/02/26


Manipulação de anexos da publicaçãoSignIntegration

GET

/v2/Anexos/download/{idFileStream}

GET

/documents/v1/publicacoes/{idDocumento}/anexos/{idAnexo}

10/02/25

10/02/26


Manipulação de anexos da publicaçãoSignIntegration

DELETE

/v2/Anexos/{idAnexo}

DELETE

/documents/v1/publicacoes/{idDocumento}/anexos/{idAnexo}

10/02/25

10/02/26


Manipulação de anexos da publicaçãoSignIntegration

DELETE

/v2/Anexos/all/{idArquivo}

DELETE

/documents/v1/publicacoes/{idDocumento}/anexos

10/02/25

10/02/26


Enviar publicação SignIntegration 

POST

/v2/Publicacoes

POST

/documents/v1/publicacoes

06/12/24

30/11/25


Upload de arquivoStorage

POST

/api/Storage/list

POST

/documents/v1/envelopes/upload

23/05/2330/11/25

Login

IdentityIntegration

POST

/api/auth/login

POST

/identityintegration/v2/auth/login

06/04/2330/11/25

Upload de arquivo

Storage

POST

/api/Storage

POST

/documents/v1/envelopes/upload

27/04/2230/11/25

Download arquivo

Storage

GET

/v1/Storage

GET

/documents/v1/publicacoes/{id}/download

27/04/2230/11/25

Consulta envelope por id

SignIntegration

GET

/v2/publicacoes/{id}

GET

/documents/v2/publicacoes/{id}

27/04/2230/11/25

Consulta envelope por id

Documents

GET

/v1/publicacoes/{id}

GET

/documents/v2/publicacoes/{id}

27/04/2230/11/25

Buscar e filtrar envelopes 

SignIntegration

GET

/v2/publicacoes/filter

POST

/documents/v4/publicacoes/pesquisas

27/04/2230/11/25

Buscar e filtrar envelopes 

SignIntegration

GET

/v2/publicacoes/filter-basic

POST

/documents/v4/publicacoes/pesquisas

27/04/2230/11/25

Buscar e filtrar envelopes 

Documents

POST

/v1/publicacoes/pesquisas

POST

/documents/v4/publicacoes/pesquisas

27/04/2230/11/25

Buscar e filtrar envelopes 

Documents

POST

/v2/publicacoes/pesquisas

POST

/documents/v4/publicacoes/pesquisas

27/04/2230/11/25

Buscar e filtrar envelopes 

Documents

POST

/v3/publicacoes/pesquisas

POST

/documents/v4/publicacoes/pesquisas

27/04/2230/11/25

Criar e editar usuario através de um administrador

IdentityIntegration

POST

/v1/administrators/user

POST

/v2/administrators/user

10/11/2430/11/25

Criar e editar usuario através de um administrador

IdentityIntegration

PUT (Depreciada)
/v1/administrators/user

PUT  (nova rota)
/v2/administrators/user




Consulta envelope por id

(Autenticação por código / Sem cadastro)


Documents

GET  (Depreciada)
/v1/publicacoes/sem-cadastro/{id}


GET (nova rota)
/v2/publicacoes/sem-cadastro/{id}


02/04/2430/11/25

Realizar assinatura

(Autenticação por código / Sem cadastro)


Signintegration

POST  (Depreciada)
/v2/Assinaturas/sem-cadastro


POST (nova rota)
/v3/Assinaturas/sem-cadastro


02/04/2430/11/25

Manipulação de contatos e grupos de agenda



Contact

GET  (Depreciada)
/v1/contatos

DELETE  (Depreciada)
/v1/contatos

PUT  (Depreciada)
/v1/contatos

GET  (Depreciada)
/v1/contatos/usuario

POST  (Depreciada)
/v1/contatos-grupo

DELETE  (Depreciada)
/v1/contatos-grupo

GET  (Depreciada)
/v1/grupos

PUT  (Depreciada)
/v1/grupos

DELETE  (Depreciada)
/v1/grupos

GET  (Depreciada)
/v1/grupos/usuario



GET (nova rota)
/v2/contatos/{id}

DELETE (nova rota)
/v2/contatos/{id}

PUT (nova rota)
/v2/contatos/{id}

GET (nova rota)
/v2/contatos

GET (nova rota)
/v2/grupos/{id}

PUT (nova rota)
/v2/grupos/{id}

DELETE (nova rota)
/v2/grupos/{id}

GET (nova rota)
/v2/grupos

POST (nova rota)
/v1/grupos/{id}/contatos

DELETE (nova rota)
/v1/grupos/{id}/contatos

DELETE (nova rota)
/v1/grupos/{id}/contato


29/05/2330/11/25

Realizar assinatura

(Autenticação por código / Sem cadastro)

Signintegration

DELETE

/v2/publicacoes

DELETE

documents/v1/publicacoes/{id}

12/12/2330/11/25

Excluir publicação

Signintegration

DELETE

/v2/publicacoes

POST

documents/v1/publicacoes/{id}/cancelar

12/12/2330/11/25
DescriçãoAPIROTAData
Depreciação rota

(Implementação de nova rota para publicação de envelopes)		SignIntegration / Documents

POST (antiga)
signintegration/v2/Publicacoes


POST (nova)
documents/v1/publicacoes


06/12/24

Exclusão de apis depreciadas do read.meTodas depreciadasTodas depreciadas19/08/24
Depreciação rota

Assinatura em rota sem cadastro		SignIntegration

POST  (Depreciada)
/v2/Assinaturas/sem-cadastro


POST  (Nova)
/v2/Assinaturas/sem-cadastro

02/04/24
Depreciação rota

Consultar envelope em rota sem cadastro		Documents

GET  (Depreciada)
/v1/publicacoes/sem-cadastro/{id}


GET (nova rota)
/v2/publicacoes/sem-cadastro/{id}

02/04/24
Inclusão de novas rotas.

Registrar leitura inicial e final de documento

Buscar parametros da empresa dona do documento		DocumentsPOST /v1/publicacoes/{id}/leituras

GET /v1/publicacoes/{id}/tenant/params		23/11/23
Inclusão de novas rotas.

Rota para criar assinatura manuscrita ou rubrica

Rota para obter uma assinatura manuscrita ou rubrica		SignIntegrationPUT /v1/Subscricao

GET /v1/Subscricao/{tipo}		23/11/23
Inclusão de novas rotas.

Rota para alterar senha do usuário logado.
Rota para alterar perfil do usuário logado.		IdentityIntegrationPOST
/api/users/change-password

PUT
api/users		10/11/23
Inclusão de API

Rota para listar eventos do TAE que podem ter webhook

Rota responsável por criar uma Subscription (WebHook).

Rota responsável por listar todas as Subscriptions (WebHook). vinculadas a empresa do usuário administrador logado.

Rota utilizado para consultar uma Subscription (WebHook) pelo id.

Rota usado para editar uma Subscription (WebHook).

Adiciona o Callback personalizado vinculado a uma Subscription (WebHook)..		WebhooksGET
/v1/webhookevent

POST
/v1/subscription

GET
/v1/subscription

GET
/v1/subscription/{subscriptionId}

PATCH
/v1/subscription

POST
/v1/callbacks		29/08/23
Inclusão de API

Rota para incluir um callback em uma publicação		Signintegration/POST
/v1/Publicacoes/{IdArquivo}/CallBacks		29/08/23
Inclusão de parâmetros opcionais
(Opção da publicação: intervaloLembrete)		SignIntegrationPOST
/v2/Publicacoes		21/08/23
Inclusão de parâmetros opcionais
(Opção da publicação: intervaloLembrete)		SignIntegrationPUT
/v2/PublicacaoOpcoes		21/08/23
Inclusão de API
Rota utilizada para listar todos os papeis de assinantes disponíveis no TAE.		SignIntegrationGET
/v1/papeis-assinante		21/08/23
Depreciação rota

Manipulação de contatos e grupos de agenda		Contact

GET (antiga)
/v1/contatos

DELETE (antiga)
/v1/contatos

PUT (antiga)
/v1/contatos

GET (antiga)
/v1/contatos/usuario

POST (antiga)
/v1/contatos-grupo

DELETE (antiga)
/v1/contatos-grupo

GET (antiga)
/v1/grupos

PUT (antiga)
/v1/grupos

DELETE (antiga)
/v1/grupos

GET (antiga)
/v1/grupos/usuario



GET (nova)
/v2/contatos/{id}

DELETE (nova)
/v2/contatos/{id}

PUT (nova)
/v2/contatos/{id}

GET (nova)
/v2/contatos

GET (nova)
/v2/grupos/{id}

PUT (nova)
/v2/grupos/{id}

DELETE (nova)
/v2/grupos/{id}

GET (nova)
/v2/grupos

POST (nova)
/v1/grupos/{id}/contatos

DELETE (nova)
/v1/grupos/{id}/contatos

DELETE (nova)
/v1/grupos/{id}/contato


29/05/23
Inclusão API

Rota para consultar destinatários de uma publicação

Rota para substituir arquivo enquanto for um rascunho

Rota utilizada para baixar um documento através de uma url assinada (jornada de assinatura sem cadastro)		DocumentsPOST documents/v1/publicacoes/{id}/destinatarios

PUT
documents/v1/publicacoes/{id}/files

GET
documents/v1/publicacoes/download/signed-url		29/05/23
Depreciação rota

(Implementação de nova rota para upload de arquivos que aceita .doc e .docx)		Storage/ DocumentsPOST (antiga)
storage/api/Storage/list
POST (nova)
documents/v1/envelopes/upload		23/05/23
Inclusão API

Rota para upload de arquivos que aceita .doc e .docx		DocumentsPOST
documents/v1/envelopes/upload		11/05/23
Inclusão de parâmetros opcionais
(Opção da publicação: permiteRejeitarDocumento)		SignIntegrationPOST
/v2/Publicacoes		06/04/23
Inclusão de parâmetros opcionais
(Opção da publicação: permiteRejeitarDocumento)		SignIntegrationPUT
/v2/PublicacaoOpcoes		06/04/23
Inclusão API

(Épico Assinatura Simplificada - Rota para rejeitar sem cadastro)		SignIntegrationPOST
/v2/Assinaturas/rejeitar-sem-cadastro		06/04/23
Inclusão API

Rota para renovação de TOKEN JWE pelo refreshtoken		IdentityIntegrationPOST
/v1/auth/refreshToken		06/04/23
Depreciação Rotas (Implementação de nova rota com token JWE e refresh token)IdentityIntegrationPOST
/api/auth/login
Substituida pela
/v2/auth/login		06/04/23
Inclusão API

(Épico Assinatura Simplificada - Solicitar código para autenticação)		IdentityIntegrationPOST
/v1/verification-codes/send		25/11/22
Inclusão API

(Épico Assinatura Simplificada - Validar código para autenticação)		IdentityIntegrationPOST
/v1/verification-codes/validate		25/11/22
Inclusão API

(Épico Assinatura Simplificada - Obter totais de publicacoes que enviei para um destinatário)		DocumentsPOST
/v1/publicacoes/dashboard/destinatario		25/11/22
Inclusão API

(Épico Assinatura Simplificada - Listar publicacções que enviei para um destinatário)		SignIntegrationPOST
/v1/publicacoes/destinatario		25/11/22
Inclusão API

(Épico Assinatura Simplificada - Obter informações de uma publicação autenticado via código)		DocumentsGET
/v1​/publicacoes​/sem-cadastro​/{id}​		25/11/22
Inclusão API

(Épico Assinatura Simplificada - Realizar download autenticado via código)		DocumentsGET
/v1/publicacoes/sem-cadastro/{id}/download		25/11/22
Inclusão API

(Épico Assinatura Simplificada - Assinar sem cadastro)		SignIntegrationPOST
/v2/Assinaturas/sem-cadastro		25/11/22
Inclusão de campos opcionais

(Épico Assinatura Simplificada - Publicar com destinatários sem necessidade de efetuarem login)		SignIntegrationPOST
/v2/Publicacoes		25/11/22
Inclusão de campos opcionais

(Épico Assinatura Simplificada - Adicionar destinatários sem necessidade de efetuarem login)		SignIntegrationPOST /v2/Publicacoes/destinatario-list25/11/22
Inclusão APIDocumentsPOST /v1/publicacoes/pesquisas

GET
/v1/publicacoes/{id}

GET /v1/publicacoes/{id}/download		27/04/22
Depreciação RotasStoragePOST
/v1/Storage

GET
/v1/Storage		27/04/22
Depreciação RotasSignIntegrationGET
/v2/publicacoes/{id}

GET
/v2/publicacoes/filter

GET
/v2/publicacoes/filter-basic		27/04/22
Inclusão APIContactGET
/v1/contatos

DELETE
/v1/contatos

PUT
/v1/contatos

POST
/v1/contatos

GET
/v1/contatos/usuario		27/04/22
Inclusão RotasContactGET
/v1/grupos

POST
/v1/grupos

PUT
/v1/grupos

DELETE
/v1/grupos

GET
/v1/grupos/usuario

POST
/v1/contatos-grupo

DELETE
/v1/contatos-grupo		27/04/22
Inclusão RotasDocumentsGET
/v1/pastas

POST
/v1/pastas

GET
/v1/pastas/{id}

DELETE
/v1/pastas/{id}

POST
/v1/pastas/{id}/arquivos

DELETE
/v1/pastas/{id}/arquivos		27/04/22
Inclusão RotasDocumentsGET
/v1/pastas/compartilhadas

GET
/v1/pastas/compartilhadas/{id}

POST
/v1/pastas/{id}/contatos

GET
/v1/pastas/{id}/contatos

DELET
/v1/pastas/{id}/contatos		27/04/22
Inativação RotasSignIntegrationTodas as rotas V104/04/22
Depreciação RotasSignIntegrationTodas as rotas V104/04/22