V2
Clientes
Validar Cliente

Validar Cliente

Essa rota é utilizada para validar um cliente em uma concessionária específica (Dealership). A validação varia de acordo com o grupo da concessionária (ex: ENEL, CPFL, ENERGISA, NEOENERGIA).

🔐 Autenticação

A API exige autenticação via token JWT no cabeçalho da requisição:

Authorization: Bearer {token}

📬 Endpoint

GET /clients/dealership/validate
Authorization: Bearer {token}

📥 Parâmetros de Query (Query String)

Os parâmetros enviados na URL dependem do grupo da concessionária a qual pertence o dealershipId. O parâmetro dealershipId é obrigatório para todos. Abaixo estão listados os principais parâmetros:

Especificações dos parâmetros

ParâmetroDescriçãoTipoGrupo(s) aplicável(is)Obrigatório
dealershipIdID numérico da concessionária (banco de dados)numberTodosSIM
cpfCPF ou CNPJ do clientestringENEL, ENERGISA, CPFL, NEOENERGIADepende
installationNumberNúmero de instalação / conta contratostringENEL, ENERGISADepende

🧾 Exemplos de respostas

HTTP Code - 200

A estrutura de resposta varia conforme o distribuidor e a validação em si. Para distribuidoras como ENEL, CPFL e NEOENERGIA, quando o cliente não está em um status válido ou não é encontrado uma conta contrato vigente com essas credenciais, a resposta pode conter os campos adicionais message e motive detalhando a razão.

{
    "hasPending": false,
    "isValid": false,
    "message": "Client not validated on CPFL",
    "motive": "PN não correspondente a instalação vigente"
}

Exemplo genérico de sucesso (varia conforme a distribuidora, o mais comum é retornar informações sobre a validade do usuário na concessionária):

{
    "hasPending": false,
    "isValid": true
}

HTTP Code - 400

  • Exemplo de erro quando algum parâmetro obrigatório falta:
{
    "message": "Request body validation error",
    "code": 400,
    "invalidFieldsErrors": [
        {
            "field": "dealershipId",
            "message": "is required"
        }
    ]
}

HTTP Code - 401

  • Requisição não autorizada
{
    "message": "Unauthorized"
}