Máquinas e Equipamentos

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 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/maquinas-equipamentos/quotes
Method	Post
Query	product_key	Chave de identificação do produto. maquinas-equipamentos
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	Quote

Exemplos

Cotação para o produto RD - Maquinas e Equipamentos

Para cadastro de cotação para o produto RD - Equipamento é necessário informar os objetos de risco do tipo Equipment.

{
  "policyPeriodStart": "2021-01-01",
  "policyPeriodEnd": "2021-12-31",
  "discountPercentage": 0,
  "commercialLoadingFee": 0,
  "commissionedAgents": [
    {
      "documentNumber": "11111111111111",
      "role": "Broker",
      "lead": true,
      "commissionPercentage": 0.15    
    }
  ],
  "participants": [
    {
      "documentNumber": "22222222222222",
      "role": "Insured",
      "isPayer": true,
      "emails": [
        {
          "emailAddress": "[email protected]"
        }
      ],
      "phones": [
        {
          "number": "3333333"
        }
      ],
      "address": {
        "street": "Av. Raja Gabáglia",
        "number": "1143",
        "district": "Luxemburgo",
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403",
        "complement": "20º andar",
        "country": "bra",
        "type": "Residential"
      }
    },
    {
      "documentNumber": "3333333333333",
      "role": "Beneficiary",
      "isPayer": false,     
      "emails": [
        {
          "emailAddress": "[email protected]"
        }
      ],
      "phones": [
        {
          "number": "3333333"
        }
      ],
      "address": {
        "street": "Av. Raja Gabáglia",
        "number": "1143",
        "district": "Luxemburgo",
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403",
        "complement": "20º andar",
        "country": "bra",
        "type": "Residential"
      }
    }
  ],
  "riskObjects": [
    {
      "type": "Equipment",
      "coverages": [
        {
          "key": "basica",
          "insuredAmount": "50000.00"        
        },
        {
          "key": "furto",
          "insuredAmount": "10000.00"
        },
        {
          "key": "perda-pagamento",
          "insuredAmount": "10000.00",        
          "indemnityPeriod": 2
        },
        {
          "key": "rc-maquinas",
          "insuredAmount": "10000.00"        
        },
        {
          "key": "operacao-proxima-agua",
          "insuredAmount": "10000.00"           
        },
        {
          "key": "danos-eletricos",
          "insuredAmount": "10000.00"       
        },
        {
          "key": "rc-operador",
          "insuredAmount": "10000.00"          
        }
      ],
      "equipmentDetails": {
        "manufacturer": "Fabricante",
        "model": "Modelo do equipamento",
        "serialNumber": "Número de série do equipamento",
        "chassis": "Número do chassi",
        "manufactureYear": "2021",
        "equipmentType": "1"     
      },
      "equipmentLocation": {
        "nationalCoverage": false,
        "address": {
          "street": "Av. Raja Gabáglia",
          "number": "1143",
          "district": "Luxemburgo",
          "city": "Belo Horizonte",
          "state": "MG",
          "zipCode": "30380403",
          "complement": "20º andar",
          "country": "bra",
          "type": "Residential"
        }
      },
      "invoiceNumber": "NF1111",
      "invoiceDate": "2021-01-01",
      "utilizationType": "1",
      "equipmentAreRentedMayCededThird": false,
      "beneficiaries": [
        {
          "documentNumber": "444444444444",
          "percentage": "1"
        }
      ]
    }
  ]
}

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

Resposta da cotação para o produto RD - Maquinas e Equipamentos

O retorno da cotação traz o quoteId que identifica unicamente da cotação, além dos valores do prêmio bruto, comercial e iof.

