Vida

Produto Vida

O Seguro de Vida é a nossa solução para você que quer proteger seu bem maior.

As APIs da Pottencial permitem que sua empresa realize cotações, propostas e emissões de apólices para os produtos da Pottencial de forma integrada, rápida e segura.

O fluxo para emissão de uma apólice está descrito em passos simples abaixo:

Passo 1 - Autenticação: Gere um token de autenticação a partir de sua chave de acesso. Esse token será necessário nas demais operações.
Passo 2 - Solicitar cotação: Envie os dados da cotação e receba os valores do prêmio para os dados informados.
Passo 3 - Enviar proposta: Quando a cotação estiver pronta, envie os dados para criar uma proposta.
Passo 4 - Aceitar proposta: Aceite a proposta criada.
Passo 5 - Pagamento: Com o pagamento, recebe sua apólice por Email.

Pré-requisitos

Antes de começar a utilizar a API, é fundamental compreender os requisitos de autenticação e obter as credenciais necessárias.
Certifique-se de revisar a seção de autenticação para garantir uma integração segura e bem-sucedida.

Cotação

Solicitar cotação

Permite solicitar uma nova cotação para um produto Pottencial.

Cada produto possui regras específicas de preenchimento, que estão detalhadas em cada um dos campos.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/vida/quotes
Method	Post
Query	vida	Chave de identificação do produto.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	Quote

Para cadastro de cotação para o produto Vida é necessário informar um único objeto de risco do tipo Person.


  {
    "commissionedAgents": [
      {
        "documentNumber": "11111111111111",
        "role": "Broker",
        "commissionPercentage": 0.45,
        "isPayer": false,
        "lead": true
      }
    ],
    "participants": [
      {
        "documentNumber": "33333333333",
        "role": "Insured",
        "isPayer": false,
        "address": {
          "type": "Billing",
          "street": "Av. Raja Gabáglia",
          "number": "1143",
          "district": "Luxemburgo",
          "city": "Belo Horizonte",
          "state": "MG",
          "zipCode": "30380403",
          "complement": "20º andar"
        },
        "contact": {
          "name": "nome do contato",
          "email": "[email protected]",
          "cellPhoneNumber": "31999999999",
          "phoneNumber": "31999999999"
        }
      },
      {
        "documentNumber": "33333333333",
        "role": "Beneficiary",
        "isPayer": false,
        "address": {
          "type": "Residential",
          "street": "Av. Raja Gabáglia",
          "number": "1143",
          "district": "Luxemburgo",
          "city": "Belo Horizonte",
          "state": "MG",
          "zipCode": "30380403",
          "complement": "20º andar"
        },
        "contact": {
          "name": "nome do contato",
          "email": "[email protected]",
          "cellPhoneNumber": "31999999999",
          "phoneNumber": "31999999999"
        }
      }
    ],
    "riskObjects": [
      {
        "type": "Person",
        "coverages": [
          {
            "key": "basica",
            "insuredAmount": 100000
          },
          {
            "key": "morte-acidental",
            "insuredAmount": 100000
          },
          {
            "key": "invalidez",
            "insuredAmount": 100000
          },
          {
            "key": "auxilio-funeral",
            "insuredAmount": 100000
          },
          {
            "key": "despesa-medico-hospitalar-odontologica",
            "insuredAmount": 100000
          },
          {
            "key": "jazigo",
            "insuredAmount": 100000
          }
        ],
        "haveNoSeriousOrAutoimmuneDisease": true,
        "birthDate": "2023-04-06",
        "gender": "Female",
        "riskUF": "MG",
        "documentNumber": "55555555555555",
        "paymentConditions": {
          "paymentType": "AutomaticDebit",
          "installments": 2
        }
      }
    ]
  }

Cotação para o produto Vida com Assistencia

Para cadastro de cotação para o produto Vida é necessário informar um único objeto de risco do tipo Person.


