> ## Documentation Index
> Fetch the complete documentation index at: https://docs.piposaude.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Alteração de membro

> Solicita uma alteração para um membro já existente — troca de plano, troca da empresa
vinculada ao plano (CNPJ), e/ou correção de dados cadastrais, em uma única requisição.

`alteration-data` é um mapa de campos livres: deve conter **apenas** chaves
conhecidas e **pelo menos uma** das seguintes indicações de mudança:
- `new-product-id` — troca de plano.
- `new-company-tax-id` — troca do CNPJ vinculado ao plano.
- um ou mais campos cadastrais (`name`, `email`, `address-*`, `bank-*`, etc.).

Essas indicações podem ser combinadas na mesma requisição (ex.: troca de plano junto
com correção de e-mail).


<Warning>
  Este endpoint está disponível, por enquanto, apenas no ambiente de homologação
  (`https://api.pipo.health`). Ainda não deve ser utilizado em produção.
</Warning>


## OpenAPI

````yaml openapi.yaml POST /v1/enrollment/alteration/{member-tax-id}
openapi: 3.1.0
info:
  title: Pipo Public API
  version: 0.2.0
  description: >
    API pública da Pipo Saúde para integração de movimentações de benefícios

    (inclusões, exclusões e consultas) por parceiros e sistemas de folha de
    pagamento.
  contact:
    name: Pipo Engineering
    email: felipe.rodopoulos@piposaude.com.br
servers:
  - url: https://api.pipo.health
    description: Homologação (staging)
  - url: https://api.piposaude.com.br
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Autenticação
    description: Obtenção do token de acesso.
  - name: Empresas
    description: Consulta de empresas e seus produtos.
  - name: Benefícios
    description: Consulta de produtos/benefícios disponíveis.
  - name: Faturas
    description: Consulta de faturas, boletos e status de pagamento.
  - name: Movimentações
    description: Inclusões, exclusões e histórico de movimentações.
  - name: Membros
    description: Consulta de membros e seus benefícios.
  - name: Solicitações
    description: Consulta do status de requisições assíncronas.
  - name: Health Check
    description: Verificação de disponibilidade.
paths:
  /v1/enrollment/alteration/{member-tax-id}:
    post:
      tags:
        - Movimentações
      summary: Alteração de membro
      description: >
        Solicita uma alteração para um membro já existente — troca de plano,
        troca da empresa

        vinculada ao plano (CNPJ), e/ou correção de dados cadastrais, em uma
        única requisição.


        `alteration-data` é um mapa de campos livres: deve conter **apenas**
        chaves

        conhecidas e **pelo menos uma** das seguintes indicações de mudança:

        - `new-product-id` — troca de plano.

        - `new-company-tax-id` — troca do CNPJ vinculado ao plano.

        - um ou mais campos cadastrais (`name`, `email`, `address-*`, `bank-*`,
        etc.).


        Essas indicações podem ser combinadas na mesma requisição (ex.: troca de
        plano junto

        com correção de e-mail).
      parameters:
        - $ref: '#/components/parameters/MemberTaxIdPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlterationRequest'
            examples:
              troca-de-plano:
                summary: Troca de plano
                value:
                  company-tax-id: '12345678000190'
                  alteration-data:
                    new-product-id: 4de3d975-a4ed-47ab-aab9-d4a190fea06f
                    requested-start-date: '2026-10-01'
                    reason: Upgrade de plano solicitado pelo RH
              correcao-cadastral:
                summary: Correção cadastral com motivo e data de vigência
                value:
                  company-tax-id: '12345678000190'
                  alteration-data:
                    email: novo@email.com
                    requested-start-date: '2026-10-01'
                    reason: Solicitação do RH
              troca-de-cnpj:
                summary: Troca do CNPJ vinculado ao plano
                value:
                  company-tax-id: '12345678000190'
                  alteration-data:
                    new-company-tax-id: '44555666000199'
      responses:
        '200':
          $ref: '#/components/responses/RequestAccepted'
        '400':
          description: Dados inválidos — `alteration-data` vazio ou com chave desconhecida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Invalid alteration-data
        '401':
          description: Token ausente ou inválido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Invalid credentials
        '403':
          description: Não autorizado a alterar membros desta empresa.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: You are not authorized to alter members in this company.
        '404':
          description: >-
            Membro não encontrado, ou nenhum benefício primário ativo encontrado
            no membro.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                membro-nao-encontrado:
                  summary: Membro não encontrado
                  value:
                    error: Member not found
                sem-beneficio-ativo:
                  summary: Sem benefício primário ativo
                  value:
                    error: No active primary benefit found in member
