Garantia do Licitante (BID)

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

Exemplos

Cotação para o produto Garantia do Licitante

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

{
  "policyType": "Unique",
  "policyPeriodStart": "2021-11-23T00:00:00Z",
  "policyPeriodEnd": "2022-11-23T00:00:00Z",
  "commissionedAgents": [
    {
      "documentNumber": "11111111111111",
      "role": "Broker",
      "participationPercentage": 0.50,
      "lead": "true"
    },
    {
      "documentNumber": "22222222222222",
      "role": "Broker",
      "participationPercentage": 0.50,
      "lead": "false"
    },
    {
      "documentNumber": "33333333333333",
      "role": "PolicyOwner"
    }
  ],
  "participants": [
    {
      "documentNumber": "44444444444",
      "role": "Beneficiary"
    },
    {
      "documentNumber": "44444444444",
      "role": "Insured",
      "address": {
        "street": "Av. Raja Gabáglia",
        "number": "1143",
        "district": "Luxemburgo",
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403",
        "complement": "20º andar"
      }
    }
  ],
  "riskObjects": [
    {
      "type": "Contract",
      "coverages": [
        {
          "key": "basica",
          "insuredAmount": 115000.00
        }
      ],
      "noticeNumber": "123456",
      "contractAmount": 100000.00,
      "additionalInformation": "Informações adicionais",
      "observation": "Informações adicionais do tomador"
    }
  ]
}

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

{
  "quoteId": "c03ab663-3d5c-4014-aa5e-cae727103392",
  "productId": "0040b17d-90cf-405a-8962-07cc3f19d9cb",
  "policyType": "Unique",
  "quoteNumber": "99999",
  "createdAt": "2021-04-29T17:12:27.219Z",
  "status": "Approved",
  "commercialPremium": 109.98,
  "grossPremium": 99.99,
  "iof": 9.99,
  "commissionedAgents": [
    {
      "documentNumber": "11111111111111",
      "role": "Broker",
      "participationPercentage": 0.50,
      "commissionAmount": 9.99,
      "lead": "true"
    },
    {
      "documentNumber": "22222222222222",
      "role": "Broker",
      "participationPercentage": 0.50,
      "commissionAmount": 9.99,
      "lead": "false"
    },
    {
      "documentNumber": "33333333333333",
      "role": "PolicyOwner"
    }
  ],
  "participants": [
    {
      "documentNumber": "44444444444",
      "role": "Beneficiary"
    },
    {
      "documentNumber": "44444444444",
      "role": "Insured",
      "address": {
        "street": "Av. Raja Gabáglia",
        "number": "1143",
        "district": "Luxemburgo",
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403",
        "complement": "20º andar"
      }
    }
  ],
  "riskObjects": [
    {
      "type": "Contract",
      "coverages": [
        {
          "key": "basica",
          "insuredAmount": 115000.00
        }
      ],
      "noticeNumber": "123456",
      "contractAmount": 100000.00,
      "additionalInformation": "Informações adicionais",
      "observation": "Informações adicionais do tomador"
    }
  ]
}

Consultar cotação

Permite consultar os dados de uma cotação.

Requisição (Request)

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

{
  "quoteId": "c03ab663-3d5c-4014-aa5e-cae727103392",
  "productId": "0040b17d-90cf-405a-8962-07cc3f19d9cb",
  "policyType": "Unique",
  "quoteNumber": "99999",
  "createdAt": "2021-04-29T17:12:27.219Z",
  "status": "Approved",
  "commercialPremium": "109.98",
  "grossPremium": "99.99",
  "iof": "9.99",
  "commissionedAgents": [
    {
      "documentNumber": "11111111111111",
      "role": "Broker",
      "participationPercentage": "0.50",
      "commissionAmount": "9.99",
      "lead": "true"
    },
    {
      "documentNumber": "22222222222222",
      "role": "Broker",
      "participationPercentage": "0.50",
      "commissionAmount": "9.99",
      "lead": "false"
    },
    {
      "documentNumber": "33333333333333",
      "role": "PolicyOwner"
    }
  ],
  "participants": [
    {
      "documentNumber": "44444444444",
      "role": "Beneficiary"
    },
    {
      "documentNumber": "44444444444",
      "role": "Insured",
      "address": {
        "street": "Av. Raja Gabáglia",
        "number": "1143",
        "district": "Luxemburgo",
        "city": "Belo Horizonte",
        "state": "MG",
        "zipCode": "30380403",
        "complement": "20º andar"
      }
    }
  ],
  "riskObjects": [
    {
      "type": "Contract",
      "coverages": [
        {
          "key": "basica",
          "insuredAmount": "115000.00"
        }
      ],
      "noticeNumber": "123456",
      "contractAmount": "100000.00",
      "additionalInformation": "Informações adicionais",
      "observation": "Informações adicionais do tomador"
    }
  ]
}

