> ## 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.

# Inclusão em lote

> Inclui novos membros e/ou grupos familiares em lote.



## OpenAPI

````yaml openapi.yaml POST /v1/enrollment/inclusion
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: 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/inclusion:
    post:
      tags:
        - Movimentações
      summary: Inclusão em lote
      description: Inclui novos membros e/ou grupos familiares em lote.
      parameters:
        - $ref: '#/components/parameters/AutoResolveEnrollments'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemberInclusionRequest'
            examples:
              titular:
                summary: Inclusão de titular
                value:
                  company-tax-id: '12345678000190'
                  members:
                    - beneficiary-type: primary
                      name: João Silva
                      tax-id: '12345678900'
                      mothers-name: Maria Silva
                      date-of-birth: '1985-05-15'
                      gender: male
                      marital-status: married
                      admission-date: '2024-01-01'
                      work-contract-type: brazil-labor-law
                      job-title: Desenvolvedor Senior
                      employee-id: EMP001
                      salary: 800000
                      email-corporate: joao.silva@acme.com
                      email-private: joao.silva@email.com
                      phone: '11987654321'
                      products:
                        health-insurance:
                          - name: Plano Saúde Premium
                            start-option: on-inclusion-date
              grupo-familiar:
                summary: Inclusão de grupo familiar (membro com dependentes)
                value:
                  company-tax-id: '12345678000190'
                  members:
                    - beneficiary-type: primary
                      name: Mariazinha da Silva
                      tax-id: '12345678900'
                      mothers-name: Mãe Maria Silva
                      date-of-birth: '1985-05-15'
                      gender: female
                      marital-status: married
                      admission-date: '2024-01-01'
                      work-contract-type: brazil-labor-law
                      job-title: Desenvolvedora Senior
                      employee-id: EMP001
                      salary: 800000
                      email-corporate: maria.silva@acme.com
                      email-private: maria.silva@email.com
                      phone: '11987654321'
                      documents:
                        - document-id: cd56c772-e8d9-4ce9-82c7-7bb155de40cc
                          document-type: identification-document-with-tax-id
                        - document-id: 957ef952-8515-4dd6-b356-c1434a8e9f33
                          document-type: enrollment-request
                      products:
                        health-insurance:
                          - product-id: 4de3d975-a4ed-47ab-aab9-d4a190fea06f
                            start-option: on-inclusion-date
                        dental-insurance:
                          - product-id: 6b9616e3-f76b-414f-b5d5-75ebc90d5895
                            start-option: on-inclusion-date
                    - beneficiary-type: dependent
                      name: Filho da Mariazinha
                      tax-id: '41165181070'
                      primary-tax-id: '12345678900'
                      mothers-name: Mariazinha da Silva
                      date-of-birth: '2020-03-01'
                      gender: male
                      marital-status: single
                      dependent-relationship-type: child
                      dependent-relationship-start-date: '2020-03-01'
                      phone: '11911234456'
                      email-private: filho.mariazinha@example.com
                      weight: 7000
                      height: 18000
                      handicapped: 'no'
                      documents:
                        - document-id: e079e1ad-bdff-49e9-85f7-fbd228ca15fd
                          document-type: document-proving-relationship
                      products:
                        health-insurance:
                          - product-id: 4de3d975-a4ed-47ab-aab9-d4a190fea06f
                            start-option: on-inclusion-date
      responses:
        '200':
          $ref: '#/components/responses/RequestAccepted'
        '403':
          $ref: '#/components/responses/NotEntitledCompany'
        '422':
          description: >-
            Dados inválidos, movimentação não aceita — payload com offenses
            (violações de validação) e com dados do membro referentes à ofensa.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: array
                    items:
                      $ref: '#/components/schemas/FlatMemberWithOffenses'
              example:
                result:
                  - beneficiary-type: primary
                    name: João Silva
                    tax-id: '12345678900'
                    company-tax-id: '12345678000190'
                    offenses:
                      - invalid-tax-id
                      - missing-mothers-name
