Gender
| Valor | Descrição |
|---|---|
male | Masculino |
female | Feminino |
Marital Status
| Valor | Descrição |
|---|---|
single | Solteiro |
married | Casado |
divorced | Divorciado |
widowed | Viúvo |
others | Outros |
Member Type
| Valor | Descrição |
|---|---|
primary | Titular |
dependent | Dependente |
Product Types
| Valor | Descrição |
|---|---|
health-insurance | Plano de saúde |
dental-insurance | Plano odontológico |
life-insurance | Seguro de vida |
mental-health | Saúde mental, terapia online, etc. |
gym | Academia |
pet-insurance | Seguro Pet |
private-pension | Previdência privada |
air-medical-transport | Transporte médico aéreo |
health-navigation | Pipo Cuida |
Relationship Types (Dependentes)
| Valor | Descrição |
|---|---|
adopted-child | Filho adotivo/Filha adotiva |
child | Filho/Filha |
companion | Parceiro/Parceira |
grandchild | Neto/Neta |
grandparent | Avô/Avó |
great-grandchild | Bisneto/Bisneta |
niece-or-nephew | Sobrinho/Sobrinha |
parent-in-law | Sogro/Sogra |
parent | Pai/Mãe |
sibling | Irmão/irmã |
spouse | Cônjuge |
stepchild | Enteado/Enteada |
uncle-or-aunt | Tio/Tia |
unknown | Desconhecido |
ward | Tutelado/Tutelada |
Work Contract Types
| Valor | Descrição |
|---|---|
brazil-labor-law | CLT (Consolidação das Leis do Trabalho) |
services-contract | Prestador de Serviços (Pessoa Jurídica) |
partner | Sociedade |
intern | Estágio |
on-leave | Afastamento |
other | Outros |
Enrollment Status
| Valor | Descrição |
|---|---|
cancelled | Cancelada |
completed | Completa |
failed | Falha |
not-submitted | Não submetida |
pending | Pendente |
requested | Recebida pela Pipo |
requested-cancellation | Cancelamento solicitado |
scheduled | Agendada |
submission-failed | Envio para operadora com falha |
submitted | Enviada para operadora |
Enrollment Types
| Valor | Descrição |
|---|---|
inclusion | Inclusão |
exclusion | Exclusão |
alteration | Alteração |
Exclusion Reasons
| Valor | Descrição |
|---|---|
dismissal | Demissão |
voluntary-dismissal | Demissão voluntária |
just-cause-dismissal | Demissão por justa causa |
requested-by-beneficiary | Solicitado pelo beneficiário |
other | Outro (requer detalhes) |
Request Status
| Valor | Descrição |
|---|---|
processing | Processando |
completed | Concluído |
partial-failure | Falha parcial |
failed | Falhado |
Request Item Status
Status de cada parte de uma requisição, por CPF e produto, retornado emstatus-by-tax-id de
GET /v1/request/{request-id}.
| Valor | Descrição |
|---|---|
enrollment-created | Movimentação criada para este CPF/produto |
enrollment-creation-failed | Falha ao criar a movimentação para este CPF/produto |
pending | Aguardando processamento |
Webhook Status
Valores do campostatus das notificações de webhook.
| Valor | Descrição |
|---|---|
enrollment-created | Movimentação solicitada (pedido recebido) |
enrollment-completed | Movimentação concluída |
Request Type
| Valor | Descrição |
|---|---|
inclusion | Inclusão |
exclusion | Exclusão |
alteration | Alteração |
Start Options
| Valor | Descrição |
|---|---|
on-inclusion-date | Plano iniciará na data do envio do pedido de inclusão |
on-admission-date | Plano iniciará na data de admissão do beneficiário |
on-next-billing-period | Plano iniciará no início do próximo período de faturamento da apólice |
on-current-billing-period | Plano iniciará no período de faturamento atual (vigente) da apólice. Ver Convenções. |
Document Types
| Valor | Descrição |
|---|---|
beneficiary-inclusion-form | Ficha de Inclusão |
birth-certificate-or-national-id | Certidão de Nascimento ou CIN/RG |
company-letter | Carta da Empresa |
company-linking-declaration | Declaração de Vínculo Econômico |
company-social-contract | Contrato Social da empresa (Cliente) |
document-proving-relationship | Comprovante de Vínculo de Relacionamento |
employee-social-contract | Contrato Social da empresa PJ do funcionário |
employee-tax-id-card | Cartão CNPJ da empresa PJ do funcionário |
employment-contract | Contrato de Prestação de Serviços |
enrollment-request | Proposta de Seguros |
exclusion-file | Ficha de Exclusão |
guardianship-certificate | Documento comprobatório de Guarda ou Tutela da criança |
identification-document-with-tax-id | Documento de Identificação que contenha o número do CPF - Frente e verso (CIN, RG ou CNH) |
invoice | Fatura de Serviço |
marriage-certificate | Certidão de Casamento |
proof-of-dependent-relationship | Documento comprobatório do relacionamento entre o Titular e o Dependente |
proof-of-employment | Comprovante de Vínculo Empregatício |
proof-of-promotion | Prova de promoção de cargo |
proof-of-residency | Comprovante de Residência |
rescission | Documento de Rescisão Contratual |
same-sex-marriage-certificate | Certidão de Casamento Homoafetivo |
other | Outro tipo de documento não coberto pelos tipos anteriormente listados |
National Id Type
| Valor | Descrição |
|---|---|
RG | Registro Geral |
RNM | Registro Nacional Migratório |
CNH | Carteira Nacional de Habilitação |
passport | Passaporte |