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ções

Solicitar cotação

Permite solicitar uma nova cotação para os planos básico, completo e tradicional.

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

Caso os valores de aluguel e encargos ultrapassem o limite liberado, o retorno será recusado, sendo necessário solicitar uma reanálise.

Requisição (Request)

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

Exemplo

Para cadastro de cotação para o produto Fiança Locatícia é necessário informar um único objeto de risco do tipo RentalSurety.

Cotação plano mensalizado

    
        {
            "policyPeriodStart": "2024-11-10",
            "policyPeriodEnd": "2025-11-10",
            "policyType": "Unique",
            "commissionedAgents": [
              {
                "documentNumber": "82931509000112",
                "role": "Broker",
                "commissionPercentage": 0.20,
                "lead": true,
                "isPayer": false
              },
              {
                "documentNumber": "38456770000116",
                "role": "PolicyOwner",
                "lead": false,
                "isPayer": true
              }
            ],
            "participants": [
              {
                "documentNumber": "33286641065",
                "participationPercentage": 1,
                "role": "Beneficiary",
                "address": {
                  "street": "Rua Coronel Camisão",
                  "number": "333",
                  "district": "Altaneira",
                  "city": "Marília",
                  "state": "SP",
                  "zipCode": "06330320",
                  "complement": "Apto 1003",
                  "country": "BRA",
                  "type": "Residential"
                },
                "contact": {
                  "name": "Joao da Silva",
                  "email": "[email protected]",
                  "phoneNumber": "",
                  "cellPhoneNumber": "14987192873"
                }
              },
              {
                "documentNumber": "98965630045",
                "role": "PolicyHolder",
                "main": true,
                "address": {
                  "street": "Rua Coronel Camisão",
                  "number": "333",
                  "district": "Altaneira",
                  "city": "Marília",
                  "state": "SP",
                  "zipCode": "78559544",
                  "complement": "Apto 1001",
                  "country": "BRA",
                  "type": "Residential"
                },
                "contact": {
                  "name": "Joao da Silva",
                  "email": "[email protected]",
                  "phoneNumber": "",
                  "cellPhoneNumber": "14987192873"
                }
              },
              {
                "documentNumber": "68426024084",
                "role": "Insured",
                "address": {
                  "street": "Rua Coronel Camisão",
                  "number": "353",
                  "district": "Altaneira",
                  "city": "Marília",
                  "state": "SP",
                  "zipCode": "71995485",
                  "complement": "Apto 1003",
                  "country": "BRA",
                  "type": "Residential"
                },
                "contact": {
                  "name": "Joao da Silva",
                  "email": "[email protected]",
                  "phoneNumber": "",
                  "cellPhoneNumber": "14987192873"
                }
              }
            ],
            "riskObjects": [
              {
                "type": "rentalProperty",
                "tenantDocumentNumber": "98965630045",
                "startLeaseContract": "2024-11-10",
                "endLeaseContract": "2025-11-10",
                "coverages": [
                  {
                    "key": "basica",
                    "insuredAmount": 2700
                  }
                ],
                "riskLocation": {
                  "nationalCoverage": false,
                  "address": {
                    "street": "Rua Coronel Camisão de Gola",
                    "number": "1000",
                    "district": "Barreiro",
                    "city": "Belo Horizonte",
                    "state": "MG",
                    "zipCode": "49067053",
                    "complement": "Casa 1268",
                    "country": "BRA",
                    "type": "Residential" 
                  }
                },
                "expenses": [
                  {
                    "description": "VALOR_ALUGUEL",
                    "value": 90
                  },
                  {
                    "description": "VALOR_CONDOMINIO",
                    "value": 50
                  },
                  {
                    "description": "VALOR_IPTU",
                    "value": 50
                  }
                ],
                "planKey": "Basic",
                "occupation": "Residencial",
                "inhabited": true,
                "multiple": 30
              }
            ],
                "paymentConditions": {
                  "paymentType": "Invoice",
                  "installments": 12
                }
    }

Cotação plano tradicional