{
  "quoteId": "c03ab663-3d5c-4014-aa5e-cae727103392",
  "productKey": "maquinas-equipamentos",
  "policyType": "ItemByItem",
  "quoteNumber": "99999",
  "createdAt": "2021-04-29T17:12:27.219Z",
  "status": "Approved",
  "commercialPremium": "109.98",
  "grossPremium": "99.99",
  "iof": "9.99",
  "policyPeriodStart": "2021-01-01",
  "policyPeriodEnd": "2021-12-31",
  "discountPercentage": 0,
  "commercialLoadingFee": 0,
  "commissionedAgents": [
    {
      "documentNumber": "11111111111111",
      "role": "Broker",
      "lead": true,
      "commissionPercentage": 0.15,
      "commissionAmount": 9.99,
      "participationPercentage": 1.0
    }
  ],
  "participants": [
    {
      "documentNumber": "22222222222222",
      "role": "Insured",
      "isPayer": true,
      "emails": [
        {
          "emailAddress": "[email protected]"
        }
      ],
      "phones": [
        {
          "number": "3333333"
        }
      ],
      "address": {
        "street": "Av. Raja Gabáglia",
        "number": "1143",
        "district": "Luxemburgo",
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403",
        "complement": "20º andar",
        "country": "bra",
        "type": "Residential"
      }
    },
    {
      "documentNumber": "3333333333333",
      "role": "Beneficiary",
      "isPayer": false,
      "participationPercentage": 1,
      "emails": [
        {
          "emailAddress": "[email protected]"
        }
      ],
      "phones": [
        {
          "number": "3333333"
        }
      ],
      "address": {
        "street": "Av. Raja Gabáglia",
        "number": "1143",
        "district": "Luxemburgo",
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403",
        "complement": "20º andar",
        "country": "bra",
        "type": "Residential"
      }
    }
  ],
  "riskObjects": [
    {
      "type": "Equipment",
      "coverages": [
        {
          "key": "basica",
          "insuredAmount": "50000.00",
          "feeMultiple": "1"          
        },
        {
          "key": "furto",
          "insuredAmount": "10000.00",
          "feeMultiple": "1"
        },
        {
          "key": "perda-pagamento",
          "insuredAmount": "10000.00",
          "feeMultiple": "1",
          "indemnityPeriod": 2
        },
        {
          "key": "rc-maquinas",
          "insuredAmount": "10000.00",
          "feeMultiple": "1
        },
        {
          "key": "operacao-proxima-agua",
          "insuredAmount": "10000.00",
          "feeMultiple": "1
        },
        {
          "key": "danos-eletricos",
          "insuredAmount": "10000.00",
          "feeMultiple": "1
        },
        {
          "key": "rc-operador",
          "insuredAmount": "10000.00",
          "feeMultiple": "1"
        }
      ],
      "equipmentDetails": {
        "manufacturer": "Fabricante",
        "model": "Modelo do equipamento",
        "serialNumber": "Número de série do equipamento",
        "chassis": "Número do chassi",
        "manufactureYear": "2021",
        "equipmentType": "1",
        "equipmentValue": "2500000.00",
        "name": "Maquina",
        "category": "2"
      },
      "equipmentLocation": {
        "nationalCoverage": false,
        "address": {
          "street": "Av. Raja Gabáglia",
          "number": "1143",
          "district": "Luxemburgo",
          "city": "Belo Horizonte",
          "state": "MG",
          "zipCode": "30380403",
          "complement": "20º andar",
          "country": "bra",
          "type": "Residential"
        }
      },
      "invoiceNumber": "NF1111",
      "invoiceDate": "2021-01-01",
      "utilizationType": "1",
      "equipmentAreRentedMayCededThird": false,
      "beneficiaries": [
        {
          "documentNumber": "444444444444",
          "percentage": "1"
        }
      ]
    }
  ]
}

Consultar cotação

Permite consultar os dados de uma cotação.

Requisição (Request)

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

Resposta da cotação para o produto RD - Maquinas e Equipamentos

O retorno da cotação traz o quoteId que identifica unicamente da cotação, além dos valores do prêmio bruto, comercial e iof.

