Verificando o contexto da unidade consumidora (UC):

Verify context flow

Descrição

A verificação de contexto de unidade consumidora ocorre junto à concessionária de energia abrangendo a necessidade do sistema consumidor do motor de verificar a situação atual do usuário.

Campo	Tipo	Descrição
`dealershipId`	`number`	Obrigatório. Chave fornecida a cada parceiro.
`companyCode`	`number`	Numero da compania (requerido para energisa).
`installationNumber`	`number`	Obrigatório. Numero da UC presente na conta.
`cpf`	`string`	CPF do cliente (requerido para enel).

Exemplos de utilização

curl --location '{motor_base_url}/validate?dealershipId=0&companyCode=0&installationNumber=0'

Retornos aguardados

{
    "hasPending": [false, true], // é uma UC válida, porém pode estar em débito.
    "isValid": true,
    "message": null,
    "motive": null
}

Retornos de erro

{
    "hasPending": false,
    "isValid": false,
    "message": "Client not found on {service_name}",
    "motive": "Not found"
}

ℹ

O endpoint de verificação de contexto irá sempre consultar o serviço da concessionária portanto, caso o serviço externo esteja offline, nesse caso o padrão será modificado.

️🚫

Status Code 500

{
    "message": "Service is unavailable, please try again later"
}

Autenticação Sobre