{
    "policyPeriodStart": "2024-11-10",
    "policyPeriodEnd": "2025-11-10",
    "policyType": "Unico",
    "commissionedAgents": [
        {
            "documentNumber": "82931509000112",
            "role": "Broker",
            "commissionPercentage": 0.1,
            "lead": true
        }
    ],
    "participants": [
        {
            "documentNumber": "33286641065",
            "role": "PolicyHolder",
            "main": true,
            "address": {
                "street": "Rua Coronel Camisão",
                "number": "333",
                "district": "Altaneira",
                "city": "Marília",
                "state": "SP",
                "zipCode": "17513080",
                "complement": "Casa",
                "country": "BRA",
                "type": "Residential"
            },
            "contact": {
                "name": "Joao da Silva",
                "email": "[email protected]",
                "phoneNumber": "",
                "cellPhoneNumber": "14987192873"
            }
        }
    ],
    "riskObjects": [
        {
            "type": "FiancaLocaticia",
            "planKey": "traditional",
            "multiple": 12,
            "occupation": "Residencial",
            "inhabited": false,
            "tenantDocumentNumber": "33286641065",
            "startLeaseContract": "2024-11-10",
            "endLeaseContract": "2025-11-10",
            "riskLocation": {
                "address": {
                    "street": "Rua Coronel Camisão",
                    "number": "9999",
                    "district": "Altaneira",
                    "city": "Marília",
                    "state": "SP",
                    "zipCode": "17513080",
                    "complement": "Casa PAULO",
                    "country": "BRA",
                    "type": "Residential"
                }
            },
            "coverages": [
                {
                    "key": "basica",
                    "insuredAmount": 12000
                },
                  {
                    "key": "condominio",
                    "insuredAmount": 1200
                  },
                  {
                    "key": "iptu",
                    "insuredAmount": 1200
                  },
                  {
                    "key": "gas",
                    "insuredAmount": 1200
                  },
                  {
                    "key": "agua",
                    "insuredAmount": 1200
                  },
                  {
                    "key": "luz",
                    "insuredAmount": 1200
                  },
                  {
                    "key": "danos",
                    "insuredAmount": 6000
                  },
                  {
                    "key": "pintura",
                    "insuredAmount": 6000
                  },
                  {
                    "key": "multa-rescisao",
                    "insuredAmount": 3000
                  }
            ],
            "expenses": [
                {
                    "description": "VALOR_ALUGUEL",
                    "value": 1000
                },
                {
                    "description": "VALOR_CONDOMINIO",
                    "value": 100
                  },
                  {
                    "description": "VALOR_IPTU",
                    "value": 100
                  },
                  {
                    "description": "VALOR_GAS",
                    "value": 100
                  },
                  {
                    "description": "VALOR_AGUA",
                    "value": 100
                  },
                  {
                    "description": "VALOR_LUZ",
                    "value": 100
                  }
            ]
        }
    ],
        "paymentConditions": {
        "paymentType": "Boleto",
        "installments": 12
        }
}

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

Exemplo

    
        {
            "id": "e674ee21-ff27-4ac1-b480-530672aca16e",
            "type": "Issuance",
            "createdBy": "6453f2b9-e78f-40fb-857e-96cf2471ca6b",
            "createdAt": "2024-12-13T17:33:10.5092995Z",
            "productId": "44813ecc-0bca-476b-9a7c-b4b3ff3d9902",
            "documentPeriodStart": "2024-12-10T00:00:00.000Z",
            "documentPeriodEnd": "2024-12-13T17:32:36.453Z",
            "channel": "PortalApi",
            "status": "Created",
            "underwritingStatus": "Approved",
            "policyType": "Unico",
            "sequential": 15282,
            "discount": 0.0,
            "commercialLoadingFee": 0.0,
            "paymentConditions": {
                "paymentType": "Invoice",
                "installments": 12
            },
            "participants": [
                {
                    "operation": "Add",
                    "personId": "2b94d710-40be-47c2-ad6f-bf648708d3ea",
                    "addressId": "788800e0-13d3-4a42-b1aa-e801c6ef5faf",
                    "emailId": "671ac36b-f846-45d7-8fd9-d0e452551074",
                    "role": "Beneficiary",
                    "percentage": 1.0,
                    "isPayer": false
                },
                {
                    "operation": "Add",
                    "personId": "d3975097-5e39-4c62-a8b6-fac8f3d0341f",
                    "addressId": "df52530a-8bb8-4040-be55-db1bbd82c08e",
                    "emailId": "ca728730-ec8f-4194-8751-5a14d90fc5dc",
                    "role": "PolicyHolder",
                    "isPayer": false
                },
                {
                    "operation": "Add",
                    "personId": "2b94d710-40be-47c2-ad6f-bf648708d3ea",
                    "addressId": "3e841216-635d-4e0f-9fc4-77494cb3ce47",
                    "emailId": "671ac36b-f846-45d7-8fd9-d0e452551074",
                    "role": "Insured",
                    "isPayer": false
                }
            ],
            "commissionedAgents": [
                {
                    "personId": "6453f2b9-e78f-40fb-857e-96cf2471ca6b",
                    "licenseNumber": "202018191",
                    "role": "Broker",
                    "commissionPercentage": 0.2,
                    "lead": true,
                    "isPayer": false
                },
                {
                    "personId": "bfbead9b-00c8-4157-b0a5-4c471dc63a7d",
                    "role": "PolicyOwner",
                    "commissionPercentage": 0.0,
                    "isPayer": true
                }
            ],
            "insurers": [
                {
                    "personId": "8644a09a-9909-40d3-a6d0-2cbc53f5ab95",
                    "lead": true,
                    "participationPercentage": 1
                }
            ],
            "riskObjects": [
                {
                    "coverages": [
                        {
                            "operation": "Add",
                            "id": "47728446-c81d-4b1c-81a3-8a7c34d86ea3",
                            "insuredAmount": 2700.0,
                            "lmi": 2700.0
                        }
                    ],
                    "riskId": "98a4f5d9-6585-4335-9e70-888446be6d1c",
                    "riskVersion": "1.35",
                    "operation": "Add",
                    "sortSequence": 1
                }
            ],
            "deductibleType": "Coverage"
        }