{
  "commissionedAgents": [
    {
      "documentNumber": "11111111111111",
      "role": "Broker",
      "commissionPercentage": "0.45",
      "isPayer": "false",
      "lead": "true"
    }
  ],
  "participants": [
    {
      "documentNumber": "33333333333",
      "role": "Insured",
      "isPayer": "false",
      "address": {
        "type": "Billing",
        "street": "Av. Raja Gabáglia",
        "number": "1143",
        "district": "Luxemburgo",
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403",
        "complement": "20º andar"
      },
      "contact": {
        "name": "nome do contato",
        "email": "[email protected]",
        "cellPhoneNumber": "31999999999",
        "phoneNumber": "31999999999"
      }
    },
    {
      "documentNumber": "33333333333",
      "role": "Beneficiary",
      "isPayer": "false",
      "address": {
        "type": "Residential",
        "street": "Av. Raja Gabáglia",
        "number": "1143",
        "district": "Luxemburgo",
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403",
        "complement": "20º andar"
      },
      "contact": {
        "name": "nome do contato",
        "email": "[email protected]",
        "cellPhoneNumber": "31999999999",
        "phoneNumber": "31999999999"
      }
    }
  ],
  "riskObjects": [
    {
      "type": "Person",
      "coverages": [
        {
          "key": "basica",
          "insuredAmount": "100000"
        },
        {
          "key": "morte-acidental",
          "insuredAmount": "100000"
        },
        {
          "key": "invalidez",
          "insuredAmount": "100000"
        },
        {
          "key": "auxilio-funeral",
          "insuredAmount": "100000"
        },
        {
          "key": "despesa-medico-hospitalar-odontologica",
          "insuredAmount": "100000"
        },
        {
          "key": "jazigo",
          "insuredAmount": "100000"
        }
      ],
      "haveNoSeriousOrAutoimmuneDisease": "true",
      "birthDate": "2023-04-06",
      "gender": "Female",
      "riskUF": "MG",
      "documentNumber": "55555555555555",
      "paymentConditions": {
        "paymentType": "AutomaticDebit",
        "installments": 2
      }
    }
  ],
  "assistanceServices": [
    {
      "id": "111111-5553-4467-9883-555555555555"
    },
    {
      "id": "111111-5553-4467-9883-222222222222"
    }
  ]
}

Respostas (Response)

Status	Descrição	Tipo
200	Cotação cadastrada com sucesso.	Quote
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplos

Cotação para o produto Vida

Para cadastro de cotação para o produto Vida é necessário informar um único objeto de risco do tipo Person.


{
  "quoteId": "c03ab663-3d5c-4014-aa5e-cae727103392",
  "productKey": "vida",
  "policyType": "Unique",
  "quoteNumber": "99999",
  "createdAt": "2021-04-29T17:12:27.219Z",
  "status": "Approved",
  "commercialPremium": "109.98",
  "grossPremium": "99.99",
  "iof": "9.99",
  "commissionedAgents": [
    {
      "documentNumber": "11111111111111",
      "role": "Broker",
      "commissionPercentage": "0.15",
      "commissionAmount": "486.9,",
      "lead": "true",
      "isPayer": "false"
    }
  ],
  "participants": [
    {
      "documentNumber": "33333333333",
      "role": "Insured",
      "isPayer": "false",
      "address": {
        "type": "Residential",
        "street": "Av. Raja Gabáglia",
        "number": "1143",
        "district": "Luxemburgo",
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403",
        "complement": "20º andar"
      },
      "contact": {
        "name": "nome do contato",
        "email": "[email protected]",
        "phoneNumber": "31999999999",
        "cellPhoneNumber": "31999999999"
      }
    },
    {
      "documentNumber": "33333333333",
      "role": "Beneficiary",
      "isPayer": "false",
      "address": {
        "type": "Business",
        "street": "Av. Raja Gabáglia",
        "number": "1143",
        "district": "Luxemburgo",
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403",
        "complement": "20º andar"
      },
      "contact": {
        "name": "nome do contato",
        "email": "[email protected]",
        "phoneNumber": "31999999999",
        "cellPhoneNumber": "31999999999"
      }
    }
  ],
  "riskObjects": [
    {
      "type": "Person",
      "coverages": [
        {
          "key": "basica",
          "insuredAmount": "100000"
        },
        {
          "key": "morte-acidental",
          "insuredAmount": "100000"
        },
        {
          "key": "invalidez",
          "insuredAmount": "100000"
        },
        {
          "key": "auxilio-funeral",
          "insuredAmount": "100000"
        },
        {
          "key": "despesa-medico-hospitalar-odontologica",
          "insuredAmount": "100000"
        },
        {
          "key": "jazigo",
          "insuredAmount": "100000"
        }
      ],
      "riskUF": "MG",
      "haveNoSeriousOrAutoimmuneDisease": "true",
      "birthDate": "2021-04-29",
      "gender": "Male",
      "documentNumber": "55555555555555"
    }
  ]
}

Cotação para o produto Vida com Assistencia

Para cadastro de cotação para o produto Vida é necessário informar um único objeto de risco do tipo Person.


