API Cancelamento

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.

Produtos Disponíveis para Cancelamento

A API de Cancelamento está disponível para uma variedade de produtos. Cada produto corresponde a um tipo específico de apólice que pode ser cancelada utilizando esta API. Abaixo, você encontrará a lista dos produtos atualmente suportados:

• Garantia Judicial Depósito Recursal (judicial-deposito-recursal)
• Pottencial Residencial (residencial)
• Pottencial Vida (vida)

Cancellations

Motivos de Cancelamento

Essa operação permite consultar os dados e listar os motivos de cancelamento do produto.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/cancellation/v1/{product_key}/proposals/cancellation-reasons
Method	Get
Query	product_key	Chave de identificação do produto. Judicial Depósito Recursal judicial-deposito-recursal
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	Lista localizada com sucesso.	Reasons
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

Exemplo

[
  {
    "id": "62354f29-4029-4ba1-82f8-309e458a0170",
    "reason": "Emissão em duplicidade",
    "attachmentsRequired": "true"
  },
  {
    "id": "52354f29-4029-4ba1-82f8-309e458a0171",
    "reason": "Recusa do Segurado",
    "attachmentsRequired": "false"
  }
]

Cálculo do cancelamento do produto.

Permite obter cálculo do cancelamento do produto.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/cancellation/v1/{product_key}/proposals/cancellation-calc/{policy_number}
Method	Get
Query	product_key	Chave de identificação do produto. Judicial Depósito Recursal judicial-deposito-recursal
	policy_number	Número 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	obter cálculo do cancelamento do produto.	CancellationCalc
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
403	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

{
  "amount": "0",
  "financialItemsToPay": {
    "refundIofAmount": "0",
    "totalToPayAmount": "100"
  },
  "unRefundableServicePaidAmount": "0",
  "financialItemsToReceive": {
    "commercialAmount": "100",
    "additionalAmount": "50",
    "additionalPercentage": "5",
    "iofAmount": "7",
    "iofPercentage": "2",
    "financialChargesAmount": "200",
    "totalToReceiveAmount": "0"
  }
}

Enviar Anexos necessário

Permite enviar anexos para proposta de cancelamento.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/cancellation/v1/{product_key}/proposals/cancellation-attachments
Method	Post
Query	product_key	Chave de identificação do produto. Judicial Depósito Recursal judicial-deposito-recursal
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	AttachmentRequest

Exemplos

Request para enviar anexos

Request para enviar anexos.

{
  "policyNumber": "0306920219901140003053000",
  "description": "segue anexos referente ao cancelamento",
  "attachment": {
    "name": "anexo1.pdf",
    "content": "BASE 64"
  }
}

Respostas (Response)

Status	Descrição	Tipo
204	Anexo enviado 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

Tickets

Lista de tickets

Permite obter lista de tickets dos chamados.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/cancellation/v1/ticket
Method	Get
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	obter lista de tickets dos chamados.	Tickets
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
403	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": "111",
    "status": "done",
    "createdAt": "2023-01-01"
  },
  {
    "ticketNumber": "112",
    "status": "done",
    "createdAt": "2023-01-01"
  }
]

Obter descrição do ticket.

Recupera os detalhes de um ticket.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/cancellation/v1/ticket/{ticket_number}
Method	Get
Query	ticket_number	Identificador do ticket .
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
200	obter lista de tickets dos chamados.	Ticket
400	Os dados da requisição estão inválidos.	ErrorResult
401	Parceiro não autorizado a realizar a operação.	ErrorResult
403	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": "111",
  "status": "done",
  "followup": [
    {
      "message": "ticket 01",
      "messageDate": "2023-01-01",
      "origin": "External"
    },
    {
      "message": "ticket 02",
      "messageDate": "2023-01-02",
      "origin": "Internal"
    }
  ]
}

Adicionar informações ao ticket

Envia mensagem em um ticket.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/cancellation/v1/ticket/{ticket_number}
Method	Post
Query	ticket_number	Identificador do ticket .
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	CancelTicket

Exemplos

Envia mensagem em um ticket

Envia mensagem a um ticket

{
  "message": "atualizado"
}

Respostas (Response)

Status	Descrição	Tipo
204	Mensagem 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

Cancelar o ticket

Permite solicitar o cancelamento do ticket.

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/cancellation/v1/ticket/{ticket_number}/cancell
Method	Post
Query	ticket_number	Identificador do ticket .
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.

Respostas (Response)

Status	Descrição	Tipo
204	Cancelamento efetuado 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 um cancelamento da apólice para um produto Pottencial.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/cancellation/v1/{product_key}/proposals
Method	Post
Query	product_key	Chave de identificação do produto. Judicial Depósito Recursal judicial-deposito-recursal
Headers	client_id	Client ID da App.
	access_token	Token de acesso gerado para a App.
Body	Cancellation

Exemplos

Solicitação de cancelamento da proposta

Solicitação de emissão de cancelamento.