Consultar cotação

Permite consultar os dados de uma cotação.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/fianca-locaticia/quotes/{quote_id}
Method	Get
	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

Exemplo

  
    {
        "id": "e674ee21-ff27-4ac1-b480-530672aca16e",
        "type": "Issuance",
        "createdBy": "6453f2b9-e78f-40fb-857e-96cf2471ca6b",
        "createdAt": "2024-12-13T17:33:10.5092995Z",
        "productId": "44813ecc-0bca-476b-9a7c-b4b3ff3d9902",
        "documentPeriodStart": "2024-12-10T00:00:00.000Z",
        "documentPeriodEnd": "2025-12-13T17:32:36.453Z",
        "channel": "PortalApi",
        "status": "Created",
        "underwritingStatus": "Approved",
        "policyType": "Unico",
        "sequential": 15282,
        "discount": 0.0,
        "commercialLoadingFee": 0.0,
        "paymentConditions": {
            "paymentType": "Invoice",
            "installments": 12
        },
        "participants": [
            {
                "operation": "Add",
                "personId": "2b94d710-40be-47c2-ad6f-bf648708d3ea",
                "addressId": "788800e0-13d3-4a42-b1aa-e801c6ef5faf",
                "emailId": "671ac36b-f846-45d7-8fd9-d0e452551074",
                "role": "Beneficiary",
                "percentage": 1.0,
                "isPayer": false
            },
            {
                "operation": "Add",
                "personId": "d3975097-5e39-4c62-a8b6-fac8f3d0341f",
                "addressId": "df52530a-8bb8-4040-be55-db1bbd82c08e",
                "emailId": "ca728730-ec8f-4194-8751-5a14d90fc5dc",
                "role": "PolicyHolder",
                "isPayer": false
            },
            {
                "operation": "Add",
                "personId": "2b94d710-40be-47c2-ad6f-bf648708d3ea",
                "addressId": "3e841216-635d-4e0f-9fc4-77494cb3ce47",
                "emailId": "671ac36b-f846-45d7-8fd9-d0e452551074",
                "role": "Insured",
                "isPayer": false
            }
        ],
        "commissionedAgents": [
            {
                "personId": "6453f2b9-e78f-40fb-857e-96cf2471ca6b",
                "licenseNumber": "202018191",
                "role": "Broker",
                "commissionPercentage": 0.2,
                "lead": true,
                "isPayer": false
            },
            {
                "personId": "bfbead9b-00c8-4157-b0a5-4c471dc63a7d",
                "role": "PolicyOwner",
                "commissionPercentage": 0.0,
                "isPayer": true
            }
        ],
        "insurers": [
            {
                "personId": "8644a09a-9909-40d3-a6d0-2cbc53f5ab95",
                "lead": true,
                "participationPercentage": 1
            }
        ],
        "riskObjects": [
            {
                "coverages": [
                    {
                        "operation": "Add",
                        "id": "47728446-c81d-4b1c-81a3-8a7c34d86ea3",
                        "insuredAmount": 2700.0,
                        "lmi": 2700.0
                    }
                ],
                "riskId": "98a4f5d9-6585-4335-9e70-888446be6d1c",
                "riskVersion": "1.35",
                "operation": "Add",
                "sortSequence": 1
            }
        ],
        "deductibleType": "Coverage"
    }

Atualizar cotação

Permite atualizar uma cotação existente 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/fianca-locaticia/quotes/{quote_id}
Method	Put
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	QuoteRequest

Exemplos

Cotação para o produto Fiança Locatícia

