LISTA DETALHES DO SINISTRO

Objetivo

Esta API tem o objetivo de retornar as informações detalhadas sobre o sinistro, Timeline e Vistoria

Contrato de Serviço - Swagger

Collection Test Postman

Dados Básicos


Nome do Serviço	netx/claim/detail/ Detalhes do sinistro
Descrição Resumida	Consulta os detalhes do sinistro pesquisado
URL	Base Path: openapi.hdi.com.br/insurance/claim/v1 URI: netx/claim/detail
Status	Ativo
Versão	1.0

Exemplo de Payload

key=ABCSSyCS3yeMs9pYI7BPIy4Cg_d1wcKoW1AIe5Q
claimId=54484484

Content-Type=application/json
X-Company-Id=01
X-Application-Id=01
X-User-Id=7777777777
X-Trace-Id="Trace"
X-Susep-Code=4854848
X-Sucursal-Code=015

{
  "prospectDocumentNumber": "string",
  "prospectName": "string",
  "paymentType": 1,
  "bankAccount": {
    "dueDate": "string",
    "number": "string",
    "digit": "string",
    "bank": "string",
    "branch": "string"
  }
}

Parâmetros e Detalhes do Request

REQUEST

Header
- Content-Type
  
  Tipo: String
  Obrigatório: Sim
  Descrição: Tipo do conteúdo a ser trafegado no protocolo http
  
  -- Saiba Mais
  
  [+]
  
  Este conteúdo deve ser: Application/Json
- X-Company-id
  
  Tipo: String
  Obrigatório: Sim
  Descrição: Código da empresa
  
  -- Saiba Mais
  
  [+]
  
  Deverá ser informado um número para a empresa, que posteriormente servirá para rastreio do consumo da API
- x-Application-id
  
  Tipo: String
  Obrigatório: Sim
  Descrição: Código da aplicação
  
  -- Saiba Mais
  
  [+]
  
  Código recebido pela HDI para identificação da aplicação que está consumindo a API, se a API for utilizada por mais do que uma aplicação, informar a HDI para gerar um outro código, desta forma garantimos a unicidade das transações e conseguimos ter clareza nas produtividades de cada aplicação
- 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
- X-Trace-Id
  
  Tipo: String
  Obrigatório: Sim
  Descrição: Código da trace
  
  -- Saiba Mais
  
  [+]
  
  Código da Trace
- documentNumber
  
  Tipo: String
  Obrigatório: Sim
  Descrição: CPF do cliente
  
  -- Saiba Mais
  
  [+]
  
  CPF do cliente a ser consultado
- plateCode
  
  Tipo: String
  Obrigatório: Sim
  Descrição: Placa do carro
  
  -- Saiba Mais
  
  [+]
  
  Placa do carro do cliente da consulta
- Authorization
  
  Tipo: String
  Obrigatório: Sim
  Descrição: Token de Autorização
  
  -- Saiba Mais
  
  [+]
  
  Deverá ser informado o code da API de Token, que deverá ser renovado após 1 hora
Param
- 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 funcionalidades da HDI Seguros, ou seja, em todos as chamadas independente da API deverá ser trafegada esta chave nos Params.
  Para obter acesso a chave é necessário passar por um processo de autorização junto a área de parcerias da HDI Seguros. O canal para solicitar acesso é através do e-mail: [email protected]

Parâmetros e Detalhes do Response

RESPONSE

Body
- prospectDocumentNumber
  
  Tipo: String
  Obrigatório: Sim
  Descrição: Número do CPF
  
  -- Saiba Mais
  
  [+]
  
  Número do CPF do titular do pagamento
- prospectName
  
  Tipo: String
  Obrigatório: Sim
  Descrição: Nome
  
  -- Saiba Mais
  
  [+]
  
  Nome do titular do pagamento
- paymentType
  
  Tipo: Integer
  Obrigatório: Sim
  Descrição: Tipo do pagamento
  
  -- Saiba Mais
  
  [+]
  
  1 - Debito em conta. 2 - Cartão de credito. 3 - Boleto
- bankAccount
  - dueDate
    
    Tipo: String
    Obrigatório: Sim
    Descrição: Data de vencimento
    
    -- Saiba Mais
    
    [+]
    
    Data de vencimento escolhida pelo cliente
  - number
    
    Tipo: String
    Obrigatório: Sim
    Descrição: Número da conta
    
    -- Saiba Mais
    
    [+]
    
    Número da conta do titular do pagamento
  - digit
    
    Tipo: String
    Obrigatório: Não
    Descrição: Dígito da conta
    
    -- Saiba Mais
    
    [+]
    
    Dígito da conta do titular do pagamento
  - bank
    
    Tipo: String
    Obrigatório: Sim
    Descrição: Número do banco
    
    -- Saiba Mais
    
    [+]
    
    Número do banco do titular do pagamento
  - branch
    
    Tipo: String
    Obrigatório: Sim
    Descrição: Número da agência
    
    -- Saiba Mais
    
    [+]
    
    Número da agência do titular do pagamento

Informações de ambientes


Homologação	## https://openapi-int.hdi.com.br/insurance/policy/v1/client/bankdata/read
Produção	## https://openapi.hdi.com.br/insurance/policy/v1/client/bankdata/read

Histórico de versões

Autor	Área ou Setor	Versão	Descrição da versão
OpenInsurance	Integração	V1.0	Versão Inicial