Criar Proposta

Criar proposta

POST {{url_ambiente}}/{{version}}/quotation/proposal

Cria uma proposta (atualiza informações adicionais)

Headers

Name
Type
Description

Ocp-Apim_Subscription-Key*

key

chave de acesso da api.

Response

Request

{
    "identifier": "3a7d4d0f-905b-4abf-859d-8b1cebddb53a",
    "registerNumber": "100000",
    "operationCode": "INSURANCE-BROKER-CIVIL-LIABILITY-PARTNER",
    "answers": [
        {
            "code": "DUE-DAY",
            "answer": "1"
        },
        {
            "code": "PAYMENT-METHOD",
            "answer": "CREDIT-CARD"
        },
        {
            "code": "INSURED-BIRTH-DATE",
            "answer": "1990-09-08T03:00:00.000Z"
        },
        {
            "code": "PAYMENT-INSTALLMENT-IDENTIFIER",
            "answer": "fab2abd1-88f3-40fe-b37f-0db0ed5ba9b5"
        },
        {
            "code": "PEP",
            "answer": "NO"
        },
        {
            "code": "PEP-NAME",
            "answer": ""
        },
        {
            "code": "PEP-PARENTING",
            "answer": ""
        }
    ]
}

Detalhamento request de proposta

Code: INSURED-BIRTH-DATE Type: date ❗ Obrigatório que esteja incluído no array (apenas se o segurado for Pessoa Fisica).

Pergunta usada para definir a data de nascimento do segurado.

Field: RegisterNumber

Tipo: text

❗ Campo Obrigatório.

Campo usado para definir qual o SusepNumber da corretora que está sendo cotada. Neste caso, o susep da corretora é "100000".

Code: PAYMENT-METHOD Type: text ❗ Obrigatório que esteja incluído no array.

Pergunta usada para definir o método de pagamento. Os possíveis valores para esta pergunta são:

  • CREDIT-CARD

    • Para o ambiente de homologação, é necessário que o valor do prêmio da cotação, campo "Total Value", seja um número par, para que seja possível obter sucesso no checkout.

  • TICKET

Code: DUE-DAY Type: integer ❗ Obrigatório que esteja incluído no array. (apenas quando o PAYMENT-METHOD for TICKET).

Pergunta usada para definir o dia de vencimento quando o PAYMENT-METHOD for TICKET (boleto). Só é possivel envio do dia 1 ao dia 20.

Code: PAYMENT-INSTALLMENT-IDENTIFIER Type: guid ❗ Obrigatório que esteja incluído no array.

O guid que será enviado nesse campo é retornado no array de installments, no retorno do endpoint de criar cotação.

Code: PEP Type: string ❗ Obrigatório que esteja incluído no array quando for PESSOA FÍSICA.

Pergunta usada para definir se é uma pessoa exposta publicamente.

Respostas para PEP: NO: Não é publicamente exposta.

YES: É publicamente exposta.

RELATION: Relacionamento próximo.

Caso PEP for RELATION, é necessário o envio de mais três perguntas, sendo elas:

Response

Explicando campos de retorno

Diferente do Response de Cotação, o de proposta possui um campo a mais logo após o "Status", que seria o proposal:

Field: number Type: text

Número da proposta.

Field: date Type: date

Data que a proposta foi criada.

Field: documentUrl Type: text

Link do documento da proposta.

PreviousCriar CotaçãoNextCheckout

Last updated