Para atualização de cotação para o produto Riscos Empresariais é necessário informar um único objeto de risco do tipo RentalSurety.

    {
        "policyPeriodStart": "2025-01-28",
        "policyPeriodEnd": "2026-01-28",
        "policyType": "Unique",
        "commissionedAgents": [
            {
                "documentNumber": "74591281000130",
                "role": "Broker",
                "commissionPercentage": "0.26",
                "lead": true,
                "isPayer": false
            },
            {
                "documentNumber": "23225196000118",
                "role": "PolicyOwner",
                "lead": false,
                "isPayer": true
            }
        ],
        "participants": [
            {
                "documentNumber": "93213020001",
                "participationPercentage": "1",
                "role": "Beneficiary",
                "address": {
                    "street": "Rua Mecenas Pinto Bueno",
                    "number": "1107",
                    "district": "Jardim Mariz Izabel",
                    "city": "Marília",
                    "state": "SP",
                    "zipCode": "17516030",
                    "complement": "Casa",
                    "country": "BRA",
                    "type": "Residential"
                },
                "contact": {
                    "name": "John Doe da Silva",
                    "email": "[email protected]",
                    "phoneNumber": "",
                    "cellPhoneNumber": "14999999999"
                }
            },
            {
                "documentNumber": "27677247067",
                "role": "PolicyHolder",
                "main": true,
                "address": {
                    "street": "Rua Coronel Camisão",
                    "number": "333",
                    "district": "Altaneira",
                    "city": "Marília",
                    "state": "SP",
                    "zipCode": "17513080",
                    "complement": "Casa",
                    "country": "BRA",
                    "type": "Residential"
                },
                "contact": {
                    "name": "Danny da Silva",
                    "email": "[email protected]",
                    "phoneNumber": "",
                    "cellPhoneNumber": "14999999999"
                }
            },
            {
                "documentNumber": "33586425007",
                "role": "Insured",
                "address": {
                    "street": "Rua Coronel Camisão",
                    "number": "333",
                    "district": "Altaneira",
                    "city": "Marília",
                    "state": "SP",
                    "zipCode": "17513080",
                    "complement": "Casa",
                    "country": "BRA",
                    "type": "Residential"
                },
                "contact": {
                    "name": "Denner da Silva",
                    "email": "[email protected]",
                    "phoneNumber": "",
                    "cellPhoneNumber": "14999999999"
                }
            }
        ],
        "riskObjects": [
            {
                "type": "rentalProperty",
                "tenantDocumentNumber": "27677247067",
                "startLeaseContract": "2025-01-28",
                "endLeaseContract": "2026-01-28",
                "coverages": [
                    {
                        "key": "basica",
                        "insuredAmount": "1000"
                    }
                ],
                "riskLocation": {
                    "nationalCoverage": false,
                    "address": {
                        "street": "Rua Coronel Camisão",
                        "number": "333",
                        "district": "Altaneira",
                        "city": "Marília",
                        "state": "SP",
                        "zipCode": "17513080",
                        "complement": "Casa",
                        "country": "BRA",
                        "type": "Residential"
                    }
                },
                "expenses": [
                    {
                        "description": "VALOR_ALUGUEL",
                        "value": "900"
                    },
                    {
                        "description": "VALOR_CONDOMINIO",
                        "value": "50"
                    },
                    {
                        "description": "VALOR_IPTU",
                        "value": "50"
                    }
                ],
                "planKey": "basic",
                "occupation": "Residencial",
                "inhabited": true,
                "multiple": "30"
            }
        ],
        "productKey": "fianca-locaticia"
    }

Respostas (Response)

Status	Descrição	Tipo
200	Cotação atualizada 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

Response de Cotação para o produto Fiança Locatícia.

    {
        "createdAt": "2025-01-28T14:11:40.77Z",
        "updatedBy": "8e3391ba-3dfa-4ea8-9583-9a21e25c213b",
        "updatedAt": "2025-01-28T14:17:01.9Z",
        "documentPeriodStart": "2025-02-28T03:00:00Z",
        "documentPeriodEnd": "2026-03-01T02:59:00Z",
        "productName": "Aluguel",
        "productDisplayedName": "Aluguel",
        "status": "Approved",
        "policyType": "Unique",
        "commercialPremium": 90.51,
        "grossPremium": 97.19,
        "iof": 6.68,
        "installmentCost": 0,
        "commercialLoadingFee": 0,
        "participants": [
            {
                "documentNumber": "638***274**",
                "role": "Insured",
                "address": {
                    "id": "d6d0956a-3fcd-4d04-9dc1-a3c4cd662e25",
                    "type": "Residential",
                    "street": "RUA CORONEL CAMISÃO",
                    "number": "333",
                    "complement": "CASA",
                    "district": "Altaneira",
                    "city": "MARÍLIA",
                    "state": "SP",
                    "country": "BRA",
                    "zipCode": "17513080"
                },
                "isPayer": false,
                "contact": {
                    "emailId": "671ac36b-f846-45d7-8fd9-d0e452551074",
                    "email": "[email protected]"
                }
            },
            {
                "documentNumber": "693***032**",
                "role": "PolicyHolder",
                "address": {
                    "id": "62333842-4c50-4cef-b27a-5ebe7e5c48fd",
                    "type": "Residential",
                    "street": "RUA CORONEL CAMISÃO",
                    "number": "333",
                    "complement": "CASA",
                    "district": "Altaneira",
                    "city": "MARÍLIA",
                    "state": "SP",
                    "country": "BRA",
                    "zipCode": "17513080"
                },
                "isPayer": false,
                "contact": {
                    "emailId": "a4a75075-2978-4413-bef7-c420efdd94f6",
                    "email": "[email protected]"
                }
            },
            {
                "documentNumber": "638***274**",
                "role": "Beneficiary",
                "address": {
                    "id": "6ab96d10-11f6-4c96-905c-d0fc1b0ef061",
                    "type": "Residential",
                    "street": "RUA MECENAS PINTO BUENO",
                    "number": "1107",
                    "complement": "CASA",
                    "district": "Jardim Mariz Izabel",
                    "city": "MARÍLIA",
                    "state": "SP",
                    "country": "BRA",
                    "zipCode": "17516030"
                },
                "participationPercentage": 1,
                "isPayer": false,
                "contact": {
                    "emailId": "b7390ba1-370d-4fc6-bce6-ceb07ae3ea35",
                    "email": "[email protected]"
                }
            }
        ],
        "commissionedAgents": [
            {
                "documentNumber": "02***0130001**",
                "role": "Broker",
                "commissionPercentage": 0.2,
                "commissionAmount": 18.1,
                "lead": true,
                "participationPercentage": 0,
                "isPayer": false
            },
            {
                "documentNumber": "20***4280001**",
                "role": "PolicyOwner",
                "commissionPercentage": 0,
                "commissionAmount": 0,
                "participationPercentage": 0,
                "isPayer": true
            }
        ],
        "riskObjects": [
            {
                "type": "RentalProperty",
                "tenantDocumentNumber": "69313903253",
                "expenses": [
                    {
                        "description": "VALOR_ALUGUEL",
                        "value": 90
                    },
                    {
                        "description": "VALOR_CONDOMINIO",
                        "value": 50
                    },
                    {
                        "description": "VALOR_IPTU",
                        "value": 50
                    }
                ],
                "planKey": "basic",
                "multiple": 30,
                "occupation": "Residencial",
                "inhabited": true,
                "riskLocation": {
                    "nationalCoverage": false,
                    "address": {
                        "street": "Rua Coronel Camisão",
                        "number": "1002",
                        "district": "Altaneira",
                        "city": "Marília",
                        "state": "SP",
                        "zipCode": "17513080",
                        "complement": "Casa",
                        "country": "BRA"
                    }
                },
                "startLeaseContract": "2025-02-28T00:00:00",
                "endLeaseContract": "2026-02-28T00:00:00",
                "coverages": [
                    {
                        "key": "basica",
                        "insuredAmount": 2700,
                        "lmi": 2700,
                        "description": "",
                        "commercialPremium": 90.51,
                        "grossPremium": 97.19
                    }
                ]
            }
        ],
        "deductibleType": "Coverage",
        "partners": [],
        "productKey": "fianca-locaticia",
        "policyPeriodStart": "2025-02-28T00:00:00",
        "policyPeriodEnd": "2026-02-28T00:00:00",
        "discountPercentage": 0,
        "quoteId": "7d894a74-177d-47cf-8cc7-169705bd3be4",
        "quoteNumber": 17368
    }

