/offers/proposed
API para realizar a efetivação de uma Oferta

Objetivo

Disponibilizar um serviço que oferece a possibilidade do consumidor transmitir uma cotação, realizando a efetivação de uma oferta disponibilizada,
Esta API realiza a transmissão de uma oferta.

Contrato de Serviço - Swagger
Download Swagger
Collection Test Postman
Download Collection Test
Dados Básicos

Nome do Serviço

API Efetivação de Oferta

Descrição Resumida

Realizar a efetivação de uma Oferta

URL

Base Path:
/marketplace/offer/v1/

URI:

  1. /offers/proposal

Status

Ativo

Versão

1.0

Diagrama
Exemplo de Payload
key:AIzaSyCwI4ocy8qCWOrhLSmLFAKkZpoIKqr7LBQ
X-Application-Id:00
X-Company-Id:00
X-User-Id:33333333333
Content-Type:application/json
X-Track-Id:fdgdst43
Authorization=Bearer eyJraWQiOiJiZDc2MzhjYzg4OTU2ZmNjZGFhMGRlYWQ2NDk5M2E1NjQ0ZTcwMTVkIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJoZGktY29ycG9yYXRlLWF1dGhAaW5zLWNyb3NzLXNlY3VyaXR5LWF1dGgtaW50Zy5pYW0uZ3NlcnZpY2VhY2NvdW50LmNvbSIsImF1ZCI6ImFwaS5oZGkuY29tLmJyIiwiYXBwbGljYXRpb24iOltudWxsXSwicm9sZXMiOlsiUm9sZTEiLCJSb2xlMiIsIlJvbGVOIl0sImlzcyI6ImhkaS1jb3Jwb3JhdGUtYXV0aEBpbnMtY3Jvc3Mtc2VjdXJpdHktYXV0aC1pbnRnLmlhbS5nc2VydmljZWFjY291bnQuY29tIiwiZXhwIjoxNTcyNDc4NDY4LCJpYXQiOjE1NzI0NzQ4NjgsInVzZXIiOlsiYXBpLWlucy1pbnRlZ3JhdGlvbi1pbnRlcm5hbC1hY2Nlc3MiXSwid2ViQ2xpZW50IjpbbnVsbF19.N0KeFZzNZiUToV0-Y3hA15PYaYzAUq4xSjbErA97FUhp3Mqs1Yg2AByIOhcqWG4qIuEqvSuf1dIH0QdIToVySP4db9fGEELqu48SF1yCwk2fuaxGLmRtgNDjoJRPwkrxFDUSR7MMsnxn9pV2_sevaWJCyF7QKdGMG0zgZVQbb25S7IrOD3CF97fN9PN5yhsj9f3C8_WDqbDRsvVUdMItmmsbQI98iWM4xQ7O93s1TQCcd84ZQhOdBfYw_yY6jz-hA-tYin3vS33DIcAAR-HNnljdV_9XmWQ5WXd07VjCI8Ynntlrb3vyYjgbkl15VMvfsm0p2ZXgm5jLKFdw8w5nyg
{
    "prospect": [
        {
            "name": "José da Silva Santos",
            "occupationClassificationCode": 9,
            "salaryRangeCode": 9,
            "isAwareName": true,
            "isAwareAddress": true,
            "isPoliticallyExposedPerson": false,            
            "document": [
                {
                    "type": {
                        "id": "1"
                    },
                    "number": "11980808080",
                    "issuer": "",
                    "issueDate": ""
                },
                {
                    "type": {
                        "id": "3"
                    },
                    "number": "32333222",
                    "issuer": "SSP-SP",
                    "issueDate": "2000-12-31"
                }               
            ],
            "contacts": [
                {
                    "type": {
                        "id": "3"
                    },
                    "data": "[email protected]",
                    "isAllowCampaign": false
                },
                {
                    "type": {
                        "id": "1"
                    },
                    "data": "1130303030",
                    "isAllowCampaign": true
                },
                {
                    "type": {
                        "id": "2"
                    },
                    "data": "1130303030",
                    "isAllowCampaign": true
                }
            ],
            "addresses": [
                {
                    "street": "Praça da Sé",
                    "district": "Centro",
                    "number": 1,
                    "complement": "praça",
                    "referencePoint": "Catedral da Sé",
                    "postalCode": "01001001",
                    "city": "Sao Paulo",
                    "State": "SP"
                }
            ]
        }
    ],
    "businessItem": {
        "offerId": "3d0a4660-79f3-432a-b299-c90dd2bb74ad",
        "insurance": {
            "installments": {
                "numberOfInstallments": 5,
                "billingTypeId": 2,
                "installmentDueDate": "2019-10-30",
                "bankData": {
                    "bankCode": "004",
                    "branchCode": "0005",
                    "branchDigit": "",
                    "checkingAccount": "08476",
                    "checkingAccountDigit": "5",
                    "document": [
                        {
                            "type": {
                                "id": "1"
                            },
                            "number": "23123123103",
                            "mainName": "José da Silva Santos"
                        }
                    ]
                }
            },
            "broker": [
                {
                    "sucursalCode": "021",
                    "susepCode": "00000400004995",
                    "isMain": true,
                    "percentageParticipation": 100
                }
            ],
            "autos": [
                {
                    "taxInvoiceNumber  ": "",
                    "newCarWithdrawalDate": "",
                    "dealershipRevenueServiceDocument": "",
                    "provisionalCoverageNumber": "",
                    "provisionalCoverageBrokerSusepCode": "",
                    "vehicle": {
                        "chassisCode": "KMHJN81BBAU179136",
                        "licensePlateCode": "FJU3538",
                        "stateLicensePlateCode": "SP",
                        "nationalVehicleRegistrationNumber": "18118807580"
                    },
                    "insuranceRelationship": {
                        "claimQuantity": 0,
                        "bonusClassNumber": "2",
                        "previousPolicy": {
                            "counterpartCode": "5177",
                            "identificationCode": "51712345678900",
                            "code": "01021431411327",
                         "expirationDate":"2019-10-26"
                        }
                    }
                }
            ]
        }
    }
}
{
    "links": [
        {
            "type": "VISTORIA",
            "dataURL": "https://net.hdi.com.br/digital2/agendamento/acesso/processar?t=eyJhbGc..."
        }
    ]
}
Parâmetros do Request Params
  • key
    Tipo:String
    Obrigatório: Sim
    Descrição: chave de acesso única por player.
    -- Saiba Mais
    [+]
    Esta chave é intransferível e garante a autorização para consumir as APIs.
    Esta informação será trafegada em todas os Params das APIs da HDI.