{
  "quoteId": "c03ab663-3d5c-4014-aa5e-cae727103392",
  "key": "vida",
  "policyType": "Unique",
  "quoteNumber": "99999",
  "createdAt": "2021-04-29T17:12:27.219Z",
  "status": "Approved",
  "commercialPremium": "109.98",
  "grossPremium": "99.99",
  "iof": "9.99",
  "commissionedAgents": [
    {
      "documentNumber": "11111111111111",
      "role": "Broker",
      "commissionPercentage": "0.15",
      "commissionAmount": "486.9,",
      "lead": "true",
      "isPayer": "false"
    }
  ],
  "participants": [
    {
      "documentNumber": "33333333333",
      "role": "Insured",
      "isPayer": "false",
      "address": {
        "type": "Residential",
        "street": "Av. Raja Gabáglia",
        "number": "1143",
        "district": "Luxemburgo",
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403",
        "complement": "20º andar"
      },
      "contact": {
        "name": "nome do contato",
        "email": "[email protected]",
        "phoneNumber": "31999999999",
        "cellPhoneNumber": "31999999999"
      }
    },
    {
      "documentNumber": "33333333333",
      "role": "Beneficiary",
      "isPayer": "false",
      "address": {
        "type": "Business",
        "street": "Av. Raja Gabáglia",
        "number": "1143",
        "district": "Luxemburgo",
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403",
        "complement": "20º andar"
      },
      "contact": {
        "name": "nome do contato",
        "email": "[email protected]",
        "phoneNumber": "31999999999",
        "cellPhoneNumber": "31999999999"
      }
    }
  ],
  "riskObjects": [
    {
      "type": "Person",
      "coverages": [
        {
          "key": "basica",
          "insuredAmount": "100000"
        },
        {
          "key": "morte-acidental",
          "insuredAmount": "100000"
        },
        {
          "key": "invalidez",
          "insuredAmount": "100000"
        },
        {
          "key": "auxilio-funeral",
          "insuredAmount": "100000"
        },
        {
          "key": "despesa-medico-hospitalar-odontologica",
          "insuredAmount": "100000"
        },
        {
          "key": "jazigo",
          "insuredAmount": "100000"
        }
      ],
      "riskUF": "MG",
      "haveNoSeriousOrAutoimmuneDisease": "true",
      "birthDate": "2021-04-29",
      "gender": "Male",
      "documentNumber": "55555555555555",
    }
  ],
  "assistanceServices": [
    {
      "id": "111111-5553-4467-9883-555555555555",
      "makeUpPremium": "true",
      "amount": "75.55",
      "commercialAmount": "22.55",
      "grossAmount": "22.55",
      "iof": "0.75",
      "financialCharge": "1",
      "installmentCost": "0",
      "linkDescription": "Combo Saúde"    
    },
    {
      "id": "111111-5553-4467-9883-222222222222",
      "makeUpPremium": "true",
      "amount": "75.55",
      "commercialAmount": "22.55",
      "grossAmount": "22.55",
      "iof": "0.75",
      "financialCharge": "1",
      "installmentCost": "0",
      "linkDescription": "Combo Saúde 3"      
    }
  ]
}

Consultar cotação

Permite consultar os dados de uma cotação.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/vida/quotes/{quote_id}
Method	Get
Query	vida	Chave de identificação do produto.
	quote_id	ID da cotação para consulta.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Cotação localizada com sucesso.	Quote
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplos

Cotação para o produto Vida

Para cadastro de cotação para o produto Vida é necessário informar um único objeto de risco do tipo Person.


