NAV
javascript python java

Introdução

O Open Insurance, ou Sistema de Seguros Aberto, é a possibilidade de consumidores de produtos e serviços de seguros, previdência complementar aberta e capitalização permitirem o compartilhamento de suas informações entre diferentes sociedades autorizadas/credenciadas pela Susep, de forma segura, ágil, precisa e conveniente.

Para entregar esses benefícios ao consumidor, o Open Insurance operacionaliza e padroniza o compartilhamento de dados e serviços por meio de abertura e integração de sistemas, com privacidade e segurança.

Manuais para participantes

Passo a passo para cadastro de Endpoint’s - dados públicos Fase 1
Passo a passo de cadastro no diretório
Passo a passo Cadastro Contatos Técnicos Diretório
Passo a passo testes de confomidade APIs

Glossário

Segurança

APIs comuns v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

As APIs descritas neste documento são referentes as APIs da fase Open Data do Open Insurance Brasil.

Base URLs:

Web: Support

API de status

A descrição referente ao código de status retornado pelas APIs

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.organizacao.com.br/open-insurance/discovery/v1/status");
xhr.setRequestHeader("Accept", "application/json");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.organizacao.com.br")

headers = { 'Accept': "application/json" }

conn.request("GET", "/open-insurance/discovery/v1/status", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("https://api.organizacao.com.br/open-insurance/discovery/v1/status")
  .header("Accept", "application/json")
  .asString();

GET /status

Descrição referente ao código de status retornado pelas APIs

Parameters

Name In Type Required Description
page query integer false Número da página que está sendo requisitada, sendo a primeira página 1.
page-size query integer false Quantidade total de registros por páginas.

Example responses

200 Response

{
  "data": {
    "status": [
      {
        "code": "OK",
        "explanation": "Retorno com Sucesso",
        "detectionTime": "2021-07-21T08:30:00Z",
        "expectedResolutionTime": "2021-07-21T08:30:00Z",
        "updateTime": "2021-01-02T01:00:00Z",
        "unavailableEndpoints": [
          "https://api.seguradora.com.br/open-insurance/channels/v1/electronic-channels"
        ]
      }
    ]
  },
  "links": {
    "self": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
    "first": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
    "prev": "string",
    "next": "string",
    "last": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>"
  },
  "meta": {
    "totalRecords": 9,
    "totalPages": 3
  }
}

Responses

Status Meaning Description Schema
200 OK Código de status retornado pelas APIs ResponseDiscoveryStatusList

API de outages

a descrição referente a listagem de indisponibilidades agendadas para os serviços

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.organizacao.com.br/open-insurance/discovery/v1/outages");
xhr.setRequestHeader("Accept", "application/json");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.organizacao.com.br")

headers = { 'Accept': "application/json" }

conn.request("GET", "/open-insurance/discovery/v1/outages", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("https://api.organizacao.com.br/open-insurance/discovery/v1/outages")
  .header("Accept", "application/json")
  .asString();

GET /outages

a descrição referente a listagem de indisponibilidades agendadas para os serviços

Parameters

Name In Type Required Description
page query integer false Número da página que está sendo requisitada, sendo a primeira página 1.
page-size query integer false Quantidade total de registros por páginas.

Example responses

200 Response

{
  "data": [
    {
      "outageTime": "2020-07-21T08:30:00Z",
      "duration": "PT2H30M",
      "isPartial": false,
      "explanation": "Atualização do API Gateway",
      "unavailableEndpoints": [
        "https://api.seguradora.com.br/open-insurance/channels/v1/electronic-channels"
      ]
    }
  ],
  "links": {
    "self": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
    "first": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
    "prev": "string",
    "next": "string",
    "last": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>"
  },
  "meta": {
    "totalRecords": 9,
    "totalPages": 3
  }
}

Responses

Status Meaning Description Schema
200 OK listagem de indisponibilidades agendadas para os serviços ResponseDiscoveryOutageList

Schemas

ResponseDiscoveryStatusList

{
  "data": {
    "status": [
      {
        "code": "OK",
        "explanation": "Retorno com Sucesso",
        "detectionTime": "2021-07-21T08:30:00Z",
        "expectedResolutionTime": "2021-07-21T08:30:00Z",
        "updateTime": "2021-01-02T01:00:00Z",
        "unavailableEndpoints": [
          "https://api.seguradora.com.br/open-insurance/channels/v1/electronic-channels"
        ]
      }
    ]
  },
  "links": {
    "self": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
    "first": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
    "prev": "string",
    "next": "string",
    "last": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>"
  },
  "meta": {
    "totalRecords": 9,
    "totalPages": 3
  }
}

Properties

Name Type Required Restrictions Description
data object true none none
» status [Status] true none none
links Links true none none
meta Meta true none none

ResponseDiscoveryOutageList

{
  "data": [
    {
      "outageTime": "2020-07-21T08:30:00Z",
      "duration": "PT2H30M",
      "isPartial": false,
      "explanation": "Atualização do API Gateway",
      "unavailableEndpoints": [
        "https://api.seguradora.com.br/open-insurance/channels/v1/electronic-channels"
      ]
    }
  ],
  "links": {
    "self": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
    "first": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
    "prev": "string",
    "next": "string",
    "last": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>"
  },
  "meta": {
    "totalRecords": 9,
    "totalPages": 3
  }
}

Properties

Name Type Required Restrictions Description
data [any] true none none
» outageTime string true none Data e hora planejada do início da indisponibilidade
» duration string true none Duração prevista da indisponibilidade
» isPartial boolean true none Flag que indica se a indisponibilidade é parcial (atingindo apenas alguns end points) ou total (atingindo todos os end points)
» explanation string true none Explicação sobre os motivos da indisponibilidade.
» unavailableEndpoints [string] true none Endpoints com indisponibilidade.
links Links true none none
meta Meta true none none

{
  "self": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
  "first": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>",
  "prev": "string",
  "next": "string",
  "last": "https://api.seguradora.com.br/open-insurance/channels/v1/<resource>"
}

Properties

Name Type Required Restrictions Description
self string false none URL da página atualmente requisitada
first string false none URL da primeira página de registros
prev string false none URL da página anterior de registros
next string false none URL da próxima página de registros
last string false none URL da última página de registros

Meta

{
  "totalRecords": 9,
  "totalPages": 3
}

Properties

Name Type Required Restrictions Description
totalRecords integer true none Total de registros encontrados
totalPages integer true none Total de páginas para os registros encontrados

Status

{
  "code": "OK",
  "explanation": "Retorno com Sucesso",
  "detectionTime": "2021-07-21T08:30:00Z",
  "expectedResolutionTime": "2021-07-21T08:30:00Z",
  "updateTime": "2021-01-02T01:00:00Z",
  "unavailableEndpoints": [
    "https://api.seguradora.com.br/open-insurance/channels/v1/electronic-channels"
  ]
}

Properties

Name Type Required Restrictions Description
code string true none Condição atual da API:
* OK - A implementação é totalmente funcional
* PARTIAL_FAILURE - Um ou mais endpoints estão indisponíveis
* UNAVAILABLE - A implementação completa está indisponível
* SCHEDULED_OUTAGE - Uma interrupção anunciada está em vigor
explanation string true none Fornece uma explicação da interrupção atual que pode ser exibida para um cliente final. Será obrigatoriamente preenchido se code tiver algum valor que não seja OK
detectionTime string false none A data e hora em que a interrupção atual foi detectada. Será obrigatoriamente preenchido se a propriedade code for PARTIAL_FAILURE ou UNAVAILABLE
expectedResolutionTime string false none A data e hora em que o serviço completo deve continuar (se conhecido). Será obrigatoriamente preenchido se code tiver algum valor que não seja OK
updateTime string false none A data e hora em que esse status foi atualizado pela última vez pelo titular dos dados.
unavailableEndpoints [string] false none Endpoints com indisponibilidade

Enumerated Values

Property Value
code OK
code PARTIAL_FAILURE
code UNAVAILABLE
code SCHEDULED_OUTAGE

APIs Open Data do Open Insurance Brasil v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

As API's administrativas são recursos que podem ser consumidos apenas pelo diretório para avaliação e controle da qualidade dos serviços fornecidos pelas instituições

Base URLs:

Web: Support

Metrics

Obtém as métricas de disponibilidade das APIs

Especificação em OAS

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://api.organizacao.com.br/open-insurance/admin/v1/metrics");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("cache-control", "string");
xhr.setRequestHeader("Content-Security-Policy", "string");
xhr.setRequestHeader("content-Type", "string");
xhr.setRequestHeader("Strict-Transport-Security", "string");
xhr.setRequestHeader("X-Content-Type-Options", "string");
xhr.setRequestHeader("X-Frame-Options", "string");

xhr.send(data);
import http.client

conn = http.client.HTTPConnection("api.organizacao.com.br")

headers = {
    'Accept': "application/json",
    'cache-control': "string",
    'Content-Security-Policy': "string",
    'content-Type': "string",
    'Strict-Transport-Security': "string",
    'X-Content-Type-Options': "string",
    'X-Frame-Options': "string"
    }

conn.request("GET", "/open-insurance/admin/v1/metrics", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("http://api.organizacao.com.br/open-insurance/admin/v1/metrics")
  .header("Accept", "application/json")
  .header("cache-control", "string")
  .header("Content-Security-Policy", "string")
  .header("content-Type", "string")
  .header("Strict-Transport-Security", "string")
  .header("X-Content-Type-Options", "string")
  .header("X-Frame-Options", "string")
  .asString();

GET /metrics

Obtém as métricas de disponibilidade das APIs

Parameters

Name In Type Required Description
cache-control header string true Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy header string false Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type header string false Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security header string false Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options header string false Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options header string false Campo indica se o navegador deve ou não renderizar um frame.
page query integer false Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size query integer false Quantidade total de registros por páginas.
period query string false Período a ser consultado

Detailed descriptions

period: Período a ser consultado * CURRENT - Métricas do dia atual. * ALL - Métricas de todo o período disponível.

Enumerated Values

Parameter Value
period CURRENT
period ALL

Example responses

200 Response

{
  "data": {
    "requestTime": "2019-08-24T14:15:22Z",
    "availability": {
      "uptime": {
        "generalUptimeRate": "string",
        "endpoints": [
          {
            "url": "string",
            "uptimeRate": "string"
          }
        ]
      },
      "downtime": {
        "generalDowntime": 0,
        "scheduledOutage": 0,
        "endpoints": [
          {
            "url": "string",
            "partialDowntime": 0
          }
        ]
      }
    },
    "invocations": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "mediumPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "averageResponse": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "mediumPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "averageTps": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "peakTps": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "errors": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "rejections": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>",
    "first": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>",
    "prev": "string",
    "next": "string",
    "last": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

Responses

Status Meaning Description Schema
200 OK Dados das métricas ResponseMetricsList

Schemas

ResponseMetricsList

{
  "data": {
    "requestTime": "2019-08-24T14:15:22Z",
    "availability": {
      "uptime": {
        "generalUptimeRate": "string",
        "endpoints": [
          {
            "url": "string",
            "uptimeRate": "string"
          }
        ]
      },
      "downtime": {
        "generalDowntime": 0,
        "scheduledOutage": 0,
        "endpoints": [
          {
            "url": "string",
            "partialDowntime": 0
          }
        ]
      }
    },
    "invocations": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "mediumPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "averageResponse": {
      "unauthenticated": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "highPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "mediumPriority": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      },
      "unattended": {
        "currentDay": 0,
        "previousDays": [
          0
        ]
      }
    },
    "averageTps": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "peakTps": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "errors": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    },
    "rejections": {
      "currentDay": 0,
      "previousDays": [
        0
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>",
    "first": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>",
    "prev": "string",
    "next": "string",
    "last": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

Properties

Name Type Required Restrictions Description
data object true none none
» requestTime string(date-time) true none Data e hora que as métricas foram requisitadas.
» availability AvailabilityMetrics true none none
» invocations InvocationMetrics true none none
» averageResponse AverageMetrics true none none
» averageTps AverageTPSMetrics true none none
» peakTps PeakTPSMetrics true none none
» errors ErrorMetrics true none none
» rejections RejectionMetrics true none none
links Links true none none
meta Meta false none none

AvailabilityMetrics

{
  "uptime": {
    "generalUptimeRate": "string",
    "endpoints": [
      {
        "url": "string",
        "uptimeRate": "string"
      }
    ]
  },
  "downtime": {
    "generalDowntime": 0,
    "scheduledOutage": 0,
    "endpoints": [
      {
        "url": "string",
        "partialDowntime": 0
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
uptime object true none none
» generalUptimeRate string true none Taxa de disponibilidade (considerando todos os serviços ativos ao mesmo tempo).
» endpoints EndpointUptime true none none
downtime object true none none
» generalDowntime integer true none Quantidade de segundos de downtime (considerando qualquer api em downtime).
» scheduledOutage integer true none Quantidade de segundos de indisponibilidade agendada.
» endpoints EndpointDowntime true none none

EndpointUptime

[
  {
    "url": "string",
    "uptimeRate": "string"
  }
]

Properties

Name Type Required Restrictions Description
url string true none URL do endpoint
uptimeRate string true none Taxa de disponibilidade do endpoint.

EndpointDowntime

[
  {
    "url": "string",
    "partialDowntime": 0
  }
]

Properties

Name Type Required Restrictions Description
url string true none URL do endpoint
partialDowntime integer true none Quantidade de segundos de indisponibilidade do endpoint.

InvocationMetrics

{
  "unauthenticated": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "highPriority": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "mediumPriority": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "unattended": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  }
}

Properties

Name Type Required Restrictions Description
unauthenticated object true none Número de chamadas não autenticadas.
» currentDay integer true none Número de chamadas não autenticadas no dia atual.
» previousDays [integer] true none Número de chamadas não autenticadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
highPriority object true none Número de chamadas para o nível de alta prioridade.
» currentDay integer true none Número de chamadas no dia atual para o nível de alta prioridade.
» previousDays [integer] true none Número de chamadas nos dias anteriores para o nível de alta prioridade. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
mediumPriority object true none Número de chamadas para o nível de média prioridade.
» currentDay integer true none Número de chamadas no dia atual para o nível de média prioridade.
» previousDays [integer] true none Número de chamadas nos dias anteriores para o nível de média prioridade. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
unattended object true none Número de chamadas para o nível não acompanhado.
» currentDay integer true none Número de chamadas no dia atual para o nível não acompanhado.
» previousDays [integer] true none Número de chamadas nos dias anteriores para o nível não acompanhado. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

AverageMetrics

{
  "unauthenticated": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "highPriority": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "mediumPriority": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  },
  "unattended": {
    "currentDay": 0,
    "previousDays": [
      0
    ]
  }
}

Properties

Name Type Required Restrictions Description
unauthenticated object true none Tempo médio de resposta para chamadas não autenticadas.
» currentDay integer true none Tempo médio de resposta em milissegundos para chamadas no dia atual.
» previousDays [integer] true none Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
highPriority object true none Tempo médio de resposta de chamadas para o nível de alta prioridade.
» currentDay integer true none Tempo médio de resposta em milissegundos para chamadas no dia atual.
» previousDays [integer] true none Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
mediumPriority object true none Tempo médio de resposta para chamadas para o nível de média prioridade.
» currentDay integer true none Tempo médio de resposta em milissegundos para chamadas no dia atual.
» previousDays [integer] true none Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
unattended object true none Tempo médio de resposta para chamadas para o nível não acompanhado.
» currentDay integer true none Tempo médio de resposta em milissegundos para chamadas no dia atual.
» previousDays [integer] true none Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

AverageTPSMetrics

{
  "currentDay": 0,
  "previousDays": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
currentDay integer true none Número médio de chamadas por segundo no dia.
previousDays [integer] true none Número médio de chamadas por segundo nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

PeakTPSMetrics

{
  "currentDay": 0,
  "previousDays": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
currentDay integer true none Pico de chamadas por segundo no dia.
previousDays [integer] true none Pico de chamadas por segundo nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

ErrorMetrics

{
  "currentDay": 0,
  "previousDays": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
currentDay integer true none Número de chamadas com erro no dia atual.
previousDays [integer] true none Número de chamadas com erro nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

RejectionMetrics

{
  "currentDay": 0,
  "previousDays": [
    0
  ]
}

Properties

Name Type Required Restrictions Description
currentDay integer true none Número de chamadas rejeitadas no dia atual.
previousDays [integer] true none Número de chamadas rejeitadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.

{
  "self": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>",
  "first": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>",
  "prev": "string",
  "next": "string",
  "last": "https://api.organizacao.com.br/open-insurance/admin/v1/<resource>"
}

Properties

Name Type Required Restrictions Description
self string false none URL da página atualmente requisitada
first string false none URL da primeira página de registros
prev string false none URL da página anterior de registros
next string false none URL da próxima página de registros
last string false none URL da última página de registros

Meta

{
  "totalRecords": 1,
  "totalPages": 1
}

Properties

Name Type Required Restrictions Description
totalRecords integer true none Total de registros encontrados
totalPages integer true none Total de páginas para os registros encontrados

API - Canais de Atendimento v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

As APIs descritas neste documento são referentes as APIs da fase Open Data do Open Insurance Brasil.

Base URLs:

Web: Support

Especificação em OAS

Dependências próprias

Obtém a listagem de dependências próprias da instituição.

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.organizacao.com.br/open-insurance/channels/v1/branches");
xhr.setRequestHeader("Accept", "application/json");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.organizacao.com.br")

headers = { 'Accept': "application/json" }

conn.request("GET", "/open-insurance/channels/v1/branches", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("https://api.organizacao.com.br/open-insurance/channels/v1/branches")
  .header("Accept", "application/json")
  .asString();

GET /branches

Método para obter a listagem de dependências próprias da instituição.

Parameters

Name In Type Required Description
page query integer false Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size query integer false Quantidade total de registros por páginas.

Example responses

200 Response

{
  "data": {
    "brand": {
      "name": "Organização AZ",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "branches": [
            {
              "identification": {
                "type": "POSTO_ATENDIMENTO",
                "code": "0001",
                "checkDigit": "9",
                "name": "Marília"
              },
              "postalAddress": {
                "address": "Av Naburo Ykesaki 1270, bloco 35, fundos",
                "additionalInfo": "Loja B",
                "districtName": "Centro",
                "townName": "São Paulo",
                "ibgeCode": "3550308",
                "countrySubDivision": "SP",
                "postCode": "17500001",
                "country": "Brasil",
                "countryCode": "BRA",
                "geographicCoordinates": {
                  "latitude": "-90.8365180",
                  "longitude": "-180.836519"
                }
              },
              "availability": {
                "standards": [
                  {
                    "weekday": "SEGUNDA_FEIRA",
                    "openingTime": "10:00:57Z",
                    "closingTime": "16:00:57Z"
                  }
                ],
                "exception": "string",
                "isPublicAccessAllowed": true
              },
              "phones": [
                {
                  "type": "FIXO",
                  "countryCallingCode": "55",
                  "areaCode": "19",
                  "number": "35721199"
                }
              ],
              "services": [
                {
                  "name": "ENDOSSO",
                  "code": "01"
                }
              ]
            }
          ]
        }
      ]
    },
    "links": {
      "self": "https://api.organizacao.com.br/open-insurance/channels/v1/<resource>",
      "first": "https://api.organizacao.com.br/open-insurance/channels/v1/<resource>",
      "prev": "string",
      "next": "string",
      "last": "https://api.organizacao.com.br/open-insurance/channels/v1/<resource>"
    },
    "meta": {
      "totalRecords": 1,
      "totalPages": 1
    }
  }
}

Responses

Status Meaning Description Schema
200 OK Lista de dependências próprias obtida com sucesso. ResponseBranchesList
400 Bad Request A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. ResponseError
401 Unauthorized Cabeçalho de autenticação ausente/inválido ou token inválido ResponseError
403 Forbidden O token tem escopo incorreto ou uma política de segurança foi violada ResponseError
404 Not Found O recurso solicitado não existe ou não foi implementado ResponseError
405 Method Not Allowed O consumidor tentou acessar o recurso com um método não suportado ResponseError
406 Not Acceptable A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8 ResponseError
429 Too Many Requests A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido ResponseError
500 Internal Server Error Ocorreu um erro no gateway da API ou no microsserviço ResponseError
default Default Lista de dependências próprias obtida com sucesso. ResponseBranchesList

Canais de atendimento eletrônico

Obtém a listagem de canais eletrônicos de atendimento da instituição.

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.organizacao.com.br/open-insurance/channels/v1/electronic-channels");
xhr.setRequestHeader("Accept", "application/json");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.organizacao.com.br")

headers = { 'Accept': "application/json" }

conn.request("GET", "/open-insurance/channels/v1/electronic-channels", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("https://api.organizacao.com.br/open-insurance/channels/v1/electronic-channels")
  .header("Accept", "application/json")
  .asString();

GET /electronic-channels

Método para obter a listagem de canais eletrônicos de atendimento da instituição.

Parameters

Name In Type Required Description
page query integer false Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size query integer false Quantidade total de registros por páginas.

Example responses

200 Response

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-insurance",
          "electronicChannels": [
            {
              "identification": {
                "type": "INTERNET",
                "urls": [
                  "https://empresa1.com/insurance"
                ]
              },
              "services": [
                {
                  "name": "SEGUROS",
                  "code": "SEGUROS"
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/channels/v1/electronic-channels",
    "first": "https://api.organizacao.com.br/open-insurance/channels/v1/electronic-channels",
    "prev": "null",
    "next": "null",
    "last": "https://api.organizacao.com.br/open-insurance/channels/v1/electronic-channels"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

Responses

Status Meaning Description Schema
200 OK Listagem de canais eletrônicos de atendimento obtida com sucesso. ResponseElectronicChannelsList
400 Bad Request A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. ResponseError
401 Unauthorized Cabeçalho de autenticação ausente/inválido ou token inválido ResponseError
403 Forbidden O token tem escopo incorreto ou uma política de segurança foi violada ResponseError
404 Not Found O recurso solicitado não existe ou não foi implementado ResponseError
405 Method Not Allowed O consumidor tentou acessar o recurso com um método não suportado ResponseError
406 Not Acceptable A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8 ResponseError
429 Too Many Requests A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido ResponseError
500 Internal Server Error Ocorreu um erro no gateway da API ou no microsserviço ResponseError
default Default Listagem de canais eletrônicos de atendimento obtida com sucesso. ResponseElectronicChannelsList

Canais de atendimento telefônico

Obtém a listagem de canais telefônicos de atendimento da instituição.

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.organizacao.com.br/open-insurance/channels/v1/phone-channels");
xhr.setRequestHeader("Accept", "application/json");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.organizacao.com.br")

headers = { 'Accept': "application/json" }

conn.request("GET", "/open-insurance/channels/v1/phone-channels", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("https://api.organizacao.com.br/open-insurance/channels/v1/phone-channels")
  .header("Accept", "application/json")
  .asString();

GET /phone-channels

Método para obter a listagem de canais telefônicos de atendimento da instituição.

Parameters

Name In Type Required Description
page query integer false Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size query integer false Quantidade total de registros por páginas.

Example responses

200 Response

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-insurance",
          "phoneChannels": [
            {
              "identification": {
                "type": "CENTRAL_TELEFONICA",
                "phones": [
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "35721199"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "997865532"
                  }
                ]
              },
              "services": [
                {
                  "name": "ALTERACOES_FORMA_PAGAMENTO",
                  "code": "01"
                },
                {
                  "name": "AVISO_SINISTRO",
                  "code": "02"
                },
                {
                  "name": "ENDOSSO",
                  "code": "05"
                }
              ]
            },
            {
              "identification": {
                "type": "SAC",
                "phones": [
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40044828",
                    "additionalInfo": "DDI '55'; DDD '11', 40044828, 'Para clientes no exterior'"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40044828",
                    "additionalInfo": "DDI '55'; DDD '11', 40044828, 'Para clientes no exterior'"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40044828",
                    "additionalInfo": "DDI '55'; DDD '11', 40044828, 'Para clientes no exterior'"
                  }
                ]
              },
              "services": [
                {
                  "name": "RECLAMACAO",
                  "code": "16"
                },
                {
                  "name": "PORTABILIDADE",
                  "code": "15"
                },
                {
                  "name": "ENDOSSO",
                  "code": "05"
                }
              ]
            },
            {
              "identification": {
                "type": "OUVIDORIA",
                "phones": [
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40045555"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40045555"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40045555"
                  }
                ]
              },
              "services": [
                {
                  "name": "RECLAMACAO",
                  "code": "16"
                },
                {
                  "name": "PORTABILIDADE",
                  "code": "15"
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/channels/v1/phone-channels",
    "first": "https://api.organizacao.com.br/open-insurance/channels/v1/phone-channels",
    "prev": "null",
    "next": "null",
    "last": "https://api.organizacao.com.br/open-insurance/channels/v1/phone-channels"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

Responses

Status Meaning Description Schema
200 OK Listagem de canais telefônicos de atendimento obtida com sucesso. ResponsePhoneChannelsList
400 Bad Request A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. ResponseError
401 Unauthorized Cabeçalho de autenticação ausente/inválido ou token inválido ResponseError
403 Forbidden O token tem escopo incorreto ou uma política de segurança foi violada ResponseError
404 Not Found O recurso solicitado não existe ou não foi implementado ResponseError
405 Method Not Allowed O consumidor tentou acessar o recurso com um método não suportado ResponseError
406 Not Acceptable A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8 ResponseError
429 Too Many Requests A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido ResponseError
500 Internal Server Error Ocorreu um erro no gateway da API ou no microsserviço ResponseError
default Default Listagem de canais telefônicos de atendimento obtida com sucesso. ResponsePhoneChannelsList

Schemas

ResponseBranchesList

{
  "data": {
    "brand": {
      "name": "Organização AZ",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "branches": [
            {
              "identification": {
                "type": "POSTO_ATENDIMENTO",
                "code": "0001",
                "checkDigit": "9",
                "name": "Marília"
              },
              "postalAddress": {
                "address": "Av Naburo Ykesaki 1270, bloco 35, fundos",
                "additionalInfo": "Loja B",
                "districtName": "Centro",
                "townName": "São Paulo",
                "ibgeCode": "3550308",
                "countrySubDivision": "SP",
                "postCode": "17500001",
                "country": "Brasil",
                "countryCode": "BRA",
                "geographicCoordinates": {
                  "latitude": "-90.8365180",
                  "longitude": "-180.836519"
                }
              },
              "availability": {
                "standards": [
                  {
                    "weekday": "SEGUNDA_FEIRA",
                    "openingTime": "10:00:57Z",
                    "closingTime": "16:00:57Z"
                  }
                ],
                "exception": "string",
                "isPublicAccessAllowed": true
              },
              "phones": [
                {
                  "type": "FIXO",
                  "countryCallingCode": "55",
                  "areaCode": "19",
                  "number": "35721199"
                }
              ],
              "services": [
                {
                  "name": "ENDOSSO",
                  "code": "01"
                }
              ]
            }
          ]
        }
      ]
    },
    "links": {
      "self": "https://api.organizacao.com.br/open-insurance/channels/v1/<resource>",
      "first": "https://api.organizacao.com.br/open-insurance/channels/v1/<resource>",
      "prev": "string",
      "next": "string",
      "last": "https://api.organizacao.com.br/open-insurance/channels/v1/<resource>"
    },
    "meta": {
      "totalRecords": 1,
      "totalPages": 1
    }
  }
}

Properties

Name Type Required Restrictions Description
data object true none none
» brand BranchesBrand true none none
» links LinksPaginated false none none
» meta MetaPaginated false none none

BranchesBrand

{
  "name": "Organização AZ",
  "companies": [
    {
      "name": "Empresa A1",
      "cnpjNumber": "45086338000178",
      "branches": [
        {
          "identification": {
            "type": "POSTO_ATENDIMENTO",
            "code": "0001",
            "checkDigit": "9",
            "name": "Marília"
          },
          "postalAddress": {
            "address": "Av Naburo Ykesaki 1270, bloco 35, fundos",
            "additionalInfo": "Loja B",
            "districtName": "Centro",
            "townName": "São Paulo",
            "ibgeCode": "3550308",
            "countrySubDivision": "SP",
            "postCode": "17500001",
            "country": "Brasil",
            "countryCode": "BRA",
            "geographicCoordinates": {
              "latitude": "-90.8365180",
              "longitude": "-180.836519"
            }
          },
          "availability": {
            "standards": [
              {
                "weekday": "SEGUNDA_FEIRA",
                "openingTime": "10:00:57Z",
                "closingTime": "16:00:57Z"
              }
            ],
            "exception": "string",
            "isPublicAccessAllowed": true
          },
          "phones": [
            {
              "type": "FIXO",
              "countryCallingCode": "55",
              "areaCode": "19",
              "number": "35721199"
            }
          ],
          "services": [
            {
              "name": "ENDOSSO",
              "code": "01"
            }
          ]
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string true none Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
companies [BranchesCompany] true none Companies traz uma lista de todas as instuituições da Marca.

BranchesCompany

{
  "name": "Empresa A1",
  "cnpjNumber": "45086338000178",
  "branches": [
    {
      "identification": {
        "type": "POSTO_ATENDIMENTO",
        "code": "0001",
        "checkDigit": "9",
        "name": "Marília"
      },
      "postalAddress": {
        "address": "Av Naburo Ykesaki 1270, bloco 35, fundos",
        "additionalInfo": "Loja B",
        "districtName": "Centro",
        "townName": "São Paulo",
        "ibgeCode": "3550308",
        "countrySubDivision": "SP",
        "postCode": "17500001",
        "country": "Brasil",
        "countryCode": "BRA",
        "geographicCoordinates": {
          "latitude": "-90.8365180",
          "longitude": "-180.836519"
        }
      },
      "availability": {
        "standards": [
          {
            "weekday": "SEGUNDA_FEIRA",
            "openingTime": "10:00:57Z",
            "closingTime": "16:00:57Z"
          }
        ],
        "exception": "string",
        "isPublicAccessAllowed": true
      },
      "phones": [
        {
          "type": "FIXO",
          "countryCallingCode": "55",
          "areaCode": "19",
          "number": "35721199"
        }
      ],
      "services": [
        {
          "name": "ENDOSSO",
          "code": "01"
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string true none none
cnpjNumber string true none Número completo do CNPJ da instituição responsável pela dependência - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica.
Deve-se ter apenas os números do CNPJ, sem máscara
branches [Branch] false none Lista de Dependências de uma Instituição

ResponseElectronicChannelsList

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-insurance",
          "electronicChannels": [
            {
              "identification": {
                "type": "INTERNET",
                "urls": [
                  "https://empresa1.com/insurance"
                ]
              },
              "services": [
                {
                  "name": "SEGUROS",
                  "code": "SEGUROS"
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/channels/v1/electronic-channels",
    "first": "https://api.organizacao.com.br/open-insurance/channels/v1/electronic-channels",
    "prev": "null",
    "next": "null",
    "last": "https://api.organizacao.com.br/open-insurance/channels/v1/electronic-channels"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

Properties

Name Type Required Restrictions Description
brand ElectronicChannelsBrand false none none
links LinksPaginated true none none
meta MetaPaginated true none none

ElectronicChannelsBrand

{
  "name": "Marca A",
  "companies": [
    {
      "name": "Empresa da Marca A",
      "cnpjNumber": "stringstringst",
      "electronicChannels": [
        {
          "identification": {
            "type": "CHAT",
            "accessType": "EMAIL",
            "urls": [
              "string"
            ]
          },
          "services": [
            {
              "name": "ALTERACACOES_FORMA_PAGAMENTO",
              "code": "01",
              "additionalInfo": "SIC"
            }
          ],
          "availability": {
            "standards": [
              {
                "weekday": "SEGUNDA_FEIRA",
                "openingTime": "10:00:57Z",
                "closingTime": "16:00:57Z"
              }
            ]
          }
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string true none Nome da marca selecionada pela Organização proprietária da dependência (titular).
companies [ElectronicChannelsCompanies] true none Lista de instituições pertencentes à marca

ElectronicChannelsCompanies

{
  "name": "Empresa da Marca A",
  "cnpjNumber": "stringstringst",
  "electronicChannels": [
    {
      "identification": {
        "type": "CHAT",
        "accessType": "EMAIL",
        "urls": [
          "string"
        ]
      },
      "services": [
        {
          "name": "ALTERACACOES_FORMA_PAGAMENTO",
          "code": "01",
          "additionalInfo": "SIC"
        }
      ],
      "availability": {
        "standards": [
          {
            "weekday": "SEGUNDA_FEIRA",
            "openingTime": "10:00:57Z",
            "closingTime": "16:00:57Z"
          }
        ]
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string true none Nome da marca selecionada pela Organização proprietária da dependência (titular).
cnpjNumber string true none CNPJ da sociedade responsável pelo canal de atendimento - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica.
electronicChannels [ElectronicChannels] true none Lista de canais de atendimento eltrônico

Branch

{
  "identification": {
    "type": "POSTO_ATENDIMENTO",
    "code": "0001",
    "checkDigit": "9",
    "name": "Marília"
  },
  "postalAddress": {
    "address": "Av Naburo Ykesaki 1270, bloco 35, fundos",
    "additionalInfo": "Loja B",
    "districtName": "Centro",
    "townName": "São Paulo",
    "ibgeCode": "3550308",
    "countrySubDivision": "SP",
    "postCode": "17500001",
    "country": "Brasil",
    "countryCode": "BRA",
    "geographicCoordinates": {
      "latitude": "-90.8365180",
      "longitude": "-180.836519"
    }
  },
  "availability": {
    "standards": [
      {
        "weekday": "SEGUNDA_FEIRA",
        "openingTime": "10:00:57Z",
        "closingTime": "16:00:57Z"
      }
    ],
    "exception": "string",
    "isPublicAccessAllowed": true
  },
  "phones": [
    {
      "type": "FIXO",
      "countryCallingCode": "55",
      "areaCode": "19",
      "number": "35721199"
    }
  ],
  "services": [
    {
      "name": "ENDOSSO",
      "code": "01"
    }
  ]
}

Dependência destinada à prática das atividades para as quais a instituição esteja regularmente habilitada.

Properties

Name Type Required Restrictions Description
identification BranchIdentification false none none
postalAddress BranchPostalAddress true none none
availability BranchAvailability true none none
phones [BranchPhone] false none Listagem de telefones da Dependência própria
services [BranchService] true none Traz a relação de serviços disponbilizados pelo Canal de Atendimento

BranchPostalAddress

{
  "address": "Av Naburo Ykesaki 1270, bloco 35, fundos",
  "additionalInfo": "Loja B",
  "districtName": "Centro",
  "townName": "São Paulo",
  "ibgeCode": "3550308",
  "countrySubDivision": "SP",
  "postCode": "17500001",
  "country": "Brasil",
  "countryCode": "BRA",
  "geographicCoordinates": {
    "latitude": "-90.8365180",
    "longitude": "-180.836519"
  }
}

Properties

Name Type Required Restrictions Description
address string true none Deverá trazer toda a informação referente ao endereço da dependência informada. Tipo de logradouro + Nome do logradouro + Número do Logradouro (se não existir usar ' s/n') + complemento (se houver).
additionalInfo string false none Alguns logradouros ainda necessitam ser especificados por meio de complemento, conforme o exemplo a seguir.
districtName string true none Bairro é uma comunidade ou região localizada em uma cidade ou município de acordo com as suas subdivisões geográficas.
townName string true none O nome da localidade corresponde à designação da cidade ou município no qual o endereço está localizado.
ibgeCode string true none Código IBGE de Município. A Tabela de Códigos de Municípios do IBGE apresenta a lista dos municípios brasileiros associados a um código composto de 7 dígitos, sendo os dois primeiros referentes ao código da Unidade da Federação.
countrySubDivision string true none Enumeração referente a cada sigla da unidade da federação que identifica o estado ou o distrito federal, no qual o endereço está localizado. São consideradas apenas as siglas para os estados brasileiros.
postCode string true none Código de Endereçamento Postal. Composto por um conjunto numérico de oito dígitos, o objetivo principal do CEP é orientar e acelerar o encaminhamento, o tratamento e a entrega de objetos postados nos Correios, por meio da sua atribuição a localidades, logradouros, unidades dos Correios, serviços, órgãos públicos, empresas e edifícios.
country string false none Nome do país.
countryCode string false none Código do país de acordo com o código “alpha3” do ISO-3166.
geographicCoordinates BranchesGeographicCoordinates false none Informação referente a geolocalização informada.

BranchIdentification

{
  "type": "POSTO_ATENDIMENTO",
  "code": "0001",
  "checkDigit": "9",
  "name": "Marília"
}

Properties

Name Type Required Restrictions Description
type string false none Tipo de dependência.
code string false none Código identificador da dependência
checkDigit string false none Dígito verificador do código da dependência
name string false none Nome da dependência

Enumerated Values

Property Value
type POSTO_ATENDIMENTO
type UNIDADE_ADMINISTRATIVA_DESMEMBRADA

BranchAvailability

{
  "standards": [
    {
      "weekday": "SEGUNDA_FEIRA",
      "openingTime": "10:00:57Z",
      "closingTime": "16:00:57Z"
    }
  ],
  "exception": "string",
  "isPublicAccessAllowed": true
}

Properties

Name Type Required Restrictions Description
standards [any] true none Lista disponibilidade padrão da depêndencia próprias por dias da semana
» weekday string true none Dia da semana de abertura da dependência
» openingTime string true none Horário de abertura da dependência (UTC)
» closingTime string true none Horário de fechamento da dependência (UTC)
exception string false none Em campo texto devem ser registradas todas as Exceções para o não atendimento.
isPublicAccessAllowed boolean false none Indica se a instalação da Dependência tem acesso restrito a clientes.

Enumerated Values

Property Value
weekday DOMINGO
weekday SEGUNDA_FEIRA
weekday TERCA_FEIRA
weekday QUARTA_FEIRA
weekday QUINTA_FEIRA
weekday SEXTA_FEIRA
weekday SABADO

EletronicChannelsAvailability

{
  "standards": [
    {
      "weekday": "SEGUNDA_FEIRA",
      "openingTime": "10:00:57Z",
      "closingTime": "16:00:57Z"
    }
  ]
}

Properties

Name Type Required Restrictions Description
standards [any] true none Lista disponibilidade padrão da depêndencia próprias por dias da semana
» weekday string true none Dias de funcionamento em formato texto
» openingTime string true none Horário padrão de início de atendimento do canal eletrônico. (UTC)
» closingTime string true none Horário padrão de encerramento de atendimento do canal eletrônico (UTC)

Enumerated Values

Property Value
weekday DOMINGO
weekday SEGUNDA_FEIRA
weekday TERCA_FEIRA
weekday QUARTA_FEIRA
weekday QUINTA_FEIRA
weekday SEXTA_FEIRA
weekday SABADO

PhoneChannelsAvailability

{
  "standards": [
    {
      "weekday": "SEGUNDA_FEIRA",
      "openingTime": "10:00:57Z",
      "closingTime": "16:00:57Z"
    }
  ]
}

Properties

Name Type Required Restrictions Description
standards [any] true none Lista disponibilidade padrão da depêndencia próprias por dias da semana
» weekday string true none Dia da semana de abertura da dependência
» openingTime string true none Horário de abertura da dependência (UTC)
» closingTime string true none Horário de fechamento da dependência (UTC)

Enumerated Values

Property Value
weekday DOMINGO
weekday SEGUNDA_FEIRA
weekday TERCA_FEIRA
weekday QUARTA_FEIRA
weekday QUINTA_FEIRA
weekday SEXTA_FEIRA
weekday SABADO

BranchService

{
  "name": "ENDOSSO",
  "code": "01"
}

Properties

Name Type Required Restrictions Description
name string true none Nome dos Serviços efetivamente prestados pelo Canal de Atendimento
code string true none Código dos Serviços efetivamente prestados pelo Canal de Atendimento

Enumerated Values

Property Value
name ALTERACOES_FORMA_PAGAMENTO
name AVISO_SINISTRO
name CANCELAMENTO_SUSPENSAO_PAGAMENTO_PREMIOS_CONTRIBUICAO
name EFETIVACAO_APORTE
name ENDOSSO
name ENVIO_DOCUMENTOS
name INFORMACOES_GERAIS_DUVIDAS
name INFORMACOES_INTERMEDIARIOS
name INFORMACOES_SOBRE_SERVICOS_ASSISTENCIAS
name INFORMACOES_SOBRE_SORTEIOS
name OUVIDORIA_RECEPCAO_SUGESTOES_ELOGIOS
name OUVIDORIA_SOLUCAO_EVENTUAIS_DIVERGENCIAS_SOBRE_CONTRATO_SEGURO_CAPITALIZAÇÃO_PREVIDÊNCIA_APOS_ESGOTADOS_CANAIS_REGULARES_ATENDIMENTO_AQUELAS_ORIUNDAS_ORGAOS_REGULADORES_OU_INTEGRANTES_SISTEMA_NACIONAL_DEFESA_CONSUMIDOR
name OUVIDORIA_TRATAMENTO_INSATISFACAO_CONSUMIDOR_RELACAO_ATENDIMENTO_RECEBIDO_CANAIS_REGULARES_ATENDIMENTO
name OUVIDORIA_TRATAMENTO_RECLAMACOES_SOBRE_IRREGULARDADES_CONDUTA_COMPANHIA
name PORTABILIDADE
name RECLAMACAO
name RESGATE
name SEGUNDA_VIA_DOCUMENTOS_CONTRATUAIS
name SUGESTOES_ELOGIOS
code 01
code 02
code 03
code 04
code 05
code 06
code 07
code 08
code 09
code 10
code 11
code 12
code 13
code 14
code 15
code 16
code 17
code 18
code 19

ElectronicChannels

{
  "identification": {
    "type": "CHAT",
    "accessType": "EMAIL",
    "urls": [
      "string"
    ]
  },
  "services": [
    {
      "name": "ALTERACACOES_FORMA_PAGAMENTO",
      "code": "01",
      "additionalInfo": "SIC"
    }
  ],
  "availability": {
    "standards": [
      {
        "weekday": "SEGUNDA_FEIRA",
        "openingTime": "10:00:57Z",
        "closingTime": "16:00:57Z"
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
identification ElectronicChannelsIdentification true none none
services [ElectronicChannelsServices] true none Traz a relação de serviços disponbilizados pelo Canal de Atendimento
availability EletronicChannelsAvailability false none none

ElectronicChannelsIdentification

{
  "type": "CHAT",
  "accessType": "EMAIL",
  "urls": [
    "string"
  ]
}

Properties

Name Type Required Restrictions Description
type string true none Tipo de canal de atendimento eletrônico
accessType string false none Tipo de acesso
urls [ElectronicChannelsUrl] true none Lista das URLs que atendem um tipo de canal eletrônico selecionado

Enumerated Values

Property Value
type INTERNET
type MOBILE
type CHAT
type WHATSAPP
type CONSUMIDOR
type OUTROS
accessType EMAIL
accessType INTERNET
accessType APP
accessType CHAT
accessType WHATSAPP
accessType CONSUMIDOR
accessType OUTROS

ElectronicChannelsUrl

"string"

Properties

Name Type Required Restrictions Description
anonymous string false none none

ElectronicChannelsServices

{
  "name": "ALTERACACOES_FORMA_PAGAMENTO",
  "code": "01",
  "additionalInfo": "SIC"
}

Properties

Name Type Required Restrictions Description
name string true none Nome dos Serviços efetivamente prestados pelo Canal de Atendimento
code string true none Código dos Serviços efetivamente prestados pelo Canal de Atendimento
additionalInfo string false none Texto livre para complementar informação relativa ao Serviço disponível, quando for selecionada a opção 'OUTROS_PRODUTOS_SERVICOS'

Enumerated Values

Property Value
name ALTERACACOES_FORMA_PAGAMENTO
name AVISO_SINISTRO
name CANCELAMENTO_SUSPENSAO_PAGAMENTO_PREMIOS_CONTRIBUICAO
name EFETIVACAO_APORTE
name ENDOSSO
name ENVIO_DOCUMENTOS
name INFORMACOES_GERAIS_DUVIDAS
name INFORMACOES_INTERMEDIARIOS
name INFORMACOES_SOBRE_SERVICOS_ASSISTENCIAS
name INFORMACOES_SOBRE_SORTEIOS
name OUVIDORIA_RECEPCAO_SUGESTOES_ELOGIOS
name OUVIDORIA_SOLUCAO_EVENTUAIS_DIVERGENCIAS_SOBRE_CONTRATO_SEGURO_CAPITALIZAÇÃO_PREVIDÊNCIA_APOS_ESGOTADOS_CANAIS_REGULARES_ATENDIMENTO_AQUELAS_ORIUNDAS_ORGAOS_REGULADORES_OU_INTEGRANTES_SISTEMA_NACIONAL_DEFESA_CONSUMIDOR
name OUVIDORIA_TRATAMENTO_INSATISFACAO_CONSUMIDOR_RELACAO_ATENDIMENTO_RECEBIDO_CANAIS_REGULARES_ATENDIMENTO
name OUVIDORIA_TRATAMENTO_RECLAMACOES_SOBRE_IRREGULARDADES_CONDUTA_COMPANHIA
name PORTABILIDADE
name RECLAMACAO
name RESGATE
name SEGUNDA_VIA_DOCUMENTOS_CONTRATUAIS
name SUGESTOES_ELOGIOS
code 01
code 02
code 03
code 04
code 05
code 06
code 07
code 08
code 09
code 10
code 11
code 12
code 13
code 14
code 15
code 16
code 17
code 18
code 19

BranchPhone

{
  "type": "FIXO",
  "countryCallingCode": "55",
  "areaCode": "19",
  "number": "35721199"
}

Properties

Name Type Required Restrictions Description
type string false none Identificação do Tipo de telefone da dependência. p.ex.FIXO, MOVEL.
countryCallingCode string false none Número de DDI (Discagem Direta Internacional) para telefone de acesso ao Canal - se houver. p.ex. '55'
areaCode string false none Número de DDD (Discagem Direta à Distância) do telefone da dependência - se houver. p.ex. '19'
number string false none Número de telefone da dependência - se houver

Enumerated Values

Property Value
type FIXO
type MOVEL

ResponsePhoneChannelsList

{
  "data": {
    "brand": {
      "name": "Organização A",
      "companies": [
        {
          "name": "Empresa A1",
          "cnpjNumber": "45086338000178",
          "urlComplementaryList": "https://empresaa1.com/branches-insurance",
          "phoneChannels": [
            {
              "identification": {
                "type": "CENTRAL_TELEFONICA",
                "phones": [
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "35721199"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "997865532"
                  }
                ]
              },
              "services": [
                {
                  "name": "ALTERACOES_FORMA_PAGAMENTO",
                  "code": "01"
                },
                {
                  "name": "AVISO_SINISTRO",
                  "code": "02"
                },
                {
                  "name": "ENDOSSO",
                  "code": "05"
                }
              ]
            },
            {
              "identification": {
                "type": "SAC",
                "phones": [
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40044828",
                    "additionalInfo": "DDI '55'; DDD '11', 40044828, 'Para clientes no exterior'"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40044828",
                    "additionalInfo": "DDI '55'; DDD '11', 40044828, 'Para clientes no exterior'"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40044828",
                    "additionalInfo": "DDI '55'; DDD '11', 40044828, 'Para clientes no exterior'"
                  }
                ]
              },
              "services": [
                {
                  "name": "RECLAMACAO",
                  "code": "16"
                },
                {
                  "name": "PORTABILIDADE",
                  "code": "15"
                },
                {
                  "name": "ENDOSSO",
                  "code": "05"
                }
              ]
            },
            {
              "identification": {
                "type": "OUVIDORIA",
                "phones": [
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40045555"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40045555"
                  },
                  {
                    "countryCallingCode": "55",
                    "areaCode": "14",
                    "number": "40045555"
                  }
                ]
              },
              "services": [
                {
                  "name": "RECLAMACAO",
                  "code": "16"
                },
                {
                  "name": "PORTABILIDADE",
                  "code": "15"
                }
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/channels/v1/phone-channels",
    "first": "https://api.organizacao.com.br/open-insurance/channels/v1/phone-channels",
    "prev": "null",
    "next": "null",
    "last": "https://api.organizacao.com.br/open-insurance/channels/v1/phone-channels"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

Properties

Name Type Required Restrictions Description
data object true none none
» brand PhoneChannelsBrand true none none
links LinksPaginated true none none
meta MetaPaginated true none none

PhoneChannelsBrand

{
  "name": "Marca A",
  "companies": [
    {
      "name": "Empresa da Marca A",
      "cnpjNumber": "45086338000178",
      "phoneChannels": [
        {
          "identification": {
            "type": "OUVIDORIA",
            "phones": [
              {
                "countryCallingCode": "55",
                "areaCode": "19",
                "number": "08007787788"
              }
            ]
          },
          "services": [
            {
              "name": "AVISO_SINISTRO",
              "code": "01"
            }
          ],
          "availability": {
            "standards": [
              {
                "weekday": "SEGUNDA_FEIRA",
                "openingTime": "10:00:57Z",
                "closingTime": "16:00:57Z"
              }
            ]
          }
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string true none Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' utilizada está em definição pelos participantes.
companies [PhoneChannelsCompanies] true none Lista de instituições pertencentes à marca

PhoneChannelsCompanies

{
  "name": "Empresa da Marca A",
  "cnpjNumber": "45086338000178",
  "phoneChannels": [
    {
      "identification": {
        "type": "OUVIDORIA",
        "phones": [
          {
            "countryCallingCode": "55",
            "areaCode": "19",
            "number": "08007787788"
          }
        ]
      },
      "services": [
        {
          "name": "AVISO_SINISTRO",
          "code": "01"
        }
      ],
      "availability": {
        "standards": [
          {
            "weekday": "SEGUNDA_FEIRA",
            "openingTime": "10:00:57Z",
            "closingTime": "16:00:57Z"
          }
        ]
      }
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string true none Nome da Instituição, pertencente à organização, responsável pelo Canal Telefônico.
cnpjNumber string true none Número completo do CNPJ da instituição responsável pela dependência - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica.
Deve-se ter apenas os números do CNPJ, sem máscara
phoneChannels [PhoneChannels] true none Lista de canais de atendimento telefônico

PhoneChannels

{
  "identification": {
    "type": "OUVIDORIA",
    "phones": [
      {
        "countryCallingCode": "55",
        "areaCode": "19",
        "number": "08007787788"
      }
    ]
  },
  "services": [
    {
      "name": "AVISO_SINISTRO",
      "code": "01"
    }
  ],
  "availability": {
    "standards": [
      {
        "weekday": "SEGUNDA_FEIRA",
        "openingTime": "10:00:57Z",
        "closingTime": "16:00:57Z"
      }
    ]
  }
}

Properties

Name Type Required Restrictions Description
identification PhoneChannelsIdentification true none none
services [PhoneChannelsServices] true none Traz a relação de serviços disponbilizados pelo Canal de Atendimento
availability PhoneChannelsAvailability false none none

PhoneChannelsIdentification

{
  "type": "OUVIDORIA",
  "phones": [
    {
      "countryCallingCode": "55",
      "areaCode": "19",
      "number": "08007787788"
    }
  ]
}

Properties

Name Type Required Restrictions Description
type string true none Tipo de canal telefônico de atendimento:
* CENTRAL_TELEFONICA
* SAC
* OUVIDORIA
phones [PhoneChannelsPhones] false none Lista de telefones do Canal de Atendimento

Enumerated Values

Property Value
type CENTRAL_TELEFONICA
type SAC
type OUVIDORIA

PhoneChannelsPhones

{
  "countryCallingCode": "55",
  "areaCode": "19",
  "number": "08007787788"
}

Properties

Name Type Required Restrictions Description
countryCallingCode string true none Número de DDI (Discagem Direta Internacional) para telefone de acesso ao Canal - se houver.
areaCode string true none Número de DDD (Discagem Direta à Distância) para telefone de acesso ao Canal - se houver.
number string true none Número de telefone de acesso ao canal.

PhoneChannelsServices

{
  "name": "AVISO_SINISTRO",
  "code": "01"
}

Properties

Name Type Required Restrictions Description
name string true none Nome dos Serviços efetivamente prestados pelo Canal de Atendimento
code string true none Código dos Serviços efetivamente prestados pelo Canal de Atendimento

Enumerated Values

Property Value
name ALTERACOES_FORMA_PAGAMENTO
name AVISO_SINISTRO
name CANCELAMENTO_SUSPENSAO_PAGAMENTO_PREMIOS_CONTRIBUICAO
name EFETIVACAO_APORTE
name ENDOSSO
name ENVIO_DOCUMENTOS
name INFORMACOES_GERAIS_DUVIDAS
name INFORMACOES_INTERMEDIARIOS
name INFORMACOES_SOBRE_SERVICOS_ASSISTENCIAS
name INFORMACOES_SOBRE_SORTEIOS
name OUVIDORIA_RECEPCAO_SUGESTOES_ELOGIOS
name OUVIDORIA_SOLUCAO_EVENTUAIS_DIVERGENCIAS_SOBRE_CONTRATO_SEGURO_CAPITALIZAÇÃO_PREVIDÊNCIA_APOS_ESGOTADOS_CANAIS_REGULARES_ATENDIMENTO_AQUELAS_ORIUNDAS_ORGAOS_REGULADORES_OU_INTEGRANTES_SISTEMA_NACIONAL_DEFESA_CONSUMIDOR
name OUVIDORIA_TRATAMENTO_INSATISFACAO_CONSUMIDOR_RELACAO_ATENDIMENTO_RECEBIDO_CANAIS_REGULARES_ATENDIMENTO
name OUVIDORIA_TRATAMENTO_RECLAMACOES_SOBRE_IRREGULARDADES_CONDUTA_COMPANHIA
name PORTABILIDADE
name RECLAMACAO
name RESGATE
name SEGUNDA_VIA_DOCUMENTOS_CONTRATUAIS
name SUGESTOES_ELOGIOS
code 01
code 02
code 03
code 04
code 05
code 06
code 07
code 08
code 09
code 10
code 11
code 12
code 13
code 14
code 15
code 16
code 17
code 18
code 19

BranchesGeographicCoordinates

{
  "latitude": "-90.8365180",
  "longitude": "-180.836519"
}

Informação referente a geolocalização informada.

Properties

Name Type Required Restrictions Description
latitude string false none Informação da latitude referente a geolocalização informada. Entre -90 e 90. Formato númerico 2 casas antes da vírgula, 11 posições.
longitude string false none Informação da longitude referente a geolocalização informada. Formato númerico 3 casas antes da vírgula, 11 posições.

LinksPaginated

{
  "self": "https://api.organizacao.com.br/open-insurance/channels/v1/<resource>",
  "first": "https://api.organizacao.com.br/open-insurance/channels/v1/<resource>",
  "prev": "string",
  "next": "string",
  "last": "https://api.organizacao.com.br/open-insurance/channels/v1/<resource>"
}

Properties

Name Type Required Restrictions Description
self string false none URL da página atualmente requisitada
first string false none URL da primeira página de registros
prev string false none URL da página anterior de registros
next string false none URL da próxima página de registros
last string false none URL da última página de registros

MetaPaginated

{
  "totalRecords": 1,
  "totalPages": 1
}

Properties

Name Type Required Restrictions Description
totalRecords integer true none Total de registros encontrados
totalPages integer true none Total de páginas para os registros encontrados

ResponseError

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "requestDateTime": "2021-08-20T08:30:00Z"
    }
  ],
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}

Properties

Name Type Required Restrictions Description
errors [object] true none none
» code string true none Código de erro específico do endpoint
» title string true none Título legível por humanos deste erro específico
» detail string true none Descrição legível por humanos deste erro específico
» requestDateTime string(date-time) true none Data e hora da consulta, conforme especificação RFC-3339, formato UTC.
meta MetaPaginated false none none

API - Produtos e serviços v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

As APIs descritas neste documento são referentes as APIs da fase Open Data do Open Insurance Brasil.

Base URLs:

Web: Support

life-pension

Obtém a lista dos produtos do tipo vida e previdência.

Especificação em OAS

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.organizacao.com.br/open-insurance/products-services/v1/life-pension");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("cache-control", "string");
xhr.setRequestHeader("Content-Security-Policy", "string");
xhr.setRequestHeader("content-Type", "string");
xhr.setRequestHeader("Strict-Transport-Security", "string");
xhr.setRequestHeader("X-Content-Type-Options", "string");
xhr.setRequestHeader("X-Frame-Options", "string");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.organizacao.com.br")

headers = {
    'Accept': "application/json",
    'cache-control': "string",
    'Content-Security-Policy': "string",
    'content-Type': "string",
    'Strict-Transport-Security': "string",
    'X-Content-Type-Options': "string",
    'X-Frame-Options': "string"
    }

conn.request("GET", "/open-insurance/products-services/v1/life-pension", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("https://api.organizacao.com.br/open-insurance/products-services/v1/life-pension")
  .header("Accept", "application/json")
  .header("cache-control", "string")
  .header("Content-Security-Policy", "string")
  .header("content-Type", "string")
  .header("Strict-Transport-Security", "string")
  .header("X-Content-Type-Options", "string")
  .header("X-Frame-Options", "string")
  .asString();

GET /life-pension

Obtém a lista dos produtos do tipo vida e previdência.

Parameters

Name In Type Required Description
cache-control header string true Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy header string false Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type header string false Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security header string false Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options header string false Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options header string false Campo indica se o navegador deve ou não renderizar um frame.
page query integer false Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size query integer false Quantidade total de registros por páginas.

Example responses

200 Response

[
  {
    "identification": {
      "brand": "Brasilprev",
      "societyName": "Brasilprev Seguros e Previdência S.A",
      "cnpjNumber": "27665207000131"
    },
    "products": [
      {
        "name": "Brasilprev Private Multimercado 2020",
        "code": "1234",
        "segment": "PREVIDENCIA",
        "type": "PGBL",
        "modality": "CONTRIBUICAO_VARIAVEL",
        "optionalCoverage": "string",
        "productDetails": [
          {
            "susepProcessNumber": "15414.614141/2020-71",
            "contractTermsConditions": "https://example.com/mobilebanking",
            "defferalPeriod": {
              "interestRate": 0.25123,
              "updateIndex": "IPCA",
              "otherMinimumPerformanceGarantees": "SELIC",
              "reversalFinancialResults": 5.123,
              "minimumPremiumAmount": [
                {
                  "minimumPremiumAmountValue": 250,
                  "minimumPremiumAmountDescription": ""
                }
              ],
              "premiumPaymentMethod": [
                "CARTAO_CREDITO"
              ],
              "permissionExtraordinaryContributions": true,
              "permissonScheduledFinancialPayments": true,
              "gracePeriodRedemption": 100,
              "gracePeriodBetweenRedemptionRequests": 30,
              "redemptionPaymentTerm": 10,
              "gracePeriodPortability": 12,
              "gracePeriodBetweenPortabilityRequests": 15,
              "portabilityPaymentTerm": 20,
              "investimentFunds": [
                {
                  "cnpjNumber": "13.456.789/0001-12",
                  "companyName": "EYPREV",
                  "maximumAdministrationFee": 20.1,
                  "typePerformanceFee": [
                    "DIRETAMENTE"
                  ],
                  "maximumPerformanceFee": 20,
                  "eligibilityRule": true,
                  "minimumContributionAmount": 1000,
                  "minimumMathematicalProvisionAmount": 1000
                }
              ]
            },
            "grantPeriodBenefit": {
              "incomeModality": [
                "RENDA_VITALICIA"
              ],
              "biometricTable": [
                "AT_2000_FEMALE_SUAVIZADA_15"
              ],
              "interestRate": 3.225,
              "updateIndex": "IPCA",
              "reversalResultsFinancial": 13.252,
              "investimentFunds": [
                {
                  "cnpjNumber": "13.456.789/0001-12",
                  "companyName": "EYPREV",
                  "maximumAdministrationFee": 20.1,
                  "typePerformanceFee": [
                    "DIRETAMENTE"
                  ],
                  "maximumPerformanceFee": 20,
                  "eligibilityRule": true,
                  "minimumContributionAmount": 1000,
                  "minimumMathematicalProvisionAmount": 1000
                }
              ]
            },
            "costs": {
              "loadingAntecipated": {
                "minValue": 4.122,
                "maxValue": 10
              },
              "loadingLate": {
                "minValue": 4.122,
                "maxValue": 10
              }
            }
          }
        ],
        "minimumRequirements": {
          "contractType": "INDIVIDUAL",
          "participantQualified": true,
          "minRequirementsContract": "https://example.com/mobile-banking"
        },
        "targetAudience": "PESSOA_NATURAL"
      }
    ],
    "links": {
      "self": "https://api.organizacao.com.br/open-insurance/products-services/v1",
      "first": "https://api.organizacao.com.br/open-insurance/products-services/v1",
      "prev": "string",
      "next": "string",
      "last": "https://api.organizacao.com.br/open-insurance/products-services/v1"
    },
    "meta": {
      "totalRecords": 10,
      "totalPages": 1
    }
  }
]

Responses

Status Meaning Description Schema
200 OK Dados dos produtos de Vida e Previdência ResponseLifePensionList
400 Bad Request A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. ResponseError
401 Unauthorized Cabeçalho de autenticação ausente/inválido ou token inválido ResponseError
403 Forbidden O token tem escopo incorreto ou uma política de segurança foi violada ResponseError
404 Not Found O recurso solicitado não existe ou não foi implementado ResponseError
405 Method Not Allowed O consumidor tentou acessar o recurso com um método não suportado ResponseError
406 Not Acceptable A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8 ResponseError
429 Too Many Requests A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido ResponseError
500 Internal Server Error Ocorreu um erro no gateway da API ou no microsserviço ResponseError
default Default Dados dos produtos de Vida e Previdência ResponseLifePensionList

pension-plan

Obtém informações de plano de previdência com cobertura de risco

Especificação em OAS

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.organizacao.com.br/open-insurance/products-services/v1/pension-plan/");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("cache-control", "string");
xhr.setRequestHeader("Content-Security-Policy", "string");
xhr.setRequestHeader("content-Type", "string");
xhr.setRequestHeader("Strict-Transport-Security", "string");
xhr.setRequestHeader("X-Content-Type-Options", "string");
xhr.setRequestHeader("X-Frame-Options", "string");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.organizacao.com.br")

headers = {
    'Accept': "application/json",
    'cache-control': "string",
    'Content-Security-Policy': "string",
    'content-Type': "string",
    'Strict-Transport-Security': "string",
    'X-Content-Type-Options': "string",
    'X-Frame-Options': "string"
    }

conn.request("GET", "/open-insurance/products-services/v1/pension-plan/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("https://api.organizacao.com.br/open-insurance/products-services/v1/pension-plan/")
  .header("Accept", "application/json")
  .header("cache-control", "string")
  .header("Content-Security-Policy", "string")
  .header("content-Type", "string")
  .header("Strict-Transport-Security", "string")
  .header("X-Content-Type-Options", "string")
  .header("X-Frame-Options", "string")
  .asString();

GET /pension-plan/

Obtém informações de plano de previdência com cobertura de risco

Parameters

Name In Type Required Description
cache-control header string true Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy header string false Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type header string false Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security header string false Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options header string false Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options header string false Campo indica se o navegador deve ou não renderizar um frame.
page query integer false Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size query integer false Quantidade total de registros por páginas.

Example responses

200 Response

{
  "requestTime": "2021-08-20T08:30:00Z",
  "data": {},
  "brand": {
    "name": "EMPRESA",
    "companies": {
      "name": "EMPRESA Seguros",
      "cnpjNumber": 45086338000178,
      "products": [
        {
          "name": "Nome comercial do Produto",
          "code": "123456789_cap",
          "modality": "PENSAO",
          "coverages": [
            {
              "coverage": "INVALIDEZ",
              "coveragesAttributes": {
                "indenizationPaymentMethod": "Pagamento Único",
                "minValue": {
                  "amount": 0,
                  "unit": {
                    "code": "string",
                    "description": "string"
                  }
                },
                "maxValue": {
                  "amount": 0,
                  "unit": {
                    "code": "string",
                    "description": "string"
                  }
                },
                "indemnifiablePeriod": "Prazo",
                "indemnifiableDeadline": 48,
                "currency": "BRL",
                "gracePeriod": {
                  "amount": 0,
                  "unit": "DIAS"
                },
                "excludedRisk": [
                  "ATO_RECONHECIMENTO_PERIGOSO"
                ],
                "excludedRiskURL": "string"
              },
              "coveragePeriod": "Vitalícia"
            }
          ],
          "additional": "SORTEIO",
          "additionalOthers": "string",
          "assistanceType": [
            "Funeral"
          ],
          "assistanceTypeOthers": [
            "string"
          ],
          "termAndCondition": [
            {
              "susepProcessNumber": "15414.622222/2222-22",
              "definition": "wwww.seguradora.com.br/termos"
            }
          ],
          "updatePMBaC": {
            "interestRate": 14,
            "updateIndex": "IPCA(IBGE)"
          },
          "premiumUpdateIndex": "IPCA",
          "ageReframing": {
            "reframingCriterion": "Após período em anos",
            "reframingPeriodicity": 10
          },
          "financialRegimeContractType": "Repartição Simples",
          "reclaim": {
            "reclaimTable": [
              {
                "initialMonthRange": 0,
                "finalMonthRange": 0,
                "percentage": "string"
              }
            ],
            "differentiatedPercentage": "string",
            "gracePeriod": "20/Não se aplica"
          },
          "otherGuarateedValues": "Saldamento",
          "profitModality": "PAGAMENTO_UNICO",
          "contributionPayment": {
            "contributionPaymentMethod": [
              "Cartão de crédito"
            ],
            "contributionPeriodicity": [
              "Mensal"
            ]
          },
          "contributionTax": "string",
          "minimumRequirements": {
            "minRequirementsContractType": "Individual",
            "minRequirementsContract": "wwww.seguradora.com.br/termos"
          },
          "targetAudience": "Pessoa Natural"
        }
      ]
    }
  },
  "linksPaginated": {
    "self": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "first": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "prev": "string",
    "next": "string",
    "last": "https://api.organizacao.com.br/open-insurance/products-services/v1"
  },
  "metaPaginated": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Responses

Status Meaning Description Schema
200 OK Dados dos Plano de Previdência com cobertura de risco ResponsePensionPlanList
201 Created A operação resulta na criação de um novo recurso. None
204 No Content none None
304 Not Modified none None
400 Bad Request A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. ResponseError
401 Unauthorized Cabeçalho de autenticação ausente/inválido ou token inválido ResponseError
403 Forbidden O token tem escopo incorreto ou uma política de segurança foi violada ResponseError
404 Not Found O recurso solicitado não existe ou não foi implementado ResponseError
405 Method Not Allowed O consumidor tentou acessar o recurso com um método não suportado ResponseError
406 Not Acceptable A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8 ResponseError
410 Gone none None
415 Unsupported Media Type none None
422 Unprocessable Entity Se aplicável ao endpoint, espera-se que esse erro resulte em um payload de erro. None
429 Too Many Requests A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido ResponseError
500 Internal Server Error Ocorreu um erro no gateway da API ou no microsserviço ResponseError
503 Service Unavailable none None
504 Gateway Time-out Retornado se ocorreu um tempo limite, mas um reenvio da solicitação original é viável (caso contrário, use 500 Internal Server Error). None
default Default none None

person

Obtém a lista dos produtos do tipo seguro de pessoas.

Especificação em OAS

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.organizacao.com.br/open-insurance/products-services/v1/person/");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("cache-control", "string");
xhr.setRequestHeader("Content-Security-Policy", "string");
xhr.setRequestHeader("content-Type", "string");
xhr.setRequestHeader("Strict-Transport-Security", "string");
xhr.setRequestHeader("X-Content-Type-Options", "string");
xhr.setRequestHeader("X-Frame-Options", "string");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.organizacao.com.br")

headers = {
    'Accept': "application/json",
    'cache-control': "string",
    'Content-Security-Policy': "string",
    'content-Type': "string",
    'Strict-Transport-Security': "string",
    'X-Content-Type-Options': "string",
    'X-Frame-Options': "string"
    }

conn.request("GET", "/open-insurance/products-services/v1/person/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("https://api.organizacao.com.br/open-insurance/products-services/v1/person/")
  .header("Accept", "application/json")
  .header("cache-control", "string")
  .header("Content-Security-Policy", "string")
  .header("content-Type", "string")
  .header("Strict-Transport-Security", "string")
  .header("X-Content-Type-Options", "string")
  .header("X-Frame-Options", "string")
  .asString();

GET /person/

Obtém a lista dos produtos do tipo seguro de pessoas.

Parameters

Name In Type Required Description
cache-control header string true Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy header string false Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type header string false Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security header string false Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options header string false Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options header string false Campo indica se o navegador deve ou não renderizar um frame.
page query integer false Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size query integer false Quantidade total de registros por páginas.

Example responses

200 Response

{
  "data": {
    "brand": {
      "name": "Marca",
      "companies": [
        {
          "name": "Seguradora",
          "cnpjNumber": 45086338000178,
          "products": [
            {
              "name": "Seguro Pessoal",
              "code": "123456789_cap",
              "category": "TRADICIONAL",
              "insuranceModality": "FUNERAL",
              "coverages": [
                {
                  "coverage": "AUXILIO_CESTA_BASICA",
                  "coverageOthers": [
                    "string"
                  ],
                  "coverageAttributes": {
                    "indemnityPaymentMethod": [],
                    "indemnityPaymentFrequency": [],
                    "minValue": {},
                    "maxValue": {},
                    "indemnifiablePeriod": [],
                    "maximumQtyIndemnifiableInstallments": 0,
                    "currency": "BRL",
                    "gracePeriod": {},
                    "differentiatedGracePeriod": {},
                    "deductibleDays": 0,
                    "differentiatedDeductibleDays": 0,
                    "deductibleBRL": 0,
                    "differentiatedDeductibleBRL": "string",
                    "excludedRisks": [],
                    "excludedRisksURL": "string",
                    "allowApartPurchase": true
                  }
                }
              ],
              "assistanceType": [
                "ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA"
              ],
              "additional": [
                "SORTEIO"
              ],
              "assistanceTypeOthers": [
                "string"
              ],
              "termsAndConditions": [
                {
                  "susepProcessNumber": "string",
                  "definition": "string"
                }
              ],
              "globalCapital": true,
              "validity": [
                "VITALICIA"
              ],
              "pmbacRemuneration": {
                "interestRate": 0,
                "pmbacUpdateIndex": "IPCA"
              },
              "benefitRecalculation": {
                "benefitRecalculationCriteria": "INDICE",
                "benefitUpdateIndex": "IPCA"
              },
              "ageAdjustment": {
                "criterion": "APOS_PERIODO_EM_ANOS",
                "frequency": 0
              },
              "contractType": "REPARTICAO_SIMPLES",
              "reclaim": {
                "reclaimTable": [
                  {
                    "initialMonthRange": 1,
                    "finalMonthRange": 12,
                    "percentage": 0
                  }
                ],
                "differentiatedPercentage": "string",
                "gracePeriod": {
                  "amount": 60,
                  "unit": "DIAS"
                }
              },
              "otherGuaranteedValues": "SALDAMENTO",
              "allowPortability": true,
              "portabilityGraceTime": 0,
              "indemnityPaymentMethod": [
                "UNICO"
              ],
              "indemnityPaymentIncome": [
                "CERTA"
              ],
              "premiumPayment": {
                "paymentMethod": [
                  "CARTAO_CREDITO"
                ],
                "frequency": [
                  "DIARIA"
                ],
                "premiumTax": "string"
              },
              "minimunRequirements": {
                "contractingType": "COLETIVO",
                "contractingMinRequirement": "string"
              },
              "targetAudience": "PESSOA_NATURAL"
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "first": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "prev": "string",
    "next": "string",
    "last": "https://api.organizacao.com.br/open-insurance/products-services/v1"
  },
  "meta": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Responses

Status Meaning Description Schema
200 OK Dados dos Plano de Seguro de Pessoas ResponsePersonList
400 Bad Request A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. ResponseError
401 Unauthorized Cabeçalho de autenticação ausente/inválido ou token inválido ResponseError
403 Forbidden O token tem escopo incorreto ou uma política de segurança foi violada ResponseError
404 Not Found O recurso solicitado não existe ou não foi implementado ResponseError
405 Method Not Allowed O consumidor tentou acessar o recurso com um método não suportado ResponseError
406 Not Acceptable A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8 ResponseError
429 Too Many Requests A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido ResponseError
500 Internal Server Error Ocorreu um erro no gateway da API ou no microsserviço ResponseError
default Default none None

auto-insurance

Obtém informações de seguros de automóveis

Especificação em OAS

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.organizacao.com.br/open-insurance/products-services/v1/auto-insurance/string/string/string");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("cache-control", "string");
xhr.setRequestHeader("Content-Security-Policy", "string");
xhr.setRequestHeader("content-Type", "string");
xhr.setRequestHeader("Strict-Transport-Security", "string");
xhr.setRequestHeader("X-Content-Type-Options", "string");
xhr.setRequestHeader("X-Frame-Options", "string");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.organizacao.com.br")

headers = {
    'Accept': "application/json",
    'cache-control': "string",
    'Content-Security-Policy': "string",
    'content-Type': "string",
    'Strict-Transport-Security': "string",
    'X-Content-Type-Options': "string",
    'X-Frame-Options': "string"
    }

conn.request("GET", "/open-insurance/products-services/v1/auto-insurance/string/string/string", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("https://api.organizacao.com.br/open-insurance/products-services/v1/auto-insurance/string/string/string")
  .header("Accept", "application/json")
  .header("cache-control", "string")
  .header("Content-Security-Policy", "string")
  .header("content-Type", "string")
  .header("Strict-Transport-Security", "string")
  .header("X-Content-Type-Options", "string")
  .header("X-Frame-Options", "string")
  .asString();

GET /auto-insurance/{commercializationArea}/{fipeCode}/{year}

Obtém informações de seguros de automóveis

Parameters

Name In Type Required Description
cache-control header string true Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy header string false Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type header string false Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security header string false Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options header string false Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options header string false Campo indica se o navegador deve ou não renderizar um frame.
page query integer false Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size query integer false Quantidade total de registros por páginas.
commercializationArea path string true Area de comercialização.
fipeCode path string true Código FIPE
year path string true Ano de comercialização do veículo

Example responses

200 Response

{
  "data": {
    "brand": {
      "name": "string",
      "company": [
        {
          "name": "string",
          "cnpjNumber": "string",
          "products": [
            {
              "name": "string",
              "code": "string",
              "coverages": [
                {
                  "coverage": "VIDROS",
                  "coverageDetail": "Roubo total",
                  "coveragePermissionSeparteAcquisition": true,
                  "coverageAttributes": {
                    "minLMI": {},
                    "maxLMI": {},
                    "contractBase": [],
                    "newCarMaximumCalculatingPeriod": 12,
                    "newCarContractBase": [],
                    "fullIndemnityPercentage": {},
                    "deductibleType": [],
                    "fullIndemnityDeductible": true,
                    "deductiblePaymentByCoverage": true,
                    "deductiblePercentage": {},
                    "mandatoryParticipation": "Casco - RCF-V Danos",
                    "geographicScopeCoverage": [],
                    "geographicScopeCoverageOthers": "string"
                  }
                }
              ],
              "carParts": [
                {
                  "carPartCondition": "NOVAS",
                  "carPartType": "ORIGINAIS"
                }
              ],
              "carModels": [
                {
                  "manufacturer": "FORD",
                  "model": "KA",
                  "year": 2018,
                  "fipeCode": "string"
                }
              ],
              "vehicleOvernightZipCode": 1311000,
              "additional": [
                "SORTEIO GRATUITO"
              ],
              "additionalOthers": "string",
              "assistanceServices": [
                {
                  "assistanceServicesPackage": [
                    "ATE_10_SERVICOS"
                  ],
                  "assistanceServicesDetail": "Perda Parcial - Colisão",
                  "chargeTypeSignaling": "GRATUITA"
                }
              ],
              "termsAndConditions": [
                {
                  "susepProcessNumber": "15414.622222/2222-22",
                  "definition": "https://ey.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.pdf"
                }
              ],
              "terms": [
                "ANUAL"
              ],
              "customerService": [
                "REDE REFERECIADA"
              ],
              "premiumPayment": {
                "paymentMethod": [
                  "CARTÃO DE CRÉDITO"
                ],
                "paymentType": [
                  "PARCELADO"
                ],
                "paymentDetail": "string"
              },
              "minimumRequirements": {
                "contractingType": [
                  "COLETIVO"
                ],
                "contractingMinRequirement": "https://example.com/mobile-banking"
              },
              "targetAudiences": [
                "PESSOA_NATURAL"
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "first": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "prev": "string",
    "next": "string",
    "last": "https://api.organizacao.com.br/open-insurance/products-services/v1"
  },
  "meta": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Responses

Status Meaning Description Schema
200 OK Dados dos Seguros de Automóveis ResponseAutoInsuranceList
400 Bad Request A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. ResponseError
401 Unauthorized Cabeçalho de autenticação ausente/inválido ou token inválido ResponseError
403 Forbidden O token tem escopo incorreto ou uma política de segurança foi violada ResponseError
404 Not Found O recurso solicitado não existe ou não foi implementado ResponseError
405 Method Not Allowed O consumidor tentou acessar o recurso com um método não suportado ResponseError
406 Not Acceptable A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8 ResponseError
429 Too Many Requests A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido ResponseError
500 Internal Server Error Ocorreu um erro no gateway da API ou no microsserviço ResponseError
default Default none None

home-insurance

Obtém informações de seguros residenciais

Especificação em OAS

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.organizacao.com.br/open-insurance/products-services/v1/home-insurance/commercializationArea/0");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("cache-control", "string");
xhr.setRequestHeader("Content-Security-Policy", "string");
xhr.setRequestHeader("content-Type", "string");
xhr.setRequestHeader("Strict-Transport-Security", "string");
xhr.setRequestHeader("X-Content-Type-Options", "string");
xhr.setRequestHeader("X-Frame-Options", "string");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.organizacao.com.br")

headers = {
    'Accept': "application/json",
    'cache-control': "string",
    'Content-Security-Policy': "string",
    'content-Type': "string",
    'Strict-Transport-Security': "string",
    'X-Content-Type-Options': "string",
    'X-Frame-Options': "string"
    }

conn.request("GET", "/open-insurance/products-services/v1/home-insurance/commercializationArea/0", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("https://api.organizacao.com.br/open-insurance/products-services/v1/home-insurance/commercializationArea/0")
  .header("Accept", "application/json")
  .header("cache-control", "string")
  .header("Content-Security-Policy", "string")
  .header("content-Type", "string")
  .header("Strict-Transport-Security", "string")
  .header("X-Content-Type-Options", "string")
  .header("X-Frame-Options", "string")
  .asString();

GET /home-insurance/commercializationArea/{commercializationArea}

Obtém informações de seguros redidenciais

Parameters

Name In Type Required Description
cache-control header string true Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy header string false Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type header string false Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security header string false Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options header string false Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options header string false Campo indica se o navegador deve ou não renderizar um frame.
page query integer false Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size query integer false Quantidade total de registros por páginas.
commercializationArea path integer true Area de comercialização.

Example responses

200 Response

{
  "data": {
    "brand": {
      "name": "EMPRESA A seguros",
      "company": [
        {
          "name": "ABCDE SEGUROS",
          "cnpjNumber": 12345678901234,
          "products": [
            {
              "name": "RESIDENCIAL XPTO",
              "code": "0000-0",
              "coverages": [
                {
                  "coverageType": "Escritório em Residência",
                  "coverageDetail": "Cobertura especial para escritório residenciais",
                  "coveragePermissionSeparteAquisition": false,
                  "coverageAttributes": {
                    "minLMI": {},
                    "maxLMI": {},
                    "minDeductibleAmount": {},
                    "insuredMandatoryParticipationPercentage": 0
                  }
                }
              ],
              "propertyCharacteristics": [
                {
                  "propertyType": "CASA",
                  "propertyBuildType": "ALVENARIA",
                  "propertyUsageType": "HABITUAL",
                  "destinationInsuredImportance": "PRÉDIO"
                }
              ],
              "propertyZipCode": "1311000",
              "protective": true,
              "additional": [
                "SORTEIO_GRATUITO"
              ],
              "additionalOthers": "string",
              "assistanceServices": [
                {
                  "assistanceServicesPackage": "ATE_10_SERVICOS",
                  "complementaryAssistanceServicesDetail": "reboque pane seca",
                  "chargeTypeSignaling": "GRATUITA"
                }
              ],
              "termsAndConditions": [
                {
                  "susepProcessNumber": "XXXXX.XXXXXX/XXXX-XX",
                  "definition": "https://openinsurance.com.br/aaa"
                }
              ],
              "validity": [
                {
                  "term": "ANUAL",
                  "termOthers": "string"
                }
              ],
              "customerServices": [
                "LIVRE ESCOLHA"
              ],
              "premiumRates": [
                "string"
              ],
              "premiumPayments": [
                {
                  "paymentMethod": "CARTÃO DE CRÉDITO",
                  "paymentMethodDetail": "string",
                  "paymentType": "PAGAMENTO_UNICO"
                }
              ],
              "minimumRequirements": [
                {
                  "contractingType": "COLETIVO",
                  "contractingMinRequirement": "https://openinsurance.com.br/aaa"
                }
              ],
              "targetAudiences": [
                "PESSOA_NATURAL"
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "first": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "prev": "string",
    "next": "string",
    "last": "https://api.organizacao.com.br/open-insurance/products-services/v1"
  },
  "meta": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Responses

Status Meaning Description Schema
200 OK Dados dos Seguros Residenciais ResponseHomeInsuranceList
400 Bad Request A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. ResponseError
401 Unauthorized Cabeçalho de autenticação ausente/inválido ou token inválido ResponseError
403 Forbidden O token tem escopo incorreto ou uma política de segurança foi violada ResponseError
404 Not Found O recurso solicitado não existe ou não foi implementado ResponseError
405 Method Not Allowed O consumidor tentou acessar o recurso com um método não suportado ResponseError
406 Not Acceptable A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8 ResponseError
429 Too Many Requests A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido ResponseError
500 Internal Server Error Ocorreu um erro no gateway da API ou no microsserviço ResponseError
default Default none None

capitalization-title

Obtém a lista dos produtos do tipo título de capitalização

Especificação em OAS

Code samples

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.organizacao.com.br/open-insurance/products-services/v1/capitalization-title");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("cache-control", "string");
xhr.setRequestHeader("Content-Security-Policy", "string");
xhr.setRequestHeader("content-Type", "string");
xhr.setRequestHeader("Strict-Transport-Security", "string");
xhr.setRequestHeader("X-Content-Type-Options", "string");
xhr.setRequestHeader("X-Frame-Options", "string");

xhr.send(data);
import http.client

conn = http.client.HTTPSConnection("api.organizacao.com.br")

headers = {
    'Accept': "application/json",
    'cache-control': "string",
    'Content-Security-Policy': "string",
    'content-Type': "string",
    'Strict-Transport-Security': "string",
    'X-Content-Type-Options': "string",
    'X-Frame-Options': "string"
    }

conn.request("GET", "/open-insurance/products-services/v1/capitalization-title", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
HttpResponse<String> response = Unirest.get("https://api.organizacao.com.br/open-insurance/products-services/v1/capitalization-title")
  .header("Accept", "application/json")
  .header("cache-control", "string")
  .header("Content-Security-Policy", "string")
  .header("content-Type", "string")
  .header("Strict-Transport-Security", "string")
  .header("X-Content-Type-Options", "string")
  .header("X-Frame-Options", "string")
  .asString();

GET /capitalization-title

Obtém a lista dos produtos do tipo título de capitalização

Parameters

Name In Type Required Description
cache-control header string true Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy header string false Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type header string false Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security header string false Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options header string false Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options header string false Campo indica se o navegador deve ou não renderizar um frame.
page query integer false Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size query integer false Quantidade total de registros por páginas.

Example responses

200 Response

{
  "requestTime": "2021-08-20T08:30:00Z",
  "brand": {
    "name": "ACME seguros",
    "companies": [
      {
        "name": "ACME cap da ACME seguros",
        "cnpjNumber": "12345678901234",
        "product": [
          {
            "name": "ACMEcap",
            "code": "01234589_cap",
            "modality": [
              "TRADICIONAL"
            ],
            "costType": [
              "PAGAMENTO_UNICO"
            ],
            "termsAndConditions": {
              "susepProcessNumber": 15414622222222222,
              "termsRegulations": "https://ey.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.pdf"
            },
            "quotas": [
              {
                "quota": 10,
                "capitalizationQuota": [
                  10
                ],
                "raffleQuota": [
                  10
                ],
                "chargingQuota": [
                  10
                ]
              }
            ],
            "validity": 48,
            "serieSize": 5000000,
            "capitalizationPeriod": {
              "interestRate": 0.25123,
              "updateIndex": [
                "IPCA"
              ],
              "others": [
                "Índice de atualização"
              ],
              "contributionAmount": {
                "minValue": 500,
                "maxValue": 5000,
                "frequency": "MENSAL",
                "value": 0
              },
              "earlyRedemption": [
                10
              ],
              "redemptionPercentageEndTerm": 100.002,
              "gracePeriodRedemption": 48
            },
            "latePayment": {
              "suspensionPeriod": 10,
              "termExtensionOption": true
            },
            "contributionPayment": {
              "paymentMethod": [
                "CARTAO_CREDITO"
              ],
              "updateIndex": [
                "IPCA"
              ],
              "others": [
                "Índice de atualização"
              ]
            },
            "redemption": {
              "redemption": 151.23
            },
            "raffle": {
              "raffleQty": 10000,
              "timeInterval": [
                "QUINZENAL"
              ],
              "raffleValue": 5,
              "earlySettlementRaffle": true,
              "mandatoryContemplation": true,
              "ruleDescription": "Sorteio às quartas-feiras",
              "minimumContemplationProbability": 0.000001
            },
            "additionalDetails": {
              "additionalDetails": "https://example.com/openinsurance"
            },
            "minimumRequirements": {
              "minimumRequirementDetails": "https://ey.exemplo/capitalizacao/tradicional/PU/requisitos_min",
              "targetAudiences": [
                "PESSOAL_NATURAL"
              ]
            }
          }
        ]
      }
    ]
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "first": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "prev": "string",
    "next": "string",
    "last": "https://api.organizacao.com.br/open-insurance/products-services/v1"
  },
  "meta": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Responses

Status Meaning Description Schema
200 OK Dados dos produtos de Título de Capitalização ResponseCapitalizationTitleList
400 Bad Request A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. ResponseError
401 Unauthorized Cabeçalho de autenticação ausente/inválido ou token inválido ResponseError
403 Forbidden O token tem escopo incorreto ou uma política de segurança foi violada ResponseError
404 Not Found O recurso solicitado não existe ou não foi implementado ResponseError
405 Method Not Allowed O consumidor tentou acessar o recurso com um método não suportado ResponseError
406 Not Acceptable A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8 ResponseError
429 Too Many Requests A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido ResponseError
500 Internal Server Error Ocorreu um erro no gateway da API ou no microsserviço ResponseError
default Default Dados dos produtos de Título de Capitalização ResponseCapitalizationTitleList

Schemas

ResponseLifePensionList

[
  {
    "identification": {
      "brand": "Brasilprev",
      "societyName": "Brasilprev Seguros e Previdência S.A",
      "cnpjNumber": "27665207000131"
    },
    "products": [
      {
        "name": "Brasilprev Private Multimercado 2020",
        "code": "1234",
        "segment": "PREVIDENCIA",
        "type": "PGBL",
        "modality": "CONTRIBUICAO_VARIAVEL",
        "optionalCoverage": "string",
        "productDetails": [
          {
            "susepProcessNumber": "15414.614141/2020-71",
            "contractTermsConditions": "https://example.com/mobilebanking",
            "defferalPeriod": {
              "interestRate": 0.25123,
              "updateIndex": "IPCA",
              "otherMinimumPerformanceGarantees": "SELIC",
              "reversalFinancialResults": 5.123,
              "minimumPremiumAmount": [
                {
                  "minimumPremiumAmountValue": 250,
                  "minimumPremiumAmountDescription": ""
                }
              ],
              "premiumPaymentMethod": [
                "CARTAO_CREDITO"
              ],
              "permissionExtraordinaryContributions": true,
              "permissonScheduledFinancialPayments": true,
              "gracePeriodRedemption": 100,
              "gracePeriodBetweenRedemptionRequests": 30,
              "redemptionPaymentTerm": 10,
              "gracePeriodPortability": 12,
              "gracePeriodBetweenPortabilityRequests": 15,
              "portabilityPaymentTerm": 20,
              "investimentFunds": [
                {
                  "cnpjNumber": "13.456.789/0001-12",
                  "companyName": "EYPREV",
                  "maximumAdministrationFee": 20.1,
                  "typePerformanceFee": [
                    "DIRETAMENTE"
                  ],
                  "maximumPerformanceFee": 20,
                  "eligibilityRule": true,
                  "minimumContributionAmount": 1000,
                  "minimumMathematicalProvisionAmount": 1000
                }
              ]
            },
            "grantPeriodBenefit": {
              "incomeModality": [
                "RENDA_VITALICIA"
              ],
              "biometricTable": [
                "AT_2000_FEMALE_SUAVIZADA_15"
              ],
              "interestRate": 3.225,
              "updateIndex": "IPCA",
              "reversalResultsFinancial": 13.252,
              "investimentFunds": [
                {
                  "cnpjNumber": "13.456.789/0001-12",
                  "companyName": "EYPREV",
                  "maximumAdministrationFee": 20.1,
                  "typePerformanceFee": [
                    "DIRETAMENTE"
                  ],
                  "maximumPerformanceFee": 20,
                  "eligibilityRule": true,
                  "minimumContributionAmount": 1000,
                  "minimumMathematicalProvisionAmount": 1000
                }
              ]
            },
            "costs": {
              "loadingAntecipated": {
                "minValue": 4.122,
                "maxValue": 10
              },
              "loadingLate": {
                "minValue": 4.122,
                "maxValue": 10
              }
            }
          }
        ],
        "minimumRequirements": {
          "contractType": "INDIVIDUAL",
          "participantQualified": true,
          "minRequirementsContract": "https://example.com/mobile-banking"
        },
        "targetAudience": "PESSOA_NATURAL"
      }
    ],
    "links": {
      "self": "https://api.organizacao.com.br/open-insurance/products-services/v1",
      "first": "https://api.organizacao.com.br/open-insurance/products-services/v1",
      "prev": "string",
      "next": "string",
      "last": "https://api.organizacao.com.br/open-insurance/products-services/v1"
    },
    "meta": {
      "totalRecords": 10,
      "totalPages": 1
    }
  }
]

Properties

Name Type Required Restrictions Description
identification LifePensionIdentification true none Organização controladora do grupo.
products LifePensionProduct true none none
links LinksPaginated true none none
meta MetaPaginated true none none

LifePensionIdentification

{
  "brand": "Brasilprev",
  "societyName": "Brasilprev Seguros e Previdência S.A",
  "cnpjNumber": "27665207000131"
}

Organização controladora do grupo.

Properties

Name Type Required Restrictions Description
brand string true none Nome da marca reportada pelo participante do Open Insurance. O conceito a que se refere a marca é em essência uma promessa das sociedades sob ela em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
societyName string true none Nome da sociedade pertencente à marca.
cnpjNumber string true none CNPJ da sociedade pertencente à marca.

LifePensionProduct

[
  {
    "name": "Brasilprev Private Multimercado 2020",
    "code": "1234",
    "segment": "PREVIDENCIA",
    "type": "PGBL",
    "modality": "CONTRIBUICAO_VARIAVEL",
    "optionalCoverage": "string",
    "productDetails": [
      {
        "susepProcessNumber": "15414.614141/2020-71",
        "contractTermsConditions": "https://example.com/mobilebanking",
        "defferalPeriod": {
          "interestRate": 0.25123,
          "updateIndex": "IPCA",
          "otherMinimumPerformanceGarantees": "SELIC",
          "reversalFinancialResults": 5.123,
          "minimumPremiumAmount": [
            {
              "minimumPremiumAmountValue": 250,
              "minimumPremiumAmountDescription": ""
            }
          ],
          "premiumPaymentMethod": [
            "CARTAO_CREDITO"
          ],
          "permissionExtraordinaryContributions": true,
          "permissonScheduledFinancialPayments": true,
          "gracePeriodRedemption": 100,
          "gracePeriodBetweenRedemptionRequests": 30,
          "redemptionPaymentTerm": 10,
          "gracePeriodPortability": 12,
          "gracePeriodBetweenPortabilityRequests": 15,
          "portabilityPaymentTerm": 20,
          "investimentFunds": [
            {
              "cnpjNumber": "13.456.789/0001-12",
              "companyName": "EYPREV",
              "maximumAdministrationFee": 20.1,
              "typePerformanceFee": [
                "DIRETAMENTE"
              ],
              "maximumPerformanceFee": 20,
              "eligibilityRule": true,
              "minimumContributionAmount": 1000,
              "minimumMathematicalProvisionAmount": 1000
            }
          ]
        },
        "grantPeriodBenefit": {
          "incomeModality": [
            "RENDA_VITALICIA"
          ],
          "biometricTable": [
            "AT_2000_FEMALE_SUAVIZADA_15"
          ],
          "interestRate": 3.225,
          "updateIndex": "IPCA",
          "reversalResultsFinancial": 13.252,
          "investimentFunds": [
            {
              "cnpjNumber": "13.456.789/0001-12",
              "companyName": "EYPREV",
              "maximumAdministrationFee": 20.1,
              "typePerformanceFee": [
                "DIRETAMENTE"
              ],
              "maximumPerformanceFee": 20,
              "eligibilityRule": true,
              "minimumContributionAmount": 1000,
              "minimumMathematicalProvisionAmount": 1000
            }
          ]
        },
        "costs": {
          "loadingAntecipated": {
            "minValue": 4.122,
            "maxValue": 10
          },
          "loadingLate": {
            "minValue": 4.122,
            "maxValue": 10
          }
        }
      }
    ],
    "minimumRequirements": {
      "contractType": "INDIVIDUAL",
      "participantQualified": true,
      "minRequirementsContract": "https://example.com/mobile-banking"
    },
    "targetAudience": "PESSOA_NATURAL"
  }
]

Properties

Name Type Required Restrictions Description
name string true none Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code string true none Código único a ser definido pela sociedade.
segment string true none Segmento do qual se trata o produto contratado.
type string false none Tipo do produto contratado.
modality string true none Modalidade do produto contratado.
optionalCoverage string false none Campo aberto (possibilidade de incluir URL).
productDetails LifePensionProductDetails false none none
minimumRequirements LifePensionMinimumRequirements true none none
targetAudience string true none Público-alvo.

Enumerated Values

Property Value
segment SEGURO_PESSOAS
segment PREVIDENCIA
type PGBL
type PRGP
type PAGP
type PRSA
type PRI
type PDR
type VGBL
type VRGP
type VAGP
type VRSA
type VRI
type VDR
type DEMAIS_PRODUTOS_PREVIDENCIA
modality CONTRIBUICAO_VARIAVEL
modality BENEFICIO_DEFINIDO
targetAudience PESSOA_NATURAL
targetAudience PESSOA_JURIDICA

LifePensionProductDetails

[
  {
    "susepProcessNumber": "15414.614141/2020-71",
    "contractTermsConditions": "https://example.com/mobilebanking",
    "defferalPeriod": {
      "interestRate": 0.25123,
      "updateIndex": "IPCA",
      "otherMinimumPerformanceGarantees": "SELIC",
      "reversalFinancialResults": 5.123,
      "minimumPremiumAmount": [
        {
          "minimumPremiumAmountValue": 250,
          "minimumPremiumAmountDescription": ""
        }
      ],
      "premiumPaymentMethod": [
        "CARTAO_CREDITO"
      ],
      "permissionExtraordinaryContributions": true,
      "permissonScheduledFinancialPayments": true,
      "gracePeriodRedemption": 100,
      "gracePeriodBetweenRedemptionRequests": 30,
      "redemptionPaymentTerm": 10,
      "gracePeriodPortability": 12,
      "gracePeriodBetweenPortabilityRequests": 15,
      "portabilityPaymentTerm": 20,
      "investimentFunds": [
        {
          "cnpjNumber": "13.456.789/0001-12",
          "companyName": "EYPREV",
          "maximumAdministrationFee": 20.1,
          "typePerformanceFee": [
            "DIRETAMENTE"
          ],
          "maximumPerformanceFee": 20,
          "eligibilityRule": true,
          "minimumContributionAmount": 1000,
          "minimumMathematicalProvisionAmount": 1000
        }
      ]
    },
    "grantPeriodBenefit": {
      "incomeModality": [
        "RENDA_VITALICIA"
      ],
      "biometricTable": [
        "AT_2000_FEMALE_SUAVIZADA_15"
      ],
      "interestRate": 3.225,
      "updateIndex": "IPCA",
      "reversalResultsFinancial": 13.252,
      "investimentFunds": [
        {
          "cnpjNumber": "13.456.789/0001-12",
          "companyName": "EYPREV",
          "maximumAdministrationFee": 20.1,
          "typePerformanceFee": [
            "DIRETAMENTE"
          ],
          "maximumPerformanceFee": 20,
          "eligibilityRule": true,
          "minimumContributionAmount": 1000,
          "minimumMathematicalProvisionAmount": 1000
        }
      ]
    },
    "costs": {
      "loadingAntecipated": {
        "minValue": 4.122,
        "maxValue": 10
      },
      "loadingLate": {
        "minValue": 4.122,
        "maxValue": 10
      }
    }
  }
]

Properties

Name Type Required Restrictions Description
susepProcessNumber string true none Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais.
contractTermsConditions string true none Campo aberto (possibilidade de incluir URL).
defferalPeriod LifePensionDefferalPeriod true none none
grantPeriodBenefit LifePensionPeriodGrantBenefit true none none
costs LifePensionCosts true none none

LifePensionDefferalPeriod

{
  "interestRate": 0.25123,
  "updateIndex": "IPCA",
  "otherMinimumPerformanceGarantees": "SELIC",
  "reversalFinancialResults": 5.123,
  "minimumPremiumAmount": [
    {
      "minimumPremiumAmountValue": 250,
      "minimumPremiumAmountDescription": ""
    }
  ],
  "premiumPaymentMethod": [
    "CARTAO_CREDITO"
  ],
  "permissionExtraordinaryContributions": true,
  "permissonScheduledFinancialPayments": true,
  "gracePeriodRedemption": 100,
  "gracePeriodBetweenRedemptionRequests": 30,
  "redemptionPaymentTerm": 10,
  "gracePeriodPortability": 12,
  "gracePeriodBetweenPortabilityRequests": 15,
  "portabilityPaymentTerm": 20,
  "investimentFunds": [
    {
      "cnpjNumber": "13.456.789/0001-12",
      "companyName": "EYPREV",
      "maximumAdministrationFee": 20.1,
      "typePerformanceFee": [
        "DIRETAMENTE"
      ],
      "maximumPerformanceFee": 20,
      "eligibilityRule": true,
      "minimumContributionAmount": 1000,
      "minimumMathematicalProvisionAmount": 1000
    }
  ]
}

Properties

Name Type Required Restrictions Description
interestRate number true none Taxa de juros garantida que remunera o plano durante a fase de diferimento/acumulação.
updateIndex string true none Indice garantido que remunera o plano durante a fase de diferimento/ acumulação.
otherMinimumPerformanceGarantees string true none Para produtos do tipo PDR e VDR, indicação do percentual e do índice de ampla divulgação utilizados como garantia mínima de desempenho. Em %.
reversalFinancialResults number true none Percentual de reversão de excedente financeiro no período de diferimento.
minimumPremiumAmount [object] true none none
» minimumPremiumAmountValue number false none Valor
» minimumPremiumAmountDescription string false none Descrição Período.
premiumPaymentMethod [string] false none none
permissionExtraordinaryContributions boolean false none Se ficam permitidos aportes extraordinários.
permissonScheduledFinancialPayments boolean true none Se ficam permitidos pagamentos financeiros programados.
gracePeriodRedemption integer true none Prazo em dias de carência para resgate.
gracePeriodBetweenRedemptionRequests integer true none Prazo em dias de carência entre pedidos de resgate.
redemptionPaymentTerm integer true none Prazo em dias para pagamento do resgate.
gracePeriodPortability integer true none Prazo em dias de carência para portabilidade.
gracePeriodBetweenPortabilityRequests integer true none Prazo em dias de carência entre pedidos de portabilidade.
portabilityPaymentTerm integer true none Prazo em dias para pagamento da portabilidade.
investimentFunds LifePensionInvestmentFunds true none Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação.

Enumerated Values

Property Value
updateIndex IPCA
updateIndex IGP-M
updateIndex INPC

LifePensionInvestmentFunds

[
  {
    "cnpjNumber": "13.456.789/0001-12",
    "companyName": "EYPREV",
    "maximumAdministrationFee": 20.1,
    "typePerformanceFee": [
      "DIRETAMENTE"
    ],
    "maximumPerformanceFee": 20,
    "eligibilityRule": true,
    "minimumContributionAmount": 1000,
    "minimumMathematicalProvisionAmount": 1000
  }
]

Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação.

Properties

Name Type Required Restrictions Description
cnpjNumber string true none Número de CNPJ.
companyName string true none Nome Fantasia.
maximumAdministrationFee number true none Taxa Máxima de Administração – em %.
typePerformanceFee [string] true none none
maximumPerformanceFee number false none Taxa Máxima de Performance. Caso o Tipo de Taxa de Performance seja ‘Diretamente’.
eligibilityRule boolean true none Regra de Eligibilidade.
minimumContributionAmount number true none Valor Mínimo de Contribuição. Regra de Elegibilidade. Caso a Regra de Elegibilidade SIM.
minimumMathematicalProvisionAmount number true none Valor Mínimo Provisão Matemática. Caso a Regra de Elegibilidade SIM.

LifePensionPeriodGrantBenefit

{
  "incomeModality": [
    "RENDA_VITALICIA"
  ],
  "biometricTable": [
    "AT_2000_FEMALE_SUAVIZADA_15"
  ],
  "interestRate": 3.225,
  "updateIndex": "IPCA",
  "reversalResultsFinancial": 13.252,
  "investimentFunds": [
    {
      "cnpjNumber": "13.456.789/0001-12",
      "companyName": "EYPREV",
      "maximumAdministrationFee": 20.1,
      "typePerformanceFee": [
        "DIRETAMENTE"
      ],
      "maximumPerformanceFee": 20,
      "eligibilityRule": true,
      "minimumContributionAmount": 1000,
      "minimumMathematicalProvisionAmount": 1000
    }
  ]
}

Properties

Name Type Required Restrictions Description
incomeModality [string] true none none
biometricTable [string] true none none
interestRate number true none Taxa de juros garantida utilizada para conversão em renda. Em %.
updateIndex string true none É o índice contratado para atualização monetária dos valores relativos ao plano, na forma estabelecida por este regulamento.
reversalResultsFinancial number true none Percentual de reversão de excedente financeiro na concessão. Em %.
investimentFunds LifePensionInvestmentFunds true none Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação.

Enumerated Values

Property Value
updateIndex IPCA
updateIndex IGP-M
updateIndex INPC

LifePensionCosts

{
  "loadingAntecipated": {
    "minValue": 4.122,
    "maxValue": 10
  },
  "loadingLate": {
    "minValue": 4.122,
    "maxValue": 10
  }
}

Properties

Name Type Required Restrictions Description
loadingAntecipated LifePensionLoading true none none
loadingLate LifePensionLoading true none none

LifePensionLoading

{
  "minValue": 4.122,
  "maxValue": 10
}

Properties

Name Type Required Restrictions Description
minValue number true none Valor mínimo em %.
maxValue number true none alor máximo em %.

LifePensionMinimumRequirements

{
  "contractType": "INDIVIDUAL",
  "participantQualified": true,
  "minRequirementsContract": "https://example.com/mobile-banking"
}

Properties

Name Type Required Restrictions Description
contractType string true none O tipo de serviço contratado.
participantQualified boolean true none Indicação se o plano é destinado para participante qualificado.
minRequirementsContract string true none Campo aberto contendo todos os requisitos mínimos para contratação (possibilidade de incluir URL).

Enumerated Values

Property Value
contractType COLETIVO_AVERBADO
contractType COLETIVO_INSTITUIDO
contractType INDIVIDUAL

LinksPaginated

{
  "self": "https://api.organizacao.com.br/open-insurance/products-services/v1",
  "first": "https://api.organizacao.com.br/open-insurance/products-services/v1",
  "prev": "string",
  "next": "string",
  "last": "https://api.organizacao.com.br/open-insurance/products-services/v1"
}

Properties

Name Type Required Restrictions Description
self string false none URL da página atualmente requisitada
first string false none URL da primeira página de registros
prev string false none URL da página anterior de registros
next string false none URL da próxima página de registros
last string false none URL da última página de registros

MetaPaginated

{
  "totalRecords": 10,
  "totalPages": 1
}

Properties

Name Type Required Restrictions Description
totalRecords integer true none Total de registros encontrados
totalPages integer true none Total de páginas para os registros encontrados

ResponseError

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "requestDateTime": "2021-08-20T08:30:00Z"
    }
  ],
  "meta": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Properties

Name Type Required Restrictions Description
errors [object] true none none
» code string true none Código de erro específico do endpoint
» title string true none Título legível por humanos deste erro específico
» detail string true none Descrição legível por humanos deste erro específico
» requestDateTime string(date-time) true none Data e hora da consulta, conforme especificação RFC-3339, formato UTC.
meta MetaPaginated false none none

ResponsePersonList

{
  "data": {
    "brand": {
      "name": "Marca",
      "companies": [
        {
          "name": "Seguradora",
          "cnpjNumber": 45086338000178,
          "products": [
            {
              "name": "Seguro Pessoal",
              "code": "123456789_cap",
              "category": "TRADICIONAL",
              "insuranceModality": "FUNERAL",
              "coverages": [
                {
                  "coverage": "AUXILIO_CESTA_BASICA",
                  "coverageOthers": [
                    "string"
                  ],
                  "coverageAttributes": {
                    "indemnityPaymentMethod": [],
                    "indemnityPaymentFrequency": [],
                    "minValue": {},
                    "maxValue": {},
                    "indemnifiablePeriod": [],
                    "maximumQtyIndemnifiableInstallments": 0,
                    "currency": "BRL",
                    "gracePeriod": {},
                    "differentiatedGracePeriod": {},
                    "deductibleDays": 0,
                    "differentiatedDeductibleDays": 0,
                    "deductibleBRL": 0,
                    "differentiatedDeductibleBRL": "string",
                    "excludedRisks": [],
                    "excludedRisksURL": "string",
                    "allowApartPurchase": true
                  }
                }
              ],
              "assistanceType": [
                "ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA"
              ],
              "additional": [
                "SORTEIO"
              ],
              "assistanceTypeOthers": [
                "string"
              ],
              "termsAndConditions": [
                {
                  "susepProcessNumber": "string",
                  "definition": "string"
                }
              ],
              "globalCapital": true,
              "validity": [
                "VITALICIA"
              ],
              "pmbacRemuneration": {
                "interestRate": 0,
                "pmbacUpdateIndex": "IPCA"
              },
              "benefitRecalculation": {
                "benefitRecalculationCriteria": "INDICE",
                "benefitUpdateIndex": "IPCA"
              },
              "ageAdjustment": {
                "criterion": "APOS_PERIODO_EM_ANOS",
                "frequency": 0
              },
              "contractType": "REPARTICAO_SIMPLES",
              "reclaim": {
                "reclaimTable": [
                  {
                    "initialMonthRange": 1,
                    "finalMonthRange": 12,
                    "percentage": 0
                  }
                ],
                "differentiatedPercentage": "string",
                "gracePeriod": {
                  "amount": 60,
                  "unit": "DIAS"
                }
              },
              "otherGuaranteedValues": "SALDAMENTO",
              "allowPortability": true,
              "portabilityGraceTime": 0,
              "indemnityPaymentMethod": [
                "UNICO"
              ],
              "indemnityPaymentIncome": [
                "CERTA"
              ],
              "premiumPayment": {
                "paymentMethod": [
                  "CARTAO_CREDITO"
                ],
                "frequency": [
                  "DIARIA"
                ],
                "premiumTax": "string"
              },
              "minimunRequirements": {
                "contractingType": "COLETIVO",
                "contractingMinRequirement": "string"
              },
              "targetAudience": "PESSOA_NATURAL"
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "first": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "prev": "string",
    "next": "string",
    "last": "https://api.organizacao.com.br/open-insurance/products-services/v1"
  },
  "meta": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Properties

Name Type Required Restrictions Description
data object true none none
» brand PersonBrand true none Organização controladora do grupo.
links LinksPaginated true none none
meta MetaPaginated true none none

PersonBrand

{
  "name": "Marca",
  "companies": [
    {
      "name": "Seguradora",
      "cnpjNumber": 45086338000178,
      "products": [
        {
          "name": "Seguro Pessoal",
          "code": "123456789_cap",
          "category": "TRADICIONAL",
          "insuranceModality": "FUNERAL",
          "coverages": [
            {
              "coverage": "AUXILIO_CESTA_BASICA",
              "coverageOthers": [
                "string"
              ],
              "coverageAttributes": {
                "indemnityPaymentMethod": [
                  "PAGAMENTO_CAPITAL_SEGURADO_VALOR_MONETARIO"
                ],
                "indemnityPaymentFrequency": [
                  "INDENIZACAO_UNICA"
                ],
                "minValue": {},
                "maxValue": {},
                "indemnifiablePeriod": [
                  "ATE_FIM_CICLO_DETERMINADO"
                ],
                "maximumQtyIndemnifiableInstallments": 0,
                "currency": "BRL",
                "gracePeriod": {
                  "amount": 60,
                  "unit": "DIAS"
                },
                "differentiatedGracePeriod": {
                  "amount": 60,
                  "unit": "DIAS"
                },
                "deductibleDays": 0,
                "differentiatedDeductibleDays": 0,
                "deductibleBRL": 0,
                "differentiatedDeductibleBRL": "string",
                "excludedRisks": [
                  "ATO_RECONHECIMENTO_PERIGOSO"
                ],
                "excludedRisksURL": "string",
                "allowApartPurchase": true
              }
            }
          ],
          "assistanceType": [
            "ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA"
          ],
          "additional": [
            "SORTEIO"
          ],
          "assistanceTypeOthers": [
            "string"
          ],
          "termsAndConditions": [
            {
              "susepProcessNumber": "string",
              "definition": "string"
            }
          ],
          "globalCapital": true,
          "validity": [
            "VITALICIA"
          ],
          "pmbacRemuneration": {
            "interestRate": 0,
            "pmbacUpdateIndex": "IPCA"
          },
          "benefitRecalculation": {
            "benefitRecalculationCriteria": "INDICE",
            "benefitUpdateIndex": "IPCA"
          },
          "ageAdjustment": {
            "criterion": "APOS_PERIODO_EM_ANOS",
            "frequency": 0
          },
          "contractType": "REPARTICAO_SIMPLES",
          "reclaim": {
            "reclaimTable": [
              {
                "initialMonthRange": 1,
                "finalMonthRange": 12,
                "percentage": 0
              }
            ],
            "differentiatedPercentage": "string",
            "gracePeriod": {
              "amount": 60,
              "unit": "DIAS"
            }
          },
          "otherGuaranteedValues": "SALDAMENTO",
          "allowPortability": true,
          "portabilityGraceTime": 0,
          "indemnityPaymentMethod": [
            "UNICO"
          ],
          "indemnityPaymentIncome": [
            "CERTA"
          ],
          "premiumPayment": {
            "paymentMethod": [
              "CARTAO_CREDITO"
            ],
            "frequency": [
              "DIARIA"
            ],
            "premiumTax": "string"
          },
          "minimunRequirements": {
            "contractingType": "COLETIVO",
            "contractingMinRequirement": "string"
          },
          "targetAudience": "PESSOA_NATURAL"
        }
      ]
    }
  ]
}

Organização controladora do grupo.

Properties

Name Type Required Restrictions Description
name string true none Nome da marca reportada pelo participante do Open Insurance. O conceito a que se refere a marca é em essência uma promessa das sociedades sob ela em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
companies PersonCompany true none none

PersonCompany

[
  {
    "name": "Seguradora",
    "cnpjNumber": 45086338000178,
    "products": [
      {
        "name": "Seguro Pessoal",
        "code": "123456789_cap",
        "category": "TRADICIONAL",
        "insuranceModality": "FUNERAL",
        "coverages": [
          {
            "coverage": "AUXILIO_CESTA_BASICA",
            "coverageOthers": [
              "string"
            ],
            "coverageAttributes": {
              "indemnityPaymentMethod": [
                "PAGAMENTO_CAPITAL_SEGURADO_VALOR_MONETARIO"
              ],
              "indemnityPaymentFrequency": [
                "INDENIZACAO_UNICA"
              ],
              "minValue": {},
              "maxValue": {},
              "indemnifiablePeriod": [
                "ATE_FIM_CICLO_DETERMINADO"
              ],
              "maximumQtyIndemnifiableInstallments": 0,
              "currency": "BRL",
              "gracePeriod": {
                "amount": 60,
                "unit": "DIAS"
              },
              "differentiatedGracePeriod": {
                "amount": 60,
                "unit": "DIAS"
              },
              "deductibleDays": 0,
              "differentiatedDeductibleDays": 0,
              "deductibleBRL": 0,
              "differentiatedDeductibleBRL": "string",
              "excludedRisks": [
                "ATO_RECONHECIMENTO_PERIGOSO"
              ],
              "excludedRisksURL": "string",
              "allowApartPurchase": true
            }
          }
        ],
        "assistanceType": [
          "ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA"
        ],
        "additional": [
          "SORTEIO"
        ],
        "assistanceTypeOthers": [
          "string"
        ],
        "termsAndConditions": [
          {
            "susepProcessNumber": "string",
            "definition": "string"
          }
        ],
        "globalCapital": true,
        "validity": [
          "VITALICIA"
        ],
        "pmbacRemuneration": {
          "interestRate": 0,
          "pmbacUpdateIndex": "IPCA"
        },
        "benefitRecalculation": {
          "benefitRecalculationCriteria": "INDICE",
          "benefitUpdateIndex": "IPCA"
        },
        "ageAdjustment": {
          "criterion": "APOS_PERIODO_EM_ANOS",
          "frequency": 0
        },
        "contractType": "REPARTICAO_SIMPLES",
        "reclaim": {
          "reclaimTable": [
            {
              "initialMonthRange": 1,
              "finalMonthRange": 12,
              "percentage": 0
            }
          ],
          "differentiatedPercentage": "string",
          "gracePeriod": {
            "amount": 60,
            "unit": "DIAS"
          }
        },
        "otherGuaranteedValues": "SALDAMENTO",
        "allowPortability": true,
        "portabilityGraceTime": 0,
        "indemnityPaymentMethod": [
          "UNICO"
        ],
        "indemnityPaymentIncome": [
          "CERTA"
        ],
        "premiumPayment": {
          "paymentMethod": [
            "CARTAO_CREDITO"
          ],
          "frequency": [
            "DIARIA"
          ],
          "premiumTax": "string"
        },
        "minimunRequirements": {
          "contractingType": "COLETIVO",
          "contractingMinRequirement": "string"
        },
        "targetAudience": "PESSOA_NATURAL"
      }
    ]
  }
]

Properties

Name Type Required Restrictions Description
name string true none Nome da sociedade pertencente à marca.
cnpjNumber string true none CNPJ da sociedade pertencente à marca.
products PersonProducts false none Lista de Dependências de uma Instituição.

PersonProducts

[
  {
    "name": "Seguro Pessoal",
    "code": "123456789_cap",
    "category": "TRADICIONAL",
    "insuranceModality": "FUNERAL",
    "coverages": [
      {
        "coverage": "AUXILIO_CESTA_BASICA",
        "coverageOthers": [
          "string"
        ],
        "coverageAttributes": {
          "indemnityPaymentMethod": [
            "PAGAMENTO_CAPITAL_SEGURADO_VALOR_MONETARIO"
          ],
          "indemnityPaymentFrequency": [
            "INDENIZACAO_UNICA"
          ],
          "minValue": {},
          "maxValue": {},
          "indemnifiablePeriod": [
            "ATE_FIM_CICLO_DETERMINADO"
          ],
          "maximumQtyIndemnifiableInstallments": 0,
          "currency": "BRL",
          "gracePeriod": {
            "amount": 60,
            "unit": "DIAS"
          },
          "differentiatedGracePeriod": {
            "amount": 60,
            "unit": "DIAS"
          },
          "deductibleDays": 0,
          "differentiatedDeductibleDays": 0,
          "deductibleBRL": 0,
          "differentiatedDeductibleBRL": "string",
          "excludedRisks": [
            "ATO_RECONHECIMENTO_PERIGOSO"
          ],
          "excludedRisksURL": "string",
          "allowApartPurchase": true
        }
      }
    ],
    "assistanceType": [
      "ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA"
    ],
    "additional": [
      "SORTEIO"
    ],
    "assistanceTypeOthers": [
      "string"
    ],
    "termsAndConditions": [
      {
        "susepProcessNumber": "string",
        "definition": "string"
      }
    ],
    "globalCapital": true,
    "validity": [
      "VITALICIA"
    ],
    "pmbacRemuneration": {
      "interestRate": 0,
      "pmbacUpdateIndex": "IPCA"
    },
    "benefitRecalculation": {
      "benefitRecalculationCriteria": "INDICE",
      "benefitUpdateIndex": "IPCA"
    },
    "ageAdjustment": {
      "criterion": "APOS_PERIODO_EM_ANOS",
      "frequency": 0
    },
    "contractType": "REPARTICAO_SIMPLES",
    "reclaim": {
      "reclaimTable": [
        {
          "initialMonthRange": 1,
          "finalMonthRange": 12,
          "percentage": 0
        }
      ],
      "differentiatedPercentage": "string",
      "gracePeriod": {
        "amount": 60,
        "unit": "DIAS"
      }
    },
    "otherGuaranteedValues": "SALDAMENTO",
    "allowPortability": true,
    "portabilityGraceTime": 0,
    "indemnityPaymentMethod": [
      "UNICO"
    ],
    "indemnityPaymentIncome": [
      "CERTA"
    ],
    "premiumPayment": {
      "paymentMethod": [
        "CARTAO_CREDITO"
      ],
      "frequency": [
        "DIARIA"
      ],
      "premiumTax": "string"
    },
    "minimunRequirements": {
      "contractingType": "COLETIVO",
      "contractingMinRequirement": "string"
    },
    "targetAudience": "PESSOA_NATURAL"
  }
]

Lista de Dependências de uma Instituição.

Properties

Name Type Required Restrictions Description
name string true none Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code string true none Código único a ser definido pela sociedade (código interno do produto) a critério da participante.
category string true none Indica a categoria do Produto
insuranceModality string true none none
coverages [object] true none none
» coverage string false none none
» coverageOthers [string] false none none
» coverageAttributes PersonCoverageAttributes false none none
assistanceType [string] false none Listagem dos serviços de assistências complementares disponíveis vinculados ao produto. Deve ser padronizada na proposta técnica submetida pela Estrutura Inicial de Governança para observância comum por todas as sociedades participantes
additional [string] true none none
assistanceTypeOthers [string] false none none
termsAndConditions [PersonTermsAndCondition] true none none
globalCapital boolean true none Seguro de pessoas com capital global modalidade de contratação coletiva da cobertura de risco, respeitados os critérios técnico-operacionais, forma e limites fixados pela SUSEP, segundo a qual o valor do capital segurado referente a cada componente sofrerá variações decorrentes de mudanças na composição do grupo segurado
validity [string] true none none
pmbacRemuneration PersonPmbacRemuneration false none none
benefitRecalculation PersonBenefitRecalculation false none none
ageAdjustment PersonAgeAdjustment false none none
contractType string true none Regime Financeiro
reclaim PersonReclaim false none none
otherGuaranteedValues string true none none
allowPortability boolean true none Permite Portabilidade
portabilityGraceTime integer true none Prazo de carência em dias para Portabilidade
indemnityPaymentMethod [string] true none none
indemnityPaymentIncome [string] true none none
premiumPayment PersonPremiumPayment false none none
minimunRequirements PersonMinimumRequirements false none none
targetAudience string true none none

Enumerated Values

Property Value
category TRADICIONAL
category MICROSEGURO
insuranceModality FUNERAL
insuranceModality PRESTAMISTA
insuranceModality VIAGEM
insuranceModality EDUCACIONAL
insuranceModality DOTAL
insuranceModality ACIDENTES_PESSOAIS
insuranceModality VIDA
insuranceModality PERDA_CERTIFICADO_HABILITACAOO_VOO
insuranceModality DOENCAS_GRAVES_DOENCA_TERMINAL
insuranceModality DESEMPREGO_PERDA_RENDA
insuranceModality EVENTOS_ALEATORIOS
coverage ADIANTAMENTO_DOENCA_ESTAGIO_TERMINAL
coverage AUXILIO_CESTA_BASICA
coverage AUXILIO_FINANCEIRO_IMEDIATO
coverage CANCELAMENTO_DE_VIAGEM
coverage CIRURGIA
coverage COBERTURA_PARA_HERNIA
coverage COBERTURA_PARA_LER_DORT
coverage CUIDADOS_PROLONGADOS_ACIDENTE
coverage DESEMPREGO_PERDA_DE_RENDA
coverage DESPESAS_EXTRA_INVALIDEZ_PERMANENTE_TOTAL_PARCIAL_ACIDENTE_DEI
coverage DESPESAS_EXTRA_MORTE_DEM
coverage DESPESAS_MEDICAS_HOSPITALARES_ODONTOLOGICAS
coverage DESPESAS_MEDICAS_HOSPITALARES_ODONTOLOGICAS_BRASIL
coverage DESPESAS_MEDICAS_HOSPITALARES_ODONTOLOGICAS_EXTERIOR
coverage DIARIA_INCAPACIDADE_TOTAL_TEMPORARIA
coverage DIARIA_INTERNACAO_HOSPITALAR
coverage INTERNACAO_HOSPITALAR
coverage DIARIAS_INCAPACIDADE_PECUNIARIA_DIP
coverage DOENCA_GRAVE
coverage DOENCA_CONGENITA_FILHOS_DCF
coverage FRATURA_OSSEA
coverage DOENCAS_TROPICAIS
coverage INCAPACIDADE_TOTAL_OU_TEMPORARIA
coverage INVALIDEZ_PERMANENTE_TOTAL_PARCIAL
coverage INVALIDEZ_TOTAL_ACIDENTE
coverage INVALIDEZ_PARCIAL_ACIDENTE
coverage INVALIDEZ_FUNCIONAL_PERMANENTE_DOENCA
coverage INVALIDEZ_LABORATIVA_DOENCA
coverage MORTE
coverage MORTE_ACIDENTAL
coverage MORTE_CONJUGE
coverage MORTE_FILHOS
coverage MORTE_ADIATAMENTO_DOENCA_ESTAGIO_TERMINAL
coverage PAGAMENTO_ANTECIPADO_ESPECIAL_DOENCA_PROFISSIONAL_PAED
coverage PERDA_DA_AUTONOMIA_PESSOAL
coverage PERDA_INVOLUNTARIA_EMPREGO
coverage QUEIMADURA_GRAVE
coverage REGRESSO_ANTECIPADO_SANITARIO
coverage RENDA_INCAPACIDADE_TEMPORARIA
coverage RESCISAO_CONTRATUAL_CASO_MORTE_RCM
coverage RESCISAO_TRABALHISTA
coverage SERVICO_AUXILIO_FUNERAL
coverage SOBREVIVENCIA
coverage TRANSPLANTE_ORGAOS
coverage TRANSLADO
coverage TRANSLADO_MEDICO
coverage TRANSLADO_CORPO
coverage VERBA_RESCISORIA
coverage OUTRAS
contractType REPARTICAO_SIMPLES
contractType REPARTICAO_CAPITAIS
contractType CAPITALIZACAO
otherGuaranteedValues SALDAMENTO
otherGuaranteedValues BENEFICIO_PROLONGADO
otherGuaranteedValues NAO_SE_APLICA
targetAudience PESSOA_NATURAL
targetAudience PESSOA_JURIDICA

PersonTermsAndCondition

{
  "susepProcessNumber": "string",
  "definition": "string"
}

Properties

Name Type Required Restrictions Description
susepProcessNumber string true none Número do processo Susep.
definition string true none Campo aberto (possibilidade de incluir URL).

PersonCoverageAttibutesDetailsUnit

{
  "code": "R$",
  "description": "description"
}

Properties

Name Type Required Restrictions Description
code string true none Tipo unidade de medida.
description string true none Descrição da unidade de medida

PersonCoverageAttibutesDetails

{
  "amount": 60,
  "unit": {
    "code": "R$",
    "description": "description"
  }
}

Properties

Name Type Required Restrictions Description
amount number true none Valor.
unit PersonCoverageAttibutesDetailsUnit true none none

PersonGracePeriodUnit

{
  "amount": 60,
  "unit": "DIAS"
}

Período de carência

Properties

Name Type Required Restrictions Description
amount number false none Prazo de Carência
unit string false none Unidade do prazo (dias ou meses).

Enumerated Values

Property Value
unit DIAS
unit MESES
unit NAO_SE_APLICA

personPortabilityGraceTime

{
  "amount": 60,
  "unit": "DIAS"
}

Prazo de carência em dias para Portabilidade

Properties

Name Type Required Restrictions Description
amount number false none Prazo de Carência
unit string false none Unidade do prazo (dias ou meses).

Enumerated Values

Property Value
unit DIAS
unit MESES
unit NAO_SE_APLICA

PersonCoverageAttributes

{
  "indemnityPaymentMethod": [
    "PAGAMENTO_CAPITAL_SEGURADO_VALOR_MONETARIO"
  ],
  "indemnityPaymentFrequency": [
    "INDENIZACAO_UNICA"
  ],
  "minValue": {},
  "maxValue": {},
  "indemnifiablePeriod": [
    "ATE_FIM_CICLO_DETERMINADO"
  ],
  "maximumQtyIndemnifiableInstallments": 0,
  "currency": "BRL",
  "gracePeriod": {
    "amount": 60,
    "unit": "DIAS"
  },
  "differentiatedGracePeriod": {
    "amount": 60,
    "unit": "DIAS"
  },
  "deductibleDays": 0,
  "differentiatedDeductibleDays": 0,
  "deductibleBRL": 0,
  "differentiatedDeductibleBRL": "string",
  "excludedRisks": [
    "ATO_RECONHECIMENTO_PERIGOSO"
  ],
  "excludedRisksURL": "string",
  "allowApartPurchase": true
}

Properties

Name Type Required Restrictions Description
indemnityPaymentMethod [string] true none Listagem da forma de pagamento da indenização para cada combinação de modalidade/cobertura do produto
indemnityPaymentFrequency [string] true none Listagem de tipos de frequência de pagamento de indenização para cada combinação de modalidade/cobertura do produto
minValue object true none Listagem do valor mínimo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto. Em reais
maxValue object true none Listagem do valor máximo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto. Em reais
indemnifiablePeriod [string] true none Listagem de período indenizável para cada combinação de modalidade/cobertura do produto
maximumQtyIndemnifiableInstallments integer true none Caso o período indenizável seja relacionado a parcelas, listagem de número máximo de parcelas indenizáveis para cada combinação de modalidade/ cobertura do produto
currency string true none Moeda sobre a qual a cobertura se refere. De acordo com ISO-4217.
gracePeriod PersonGracePeriodUnit true none Período de carência
differentiatedGracePeriod PersonGracePeriodUnit false none Detalhamento do período de carência diferentes para cada cobertura que exista alguma especificidade. Caso a seguradora não tenha essa diferenciação, não retornará nada no campo
deductibleDays integer true none Listagem de franquia em dias para cada combinação de modalidade/cobertura do produto.
differentiatedDeductibleDays number false none Detalhamento da franquia em dias diferentes para cada cobertura que exista alguma especificidade. Caso a seguradora não tenha essa diferenciação, não retornará nada no campo.
deductibleBRL number true none Listagem de franquia em reais para cada combinação de modalidade/cobertura do produto.
differentiatedDeductibleBRL string false none Detalhamento da franquia em reais diferentes para cada cobertura que exista alguma especificidade. Caso a seguradora não tenha essa diferenciação, não retornará nada no campo.
excludedRisks [string] true none Listagem dos tipos de riscos excluídos para cada combinação de modalidade/cobertura do produto. Deve ser padronizada na proposta técnica submetida pela Estrutura Inicial de Governança para observância comum por todas as sociedades participantes
excludedRisksURL string false none Campo aberto (possibilidade de incluir URL).
allowApartPurchase boolean true none Indicar se a cobertura pode ser contratada isoladamente ou não.

Enumerated Values

Property Value
currency AFN
currency ALL
currency DZD
currency USD
currency EUR
currency AOA
currency XCD
currency XCD
currency ARS
currency AMD
currency AWG
currency AUD
currency EUR
currency AZN
currency BSD
currency BHD
currency BDT
currency BBD
currency BYN
currency EUR
currency BZD
currency XOF
currency BMD
currency BTN
currency BOB
currency BOV
currency USD
currency BAM
currency BWP
currency NOK
currency BRL
currency USD
currency BND
currency BGN
currency XOF
currency BIF
currency CVE
currency KHR
currency XAF
currency CAD
currency KYD
currency XAF
currency XAF
currency CLF
currency CLP
currency CNY
currency AUD
currency AUD
currency COP
currency COU
currency KMF
currency CDF
currency XAF
currency NZD
currency CRC
currency HRK
currency CUC
currency CUP
currency ANG
currency EUR
currency CZK
currency XOF
currency DKK
currency DJF
currency XCD
currency DOP
currency USD
currency EGP
currency SVC
currency USD
currency XAF
currency ERN
currency EUR
currency ETB
currency EUR
currency FKP
currency DKK
currency FJD
currency EUR
currency EUR
currency EUR
currency XPF
currency EUR
currency XAF
currency GMD
currency GEL
currency EUR
currency GHS
currency GIP
currency EUR
currency DKK
currency XCD
currency EUR
currency USD
currency GTQ
currency GBP
currency GNF
currency XOF
currency GYD
currency HTG
currency USD
currency AUD
currency EUR
currency HNL
currency HKD
currency HUF
currency ISK
currency INR
currency IDR
currency XDR
currency IRR
currency IQD
currency EUR
currency GBP
currency ILS
currency EUR
currency JMD
currency JPY
currency GBP
currency JOD
currency KZT
currency KES
currency AUD
currency KPW
currency KRW
currency KWD
currency KGS
currency LAK
currency EUR
currency LBP
currency LSL
currency ZAR
currency LRD
currency LYD
currency CHF
currency EUR
currency EUR
currency MOP
currency MGA
currency MWK
currency MYR
currency MVR
currency XOF
currency EUR
currency USD
currency EUR
currency MRU
currency MUR
currency EUR
currency XUA
currency MXN
currency MXV
currency USD
currency MDL
currency EUR
currency MNT
currency EUR
currency XCD
currency MAD
currency MZN
currency MMK
currency NAD
currency ZAR
currency AUD
currency NPR
currency EUR
currency XPF
currency NZD
currency NIO
currency XOF
currency NGN
currency NZD
currency AUD
currency USD
currency NOK
currency OMR
currency PKR
currency USD
currency PAB
currency USD
currency PGK
currency PYG
currency PEN
currency PHP
currency NZD
currency PLN
currency EUR
currency USD
currency QAR
currency MKD
currency RON
currency RUB
currency RWF
currency EUR
currency EUR
currency SHP
currency XCD
currency XCD
currency EUR
currency EUR
currency XCD
currency WST
currency EUR
currency STN
currency SAR
currency XOF
currency RSD
currency SCR
currency SLL
currency SGD
currency ANG
currency XSU
currency EUR
currency EUR
currency SBD
currency SOS
currency ZAR
currency SSP
currency EUR
currency LKR
currency SDG
currency SRD
currency NOK
currency SZL
currency SEK
currency CHE
currency CHF
currency CHW
currency SYP
currency TWD
currency TJS
currency TZS
currency THB
currency USD
currency XOF
currency NZD
currency TOP
currency TTD
currency TND
currency TRY
currency TMT
currency USD
currency AUD
currency UGX
currency UAH
currency AED
currency GBP
currency USD
currency USD
currency USN
currency UYI
currency UYU
currency UZS
currency VUV
currency VEF
currency VND
currency USD
currency USD
currency XPF
currency MAD
currency YER
currency ZMW
currency ZWL

PersonPmbacRemuneration

{
  "interestRate": 0,
  "pmbacUpdateIndex": "IPCA"
}

Properties

Name Type Required Restrictions Description
interestRate number false none Taxa de juros para capitalização da PMBaC.
pmbacUpdateIndex string true none Índice utilizado na atualização da PMBaC.

Enumerated Values

Property Value
pmbacUpdateIndex IPCA
pmbacUpdateIndex IGP-M
pmbacUpdateIndex INPC

PersonBenefitRecalculation

{
  "benefitRecalculationCriteria": "INDICE",
  "benefitUpdateIndex": "IPCA"
}

Properties

Name Type Required Restrictions Description
benefitRecalculationCriteria string true none none
benefitUpdateIndex string true none Índice utilizado na atualização do prêmio/contribuição e do capital segurado/ benefício, caso critério de atualização por meio de índice

Enumerated Values

Property Value
benefitRecalculationCriteria INDICE
benefitRecalculationCriteria VINCULADO_SALDO_DEVEDOR
benefitRecalculationCriteria VARIAVEL_ACORDO_CRITERIO_ESPECIFICO
benefitUpdateIndex IPCA
benefitUpdateIndex IGP-M
benefitUpdateIndex INPC

PersonAgeAdjustment

{
  "criterion": "APOS_PERIODO_EM_ANOS",
  "frequency": 0
}

Properties

Name Type Required Restrictions Description
criterion string true none Critério escolhido para reenquadramento etário
frequency integer true none Período em anos, caso critério de reenquadramento após ou a cada período em anos.

Enumerated Values

Property Value
criterion APOS_PERIODO_EM_ANOS
criterion A_CADA_PERIODO_EM_ANOS
criterion POR_MUDANCA_DE_FAIXA_ETARIA
criterion NAO_APLICAVEL

personReclaimTable

{
  "initialMonthRange": 1,
  "finalMonthRange": 12,
  "percentage": 0
}

Tabela Percentuais de resgate

Properties

Name Type Required Restrictions Description
initialMonthRange integer true none Mês inicial do range
finalMonthRange integer true none Mês final do range
percentage number true none Percentual da faixa de resgate

PersonReclaim

{
  "reclaimTable": [
    {
      "initialMonthRange": 1,
      "finalMonthRange": 12,
      "percentage": 0
    }
  ],
  "differentiatedPercentage": "string",
  "gracePeriod": {
    "amount": 60,
    "unit": "DIAS"
  }
}

Properties

Name Type Required Restrictions Description
reclaimTable [personReclaimTable] true none Listagem de percentuais de resgate da PMBaC para cada conjunto de prazo aplicável e para cada combinação de modalidade/cobertura estruturados em regime de capitalização
differentiatedPercentage string false none Campo aberto (possibilidade de incluir URL).
gracePeriod PersonGracePeriodUnit true none Período de carência

PersonPremiumPayment

{
  "paymentMethod": [
    "CARTAO_CREDITO"
  ],
  "frequency": [
    "DIARIA"
  ],
  "premiumTax": "string"
}

Properties

Name Type Required Restrictions Description
paymentMethod [string] true none none
frequency [string] true none none
premiumTax string false none Distribuição de frequência relativa aos valores referentes às taxas cobradas.

PersonMinimumRequirements

{
  "contractingType": "COLETIVO",
  "contractingMinRequirement": "string"
}

Properties

Name Type Required Restrictions Description
contractingType string true none none
contractingMinRequirement string true none none

Enumerated Values

Property Value
contractingType COLETIVO
contractingType INDIVIDUAL

LinksPaginated

{
  "self": "https://api.organizacao.com.br/open-insurance/products-services/v1",
  "first": "https://api.organizacao.com.br/open-insurance/products-services/v1",
  "prev": "string",
  "next": "string",
  "last": "https://api.organizacao.com.br/open-insurance/products-services/v1"
}

Properties

Name Type Required Restrictions Description
self string false none URL da página atualmente requisitada
first string false none URL da primeira página de registros
prev string false none URL da página anterior de registros
next string false none URL da próxima página de registros
last string false none URL da última página de registros

MetaPaginated

{
  "totalRecords": 10,
  "totalPages": 1
}

Properties

Name Type Required Restrictions Description
totalRecords integer true none Total de registros encontrados
totalPages integer true none Total de páginas para os registros encontrados

ResponseError

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "requestDateTime": "2021-08-20T08:30:00Z"
    }
  ],
  "meta": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

ResponsePensionPlanList

{
  "requestTime": "2021-08-20T08:30:00Z",
  "data": {},
  "brand": {
    "name": "EMPRESA",
    "companies": {
      "name": "EMPRESA Seguros",
      "cnpjNumber": 45086338000178,
      "products": [
        {
          "name": "Nome comercial do Produto",
          "code": "123456789_cap",
          "modality": "PENSAO",
          "coverages": [
            {
              "coverage": "INVALIDEZ",
              "coveragesAttributes": {
                "indenizationPaymentMethod": "Pagamento Único",
                "minValue": {
                  "amount": 0,
                  "unit": {
                    "code": "string",
                    "description": "string"
                  }
                },
                "maxValue": {
                  "amount": 0,
                  "unit": {
                    "code": "string",
                    "description": "string"
                  }
                },
                "indemnifiablePeriod": "Prazo",
                "indemnifiableDeadline": 48,
                "currency": "BRL",
                "gracePeriod": {
                  "amount": 0,
                  "unit": "DIAS"
                },
                "excludedRisk": [
                  "ATO_RECONHECIMENTO_PERIGOSO"
                ],
                "excludedRiskURL": "string"
              },
              "coveragePeriod": "Vitalícia"
            }
          ],
          "additional": "SORTEIO",
          "additionalOthers": "string",
          "assistanceType": [
            "Funeral"
          ],
          "assistanceTypeOthers": [
            "string"
          ],
          "termAndCondition": [
            {
              "susepProcessNumber": "15414.622222/2222-22",
              "definition": "wwww.seguradora.com.br/termos"
            }
          ],
          "updatePMBaC": {
            "interestRate": 14,
            "updateIndex": "IPCA(IBGE)"
          },
          "premiumUpdateIndex": "IPCA",
          "ageReframing": {
            "reframingCriterion": "Após período em anos",
            "reframingPeriodicity": 10
          },
          "financialRegimeContractType": "Repartição Simples",
          "reclaim": {
            "reclaimTable": [
              {
                "initialMonthRange": 0,
                "finalMonthRange": 0,
                "percentage": "string"
              }
            ],
            "differentiatedPercentage": "string",
            "gracePeriod": "20/Não se aplica"
          },
          "otherGuarateedValues": "Saldamento",
          "profitModality": "PAGAMENTO_UNICO",
          "contributionPayment": {
            "contributionPaymentMethod": [
              "Cartão de crédito"
            ],
            "contributionPeriodicity": [
              "Mensal"
            ]
          },
          "contributionTax": "string",
          "minimumRequirements": {
            "minRequirementsContractType": "Individual",
            "minRequirementsContract": "wwww.seguradora.com.br/termos"
          },
          "targetAudience": "Pessoa Natural"
        }
      ]
    }
  },
  "linksPaginated": {
    "self": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "first": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "prev": "string",
    "next": "string",
    "last": "https://api.organizacao.com.br/open-insurance/products-services/v1"
  },
  "metaPaginated": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Properties

Name Type Required Restrictions Description
requestTime string(date-time) false none Data e hora da consulta, conforme especificação RFC-3339, formato UTC.
data object true none none
brand PensionPlanBrand true none Organização controladora do grupo.
linksPaginated LinksPaginated true none none
metaPaginated MetaPaginated true none none

PensionPlanBrand

{
  "name": "EMPRESA",
  "companies": {
    "name": "EMPRESA Seguros",
    "cnpjNumber": 45086338000178,
    "products": [
      {
        "name": "Nome comercial do Produto",
        "code": "123456789_cap",
        "modality": "PENSAO",
        "coverages": [
          {
            "coverage": "INVALIDEZ",
            "coveragesAttributes": {
              "indenizationPaymentMethod": "Pagamento Único",
              "minValue": {
                "amount": 0,
                "unit": {
                  "code": "string",
                  "description": "string"
                }
              },
              "maxValue": {
                "amount": 0,
                "unit": {
                  "code": "string",
                  "description": "string"
                }
              },
              "indemnifiablePeriod": "Prazo",
              "indemnifiableDeadline": 48,
              "currency": "BRL",
              "gracePeriod": {
                "amount": 0,
                "unit": "DIAS"
              },
              "excludedRisk": [
                "ATO_RECONHECIMENTO_PERIGOSO"
              ],
              "excludedRiskURL": "string"
            },
            "coveragePeriod": "Vitalícia"
          }
        ],
        "additional": "SORTEIO",
        "additionalOthers": "string",
        "assistanceType": [
          "Funeral"
        ],
        "assistanceTypeOthers": [
          "string"
        ],
        "termAndCondition": [
          {
            "susepProcessNumber": "15414.622222/2222-22",
            "definition": "wwww.seguradora.com.br/termos"
          }
        ],
        "updatePMBaC": {
          "interestRate": 14,
          "updateIndex": "IPCA(IBGE)"
        },
        "premiumUpdateIndex": "IPCA",
        "ageReframing": {
          "reframingCriterion": "Após período em anos",
          "reframingPeriodicity": 10
        },
        "financialRegimeContractType": "Repartição Simples",
        "reclaim": {
          "reclaimTable": [
            {
              "initialMonthRange": 0,
              "finalMonthRange": 0,
              "percentage": "string"
            }
          ],
          "differentiatedPercentage": "string",
          "gracePeriod": "20/Não se aplica"
        },
        "otherGuarateedValues": "Saldamento",
        "profitModality": "PAGAMENTO_UNICO",
        "contributionPayment": {
          "contributionPaymentMethod": [
            "Cartão de crédito"
          ],
          "contributionPeriodicity": [
            "Mensal"
          ]
        },
        "contributionTax": "string",
        "minimumRequirements": {
          "minRequirementsContractType": "Individual",
          "minRequirementsContract": "wwww.seguradora.com.br/termos"
        },
        "targetAudience": "Pessoa Natural"
      }
    ]
  }
}

Organização controladora do grupo.

Properties

Name Type Required Restrictions Description
name string true none Nome da marca reportada pelo participante do Open Insurance. O conceito a que se refere a marca é em essência uma promessa das sociedades sob ela em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
companies PensionPlanCompany true none Informações referente a sociedade a qual a marca pertence.

PensionPlanCompany

{
  "name": "EMPRESA Seguros",
  "cnpjNumber": 45086338000178,
  "products": [
    {
      "name": "Nome comercial do Produto",
      "code": "123456789_cap",
      "modality": "PENSAO",
      "coverages": [
        {
          "coverage": "INVALIDEZ",
          "coveragesAttributes": {
            "indenizationPaymentMethod": "Pagamento Único",
            "minValue": {
              "amount": 0,
              "unit": {
                "code": "string",
                "description": "string"
              }
            },
            "maxValue": {
              "amount": 0,
              "unit": {
                "code": "string",
                "description": "string"
              }
            },
            "indemnifiablePeriod": "Prazo",
            "indemnifiableDeadline": 48,
            "currency": "BRL",
            "gracePeriod": {
              "amount": 0,
              "unit": "DIAS"
            },
            "excludedRisk": [
              "ATO_RECONHECIMENTO_PERIGOSO"
            ],
            "excludedRiskURL": "string"
          },
          "coveragePeriod": "Vitalícia"
        }
      ],
      "additional": "SORTEIO",
      "additionalOthers": "string",
      "assistanceType": [
        "Funeral"
      ],
      "assistanceTypeOthers": [
        "string"
      ],
      "termAndCondition": [
        {
          "susepProcessNumber": "15414.622222/2222-22",
          "definition": "wwww.seguradora.com.br/termos"
        }
      ],
      "updatePMBaC": {
        "interestRate": 14,
        "updateIndex": "IPCA(IBGE)"
      },
      "premiumUpdateIndex": "IPCA",
      "ageReframing": {
        "reframingCriterion": "Após período em anos",
        "reframingPeriodicity": 10
      },
      "financialRegimeContractType": "Repartição Simples",
      "reclaim": {
        "reclaimTable": [
          {
            "initialMonthRange": 0,
            "finalMonthRange": 0,
            "percentage": "string"
          }
        ],
        "differentiatedPercentage": "string",
        "gracePeriod": "20/Não se aplica"
      },
      "otherGuarateedValues": "Saldamento",
      "profitModality": "PAGAMENTO_UNICO",
      "contributionPayment": {
        "contributionPaymentMethod": [
          "Cartão de crédito"
        ],
        "contributionPeriodicity": [
          "Mensal"
        ]
      },
      "contributionTax": "string",
      "minimumRequirements": {
        "minRequirementsContractType": "Individual",
        "minRequirementsContract": "wwww.seguradora.com.br/termos"
      },
      "targetAudience": "Pessoa Natural"
    }
  ]
}

Informações referente a sociedade a qual a marca pertence.

Properties

Name Type Required Restrictions Description
name string true none Nome da sociedade pertencente à marca.
cnpjNumber string true none CNPJ da sociedade pertencente à marca.
products PensionPlanProduct false none Produtos de Seguro de Automóveis.

PensionPlanProduct

[
  {
    "name": "Nome comercial do Produto",
    "code": "123456789_cap",
    "modality": "PENSAO",
    "coverages": [
      {
        "coverage": "INVALIDEZ",
        "coveragesAttributes": {
          "indenizationPaymentMethod": "Pagamento Único",
          "minValue": {
            "amount": 0,
            "unit": {
              "code": "string",
              "description": "string"
            }
          },
          "maxValue": {
            "amount": 0,
            "unit": {
              "code": "string",
              "description": "string"
            }
          },
          "indemnifiablePeriod": "Prazo",
          "indemnifiableDeadline": 48,
          "currency": "BRL",
          "gracePeriod": {
            "amount": 0,
            "unit": "DIAS"
          },
          "excludedRisk": [
            "ATO_RECONHECIMENTO_PERIGOSO"
          ],
          "excludedRiskURL": "string"
        },
        "coveragePeriod": "Vitalícia"
      }
    ],
    "additional": "SORTEIO",
    "additionalOthers": "string",
    "assistanceType": [
      "Funeral"
    ],
    "assistanceTypeOthers": [
      "string"
    ],
    "termAndCondition": [
      {
        "susepProcessNumber": "15414.622222/2222-22",
        "definition": "wwww.seguradora.com.br/termos"
      }
    ],
    "updatePMBaC": {
      "interestRate": 14,
      "updateIndex": "IPCA(IBGE)"
    },
    "premiumUpdateIndex": "IPCA",
    "ageReframing": {
      "reframingCriterion": "Após período em anos",
      "reframingPeriodicity": 10
    },
    "financialRegimeContractType": "Repartição Simples",
    "reclaim": {
      "reclaimTable": [
        {
          "initialMonthRange": 0,
          "finalMonthRange": 0,
          "percentage": "string"
        }
      ],
      "differentiatedPercentage": "string",
      "gracePeriod": "20/Não se aplica"
    },
    "otherGuarateedValues": "Saldamento",
    "profitModality": "PAGAMENTO_UNICO",
    "contributionPayment": {
      "contributionPaymentMethod": [
        "Cartão de crédito"
      ],
      "contributionPeriodicity": [
        "Mensal"
      ]
    },
    "contributionTax": "string",
    "minimumRequirements": {
      "minRequirementsContractType": "Individual",
      "minRequirementsContract": "wwww.seguradora.com.br/termos"
    },
    "targetAudience": "Pessoa Natural"
  }
]

Produtos de Seguro de Automóveis.

Properties

Name Type Required Restrictions Description
name string true none Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code string true none Código único a ser definido pela sociedade.
modality string true none Lista padronizada de modalidades de coberturas incluídas no produto.
coverages [object] true none none
» coverage string false none Formas de coberturas.
» coveragesAttributes PensionPlanCoverageAttributes false none Atributos da cobertura.
» coveragePeriod string false none Formas de coberturas.
additional string false none Adicional ao plano.
additionalOthers string false none Lista a ser preenchida pelas participantes quando houver ‘Outros’ no campo ‘additional’
assistanceType [string] false none Tipos de assistências.
assistanceTypeOthers [string] false none Outros tipos de assistências.
termAndCondition [PensionPlanTerms] false none [Informações dos termos e condições conforme número do processo SUSEP.]
updatePMBaC PensionPlanUpdatePMBaC false none Atualização/ Remuneração da PMaC.
premiumUpdateIndex string true none Índice utilizado na atualização do prêmio/contribuição e do capital segurado/benefício
ageReframing PensionPlanAgeReframing false none Reenquadramento etário.
financialRegimeContractType string true none Tipo de contratação de regime financeiro.
reclaim PensionPlanReclaim false none Resgate.
otherGuarateedValues string true none Outros valores garantidos.
profitModality string true none Modalidade de pagamento da indenização.
contributionPayment PensionPlanContributionPayment true none Pagamento da contribuição.
contributionTax string false none Distribuição de frequência relativa aos valores referentes às taxas cobradas
minimumRequirements PensionPlanMinimumRequirements true none Requisitos mínimos.
targetAudience string true none none

Enumerated Values

Property Value
modality PECULIO
modality RENDA
modality PENSAO_PRAZO_CERTO
modality PENSAO_MENORES_21
modality PENSAO_MENORES_24
modality PENSAO_CONJUGE_VITALICIA
modality PENSAO_CONJUGE_TEMPORARIA
coverage MORTE
coverage INVALIDEZ
coveragePeriod VITALICIA
coveragePeriod TEMPORARIA
additional SORTEIO
additional OUTROS
premiumUpdateIndex IPCA
premiumUpdateIndex IGPM
premiumUpdateIndex INPC
financialRegimeContractType REPARTICAO_SIMPLES
financialRegimeContractType REPARTICAO_CAPITAIS_COBERTURA
financialRegimeContractType CAPITALIZACAO
otherGuarateedValues SALDAMENTO
otherGuarateedValues BENEFICIO_PROLOGANDO
otherGuarateedValues NAO_APLICA
profitModality PAGAMENTO_UNICO
profitModality FORMA_RENDA
targetAudience PESSOA_NATURAL
targetAudience PESSOA_JURIDICA

PensionPlanTerms

{
  "susepProcessNumber": "15414.622222/2222-22",
  "definition": "wwww.seguradora.com.br/termos"
}

Informações dos termos e condições conforme número do processo SUSEP.

Properties

Name Type Required Restrictions Description
susepProcessNumber string true none Número do processo SUSEP.
definition string true none Campo aberto (possibilidade de incluir uma url).

PensionPlanCovaregeAttibutesDetailsUnit

{
  "code": "string",
  "description": "string"
}

Properties

Name Type Required Restrictions Description
code string true none Tipo unidade de medida
description string true none Descrição da unidade de medida

PensionPlanCovaregeAttibutesDetails

{
  "amount": 0,
  "unit": {
    "code": "string",
    "description": "string"
  }
}

Properties

Name Type Required Restrictions Description
amount number true none none
unit PensionPlanCovaregeAttibutesDetailsUnit true none none

PensionPlanCoverageAttributes

{
  "indenizationPaymentMethod": "Pagamento Único",
  "minValue": {
    "amount": 0,
    "unit": {
      "code": "string",
      "description": "string"
    }
  },
  "maxValue": {
    "amount": 0,
    "unit": {
      "code": "string",
      "description": "string"
    }
  },
  "indemnifiablePeriod": "Prazo",
  "indemnifiableDeadline": 48,
  "currency": "BRL",
  "gracePeriod": {
    "amount": 0,
    "unit": "DIAS"
  },
  "excludedRisk": [
    "ATO_RECONHECIMENTO_PERIGOSO"
  ],
  "excludedRiskURL": "string"
}

Atributos da cobertura.

Properties

Name Type Required Restrictions Description
indenizationPaymentMethod string true none Forma de pagamento da indenização.
minValue PensionPlanCovaregeAttibutesDetails true none Valor mínimo de cobertura diária ou parcelada. Em reais.
maxValue PensionPlanCovaregeAttibutesDetails true none Valor máxima de cobertura diária ou parcelada. Em reais.
indemnifiablePeriod string true none Período indenizável. Se for indenização única, esse campo não se aplica.
indemnifiableDeadline integer true none Número máximo de parcelas indenizáveis. Caso seja relacionado a parcelas.
currency string true none Moeda utilizada.
gracePeriod PensionPlanGracePeriod true none Período de carência.
excludedRisk [string] true none Riscos excluídos.
excludedRiskURL string true none Campo aberto (possibilidade de incluir URL)

Enumerated Values

Property Value
indenizationPaymentMethod PAGAMENTO_UNICO
indenizationPaymentMethod FORMA_RENDA
indemnifiablePeriod PRAZO
indemnifiablePeriod ATE_FIM_CICLO_DETERMINADO
currency AFN
currency ALL
currency DZD
currency USD
currency EUR
currency AOA
currency XCD
currency XCD
currency ARS
currency AMD
currency AWG
currency AUD
currency EUR
currency AZN
currency BSD
currency BHD
currency BDT
currency BBD
currency BYN
currency EUR
currency BZD
currency XOF
currency BMD
currency BTN
currency BOB
currency BOV
currency USD
currency BAM
currency BWP
currency NOK
currency BRL
currency USD
currency BND
currency BGN
currency XOF
currency BIF
currency CVE
currency KHR
currency XAF
currency CAD
currency KYD
currency XAF
currency XAF
currency CLF
currency CLP
currency CNY
currency AUD
currency AUD
currency COP
currency COU
currency KMF
currency CDF
currency XAF
currency NZD
currency CRC
currency HRK
currency CUC
currency CUP
currency ANG
currency EUR
currency CZK
currency XOF
currency DKK
currency DJF
currency XCD
currency DOP
currency USD
currency EGP
currency SVC
currency USD
currency XAF
currency ERN
currency EUR
currency ETB
currency EUR
currency FKP
currency DKK
currency FJD
currency EUR
currency EUR
currency EUR
currency XPF
currency EUR
currency XAF
currency GMD
currency GEL
currency EUR
currency GHS
currency GIP
currency EUR
currency DKK
currency XCD
currency EUR
currency USD
currency GTQ
currency GBP
currency GNF
currency XOF
currency GYD
currency HTG
currency USD
currency AUD
currency EUR
currency HNL
currency HKD
currency HUF
currency ISK
currency INR
currency IDR
currency XDR
currency IRR
currency IQD
currency EUR
currency GBP
currency ILS
currency EUR
currency JMD
currency JPY
currency GBP
currency JOD
currency KZT
currency KES
currency AUD
currency KPW
currency KRW
currency KWD
currency KGS
currency LAK
currency EUR
currency LBP
currency LSL
currency ZAR
currency LRD
currency LYD
currency CHF
currency EUR
currency EUR
currency MOP
currency MGA
currency MWK
currency MYR
currency MVR
currency XOF
currency EUR
currency USD
currency EUR
currency MRU
currency MUR
currency EUR
currency XUA
currency MXN
currency MXV
currency USD
currency MDL
currency EUR
currency MNT
currency EUR
currency XCD
currency MAD
currency MZN
currency MMK
currency NAD
currency ZAR
currency AUD
currency NPR
currency EUR
currency XPF
currency NZD
currency NIO
currency XOF
currency NGN
currency NZD
currency AUD
currency USD
currency NOK
currency OMR
currency PKR
currency USD
currency PAB
currency USD
currency PGK
currency PYG
currency PEN
currency PHP
currency NZD
currency PLN
currency EUR
currency USD
currency QAR
currency MKD
currency RON
currency RUB
currency RWF
currency EUR
currency EUR
currency SHP
currency XCD
currency XCD
currency EUR
currency EUR
currency XCD
currency WST
currency EUR
currency STN
currency SAR
currency XOF
currency RSD
currency SCR
currency SLL
currency SGD
currency ANG
currency XSU
currency EUR
currency EUR
currency SBD
currency SOS
currency ZAR
currency SSP
currency EUR
currency LKR
currency SDG
currency SRD
currency NOK
currency SZL
currency SEK
currency CHE
currency CHF
currency CHW
currency SYP
currency TWD
currency TJS
currency TZS
currency THB
currency USD
currency XOF
currency NZD
currency TOP
currency TTD
currency TND
currency TRY
currency TMT
currency USD
currency AUD
currency UGX
currency UAH
currency AED
currency GBP
currency USD
currency USD
currency USN
currency UYI
currency UYU
currency UZS
currency VUV
currency VEF
currency VND
currency USD
currency USD
currency XPF
currency MAD
currency YER
currency ZMW
currency ZWL
currency EUR

PensionPlanUpdatePMBaC

{
  "interestRate": 14,
  "updateIndex": "IPCA(IBGE)"
}

Atualização/ Remuneração da PMaC.

Properties

Name Type Required Restrictions Description
interestRate number true none Taxa de juros para capitalização da PMBaC PMBC.
updateIndex string true none Índice utilizado na atualização da PMBaC.

Enumerated Values

Property Value
updateIndex FINANCEIRA
updateIndex IGPM
updateIndex INPC

PensionPlanAgeReframing

{
  "reframingCriterion": "Após período em anos",
  "reframingPeriodicity": 10
}

Reenquadramento etário.

Properties

Name Type Required Restrictions Description
reframingCriterion string true none Critério para reenquadramento etário.
reframingPeriodicity integer true none Período em anos para reenquadramento etário.

Enumerated Values

Property Value
reframingCriterion APOS_PERIODO_ANOS
reframingCriterion CADA_PERIODO_ANOS
reframingCriterion MUDANCA_FAIXA_ETARIA
reframingCriterion NAO_APLICAVEL

PensionPlanReclaim

{
  "reclaimTable": [
    {
      "initialMonthRange": 0,
      "finalMonthRange": 0,
      "percentage": "string"
    }
  ],
  "differentiatedPercentage": "string",
  "gracePeriod": "20/Não se aplica"
}

Resgate.

Properties

Name Type Required Restrictions Description
reclaimTable [PensionPlanReclaimTable] true none Percentual de resgate para PMBaC para cada conjunto aplicável.
differentiatedPercentage string false none Campo aberto (possibilidade de incluir URL)
gracePeriod string true none Prazo de carência em dias para resgate.

PensionPlanReclaimTable

{
  "initialMonthRange": 0,
  "finalMonthRange": 0,
  "percentage": "string"
}

Properties

Name Type Required Restrictions Description
initialMonthRange number true none Mês inicial do range
finalMonthRange number true none Mês final do range
percentage string true none Percentual da faixa de resgate

PensionPlanContributionPayment

{
  "contributionPaymentMethod": [
    "Cartão de crédito"
  ],
  "contributionPeriodicity": [
    "Mensal"
  ]
}

Pagamento da contribuição.

Properties

Name Type Required Restrictions Description
contributionPaymentMethod [string] true none Forma de pagamento da contribuição.
contributionPeriodicity [string] true none Periodicidade de pagamento da contribuição.

PensionPlanMinimumRequirements

{
  "minRequirementsContractType": "Individual",
  "minRequirementsContract": "wwww.seguradora.com.br/termos"
}

Requisitos mínimos.

Properties

Name Type Required Restrictions Description
minRequirementsContractType string true none Tipo de contratação.
minRequirementsContract string true none Campo aberto contendo todos os requisitos mínimos para contratação.

Enumerated Values

Property Value
minRequirementsContractType COLETIVO
minRequirementsContractType INDIVIDUAL

PensionPlanGracePeriod

{
  "amount": 0,
  "unit": "DIAS"
}

Properties

Name Type Required Restrictions Description
amount number false none Prazo de Carência
unit string false none Unidade do prazo (dias ou meses)

Enumerated Values

Property Value
unit DIAS
unit MESES
unit NAO_SE_APLICA

LinksPaginated

{
  "self": "https://api.organizacao.com.br/open-insurance/products-services/v1",
  "first": "https://api.organizacao.com.br/open-insurance/products-services/v1",
  "prev": "string",
  "next": "string",
  "last": "https://api.organizacao.com.br/open-insurance/products-services/v1"
}

Properties

Name Type Required Restrictions Description
self string true none URI completo que gerou a resposta atual.
first string false none URI da primeira página que originou essa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta
prev string false none URI da página anterior dessa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta
next string false none URI da próxima página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
last string false none URI da última página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta

MetaPaginated

{
  "totalRecords": 10,
  "totalPages": 1
}

Properties

Name Type Required Restrictions Description
totalRecords integer true none Total de registros encontrados
totalPages integer true none Total de páginas para os registros encontrados

ResponseError

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "requestDateTime": "2021-08-20T08:30:00Z"
    }
  ],
  "meta": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Properties

Name Type Required Restrictions Description
errors [object] true none none
» code string true none Código de erro específico do endpoint
» title string true none Título legível por humanos deste erro específico
» detail string true none Descrição legível por humanos deste erro específico
» requestDateTime string(date-time) true none Data e hora da consulta, conforme especificação RFC-3339, formato UTC.
meta MetaPaginated false none none

Properties

Name Type Required Restrictions Description
errors [object] true none none
» code string true none Código de erro específico do endpoint
» title string true none Título legível por humanos deste erro específico
» detail string true none Descrição legível por humanos deste erro específico
» requestDateTime string(date-time) true none Data e hora da consulta, conforme especificação RFC-3339, formato UTC.
meta MetaPaginated false none none

ResponseAutoInsuranceList

{
  "data": {
    "brand": {
      "name": "string",
      "company": [
        {
          "name": "string",
          "cnpjNumber": "string",
          "products": [
            {
              "name": "string",
              "code": "string",
              "coverages": [
                {
                  "coverage": "VIDROS",
                  "coverageDetail": "Roubo total",
                  "coveragePermissionSeparteAcquisition": true,
                  "coverageAttributes": {
                    "minLMI": {},
                    "maxLMI": {},
                    "contractBase": [],
                    "newCarMaximumCalculatingPeriod": 12,
                    "newCarContractBase": [],
                    "fullIndemnityPercentage": {},
                    "deductibleType": [],
                    "fullIndemnityDeductible": true,
                    "deductiblePaymentByCoverage": true,
                    "deductiblePercentage": {},
                    "mandatoryParticipation": "Casco - RCF-V Danos",
                    "geographicScopeCoverage": [],
                    "geographicScopeCoverageOthers": "string"
                  }
                }
              ],
              "carParts": [
                {
                  "carPartCondition": "NOVAS",
                  "carPartType": "ORIGINAIS"
                }
              ],
              "carModels": [
                {
                  "manufacturer": "FORD",
                  "model": "KA",
                  "year": 2018,
                  "fipeCode": "string"
                }
              ],
              "vehicleOvernightZipCode": 1311000,
              "additional": [
                "SORTEIO GRATUITO"
              ],
              "additionalOthers": "string",
              "assistanceServices": [
                {
                  "assistanceServicesPackage": [
                    "ATE_10_SERVICOS"
                  ],
                  "assistanceServicesDetail": "Perda Parcial - Colisão",
                  "chargeTypeSignaling": "GRATUITA"
                }
              ],
              "termsAndConditions": [
                {
                  "susepProcessNumber": "15414.622222/2222-22",
                  "definition": "https://ey.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.pdf"
                }
              ],
              "terms": [
                "ANUAL"
              ],
              "customerService": [
                "REDE REFERECIADA"
              ],
              "premiumPayment": {
                "paymentMethod": [
                  "CARTÃO DE CRÉDITO"
                ],
                "paymentType": [
                  "PARCELADO"
                ],
                "paymentDetail": "string"
              },
              "minimumRequirements": {
                "contractingType": [
                  "COLETIVO"
                ],
                "contractingMinRequirement": "https://example.com/mobile-banking"
              },
              "targetAudiences": [
                "PESSOA_NATURAL"
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "first": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "prev": "string",
    "next": "string",
    "last": "https://api.organizacao.com.br/open-insurance/products-services/v1"
  },
  "meta": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Properties

Name Type Required Restrictions Description
data object true none none
» brand AutoInsuranceBrand false none none
links Links true none none
meta Meta true none none

AutoInsuranceBrand

{
  "name": "string",
  "company": [
    {
      "name": "string",
      "cnpjNumber": "string",
      "products": [
        {
          "name": "string",
          "code": "string",
          "coverages": [
            {
              "coverage": "VIDROS",
              "coverageDetail": "Roubo total",
              "coveragePermissionSeparteAcquisition": true,
              "coverageAttributes": {
                "minLMI": {
                  "amount": 0,
                  "unit": {
                    "code": "string",
                    "description": "string"
                  }
                },
                "maxLMI": {
                  "amount": 0,
                  "unit": {
                    "code": "string",
                    "description": "string"
                  }
                },
                "contractBase": [
                  {
                    "contractBaseType": "VALOR DETERMINADO",
                    "contractBaseMinValue": {},
                    "contractBaseMaxValue": {}
                  }
                ],
                "newCarMaximumCalculatingPeriod": 12,
                "newCarContractBase": [
                  {
                    "contractBaseType": "VALOR DETERMINADO",
                    "contractBaseMinValue": {},
                    "contractBaseMaxValue": {}
                  }
                ],
                "fullIndemnityPercentage": {
                  "amount": 0,
                  "unit": {
                    "code": "string",
                    "description": "string"
                  }
                },
                "deductibleType": [
                  "NORMAL"
                ],
                "fullIndemnityDeductible": true,
                "deductiblePaymentByCoverage": true,
                "deductiblePercentage": {
                  "amount": 0,
                  "unit": {
                    "code": "string",
                    "description": "string"
                  }
                },
                "mandatoryParticipation": "Casco - RCF-V Danos",
                "geographicScopeCoverage": [
                  "NACIONAL"
                ],
                "geographicScopeCoverageOthers": "string"
              }
            }
          ],
          "carParts": [
            {
              "carPartCondition": "NOVAS",
              "carPartType": "ORIGINAIS"
            }
          ],
          "carModels": [
            {
              "manufacturer": "FORD",
              "model": "KA",
              "year": 2018,
              "fipeCode": "string"
            }
          ],
          "vehicleOvernightZipCode": 1311000,
          "additional": [
            "SORTEIO GRATUITO"
          ],
          "additionalOthers": "string",
          "assistanceServices": [
            {
              "assistanceServicesPackage": [
                "ATE_10_SERVICOS"
              ],
              "assistanceServicesDetail": "Perda Parcial - Colisão",
              "chargeTypeSignaling": "GRATUITA"
            }
          ],
          "termsAndConditions": [
            {
              "susepProcessNumber": "15414.622222/2222-22",
              "definition": "https://ey.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.pdf"
            }
          ],
          "terms": [
            "ANUAL"
          ],
          "customerService": [
            "REDE REFERECIADA"
          ],
          "premiumPayment": {
            "paymentMethod": [
              "CARTÃO DE CRÉDITO"
            ],
            "paymentType": [
              "PARCELADO"
            ],
            "paymentDetail": "string"
          },
          "minimumRequirements": {
            "contractingType": [
              "COLETIVO"
            ],
            "contractingMinRequirement": "https://example.com/mobile-banking"
          },
          "targetAudiences": [
            "PESSOA_NATURAL"
          ]
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string true none Nome da marca reportada pelo participante do Open Insurance. O conceito a que se refere a marca é em essência uma promessa das sociedades sob ela em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
company AutoInsuranceCompany true none none

AutoInsuranceCompany

[
  {
    "name": "string",
    "cnpjNumber": "string",
    "products": [
      {
        "name": "string",
        "code": "string",
        "coverages": [
          {
            "coverage": "VIDROS",
            "coverageDetail": "Roubo total",
            "coveragePermissionSeparteAcquisition": true,
            "coverageAttributes": {
              "minLMI": {
                "amount": 0,
                "unit": {
                  "code": "string",
                  "description": "string"
                }
              },
              "maxLMI": {
                "amount": 0,
                "unit": {
                  "code": "string",
                  "description": "string"
                }
              },
              "contractBase": [
                {
                  "contractBaseType": "VALOR DETERMINADO",
                  "contractBaseMinValue": {
                    "amount": 0,
                    "unit": {}
                  },
                  "contractBaseMaxValue": {
                    "amount": 0,
                    "unit": {}
                  }
                }
              ],
              "newCarMaximumCalculatingPeriod": 12,
              "newCarContractBase": [
                {
                  "contractBaseType": "VALOR DETERMINADO",
                  "contractBaseMinValue": {
                    "amount": 0,
                    "unit": {}
                  },
                  "contractBaseMaxValue": {
                    "amount": 0,
                    "unit": {}
                  }
                }
              ],
              "fullIndemnityPercentage": {
                "amount": 0,
                "unit": {
                  "code": "string",
                  "description": "string"
                }
              },
              "deductibleType": [
                "NORMAL"
              ],
              "fullIndemnityDeductible": true,
              "deductiblePaymentByCoverage": true,
              "deductiblePercentage": {
                "amount": 0,
                "unit": {
                  "code": "string",
                  "description": "string"
                }
              },
              "mandatoryParticipation": "Casco - RCF-V Danos",
              "geographicScopeCoverage": [
                "NACIONAL"
              ],
              "geographicScopeCoverageOthers": "string"
            }
          }
        ],
        "carParts": [
          {
            "carPartCondition": "NOVAS",
            "carPartType": "ORIGINAIS"
          }
        ],
        "carModels": [
          {
            "manufacturer": "FORD",
            "model": "KA",
            "year": 2018,
            "fipeCode": "string"
          }
        ],
        "vehicleOvernightZipCode": 1311000,
        "additional": [
          "SORTEIO GRATUITO"
        ],
        "additionalOthers": "string",
        "assistanceServices": [
          {
            "assistanceServicesPackage": [
              "ATE_10_SERVICOS"
            ],
            "assistanceServicesDetail": "Perda Parcial - Colisão",
            "chargeTypeSignaling": "GRATUITA"
          }
        ],
        "termsAndConditions": [
          {
            "susepProcessNumber": "15414.622222/2222-22",
            "definition": "https://ey.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.pdf"
          }
        ],
        "terms": [
          "ANUAL"
        ],
        "customerService": [
          "REDE REFERECIADA"
        ],
        "premiumPayment": {
          "paymentMethod": [
            "CARTÃO DE CRÉDITO"
          ],
          "paymentType": [
            "PARCELADO"
          ],
          "paymentDetail": "string"
        },
        "minimumRequirements": {
          "contractingType": [
            "COLETIVO"
          ],
          "contractingMinRequirement": "https://example.com/mobile-banking"
        },
        "targetAudiences": [
          "PESSOA_NATURAL"
        ]
      }
    ]
  }
]

Properties

Name Type Required Restrictions Description
name string true none Nome da sociedade pertencente à marca.
cnpjNumber string true none CNPJ da sociedade pertencente à marca.
products AutoInsuranceProduct true none Lista de Dependências de uma Instituição.

AutoInsuranceProduct

[
  {
    "name": "string",
    "code": "string",
    "coverages": [
      {
        "coverage": "VIDROS",
        "coverageDetail": "Roubo total",
        "coveragePermissionSeparteAcquisition": true,
        "coverageAttributes": {
          "minLMI": {
            "amount": 0,
            "unit": {
              "code": "string",
              "description": "string"
            }
          },
          "maxLMI": {
            "amount": 0,
            "unit": {
              "code": "string",
              "description": "string"
            }
          },
          "contractBase": [
            {
              "contractBaseType": "VALOR DETERMINADO",
              "contractBaseMinValue": {
                "amount": 0,
                "unit": {
                  "code": "string",
                  "description": "string"
                }
              },
              "contractBaseMaxValue": {
                "amount": 0,
                "unit": {
                  "code": "string",
                  "description": "string"
                }
              }
            }
          ],
          "newCarMaximumCalculatingPeriod": 12,
          "newCarContractBase": [
            {
              "contractBaseType": "VALOR DETERMINADO",
              "contractBaseMinValue": {
                "amount": 0,
                "unit": {
                  "code": "string",
                  "description": "string"
                }
              },
              "contractBaseMaxValue": {
                "amount": 0,
                "unit": {
                  "code": "string",
                  "description": "string"
                }
              }
            }
          ],
          "fullIndemnityPercentage": {
            "amount": 0,
            "unit": {
              "code": "string",
              "description": "string"
            }
          },
          "deductibleType": [
            "NORMAL"
          ],
          "fullIndemnityDeductible": true,
          "deductiblePaymentByCoverage": true,
          "deductiblePercentage": {
            "amount": 0,
            "unit": {
              "code": "string",
              "description": "string"
            }
          },
          "mandatoryParticipation": "Casco - RCF-V Danos",
          "geographicScopeCoverage": [
            "NACIONAL"
          ],
          "geographicScopeCoverageOthers": "string"
        }
      }
    ],
    "carParts": [
      {
        "carPartCondition": "NOVAS",
        "carPartType": "ORIGINAIS"
      }
    ],
    "carModels": [
      {
        "manufacturer": "FORD",
        "model": "KA",
        "year": 2018,
        "fipeCode": "string"
      }
    ],
    "vehicleOvernightZipCode": 1311000,
    "additional": [
      "SORTEIO GRATUITO"
    ],
    "additionalOthers": "string",
    "assistanceServices": [
      {
        "assistanceServicesPackage": [
          "ATE_10_SERVICOS"
        ],
        "assistanceServicesDetail": "Perda Parcial - Colisão",
        "chargeTypeSignaling": "GRATUITA"
      }
    ],
    "termsAndConditions": [
      {
        "susepProcessNumber": "15414.622222/2222-22",
        "definition": "https://ey.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.pdf"
      }
    ],
    "terms": [
      "ANUAL"
    ],
    "customerService": [
      "REDE REFERECIADA"
    ],
    "premiumPayment": {
      "paymentMethod": [
        "CARTÃO DE CRÉDITO"
      ],
      "paymentType": [
        "PARCELADO"
      ],
      "paymentDetail": "string"
    },
    "minimumRequirements": {
      "contractingType": [
        "COLETIVO"
      ],
      "contractingMinRequirement": "https://example.com/mobile-banking"
    },
    "targetAudiences": [
      "PESSOA_NATURAL"
    ]
  }
]

Produtos de Seguro de Automóveis.

Properties

Name Type Required Restrictions Description
name string true none Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code string true none Código único a ser definido pela sociedade.
coverages AutoInsuranceCoverage true none Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela II.5 do Anexo II
carParts AutoInsuranceCarPart true none Tipo de peça utilizada para reparação.
carModels AutoInsuranceCarModel true none Listagem de modelos / ano de veículos. Deve ser padronizada na proposta técnica submetida pela Estrutura Inicial de Governança para observância comum por todas as sociedades participantes.
vehicleOvernightZipCode string true none Área de comercialização do seguro do automóvel.
additional [string] true none none
additionalOthers string false none Campo aberto para descrição de cada participante ao selecionar o domínio ‘Outros’ no campo acima ‘Adicionais’
assistanceServices [AutoInsuranceAssistanceServices] true none [Serviços de Assistência.]
termsAndConditions AutoInsuranceTermsAndConditions true none none
terms [string] true none Prazo.
customerService [string] true none Rede de atendimento do seguro contratado.
premiumPayment AutoInsurancePremiumPayment true none Informações de pagamento de prêmio.
minimumRequirements AutoInsuranceMinimumRequirements true none Produtos de Seguro de Automóvel.
targetAudiences [string] true none Público-alvo.

AutoInsuranceCoverage

[
  {
    "coverage": "VIDROS",
    "coverageDetail": "Roubo total",
    "coveragePermissionSeparteAcquisition": true,
    "coverageAttributes": {
      "minLMI": {
        "amount": 0,
        "unit": {
          "code": "string",
          "description": "string"
        }
      },
      "maxLMI": {
        "amount": 0,
        "unit": {
          "code": "string",
          "description": "string"
        }
      },
      "contractBase": [
        {
          "contractBaseType": "VALOR DETERMINADO",
          "contractBaseMinValue": {
            "amount": 0,
            "unit": {
              "code": "string",
              "description": "string"
            }
          },
          "contractBaseMaxValue": {
            "amount": 0,
            "unit": {
              "code": "string",
              "description": "string"
            }
          }
        }
      ],
      "newCarMaximumCalculatingPeriod": 12,
      "newCarContractBase": [
        {
          "contractBaseType": "VALOR DETERMINADO",
          "contractBaseMinValue": {
            "amount": 0,
            "unit": {
              "code": "string",
              "description": "string"
            }
          },
          "contractBaseMaxValue": {
            "amount": 0,
            "unit": {
              "code": "string",
              "description": "string"
            }
          }
        }
      ],
      "fullIndemnityPercentage": {
        "amount": 0,
        "unit": {
          "code": "string",
          "description": "string"
        }
      },
      "deductibleType": [
        "NORMAL"
      ],
      "fullIndemnityDeductible": true,
      "deductiblePaymentByCoverage": true,
      "deductiblePercentage": {
        "amount": 0,
        "unit": {
          "code": "string",
          "description": "string"
        }
      },
      "mandatoryParticipation": "Casco - RCF-V Danos",
      "geographicScopeCoverage": [
        "NACIONAL"
      ],
      "geographicScopeCoverageOthers": "string"
    }
  }
]

Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela II.5 do Anexo II

Properties

Name Type Required Restrictions Description
coverage string true none Conjunto de riscos elencados na apólice.
coverageDetail string true none Campo aberto para detalhamento de riscos possíveis dos produtos a ser feito para cada participante.
coveragePermissionSeparteAcquisition boolean false none Indicação se a cobertura permite contratação separada (por cobertura selecionada).
coverageAttributes AutoInsuranceCoverageAttributes false none Atributos da cobertura.

Enumerated Values

Property Value
coverage CASCO_COMPREENSIVA_COLISAO_INCENDIO_ROUBO_FURTO
coverage CASCO_INCENDIO_ROUBO_FURTO
coverage CASCO_ROUBO_FURTO
coverage CASCO_INCENDIO
coverage CASCO_ALAGAMENTO
coverage CASCO_COLISAO_INDENIZACAO_PARCIAL
coverage CASCO_COLISAO_INDENIZACAO_INTEGRAL
coverage RESPONSABILIDADE_CIVIL_FACULTATIVA_VEICULOS_RCFV
coverage RESPONSABILIDADE_CIVIL_FACULTATIVA_CONDUTOR_RCFC
coverage ACIDENTE_PESSOAIS_PASSAGEIROS_VEICULO
coverage ACIDENTE_PESSOAIS_PASSAGEIROS_CONDUTOR
coverage VIDROS
coverage DIARIA_INDISPONIBILIDADE
coverage LFR_LANTERNAS_FAROIS_RETROVISORES
coverage ACESSORIOS_EQUIPAMENTOS
coverage CARRO_RESERVA
coverage PEQUENOS_REPAROS
coverage RESPONSABILIDADE_CIVIL_CARTA_VERDE
coverage VOUCHER_MOBILIDADE
coverage DESPESAS_EXTRAORDINARIAS
coverage PEQUENOS_REPAROS
coverage GARANTIA_MECANICA
coverage OUTRAS

AutoInsuranceCovaregeAttibutesDetailsUnit

{
  "code": "string",
  "description": "string"
}

Properties

Name Type Required Restrictions Description
code string true none none
description string true none none

AutoInsuranceCovaregeAttibutesDetails

{
  "amount": 0,
  "unit": {
    "code": "string",
    "description": "string"
  }
}

Properties

Name Type Required Restrictions Description
amount number true none none
unit AutoInsuranceCovaregeAttibutesDetailsUnit true none none

AutoInsuranceContractBase

[
  {
    "contractBaseType": "VALOR DETERMINADO",
    "contractBaseMinValue": {
      "amount": 0,
      "unit": {
        "code": "string",
        "description": "string"
      }
    },
    "contractBaseMaxValue": {
      "amount": 0,
      "unit": {
        "code": "string",
        "description": "string"
      }
    }
  }
]

Base de contratação.

Properties

Name Type Required Restrictions Description
contractBaseType string true none Incidência ao capital segurado da cobertura de casco.
contractBaseMinValue AutoInsuranceCovaregeAttibutesDetails false none Valor Base de Contratação Mínimo.
contractBaseMaxValue AutoInsuranceCovaregeAttibutesDetails false none Valor Base de Contratação Máximo.

Enumerated Values

Property Value
contractBaseType VALOR_DETERMINADO
contractBaseType VALOR_MERCADO
contractBaseType AMBOS

AutoInsuranceCoverageAttributes

{
  "minLMI": {
    "amount": 0,
    "unit": {
      "code": "string",
      "description": "string"
    }
  },
  "maxLMI": {
    "amount": 0,
    "unit": {
      "code": "string",
      "description": "string"
    }
  },
  "contractBase": [
    {
      "contractBaseType": "VALOR DETERMINADO",
      "contractBaseMinValue": {
        "amount": 0,
        "unit": {
          "code": "string",
          "description": "string"
        }
      },
      "contractBaseMaxValue": {
        "amount": 0,
        "unit": {
          "code": "string",
          "description": "string"
        }
      }
    }
  ],
  "newCarMaximumCalculatingPeriod": 12,
  "newCarContractBase": [
    {
      "contractBaseType": "VALOR DETERMINADO",
      "contractBaseMinValue": {
        "amount": 0,
        "unit": {
          "code": "string",
          "description": "string"
        }
      },
      "contractBaseMaxValue": {
        "amount": 0,
        "unit": {
          "code": "string",
          "description": "string"
        }
      }
    }
  ],
  "fullIndemnityPercentage": {
    "amount": 0,
    "unit": {
      "code": "string",
      "description": "string"
    }
  },
  "deductibleType": [
    "NORMAL"
  ],
  "fullIndemnityDeductible": true,
  "deductiblePaymentByCoverage": true,
  "deductiblePercentage": {
    "amount": 0,
    "unit": {
      "code": "string",
      "description": "string"
    }
  },
  "mandatoryParticipation": "Casco - RCF-V Danos",
  "geographicScopeCoverage": [
    "NACIONAL"
  ],
  "geographicScopeCoverageOthers": "string"
}

Atributos da cobertura.

Properties

Name Type Required Restrictions Description
minLMI AutoInsuranceCovaregeAttibutesDetails true none Lista com valor mínimo de LMI aceito pela sociedade para cada cobertura.
maxLMI AutoInsuranceCovaregeAttibutesDetails true none Lista com valor máximo de LMI aceito pela sociedade para cada cobertura.
contractBase AutoInsuranceContractBase true none Veículo Zero Km Base de Contratação
newCarMaximumCalculatingPeriod integer true none Prazo máximo para apuração do valor a ser indenizado para veículo zero quilômetro. Em meses.
newCarContractBase AutoInsuranceContractBase false none Semelhante ao campo “Atributos cobertura - base de contratação” aplicada ao veículo Zero Km.
fullIndemnityPercentage AutoInsuranceCovaregeAttibutesDetails true none Percentual do Limite Máximo de Indenização para caracterização de indenização integral.
deductibleType [string] true none Listagem de tipo de franquia para cada tipo de cobertura do produto.
fullIndemnityDeductible boolean true none Franquia para Indenização Integral.
deductiblePaymentByCoverage boolean true none Sinalização para cada cobertura se a seguradora exige pagamento de franquia.
deductiblePercentage AutoInsuranceCovaregeAttibutesDetails true none Listagem percentual de franquia e/ou percentual de participação obrigatória do segurado estabelecida pela sociedade para cada tipo de cobertura de produto.
mandatoryParticipation string true none Participação Obrigatória do Segurado.
geographicScopeCoverage [string] true none Listagem de abrangência geográfica do produto para fins de cada cobertura.
geographicScopeCoverageOthers string false none Âmbito geográficoda cobertura - Outros

AutoInsuranceMinimumRequirements

{
  "contractingType": [
    "COLETIVO"
  ],
  "contractingMinRequirement": "https://example.com/mobile-banking"
}

Produtos de Seguro de Automóvel.

Properties

Name Type Required Restrictions Description
contractingType [string] true none Informações sobre todos os requisitos mínimos para contratação.
contractingMinRequirement string true none Campo aberto contendo todos os requisitos mínimos para contratação (possibilidade de incluir URL).

AutoInsuranceTermsAndConditions

[
  {
    "susepProcessNumber": "15414.622222/2222-22",
    "definition": "https://ey.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.pdf"
  }
]

Properties

Name Type Required Restrictions Description
susepProcessNumber string true none Número do processo SUSEP.
definition string true none Campo aberto (possibilidade de incluir uma url).

AutoInsurancePremiumPayment

{
  "paymentMethod": [
    "CARTÃO DE CRÉDITO"
  ],
  "paymentType": [
    "PARCELADO"
  ],
  "paymentDetail": "string"
}

Informações de pagamento de prêmio.

Properties

Name Type Required Restrictions Description
paymentMethod [string] true none Meio de pagamento escolhido pelo segurado.
paymentType [string] false none Forma de pagamento.
paymentDetail string false none Campo aberto para detalhamento do campo ‘Outros’ por cada participante.

AutoInsuranceAssistanceServices

{
  "assistanceServicesPackage": [
    "ATE_10_SERVICOS"
  ],
  "assistanceServicesDetail": "Perda Parcial - Colisão",
  "chargeTypeSignaling": "GRATUITA"
}

Serviços de Assistência.

Properties

Name Type Required Restrictions Description
assistanceServicesPackage [string] true none Pacotes de Assistência - Agrupamento.
assistanceServicesDetail string true none Serviços de assistência - Detalhamento.
chargeTypeSignaling string false none Sinalização em campo exclusivo se o pacote de Assistência é gratuita ou contratada/paga.

Enumerated Values

Property Value
chargeTypeSignaling GRATUITA
chargeTypeSignaling PAGA

AutoInsuranceCarPart

[
  {
    "carPartCondition": "NOVAS",
    "carPartType": "ORIGINAIS"
  }
]

Tipo de peça utilizada para reparação.

Properties

Name Type Required Restrictions Description
carPartCondition string true none Nova ou usada
carPartType string true none Originais e não originais

Enumerated Values

Property Value
carPartCondition NOVAS
carPartCondition USADAS
carPartCondition AMBAS
carPartType ORIGINAIS
carPartType COMPATIVEIS
carPartType AMBAS

AutoInsuranceCarModel

[
  {
    "manufacturer": "FORD",
    "model": "KA",
    "year": 2018,
    "fipeCode": "string"
  }
]

Listagem de modelos / ano de veículos. Deve ser padronizada na proposta técnica submetida pela Estrutura Inicial de Governança para observância comum por todas as sociedades participantes.

Properties

Name Type Required Restrictions Description
manufacturer string true none Fabricante
model string true none Modelo
year integer true none Ano de fabricação.
fipeCode string true none Código FIPE do veículo.

{
  "self": "https://api.organizacao.com.br/open-insurance/products-services/v1",
  "first": "https://api.organizacao.com.br/open-insurance/products-services/v1",
  "prev": "string",
  "next": "string",
  "last": "https://api.organizacao.com.br/open-insurance/products-services/v1"
}

Properties

Name Type Required Restrictions Description
self string false none URL da página atualmente requisitada
first string false none URL da primeira página de registros
prev string false none URL da página anterior de registros
next string false none URL da próxima página de registros
last string false none URL da última página de registros

Meta

{
  "totalRecords": 10,
  "totalPages": 1
}

Properties

Name Type Required Restrictions Description
totalRecords integer true none Total de registros encontrados
totalPages integer true none Total de páginas para os registros encontrados

ResponseError

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "requestDateTime": "2021-08-20T08:30:00Z"
    }
  ],
  "meta": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Properties

Name Type Required Restrictions Description
errors [object] true none none
» code string true none Código de erro específico do endpoint
» title string true none Título legível por humanos deste erro específico
» detail string true none Descrição legível por humanos deste erro específico
» requestDateTime string(date-time) true none Data e hora da consulta, conforme especificação RFC-3339, formato UTC.
meta Meta false none none

ResponseHomeInsuranceList

{
  "data": {
    "brand": {
      "name": "EMPRESA A seguros",
      "company": [
        {
          "name": "ABCDE SEGUROS",
          "cnpjNumber": 12345678901234,
          "products": [
            {
              "name": "RESIDENCIAL XPTO",
              "code": "0000-0",
              "coverages": [
                {
                  "coverageType": "Escritório em Residência",
                  "coverageDetail": "Cobertura especial para escritório residenciais",
                  "coveragePermissionSeparteAquisition": false,
                  "coverageAttributes": {
                    "minLMI": {},
                    "maxLMI": {},
                    "minDeductibleAmount": {},
                    "insuredMandatoryParticipationPercentage": 0
                  }
                }
              ],
              "propertyCharacteristics": [
                {
                  "propertyType": "CASA",
                  "propertyBuildType": "ALVENARIA",
                  "propertyUsageType": "HABITUAL",
                  "destinationInsuredImportance": "PRÉDIO"
                }
              ],
              "propertyZipCode": "1311000",
              "protective": true,
              "additional": [
                "SORTEIO_GRATUITO"
              ],
              "additionalOthers": "string",
              "assistanceServices": [
                {
                  "assistanceServicesPackage": "ATE_10_SERVICOS",
                  "complementaryAssistanceServicesDetail": "reboque pane seca",
                  "chargeTypeSignaling": "GRATUITA"
                }
              ],
              "termsAndConditions": [
                {
                  "susepProcessNumber": "XXXXX.XXXXXX/XXXX-XX",
                  "definition": "https://openinsurance.com.br/aaa"
                }
              ],
              "validity": [
                {
                  "term": "ANUAL",
                  "termOthers": "string"
                }
              ],
              "customerServices": [
                "LIVRE ESCOLHA"
              ],
              "premiumRates": [
                "string"
              ],
              "premiumPayments": [
                {
                  "paymentMethod": "CARTÃO DE CRÉDITO",
                  "paymentMethodDetail": "string",
                  "paymentType": "PAGAMENTO_UNICO"
                }
              ],
              "minimumRequirements": [
                {
                  "contractingType": "COLETIVO",
                  "contractingMinRequirement": "https://openinsurance.com.br/aaa"
                }
              ],
              "targetAudiences": [
                "PESSOA_NATURAL"
              ]
            }
          ]
        }
      ]
    }
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "first": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "prev": "string",
    "next": "string",
    "last": "https://api.organizacao.com.br/open-insurance/products-services/v1"
  },
  "meta": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Properties

Name Type Required Restrictions Description
data object true none none
» brand HomeInsuranceBrand false none none
links Links true none none
meta Meta true none none

HomeInsuranceBrand

{
  "name": "EMPRESA A seguros",
  "company": [
    {
      "name": "ABCDE SEGUROS",
      "cnpjNumber": 12345678901234,
      "products": [
        {
          "name": "RESIDENCIAL XPTO",
          "code": "0000-0",
          "coverages": [
            {
              "coverageType": "Escritório em Residência",
              "coverageDetail": "Cobertura especial para escritório residenciais",
              "coveragePermissionSeparteAquisition": false,
              "coverageAttributes": {
                "minLMI": {
                  "amount": 0,
                  "unit": {
                    "code": "R$",
                    "description": "REAL"
                  }
                },
                "maxLMI": {
                  "amount": 0,
                  "unit": {
                    "code": "R$",
                    "description": "REAL"
                  }
                },
                "minDeductibleAmount": {
                  "amount": 0,
                  "unit": {
                    "code": "R$",
                    "description": "REAL"
                  }
                },
                "insuredMandatoryParticipationPercentage": 0
              }
            }
          ],
          "propertyCharacteristics": [
            {
              "propertyType": "CASA",
              "propertyBuildType": "ALVENARIA",
              "propertyUsageType": "HABITUAL",
              "destinationInsuredImportance": "PRÉDIO"
            }
          ],
          "propertyZipCode": "1311000",
          "protective": true,
          "additional": [
            "SORTEIO_GRATUITO"
          ],
          "additionalOthers": "string",
          "assistanceServices": [
            {
              "assistanceServicesPackage": "ATE_10_SERVICOS",
              "complementaryAssistanceServicesDetail": "reboque pane seca",
              "chargeTypeSignaling": "GRATUITA"
            }
          ],
          "termsAndConditions": [
            {
              "susepProcessNumber": "XXXXX.XXXXXX/XXXX-XX",
              "definition": "https://openinsurance.com.br/aaa"
            }
          ],
          "validity": [
            {
              "term": "ANUAL",
              "termOthers": "string"
            }
          ],
          "customerServices": [
            "LIVRE ESCOLHA"
          ],
          "premiumRates": [
            "string"
          ],
          "premiumPayments": [
            {
              "paymentMethod": "CARTÃO DE CRÉDITO",
              "paymentMethodDetail": "string",
              "paymentType": "PAGAMENTO_UNICO"
            }
          ],
          "minimumRequirements": [
            {
              "contractingType": "COLETIVO",
              "contractingMinRequirement": "https://openinsurance.com.br/aaa"
            }
          ],
          "targetAudiences": [
            "PESSOA_NATURAL"
          ]
        }
      ]
    }
  ]
}

Properties

Name Type Required Restrictions Description
name string true none Nome da marca reportada pelo participante do Open Insurance. O conceito a que se refere a marca é em essência uma promessa das sociedades sob ela em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
company HomeInsuranceCompany false none none

HomeInsuranceCompany

[
  {
    "name": "ABCDE SEGUROS",
    "cnpjNumber": 12345678901234,
    "products": [
      {
        "name": "RESIDENCIAL XPTO",
        "code": "0000-0",
        "coverages": [
          {
            "coverageType": "Escritório em Residência",
            "coverageDetail": "Cobertura especial para escritório residenciais",
            "coveragePermissionSeparteAquisition": false,
            "coverageAttributes": {
              "minLMI": {
                "amount": 0,
                "unit": {
                  "code": "R$",
                  "description": "REAL"
                }
              },
              "maxLMI": {
                "amount": 0,
                "unit": {
                  "code": "R$",
                  "description": "REAL"
                }
              },
              "minDeductibleAmount": {
                "amount": 0,
                "unit": {
                  "code": "R$",
                  "description": "REAL"
                }
              },
              "insuredMandatoryParticipationPercentage": 0
            }
          }
        ],
        "propertyCharacteristics": [
          {
            "propertyType": "CASA",
            "propertyBuildType": "ALVENARIA",
            "propertyUsageType": "HABITUAL",
            "destinationInsuredImportance": "PRÉDIO"
          }
        ],
        "propertyZipCode": "1311000",
        "protective": true,
        "additional": [
          "SORTEIO_GRATUITO"
        ],
        "additionalOthers": "string",
        "assistanceServices": [
          {
            "assistanceServicesPackage": "ATE_10_SERVICOS",
            "complementaryAssistanceServicesDetail": "reboque pane seca",
            "chargeTypeSignaling": "GRATUITA"
          }
        ],
        "termsAndConditions": [
          {
            "susepProcessNumber": "XXXXX.XXXXXX/XXXX-XX",
            "definition": "https://openinsurance.com.br/aaa"
          }
        ],
        "validity": [
          {
            "term": "ANUAL",
            "termOthers": "string"
          }
        ],
        "customerServices": [
          "LIVRE ESCOLHA"
        ],
        "premiumRates": [
          "string"
        ],
        "premiumPayments": [
          {
            "paymentMethod": "CARTÃO DE CRÉDITO",
            "paymentMethodDetail": "string",
            "paymentType": "PAGAMENTO_UNICO"
          }
        ],
        "minimumRequirements": [
          {
            "contractingType": "COLETIVO",
            "contractingMinRequirement": "https://openinsurance.com.br/aaa"
          }
        ],
        "targetAudiences": [
          "PESSOA_NATURAL"
        ]
      }
    ]
  }
]

Properties

Name Type Required Restrictions Description
name string true none Nome da sociedade pertencente à marca.
cnpjNumber string true none CNPJ da sociedade pertencente à marca.
products HomeInsuranceProduct false none Produtos de Seguro Residencial.

HomeInsuranceProduct

[
  {
    "name": "RESIDENCIAL XPTO",
    "code": "0000-0",
    "coverages": [
      {
        "coverageType": "Escritório em Residência",
        "coverageDetail": "Cobertura especial para escritório residenciais",
        "coveragePermissionSeparteAquisition": false,
        "coverageAttributes": {
          "minLMI": {
            "amount": 0,
            "unit": {
              "code": "R$",
              "description": "REAL"
            }
          },
          "maxLMI": {
            "amount": 0,
            "unit": {
              "code": "R$",
              "description": "REAL"
            }
          },
          "minDeductibleAmount": {
            "amount": 0,
            "unit": {
              "code": "R$",
              "description": "REAL"
            }
          },
          "insuredMandatoryParticipationPercentage": 0
        }
      }
    ],
    "propertyCharacteristics": [
      {
        "propertyType": "CASA",
        "propertyBuildType": "ALVENARIA",
        "propertyUsageType": "HABITUAL",
        "destinationInsuredImportance": "PRÉDIO"
      }
    ],
    "propertyZipCode": "1311000",
    "protective": true,
    "additional": [
      "SORTEIO_GRATUITO"
    ],
    "additionalOthers": "string",
    "assistanceServices": [
      {
        "assistanceServicesPackage": "ATE_10_SERVICOS",
        "complementaryAssistanceServicesDetail": "reboque pane seca",
        "chargeTypeSignaling": "GRATUITA"
      }
    ],
    "termsAndConditions": [
      {
        "susepProcessNumber": "XXXXX.XXXXXX/XXXX-XX",
        "definition": "https://openinsurance.com.br/aaa"
      }
    ],
    "validity": [
      {
        "term": "ANUAL",
        "termOthers": "string"
      }
    ],
    "customerServices": [
      "LIVRE ESCOLHA"
    ],
    "premiumRates": [
      "string"
    ],
    "premiumPayments": [
      {
        "paymentMethod": "CARTÃO DE CRÉDITO",
        "paymentMethodDetail": "string",
        "paymentType": "PAGAMENTO_UNICO"
      }
    ],
    "minimumRequirements": [
      {
        "contractingType": "COLETIVO",
        "contractingMinRequirement": "https://openinsurance.com.br/aaa"
      }
    ],
    "targetAudiences": [
      "PESSOA_NATURAL"
    ]
  }
]

Produtos de Seguro Residencial.

Properties

Name Type Required Restrictions Description
name string true none Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code string true none Código único a ser definido pela sociedade.
coverages HomeInsuranceCoverages true none Listagem de coberturas incluídas no produto.
propertyCharacteristics HomeInsurancePropertyCharacteristics true none Caracteristicas do imóvel.
propertyZipCode string true none Código de Endereçamento Postal do Imóvel
protective boolean true none Protecionais - Indicativo de exigência de itens protecionais.
additional [string] true none none
additionalOthers string false none Campo aberto para descrição de cada participante ao selecionar o domínio ‘Outros’ no campo acima ‘Adicionais’.
assistanceServices HomeInsuranceAssistanceServices true none Agrupamento dos serviços de assistências disponíveis vinculado ao produto.
termsAndConditions HomeInsuranceTermsAndConditions true none Informações dos termos e condições conforme número do processo SUSEP.
validity HomeInsuranceValidity true none Vigência
customerServices [string] false none Informações de pagamento de prêmio.
premiumRates [string] false none Distribuição de frequência relativa aos valores referentes às taxas cobradas.
premiumPayments HomeInsurancePremiumPayment true none Informações de pagamento de prêmio.
minimumRequirements [HomeInsuranceMinimumRequirements] false none [Produtos de Seguro Residencial.]
targetAudiences [string] true none none

HomeInsuranceMinimumRequirements

{
  "contractingType": "COLETIVO",
  "contractingMinRequirement": "https://openinsurance.com.br/aaa"
}

Produtos de Seguro Residencial.

Properties

Name Type Required Restrictions Description
contractingType string true none Tipo de contratação.
contractingMinRequirement string true none Campo aberto contendo todos os requisitos mínimos para contratação (possibilidade de incluir URL).

Enumerated Values

Property Value
contractingType COLETIVO
contractingType INDIVIDUAL
contractingType AMBAS

HomeInsuranceCoverageAttributes

{
  "minLMI": {
    "amount": 0,
    "unit": {
      "code": "R$",
      "description": "REAL"
    }
  },
  "maxLMI": {
    "amount": 0,
    "unit": {
      "code": "R$",
      "description": "REAL"
    }
  },
  "minDeductibleAmount": {
    "amount": 0,
    "unit": {
      "code": "R$",
      "description": "REAL"
    }
  },
  "insuredMandatoryParticipationPercentage": 0
}

Informações de cobertura do Seguro Residencial.

Properties

Name Type Required Restrictions Description
minLMI HomeInsuranceCovaregeAttibutesDetails true none Lista com valor mínimo de LMI aceito pela sociedade para cada cobertura.
maxLMI HomeInsuranceCovaregeAttibutesDetails true none Lista com valor máximo de LMI aceito pela sociedade para cada cobertura.
minDeductibleAmount HomeInsuranceCovaregeAttibutesDetails true none Valor mínimo de franquia e participação obrigatória do segurado - Listagem de valor mínimo da franquia (Reais) e/ou Participação Obrigatória do Segurado (Percentual) estabelecida pela sociedade para cada tipo de cobertura do produto.
insuredMandatoryParticipationPercentage number true none Listagem percentual de franquia e/ou percentual de participação obrigatória do segurado estabelecida pela sociedade para cada tipo de cobertura de produto.

HomeInsuranceCovaregeAttibutesDetailsUnit

{
  "code": "R$",
  "description": "REAL"
}

Properties

Name Type Required Restrictions Description
code string true none none
description string true none none

HomeInsuranceCovaregeAttibutesDetails

{
  "amount": 0,
  "unit": {
    "code": "R$",
    "description": "REAL"
  }
}

Properties

Name Type Required Restrictions Description
amount number true none none
unit HomeInsuranceCovaregeAttibutesDetailsUnit true none none

HomeInsuranceTermsAndConditions

[
  {
    "susepProcessNumber": "XXXXX.XXXXXX/XXXX-XX",
    "definition": "https://openinsurance.com.br/aaa"
  }
]

Informações dos termos e condições conforme número do processo SUSEP.

Properties

Name Type Required Restrictions Description
susepProcessNumber string true none Número do processo SUSEP.
definition string true none Campo aberto (possibilidade de incluir uma url).

HomeInsuranceValidity

[
  {
    "term": "ANUAL",
    "termOthers": "string"
  }
]

Vigência

Properties

Name Type Required Restrictions Description
term string true none Prazo de vigência do seguro contratado Intervalo contínuo de tempo durante o qual está em vigor o contrato de seguro. (RESOLUÇÃO CNSP Nº 341/2016).
termOthers string false none Campo livre para descrição por cada participante ao selecionar o domínio “Outros” no campo Prazo (acima).

Enumerated Values

Property Value
term ANUAL
term ANUAL_INTERMITENTE
term PLURIANUAL
term PLURIANUAL_INTERMITENTE
term MENSAL
term MENSAL_INTERMITENTE
term DIARIO
term DIARIO_INTERMITENTE
term OUTROS

HomeInsurancePremiumPayment

[
  {
    "paymentMethod": "CARTÃO DE CRÉDITO",
    "paymentMethodDetail": "string",
    "paymentType": "PAGAMENTO_UNICO"
  }
]

Informações de pagamento de prêmio.

Properties

Name Type Required Restrictions Description
paymentMethod string true none Meio de pagamento escolhido pelo segurado.
paymentMethodDetail string false none Campo aberto para detalhamento do campo ‘Outros’ por cada participante.
paymentType string true none Forma de pagamento

Enumerated Values

Property Value
paymentMethod CARTAO_CREDITO
paymentMethod CARTAO_DEBITO
paymentMethod DEBITO_CONTA_CORRENTE
paymentMethod DEBITO_CONTA_POUPANCA
paymentMethod BOLETO_BANCARIO
paymentMethod PIX
paymentMethod CONSIGINACAO_FOLHA_PAGAMENTO
paymentMethod PONTOS_PROGRAMAS_BENEFICIO
paymentMethod OUTROS
paymentType PAGAMENTO_UNICO
paymentType PARCELADO
paymentType AMBOS

HomeInsuranceAssistanceServices

[
  {
    "assistanceServicesPackage": "ATE_10_SERVICOS",
    "complementaryAssistanceServicesDetail": "reboque pane seca",
    "chargeTypeSignaling": "GRATUITA"
  }
]

Agrupamento dos serviços de assistências disponíveis vinculado ao produto.

Properties

Name Type Required Restrictions Description
assistanceServicesPackage string true none Pacotes de Assistência.
complementaryAssistanceServicesDetail string true none Campo livre para descrição dos serviços ofertados por cada sociedade participante.
chargeTypeSignaling string true none Sinalização em campo exclusivo se o pacote de Assistência é gratuita ou contratada/paga.

Enumerated Values

Property Value
assistanceServicesPackage ATE_10_SERVICOS
assistanceServicesPackage ATE_20_SERVICOS
assistanceServicesPackage ACIMA_20_SERVICOS
assistanceServicesPackage CUSTOMIZAVEL
chargeTypeSignaling GRATUITA
chargeTypeSignaling PAGO

HomeInsuranceCoverages

[
  {
    "coverageType": "Escritório em Residência",
    "coverageDetail": "Cobertura especial para escritório residenciais",
    "coveragePermissionSeparteAquisition": false,
    "coverageAttributes": {
      "minLMI": {
        "amount": 0,
        "unit": {
          "code": "R$",
          "description": "REAL"
        }
      },
      "maxLMI": {
        "amount": 0,
        "unit": {
          "code": "R$",
          "description": "REAL"
        }
      },
      "minDeductibleAmount": {
        "amount": 0,
        "unit": {
          "code": "R$",
          "description": "REAL"
        }
      },
      "insuredMandatoryParticipationPercentage": 0
    }
  }
]

Listagem de coberturas incluídas no produto.

Properties

Name Type Required Restrictions Description
coverageType string true none Nome do tipo da cobertura.
coverageDetail string true none Campo aberto para detalhamento por coberturas possíveis dos produtos a ser feito por cada participante.
coveragePermissionSeparteAquisition boolean true none Indicação se a cobertura permite contratação separada (por cobertura selecionada).
coverageAttributes HomeInsuranceCoverageAttributes true none Informações de cobertura do Seguro Residencial.

Enumerated Values

Property Value
coverageType IMOVEL_BASICA
coverageType IMOVEL_AMPLA
coverageType DANOS_ELETRICOS
coverageType DANOS_POR_AGUA
coverageType ALAGAMENTO
coverageType RESPONSABILIDADE_CIVIL_FAMILIAR
coverageType RESPONSABILIDADE_CIVIL_DANOS_MORAIS
coverageType ROUBO_SUBTRACAO_BENS
coverageType ROUBO_SUBTRACAO_BENS_FORA_LOCAL_SEGURADO
coverageType TACOS_GOLFE_HOLE_ONE
coverageType PEQUENAS_REFORMAS_OBRAS
coverageType GREVES_TUMULTOS_LOCKOUT
coverageType MICROEMPREENDEDOR
coverageType ESCRITORIO_RESIDENCIA
coverageType DANOS_EQUIPAMENTOS_ELETRONICOS
coverageType QUEBRA_VIDROS
coverageType IMPACTO_VEICULOS
coverageType VENDAVAL
coverageType PERDA_PAGAMENTO_ALUGUEL
coverageType BICICLETA
coverageType RESPONSABILIDADE_CIVIL_BICICLETA
coverageType RC_EMPREGADOR
coverageType DESMORONAMENTO
coverageType DESPESAS_EXTRAORDINARIAS
coverageType JOIAS_OBRAS_ARTE
coverageType TERREMOTO
coverageType IMPACTO_AERONAVES
coverageType PAISAGISMO
coverageType INCENDIO
coverageType QUEDA_RAIO
coverageType EXPLOSAO
coverageType OUTRAS

HomeInsurancePropertyCharacteristics

[
  {
    "propertyType": "CASA",
    "propertyBuildType": "ALVENARIA",
    "propertyUsageType": "HABITUAL",
    "destinationInsuredImportance": "PRÉDIO"
  }
]

Caracteristicas do imóvel.

Properties

Name Type Required Restrictions Description
propertyType string true none Tipo de imóvel.
propertyBuildType string true none Descrição do tipo de construção da propriedade.
propertyUsageType string true none Descrição do tipo de uso da propriedade.
destinationInsuredImportance string true none Destinação da Importância Segurada.

Enumerated Values

Property Value
propertyType CASA
propertyType APARTAMENTO
propertyBuildType ALVENARIA
propertyBuildType MADEIRA
propertyBuildType METALICA
propertyBuildType MISTA
propertyUsageType HABITUAL
propertyUsageType VERANEIO
propertyUsageType DESOCUPADO
propertyUsageType CASA_ESCRITORIO
propertyUsageType ALUGUEL_TEMPORADA
destinationInsuredImportance PREDIO
destinationInsuredImportance CONTEUDO
destinationInsuredImportance AMBOS

{
  "self": "https://api.organizacao.com.br/open-insurance/products-services/v1",
  "first": "https://api.organizacao.com.br/open-insurance/products-services/v1",
  "prev": "string",
  "next": "string",
  "last": "https://api.organizacao.com.br/open-insurance/products-services/v1"
}

Properties

Name Type Required Restrictions Description
self string false none URL da página atualmente requisitada
first string false none URL da primeira página de registros
prev string false none URL da página anterior de registros
next string false none URL da próxima página de registros
last string false none URL da última página de registros

Meta

{
  "totalRecords": 10,
  "totalPages": 1
}

Properties

Name Type Required Restrictions Description
totalRecords integer true none Total de registros encontrados
totalPages integer true none Total de páginas para os registros encontrados

ResponseError

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "requestDateTime": "2021-08-20T08:30:00Z"
    }
  ],
  "meta": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Properties

Name Type Required Restrictions Description
errors [object] true none none
» code string true none Código de erro específico do endpoint
» title string true none Título legível por humanos deste erro específico
» detail string true none Descrição legível por humanos deste erro específico
» requestDateTime string(date-time) true none Data e hora da consulta, conforme especificação RFC-3339, formato UTC.
meta Meta false none none

ResponseCapitalizationTitleList

{
  "requestTime": "2021-08-20T08:30:00Z",
  "brand": {
    "name": "ACME seguros",
    "companies": [
      {
        "name": "ACME cap da ACME seguros",
        "cnpjNumber": "12345678901234",
        "product": [
          {
            "name": "ACMEcap",
            "code": "01234589_cap",
            "modality": [
              "TRADICIONAL"
            ],
            "costType": [
              "PAGAMENTO_UNICO"
            ],
            "termsAndConditions": {
              "susepProcessNumber": 15414622222222222,
              "termsRegulations": "https://ey.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.pdf"
            },
            "quotas": [
              {
                "quota": 10,
                "capitalizationQuota": [
                  10
                ],
                "raffleQuota": [
                  10
                ],
                "chargingQuota": [
                  10
                ]
              }
            ],
            "validity": 48,
            "serieSize": 5000000,
            "capitalizationPeriod": {
              "interestRate": 0.25123,
              "updateIndex": [
                "IPCA"
              ],
              "others": [
                "Índice de atualização"
              ],
              "contributionAmount": {
                "minValue": 500,
                "maxValue": 5000,
                "frequency": "MENSAL",
                "value": 0
              },
              "earlyRedemption": [
                10
              ],
              "redemptionPercentageEndTerm": 100.002,
              "gracePeriodRedemption": 48
            },
            "latePayment": {
              "suspensionPeriod": 10,
              "termExtensionOption": true
            },
            "contributionPayment": {
              "paymentMethod": [
                "CARTAO_CREDITO"
              ],
              "updateIndex": [
                "IPCA"
              ],
              "others": [
                "Índice de atualização"
              ]
            },
            "redemption": {
              "redemption": 151.23
            },
            "raffle": {
              "raffleQty": 10000,
              "timeInterval": [
                "QUINZENAL"
              ],
              "raffleValue": 5,
              "earlySettlementRaffle": true,
              "mandatoryContemplation": true,
              "ruleDescription": "Sorteio às quartas-feiras",
              "minimumContemplationProbability": 0.000001
            },
            "additionalDetails": {
              "additionalDetails": "https://example.com/openinsurance"
            },
            "minimumRequirements": {
              "minimumRequirementDetails": "https://ey.exemplo/capitalizacao/tradicional/PU/requisitos_min",
              "targetAudiences": [
                "PESSOAL_NATURAL"
              ]
            }
          }
        ]
      }
    ]
  },
  "links": {
    "self": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "first": "https://api.organizacao.com.br/open-insurance/products-services/v1",
    "prev": "string",
    "next": "string",
    "last": "https://api.organizacao.com.br/open-insurance/products-services/v1"
  },
  "meta": {
    "totalRecords": 10,
    "totalPages": 1
  }
}

Properties

Name Type Required Restrictions Description
requestTime string(date-time) false none Data e hora da consulta, conforme especificação RFC-3339, formato UTC.
brand CapitalizationTitleBrand true none Organização controladora do grupo.
links Links true none none
meta Meta true none none

CapitalizationTitleBrand

{
  "name": "ACME seguros",
  "companies": [
    {
      "name": "ACME cap da ACME seguros",
      "cnpjNumber": "12345678901234",
      "product": [
        {
          "name": "ACMEcap",
          "code": "01234589_cap",
          "modality": [
            "TRADICIONAL"
          ],
          "costType": [
            "PAGAMENTO_UNICO"
          ],
          "termsAndConditions": {
            "susepProcessNumber": 15414622222222222,
            "termsRegulations": "https://ey.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.pdf"
          },
          "quotas": [
            {
              "quota": 10,
              "capitalizationQuota": [
                10
              ],
              "raffleQuota": [
                10
              ],
              "chargingQuota": [
                10
              ]
            }
          ],
          "validity": 48,
          "serieSize": 5000000,
          "capitalizationPeriod": {
            "interestRate": 0.25123,
            "updateIndex": [
              "IPCA"
            ],
            "others": [
              "Índice de atualização"
            ],
            "contributionAmount": {
              "minValue": 500,
              "maxValue": 5000,
              "frequency": "MENSAL",
              "value": 0
            },
            "earlyRedemption": [
              10
            ],
            "redemptionPercentageEndTerm": 100.002,
            "gracePeriodRedemption": 48
          },
          "latePayment": {
            "suspensionPeriod": 10,
            "termExtensionOption": true
          },
          "contributionPayment": {
            "paymentMethod": [
              "CARTAO_CREDITO"
            ],
            "updateIndex": [
              "IPCA"
            ],
            "others": [
              "Índice de atualização"
            ]
          },
          "redemption": {
            "redemption": 151.23
          },
          "raffle": {
            "raffleQty": 10000,
            "timeInterval": [
              "QUINZENAL"
            ],
            "raffleValue": 5,
            "earlySettlementRaffle": true,
            "mandatoryContemplation": true,
            "ruleDescription": "Sorteio às quartas-feiras",
            "minimumContemplationProbability": 0.000001
          },
          "additionalDetails": {
            "additionalDetails": "https://example.com/openinsurance"
          },
          "minimumRequirements": {
            "minimumRequirementDetails": "https://ey.exemplo/capitalizacao/tradicional/PU/requisitos_min",
            "targetAudiences": [
              "PESSOAL_NATURAL"
            ]
          }
        }
      ]
    }
  ]
}

Organização controladora do grupo.

Properties

Name Type Required Restrictions Description
name string true none Nome da marca reportada pelo participante do Open Insurance. O conceito a que se refere a marca é em essência uma promessa das sociedades sob ela em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
companies CapitalizationTitleCompany true none none

CapitalizationTitleCompany

[
  {
    "name": "ACME cap da ACME seguros",
    "cnpjNumber": "12345678901234",
    "product": [
      {
        "name": "ACMEcap",
        "code": "01234589_cap",
        "modality": [
          "TRADICIONAL"
        ],
        "costType": [
          "PAGAMENTO_UNICO"
        ],
        "termsAndConditions": {
          "susepProcessNumber": 15414622222222222,
          "termsRegulations": "https://ey.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.pdf"
        },
        "quotas": [
          {
            "quota": 10,
            "capitalizationQuota": [
              10
            ],
            "raffleQuota": [
              10
            ],
            "chargingQuota": [
              10
            ]
          }
        ],
        "validity": 48,
        "serieSize": 5000000,
        "capitalizationPeriod": {
          "interestRate": 0.25123,
          "updateIndex": [
            "IPCA"
          ],
          "others": [
            "Índice de atualização"
          ],
          "contributionAmount": {
            "minValue": 500,
            "maxValue": 5000,
            "frequency": "MENSAL",
            "value": 0
          },
          "earlyRedemption": [
            10
          ],
          "redemptionPercentageEndTerm": 100.002,
          "gracePeriodRedemption": 48
        },
        "latePayment": {
          "suspensionPeriod": 10,
          "termExtensionOption": true
        },
        "contributionPayment"