Histórico da Página

...

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

Informações

title	Depreciação e desativação de apis

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!

Informações

title	Tela de autenticação externa

Ainda no tema, vamos descontinuar uma tela de autenticação externa, utilizada por alguns produtos integradores. As integrações que desejam continuar realizando autenticações no TAE precisam desenvolver uma interface visual própria para isso, além de consumir nossas APIs que tratam desse contexto.

A tela em questão foi depreciada em 06/04/2023, será descontinuada em 01/03/2027 e era acessada por um dos links abaixo:

Expandir

title	Representação visual

Image Added

Descrição	API

ROTADepreciado

/ Serviço	Rota depreciada	Rota atual	Depreciada em	Descontinua em

MotivoDepreciação rota

Observações

Contagem de documentos por status

SignIntegration

GET

/v2/publicacoes/dashboard

N/A

21/10/2025

01/11/2026

Rota depreciada pois deve ser usada apenas internamente pelo produto.

Autenticação de usuário

integrador

IdentityIntegration

POST

(Depreciada)

/identityintegration

/v2/auth/login

POST

(Rota nova)

/

identityintegration/

v3/auth/login

21/08/

25

2025

21

01/

08

11/

26

2026

(

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

autenticação. 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, já que eles passam a poder Publicar Documentos.

Depreciação rota

Obter dados do usuário

(por id e por email)

IdentityIntegration

GET

(Depreciada)

/identityintegration

/v1/administrators/user

GET

(nova rota)

/identityintegration

/v2/administrators/user

19/05/

25

2025

19

01/

05

11/

26

2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Listar

Depreciação rota
Manipulação de

anexos da publicação

SignIntegration

GET (Depreciada)

GET

/v2/Anexos/{idArquivo}

POST

GET (

Depreciada

Documents)

v2

Anexos

idArquivo

GET (Depreciada)
/v2/Anexos/download/{idFileStream}

DELETE (Depreciada)
/v2/Anexos/{idAnexo}

/anexos	10/02/2025	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Incluir anexos na publicação	SignIntegration	POST

DELETE (Depreciada)

/v2/Anexos

/all

/{idArquivo}

GET

POST (

nova rota

Documents)

documents

/v1/publicacoes/{idDocumento}/anexos

POST (nova rota)
documents/v1/publicacoes/{idDocumento}/anexos

DELETE (nova rota)
documents/v1/publicacoes/{idDocumento}/anexos

GET (nova rota)
documents/v1/publicacoes/{idDocumento}/anexos/{idAnexo}

DELETE (nova rota)
documents

10/02/2025

01/11/2026

Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.

Baixar anexo da publicação

SignIntegration

GET

/v2/Anexos/download/{idFileStream}

GET (Documents)

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

10/02/

25

2025

10

01/

02

11/

26Depreciação rota
Enviar publicação SignIntegration

POST (Depreciada)
signintegration/v2/Publicacoes

POST (nova rota)
documents/v1/publicacoes

06/12/24

30/11/25

Depreciação rota
Upload de arquivoStorage

POST (Depreciada)
storage/api/Storage/list

POST (nova rota)
documents/v1/envelopes/upload23/05/2330/11/25

Depreciação rota

Login

IdentityIntegration

POST (Depreciada)
/api/auth/login

POST (nova rota)

/v2/auth/login

06/04/2330/11/25Depreciação rota
Upload de arquivoStorage

POST (Depreciada)
storage/api/Storage

POST (nova rota)
documents/v1/envelopes/upload27/04/2230/11/25

Depreciação rota

Download arquivo

Storage

GET (Depreciada)
/v1/Storage

GET (nova rota) /v1/publicacoes/{id}/download

27/04/2230/11/25

Depreciação rota

Consulta envelope por id

SignIntegration

Documents

GET (Depreciada)
signintegration/v2/publicacoes/{id}

GET (Depreciada)
documents/v1/publicacoes/{id}

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

2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Remover anexo da publicação	SignIntegration	DELETE /v2/Anexos/{idAnexo}	DELETE (Documents) /v1/publicacoes/{idDocumento}/anexos/{idAnexo}	10/02/2025	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Remover todos anexos da publicação	SignIntegration	DELETE /v2/Anexos/all/{idArquivo}	DELETE (Documents) /v1/publicacoes/{idDocumento}/anexos	10/02/2025	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Publicar documento	Signintegration	POST /v2/publicacoes	POST (Documents) /v1/publicacoes	06/12/2024	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Criar usuário, sendo um administrador	IdentityIntegration	POST /v1/administrators/user	POST /v2/administrators/user	10/11/2024	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Editar usuário, sendo um administrador	IdentityIntegration	PUT

27/04/2230/11/25

Depreciação rota

Buscar e filtrar envelopes

SignIntegration

Documents

GET (Depreciada)
signIntegration/v2/publicacoes/filter
GET (Depreciada)
signIntegration/v2/publicacoes/filter-basic

POST (Depreciada)
documents/v1/publicacoes/pesquisas

POST (Depreciada)
documents/v2/publicacoes/pesquisas

POST (Depreciada)
documents/v3/publicacoes/pesquisas

POST (nova rota) documents/v4/publicacoes/pesquisas

27/04/2230/11/25

Depreciação rota

Criar e editar usuario através de um administrador

IdentityIntegrationPOST (Depreciada)

/v1/administrators/user

PUT

(Depreciada)
/v1/administrators/user
POST (nova rota)

/v2/administrators/user

PUT (nova rota)

/v2/administrators/user

10/11/

24

2024

30

01/11/

25

Depreciação rota

2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Consultar documento

Consulta envelope por id

(Autenticação por código

/ Sem cadastro

)

Documents

GET (Depreciada)

GET

/v1/publicacoes/sem-cadastro/{id}

GET

(nova rota)

/v2/publicacoes/sem-cadastro/{id}

02/04/

24

2024

30

01/11/

25Depreciação rota

2026

Importante: a rota depreciada não retorna documentos em status Cancelado.

Alterações no Payload (contrato da API) e no Response (dados retornados).

Realizar assinatura

(Autenticação por código

/ Sem cadastro

)	Signintegration

POST (Depreciada)

POST

/v2/Assinaturas/sem-cadastro

POST

(nova rota)

/v3/Assinaturas/sem-cadastro

02/04/

24

2024

30

01/11/

25

Depreciação rota

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

...

title	Histórico completo

...

POST (antiga)
signintegration/v2/Publicacoes

POST (nova)
documents/v1/publicacoes

06/12/24

...

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

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

...

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

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

...

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

...

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

...

2026	Adição de regra para validar assinaturas manuscritas.
Excluir documento	Signintegration	DELETE /v2/publicacoes	DELETE (Documents) /v1/publicacoes/{id}	12/12/2023	01/11/2026	Importante: a rota depreciada foi ajustada para tratar os casos de Exclusão e Cancelamento. A nova rota apenas exclui os documentos. Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Excluir documento	Signintegration	DELETE /v2/publicacoes	POST (Documents) /v1/publicacoes/{id}/cancelar	12/12/2023	01/11/2026	Importante: a rota depreciada foi ajustada para tratar os casos de Exclusão e Cancelamento. A nova rota apenas cancela os documentos. Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Consultar contato	Contact	GET /v1/contatos	GET /v2/contatos/{id}	29/05/2023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Remover contato	Contact	DELETE /v1/contatos	DELETE /v2/contatos/{id}	29/05/2023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Alterar contato	Contact	PUT /v1/contatos	PUT /v2/contatos/{id}	29/05/2023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Listar todos contatos	Contact	GET /v1/contatos/usuario	GET /v2/contatos	29/05/2023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Incluir contato em grupo	Contact	POST /v1/contatos-grupo	POST /v1/grupos/{id}/contatos	29/05/2023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Remover contatos de grupo	Contact	DELETE /v1/contatos-grupo	DELETE /v1/grupos/{id}/contatos	29/05/2023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Remover contato de grupo	Contact	DELETE /v1/contatos-grupo	DELETE /v1/grupos/{id}/contato	29/05/2023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Consultar grupo	Contact	GET /v1/grupos	GET /v2/grupos/{id}	29/05/2023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Listar todos grupos	Contact	GET /v1/grupos/usuario	GET /v2/grupos	29/05/2023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Alterar grupo	Contact	PUT /v1/grupos	PUT /v2/grupos/{id}	29/05/2023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Remover grupo	Contact	DELETE /v1/grupos	DELETE /v2/grupos/{id}	29/05/2023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Upload de documentos	Storage	POST

/api/Storage/list

POST (

...

Documents)

...

/v1/envelopes/upload

...

25/05/

...

2023	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Autenticação de usuário

...

IdentityIntegration

POST

/api/auth/login

...

POST

/v2/auth/login

06/04/

...

2023	01/11/2026	Importante: a rota depreciada retornava tokens em formato JWT; a partir da nova os tokens serão JWE. Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Upload de documentos	Storage	POST /api/Storage	POST (Documents) /v1/envelopes/upload	27/04/2022	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Download de documento	Storage	GET /v1/Storage	GET (Documents) /v1/publicacoes/{id}/download	27/04/2022	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Consultar documento	SignIntegration	GET /v2/publicacoes/{id}	GET (Documents) /v2/publicacoes/{id}	27/04/2022	01/11/2026	Importante: a rota depreciada não retorna documentos em status Cancelado. Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.
Consultar documento	Documents

...

GET

/v1/publicacoes/{id}

GET

/

...

v2/publicacoes/{id}

...

27/04/

...

2022

01/11/2026

Importante: a rota depreciada não retorna documentos em status Cancelado.

Listar e filtrar documentos

SignIntegration

GET

/v2/publicacoes/filter

...

POST (Documents)

/

...

v4/publicacoes/

...

pesquisas

27/04/

...

2022

01/11/2026

Importante: a rota depreciada não retorna documentos em status Cancelado.

Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.

Listar e filtrar documentos

SignIntegration

GET

/v2/publicacoes/filter-basic

POST (Documents)

/v4/publicacoes/pesquisas

27/04/

...

2022

01/11/2026

Importante: a rota depreciada não retorna documentos em status Cancelado.

Alterações no Payload (contrato da API) e no Response (dados retornados), além da mudança de serviço.

Listar e filtrar documentos

Documents

POST

/v1/publicacoes/pesquisas

POST

/v4/publicacoes/pesquisas

...

27/04/

...

2022

01/11/2026

Importante: a rota depreciada não retorna documentos em status Cancelado.

Alterações no Payload (contrato da API) e no Response (dados retornados).

Listar e filtrar documentos

Documents

POST

/v2/publicacoes/pesquisas

POST

/v4/publicacoes/pesquisas

27/04/2022

01/11/2026

Alterações no Payload (contrato da API) e no Response (dados retornados).

Listar e filtrar documentos

Documents

POST

/v3/publicacoes/pesquisas

POST

/v4/publicacoes/pesquisas

27/04/2022

01/11/2026

Alterações no Payload (contrato da API) e no Response (dados retornados).

...

Árvore de páginas

Versões comparadas

Versão antiga 26

Nova versão Atual

Chave