Observações

As alterações podem ser feitas desde que uma proposta correspondente à cotação não tenha sido emitida.

Consultar documento da minuta

Essa operação permite consultar o documento de minuta a partir do ID da cotação.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/fianca-locaticia/quotes/{quote_id}/draft
Method	Get
	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	Documento da minuta localizado com sucesso.
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

Consultar carta de Aprovação/Recusa

Essa operação permite consultar a carta de aprovação ou de recusa a partir do ID da cotação.

A depender do status da cotação, a carta pode ser de aprovação ou de recusa. Abaixo é exibido os status para cada tipo de carta.

Status para carta de Aprovação:

• Approved
• ApprovedBiometry

Status para carta de Recusa:

• Refused
• RefusedBiometry
• Denied

Para qualquer outro status que a cotação tenha, não será retornada carta de aprovação ou de recusa.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/fianca-locaticia/quotes/{quote_id}/letters
Method	Get
	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	Carta de aprovação/recusa localizada com sucesso.
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

Solicitar reanálise do subscritor

Permite solicitar a reanálise do subscritor 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/fianca-locaticia/quotes/reanalysis
Method	Post
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	Reanalysis

Exemplos

Requisição da Reanálise do subscritor

Requisição da Reanálise do subscritor.

{
    "quoteId": "cbd9ad2b-ec22-4c2f-9c93-b77d0c470510",
    "policyOwnerDocumentNumber": "12345678912345",
    "startInsuranceContract": "2025-01-16T00:00:00.000Z",
    "endInsuranceContract": "2026-01-16T00:00:00.000Z",
    "planKey": "basic",
    "multiple": 30,
    "commission": 0.2,
    "expenses": [
        {
            "description": "VALOR_ALUGUEL",
            "value": 1000
        },
        {
            "description": "VALOR_CONDOMINIO",
            "value": 150
        },
        {
            "description": "VALOR_IPTU",
            "value": 150
        }
    ]
}

Respostas (Response)

Status	Descrição	Tipo
201	Reanálise do subscritor cadastrada 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

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/fianca-locaticia/proposals
Method	Post
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	ProposalRequest

Exemplo

Proposta com boleto

  
  {
    "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f41",
    "payment": {
      "paymentType": "Boleto",
      "FirstDueDate": "2025-01-17"
      "installments": "12"
    }
  }
  

Obs: A forma de pagamento boleto só esta disponível para o plano Tradicional do produto Fiança Locatícia, para este tipo de pagamento é necessário informar a data de vencimento da primeira parcela (FirstDueDate), e esta data não pode ultrapassar 30 dias após a aprovação da cotação, o número de parcelas pode variar de 1(um) até o período em meses da vigência do seguro, que é informada na criação da cotação.

Proposta com fatura

  
  {
    "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
    "payment": {
      "paymentType": "Invoice",
      "installments": "12"
    }
  }
  

Obs: Para o plano Mensalidado do produto Fiança Locatícia, a única modalidade de pagamento aceita é do tipo Invoice e a quantidade de parcelas deve ser igual ao período em meses da vigência do seguro, que é informada na criação da cotação. Para o plano tradicional esta forma de pagamento só pode ser utilizado se o estipulante for informado no momento da criação da cotação

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

