Baixar Collection

Certificados Digitais - Escavador API - Documentação

Grupo

Certificados Digitais

Criar certificado digital

POST /api/v2/certificados
Requer autenticaçãoGrátis

Realiza o upload de um certificado. Opcionalmente, permite enviar as configurações de 2FA no mesmo request.

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: POST.

Body Parameters

?
certificado file Obrigatório

O arquivo do certificado digital (.pfx ou .p12).

senha string Obrigatório

A senha do certificado.

autenticacoes object[] Opcional

Lista de configurações de 2FA.

autenticacoes[].tribunal string Opcional

A sigla do tribunal.

autenticacoes[].sistemas array<string> Opcional

Lista com os nomes dos sistemas.

autenticacoes[].secret_2fa string Opcional

O código secreto do 2FA.

Exemplos de respostas válidas

HTTP 201 ? 
{
    "id": 17,
    "nome": "ANA MARIA",
    "cpf": "11111111111",
    "criado_em": "2025-06-10T13:40:27+00:00",
    "expira_em": "2026-06-10T00:00:00+00:00",
    "autenticacoes": [
        {
            "id": 1,
            "tribunal": "TRF4",
            "sistema": "EPROC",
            "criado_em": "2025-11-28T15:43:21+00:00",
            "atualizado_em": "2025-11-28T15:43:21+00:00"
        },
        {
            "id": 2,
            "tribunal": "TRF2",
            "sistema": "EPROC-SJES",
            "criado_em": "2025-11-28T17:12:41+00:00",
            "atualizado_em": "2025-11-28T17:12:41+00:00"
        },
        {
            "id": 3,
            "tribunal": "TRF2",
            "sistema": "EPROC-SJRJ",
            "criado_em": "2025-11-28T17:12:41+00:00",
            "atualizado_em": "2025-11-28T17:12:41+00:00"
        }
    ]
}
HTTP 422 ? 
{
    "code": "UNPROCESSABLE_ENTITY",
    "message": "Não foi possível processar a solicitação",
    "errors": [],
    "appends": null
}

Listar certificados digitais

GET /api/v2/certificados
Requer autenticaçãoGrátis

Retorna a lista paginada de certificados digitais vinculados à conta da organização.

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: GET.

Query Parameters

?
cpf string Opcional

Filtra os certificados pelo CPF do titular.

Exemplos de respostas válidas

HTTP 200 ? 
{
    "items": [
        {
            "id": 17,
            "nome": "ANA MARIA",
            "cpf": "11111111111",
            "criado_em": "2025-06-10T13:40:27+00:00",
            "expira_em": "2026-06-10T00:00:00+00:00"
        }
    ],
    "links": {
        "next": null,
        "prev": null,
        "first": "https://api.escavador.com/api/v2/certificados?page=1",
        "last": "https://api.escavador.com/api/v2/certificados?page=1"
    },
    "paginator": {
        "current_page": 1,
        "per_page": 20,
        "total": 1,
        "total_pages": 1
    }
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}

Buscar certificado digital

GET /api/v2/certificados/{id}
Requer autenticaçãoGrátis

Retorna os dados detalhados de um certificado específico, incluindo suas configurações de 2FA.

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: GET.

URL Parameters

?
id integer Obrigatório

O ID do certificado.

Exemplos de respostas válidas

HTTP 200 ? 
{
    "id": 17,
    "nome": "ANA MARIA",
    "cpf": "11111111111",
    "criado_em": "2025-06-10T13:40:27+00:00",
    "expira_em": "2026-06-10T00:00:00+00:00",
    "autenticacoes": [
        {
            "id": 1,
            "tribunal": "TRF4",
            "sistema": "EPROC",
            "criado_em": "2025-11-28T15:43:21+00:00",
            "atualizado_em": "2025-11-28T15:43:21+00:00"
        },
        {
            "id": 2,
            "tribunal": "TRF2",
            "sistema": "EPROC-SJES",
            "criado_em": "2025-11-28T17:12:41+00:00",
            "atualizado_em": "2025-11-28T17:12:41+00:00"
        },
        {
            "id": 3,
            "tribunal": "TRF2",
            "sistema": "EPROC-SJRJ",
            "criado_em": "2025-11-28T17:12:41+00:00",
            "atualizado_em": "2025-11-28T17:12:41+00:00"
        }
    ]
}
HTTP 404 ? 
{
    "error": "NotFound"
}

Remover um certificado

DELETE /api/v2/certificados/{id}
Requer autenticaçãoGrátis

Remove o certificado digital e todos as suas configurações de autenticação.

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: DELETE.

URL Parameters

?
id integer Obrigatório

O ID do certificado a ser excluído.

Exemplos de respostas válidas

HTTP 204 ? 
[]
HTTP 404 ? 
{
    "error": "NotFound"
}

Configurar autenticações

POST /api/v2/certificados/{id}/autenticacoes
Requer autenticaçãoGrátis

Adiciona novas configurações de 2FA ou atualiza a secret de sistemas já vinculados ao certificado. O que for enviado será criado/atualizado, o que não for enviado será mantido inalterado.

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: POST.

URL Parameters

?
id integer Obrigatório

O ID do certificado.

Body Parameters

?
autenticacoes object[] Obrigatório

Lista de configurações.

autenticacoes[].tribunal string Obrigatório

A sigla do tribunal.

autenticacoes[].sistemas array<string> Obrigatório

Lista com os nomes dos sistemas.

autenticacoes[].secret_2fa string Obrigatório

O código secreto do 2FA.

Exemplos de respostas válidas

HTTP 200 ? 
{
    "id": 17,
    "nome": "ANA MARIA",
    "cpf": "11111111111",
    "criado_em": "2025-06-10T13:40:27+00:00",
    "expira_em": "2026-06-10T00:00:00+00:00",
    "autenticacoes": [
        {
            "id": 1,
            "tribunal": "TRF4",
            "sistema": "EPROC",
            "criado_em": "2025-11-28T15:43:21+00:00",
            "atualizado_em": "2025-11-28T15:43:21+00:00"
        },
        {
            "id": 2,
            "tribunal": "TRF2",
            "sistema": "EPROC-SJES",
            "criado_em": "2025-11-28T17:12:41+00:00",
            "atualizado_em": "2025-11-28T17:12:41+00:00"
        },
        {
            "id": 3,
            "tribunal": "TRF2",
            "sistema": "EPROC-SJRJ",
            "criado_em": "2025-11-28T17:12:41+00:00",
            "atualizado_em": "2025-11-28T17:12:41+00:00"
        }
    ]
}
HTTP 404 ? 
{
    "error": "NotFound"
}

Remover uma autenticação

DELETE /api/v2/certificados/{id}/autenticacoes/{autenticacaoId}
Requer autenticaçãoGrátis

Remove a autenticação de um sistema específico deste certificado.

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: DELETE.

URL Parameters

?
id integer Obrigatório

O ID do certificado.

autenticacaoId integer Obrigatório

O ID da autenticação a ser removida.

Exemplos de respostas válidas

HTTP 204 ? 
[]