B3 Insurance (Seguros) APIs

{"id":"a62d7886-257c-4814-b21c-7e095369801a","description":"<details><summary><b>Vis\u00e3o Geral<\/b><\/summary><br\/><p>\r\n\r\nEste documento descreve o conjunto de defini\u00e7\u00f5es da API desenvolvida conforme layout SUSEP que ser\u00e3o utilizadas no processo de registro de Sinistro do Evento Gerador de Seguros. \r\n\r\n**Funcionalidade da API**\r\n- Registro de Sinistros\r\n- Altera\u00e7\u00e3o de Sinistros\r\n\r\nEsse documento trata especificamente da interface de comunica\u00e7\u00e3o API Web (REST) via internet.\r\n\r\nConstru\u00edda no padr\u00e3o REST (Representational State Transfer), consiste em um conjunto de URL\u2019s (Uniform Resource Locator) que viabilizam a realiza\u00e7\u00e3o de coleta e envio de mensagens executadas por sistema. \r\n\r\nNas p\u00e1ginas a seguir ser\u00e1 informada toda a documenta\u00e7\u00e3o necess\u00e1ria para a API de Sinistros, que possibilitam conex\u00f5es diretas entre os sistemas dos participantes.\r\n<\/p><\/details><br\/>\r\n\r\n<details><summary><b>Regras e Boas Pr\u00e1ticas<\/b><\/summary><br\/><p>\r\n\r\nPara garantir a sa\u00fade da nossa plataforma e um acesso justo para todos aconselhamos seguir as orienta\u00e7\u00f5es de boas pr\u00e1ticas de consumo das APIs. \r\n\r\n**Requisitos de Utiliza\u00e7\u00e3o da API:**\r\n\r\n- Ser cliente da B3 com direito de acesso ao sistema.\r\n- Ter uma conta ativa no InsurConnect.\r\n- Possuir os certificados de acesso (produ\u00e7\u00e3o e certifica\u00e7\u00e3o)\r\n- Possuir conectividade com a B3 atrav\u00e9s da Internet.\r\n\r\n**Tamanho m\u00e1ximo do arquivo:**\r\n\r\n- Para envio a APIs em Lotes iremos receber arquivos de at\u00e9 10MB.\r\n\r\n**Frequ\u00eancia de envio de lote:**\r\n\r\n- Para envio dos lotes das APIs deve ser respeitado o limite global de 160 TPS para os Ambiente de Produ\u00e7\u00e3o e Ambiente de Certifica\u00e7\u00e3o, caso ultrapasse ir\u00e1 receber uma cr\u00edtica \r\nde recusa do lote.\r\n\r\n<\/p><\/details><br\/>\r\n\r\n<details><summary><b>Host<\/b><\/summary><br\/><p>\r\n\r\n**Para acessar as APIs utilize as URLs abaixo:**\r\n\r\n- Certifica\u00e7\u00e3o: https:\/\/api-seguros-cert-insurconnect.b3.com.br\r\n- Produ\u00e7\u00e3o: https:\/\/api-seguros-insurconnect.b3.com.br\r\n\r\n<\/p><\/details><br\/>\r\n\r\n<details><summary><b>Modelo de Autentica\u00e7\u00e3o<\/b><\/summary><br\/><p>\r\n\r\n**Orienta\u00e7\u00f5es de Configura\u00e7\u00e3o Certificado:** \r\n\r\nAo configurar o certificado em uma ferramenta verifique os seguintes pontos:\r\n- Se o host foi preenchido com a url correta de certifica\u00e7\u00e3o ou produ\u00e7\u00e3o. \r\n- Lembre-se de colocar a senha que foi disponibilizada junto do certificado. \r\n- Configure corretamente os arquivos .cer e .key ou utilize somente o arquivo .p12\r\n \r\nAp\u00f3s a configura\u00e7\u00e3o do certificado, para realizar um registro com sucesso via API \u00e9 necess\u00e1rio que seja feita uma chamada na API de autentica\u00e7\u00e3o para que seja gerado um token JWT (padr\u00e3o Oauth 2.0), no qual ser\u00e1 utilizado para fazer o envio dos registros. \r\nLembre-se de informar corretamente o client_id e secrect_id fornecido junto ao certificado que \u00e9 espec\u00edfico para cada ambiente (certifica\u00e7\u00e3o e produ\u00e7\u00e3o). \r\n\r\n[Clique aqui](\/index.php?option=com_content&view=article&id=34) para mais informa\u00e7\u00f5es sobre o Modelo de Autentica\u00e7\u00e3o utilizado.\r\n\r\n<\/p><\/details><br\/>","deprecated":false,"apiVersion":"3.0.0-rc11","swaggerVersion":"1.1","basePath":"https:\/\/developers.b3.com.br:8065","resourcePath":"\/api\/sinistros\/v3","models":{"sinistro_alteracao":{"type":"object","required":["alteracao_sinistro_codigo","apolice_codigo","coberturas_afetadas","codigo_seguradora","codigo_sinistro","moeda_apolice","possui_cosseguro","retificacao_registro","tipo_sinistro"],"properties":{"codigo_seguradora":{"type":"string","example":"xamt","description":"C\u00f3digo Susep da seguradora","maxLength":5},"codigo_sinistro":{"type":"string","example":"qrttezdzbjidxxbdduycxjandjqjykdtvwpgggghndblmantc","description":"Identificador do processo de sinistro","maxLength":50},"alteracao_sinistro_codigo":{"type":"string","example":"ialsreszdrobacfchksuucqvtfsmrlfewaidzwsikhmchwqwor","description":"Identificador da Altera\u00e7\u00e3o do Sinistro; numera\u00e7\u00e3o sequencial para as altera\u00e7\u00f5es espec\u00edficas deste sinistro. Destinado a ordenar as altera\u00e7\u00f5es, inclusive para duas ou mais altera\u00e7\u00f5es emitidas numa mesma data","maxLength":60},"apolice_codigo":{"type":"string","example":"rwgszrpautgzgyvsrdvkdnscimjmuywzbflckxuholaynuylkj","description":"Ap\u00f3lice, Bilhete, Contrato Coletivo ou Certificado de Participante Individual","maxLength":60},"certificado_codigo":{"type":"string","example":"pnoonzvlnkxdvniftokfqpfpniehwhablsqincqnutcenlikkw","description":"Identificador do certificado de seguro ou do certificado de participante coletivo de previd\u00eancia","maxLength":60},"tipo_sinistro":{"type":"integer","format":"int32","example":1,"description":"Tipo do sinistro movimentado.  Dom\u00ednio:  1 - Administrativo 2 - Judicial","minimum":1,"maximum":9,"enum":[1,2]},"moeda_apolice":{"type":"string","example":"BRL","description":"Moeda do movimento.  ISO 4217 Exemplo (  BRL ,  USD ,  EUR ,  GBP ,  JPY )","maxLength":3},"possui_beneficiario_final":{"type":"boolean","example":true,"description":"Indica se a seguradora tem identificado quais s\u00e3o os benefici\u00e1rios finais (pessoas f\u00edsicas), nos casos em que deve identificar com base na Circular Susep n\u00ba 612 2020. Obrigat\u00f3rio quando o campo Status do Sinistro  for igual a 2, 7 ou 8. "},"possui_cosseguro":{"type":"boolean","example":true,"description":"Indica se o sinistro registrado possui cosseguro"},"retificacao_registro":{"type":"boolean","example":true,"description":"Campo destinado a identificar se se trata de uma retifica\u00e7\u00e3o de registro existente"},"coberturas_afetadas":{"type":"array","items":{"$ref":"#\/definitions\/coberturas_afetadas_alteracao"}},"dados_rural":{"type":"array","items":{"$ref":"#\/definitions\/dados_rural"}},"dados_patrimonial":{"type":"array","items":{"$ref":"#\/definitions\/dados_patrimonial"}},"dados_auto":{"type":"array","items":{"$ref":"#\/definitions\/dados_auto"}},"beneficiario_final":{"type":"array","items":{"$ref":"#\/definitions\/beneficiario_final"}},"dados_carta_verde":{"type":"array","items":{"$ref":"#\/definitions\/dados_carta_verde"}}}},"justificativa_negativa":{"type":"object","required":["justificativa"],"properties":{"justificativa":{"type":"integer","format":"int32","example":1,"description":"Justificativa da negativa de sinistro. Dom\u00ednio: 1 - Risco Exclu\u00eddo 2 - Risco Agravado 3 - Sem Documenta\u00e7\u00e3o 4 - Documenta\u00e7\u00e3o Incompleta 5 - Prescri\u00e7\u00e3o 6 - Fora do Per\u00edodo de Vig\u00eancia da Cobertura 7 - Risco N\u00e3o Coberto 99 - Outros","minimum":1,"maximum":99,"enum":[1,2,3,4,5,6,7,99]},"descricao_justificativa":{"type":"string","example":"ejqkhbapidhkubhcemepwytgpllyulfembuvxcywplxpncllem","description":"Descri\u00e7\u00e3o da justificativa da negativa de sinistro. Campo obrigat\u00f3rio apenas para Justificativa cujo dom\u00ednio seja  99 - Outros","maxLength":1024}}},"Data2":{"type":"object","required":["identificador_lote"],"properties":{"identificador_lote":{"type":"string","example":"vwjrknzmyjuohdptpdqxvuf","description":"N\u00famero gerador na plataforma de seguros da B3 para identificar o lote de registro de documentos.","maxLength":24}}},"dados_carta_verde":{"type":"object","required":["numero_convenio","pais_ocorrencia_sinistro"],"properties":{"numero_convenio":{"type":"string","example":"1","description":"Indica o n\u00famero do conv\u00eanio","maxLength":50},"pais_ocorrencia_sinistro":{"type":"string","example":"ZZZ","description":"Pa\u00eds de ocorr\u00eancia do sinistro","maxLength":3}},"description":"Bloco de preenchimento obrigat\u00f3rio para o sinistro do ramo 0525. O bloco n\u00e3o deve ser preenchido quando n\u00e3o atendida esta condi\u00e7\u00e3o"},"coberturas_afetadas":{"type":"object","required":["cobertura_interna_seguradora","cod_cobertura_sinistro","data_aviso_cobertura","data_ocorrencia","data_registro_seguradora_cobertura","forma_indenizacao","grupo_ramo","status"],"properties":{"cobertura_interna_seguradora":{"type":"string","example":"jpycckfsrpmwaywisxyujpmmqhsomrwllbyumgsfuikohmowo","description":"Refer\u00eancia ao C\u00f3digo Interno da Cobertura da Seguradora da cobertura afetada","maxLength":50},"grupo_ramo":{"type":"string","example":"wxk","description":"Grupo e ramo. Para previd\u00eancia adotar: 88XX- Coberturas de Sobreviv\u00eancia (Previd\u00eancia), onde XX s\u00e3o os dois \u00faltimos n\u00fameros do identificador da cobertura conforme a tabela de coberturas 89XX - Coberturas de Risco (Previd\u00eancia),  onde XX s\u00e3o os dois \u00faltimos n\u00fameros do identificador da cobertura conforme a tabela de coberturas. Tabela de grupo e ramo","maxLength":4},"cod_cobertura_sinistro":{"type":"string","example":"fhlh","description":"C\u00f3digo da cobertura afetada. Tabela de Coberturas","maxLength":5},"sinistro_cobertura_outros":{"type":"string","example":"wpzqjnybregsmpdvqlbacolwjcoamrqbprgqbrubstusnewcgt","description":"Descri\u00e7\u00e3o   Nome da cobertura afetada (movimento). Obrigat\u00f3rio apenas para o dom\u00ednio do campo C\u00f3digo da Cobertura  99999 - Outros","maxLength":500},"data_aviso_cobertura":{"type":"string","format":"date","example":"2024-01-01","description":"Data de aviso do sinistro por cobertura (Formato : YYYY-MM-DD)"},"data_registro_seguradora_cobertura":{"type":"string","format":"date","example":"2024-01-01","description":"Data de aviso do sinistro \u00e0 seguradora por cobertura (Formato : YYYY-MM-DD)"},"data_reclamacao_terceiro_cobertura":{"type":"string","format":"date","example":"2024-01-01","description":"Data de Reclama\u00e7\u00e3o do Terceiro por cobertura. Obrigat\u00f3rio para o Grupo 03 e para os ramos 0553, 0623, 0628, 0632, 0638, 0644, 0652, 0654, 0655, 0656, 0658, 1428, 1528, 1537, 1597, 0437, 0523, 0544 e 0627 (Formato : YYYY-MM-DD)"},"data_entrega":{"type":"string","format":"date","example":"2024-01-01","description":"Data de entrega da documenta\u00e7\u00e3o completa, exigida pela seguradora para pagamento do sinistro. A data de entrega da documenta\u00e7\u00e3o deve ser maior ou igual \u00e0 data de aviso do sinistro. Obrigat\u00f3rio quando o campo  Status do Sinistro  for: - igual a 2, 7 ou 8;  ou - igual a 3 ou 9 e o campo  justificativa da negativa  for diferente de 3 e 4.  (Formato : YYYY-MM-DD)"},"status":{"type":"integer","format":"int32","example":1,"description":"Status do processo de sinistro.  Dom\u00ednio: 1 - Aberto 2 - Encerrado com Indeniza\u00e7\u00e3o 3 - Encerrado sem Indeniza\u00e7\u00e3o 4 - Reaberto 5 - Cancelado (Por erro operacional) 6 - Avalia\u00e7\u00e3o Inicial 7 - Encerrado com pagamento \u00fanico (benef\u00edcio) 8 - Encerrado com concess\u00e3o de renda (benef\u00edcio) 9 - Encerrado indeferido (benef\u00edcio)","minimum":1,"maximum":9,"enum":[1,2,3,4,5,6,7,8,9]},"data_ocorrencia":{"type":"string","format":"date","example":"2024-01-01","description":"Data de ocorr\u00eancia do sinistro (Formato : YYYY-MM-DD)"},"forma_indenizacao":{"type":"integer","format":"int32","example":1,"description":"Forma de pagamento da indeniza\u00e7\u00e3o, se mediante pagamento em dinheiro, reposi\u00e7\u00e3o do bem, reparo do bem, presta\u00e7\u00e3o de servi\u00e7o ou outra forma pactuada entre as partes.  Dom\u00ednio: 1 - Pagamento pecuni\u00e1rio; 2 - Reposi\u00e7\u00e3o; 3 - Reparo ou presta\u00e7\u00e3o de servi\u00e7o; 99 - Outros","minimum":1,"maximum":99,"enum":[1,2,3,99]},"data_liquidacao":{"type":"string","format":"date","example":"2024-01-01","description":"Data de in\u00edcio da liquida\u00e7\u00e3o do sinistro perante o segurado benefici\u00e1rio. Obrigat\u00f3rio quando o campo  Status do Sinistro  for igual a 2, 3, 7, 8 ou 9 (Formato : YYYY-MM-DD)"},"data_conclusao":{"type":"string","format":"date","example":"2024-01-01","description":"Data da liquida\u00e7\u00e3o definitiva do sinistro ou da negativa do sinistro. Obrigat\u00f3rio quando o campo  Status do Sinistro  for igual a 2, 3, 7, 8 ou 9  (Formato : YYYY-MM-DD)"},"data_salvado":{"type":"string","format":"date","example":"2024-01-01","description":"Data da venda do salvado (Formato : YYYY-MM-DD)"},"data_ressarcimento":{"type":"string","format":"date","example":"2024-01-01","description":"Data da recupera\u00e7\u00e3o do ressarcimento (Formato : YYYY-MM-DD)"},"justificativa_negativa":{"$ref":"#\/definitions\/justificativa_negativa"},"totalizacao_sinistro":{"$ref":"#\/definitions\/totalizacao_sinistro"}}},"AlteracaoReqPost":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/Data1"}},"id":"AlteracaoReqPost"},"cessionarias_cosseguro":{"type":"object","required":["codigo_cosseguradora","valor_pago_reais","valor_pendente_reais"],"properties":{"codigo_cosseguradora":{"type":"string","example":"jwgw","description":"Identifica\u00e7\u00e3o da cong\u00eanere, cession\u00e1rio do cosseguro. ","maxLength":5},"valor_pendente_reais":{"type":"number","format":"double","example":9.99,"description":"Valor Pendente em Reais a cargo da cession\u00e1ria"},"valor_pago_reais":{"type":"number","format":"double","example":9.99,"description":"Valor Pago em Reais a cargo da cession\u00e1ria"},"valor_pendente_moeda_original":{"type":"number","format":"double","example":9.99,"description":"Valor pendente do sinistro a cargo da cession\u00e1ria na moeda original da ap\u00f3lice. Campo obrigat\u00f3rio quando  moeda_apolice  for diferente de BRL"},"valor_pago_moeda_original":{"type":"number","format":"double","example":9.99,"description":"Valor pago do sinistro a cargo da cession\u00e1ria na moeda original da ap\u00f3lice. Campo obrigat\u00f3rio quando  moeda_apolice  for diferente de BRL"}}},"totalizacao_sinistro":{"type":"object","required":["valor_desp_fin","valor_despesa","valor_pago_reais","valor_pendente_reais","valor_ressarcimento","valor_salvado"],"properties":{"valor_pendente_reais":{"type":"number","format":"double","example":9.99,"description":"Valor Pendente em Reais. Campo deve considerar o valor absoluto (n\u00e3o \u00e9 Delta)"},"valor_pago_reais":{"type":"number","format":"double","example":9.99,"description":"Valor Pago em Reais. Campo deve considerar o valor absoluto (n\u00e3o \u00e9 Delta)"},"valor_salvado":{"type":"number","format":"double","example":9.99,"description":"Valor do Salvado em Reais. Campo deve considerar o valor absoluto (n\u00e3o \u00e9 Delta)"},"valor_ressarcimento":{"type":"number","format":"double","example":9.99,"description":"Valor do Ressarcimento em Reais. Campo deve considerar o valor absoluto (n\u00e3o \u00e9 Delta)"},"valor_despesa":{"type":"number","format":"double","example":9.99,"description":"Valor da Despesa em Reais. Campo deve considerar o valor absoluto (n\u00e3o \u00e9 Delta)"},"valor_desp_fin":{"type":"number","format":"double","example":9.99,"description":"Valor da Despesa Financeira Adicional (juros, multa, atualiza\u00e7\u00e3o monet\u00e1ria, oscila\u00e7\u00e3o cambial). Campo deve considerar o valor absoluto (n\u00e3o \u00e9 Delta)"},"valor_pendente_moeda_original":{"type":"number","format":"double","example":9.99,"description":"Valor Pendente do Sinistro na moeda original da ap\u00f3lice. Campo obrigat\u00f3rio quando  moeda_apolice  for diferente de BRL"},"valor_pago_moeda_original":{"type":"number","format":"double","example":9.99,"description":"Valor Pago do sinistro na moeda original da ap\u00f3lice. Campo obrigat\u00f3rio quando  moeda_apolice  for diferente de BRL"},"cessionarias_cosseguro":{"type":"array","items":{"$ref":"#\/definitions\/cessionarias_cosseguro"}}},"description":"Bloco de preenchimento obrigat\u00f3rio quando o \"Status do Sinistro\" do bloco \"Coberturas Afetadas\" apresentar os dom\u00ednios \"1 - Aberto\", \"2 - Encerrado com indeniza\u00e7\u00e3o\", \"4 - Reaberto\" ou \"6 - Avalia\u00e7\u00e3o inicial\""},"sinistro":{"type":"object","required":["apolice_codigo","coberturas_afetadas","codigo_seguradora","codigo_sinistro","moeda_apolice","possui_cosseguro","retificacao_registro","tipo_sinistro"],"properties":{"codigo_seguradora":{"type":"string","example":"rgha","description":"C\u00f3digo Susep da seguradora","maxLength":5},"codigo_sinistro":{"type":"string","example":"flikbkczpclrktehwxkdkfiaehiumrwcpugrjzfiwcgafmima","description":"Identificador do processo de sinistro","maxLength":50},"apolice_codigo":{"type":"string","example":"eccqpogrgexfxdbchptwryqasicfgqhfzjkeblngzewdqtrdif","description":"Chave de Registro   Refer\u00eancia a Chave de Registro","maxLength":60},"certificado_codigo":{"type":"string","example":"solmqhdzyeeeeftyhfvhgpeqwwpifyrfzhipxhvwmdxcwzazlk","description":"Identificador do certificado de seguro ou do certificado de participante coletivo de previd\u00eancia","maxLength":60},"tipo_sinistro":{"type":"integer","format":"int32","example":1,"description":"Tipo do sinistro movimentado.  Dom\u00ednio:  1 - Administrativo 2 - Judicial","minimum":1,"maximum":9,"enum":[1,2]},"moeda_apolice":{"type":"string","example":"BRL","description":"Moeda do movimento.  ISO 4217 Exemplo (  BRL ,  USD ,  EUR ,  GBP ,  JPY )","maxLength":3},"possui_beneficiario_final":{"type":"boolean","example":true,"description":"Indica se a seguradora tem identificado quais s\u00e3o os benefici\u00e1rios finais (pessoas f\u00edsicas), nos casos em que deve identificar com base na Circular Susep n\u00ba 612 2020. Obrigat\u00f3rio quando o campo Status do Sinistro  for igual a 2, 7 ou 8. "},"retificacao_registro":{"type":"boolean","example":true,"description":"Campo destinado a identificar se se trata de uma retifica\u00e7\u00e3o de registro existente"},"possui_cosseguro":{"type":"boolean","example":true,"description":"Indica se o sinistro registrado possui cosseguro"},"coberturas_afetadas":{"type":"array","items":{"$ref":"#\/definitions\/coberturas_afetadas"}},"dados_rural":{"type":"array","items":{"$ref":"#\/definitions\/dados_rural"}},"dados_patrimonial":{"type":"array","items":{"$ref":"#\/definitions\/dados_patrimonial"}},"dados_auto":{"type":"array","items":{"$ref":"#\/definitions\/dados_auto"}},"beneficiario_final":{"type":"array","items":{"$ref":"#\/definitions\/beneficiario_final"}},"dados_carta_verde":{"type":"array","items":{"$ref":"#\/definitions\/dados_carta_verde"}}}},"Data":{"type":"object","required":["sinistro"],"properties":{"sinistro":{"type":"array","items":{"$ref":"#\/definitions\/sinistro"}}}},"Erro":{"type":"object","required":["codigo","detalhe","titulo"],"properties":{"codigo":{"type":"string","example":"bzwpveynf","description":"C\u00f3digo do erro de neg\u00f3cio.","maxLength":10},"titulo":{"type":"string","example":"cizvaeusrbhbxiotofovafyiyvakryqicvaolfxxuwhevaynbd","description":"Mensagem sucinta do erro de neg\u00f3cio.","maxLength":100},"detalhe":{"type":"string","example":"tvxumzmccnogrmrbticirfnibltkayfljbdqczkmyjijxxpawd","description":"Informa\u00e7\u00f5es complementares a respeito do erro de neg\u00f3cio. ","maxLength":2000}},"description":"Classe padr\u00e3o em portugu\u00eas para Erro."},"dados_rural":{"type":"object","required":["codigo_objeto_rural","evento_gerador","franquia_rural","tipo_cobertura"],"properties":{"codigo_objeto_rural":{"type":"string","example":"gyunuluammnimpucckchkxgibdajsvteyncqxuzlesxjizxyy","description":"Refer\u00eancia ao Identificador do objeto Rural","maxLength":50},"data_ocorrencia_inicio":{"type":"string","format":"date","example":"2024-01-01","description":"Campo obrigat\u00f3rio para registros com Tipo da Cobertura (tipo_cobertura) igual a 1 - Agr\u00edcola ou 4 - Florestas. (Formato : YYYY-MM-DD)"},"data_ocorrencia_fim":{"type":"string","format":"date","example":"2024-01-01","description":"Campo obrigat\u00f3rio para registros com Tipo da Cobertura (tipo_cobertura) igual a 1 - Agr\u00edcola ou 4 - Florestas. (Formato : YYYY-MM-DD)"},"data_colheita_inicio":{"type":"string","format":"date","example":"2024-01-01","description":"Campo obrigat\u00f3rio para registros com Tipo da Cobertura (tipo_cobertura) igual a 1 - Agr\u00edcola ou 4 - Florestas. (Formato : YYYY-MM-DD)"},"data_colheita_fim":{"type":"string","format":"date","example":"2024-01-01","description":"Campo obrigat\u00f3rio para registros com Tipo da Cobertura (tipo_cobertura) igual a 1 - Agr\u00edcola ou 4 - Florestas. (Formato : YYYY-MM-DD)"},"data_vistoria_inicial":{"type":"string","format":"date","example":"2024-01-01","description":"Campo obrigat\u00f3rio para registros com Tipo da Cobertura (tipo_cobertura) igual a 1 - Agr\u00edcola, 2 - Pecu\u00e1rio, 3 - Aqu\u00edcola ou 4 - Florestas. (Formato : YYYY-MM-DD)"},"data_vistoria_final":{"type":"string","format":"date","example":"2024-01-01","description":"Campo obrigat\u00f3rio para registros com Tipo da Cobertura (tipo_cobertura) igual a 1 - Agr\u00edcola, 2 - Pecu\u00e1rio, 3 - Aqu\u00edcola ou 4 - Florestas.(Formato : YYYY-MM-DD)"},"uf":{"type":"string","example":"SP","description":"UF da vistoria (para Agr\u00edcola, Pecu\u00e1rio, Aqu\u00edcola e Florestas).  AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO. Adicionalmente, aceitar\u00e1 a express\u00e3o  NA  quando n\u00e3o aplic\u00e1vel. Campo obrigat\u00f3rio para registros com Tipo da Cobertura (tipo_cobertura) igual a 1 - Agr\u00edcola, 2 - Pecu\u00e1rio, 3 - Aqu\u00edcola ou 4 - Florestas.","maxLength":2,"enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO","NA"]},"municipio_sinistro":{"type":"integer","format":"int32","example":100,"description":"Munic\u00edpio da vistoria  (para Agr\u00edcola, Pecu\u00e1rio, Aqu\u00edcola e Florestas). Tabela de c\u00f3digo de munic\u00edpios do IBGE. Campo obrigat\u00f3rio para registros com Tipo da Cobertura (tipo_cobertura) igual a 1 - Agr\u00edcola, 2 - Pecu\u00e1rio, 3 - Aqu\u00edcola ou 4 - Florestas.","minimum":1,"maximum":9999999},"codigo_postal_vistoria":{"type":"string","example":"jrijhczkkrdgwfdowmwyobkmshmdw","description":"C\u00f3digo postal da vistoria, caso haja (para Agr\u00edcola, Pecu\u00e1rio, Aqu\u00edcola e Florestas). Campo obrigat\u00f3rio para registros com Tipo da Cobertura (tipo_cobertura) igual a 1 - Agr\u00edcola, 2 - Pecu\u00e1rio, 3 - Aqu\u00edcola ou 4 - Florestas.","maxLength":30},"evento_gerador":{"type":"string","example":"s","description":"Determina o evento gerador do sinistro. Tabela Eventos Rural","maxLength":2},"franquia_rural":{"type":"number","format":"double","example":9.99,"description":"Valor da franquia aplicada ao sinistro."},"tipo_cobertura":{"type":"integer","format":"int32","example":100,"description":"Identifica o tipo da cobertura \u00e0 qual o objeto se refere","minimum":-2147483648,"maximum":2147483647}}},"Data1":{"type":"object","required":["sinistro_alteracao"],"properties":{"sinistro_alteracao":{"type":"array","items":{"$ref":"#\/definitions\/sinistro_alteracao"}}}},"erros":{"type":"object","properties":{"erros":{"type":"array","items":{"$ref":"#\/definitions\/Erro"}}}},"beneficiario_final":{"type":"object","required":["codigo_postal","documento","nome","pais","tipo_documento","uf"],"properties":{"documento":{"type":"string","example":"qdfvwdcdmblotuakedbvenezypwszxmfztntyyd","description":"Documento de identifica\u00e7\u00e3o de benefici\u00e1rio final. Aceita somente letras e n\u00fameros, sem caracteres especiais (no caso de CPF   CIN, somente n\u00fameros)","maxLength":40},"tipo_documento":{"type":"integer","format":"int32","example":1,"description":"Tipo de documento de benefici\u00e1rio final.   Dom\u00ednio:  1 - CPF   CIN 3 - Passaporte 4 - RG  99 - Outros","minimum":1,"maximum":99,"enum":[1,3,4,99]},"nome":{"type":"string","example":"berqormgfwwaggltnvhwqjghpfgrjsqnwwiyeatkrwtjxuirzw","description":"Nome de benefici\u00e1rio final","maxLength":144},"codigo_postal":{"type":"string","example":"wylqixkbldzqjppudzqryxwonkrct","description":"C\u00f3digo postal de benefici\u00e1rio final. Quando Pa\u00eds BRA dever\u00e1 corresponder a 8 digitos do CEP","maxLength":30},"uf":{"type":"string","example":"SP","description":"UF do benefici\u00e1rio final. AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO. Adicionalmente, aceitar\u00e1 a express\u00e3o  NA  quando n\u00e3o aplic\u00e1vel.","maxLength":2,"enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO","NA"]},"pais":{"type":"string","example":"BRL","description":"Pa\u00eds de benefici\u00e1rio final. Lista de Pa\u00edses: ISO 3166-1 alfa-3; preencher  ZZZ  quando n\u00e3o informado","maxLength":3}}},"dados_auto":{"type":"object","required":["causa_sinistro","cep_localidade_sinistro","codigo_objeto_auto","data_nascimento","evento_auto","municipio_sinistro","sexo","uf"],"properties":{"codigo_objeto_auto":{"type":"string","example":"lftphrkqggbhvyhojdhohawppwpfcozchghcawircoexcsuwv","description":"Refer\u00eancia ao Identificador do objeto autom\u00f3vel","maxLength":50},"evento_auto":{"type":"integer","format":"int32","example":1,"description":"Indica a cobertura acionada no evento. Dom\u00ednio: 1 - Casco 2 - RCF - Danos Materiais 3 - RCF - Danos Corporais 4 - RCF - Danos Morais 5 - APP - Morte Acidental 6 - APP - Invalidez Permanente por Acidente 7 - APP - Desp. M\u00e9dicas e Hospitalares 99 - Outros","minimum":1,"maximum":99,"enum":[1,2,3,4,5,6,7,99]},"causa_sinistro":{"type":"integer","format":"int32","example":1,"description":"Causa do Sinistro. Dom\u00ednio: 1 - Roubo Furto (este c\u00f3digo somente deve ser utilizadoquando a companhia n\u00e3o disp\u00f5e das informa\u00e7\u00f5es deRoubo e Furto separadamente) 2 - Roubo 3 - Furto 4 - Colis\u00e3o parcial 5 - Colis\u00e3o Indeniza\u00e7\u00e3o Integral 6 - Inc\u00eandio 7 - Assist\u00eancia 24 horas 99 - Outros","minimum":1,"maximum":99,"enum":[1,2,3,4,5,6,7,99]},"sexo":{"type":"integer","format":"int32","example":1,"description":"Sexo do condutor do ve\u00edculo no momento do sinistro. Dom\u00ednio: 1 - Masculino 2 - Feminino 3 - N\u00e3o declarado 99 - Outros","minimum":1,"maximum":99,"enum":[1,2,3,99]},"data_nascimento":{"type":"string","format":"date","example":"2024-01-01","description":"Data de nascimento do condutor do ve\u00edculo no momento do sinistro (Casco, RCF-A, APP e Assist\u00eancia e Outras Coberturas).(Formato : YYYY-MM-DD)"},"municipio_sinistro":{"type":"integer","format":"int32","example":100,"description":"Munic\u00edpio da ocorr\u00eancia do sinistro. Tabela de c\u00f3digo de munic\u00edpios do IBGE.","minimum":1,"maximum":9999999},"uf":{"type":"string","example":"SP","description":"UF de ocorr\u00eancia do sinistro. AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO. Adicionalmente, aceitar\u00e1 a express\u00e3o  NA  quando n\u00e3o aplic\u00e1vel.","maxLength":2,"enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO","NA"]},"cep_localidade_sinistro":{"type":"string","example":"wiskwigwyjluinufhgrruukrkselq","description":"CEP da localidade de ocorr\u00eancia do sinistro.","maxLength":30}}},"coberturas_afetadas_alteracao":{"type":"object","required":["cobertura_interna_seguradora","cod_cobertura_sinistro","data_alteracao_sinistro","data_aviso_cobertura","data_ocorrencia","data_registro_seguradora_cobertura","forma_indenizacao","grupo_ramo","status"],"properties":{"cobertura_interna_seguradora":{"type":"string","example":"ongpgzvbbmegbfxmhmumzkyumcnyiscfrravpkrinoyraboka","description":"Refer\u00eancia ao C\u00f3digo Interno da Cobertura da Seguradora da cobertura afetada","maxLength":50},"grupo_ramo":{"type":"string","example":"xqr","description":"Grupo e ramo. Para previd\u00eancia adotar: 88XX- Coberturas de Sobreviv\u00eancia (Previd\u00eancia), onde XX s\u00e3o os dois \u00faltimos n\u00fameros do identificador da cobertura conforme a tabela de coberturas 89XX - Coberturas de Risco (Previd\u00eancia),  onde XX s\u00e3o os dois \u00faltimos n\u00fameros do identificador da cobertura conforme a tabela de coberturas. Tabela de grupo e ramo","maxLength":4},"cod_cobertura_sinistro":{"type":"string","example":"psbq","description":"C\u00f3digo da cobertura afetada. Tabela de Coberturas","maxLength":5},"sinistro_cobertura_outros":{"type":"string","example":"wwmvwjdyewqxuivwxofqqoaokufxamgoqtovgcustceykardqg","description":"Descri\u00e7\u00e3o   Nome da cobertura afetada (movimento). Obrigat\u00f3rio apenas para o dom\u00ednio do campo C\u00f3digo da Cobertura  99999 - Outros","maxLength":500},"data_aviso_cobertura":{"type":"string","format":"date","example":"2024-01-01","description":"Data de aviso do sinistro por cobertura (Formato : YYYY-MM-DD)"},"data_registro_seguradora_cobertura":{"type":"string","format":"date","example":"2024-01-01","description":"Data de aviso do sinistro \u00e0 seguradora por cobertura (Formato : YYYY-MM-DD)"},"data_reclamacao_terceiro_cobertura":{"type":"string","format":"date","example":"2024-01-01","description":"Data de Reclama\u00e7\u00e3o do Terceiro por cobertura. Obrigat\u00f3rio para o Grupo 03 e para os ramos 0553, 0623, 0628, 0632, 0638, 0644, 0652, 0654, 0655, 0656, 0658, 1428, 1528, 1537, 1597, 0437, 0523, 0544 e 0627 (Formato : YYYY-MM-DD)"},"data_entrega":{"type":"string","format":"date","example":"2024-01-01","description":"Data de entrega da documenta\u00e7\u00e3o completa, exigida pela seguradora para pagamento do sinistro. A data de entrega da documenta\u00e7\u00e3o deve ser maior ou igual \u00e0 data de aviso do sinistro. Obrigat\u00f3rio quando o campo  Status do Sinistro  for: - igual a 2, 7 ou 8;  ou - igual a 3 ou 9 e o campo  justificativa da negativa  for diferente de 3 e 4.  (Formato : YYYY-MM-DD)"},"status":{"type":"integer","format":"int32","example":1,"description":"Status do processo de sinistro.  Dom\u00ednio: 1 - Aberto 2 - Encerrado com Indeniza\u00e7\u00e3o 3 - Encerrado sem Indeniza\u00e7\u00e3o 4 - Reaberto 5 - Cancelado (Por erro operacional) 6 - Avalia\u00e7\u00e3o Inicial 7 - Encerrado com pagamento \u00fanico (benef\u00edcio) 8 - Encerrado com concess\u00e3o de renda (benef\u00edcio) 9 - Encerrado indeferido (benef\u00edcio)","minimum":1,"maximum":9,"enum":[1,2,3,4,5,6,7,8,9]},"data_alteracao_sinistro":{"type":"string","format":"date","example":"2024-01-01","description":"Data em que ocorreu a altera\u00e7\u00e3o do Sinistro. (Formato : YYYY-MM-DD)"},"data_ocorrencia":{"type":"string","format":"date","example":"2024-01-01","description":"Data de ocorr\u00eancia do sinistro (Formato : YYYY-MM-DD)"},"forma_indenizacao":{"type":"integer","format":"int32","example":1,"description":"Forma de pagamento da indeniza\u00e7\u00e3o, se mediante pagamento em dinheiro, reposi\u00e7\u00e3o do bem, reparo do bem, presta\u00e7\u00e3o de servi\u00e7o ou outra forma pactuada entre as partes.  Dom\u00ednio: 1 - Pagamento pecuni\u00e1rio; 2 - Reposi\u00e7\u00e3o; 3 - Reparo ou presta\u00e7\u00e3o de servi\u00e7o; 99 - Outros","minimum":1,"maximum":99,"enum":[1,2,3,99]},"data_liquidacao":{"type":"string","format":"date","example":"2024-01-01","description":"Data de in\u00edcio da liquida\u00e7\u00e3o do sinistro perante o segurado benefici\u00e1rio. Obrigat\u00f3rio quando o campo  Status do Sinistro  for igual a 2, 3, 7, 8 ou 9 (Formato : YYYY-MM-DD)"},"data_conclusao":{"type":"string","format":"date","example":"2024-01-01","description":"Data da liquida\u00e7\u00e3o definitiva do sinistro ou da negativa do sinistro. Obrigat\u00f3rio quando o campo  Status do Sinistro  for igual a 2, 3, 7, 8 ou 9  (Formato : YYYY-MM-DD)"},"data_salvado":{"type":"string","format":"date","example":"2024-01-01","description":"Data da venda do salvado (Formato : YYYY-MM-DD)"},"data_ressarcimento":{"type":"string","format":"date","example":"2024-01-01","description":"Data da recupera\u00e7\u00e3o do ressarcimento (Formato : YYYY-MM-DD)"},"justificativa_negativa":{"$ref":"#\/definitions\/justificativa_negativa"},"totalizacao_sinistro":{"$ref":"#\/definitions\/totalizacao_sinistro"}}},"RegistroRspPost":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/Data2"}}},"RegistroReqPost":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/Data"}},"id":"RegistroReqPost"},"AlteracaoRspPost":{"type":"object","required":

# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/b3-exchange/refs/heads/main/openapi/b3-exchange-insurance-claim-openapi.json