Skip to main content

Consultar Contratos do Cliente

Utilize o token obtido na autenticação para consultar os contratos de um cliente pelo CPF.

🔗 Consultar Contratos por CPF (Swagger)

🔍 Parâmetros

ParâmetroTipoObrigatórioDescrição
documentstring (path)CPF do cliente, com ou sem máscara (ex: 855.578.539-10 ou 85557853910)

Exemplo de Requisição

GET /integration/contract/by-document/85557853910
Authorization: Bearer <token>

Exemplo de Resposta (200)

{
"contracts": [
{ "id": 123, "status": "Ativo" },
{ "id": 456, "status": "Cancelado" }
]
}

Campos da Resposta

CampoDescrição
contractsLista de contratos do cliente elegíveis para anexo
contracts[].idID do contrato — utilizado no envio do anexo
contracts[].statusStatus atual do contrato (ex: Aberto, Ativo, Ag.Pagamento, Inadimplente, Cancelado)
Contratos de Energia

Contratos do tipo Energia não são retornados por esta rota. Se o CPF não tiver nenhum contrato elegível (ou não existir), a resposta é 200 com contracts: [] — a API não diferencia os dois casos.

⚠️ Respostas

CódigoDescrição
200Retorna a lista de contratos (pode ser vazia)
401Token ausente ou inválido