{
  "aid": "swaggerhub.flaviamarco:api-servico-de-movimentacao-beneficiarios-1.0.0",
  "name": "API Serviço de Movimentação Beneficiarios",
  "type": "Index",
  "description": "Esta API é responsável pela gestão do cadastro do beneficiário. Ela é mantida pela equipe de TI da Unimed Brasil.\n# Observações Importantes\n- Esta API é de uso exclusivo das Unimeds Singulares.\n- O funcionamento dos recursos desta API somente ocorrerá mediante o envio do access token gerado previamente com o uso de `CLIENT_ID` e `CLIENT_SECRET`.\n- Todos os campos de data e data/hora seguem o padrão ISO-8601.\n- Todos os campos do tipo boolean podem ser enviados como `true` ou `false`, ou também como `1` ou `0`. `true` e `1` significam \"Verdadeiro\", enquanto `false` e `0` significam \"Falso\".\n- Abaixo temos uma relação das mensagens de erro (codigoMensagem - descricaoMensagem) que podem ser retornados pelos endpoints desta API. O campo descricaoMensagem contém o detalhe exato do problema ocorrido. Os códigos da família 400 são validações na estrutura do payload, enquanto os códigos da família 422 são validações de negócio.\n  - `400.001` - O campo `{0}` é obrigatório.\n  - `400.002` - O valor informado para o campo `{0}` é inválido.\n  - `400.003` - O campo `{0}` não aceita sequência de números, espaços ou caracteres especiais.\n  - `400.004` - O campo `{0}` não aceita sequência de zeros, espaços ou caracteres especiais.\n  - `400.005` - O campo `{0}` não possui dígito verificador válido.\n  - `400.006` - O campo `{0}` só aceita dígitos.\n  - `400.007` - O campo `{0}` não aceita apenas zeros.\n  - `400.008` - O campo `{0}` não aceita caracteres especiais.\n  - `400.009` - O campo `{0}` não aceita alguns caracteres especiais, somente `{1}` são aceitos.\n  - `400.010` - O campo `{0}` não possui a quantidade de caracteres esperada.\n  - `400.011` - O campo `{0}` excedeu o tamanho máximo permitido.\n  - `400.012` - O campo `{0}` não atingiu o tamanho mínimo permitido.\n  - `400.013` - O campo beneficiarios deve conter no máximo `{0}` registros.\n  - `400.014` - O campo `{0}` está no formato incorreto.    \n  - `422.001` - Beneficiário não encontrado.\n  - `422.002` - O campo `{0}` deve conter `{1}` caracteres.\n  - `422.003` - Informar ou CNPJ, ou o CAEPF da empresa contratante.\n  - `422.004` - Código Unimed inválido no campo `{0}`.\n  - `422.005` - O valor fornecido para o campo `{0}` já existe na base de dados.\n  - `422.006` - O campo `{0}` não deve ser anterior a `{1}`.\n  - `422.007` - `{0}` não deve ser posterior a `{1}`.\n  - `422.008` - `{0}` é obrigatório quando `{1}` estiver preenchido.\n  - `422.009` - `{0}` são obrigatórios quando um deles estiver preenchido.\n  - `422.010` - Pelo menos um dos campos deve estar preenchido: `{0}`.\n  - `422.011` - A URL da Unimed de destino não está configurada para o fluxo de compartilhamento de risco.\n  - `422.012` - CarteirinhaBeneficiarioTitular não existe na base de dados ou não corresponde a um titular. Falha ao cadastrar dependente.\n  - `422.013` - `{0}` deve ser `{1}`, quando `{2}` for `{3}`.\n  - `422.014` - O campo `{0}` não é valido.\n  - `422.015` - O codigoControleUnimedBrasil não corresponde ao beneficiário informado.\n  - `422.016` - `{0}` são obrigatórios quando `{1}`.\n  - `422.017` - `{0}` obrigatório quando o campo `{1}` for `{2}`.\n  - `422.018` - Só um pode ser true: {0}.\n  - `422.019` - O campo `{0}` é inválido, pois contém termos inapropriados.\n  - `422.020` - `{0}` com valor `{1}` é inválido conforme a tabela `{2}`.\n  - `422.021` - `{0}` não pode ser validado, pois `{1}` está indisponível.\n  - `422.022` - O campo `{0}` não aceita sequência de zeros, espaços ou caracteres especiais.\n  - `422.023` - Atualização não realizada. Os valores fornecidos já estão registrados na base de dados.\n  - `422.024` - A integração com o armazenamento de dados das transações não está configurada.\n  - `422.025` - A transação de código `{0}` já foi processada para a Unimed `{1}`.\n  - `422.026` - O campo `{0}` não aceita palavras com apenas uma letra.\n  - `422.027` - O campo `{0}` só aceita letras.\n  - `422.028` - O campo `{0}` não aceita sequência de espaços em branco.\n  - `422.029` - O campo `{0}` é obrigatório.\n  - `422.030` - As datas informadas são inválidas.\n  - `422.031` - O campo codigoControleUnimedBrasil não está vinculado à carteirinha informada.\n  - `422.032` - Beneficiário provisório não pode ser atualizado.\n  - `422.033` - A diferença entre a dataInicio e dataFim não pode ser superior a 3 meses.\n  - `422.034` - O campo carteirinhaCompRisco gerado pela Unimed `{0}` é inválido.\n  - `422.035` - O campo `{0}` é obrigatório e não pode ser excluído dos dados do beneficiário.\n  - `422.036` - O campo carteirinhaBeneficiario e carteirinhaBeneficiarioTitular não devem ser iguais para beneficiários dependentes.\n  - `422.037` - O campo `{0}` é obrigatório quando Autogestão, APS, Saúde Ocup., Acid. Trab. forem falsos.\n  - `422.038` - Campo codigoVersaoPTU inválido. A versão 11 já está disponível e deve ser utilizada.\n  - `422.039` - Somente um dos campos deve estar preenchido: `{0}`.\n  - `422.040` - Inscrição inválida entre empresa matriz e filial.\n  - `422.041` - Houve um problema na integração com o VCOM.    \n  - `500.001` - Erro inesperado ao processar a requisição.\n  - `500.002` - Falha ao integrar com Unimed de destino.\n",
  "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.flaviamarco/api-servico-de-movimentacao-beneficiarios/1.0.0/apis.json",
  "tags": [
    "swaggerhub.flaviamarco",
    "api-servico-de-movimentacao-beneficiarios"
  ],
  "created": "2026-04-04",
  "modified": "2026-04-04",
  "specificationVersion": "0.19",
  "access": "3rd-Party",
  "maintainers": [
    {
      "FN": "Jentic",
      "X-github": "jentic",
      "url": "https://github.com/jentic"
    }
  ],
  "apis": [
    {
      "aid": "swaggerhub.flaviamarco:api-servico-de-movimentacao-beneficiarios-1.0.0",
      "name": "API Serviço de Movimentação Beneficiarios",
      "description": "Esta API é responsável pela gestão do cadastro do beneficiário. Ela é mantida pela equipe de TI da Unimed Brasil.\n# Observações Importantes\n- Esta API é de uso exclusivo das Unimeds Singulares.\n- O funcionamento dos recursos desta API somente ocorrerá mediante o envio do access token gerado previamente com o uso de `CLIENT_ID` e `CLIENT_SECRET`.\n- Todos os campos de data e data/hora seguem o padrão ISO-8601.\n- Todos os campos do tipo boolean podem ser enviados como `true` ou `false`, ou também como `1` ou `0`. `true` e `1` significam \"Verdadeiro\", enquanto `false` e `0` significam \"Falso\".\n- Abaixo temos uma relação das mensagens de erro (codigoMensagem - descricaoMensagem) que podem ser retornados pelos endpoints desta API. O campo descricaoMensagem contém o detalhe exato do problema ocorrido. Os códigos da família 400 são validações na estrutura do payload, enquanto os códigos da família 422 são validações de negócio.\n  - `400.001` - O campo `{0}` é obrigatório.\n  - `400.002` - O valor informado para o campo `{0}` é inválido.\n  - `400.003` - O campo `{0}` não aceita sequência de números, espaços ou caracteres especiais.\n  - `400.004` - O campo `{0}` não aceita sequência de zeros, espaços ou caracteres especiais.\n  - `400.005` - O campo `{0}` não possui dígito verificador válido.\n  - `400.006` - O campo `{0}` só aceita dígitos.\n  - `400.007` - O campo `{0}` não aceita apenas zeros.\n  - `400.008` - O campo `{0}` não aceita caracteres especiais.\n  - `400.009` - O campo `{0}` não aceita alguns caracteres especiais, somente `{1}` são aceitos.\n  - `400.010` - O campo `{0}` não possui a quantidade de caracteres esperada.\n  - `400.011` - O campo `{0}` excedeu o tamanho máximo permitido.\n  - `400.012` - O campo `{0}` não atingiu o tamanho mínimo permitido.\n  - `400.013` - O campo beneficiarios deve conter no máximo `{0}` registros.\n  - `400.014` - O campo `{0}` está no formato incorreto.    \n  - `422.001` - Beneficiário não encontrado.\n  - `422.002` - O campo `{0}` deve conter `{1}` caracteres.\n  - `422.003` - Informar ou CNPJ, ou o CAEPF da empresa contratante.\n  - `422.004` - Código Unimed inválido no campo `{0}`.\n  - `422.005` - O valor fornecido para o campo `{0}` já existe na base de dados.\n  - `422.006` - O campo `{0}` não deve ser anterior a `{1}`.\n  - `422.007` - `{0}` não deve ser posterior a `{1}`.\n  - `422.008` - `{0}` é obrigatório quando `{1}` estiver preenchido.\n  - `422.009` - `{0}` são obrigatórios quando um deles estiver preenchido.\n  - `422.010` - Pelo menos um dos campos deve estar preenchido: `{0}`.\n  - `422.011` - A URL da Unimed de destino não está configurada para o fluxo de compartilhamento de risco.\n  - `422.012` - CarteirinhaBeneficiarioTitular não existe na base de dados ou não corresponde a um titular. Falha ao cadastrar dependente.\n  - `422.013` - `{0}` deve ser `{1}`, quando `{2}` for `{3}`.\n  - `422.014` - O campo `{0}` não é valido.\n  - `422.015` - O codigoControleUnimedBrasil não corresponde ao beneficiário informado.\n  - `422.016` - `{0}` são obrigatórios quando `{1}`.\n  - `422.017` - `{0}` obrigatório quando o campo `{1}` for `{2}`.\n  - `422.018` - Só um pode ser true: {0}.\n  - `422.019` - O campo `{0}` é inválido, pois contém termos inapropriados.\n  - `422.020` - `{0}` com valor `{1}` é inválido conforme a tabela `{2}`.\n  - `422.021` - `{0}` não pode ser validado, pois `{1}` está indisponível.\n  - `422.022` - O campo `{0}` não aceita sequência de zeros, espaços ou caracteres especiais.\n  - `422.023` - Atualização não realizada. Os valores fornecidos já estão registrados na base de dados.\n  - `422.024` - A integração com o armazenamento de dados das transações não está configurada.\n  - `422.025` - A transação de código `{0}` já foi processada para a Unimed `{1}`.\n  - `422.026` - O campo `{0}` não aceita palavras com apenas uma letra.\n  - `422.027` - O campo `{0}` só aceita letras.\n  - `422.028` - O campo `{0}` não aceita sequência de espaços em branco.\n  - `422.029` - O campo `{0}` é obrigatório.\n  - `422.030` - As datas informadas são inválidas.\n  - `422.031` - O campo codigoControleUnimedBrasil não está vinculado à carteirinha informada.\n  - `422.032` - Beneficiário provisório não pode ser atualizado.\n  - `422.033` - A diferença entre a dataInicio e dataFim não pode ser superior a 3 meses.\n  - `422.034` - O campo carteirinhaCompRisco gerado pela Unimed `{0}` é inválido.\n  - `422.035` - O campo `{0}` é obrigatório e não pode ser excluído dos dados do beneficiário.\n  - `422.036` - O campo carteirinhaBeneficiario e carteirinhaBeneficiarioTitular não devem ser iguais para beneficiários dependentes.\n  - `422.037` - O campo `{0}` é obrigatório quando Autogestão, APS, Saúde Ocup., Acid. Trab. forem falsos.\n  - `422.038` - Campo codigoVersaoPTU inválido. A versão 11 já está disponível e deve ser utilizada.\n  - `422.039` - Somente um dos campos deve estar preenchido: `{0}`.\n  - `422.040` - Inscrição inválida entre empresa matriz e filial.\n  - `422.041` - Houve um problema na integração com o VCOM.    \n  - `500.001` - Erro inesperado ao processar a requisição.\n  - `500.002` - Falha ao integrar com Unimed de destino.\n",
      "image": "",
      "baseURL": "https://gateway-sandbox.unimed.coop.br/cadbenef-online/v1",
      "humanURL": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.flaviamarco/api-servico-de-movimentacao-beneficiarios/1.0.0",
      "version": "1.0.0",
      "tags": [
        "swaggerhub.flaviamarco",
        "api-servico-de-movimentacao-beneficiarios"
      ],
      "properties": [
        {
          "type": "OpenAPI",
          "name": "OpenAPI definition",
          "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.flaviamarco/api-servico-de-movimentacao-beneficiarios/1.0.0/openapi.json",
          "mediaType": "application/openapi+json"
        },
        {
          "type": "GitHubRepo",
          "url": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.flaviamarco/api-servico-de-movimentacao-beneficiarios/1.0.0"
        }
      ],
      "contact": [
        {
          "FN": "Unimed Brasil",
          "email": "api@unimedbrasil.coop.br",
          "url": "http://unimed.coop.br"
        }
      ]
    }
  ]
}