Parâmetros do Request Headers
  • Content-Type
    Tipo: String
    Obrigatório: Sim
    Descrição: Tipo do conteúdo a ser trafegado no protocolo http
    -- Saiba Mais
    [+]
    Este conteúdo pode ser: Application/Json e em alguns casos já temos Application/PDF
  • X-Company-id
    Tipo: String
    Obrigatório: Sim
    Descrição: Código da empresa
    -- Saiba Mais
    [+]
    Código da empresa
  • X-Application-id
    Tipo: String
    Obrigatório: Sim
    Descrição: Código da aplicação
    -- Saiba Mais
    [+]
    Código da aplicação que irá consumir a API
  • X-User-Id
    Tipo: String
    Obrigatório: Sim
    Descrição: Código do Usuário
    -- Saiba Mais
    [+]
    Código do usuário autenticado no sistema que irá consumir a API
    Representado por exemplo pelo CPF do corretor (no caso de seguros)
  • X-Track-Id
    Tipo: String
    Obrigatório: Sim
    Descrição: Código de agrupamento de ofertas
    -- Saiba Mais
    [+]
    Ex: 000001
Atributos do Request Body
  • prospect[]
    • name
      Tipo:String
      Obrigatório: Sim
      Descrição: Nome do componente
      -- Saiba Mais
      [+]
      Arthur Rodrigues Garcia
    • occupationClassificationCode
      Tipo: integer
      Obrigatório: Sim
      Descrição: Código Brasileiro de ocupação
      -- Saiba Mais
    • refuseOccupation
      Tipo: boolean
      Obrigatório: Não
      Descrição: Recusar o preenchimento de ocupação
      -- Saiba Mais
      [+]
      Ex: false
    • salaryRangeCode
      Tipo: integer
      Obrigatório: Sim
      Descrição: Codigo da faixa salarial
      -- Saiba Mais
      [+]
      • 9
      • 0 "Não informado"
      • 1 "até R$ 3.000,00"
      • 2 "de R$ 3.000,01 a R$ 5.000,00"
      • 3 "de R$ 5000,01 a R$ 10.000,00"
      • 4 "de R$ 10.000,01 a R$ 20.000,00"
      • 5 "acima de R$ 20.000,00"
      • 6 "do lar, sem renda a informar"
    • refuseSalary
      Tipo: boolean
      Obrigatório: Não
      Descrição: Recusar o preenchimento da renda
      -- Saiba Mais
      [+]
      Ex: false
    • resourceCode
      Tipo: String
      Obrigatório: Não
      Descrição: Recurso
      -- Saiba Mais
      [+]
      Ex: "1"
    • refuseResource
      Tipo: boolean
      Obrigatório: Não
      Descrição: Recusar o preenchimento do recurso
      -- Saiba Mais
      [+]
      Ex: false
    • isAwareName
      Tipo:boolean
      Obrigatório: Sim
      Descrição:Nome do proponente foi informado.
      -- Saiba Mais
      [+]
      Ex: true
    • isAwareAddress
      Tipo: boolean
      Obrigatório: Sim
      Descrição: O endereço do proponente foi informado
      -- Saiba Mais
      [+]
      Ex: true
    • isPoliticallyExposedPerson
      Tipo: boolean
      Obrigatório: Sim
      Descrição: É uma pessoa politicamente exposta
      -- Saiba Mais
      [+]
      Ex: false
    • documents[]
      • number
        Tipo: String
        Obrigatório: Sim
        Descrição: Numero do documento
        -- Saiba Mais
        [+]
        Ex: "11980808080"
      • type
        • id
          Tipo: String
          Obrigatório: Sim
          Descrição: Código tipo do documento
          -- Saiba Mais
          [+]
          Ex: "1"
      • issuer
        Tipo: String
        Obrigatório: Não
        Descrição: Emissor
        -- Saiba Mais
        [+]
        Ex: "SSP-SP"
      • issueDate
        Tipo: String
        Obrigatório: Não
        Descrição: Data de emissão
        -- Saiba Mais
        [+]
        Ex: "2020-01-01"
    • contacts[]
      • type
        • id
          Tipo: String
          Obrigatório: Sim
          Descrição: Código do tipo do contato
          -- Saiba Mais
          [+]
          Ex: 3

          Lista de tipos de contatos:
          1 - Telefone celular
          2 - Telefone residencial
          3 - E-mail
      • data
        Tipo: String
        Obrigatório: Sim
        Descrição: Dado do contato
        -- Saiba Mais
      • isAllowCampaign
        Tipo: boolean
        Obrigatório: Sim
        Descrição: Se permite receber campanha
        -- Saiba Mais
        [+]
        Ex: false
    • addresses[]
      • street
        Tipo: String
        Obrigatório: Sim
        Descrição: Rua
        -- Saiba Mais
        [+]
        Ex: "Avenida das Nações Unidas"
      • district
        Tipo: String
        Obrigatório: Sim
        Descrição: Bairro
        -- Saiba Mais
        [+]
        Ex: "Brooklin"
      • number
        Tipo: Integer
        Obrigatório: Sim
        Descrição: Número
        -- Saiba Mais
        [+]
        Ex: 14261
      • complement
        Tipo: String
        Obrigatório: Não
        Descrição: Complemento do Endereço
        -- Saiba Mais
        [+]
        Ex: "Conjunto 2101B e Conjunto 2201B"
      • referencePoint
        Tipo: String
        Obrigatório: Não
        Descrição: Ponto de referência
        -- Saiba Mais
        [+]
        Ex: "WTMorumbi"
      • postalCode
        Tipo: String
        Obrigatório: Sim
        Descrição: CEP
        -- Saiba Mais
        [+]
        Ex: "04578-000"
      • city
        Tipo: String
        Obrigatório: Sim
        Descrição: Cidade
        -- Saiba Mais
        [+]
        Ex: "São Paulo"
      • state
        Tipo: String
        Obrigatório: Sim
        Descrição: Estado
        -- Saiba Mais
        [+]
        Ex: SP
    • complementaryData
      • customer
        • activityDescription
          Tipo: String
          Obrigatório: Não
          Descrição: Descrição da atividade
          -- Saiba Mais
          [+]
          Ex: "Escritório de contabilidade"
        • capitalValue
          Tipo: String
          Obrigatório: Não
          Descrição: Valor do capital
          -- Saiba Mais
          [+]
          Ex: "100000".
        • salaryValue
          Tipo: String
          Obrigatório: Não
          Descrição: Renda
          -- Saiba Mais
          [+]
          Ex: "100000"
        • occupationValue
          Tipo: String
          Obrigatório: Não
          Descrição: Profissão
          -- Saiba Mais
          [+]
          Ex: "1"
        • billingAmount
          Tipo: String
          Obrigatório: Não
          Descrição: Valor do faturamento
          -- Saiba Mais
          [+]
          Ex: "100000"
        • equityValue
          Tipo: String
          Obrigatório: Não
          Descrição: Valor do patrimonio
          -- Saiba Mais
          [+]
          Ex: "100000"
        • refuseCapitalValue
          Tipo: boolean
          Obrigatório: Não
          Descrição: Recusar o preenchimento do capital
          -- Saiba Mais
          [+]
          Ex: false
        • refuseAdministratorData
          Tipo: boolean
          Obrigatório: Não
          Descrição: Recusar o preenchimento dos dados do administrador
          -- Saiba Mais
          [+]
          Ex: false
        • refuseControllerData
          Tipo: boolean
          Obrigatório: Não
          Descrição: Recusar o preenchimento dos dados do controlador
          -- Saiba Mais
          [+]
          Ex: false
        • declineBillingAmount
          Tipo: boolean
          Obrigatório: Não
          Descrição: Recusar o preenchimento do valor do faturamento
          -- Saiba Mais
          [+]
          Ex: false
      • customerAttorneys[]
        • cpf
          Tipo: String
          Obrigatório: Não
          Descrição: CPF do procurador
          -- Saiba Mais
          [+]
          Ex: "78820354080".
        • name
          Tipo: String
          Obrigatório: Não
          Descrição: Nome do procurador
          -- Saiba Mais
          [+]
          Ex: "José da Silva Santos"
      • customerAdministrators[]
        • cpf
          Tipo: String
          Obrigatório: Não
          Descrição: CPF do administrador
          -- Saiba Mais
          [+]
          Ex: "56820354080".
        • name
          Tipo: String
          Obrigatório: Não
          Descrição: Nome do administrador
          -- Saiba Mais
          [+]
          Ex: "José da Silva Santos"
      • customerControllers[]
        • cpfcnpj
          Tipo: String
          Obrigatório: Não
          Descrição: CPF do controlador
          -- Saiba Mais
          [+]
          Ex: "63520354080".
        • name
          Tipo: String
          Obrigatório: Não
          Descrição: Nome do controlador
          -- Saiba Mais
          [+]
          Ex: "José da Silva Santos"
  • businessItem
    • offerId
      Tipo: String
      Obrigatório: Sim
      Descrição: Código da oferta
      -- Saiba Mais
      [+]
      EX: "3d0a4660-79f3-432a-b299-c90dd2bb74ad"
    • insurance
      • installments
        • numberOfInstallments
          Tipo: Integer
          Obrigatório: Sim
          Descrição: Número de parcelas
          -- Saiba Mais
          [+]
          EX: 5
        • billingTypeId
          Tipo: Integer
          Obrigatório: Sim
          Descrição: Tipo de cobrança
          -- Saiba Mais
        • installmentDueDate
          Tipo: String (Date)
          Obrigatório: Sim
          Descrição: Data de cobrança
          -- Saiba Mais
          [+]
          EX: "2019-10-30"
        • installmentSecondDueDate
          Tipo: String (Date)
          Obrigatório: Não
          Descrição: Segunda data de cobrança
          -- Saiba Mais
          [+]
          EX: "2019-11-30"
        • isInstallmentDueDateFixed
          Tipo: Boolean
          Obrigatório: Não
          Descrição: Se a data de cobrança é fixa
          -- Saiba Mais
          [+]
          EX: true
        • bankData
          • bankCode
            Tipo: String
            Obrigatório: Não
            Descrição: Código do Banco
            -- Saiba Mais
            [+]
            EX: "004"
          • branchCode
            Tipo: String
            Obrigatório: Não
            Descrição: Código da agência
            -- Saiba Mais
            [+]
            EX: "0005"
          • branchDigit
            Tipo: String
            Obrigatório: Não
            Descrição: Digito da agência
            -- Saiba Mais
            [+]
            EX: "01"
          • checkingAccount
            Tipo: String
            Obrigatório: Não
            Descrição: Número da Conta
            -- Saiba Mais
            [+]
            EX: "08476"
          • checkingAccountDigit
            Tipo: String
            Obrigatório: Não
            Descrição: Dígito da Conta
            -- Saiba Mais
            [+]
            EX: "5"
          • documento[]
            • type
              • id
                Tipo: String
                Obrigatório: Não
                Descrição: Código tipo documento
                -- Saiba Mais
                [+]
                EX: "1"
            • number
              Tipo: String
              Obrigatório: Não
              Descrição: Número do documento
              -- Saiba Mais
              [+]
              EX: "23123123103"
            • mainName
              Tipo: String
              Obrigatório: Sim
              Descrição: Nome principal da conta
              -- Saiba Mais
              [+]
              EX: "José da Silva Santos"
      • broker[]
        • sucursalCode
          Tipo: String
          Obrigatório: Sim
          Descrição: Código da filial do corretor
          -- Saiba Mais
          [+]
          EX: "021"
        • susepCode
          Tipo: String
          Obrigatório: Sim
          Descrição: Código susep do corretor
          -- Saiba Mais
          [+]
          EX: "00000400004995"
        • isMain
          Tipo: Boolean
          Obrigatório: Sim
          Descrição: É corretor principal
          -- Saiba Mais
          [+]
          EX: true
        • percentageParticipation
          Tipo: Integer
          Obrigatório: Sim
          Descrição: Percentual de participação do corretor
          -- Saiba Mais
          [+]
          EX: 100
      • counterPart
        • Id
          Tipo: integer
          Obrigatório: Não
          Descrição: Código do Estipulante
          -- Saiba Mais
          [+]
          Ex: 006394824
        • branchId
          Tipo: integer
          Obrigatório: Não
          Descrição: Código da Unidade
          -- Saiba Mais
          [+]
          Ex: 01
        • agreementId
          Tipo: integer
          Obrigatório: Não
          Descrição: Código de Acordo
          -- Saiba Mais
          [+]
          Ex: 08
      • autos[]
        • taxInvoiceNumber
          Tipo: String
          Obrigatório: Não
          Descrição: Número da nota fiscal
          -- Saiba Mais
          [+]
          EX: "00921"
        • newCarWithdrawalDate
          Tipo: String (Date)
          Obrigatório: Não
          Descrição: Data de venda do zero Km
          -- Saiba Mais
          [+]
          EX: "2019-10-30"
        • dealershipRevenueServiceDocument
          Tipo: String
          Obrigatório: Não
          Descrição: Cnpj da concessionária
          -- Saiba Mais
          [+]
          EX: "23123123123110"
        • provisionalCoverageNumber
          Tipo: String
          Obrigatório: Não
          Descrição: Número da cobertura provisória
          -- Saiba Mais
          [+]
          EX: "009921"
        • provisionalCoverageBrokerSusepCode
          Tipo: String
          Obrigatório: Não
          Descrição: Código susep da cobertura provisória
          -- Saiba Mais
          [+]
          EX: "100004995"
        • isTaxInvoiceOnInspection
          Tipo: Boolean
          Obrigatório: Não
          Descrição: Cliente ciente da entrega da nota em caso de sinistro
          -- Saiba Mais
          [+]
          EX: true
        • isTaxInvoiceOnInspection
          Tipo: Boolean
          Obrigatório: Não
          Descrição: Cliente ciente da entrega da nota em caso de sinistro
          -- Saiba Mais
          [+]
          EX: true
        • surveyNumber
          Tipo: String
          Obrigatório: Não
          Descrição: Número da vistoria
          -- Saiba Mais
          [+]
          EX: "123543"
        • beneficiary
          • name
            Tipo: String
            Obrigatório: Não
            Descrição: Nome do beneficiário
            -- Saiba Mais
            [+]
            EX: "Teste"
          • document[]
            • type
              • id
                Tipo: String
                Obrigatório: Não
                Descrição: Tipo do documento
                -- Saiba Mais
                [+]
                EX: "1"
            • number
              Tipo: String
              Obrigatório: Não
              Descrição: Número do Documento
              -- Saiba Mais
              [+]
              EX: "54321"
        • vehicle
          • chassisCode
            Tipo: String
            Obrigatório: Sim
            Descrição: Chassi
            -- Saiba Mais
            [+]
            EX: "KMHJN81BBAU179136"
          • licensePlateCode
            Tipo: String
            Obrigatório: Sim
            Descrição: Placa do veículo
            -- Saiba Mais
            [+]
            EX: "FJU3538"
          • stateLicensePlateCode
            Tipo: String
            Obrigatório: Sim
            Descrição: Estado da placa do veículo
            -- Saiba Mais
            [+]
            EX: "SP"
          • nationalVehicleRegistrationNumber
            Tipo: String
            Obrigatório: Sim
            Descrição: Renavam do veículo
            -- Saiba Mais
            [+]
            EX: "18118807580"
        • insuranceRelationship
          • claimQuantity
            Tipo: Integer
            Obrigatório: Não
            Descrição: Quantidade de sinistros
            -- Saiba Mais
            [+]
            EX: 0
          • bonusClassNumber
            Tipo: String
            Obrigatório: Não
            Descrição: Classe de Bonus
            -- Saiba Mais
            [+]
            EX: "2"
          • previousPolicy
            • counterpartCode
              Tipo: String
              Obrigatório: Não
              Descrição: Código Congenere
              -- Saiba Mais
              [+]
              EX: "5177"
            • identificationCode
              Tipo: String
              Obrigatório: Não
              Descrição: Código de identificação
              -- Saiba Mais
              [+]
              EX: "51712345678900"
            • code
              Tipo: String
              Obrigatório: Não
              Descrição: Número da apólice anterior
              -- Saiba Mais
              [+]
              EX: "01021431411327"
            • endDate
              Tipo: String (Date)
              Obrigatório: Não
              Descrição: Data de final de vigência anterior
              -- Saiba Mais
              [+]
              EX: "2019-10-26"
Atributos do Response Body
  • links
    • type
      Tipo: String
      Obrigatório: Sim
      Descrição: Tipo do Link retornado
      -- Saiba Mais
      [+]
      Ex: VISTORIA
    • dataURL
      Tipo: String
      Obrigatório: Sim
      Descrição: Link de acesso a um agendamento de serviço atrelado ao seguro
      -- Saiba Mais
      [+]
      Ex: https://net.hdi.com.br/digital2/agendamento/acesso/processar?t=eyJhbGc...
Dúvidas Gerais
Informações de ambientes
Histórico de versões

Autor

Área ou Setor

Versão

Descrição da versão

OpenInsurance

Integração

V1.0

Versão Inicial

Language
Response
Click Try It! to start a request and see the response here!