{
  "quoteId": "c03ab663-3d5c-4014-aa5e-cae727103392",
  "productKey": "vida",
  "policyType": "Unique",
  "quoteNumber": "99999",
  "createdAt": "2021-04-29T17:12:27.219Z",
  "status": "Approved",
  "commercialPremium": "109.98",
  "grossPremium": "99.99",
  "iof": "9.99",
  "commissionedAgents": [
    {
      "documentNumber": "11111111111111",
      "role": "Broker",
      "commissionPercentage": "0.15",
      "commissionAmount": "486.9,",
      "lead": "true",
      "isPayer": "false"
    }
  ],
  "participants": [
    {
      "documentNumber": "33333333333",
      "role": "Insured",
      "isPayer": "false",
      "address": {
        "type": "Residential",
        "street": "Av. Raja Gabáglia",
        "number": "1143",
        "district": "Luxemburgo",
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403",
        "complement": "20º andar"
      },
      "contact": {
        "name": "nome do contato",
        "email": "[email protected]",
        "phoneNumber": "31999999999",
        "cellPhoneNumber": "31999999999"
      }
    },
    {
      "documentNumber": "33333333333",
      "role": "Beneficiary",
      "isPayer": "false",
      "address": {
        "type": "Business",
        "street": "Av. Raja Gabáglia",
        "number": "1143",
        "district": "Luxemburgo",
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403",
        "complement": "20º andar"
      },
      "contact": {
        "name": "nome do contato",
        "email": "[email protected]",
        "phoneNumber": "31999999999",
        "cellPhoneNumber": "31999999999"
      }
    }
  ],
  "riskObjects": [
    {
      "type": "Person",
      "coverages": [
        {
          "key": "basica",
          "insuredAmount": "100000"
        },
        {
          "key": "morte-acidental",
          "insuredAmount": "100000"
        },
        {
          "key": "invalidez",
          "insuredAmount": "100000"
        },
        {
          "key": "auxilio-funeral",
          "insuredAmount": "100000"
        },
        {
          "key": "despesa-medico-hospitalar-odontologica",
          "insuredAmount": "100000"
        },
        {
          "key": "jazigo",
          "insuredAmount": "100000"
        }
      ],
      "riskUF": "MG",
      "haveNoSeriousOrAutoimmuneDisease": "true",
      "birthDate": "2021-04-29",
      "gender": "Male",
      "documentNumber": "55555555555555"
    }
  ]
}

Propostas

Enviar proposta

Permite submeter uma nova proposta para um produto Pottencial. Para envio de uma proposta é necessário primeiramente ter realizado uma cotação a partir da API de cotação.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/vida/proposals
Method	Post
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	Proposal

Proposta pagamento efetuado na cotação

Proposta com pagamento efetuado na cotação .


{
  "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
  "policyPeriodStart": "2023-04-06T00:00:00.000Z",
  "policyPeriodEnd": "2024-04-06T00:00:00.000Z",
  "payment": {
    "paymentType": "AutomaticDebit",
    "firstDueDate": "2023-08-29T18:08:01.556Z",
    "paymentInstructions": "informaçoes da forma de pagamento",
    "automaticDebitAccount": {
      "bankCode": "001",
      "bankNumber": "5858",
      "accountNumber": "66544",
      "accountDigit": "1",
      "accountExtension": "X",
      "accountType": "Current"
    }
  }
}

Respostas (Response)

Status	Descrição	Tipo
200	Proposta submetida com sucesso.	Proposal
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplos

Resposta de proposta com débito em conta

Resposta de proposta com pagamento parcelado em 12 vezes através de débito em conta.


{
  "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
  "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
  "proposalNumber": "99999",
  "payment": {
    "paymentType": "AutomaticDebit",
    "firstDueDate": "2023-08-29",
    "paymentInstructions": "informaçoes da forma de pagamento",
    "automaticDebitAccount": {
      "bankCode": "001",
      "bankNumber": "5858",
      "accountNumber": "66544",
      "accountDigit": "0",
      "documentNumber": "1111111111"
    }
  },
  "createdAt": "2021-08-03",
  "status": "Ready"
}

Aceitar proposta

Permite aprovar uma proposta criada.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/vida/proposals/{proposal_id}/accept
Method	Post
Query	product_key	Chave de identificação do produto.
	proposal_id	ID da proposta.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Proposta aceita com sucesso.
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Consultar proposta

Essa operação permite consultar os dados de uma proposta a partir do ID. Algumas informações sensíveis de participantes e agentes comissionados são ofuscadas para atender a LGPD.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/vida/proposals/{proposal_id}
Method	Get
Query	product_key	Chave de identificação do produto.
	proposal_id	ID da proposta.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Proposta localizada com sucesso.	Proposal
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Exemplos

Resposta de proposta com débito em conta

Resposta de proposta com pagamento parcelado em 12 vezes através de débito em conta.


{
  "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
  "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
  "proposalNumber": "99999",
  "payment": {
    "paymentType": "AutomaticDebit",
    "installments": "12",
    "automaticDebitAccount": {
      "bankCode": "001",
      "bankNumber": "5858",
      "accountNumber": "66544",
      "accountDigit": "0",
      "documentNumber": "1111111111"
    }
  },
  "createdAt": "2021-08-03",
  "status": "Ready"
}

Consultar documento da proposta

Essa operação permite consultar o documento de uma proposta a partir do ID.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/vida/proposals/{proposal_id}/document
Method	Get
Query	vida	Chave de identificação do produto.
	proposal_id	ID da proposta.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Documento da proposta localizado com sucesso.	BLOB