Solicitar analise do subscritor

Permite solicitar a analise 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/{product_key}/quotes/analysis
Method	Post
Query	product_key	Chave de identificação do produto. Garantia do Licitante garantia-bid
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	SendToAnalysis

Exemplos

Requisição da Analise do subscritor

Requisição da Analise do subscritor.

{
  "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
  "observation": "otimo cliente pode aprovar",
  "issuer": {
    "name": "nome do issuer",
    "email": "[email protected]"
  },
  "attachments": [
    {
      "name": "anexo1.pdf",
      "content": "BASE 64"
    },
    {
      "name": "anexo2.pdf",
      "content": "BASE 64"
    }
  ]
}

Respostas (Response)

Status	Descrição	Tipo
201	Analise do subscritor cadastrada com sucesso.	TicketNumber
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

{
  "ticketNumber": "12313"
}

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/{product_key}/quotes/{quote_id}/draft
Method	Get
Query	product_key	Chave de identificação do produto. Garantia do Licitante garantia-bid
	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.	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

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/{product_key}/proposals
Method	Post
Query	product_key	Chave de identificação do produto. Garantia do Licitante garantia-bid
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 através de boleto, com vencimento entre 1 e 30 dias.

Obs.: Parcela mínima a partir de R$ 500,00 é possível parcelar.

{
  "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
  "policyPeriodStart": "2021-01-01",
  "policyPeriodEnd": "2021-12-31",
  "payment": {
    "paymentType": "Boleto",
    "installments": "1",
    "firstInstallmentDueDateDelay": "7"
  }
}

Proposta com fatura

Proposta com pagamento a vista através de fatura.

{
  "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
  "policyPeriodStart": "2021-01-01",
  "policyPeriodEnd": "2021-12-31",
  "payment": {
    "paymentType": "Invoice",
    "installments": "1"
  }
}

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

Proposta com pagamento através de boleto, com vencimento entre 1 e 30 dias.

Obs.: Parcela mínima a partir de R$ 500,00 é possível parcelar.

{
  "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",
    "firstInstallmentDueDateDelay": "7"
  },
  "createdAt": "2021-08-03",
  "status": "Ready"
}

Resposta de proposta com fatura

Resposta de Proposta com pagamento a vista através de fatura..

