> ## Documentation Index > Fetch the complete documentation index at: https://docs-koolisys.eixoassistencia.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Consulta elegibilidade de cliente e veículo > Verifica se um cliente e veículo têm cobertura ativa para acionar um atendimento. Só leitura — nunca consome cota de uso. ## OpenAPI ````yaml /referencia/openapi.json get /v1/eligibility openapi: 3.0.0 info: title: Koolisys — API Pública description: >- Contrato da API pública de integração da Koolisys: atendimentos, catálogo de serviços, elegibilidade, cadastro e consulta de clientes e veículos e a própria contratante. Gerada a partir do código — rotas, DTOs de entrada, projeções de resposta e escopos declarados —, nunca mantida à mão. version: 1.0.0 contact: {} servers: - url: https://api-koolisys.eixoassistencia.com.br description: API pública da Koolisys security: [] tags: - name: auth description: Emissão do token de curta duração a partir da chave de API - name: attendances description: Abertura, consulta e listagem de atendimentos - name: services description: Catálogo de serviços disponíveis - name: eligibility description: Consulta de elegibilidade de cliente e veículo - name: customers description: Cadastro, consulta, busca e listagem de clientes da contratante - name: vehicles description: Consulta e listagem de veículos da contratante - name: company description: 'A própria contratante: contratos vigentes e planos disponíveis' - name: meta description: A própria especificação paths: /v1/eligibility: get: tags: - eligibility summary: Consulta elegibilidade de cliente e veículo description: >- Verifica se um cliente e veículo têm cobertura ativa para acionar um atendimento. Só leitura — nunca consome cota de uso. operationId: PublicEligibilityController_check parameters: - name: plate required: true in: query description: Placa do veículo schema: example: ABC1D23 - name: document required: true in: query description: CPF ou CNPJ do cliente, só dígitos schema: example: '12345678900' responses: '200': description: Resultado da elegibilidade content: application/json: schema: type: object required: - data - meta - errors properties: data: $ref: '#/components/schemas/PublicEligibilityResponse' meta: type: object description: Metadados da resposta — vazio nesta operação. properties: {} errors: type: array description: Sempre vazio numa resposta de sucesso. items: type: object maxItems: 0 example: data: covered: true plan: id: 91 name: Plano Proteção Total contractCode: null limits: usages: limit: 5 used: 1 remaining: 4 kmPerUse: 100 valuePerUseCents: null coveredServices: - id: 7 name: Reboque leve category: AUTO monthlyLimit: null valueLimitCents: null customerPaysExcess: false meta: {} errors: [] '400': description: VALIDATION_ERROR content: application/json: example: data: null errors: - code: VALIDATION_ERROR message: 'customerDocument: Documento do cliente é obrigatório' field: customerDocument '401': description: INVALID_TOKEN content: application/json: example: data: null errors: - code: INVALID_TOKEN message: Token inválido. '403': description: INSUFFICIENT_SCOPE content: application/json: example: data: null errors: - code: INSUFFICIENT_SCOPE message: Escopo insuficiente para este endpoint. details: requiredScope: attendances.read '404': description: NOT_FOUND content: application/json: example: data: null errors: - code: NOT_FOUND message: Attendance not found '429': description: RATE_LIMITED content: application/json: example: data: null errors: - code: RATE_LIMITED message: Limite de requisições excedido. details: retryAfterSeconds: 42 '503': description: FEATURE_DISABLED content: application/json: example: data: null errors: - code: FEATURE_DISABLED message: 'Feature is disabled: public_api.enabled' security: - apiToken: [] components: schemas: PublicEligibilityResponse: type: object properties: covered: type: boolean description: >- Se o cliente e o veículo têm cobertura ativa para abrir um atendimento. plan: nullable: true description: Plano que cobre o cliente. Nulo quando não há cobertura. type: object allOf: - $ref: '#/components/schemas/PublicEligibilityPlan' limits: nullable: true description: Limites do plano. Nulos quando não há cobertura. type: object allOf: - $ref: '#/components/schemas/PublicEligibilityLimits' coveredServices: description: Serviços cobertos pelo plano. Vazio quando não há cobertura. type: array items: $ref: '#/components/schemas/PublicEligibilityCoveredService' customerPaysExcess: type: boolean description: Se o excedente aos limites é cobrado do cliente. required: - covered - plan - limits - coveredServices - customerPaysExcess PublicEligibilityPlan: type: object properties: id: type: integer format: int32 description: Identificador do plano. name: type: string description: Nome comercial do plano. contractCode: type: string nullable: true description: >- Código do contrato ao qual o plano pertence. Nulo quando não há contrato. required: - id - name - contractCode PublicEligibilityLimits: type: object properties: usages: nullable: true description: >- Cota de utilizações do plano. Nula quando o plano não limita utilizações. type: object allOf: - $ref: '#/components/schemas/PublicEligibilityUsageLimits' kmPerUse: type: integer format: int32 nullable: true description: >- Quilometragem coberta por utilização. Nula quando não há limite de km. valuePerUseCents: type: integer format: int32 nullable: true description: >- Valor coberto por utilização, em centavos. Nulo quando não há teto de valor. required: - usages - kmPerUse - valuePerUseCents PublicEligibilityCoveredService: type: object properties: id: type: integer format: int32 description: Identificador do serviço. name: type: string description: Nome do serviço. category: type: string enum: - AUTO - RESIDENCIAL - PET - MONTAGEM - SAUDE - FUNERARIA_PET - FUNERAL - PESSOA_E_BEM_ESTAR - SUPORTE - VIAGEM - VIDA description: >- Categoria do serviço: AUTO (automotivo), RESIDENCIAL, PET, MONTAGEM, SAUDE, FUNERARIA_PET, FUNERAL, PESSOA_E_BEM_ESTAR, SUPORTE, VIAGEM ou VIDA. monthlyLimit: type: integer format: int32 nullable: true description: >- Limite mensal de utilizações deste serviço. Nulo quando não há limite próprio. valueLimitCents: type: integer format: int32 nullable: true description: >- Teto de valor por utilização deste serviço, em centavos. Nulo quando não há. required: - id - name - category - monthlyLimit - valueLimitCents PublicEligibilityUsageLimits: type: object properties: limit: type: integer format: int32 nullable: true description: Total de utilizações permitidas no período. Nulo quando ilimitado. used: type: integer format: int32 description: Utilizações já consumidas no período. remaining: type: integer format: int32 nullable: true description: Utilizações restantes no período. Nulo quando ilimitado. required: - limit - used - remaining securitySchemes: apiToken: scheme: bearer bearerFormat: JWT type: http description: >- Token de curta duração devolvido por POST /v1/auth/token, carregando os escopos concedidos à chave — exigido por todo endpoint de dados. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.