401	Parceiro não autorizado a realizar a operação.	ErrorResult
404	Registro não encontrado.	ErrorResult
500	Erro interno da API. Por favor tente novamente mais tarde ou contate o suporte técnico da Pottencial.	ErrorResult

Dicionario

Quote

Representa uma cotação de um produto.

Campo	Tipo	Regras	Descrição
quoteId	string (uuid)	Somente leitura	ID único da cotação que a identifica dentro da Pottencial. Esse campo é preenchido automaticamente e retornado quando uma cotação é criada com sucesso. Ele deve ser armazenado pois é utilizado nas demais operações de consulta e proposta.
productId	string (uuid)	Somente leitura	ID único do produto. A API de produtos deve ser utilizada para recuperar a lista de produtos que estão disponíveis para cotação.
productKey	string (uuid)	Somente leitura	chave do produto. A API de produtos deve ser utilizada para recuperar a lista de produtos que estão disponíveis para cotação.
policyType	string (PolicyType)	Somente Leitura	Tipo de contratação da apólice, que no caso do produto Vida é Unique
quoteNumber	number	Opcional	Numero da Cotação
createdAt	string (date-time)	Somente leitura	Data e hora de criação da cotação. Esse campo é preenchido automaticamente e retornado quando uma cotação é criada com sucesso.
status	string (QuoteStatus)	Somente leitura	Situação atual da cotação. Esse campo é preenchido automaticamente e retornado quando uma cotação é criada com sucesso.
commercialPremium	number	Somente leitura	Valor de prêmio considerando-se subscrição e comercial, incluindo valores de comissão e prolabore. Esse campo é preenchido automaticamente e retornado quando uma cotação é criada com sucesso.
grossPremium	number	Somente leitura	Valor de prêmio total incluindo, além do prêmio comercial, o IOF e encargos financeiros. Esse campo é preenchido automaticamente e retornado quando uma cotação é criada com sucesso.
iof	number	Somente leitura	Valor do IOF da cotação. Esse campo é preenchido automaticamente e retornado quando uma cotação é criada com sucesso.
policyPeriodStart	string (date)	Opcional	Data de início de vigência da apólice.
policyPeriodEnd	string (date)	Opcional	Data do fim de vigência da apólice.
commissionedAgents	array de CommissionedAgent	Obrigatório	Lista de agentes comissionados da apólice, que inclui corretoras e estipulantes.
participants	array de Participant	Obrigatório	Lista de participantes da apólice, que inclui segurado, tomador e beneficiário
riskObjects	array de Person	Obrigatório	Lista de objetos segurados. Os objetos segurados variam conforme o produto informado.
assistanceServices	array de AssistanceServices	Opcional	Lista de Serviços de assistencia vinculado ao produto.

PolicyType

Tipo de contratação da apólice.

Unique: Contratação única.

QuoteStatus

Situação da cotação define o passo do fluxo que a cotação se encontra.

Creating: A cotação foi criada, porém ainda não foi encaminhada para a subscrição.
UnderAnalysis: A cotação está sob análise da subscrição.
Denied: A cotação não foi aprovada.
Approved: A cotação foi aprovada.

Participant

Representa um participante dentro da apólice.

Campo	Tipo	Regras	Descrição
documentNumber	string	Obrigatório	CPF/CNPJ do participante. Devem ser informados somente os dígitos, incluindo zeros à esquerda. Essa informação é ofuscada no retorno da API para atender a LGPD, trazendo somente alguns dígitos visíveis. Os demais são substituídos por asterísco (). Exemplos de retorno: 11699534000174 -> 11699\\\0001\\ 12345678909 -> 123\\\789\\*
role	string (ParticipantRole)	Obrigatório	Papel do participante na cotação. Os participantes que são obrigatórios varia por produto.
address	Address	Opcional	Endereço do participante.
emails	array de Email	Opcional	E-mails de contato do participante.
phones	array de Phone	Opcional	Telefone de contato do participante.
contact	Contact	Opcional	Contato do participante.
isPayer	boolean	Opcional	informa quem é o pagador da apolice.
relationship	string (Relationship)	Opcional	Grau de relacionamento entre beneficiário e segurado.

ParticipantRole

Lista de possíveis valores para os participantes da apólice.