{
  "quoteId": "c03ab663-3d5c-4014-aa5e-cae727103392",
  "productKey": "maquinas-equipamentos",
  "policyType": "ItemByItem",
  "quoteNumber": "99999",
  "createdAt": "2021-04-29T17:12:27.219Z",
  "status": "Approved",
  "commercialPremium": 109.98,
  "grossPremium": 99.99,
  "iof": 9.99,
  "policyPeriodStart": "2021-01-01",
  "policyPeriodEnd": "2021-12-31",
  "discountPercentage": 0,
  "commercialLoadingFee": 0,
  "commissionedAgents": [
    {
      "documentNumber": "11111111111111",
      "role": "Broker",
      "lead": true,
      "commissionPercentage": 0.15,
      "commissionAmount": 9.99,
      "participationPercentage": 1.0
    }
  ],
  "participants": [
    {
      "documentNumber": "22222222222222",
      "role": "Insured",
      "isPayer": true,
      "emails": [
        {
          "emailAddress": "[email protected]"
        }
      ],
      "phones": [
        {
          "number": "3333333"
        }
      ],
      "address": {
        "street": "Av. Raja Gabáglia",
        "number": "1143",
        "district": "Luxemburgo",
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403",
        "complement": "20º andar",
        "country": "bra",
        "type": "Residential"
      }
    },
    {
      "documentNumber": "3333333333333",
      "role": "Beneficiary",
      "isPayer": false,
      "participationPercentage": 1,
      "emails": [
        {
          "emailAddress": "[email protected]"
        }
      ],
      "phones": [
        {
          "number": "3333333"
        }
      ],
      "address": {
        "street": "Av. Raja Gabáglia",
        "number": "1143",
        "district": "Luxemburgo",
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403",
        "complement": "20º andar",
        "country": "bra",
        "type": "Residential"
      }
    }
  ],
  "riskObjects": [
    {
      "type": "Equipment",
      "coverages": [
        {
          "key": "basica",
          "insuredAmount": "50000.00",
          "feeMultiple": "1"  
        },
        {
          "key": "furto",
          "insuredAmount": "10000.00",
          "feeMultiple": "1"
        },
        {
          "key": "perda-pagamento",
          "insuredAmount": "10000.00",
          "feeMultiple": "1",
          "indemnityPeriod": 2
        },
        {
          "key": "rc-maquinas",
          "insuredAmount": "10000.00",
          "feeMultiple": "1"
        },
        {
          "key": "operacao-proxima-agua",
          "insuredAmount": "10000.00",
          "feeMultiple": "1"
        },
        {
          "key": "danos-eletricos",
          "insuredAmount": "10000.00",
          "feeMultiple": "1"
        },
        {
          "key": "rc-operador",
          "insuredAmount": "10000.00",
          "feeMultiple": "1"
        }
      ],
      "equipmentDetails": {
        "manufacturer": "Fabricante",
        "model": "Modelo do equipamento",
        "serialNumber": "Número de série do equipamento",
        "chassis": "Número do chassi",
        "manufactureYear": "2021",
        "equipmentType": "1",
        "equipmentValue": "2500000.00",
        "name": "Maquina",
        "category": "2"
      },
      "equipmentLocation": {
        "nationalCoverage": false,
        "address": {
          "street": "Av. Raja Gabáglia",
          "number": "1143",
          "district": "Luxemburgo",
          "city": "Belo Horizonte",
          "state": "MG",
          "zipCode": "30380403",
          "complement": "20º andar",
          "country": "bra",
          "type": "Residential"
        }
      },
      "invoiceNumber": "NF1111",
      "invoiceDate": "2021-01-01",
      "utilizationType": "1",
      "equipmentAreRentedMayCededThird": false,
      "beneficiaries": [
        {
          "documentNumber": "444444444444",
          "percentage": 1
        }
      ]
    }
  ]
}

Consultar documento da cotação

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

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/insurance/v1/maquinas-equipamentos/quotes/{quote_id}/draft
Method	Get
Query	product_key	Chave de identificação do produto. maquinas-equipamentos
	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 cotação 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

condições de pagamento

Para consultar condições de pagamento Api Financial em :

/billings/{product_key}/pricing/{quote_id}

acessar :

condições de pagamento

Observação :

