Exibir origem

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ção	API/ Serviço	Rota depreciada	Rota atual	Depreciada em	Descontinua em	Observações
Autenticação de usuário	IdentityIntegration	POST /v2/auth/login	POST /v3/auth/login	21/08/2025	01/11/2026	Breaking Change: Rota depreciada devido a nova regra incluída que considera o parâmetro de obrigatoriedade de autenticação por SSO para autenticação. Caso o parâmetro esteja ativo, não será possível usuários comuns se autenticarem via rota. 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.
Obter dados do usuário	IdentityIntegration	GET /v1/administrators/user	GET /v2/administrators/user	19/05/2025	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Listar anexos da publicação	SignIntegration	GET /v2/Anexos/{idArquivo}	GET (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.
Incluir anexos na publicação	SignIntegration	POST /v2/Anexos/{idArquivo}	POST (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.
Baixar anexo da publicação	SignIntegration	GET /v2/Anexos/download/{idFileStream}	GET (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 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 /v1/administrators/user	PUT /v2/administrators/user	10/11/2024	01/11/2026	Alterações no Payload (contrato da API) e no Response (dados retornados).
Consultar documento (Autenticação por código)	Documents	GET /v1/publicacoes/sem-cadastro/{id}	GET /v2/publicacoes/sem-cadastro/{id}	02/04/2024	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).
Realizar assinatura (Autenticação por código)	Signintegration	POST /v2/Assinaturas/sem-cadastro	POST /v3/Assinaturas/sem-cadastro	02/04/2024	01/11/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).