Beneficiary: O beneficiário é a pessoa da apólice que tem direito a indenização do seguro em caso de problema (sinistro). O beneficiário pode ser uma pessoa diferente do segurado (que é quem está com o risco protegido) e do estipulante (que é quem está contratando o seguro), dependendo da situação.
Insured: O segurado é a pessoa, física ou jurídica, cujos interesses estão garantidos pela apólice de seguro. Geralmente é quem contrata o seguro.
PolicyHolder: Devedor das obrigações por ele assumidas no contrato principal. (Circular SUSEP 232/03).

Relationship

Lista de possíveis valores para a relação entre os Beneficiarios.

Spouse: Marido do Benficiario.
Father: Pai do Benficiario.
Mother: Mãe do Benficiario.
Child: Filho do Benficiario.
Others: Amigo , parente ou afins do Benficiario.

CommissionedAgent

Representa um agente comissionado dentro da apólice.

Campo	Tipo	Regras	Descrição
documentNumber	string	Obrigatório	CPF/CNPJ do agente comissionado. Devem ser informados somente os dígitos, incluindo zeros à esquerda. Essa informação é ofuscada no retorno da API para atender a LGPD, trazendo somente alguns dígitos vizíveis. Os demais são substituídos por asterísco (). Exemplos de retorno: 11699534000174 -> 11699\\\0001\\ 12345678909 -> 123\\\789\\*
role	string (CommissionedAgentRole)	Obrigatório	Papel desempenhado pelo agente comissionado. Os papéis obrigatórios variam por produto.
lead	boolean	Opcional	Identifica a corretora principal na cotação. Esse campo pode ser omitido quando somente houver uma única corretora na cotação.
commissionPercentage	number	Opcional	Percentual de comissão, no caso de corretora, e percentual de pró-labore, no caso de estipulante. O limite desse valor varia conforme o produto e contrato com a seguradora. O valor deve ter no máximo 3 casas decimais.
commissionAmount	number	Somente leitura	Valor de comissão, no caso de corretora, e valor de pró-labore, no caso de estipulante. Esse valor é preenchido no retorno da cotação.
address	Address	Opcional	Endereço do pagador.
isPayer	boolean	Opcional	informa quem é o pagador da apolice.

CommissionedAgentRole

Lista de possíveis valores para os agentes comissionados da apólice.

Broker: É o profissional especializado e habilitado a intermediar contratos de seguros entre as seguradoras, empresas e os consumidores, sejam eles pessoas físicas ou jurídicas.
PolicyOwner: O estipulante é a pessoa que contrata o seguro, independente se é ele que se beneficia do seguro ou se é ele quem vai receber a indenização. É o estipulante, ou dono da apólice, que preenche e assina a proposta de seguro, paga o prêmio, solicita eventuais modificações durante a vigência da apólice, autoriza a sua renovação, ou solicita o seu cancelamento quando for o caso.
InsuranceAgent: .

Email

Representa um e-mail de contato.

Campo	Tipo	Regras	Descrição
emailAddress	string	Obrigatório	Endereço de e-mail.

Phone

Representa um telefone de contato.

Campo	Tipo	Regras	Descrição
number	string	Obrigatório	Número do telefone, com DDD.

Coverage

Contém informações das coberturas para cotação.

Campo	Tipo	Regras	Descrição
key	string	Obrigatório	ID da cobertura, conforme cada produto. Vida Invalidez por acidente: basica Auxílio Funeral: auxilio-funeral Despesa médico hospitalar e odontológica: despesa-medico-hospitalar-odontologica Invalidez por acidente: invalidez Aquisição de Jazigo: jazigo Morte Acidental: morte-acidental
lmi	number	Opcional	Limite máximo de indenização. No caso de contratação única, este valor pode ser menor ou igual à soma da importância segurada dos objetos segurados. Na contratação item a item, este valor é exatamente a soma dos itens desta cobertura. Caso não seja informado, assume-se o valor da importância segurada.
insuredAmount	number	Opcional	Importância segurada, ou valor segurado, deste objeto de risco.
feeMultiple	number	Opcional	Identifica a taxa múltipla.
indemnityPeriod	number	Opcional	Identifica o período de indenização.

Person

Representa uma objeto de Risco do vida.

Campo	Tipo	Regras	Descrição
riskUF	string	Obrigatório	Sigla do estado da localidade, com duas letras.
haveNoSeriousOrAutoimmuneDisease	boolean	Obrigatório	Não tem doença grave ou autoimune
birthDate	string (date)	Obrigatório	Data de Aniversario da pessoa
gender	string	Obrigatório	Genero da pessoa Male: Masculino. Female: Feminino.
documentNumber	string	Opcional	CPF/CNPJ do Segurado. Devem ser informados somente os dígitos, incluindo zeros à esquerda.
coverages	array de Coverage	Obrigatório	Lista de coberturas para o objeto segurado.
paymentConditions	Payment	Obrigatório	Representa um objeto informando forma de pagamento.