{
  "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
  "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
  "proposalNumber": "99999",
  "policyPeriodStart": "2021-01-01",
  "policyPeriodEnd": "2021-12-31",
  "payment": {
    "paymentType": "Invoice",
    "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/{product_key}/proposals/{proposal_id}/accept
Method	Post
Query	product_key	Chave de identificação do produto. Garantia do Licitante garantia-bid
	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/v2/{product_key}/proposals/{proposal_id}
Method	Get
Query	product_key	Chave de identificação do produto. Garantia do Licitante garantia-bid
	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

Resposta de proposta com boleto

Proposta com pagamento através de boleto, com vencimento entre 1 e 30 dias.

Obs.: Parcela mínima a partir de R$ 500,00 é possível parcelar.

{
  "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",
    "firstInstallmentDueDateDelay": "7"
  },
  "createdAt": "2021-08-03",
  "status": "Pending"
}

Resposta de proposta com fatura

Resposta de Proposta com pagamento a vista através de fatura.

{
  "proposalId": "a6ab0082-64ec-4350-81d0-281888fa638e",
  "quoteId": "ac721b29-0a5a-44b4-a205-b23288164f40",
  "proposalNumber": "99999",
  "policyPeriodStart": "2021-01-01",
  "policyPeriodEnd": "2021-12-31",
  "payment": {
    "paymentType": "Invoice",
    "installments": "1"
  },
  "createdAt": "2021-08-03",
  "status": "Pending"
}

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/{product_key}/proposals/{proposal_id}/document
Method	Get
Query	product_key	Chave de identificação do produto. Garantia do Licitante garantia-bid
	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/{product_key}/policies
Method	Post
Query	product_key	Chave de identificação do produto. Garantia do Licitante garantia-bid
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/{product_key}/policies/{policy_id}
Method	Get
Query	product_key	Chave de identificação do produto. Garantia do Licitante garantia-bid
	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/{product_key}/policies/{policy_id}/document
Method	Get
Query	product_key	Chave de identificação do produto. Garantia do Licitante garantia-bid
	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

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 Garantia do Licitante é 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.
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 Contract	Obrigatório	Lista de objetos segurados. Os objetos segurados variam conforme o produto informado. Garantia do Licitante Enviar um único objeto Contract.

PolicyType

Tipo de contratação da apólice.

• Unique: Contratação única.

QuoteStatus

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

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

Participant

Representa um participante dentro da apólice.

Campo	Tipo	Regras	Descrição
documentNumber	string	Obrigatório	CPF/CNPJ do participante. Devem ser informados somente os dígitos, incluindo zeros à esquerda. Essa informação é ofuscada no retorno da API para atender a LGPD, trazendo somente alguns dígitos vizí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.
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.

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

Email

Representa um e-mail de contato.

Campo	Tipo	Regras	Descrição
emailAddress	string	Obrigatório	Endereço de e-mail.
type	string (EmailType)	Opcional	Tipo do e-mail.

EmailType

Define os tipos de e-mail.

• Personal: Pessoal
• Business: Comercial
• Billing: Cobrança
• Communication: Comunicação
• Financial: Financeiro

Phone

Representa um telefone de contato.

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

PhoneType

Define os tipos de telefone.

• Personal: Pessoal
• Business: Comercial
• Billing: Cobrança
• CellPhone: Celular

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. Garantia do Licitante Básica: basica
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.

RiskObjectParticipation

Representa a participação de um beneficiário para um objeto de risco, quando a distribuição é diferente para cada objeto de risco.

Campo	Tipo	Regras	Descrição
documentNumber	string	Obrigatório	CPF/CNPJ do participante, conforme informado na lista de participantes.
participationPercentage	number	Obrigatório	Percentual do prêmio a que o beneficiário tem direito, para o objeto de risco. 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.

Contract

Representa um contrato.

Campo	Tipo	Regras	Descrição
type	string	Obrigatório	Nome do tipo do objeto de risco. Valor fixo "Contract"
coverages	array de Coverage	Obrigatório	Lista de coberturas para o objeto segurado.
contractNumber	string	Opcional	Número do contrato.
contractAmount	number	Obrigatório	Valor total do contrato.
processNumber	string	Opcional	Número do processo.
noticeNumber	string	Obrigatório	Número do edital.
additionalInformation	string	Opcional	Informações adicionais.
observation	string	Opcional	Campo informativo para servir como auxílio para a tomada de decisão interna.

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.

SendToAnalysis

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

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

Issuer

Representa e contem os dados do emissor .

Campo	Tipo	Regras	Descrição
name	string	Opcional	Nome do Emissor
email	string	Opcional	Email do Emissor

Attachment

Representa os dados do Anexo .

Campo	Tipo	Regras	Descrição
name	string	Opcional	Nome identificador do Anexo
content	string (base64)	Opcional	Anexo em Base 64 com tamanho maximo de 20MB e o total de 100MB. E os tipos permitidos são 'Attachments' File type is not in the allowed list (.eml, .doc, .docx, .ppt, .pptx, .pdf, .png, .jpeg, .jpg, .odt, .ods, .xls, .xlsx, .msg)

TicketNumber

Representa o retorno de sucesso com o numero de chamado aberto .

O número do chamado é para acompanhamento interno, caso entre em contato com a Pottencial. Também é possível prosseguir com o acompanhamento através da tela de Minhas Solicitações no Portal do Corretor.

Campo	Tipo	Regras	Descrição
ticketNumber	number	Opcional	numero de chamado aberto

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 em que o pagamento pode ser dividido.
firstInstallmentDueDateDelay	integer	Opcional	Carência para a data de vencimento da primeira parcela, em dias, para pagamento em boleto.

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.
branchNumber	string	Obrigatório	Número a agência da conta bancária, sem dígito.
accountNumber	string	Obrigatório	Número da conta bancária, sem dígito.
accountDigit	string	Obrigatório	Dígito verificador da conta bancária.
documentNumber	string	Obrigatório	CPF/CNPJ do titular da conta bancária.

PaymentType

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

• Invoice: Pagamento através de fatura.
• Boleto: Pagamento através de boleto.

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.