MV sistemas Cadastros auxiliares API
Listas de estados, cidades, bairros, tipos de recurso e especialidades para filtros e formulários.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/mv-sistemas-cadastros-auxiliares-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Integração Hub Operadora Cadastros auxiliares API
version: 1.0.0
description: '**Personal Health · Integração Hub Operadora** reúne as APIs que levam ao **app Personal** os serviços da **operadora de saúde**: dados do beneficiário e da carteirinha, **rede credenciada** (guia médico), guias e utilização do plano, dependentes, **histórico de relacionamento** com o beneficiário, **cadastros auxiliares** para telas e filtros (UF, município, bairro, recursos e especialidades) e **tokens** para fluxos que exigem confirmação rápida.
A integração é voltada a **operadoras** com **contrato ativo** junto à **MV Global Health** no ecossistema Personal.
Inclua em **todas** as requisições o cabeçalho **`x-api-key`** fornecido pelo time de integração. O ambiente disponível é **somente Produção**.
Detalhes de parâmetros, formatos de data e regras próprias da sua operação devem ser alinhados no **contrato técnico** e com o time de integração; esta documentação serve como **referência geral**.
'
servers:
- url: https://api.globalhealth.mv/prod/personal-hub-operadora-api
description: Ambiente de PRODUÇÃO
security:
- x-api-key: []
tags:
- name: Cadastros auxiliares
description: Listas de estados, cidades, bairros, tipos de recurso e especialidades para filtros e formulários.
paths:
/api/Funcoes/GetEstados/{numerocarteira}:
get:
tags:
- Cadastros auxiliares
summary: GetEstados
description: 'Lista **estados (UFs)** disponíveis para uso em filtros (por exemplo, na busca de rede credenciada ou cadastros auxiliares), **associados ao contexto da carteirinha** informada.
Não há parâmetros de consulta além da carteira na URL.
'
parameters:
- name: numerocarteira
in: path
required: true
schema:
type: string
description: Carteirinha do beneficiário para contextualizar as listas auxiliares.
responses:
'200':
description: Lista de UFs.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/VwClinicApiUf'
'400':
description: Requisição inválida.
'401':
description: Não autorizado.
'500':
description: Erro interno do servidor.
/api/Funcoes/GetCidades/{numerocarteira}:
get:
tags:
- Cadastros auxiliares
summary: GetCidades
description: 'Lista **municípios** de uma **UF** escolhida, para montar filtros em telas (rede credenciada, endereço, etc.). Informe a **carteirinha** no path e o **código da UF** na consulta.
'
parameters:
- name: numerocarteira
in: path
required: true
schema:
type: string
description: Carteirinha do beneficiário para contextualizar a lista.
- name: CdUF
in: query
required: true
schema:
type: string
description: Sigla ou código da UF cujos municípios devem ser listados.
responses:
'200':
description: Lista de municípios no estado informado.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/VwClinicApiMunicipio'
'400':
description: Requisição inválida.
'401':
description: Não autorizado.
'500':
description: Erro interno do servidor.
/api/Funcoes/GetBairros/{numerocarteira}:
get:
tags:
- Cadastros auxiliares
summary: GetBairros
description: 'Lista **bairros** disponíveis para o **município** e **UF** informados — útil para refinar buscas na rede credenciada. Informe a carteirinha na URL, a UF e o código do município nas consultas.
'
parameters:
- name: numerocarteira
in: path
required: true
schema:
type: string
description: Carteirinha do beneficiário para contextualizar a lista.
- name: cdUF
in: query
required: true
schema:
type: string
description: UF do município selecionado.
- name: cdCidade
in: query
required: true
schema:
type: string
description: Código do município (obtido, por exemplo, na lista de cidades).
responses:
'200':
description: Lista de bairros distintos.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/VwClinicApiBairro'
'400':
description: Requisição inválida.
'401':
description: Não autorizado.
'500':
description: Erro interno do servidor.
/api/Funcoes/GetRecursos/{numerocarteira}:
get:
tags:
- Cadastros auxiliares
summary: GetRecursos
description: 'Lista os **tipos de recurso** disponíveis para filtro (ex.: tipos de atendimento na rede), incluindo em muitos casos a opção **`TODOS`** para não restringir a busca.
Utilize apenas a **carteirinha** no path; não há outros parâmetros de consulta.
'
parameters:
- name: numerocarteira
in: path
required: true
schema:
type: string
description: Carteirinha do beneficiário para contextualizar a lista.
responses:
'200':
description: Lista de tipos de recurso; pode incluir a opção `TODOS` para ampliar o filtro.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/VwClinicApiRecurso'
'400':
description: Requisição inválida.
'401':
description: Não autorizado.
'500':
description: Erro interno do servidor.
/api/Funcoes/GetEspecialidade/{numerocarteira}:
get:
tags:
- Cadastros auxiliares
summary: GetEspecialidade
description: 'Lista **especialidades e linhas de atuação** disponíveis para filtro na rede, considerando **UF** e **tipo de recurso** (ou **`TODOS`** para não filtrar por tipo). Informe a carteirinha no path e os filtros na consulta.
'
parameters:
- name: numerocarteira
in: path
required: true
schema:
type: string
description: Carteirinha do beneficiário para contextualizar a lista.
- name: cdUF
in: query
required: true
schema:
type: string
description: UF em que se deseja listar especialidades.
- name: idTipoRecurso
in: query
required: true
schema:
type: string
example: TODOS
description: Tipo de recurso desejado ou `TODOS` para considerar todos os tipos.
responses:
'200':
description: Lista de especialidades, em geral ordenada para facilitar a escolha na interface.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/VwClinicApiEspecialidade'
'400':
description: Requisição inválida.
'401':
description: Não autorizado.
'500':
description: Erro interno do servidor.
components:
schemas:
VwClinicApiMunicipio:
type: object
description: Município com código, nome e UF para montagem de filtros e endereços.
additionalProperties: true
properties:
cdmunicipio:
type: string
description: Código do município.
cduf:
type: string
description: Código da UF.
dsmunicipio:
type: string
description: Nome do município.
cdmatalternativa:
type: string
description: Vínculo opcional com a carteirinha; em muitos retornos vem vazio.
VwClinicApiBairro:
type: object
description: Bairro associado ao município e UF selecionados, para refinamento de busca.
additionalProperties: true
properties:
dsbairro:
type: string
description: Nome do bairro.
cdmunicipio:
type: string
description: Código do município.
cduf:
type: string
description: Código da UF.
cdmatalternativa:
type: string
description: Vínculo opcional com a carteirinha; em muitos retornos vem vazio.
VwClinicApiEspecialidade:
type: object
description: 'Especialidade médica ou linha de atuação para filtro na rede. Alguns campos podem vir vazios ou com valor **genérico** quando a linha representa agrupamento ou “todas” as opções.
'
additionalProperties: true
properties:
cdespecialidade:
type: string
description: Código da especialidade ou identificador composto (ex. área de atuação).
dsespecialidade:
type: string
description: Nome da especialidade ou descrição de linha de atuação exibida ao usuário.
idtiporecurso:
type: string
description: Tipo de recurso associado; pode vir em branco em algumas linhas.
cduf:
type: string
description: UF relacionada à especialidade ou à linha de atuação.
cdmatalternativa:
type: string
description: Vínculo com carteira; pode ser vazio ou nulo.
VwClinicApiUf:
type: object
description: Estado brasileiro (**UF**) com código e nome para uso em listas e filtros.
additionalProperties: true
properties:
cduf:
type: string
description: Código da UF.
nmuf:
type: string
description: Nome da unidade federativa.
cdmatalternativa:
type: string
description: Vínculo opcional com a carteirinha; em muitos retornos vem vazio.
VwClinicApiRecurso:
type: object
description: 'Tipo de recurso ou modalidade de atendimento (ex.: consulta, exame). Pode incluir uma linha **`TODOS`** para representar “qualquer tipo” nos filtros.
'
additionalProperties: true
properties:
idtiporecurso:
type: string
description: Identificador do tipo de recurso (alinhado à descrição exibida ou a `TODOS`).
dstiporecurso:
type: string
description: Descrição do tipo de recurso ou `TODOS`.
cdmatalternativa:
type: string
description: Vínculo opcional com a carteirinha; em muitos retornos vem vazio.
securitySchemes:
x-api-key:
type: apiKey
name: x-api-key
in: header