Exemplo

Resposta de proposta

  
  {
    "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
    "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
    "proposalNumber": "99999",
    "policyPeriodStart": "2024-12-01",
    "policyPeriodEnd": "2025-12-01",
    "payment": {
      "paymentType": "Boleto",
      "installments": "12"
    },
    "createdAt": "2024-12-01",
    "status": "Ready"
  }
  

Aceitar proposta

Permite aprovar uma proposta criada.

Para o produto Fiança Locatícia, a emissão da apólice é feita logo após o aceite da proposta e os dados da apólice emitida são retornados em caso de sucesso.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/fianca-locaticia/proposals/{proposal_id}/accept
Method	Post
	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.	Policy
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 do aceite da proposta para apólice aguardando processamento

Resposta do aceite da proposta com dados de emissão de apólice aguardando processamento.

  
  {
    "policyId": "62354f29-4029-4ba1-82f8-309e458a0170",
    "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
    "quoteId": "81e56840-adb3-404f-8ce1-0a75d5dc029c",
    "policyPeriodStart": "2024-12-01T00:00:00Z",
    "policyPeriodEnd": "2025-12-01T00:00:00Z",
    "status": "Creating",
    "createdAt": "2024-12-05T18:11:02.573Z"
  }
  

Resposta do aceite da proposta para apólice processada com sucesso

Resposta do aceite da proposta com dados de emissão de apólice processada com sucesso.

  
  {
    "policyId": "62354f29-4029-4ba1-82f8-309e458a0170",
    "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
    "quoteId": "81e56840-adb3-404f-8ce1-0a75d5dc029c",
    "policyNumber": "0306920219901140003053000",
    "policyPeriodStart": "2024-12-01T00:00:00Z",
    "policyPeriodEnd": "2025-12-01T00:00:00Z",
    "status": "Active",
    "createdAt": "2024-12-05T18:11:02.573Z"
  }

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/fianca-locaticia/proposals/{proposal_id}
Method	Get
	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

Exemplo