AssistanceServices

Contém informações da assistencia service

Campo	Tipo	Regras	Descrição
id	Guid	Obrigatória	Identificador serviço de assistência vinculado ao produto na api AssistanceServices. Obter Identificador na Api Risk Object em: Serviço de Assistencia
linkDescription	string	Opcional	Descrição do serviço de assistência
makeUpPremium	boolean	Opcional	Indica se o serviço de assistência compõe o prêmio da apólice
amount	number	Opcional	Valor do serviço de assistência
commercialAmount	number	Opcional	Valor comercial do serviço de assistência Campo permitido para Canal do Corretor e Portal Api
grossAmount	number	Opcional	Valor bruto do serviço de assistência
iof	number	Opcional	Valor do iof do serviço de assistência Campo permitido para Canal do Corretor, Portal Api e Portal do Produto
financialCharge	number	Opcional	Valor dos encargos financeiros do serviço de assistência Campo permitido para Canal do Corretor, Portal Api e Portal do Produto
installmentCost	number	Opcional	Valor do adicional de fracionamento do serviço de assistência Campo permitido para Canal do Corretor, Portal Api e Portal do Produto

Proposal

Representa uma proposta de um produto.

Campo	Tipo	Regras	Descrição
proposalId	string (uuid)	Somente leitura	ID único da proposta. O ID será gerado automaticamente no retorno da API.
quoteId	string (uuid)	Obrigatório	ID único da cotação que vai dar origem à proposta.
proposalNumber	number	Opcional	Numero da Proposta
policyPeriodStart	string (date)	Opcional	Data de início de vigência da apólice. Esse valor pode ser omitido caso essa informação tenha sido informada no momento de cotação.
policyPeriodEnd	string (date)	Opcional	Data do fim de vigência da apólice. Esse valor pode ser omitido caso essa informação tenha sido informada no momento de cotação.
payment	Payment	Obrigatório	Detalhes do pagamento da apólice. (Devem ser os mesmos dados informados no momento da cotação)
createdAt	string (date-time)	Somente leitura	Data e hora de criação da proposta. Esse campo é preenchido automaticamente e retornado quando uma proposta é criada com sucesso.
status	string (ProposalStatus)	Somente leitura	Situação atual da proposta. Esse campo é preenchido automaticamente e retornado quando uma proposta é criada com sucesso.

ProposalStatus

Situação da proposta define o passo do fluxo que a proposta se encontra.

Pending: A proposta foi criada, porém ainda não foi definido meio de pagamento.
Ready: O meio de pagamento da proposta foi definido.
Issued: O documento da proposta foi emitido.
Accepted: A proposta foi aceita.

Payment

Representa os dados referentes ao pagamento da apólice.

Campo	Tipo	Regras	Descrição
paymentType	string (PaymentType)	Obrigatório	Forma de pagamento da apólice.
installments	integer	Obrigatório	Número de parcelas que será dividido o pagamento da apólice. Os produtos possuem regras específicas para a quantidade de parcelas que pode ser divido o pagamento.
automaticDebitAccount	BankAccount	Opcional	Dados bancários para pagamento através de débito em conta.

BankAccount

Representa os dados de uma conta bancária.

Campo	Tipo	Regras	Descrição
bankCode	string	Obrigatório	Código de compensação do banco, conforme cadastrado no Banco Central.
bankNumber	string	Obrigatório	Número a agência da conta bancária, sem dígito.
accountNumber	string	Obrigatório	Número da conta bancária, sem dígito.
accountDigit	string	Obrigatório	Dígito verificador da conta bancária.
documentNumber	string	Obrigatório	CPF/CNPJ do titular da conta bancária.
accountType	string	Opcional	tipo da conta . Current: Conta Corrente. Savings: Conta Poupança. Payments: Conta Pagamento.
accountExtension	string	Opcional	Letra verificador da conta bancária.

PaymentType

Lista as possíveis formas de pagamento da apólice.

AutomaticDebit: Pagamento através de débito em conta.

Policy

Representa uma apólice de um produto.

