Base de Conhecimento de Gestão Comercial de Saneamento

A maior base de documentação de GSAN do mercado mantida pela Consenso Tecnologia

Ferramentas do usuário

Ferramentas do site


integracoes:web-services-verificar-matricula-cpf-cnpj

Essa é uma revisão anterior do documento!


Web Service Verificar Matrícula CPF/CNPJ(Municipal)

O WebService recebe apenas requisições do tipo GET, e os parâmetros são passados via Query Parameter. Presente apenas na versão municipal. A funcionalidade irá verificar a relação do CPF/CNPJ informado com o imóvel, se existir irá retornar um booleano positivo se o vinculo existir. É possível também verificar se o vinculo já existiu em algum momento apenas passando o indicador atual como falso na requisição.

São esperados os seguintes parâmetros:

Parâmetro Valor Tipo
matriculaMatrícula do ImóvelString
cpfCnpjCpf ou CNPJ do clienteString
atualIndicador se vinculo atual. 1(Sim) ou 2 (Não)Integer
Exemplo de Requisição
https://<URL_GSAN>:<porta>/gsan/gsan/verificarMatriculaCpfCnpj?matricula=999999&cpfCnpj=99999999999&atual=1
Retornos

Com sucesso:

Caso imóvel exista e esteja na tarifa social.

{
    "body": {
        "cpfCnpjValido": true,
        "matriculaValida": true,
        "matriculaExistente": true,
        "cpfCnpjVinculados": false
    }
}

Com erro:

{
    "error": {
        "parametrosMensagem": [],
        "detailMessage": "Erro de acesso ao banco de dados, favor contactar administrador do sistema.",
        "stackTrace": [],
        "suppressedExceptions": []
    }
}
Possíveis Códigos de Retorno
Código
200“OK”
422“Unprocessable Entity”
integracoes/web-services-verificar-matricula-cpf-cnpj.1759171184.txt.gz · Última modificação: 29/09/2025 18:39 por jefferson.araujo