Solução de problemas:
Caso a API de requisição de PROPOSTA retorne os erros "Serial number is required." OU "Chassi is required for self-propelled equipment." isso significa que a cotação foi realizada sem o número de série (serialNumber) e/ou chassi (quando aplicável). Para que a solicitação seja bem sucedida será necessário o reenvio das informações completas através de um novo Request de COTAÇÃO já que a atual versão ainda não conta com a API de Update de cotação.

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/maquinas-equipamentos/proposals
Method	Post
Query	product_key	Chave de identificação do produto.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	Proposal

Exemplos

Proposta com boleto

Proposta com pagamento à vista através de boleto, com vencimento em 7 dias.

  {
    "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
    "policyPeriodStart": "2023-09-15",
    "policyPeriodEnd": "2024-09-15",
    "payment": {
      "paymentType": "Boleto",
       "installments": "1",
       "firstInstallmentDueDateDelay": "7"
      "paymentInstructions": "informaçoes da forma de pagamento"
    }
  }
  

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 boleto

Resposta de proposta com pagamento à vista através de boleto, com vencimento em 7 dias.

{
  "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
  "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
  "proposalNumber": "99999",
  "policyPeriodStart": "2021-01-01",
  "policyPeriodEnd": "2021-12-31",
  "payment": {
    "paymentType": "Boleto",
    "installments": "1"
  },
  "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/maquinas-equipamentos/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/maquinas-equipamentos/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 boleto

Resposta de proposta com pagamento à vista através de boleto, com vencimento em 7 dias.

{
  "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
  "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
  "proposalNumber": "99999",
  "policyPeriodStart": "2021-01-01",
  "policyPeriodEnd": "2021-12-31",
  "payment": {
    "paymentType": "Boleto",
    "installments": "1"    
  },
  "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/maquinas-equipamentos/proposals/{proposal_id}/document
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	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

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/maquinas-equipamentos/policies
Method	Post
Query	product_key	Chave de identificação do produto.
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	Policy

Exemplos

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": "2021-08-03T00:00:00Z",
  "policyPeriodEnd": "2022-08-03T00:00:00Z",
  "status": "Creating",
  "createdAt": "2021-08-03T18: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": "2021-08-03T00:00:00Z",
  "policyPeriodEnd": "2022-08-03T00:00:00Z",
  "status": "Active",
  "createdAt": "2021-08-03T18: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/maquinas-equipamentos/policies/{policy_id}
Method	Get
Query	product_key	Chave de identificação do produto.
	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": "2021-08-03T00:00:00Z",
  "policyPeriodEnd": "2022-08-03T00:00:00Z",
  "status": "Creating",
  "createdAt": "2021-08-03T18: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": "2021-08-03T00:00:00Z",
  "policyPeriodEnd": "2022-08-03T00:00:00Z",
  "status": "Active",
  "createdAt": "2021-08-03T18: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/maquinas-equipamentos/policies/{policy_id}/document
Method	Get
Query	product_key	Chave de identificação do produto.
	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.	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

SendToAnalysis

Representa solicitação de analise do subscritor de um produto.

Campo	Tipo	Regras	Descrição
quoteId	string (uuid)	Opcional	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.
observation	string	Opcional	observation
issuer	object	Opcional	Representa e contem os dados do emissor .
attachments	array de Attachment	Opcional	Lista de Anexos necessarios para a subscrição.

Dicionário

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)	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.
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.
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
partners	array de Partners	Opcional	Lista de Parceiros comerciais em uma apólice, não é uma entidade oficial ou regulamentada, é utilizada somente para representar vínculos comerciais.
riskObjects	array de Equipment	Obrigatório	Lista de objetos segurados. Os objetos segurados variam conforme o produto informado.

PolicyType

Tipo da apólice informa se é contratação única ou item a item.

• Unique: Contratação única.
• ItemByItem: Contratação item a item.

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 asterisco (*). 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.
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.
isPayer	boolean	Obrigatório	informa quem é o pagador da apólice.

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

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.
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.
• 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.
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. (aplicável apenas para a cobertura Perda ou pagamento de aluguel a terceiros período em meses, com mínimo 1 e máximo 6 meses para a cobertura)
pos	number	Opcional	percentual de Participação Obrigatória do Segurado.
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.
percentage	number	Opcional	Percentual de participação na comissão.
description	string	Opcional	texto descritivo da franquia.

Equipment

Representa um equipamento que está sendo segurado.

Campo	Tipo	Regras	Descrição
type	string	Obrigatório	Nome do tipo do objeto de risco. Valor fixo "Equipment"
coverages	array de Coverage	Obrigatório	Lista de coberturas para o objeto segurado.
equipmentDetails	EquipmentDetails	Opcional	Detalhes do equipamento segurado.
equipmentLocation	EquipmentLocation	Opcional	Detalhes da localização do equipamento segurado.
invoiceNumber	string	Opcional	Número da Nota Fiscal ou Contrato de aquisição do equipamento.
invoiceDate	string (date)	Opcional	Data de emissão da Nota Fiscal ou Contrato de aquisição do equipamento.
utilizationType	number (enum)	Opcional	Tipo da utilização do equipamento. 1: CONSTRUÇÃO CIVIL 2: COMÉRCIO 3: DEMAIS (EXCETO FLORESTAL E USO EXCLUSIVAMENTE EM ATIVIDADE RURAL) 4: LOCAÇÃO DE EQUIPAMENTOS 5: PRESTAÇÃO DE SERVIÇOS COM OPERADOR PRÓPRIO 6: MÉDICO HOSPITALAR 7: INDÚSTRIA 8: TERRAPLANAGEM 14: ATIVIDADES NÂO AGRICOLAS 20: MINERAÇÂO

EquipmentDetails

Contém informações detalhadas sobre o equipamento.

Campo	Tipo	Regras	Descrição
manufacturer	string	Obrigatório	Fabricante do equipamento.
model	string	Obrigatório	Modelo do equipamento.
serialNumber	string	Opcional	Número de série do equipamento.
chassis	string	Opcional	Chassi do equipamento. Esse campo é obrigatório caso seja um equipamento que tenha chassi.
manufactureYear	number (Int32)	Opcional	Ano de fabricação do equipamento
equipmentType	number	Obrigatório	Identificador do Tipo de equipamento segurado. Obter Tipo na Api Risk Object em: Listar tipo Equipamentos
equipmentValue	number	Obrigatório	Valor do equipamento
name	string	Obrigatório	Nome do equipamento
category	number	Obrigatório	Numero da Categoria do Equipamento. Obter Categoria na Api Risk Object em: Listar tipo Equipamentos

EquipmentLocation

Campo	Tipo	Regras	Descrição
nationalCoverage	boolean	Opcional	Identifica se a cobertura do equipamento é para todo o território nacional.
address	Address	Opcional	Representa uma localidade com endereço.

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	Sigla do pais de Origem.
type	string	Opcional	Descrição da localidade Residential: Endereço Residencial. Business: Endereço Empresal. Billing: Endereço de Cobrança.

Partners

Representa um Parceiros comerciais em uma apólice, não é uma entidade oficial ou regulamentada, é utilizada somente para representar vínculos comerciais.

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 asterisco (*). Exemplos de retorno: 11699534000174 -> 11699\*\*\*0001\*\* 12345678909 -> 123\*\*\*789\*\*
role	string (PartnerRole)	Obrigatório	Papel do parceiro na cotação. Os participantes que são obrigatórios varia por produto.
name	string	Opcional	nome do parceiro

PartnerRole

Parceiros comerciais em uma apólice, não é uma entidade oficial ou regulamentada, é utilizada somente para representar vínculos comerciais.

• Advisor:Assessor.
• CommercialAgent: Representante Comercial .

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.
• 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.
firstInstallmentDueDateDelay	integer	Opcional	Carência para a data de vencimento da primeira parcela, em dias, para pagamento em boleto.
firstDueDate	string	Opcional	Data de vencimento da primeira parcela, para pagamento em boleto.
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.
accountExtension	string	Opcional	Letra 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.

PaymentType

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

• Invoice: Pagamento através de fatura.
• Boleto: Pagamento através de boleto.
• 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

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.