components:
  parameters:
    MemberTaxIdPath:
      name: member-tax-id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/Cpf'
      description: CPF do membro.
  schemas:
    AlterationRequest:
      type: object
      required:
        - alteration-data
      properties:
        company-tax-id:
          $ref: '#/components/schemas/Cnpj'
        alteration-data:
          $ref: '#/components/schemas/AlterationData'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Mensagem descritiva do erro.
    Cpf:
      type: string
      description: CPF (Cadastro de Pessoas Físicas). Aceita apenas dígitos ou formatado.
      examples:
        - '12345678900'
        - 123.456.789-00
    Cnpj:
      type: string
      description: >-
        CNPJ (Cadastro Nacional da Pessoa Jurídica). Aceita apenas dígitos ou
        formatado.
      examples:
        - '12345678000190'
        - 12.345.678/0001-90
    AlterationData:
      type: object
      minProperties: 1
      description: >
        Mapa de campos livres com a(s) mudança(s) solicitada(s). Deve conter
        apenas as chaves

        abaixo, e ao menos uma de `new-product-id`, `new-company-tax-id` ou um
        campo cadastral.
      properties:
        new-product-id:
          type: string
          format: uuid
          description: ID do novo plano, para troca de plano.
        new-company-tax-id:
          $ref: '#/components/schemas/Cnpj'
        requested-start-date:
          type: string
          format: date
          description: Data em que a alteração deve entrar em vigor.
        reason:
          type: string
          description: Justificativa livre para a alteração.
        name:
          type: string
          description: Nome do membro.
        preferred-name:
          type: string
          description: Nome social/preferido.
        tax-id:
          $ref: '#/components/schemas/Cpf'
        mothers-name:
          type: string
          description: Nome da mãe do membro.
        date-of-birth:
          type: string
          format: date
          description: Data de nascimento.
        gender:
          $ref: '#/components/schemas/Gender'
        marital-status:
          $ref: '#/components/schemas/MaritalStatus'
        email:
          type: string
          format: email
        phone:
          type: string
          description: 'Telefone com DDD (ex.: 11987654321).'
        address-postal-code:
          type: string
          description: CEP.
        address-street:
          type: string
        address-number:
          type: string
        address-neighborhood:
          type: string
        address-complement:
          type: string
        address-city:
          type: string
        address-state:
          type: string
          description: 'UF (2 letras, ex.: SP).'
        company-id:
          type: string
          format: uuid
          description: ID interno da empresa vinculada ao membro (uso avançado).
        work-contract-type:
          $ref: '#/components/schemas/WorkContractType'
        monthly-salary:
          type: integer
          description: Salário mensal, em centavos.
        employee-company-tax-id:
          $ref: '#/components/schemas/Cnpj'
        bank-number:
          type: string
        bank-branch-number:
          type: string
        bank-account-number:
          type: string
        bank-account-owners-name:
          type: string
        bank-account-owners-tax-id:
          $ref: '#/components/schemas/Cpf'
        documents:
          type: array
          items:
            $ref: '#/components/schemas/Document'
    Gender:
      type: string
      description: Sexo biológico do membro.
      enum:
        - male
        - female
    MaritalStatus:
      type: string
      description: >-
        Estado civil. single=Solteiro, married=Casado, divorced=Divorciado,
        widowed=Viúvo, others=Outros. `other` também é aceito como alias de
        `others` e é normalizado automaticamente pela API.
      enum:
        - single
        - married
        - divorced
        - widowed
        - others
        - other
    WorkContractType:
      type: string
      description: Tipo de contrato de trabalho.
      enum:
        - brazil-labor-law
        - services-contract
        - partner
        - intern
        - on-leave
        - other
    Document:
      type: object
      required:
        - document-id
        - document-type
      description: Documento relacionado ao membro, previamente enviado via URL de upload.
      properties:
        document-id:
          type: string
          description: Identificador do documento, recebido ao solicitar a URL de upload.
        document-type:
          $ref: '#/components/schemas/DocumentType'
    DocumentType:
      type: string
      description: Tipo do documento anexado à movimentação.
      enum:
        - beneficiary-inclusion-form
        - birth-certificate-or-national-id
        - company-letter
        - company-linking-declaration
        - company-social-contract
        - document-proving-relationship
        - employee-social-contract
        - employee-tax-id-card
        - employment-contract
        - enrollment-request
        - exclusion-file
        - guardianship-certificate
        - identification-document-with-tax-id
        - invoice
        - marriage-certificate
        - proof-of-dependent-relationship
        - proof-of-employment
        - proof-of-promotion
        - proof-of-residency
        - rescission
        - same-sex-marriage-certificate
        - other
  responses:
    RequestAccepted:
      description: Movimentação processada com sucesso.
      content:
        application/json:
          schema:
            type: object
            required:
              - request-id
            properties:
              request-id:
                type: string
                format: uuid
                description: >-
                  Identificador da requisição. Use em `GET
                  /v1/request/{request-id}`.
          example:
            request-id: aaa11111-e89b-12d3-a456-426614174006
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token Bearer obtido em `POST /v1/authenticate`.

````