Ir para o conteúdo

4.7. Habilitar em Escriturador

O processo de habilitação submete o emitente para avaliação junto ao escriturador escolhido. Somente emitentes com status Aprovado podem emitir Notas Comerciais.


Solicitar Habilitação

🔗 Endpoint

Método URL
POST /public/v1/emitentes/{id}/escriturador

🧾 Descrição

Dispara a solicitação de habilitação do emitente junto a um escriturador. Após o envio, o status inicial será Em Avaliação (1).

O resultado da avaliação será comunicado via webhook (quando configurado) ou pode ser consultado pelo endpoint de consulta do emitente.

Pré-requisitos: O emitente deve ter pelo menos um assinante cadastrado, documentos enviados e vínculo com um financiador antes de solicitar habilitação.

🔹 Path Parameter

Parâmetro Tipo Descrição
id integer Identificador único do emitente

📋 Payload (JSON)

{
  "idEscriturador": 1
}

🧾 Detalhamento dos Campos

Campo Tipo Obrigatório Descrição
idEscriturador integer Sim ID do escriturador (ver 3.2. Escrituradores)

🧪 Exemplo de cURL

curl -X POST https://api.vehub.com.br/public/v1/emitentes/42/escriturador \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  -H "Content-Type: application/json" \
  -d '{ "idEscriturador": 1 }'

📥 Response — 200 OK

{
  "mensagem": "Solicitação de habilitação enviada com sucesso.",
  "statusHabilitacao": 1,
  "descricaoStatus": "Em Avaliação"
}
Campo Tipo Descrição
mensagem string Confirmação da operação
statusHabilitacao integer Status atual da habilitação
descricaoStatus string Descrição legível do status

Consultar Status de Habilitação

🔗 Endpoint

Método URL
GET /public/v1/emitentes/{id}/escriturador

🧾 Descrição

Retorna o status de habilitação do emitente em todos os escrituradores vinculados ao grupo econômico.

🧪 Exemplo de cURL

curl -X GET https://api.vehub.com.br/public/v1/emitentes/42/escriturador \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}"

📥 Response — 200 OK

[
  {
    "idEscriturador": 1,
    "nomeEscriturador": "Escriturador Central S.A.",
    "statusHabilitacao": 3,
    "descricaoStatus": "Aprovado"
  },
  {
    "idEscriturador": 2,
    "nomeEscriturador": "Registradora Digital LTDA",
    "statusHabilitacao": 1,
    "descricaoStatus": "Em Avaliação"
  }
]

Detalhamento dos Campos

Campo Tipo Descrição
idEscriturador integer ID do escriturador
nomeEscriturador string Nome do escriturador
statusHabilitacao integer Status da habilitação (ver tabela abaixo)
descricaoStatus string Descrição do status

Status de Habilitação

Código Descrição Pode emitir NC?
1 Em Avaliação Não
2 Reprovado Não
3 Aprovado Sim

❌ Erros Comuns

400 Bad Request

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "titulo": "Atenção",
  "status": 400,
  "erros": [
    "O emitente não possui assinantes cadastrados.",
    "O emitente não possui documentos enviados.",
    "O emitente não está vinculado a nenhum financiador."
  ]
}

409 Conflict

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.10",
  "titulo": "Conflito",
  "status": 409,
  "erros": ["Já existe uma solicitação de habilitação em avaliação para este escriturador."]
}