Campo	Tipo	Regras	Descrição
policyId	string (uuid)	Somente leitura	ID único da apólice. O ID será gerado automaticamente no retorno da API.
proposalId	string (uuid)	Obrigatório	ID único da proposta aceita anteriormente que vai dar origem à apólice.
quoteId	string (uuid)	Somente leitura	ID único da cotação que deu origem à proposta.
policyNumber	string	Somente leitura	Número da apólice.
policyPeriodStart	string (date)	Somente leitura	Data de início de vigência da apólice.
policyPeriodEnd	string (date)	Somente leitura	Data do fim de vigência da apólice.
status	string (PolicyStatus)	Somente leitura	Situação atual da apólice. Esse campo é preenchido automaticamente e retornado quando uma apólice é criada com sucesso.
createdAt	string (date-time)	Somente leitura	Data e hora de criação da apólice. Esse campo é preenchido automaticamente e retornado quando uma apólice é criada com sucesso.

PolicyStatus

Situação da apólice define o passo do fluxo que a apólice se encontra.

Creating
Modifying
Canceling
Active
Cancelled
Expired

Address

Representa uma localidade com endereço.

Campo	Tipo	Regras	Descrição
street	string	Obrigatório	Nome da avenida, rua ou praça da localidade.
number	string	Obrigatório	Número da localidade.
district	string	Obrigatório	Bairro do localidade.
city	string	Obrigatório	Nome da cidade da localidade, conforme cadastrado nos Correios.
state	string	Obrigatório	Sigla do estado da localidade, com duas letras.
zipCode	string	Obrigatório	CEP da localidade. Devem ser informados somente os dígitos.
complement	string	Opcional	Complemento da localidade. Apartamento, andar.
coutry	string	Opcional	Pais.
type	string	Opcional	Descrição da localidade Residential: Endereço Residencial. Business: Endereço Empresal. Billing: Endereço de Cobrança.

Resolução de erros

Código	Erro	Descrição	Solução
400	Bad Request	Invalid secret in Authorization header	O client_secret informado no header é inválido. Verifique se o client_secret informado é o mesmo da APP e se o header Authorization está sendo passado conforme especificado.
401	Unauthorized	Could not find a required APP in the request, identified by HEADER client_id.	O client_id informado no header é inválido. Verifique se o client_id informado é o mesmo da APP e se o header Authorization está sendo passado conforme especificado.
404	Not Found	Not Found	Provavelmente a URL sendo chamado não está correta. Verifique se está conforme especificado.
415	Unsupported Media Type	Content type not supported	O header Content-Type não está sendo informado conforme esperado. O correto é application/json.
429	Too Many Requests	Too Many Requests	O consumidor estourou o limite de requisições por tempo. Aguarde um pouco para tentar novas requisições.
500	Internal Server Error	Internal Server Error	Erro não esperado, algo está quebrado na API. Por favor aguarde ou entre em contato com o time de suporte.

Estrutura da mensagem de erro

ErrorResult

Representa um resultado de erro na chamada da plataforma.

Campo	Tipo	Regras	Descrição
errors	array de ErrorMessage	Opcional	Lista de erros da solicitação.

ErrorMessage

Contém informações de um erro.

Campo	Tipo	Regras	Descrição
code	string	Opcional	Código de identificação do erro.
message	string	Opcional	Descrição do erro.

Idioma

Undefined

Vida

Formulário de busca

Produto Vida

Pré-requisitos

Cotação

Solicitar cotação

Requisição (Request)

Cotação para o produto Vida com Assistencia

Respostas (Response)

Exemplos

Cotação para o produto Vida

Cotação para o produto Vida com Assistencia

Consultar cotação

Requisição (Request)

Respostas (Response)

Exemplos

Cotação para o produto Vida

Propostas

Enviar proposta

Requisição (Request)

Proposta pagamento efetuado na cotação

Respostas (Response)

Exemplos

Resposta de proposta com débito em conta

Aceitar proposta

Requisição (Request)

Respostas (Response)

Consultar proposta

Requisição (Request)

Respostas (Response)

Exemplos

Resposta de proposta com débito em conta

Consultar documento da proposta

Requisição (Request)

Respostas (Response)

Dicionario

Quote

PolicyType

QuoteStatus

Participant

ParticipantRole

Relationship

CommissionedAgent

CommissionedAgentRole

Email

Phone

Coverage

Person

AssistanceServices

Serviço de Assistencia

Proposal

ProposalStatus

Payment

BankAccount

PaymentType

Policy

PolicyStatus

Address

Resolução de erros

Estrutura da mensagem de erro

ErrorResult

ErrorMessage

Menu do rodapé