Resposta de proposta

  
    {
        "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
        "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
        "proposalNumber": "99999",
        "policyPeriodStart": "2024-12-01",
        "policyPeriodEnd": "2025-12-01",
        "payment": {
          "paymentType": "Invoice",
          "installments": "12"
        },
        "createdAt": "2024-12-01",
        "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/fianca-locaticia/proposals/{proposal_id}/document
Method	Get
	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.
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

Apólices

Emitir apólice

Permite emitir uma apólice para uma proposta existente. A proposta deve ter sido aceita previamente.

Requisição (Request)

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

Exemplo

Emissão de apólice

Emissão da apólice para uma proposta existente.

    
    {
      "proposalId": "bddbcd59-213f-4523-a055-7e28f23a4978"
    }
    

Respostas (Response)

Status	Descrição	Tipo
200	Apólice emitida com sucesso.	Policy
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 emissão de apólice aguardando processamento

Resposta de emissão de apólice aguardando processamento.

    
    {
      "policyId": "62354f29-4029-4ba1-82f8-309e458a0170",
      "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
      "quoteId": "81e56840-adb3-404f-8ce1-0a75d5dc029c",
      "policyPeriodStart": "2024-12-01T00:00:00Z",
      "policyPeriodEnd": "2025-12-01T00:00:00Z",
      "status": "Creating",
      "createdAt": "2024-12-05T18:11:02.573Z"
    }
    

Resposta de emissão de apólice processada com sucesso

Resposta de emissão de apólice processada com sucesso.

    
    {
      "policyId": "62354f29-4029-4ba1-82f8-309e458a0170",
      "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
      "quoteId": "81e56840-adb3-404f-8ce1-0a75d5dc029c",
      "policyNumber": "0306920219901140003053000",
      "policyPeriodStart": "2024-12-01T00:00:00Z",
      "policyPeriodEnd": "2025-12-01T00:00:00Z",
      "status": "Active",
      "createdAt": "2024-12-05T18:11:02.573Z"
    }

Consultar apólice

Essa operação permite consultar os dados de uma apólice 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/fianca-locaticia/policies/{policy_id}
Method	Get
	policy_id	ID da apólice.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Apólice localizada com sucesso.	Policy
400	Os dados da requisição estão inválidos.	ErrorResult
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

Exemplos

Resposta de emissão de apólice aguardando processamento

Resposta de emissão de apólice aguardando processamento.

  
    {
        "policyId": "62354f29-4029-4ba1-82f8-309e458a0170",
        "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
        "quoteId": "81e56840-adb3-404f-8ce1-0a75d5dc029c",
        "policyPeriodStart": "2024-12-01T00:00:00Z",
        "policyPeriodEnd": "2025-12-01T00:00:00Z",
        "status": "Creating",
        "createdAt": "2024-12-05T18:11:02.573Z"
    }
  

Resposta de emissão de apólice processada com sucesso

Resposta de emissão de apólice processada com sucesso.

  
    {
        "policyId": "62354f29-4029-4ba1-82f8-309e458a0170",
        "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
        "quoteId": "81e56840-adb3-404f-8ce1-0a75d5dc029c",
        "policyNumber": "0306920219901140003053000",
        "policyPeriodStart": "2024-12-01T00:00:00Z",
        "policyPeriodEnd": "2025-12-01T00:00:00Z",
        "status": "Active",
        "createdAt": "2024-12-05T18:11:02.573Z"
    }
  

Consultar documento da apólice

Essa operação permite consultar o documento de uma apólice a partir do ID.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/fianca-locaticia/policies/{policy_id}/document
Method	Get
	policy_id	ID da apólice.
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 apólice localizado com sucesso.
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 Request

Representa uma requisição de cotação de um produto.

Campo	Tipo	Regras	Descrição
policyType	string (PolicyType)	Obrigatório	Tipo de contratação da apólice, que pode ser única ou item a item. Caso não seja informado, será considerada como apólice de contratação única.Os produtos podem permitir somente um tipo de contratação, ou ambas. Para o produto Fiança Locatícia, o tipo de apólice sempre será Unique.
policyPeriodStart	string (date-time)	Obrigatório	Data de início da vigência da Apólice
policyPeriodEnd	string (date-time)	Obrigatório	Data final da 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 RentalSurety	Obrigatório	Lista de objetos segurados. Os objetos segurados variam conforme o produto informado.

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.
policyType	string (PolicyType)	Somente Leitura	Tipo de contratação da apólice, que no caso do produto Fiança Locatícia é Unique
quoteNumber	number	Opcional	Numero da Cotação
discountPercentage	number	Opcional	Percentual de desconto a ser aplicado no valor do prêmio. O percentual de desconto e a taxa de agravo são mutuamente exclusivos, então somente um deles pode ser informado para uma cotação.
commercialLoadingFee	number	Opcional	Taxa de agravo comercial a ser aplicada no valor do prêmio. O percentual de desconto e a taxa de agravo são mutuamente exclusivos, então somente um deles pode ser informado para uma 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.
underwritingStatus	string (UnderwritingStatus)	Somente leitura	Situação atual da subscrição 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 RentalSurety	Obrigatório	Lista de objetos segurados. Os objetos segurados variam conforme o produto informado.

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.

• Expired: Indica que o período de validade da cotação expirou.
• PreApproved: Indica que a cotação está pendente pela subscrição e o processo de biometria da cotação não foi criado.
• PendingBiometry: Indica que a cotação está pendente pela subscrição e o processo de biometria da cotação não foi criado.
• Performed: Indica que a Cotação já foi utilizada em uma Proposta, portanto seu ciclo de vida está finalizado.
• ApprovedBiometry: Indica que a cotação foi aprovada pela subscrição e o processo de biometria da cotação foi concluído.
• Approved: Indica que a cotação foi aprovada pela subscrição, o processo de biometria da cotação não foi concluído e a cotação não está concluída (status "Performed").
• RefusedBiometry: Indica que a cotação foi recusada pela subscrição e o processo de biometria da cotação foi concluído.
• Refused: Indica que a cotação foi recusada pela subscrição e o processo de biometria da cotação não foi concluído.
• UnderAnalysis: Indica que que a cotação está em análise pela subscrição.
• Creating: Indica que a cotação foi criada.
• Denied: Indica que a cotação foi negada pela subscrição.
• Pending: Indica que a cotação está pendente pela subscrição.

UnderwritingStatus

Situação da subscrição da cotação.

• UnderAnalysis: Indica que a Cotação está sob análise da Subscrição.
• Denied: Indica que a Subscrição negou a Cotação devido algum tipo de reprovação (Análise de crédito, Análise de risco, etc.).
• Approved: Indica que a Cotação foi aprovada pela Subscrição.
• Pending: Indica que a Cotação está pendente de alguma ação (Cadastro de Biometria, etc.).

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\*\*
participationPercentage	number	Opcional	Percentual do prêmio a que o beneficiário tem direito. O valor deve ter no máximo duas casas decimais e estar entre 0.01 e 1.00. Obrigatório para os beneficiários e a soma da participação de todos os beneficiários deve ser igual a 1.
role	string (ParticipantRole)	Obrigatório	Papel do participante na cotação. Os participantes que são obrigatórios varia por produto.
main	boolean	Opcional	Indica se o participante é o principal do seguro. (Apenas para a role PolicyHolder). Caso o valor não seja passado, é definido o valor default false.
address	Objeto deAddress	Opcional	Endereço do participante.
contact	objeto de Contact	Opcional	Dados de contato do participante.

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).
• Insured: O segurado é a pessoa, física ou jurídica, cujos interesses estão garantidos pela apólice de seguro. No caso do Garantia, o Beneficiário e o Segurado são as mesmas pessoas da apólice.
• PolicyHolder: Devedor das obrigações por ele assumidas no contrato principal. (Circular SUSEP 232/03).

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 visí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	Obrigatório	Identifica a corretora principal na cotação.
isPayer	boolean	Obrigatório	Identifica quem é o pagador da apólice. Geralmente o pagador da apólice é o estipulante (PolicyOwner).
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.
participationPercentage	number	Opcional	Percentual de participação na comissão, no caso de co-corretagem. Quando informado, a soma desse valor para todas as corretoras deve ser igual a 1. 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.

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. Obs. A presença do estipulante é obrigatória para cotações do plano mensalizado, e opcional para cotações do plano tradiconal

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.
country	string	Opcional	País da localidade. Caso não seja passado nenhum valor, será atribuído o default (BRA)
type	string	Obrigatório	Tipo da localidade. Opções: Residential Business Billing