{
  "cancellationDate": "2022-08-03T00:00:00Z",
  "policyNumber": "0306920219901140003053000",
  "cancellationReasonId": "62354f29-4029-4ba1-82f8-309e458a0170",
  "intentReuseCredit": "false",
  "financialRestitutionData": {
    "bankNumber": "001",
    "agencyNumber": "5858",
    "accountNumber": "66544",
    "accountDigit": "0"
  }
}

Respostas (Response)

Status	Descrição	Tipo
200	Proposta submetida com sucesso.	CancellationRespnse
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

{
  "proposalId": "62354f29-4029-4ba1-82f8-309e458a0170",
  "proposalNumber": "12345",
  "status": "Done",
  "documentUri": "https://developers.pottencial.com.br/api-portal/pt-br/content/api-guide",
  "ticketNumber": "123"
}

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/cancellation/v1/{product_key}/proposals/{proposal_id}
Method	Get
Query	product_key	Chave de identificação do produto. Judicial Depósito Recursal judicial-deposito-recursal
	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.	CancellationRespnse
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

{
  "proposalId": "62354f29-4029-4ba1-82f8-309e458a0170",
  "proposalNumber": "12345",
  "status": "Done",
  "documentUri": "https://developers.pottencial.com.br/api-portal/pt-br/content/api-guide",
  "ticketNumber": "123"
}

Aceitar proposta

Permite aprovar uma proposta criada.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/cancellation/v1/{product_key}/proposals/{proposal_id}/accept
Method	Post
Query	product_key	Chave de identificação do produto. Judicial Depósito Recursal judicial-deposito-recursal
	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 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/cancellation/v1/{product_key}/proposals/{proposal_id}/document
Method	Get
Query	product_key	Chave de identificação do produto. Judicial Depósito Recursal judicial-deposito-recursal
	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

Documento de cancelamento

Emitir endosso

Permite emitir um endosso para uma proposta existente. A proposta deve ter sido aceita previamente.

Requisição (Request)

Url	https://api-sandbox.pottencial.com.br/cancellation/v1/{product_key}/endosso
Method	Post
Query	product_key	Chave de identificação do produto. Judicial Depósito Recursal judicial-deposito-recursal
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 do endosso 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 endosso aguardando processamento

Resposta de emissão de endosso 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 endosso

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/cancellation/v1/{product_key}/endosso/{policy_id}
Method	Get
Query	product_key	Chave de identificação do produto. Judicial Depósito Recursal judicial-deposito-recursal
	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 endosso aguardando processamento

Resposta de emissão de endosso 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 endosso processada com sucesso

Resposta de emissão de endosso 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 do endosso

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/cancellation/v1/{product_key}/endosso/{policy_id}/document
Method	Get
Query	product_key	Chave de identificação do produto. Judicial Depósito Recursal judicial-deposito-recursal
	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

Dicionário

Cancellation

Representa uma proposta de um produto para cancelamento.

Campo	Tipo	Regras	Descrição
cancellationDate	string (date)	Somente leitura	Data de cancelamento da apólice.
policyNumber	string	Somente leitura	Número da apólice.
cancellationReasonId	string (uuid)	Somente leitura	ID único do motivo de cancelamento. O ID será obtido no endpoint reasons.
intentReuseCredit	boolean	Opcional	Solicitaçao de reaproveitamento de crédito.
financialRestitutionData	BankAccount	Opcional	Dados bancários para pagamento da restituição através de débito em conta.

BankAccount

Representa os dados de uma conta bancária.

Campo	Tipo	Regras	Descrição
bankNumber	string	Obrigatório	Código de compensação do banco, conforme cadastrado no Banco Central.
agencyNumber	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.

CancellationRespnse

Representa Resposta de uma proposta de um produto para cancelamento.

Campo	Tipo	Regras	Descrição
proposalId	string (uuid)	Somente leitura	ID único da apólice. O ID será gerado automaticamente no retorno da API..
proposalNumber	string	Somente leitura	Número da Proposta.
status	string (ProposalStatus)	Somente leitura	Situação atual da proposta. Esse campo é preenchido automaticamente e retornado quando uma proposta é criada com sucesso.
ticketNumber	string	Somente leitura	número do chamado, será retornado quando não for possível emissão automática do cancelamento.
documentUri	string	Somente leitura	uri do documento de proposta de cancelamento.

ProposalStatus

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