components:
  parameters:
    AutoResolveEnrollments:
      name: auto-resolve-enrollments
      in: query
      required: false
      schema:
        type: string
        enum:
          - approve
          - reject
      description: >
        Resolve automaticamente a movimentação: `approve` aprova; `reject`
        rejeita.

        **Esta opção existe apenas no ambiente de Homologação, para testes.**
  schemas:
    MemberInclusionRequest:
      type: object
      required:
        - company-tax-id
        - members
      properties:
        company-tax-id:
          $ref: '#/components/schemas/Cnpj'
        members:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/FlatMember'
    FlatMemberWithOffenses:
      allOf:
        - $ref: '#/components/schemas/FlatMember'
        - type: object
          required:
            - company-tax-id
          properties:
            company-tax-id:
              $ref: '#/components/schemas/Cnpj'
            offenses:
              type: array
              items:
                type: string
            documents:
              type: array
              items:
                allOf:
                  - $ref: '#/components/schemas/Document'
                  - type: object
                    properties:
                      offenses:
                        type: array
                        items:
                          type: string
    Cnpj:
      type: string
      description: >-
        CNPJ (Cadastro Nacional da Pessoa Jurídica). Aceita apenas dígitos ou
        formatado.
      examples:
        - '12345678000190'
        - 12.345.678/0001-90
    FlatMember:
      description: >-
        Membro a incluir em lote. Herda a estrutura base do beneficiário e
        complementa com produtos, contrato de trabalho, endereço, dados
        bancários e — para dependentes — o vínculo com o titular.
      allOf:
        - $ref: '#/components/schemas/BeneficiaryBase'
        - type: object
          required:
            - products
          properties:
            products:
              $ref: '#/components/schemas/ProductsMap'
            admission-date:
              type: string
              format: date
            work-contract-type:
              $ref: '#/components/schemas/WorkContractType'
            job-title:
              type: string
            employee-id:
              type: string
            cost-center:
              type: string
            salary:
              type: integer
              description: Renda em centavos.
            email-corporate:
              type: string
              format: email
            address-postal-code:
              type: string
            address-street:
              type: string
            address-number:
              type: string
            address-complement:
              type: string
            address-neighborhood:
              type: string
            address-city:
              type: string
            address-state:
              type: string
            bank-number:
              type: string
              description: Código do banco (BACEN, 3 dígitos).
            bank-branch-number:
              type: string
              description: Agência (BACEN, 4-5 dígitos, sem dígito verificador).
            bank-account-number:
              type: string
              description: Conta (BACEN, 6-10 dígitos, com dígito verificador).
            primary-tax-id:
              $ref: '#/components/schemas/Cpf'
              description: >-
                CPF do membro titular, usado para vincular o dependente ao seu
                titular. Obrigatório apenas quando `beneficiary-type` é
                `dependent`.
            dependent-relationship-type:
              $ref: '#/components/schemas/RelationshipType'
              description: >-
                Tipo de relacionamento entre o dependente e o titular.
                Obrigatório apenas quando `beneficiary-type` é `dependent`.
            dependent-relationship-start-date:
              type: string
              format: date
              description: >-
                Data em que o relacionamento entre o dependente e o titular
                começou. Obrigatório apenas quando `beneficiary-type` é
                `dependent`.
          if:
            properties:
              beneficiary-type:
                const: dependent
            required:
              - beneficiary-type
          then:
            required:
              - primary-tax-id
              - dependent-relationship-type
              - dependent-relationship-start-date
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Mensagem descritiva do erro.
    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'
    BeneficiaryBase:
      description: >-
        Estrutura base do beneficiário. Os dados de um membro e de um dependente
        compartilham esta estrutura.
      type: object
      required:
        - beneficiary-type
        - name
        - tax-id
        - mothers-name
        - date-of-birth
        - gender
        - marital-status
      properties:
        beneficiary-type:
          $ref: '#/components/schemas/MemberType'
        name:
          type: string
        preferred-name:
          type: string
          description: Nome social do membro.
        tax-id:
          $ref: '#/components/schemas/Cpf'
        mothers-name:
          type: string
        date-of-birth:
          type: string
          format: date
        gender:
          $ref: '#/components/schemas/Gender'
        marital-status:
          $ref: '#/components/schemas/MaritalStatus'
        email-private:
          type: string
          format: email
        phone:
          type: string
        weight:
          type: integer
          description: >-
            Peso em quilogramas × 100 (70,45 kg = 7045). Ver Convenções ›
            Números decimais.
        height:
          type: integer
          description: >-
            Altura em centímetros × 100 (1,75 m = 17500). Ver Convenções ›
            Números decimais.
        handicapped:
          type: string
          enum:
            - 'yes'
            - 'no'
          description: Indica se o membro é PCD.
        document-type:
          $ref: '#/components/schemas/NationalIdType'
        document-number:
          type: string
        document-issuer:
          type: string
        document-issuer-state:
          type: string
        document-issue-date:
          type: string
          format: date
        documents:
          type: array
          items:
            $ref: '#/components/schemas/Document'
    ProductsMap:
      type: object
      description: Mapa de tipo de produto → lista de entradas de produto.
      additionalProperties:
        type: array
        items:
          $ref: '#/components/schemas/ProductEntry'
      example:
        health-insurance:
          - name: Plano Saúde Premium
            start-option: on-inclusion-date
    WorkContractType:
      type: string
      description: Tipo de contrato de trabalho.
      enum:
        - brazil-labor-law
        - services-contract
        - partner
        - intern
        - on-leave
        - other
    Cpf:
      type: string
      description: CPF (Cadastro de Pessoas Físicas). Aceita apenas dígitos ou formatado.
      examples:
        - '12345678900'
        - 123.456.789-00
    RelationshipType:
      type: string
      description: Tipo de relação do dependente com o titular.
      enum:
        - adopted-child
        - child
        - companion
        - grandchild
        - grandparent
        - great-grandchild
        - niece-or-nephew
        - parent-in-law
        - parent
        - sibling
        - spouse
        - stepchild
        - uncle-or-aunt
        - unknown
        - ward
    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
    MemberType:
      type: string
      description: Tipo de membro. primary=Titular, dependent=Dependente.
      enum:
        - primary
        - dependent
    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.
      enum:
        - single
        - married
        - divorced
        - widowed
        - others
    NationalIdType:
      type: string
      description: Tipo de documento de identidade nacional.
      enum:
        - RG
        - RNM
        - CNH
        - passport
    ProductEntry:
      type: object
      required:
        - start-option
      description: Entrada de produto na inclusão. Informe `name` ou `product-id`.
      properties:
        start-option:
          $ref: '#/components/schemas/StartOption'
        name:
          type: string
          description: Nome do produto.
        product-id:
          type: string
          format: uuid
        portability:
          type: string
          enum:
            - 'yes'
            - 'no'
          description: Portabilidade de carência (apenas produtos seguráveis).
    StartOption:
      type: string
      description: >
        Opção de início do benefício.

        `on-inclusion-date`, `on-admission-date`, `on-next-billing-period`,
        `on-current-billing-period`(esta última quando `on-next-billing-period`
        está habilitada; ver Convenções).
      enum:
        - on-inclusion-date
        - on-admission-date
        - on-next-billing-period
        - on-current-billing-period
  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
    NotEntitledCompany:
      description: Não autorizado a acessar esta empresa.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Not entitled to access this company
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token Bearer obtido em `POST /v1/authenticate`.

````