Contact

Representa dados de contato de um participante.

Campo	Tipo	Regras	Descrição
name	string	Obrigatório	Nome do participante.
email	string	Opcional	Email do participante. Caso o participante possua a role PolicyHolder, este campo torna-se obrigatório.
phoneNumber	string	Opcional	Número de telefone do participante.
cellPhoneNumber	string	Opcional	Número de celular do participante.

RentalSurety

Contém informações do objeto do segurado do tipo RentalSurety.

Campo	Tipo	Regras	Descrição
type	string	Obrigatório	Tipo do objeto de risco. Opções: rentalProperty
tenantDocumentNumber	string	Obrigatório	Número do documento do inquilino. Deve ser o mesmo número de documento informado para o participante do tipo PolicyHolder.
startLeaseContract	string (date)	Obrigatório	Data de início do contrato de aluguel.
endLeaseContract	string (date)	Obrigatório	Data final do contrato de aluguel.
coverages	array de Coverage	Obrigatório	As coberturas relacionadas ao seguro.
riskLocation	objeto de RiskLocation	Obrigatório	Dados sobre o local assegurado.
expenses	array de Expense	Obrigatório	Dados sobre as despesas (encargos) asseguradas.
planKey	string	Obrigatório	Chave da plano. Opções: basic complete traditional Para o plano do tipo básico (basic) apenas a cobertura básica é vinculada à cotação. Para o plano do tipo completo (completo) além da cobertura básica, é atrelada à cotação, de forma automática pela Api, as coberturas adicionais (pintura interna e externa, danos e multa). Para o plano do tipo tradicional (traditional), as coberturas devem ser selecionadas individualmente, sendo apenas a cobertura básica obrigatória para a criação da cotação.
occupation	string	Obrigatório	Tipo de ocupação do imóvel. Opções: residencial comercial
inhabited	boolean	Obrigatório	Indica se o imóvel é habitado ou não.
multiple	number	Obrigatório	Valor do múltiplo.
paymentConditions	objeto de Payment	Opcional	Dados sobre o local assegurado.

Coverage

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

Campo	Tipo	Regras	Descrição
key	string	Obrigatório	Chave da cobertura, conforme cada produto. Opções: basica condominio iptu gas agua luz danos pintura multa-recisao
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	Obrigatório	Importância segurada, ou valor segurado, deste objeto de risco.

RiskLocation

Contém informações do imóvel a ser assegurado.

Campo	Tipo	Regras	Descrição
nationalCoverage	boolean	Obrigatório	Identifica se a cobertura do equipamento é para todo o território nacional.
address	objeto de Address	Opcional	Dados de endereço da localidade.

Expense

Representa as despesas do seguro.

Campo	Tipo	Regras	Descrição
description	string	Obrigatório	Descrição da despesa. Opções: VALOR_ALUGUEL VALOR_AGUA VALOR_LUZ VALOR_CONDOMINIO VALOR_GAS VALOR_IPTU
valor	number	Obrigatório	Valor da despesa.

Reanalysis

Representa o payload para solicitação de reanálise do subscritor.

Campo	Tipo	Regras	Descrição
quoteId	string	Obrigatório	Id da cotação.
policyOwnerDocumentNumber	string	Obrigatório	Número do documento do estipulante da cotação.
startInsuranceContract	string (date)	Obrigatório	Data de início da vigência do seguro.
endInsuranceContract	string (date)	Obrigatório	Data final da vigência do seguro.
planKey	string	Obrigatório	Opções: basic complete Para o plano do tipo básico (basic) apenas a cobertura básica é vinculada à cotação. Para o plano do tipo completo (completo) além da cobertura básica, é atrelada à cotação, de forma automática pela Api, as coberturas adicionais (pintura interna e externa, danos e multa).
multiple	number	Obrigatório	Valor do Multiplo.
commission	number	Obrigatório
expenses	array de Expense	Obrigatório	Dados sobre as despesas (encargos) asseguradas.

ProposalRequest

Representa uma requisição de proposta de um produto.

Campo	Tipo	Regras	Descrição
quoteId	string (uuid)	Obrigatório	ID único da cotação que vai dar origem à proposta.
payment	Payment	Obrigatório	Detalhes do pagamento da apólice.
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.

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.
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.
• Issued: O documento da proposta foi emitido.
• Accepted: A proposta foi aceita.
• Cancelled: Proposta cancelada.
• Rejected: Proposta rejeitada.
• Done: A apólice foi emitida.

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.

PaymentType

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

• Invoice: Pagamento através de fatura.
• Boleto: Pagamento através de boleto, disponível somente para o plano tradicional.

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

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.