• Pending: (Pendente): Indica que uma proposta foi criada e está aguardando o enriquecimento dos dados de pagamento (Id do pagador, Data do primeiro vencimento, Instruções para pagamento em caso de boleto), ou aguardando a informação dos dados bancários, nos casos de endossos de restituição onde iremos estornar valores para o cliente.
• Ready: (Pronta): Indica que a proposta está pronta para que seja gerado o PDF de proposta. A proposta fica nesse status: Quando houve a configuração de pagamento ou dados bancários para estorno; Quando não há movimentação financeira, portanto não há porque configurar pagamento ou dados bancários para estorno; Quando há redução no prêmio (endosso de restituição) e haverá uma liquidação do saldo do cliente com o cancelamento das últimas parcelas em aberto não é necessário configurar dados do pagador, portanto a Proposta fica pronta para emissão de documento (Em discussão).
• Issued:(Emitida): Indica que o PDF de proposta foi emitido, portanto a proposta já tem valor legal perante a SUSEP.
• Accepted:(Aceita): Indica que a proposta foi aceita, tanto pelo cliente, quanto pela Pottencial.
• Rejected:(Recusada): Indica que a proposta foi recusada pela Pottencial.
• PendingCompanyAcceptance:(Pendente do aceite da companhia): Esse caso é usado para produtos que mesmo após a subscrição aprovar, ainda dependam de uma confirmação da Pottencial, portanto mesmo após o aceite do cliente, a proposta fica aguardando o aceite ou recusa da Pottencial.
• Done: (Concluída): Indica que foi emitida uma apólice para aquela proposta e que a mesma foi concluída.
• Canceled: (Cancelada): Indica que a proposta foi cancelada por motivos previamente cadastrados, por exemplo falta de pagamento. Uma proposta só pode ser cancelada caso ela não tenha apólice vinculada.

Reason

Representa uma objeto de motivos de cancelamento de um produto.

Campo	Tipo	Regras	Descrição
id	string (uuid)	Somente leitura	Identificador único do motivo de cancelamento.
reason	string	Somente leitura	descrição do motivo de cancelamento.
attachmentsRequired	boolean	Somente leitura	indicador se aquele motivo de cancelamento exige anexos para análise interna.

AttachmentRequest

Representa um objeto de cancelamento de um produto anexando arquivos.

Campo	Tipo	Regras	Descrição
description	string	Somente leitura	Informações complementares para auxiliar no Anexos.
policyNumber	string	Somente leitura	Número da apólice.
attachment	object	Opcional	Anexo necessários para o Cancelamento dados do anexo.

Attachment

Representa dados do anexo.

Campo	Tipo	Regras	Descrição
name	string	Somente leitura	Nome identificador do anexo.
content	string	Somente leitura	(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)).

CancellationCalc

Representa o cálculo do cancelamento.

Campo	Tipo	Regras	Descrição
amount	number	Somente leitura	valor do cálculo onde negativo - valor a restituir / positivo - devedor da pottencial.
unRefundableServicePaidAmount	number	Somente leitura	valor pago pelo serviço reembolsável.
financialItemsToPay	PaidAmount	Opcional	Detalhes de pagamento a serem pagos.
financialItemsToReceive	ToReceive	Opcional	Detalhes de pagamento a serem restituidos.

PaidAmount

Representa um objeto com dados do pagamento.

Campo	Tipo	Regras	Descrição
refundIofAmount	number	Somente leitura	Quantia de reembolso do IOF
totalToPayAmount	number	Somente leitura	Valor total a pagar

ToReceive

Representa um objeto com dados do pagamento de restituição.

Campo	Tipo	Regras	Descrição
commercialAmount	number	Somente leitura	Quantia do valor comercial a receber
additionalAmount	number	Somente leitura	Valor adicional a receber
additionalPercentage	number	Somente leitura	Valor porcentual adicional a receber
iofAmount	number	Somente leitura	Valor IOF a receber
iofPercentage	number	Somente leitura	Valor percentual IOF a receber
financialChargesAmount	number	Somente leitura	Valor dos encargos financeiros
totalToReceiveAmount	number	Somente leitura	valor total a receber

Tickets

Representa uma proposta de um produto para cancelamento.

Campo	Tipo	Regras	Descrição
ticketNumber	string	Somente leitura	Identificador unico do tickey
status	string	Somente leitura	status tickey
createdAt	string (date)	Somente leitura	data de criação do tickey

Ticket

Recupera os detalhes de um ticket.

Campo	Tipo	Regras	Descrição
ticketNumber	string	Somente leitura	Identificador unico do tickey
status	string	Somente leitura	status tickey
followup	Followup	Obrigatório	Detalhes da mensagens do ticket.

Followup

Representa uma mensagem do ticket de cancelamento.

Campo	Tipo	Regras	Descrição
message	string	Somente leitura	descrição da mensagem
origin	string	Somente leitura	origin da mensagem
messageDate	string (date)	Somente leitura	data da mensagem

CancelTicket

Representa uma proposta de um produto para cancelamento.

Campo	Tipo	Regras	Descrição
description	string (date)	Somente leitura	descrição de cancelamento.

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	Número 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.

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. Judicial Depósito Recursal Somente permite uma única parcela. Judicial Depósito Recursal - Substituição Somente permite uma única parcela.
firstInstallmentDueDateDelay	integer	Opcional	Carência para a data de vencimento da primeira parcela, em dias, para pagamento em boleto. Judicial Depósito Recursal São permitidas as carências de 1 a 60 dias na forma de pagamento boleto e no caso de fatura (pagamento a vista). Judicial Depósito Recursal - Substituição São permitidas as carências de 1 a 60 dias na forma de pagamento boleto e no caso de fatura (pagamento a vista).
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.

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.