{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"29c24011-7bae-4f6f-9aba-dcc496107752","name":"IZA - Intermitente V2","description":"\n\nEsta documentação apresenta de forma objetiva os **endpoints**, **processos** e **tipos de requisições** necessários para a integração com as **APIs de Seguros da IZA**. \nO objetivo é fornecer às equipes técnicas todas as informações essenciais para implementar, conectar e operar os serviços disponíveis, garantindo segurança, padronização e eficiência em cada etapa da integração.\n\n---\n\n# Autenticação\n\nTodos os endpoints das nossas APIs exigem autenticação. Por isso, cada chamada deve incluir um token válido no cabeçalho da requisição. Esse token é do tipo Basic e é composto pelas informações de User API ID e Secret Key que serão disponibilizadas no momento da contratação do serviço. O Token deve ser enviado no header `Authorization`, por exemplo:\n\n> Authorization: Basic <Token> \n \n\n---\n\n# Segurança\n\n- **Armazenamento seguro do token:** \n Mantenha o token em um ambiente protegido, como um cofre de senhas ou um armazenamento criptografado. Evite armazená-lo em arquivos de texto comuns ou diretamente no código-fonte.\n \n- **Uso obrigatório de HTTPS:** \n Todas as comunicações devem ocorrer exclusivamente via HTTPS, garantindo a criptografia dos dados e reduzindo o risco de interceptações ou acessos indevidos.\n \n\n---\n\n# Validação de Credencial de Acesso\n\n- A validação da credencial de acesso e os dados cadastrados poderão ser realizados via rota `get_partner_info`\n \n- Essa rota poderá ser utilizada para validação do token de autenticação, onde:\n \n - Retorno 200 indica sucesso\n \n - Retorno 401 indica que há algum problema nas informações inseridas\n \n- Além disso, poderão ser validadas as seguintes informações:\n \n - Dados gerais de endereço\n \n - CNPJ\n \n - Data de ativação da credencial de acesso\n \n\n---\n\n# Cadastro\n\n\"Ilustração%201%20-%20Criação%20de%20Person%20e%20Contract\"\n\nO fluxo tem início com a criação de uma **Pessoa (person)**. Nesta etapa será necessário informar os seguintes dados:\n\n- Nome - obrigatório\n \n- CPF - obrigatório\n \n- Telefone - opcional\n \n- Data de Nascimento - opcional\n \n- E-mail - opcional\n \n\nApós essa etapa, é necessário criar o **Contrato (contract)**, que é equivalente à Apólice e será utilizado para agrupar os períodos correspondentes. Nesta etapa, o contrato deverá ser criado utilizando o CPF do segurado.\n\n---\n\n# Registro de Períodos (Periods)\n\n\"Ilustração%202%20-%20Registro%20de%20Period\"\n\nO processo inicia-se com a criação de um **Período (period)**. Após criado, esse período deve ser **atualizado com a data de encerramento** ao término da entrega ou **cancelado**, caso a entrega não seja concluída.\n\nTodos os registros devem ser enviados como **períodos individuais**, onde **cada entrega** representa o intervalo de tempo em que o Parceiro informa à IZA que, naquele período específico, a pessoa estava realizando uma entrega assegurada.\n\nCom base nesses períodos, a IZA realiza a cobrança — lembrando que a **cobrança é por pedido concluído**, e não por saída com múltiplos pedidos, exceto em situações em que todos os pedidos são coletados e entregues no **mesmo endereço**.\n\nEm caso de sinistro, a IZA valida se o período correspondente foi corretamente enviado e se consta no banco de dados para o segurado envolvido. A análise considera o **nexo temporal** entre o horário do acidente e o horário informado para a entrega.\n\nPara operações com **Ordens de Serviço (OS)** que agrupam vários pedidos em uma única entrega, é necessário **desmembrar a OS em pedidos individuais**, enviando um período separado para cada pedido.\n\nEntendemos que o envio em tempo real pode ser desafiador dependendo do modelo operacional. Por isso, apresentamos abaixo um cenário prático para orientar a implementação.\n\n---\n\n### Tipo de Contratação - Delivery\n\n_Regras Gerais_\n\nO parceiro precisará informar os seguintes dados para que o registro do Período (Period) seja realizado:\n\n- Início da Cobertura: conforme informada pelo parceiro, podendo ser retroativa em até 10 minutos\n \n- Fim da Cobertura: conforme informada pelo parceiro\\*\n \n\n\\*Se não for encaminhada a data fim da cobertura, automaticamente é registrado 45 min após início.\n\nCenário 1
Quando o prestador inicia o trajeto a partir de um ponto fixo (como uma loja) levando múltiplos pedidos simultaneamente, cada pedido deve possuir sua **própria chamada de Period**.\n\n**Exemplo:** Se o prestador sai com quatro pedidos (1, 2, 3 e 4):\n\n1. É realizada uma chamada à API informando o horário de saída, criando o **Period** do Pedido 1 (garantia de início de cobertura).\n \n2. Ao concluir o Pedido 1, o período deve ser finalizado.\n \n3. Em seguida, deve-se **abrir o período do Pedido 2**.\n \n4. O mesmo fluxo se repete para os demais pedidos: finaliza-se o período do pedido anterior e abre-se o período do próximo, garantindo a rastreabilidade e continuidade da cobertura para cada entrega individual.\n \n\n\"Ilustração%203%20-%20Entrega%20a%20partir%20de%20um%20ponto%20fixo\"\n\n
Cenário 2
Quando o prestador aceita um pedido diretamente pelo aplicativo — independentemente de onde ele esteja — a cobertura passa a valer **a partir do momento da aceitação do pedido**. \nAssim como no cenário anterior, cada pedido exige sua **própria chamada de Period** para garantir a rastreabilidade e a cobertura individual da entrega.\n\n**Exemplo:** Se o prestador aceita simultaneamente quatro pedidos (1, 2, 3 e 4):\n\n1. Deve ser realizada uma chamada à API informando o horário de aceitação, criando o **Period** do Pedido 1 e estabelecendo o início da cobertura.\n \n2. Após a conclusão do Pedido 1, o período correspondente deve ser finalizado.\n \n3. Em seguida, deve-se **iniciar o período do Pedido 2**, garantindo que a cobertura seja contínua e associada a cada entrega individual.\n \n4. O mesmo fluxo se repete para os pedidos seguintes: finalizar o período do pedido concluído e iniciar o período do próximo.\n \n\n\"Ilustração%204%20-%20Entrega%20com%20origem%20variável\"\n\n### **Orientações gerais válidas para ambos os cenários**\n\n- Se houver **cancelamento** ou impossibilidade de concluir as entregas, os períodos subsequentes **não precisam ser criados**.\n \n- No entanto, para pedidos pertencentes a uma **Ordem de Serviço (OS)**, qualquer pedido **já iniciado ou finalizado** por um prestador **não pode ser cancelado ou transferido** para outro prestador.\n \n - Isso ocorre porque, em muitos sinistros, o acidente pode acontecer no deslocamento até o ponto de coleta ou no percurso até o cliente final.\n \n- Quando houver **realocação total da OS** para um novo prestador, os períodos devem ser criados utilizando o **CPF do novo motorista**, garantindo que o registro reflita corretamente quem realizou cada etapa da entrega.\n \n- Caso o cancelamento da entrega seja realizado em até 2 minutos, não será realizada a cobrança do período.\n \n\n
Cenário 3 \nQuando o motorista conclui uma entrega e precisa retornar ao estabelecimento — seja para devolver a maquininha de cartão, o troco ou qualquer item operacional — esse deslocamento também deve ser registrado como um **Period**.\n\nEsse registro é essencial para garantir que o motorista permaneça **coberto durante todo o trajeto de retorno**, assegurando continuidade e rastreabilidade da operação.\n\n**Exemplo:** Após finalizar a entrega de um pedido:\n\n1. O período referente à entrega deve ser devidamente **finalizado**.\n \n2. Em seguida, deve ser criada uma nova chamada de **Period**, registrando o início do deslocamento de retorno ao estabelecimento.\n \n3. Ao chegar ao ponto de origem, esse novo período deve ser **encerrado**, concluindo o ciclo da operação.\n \n\n\"Ilustração%205%20-%20Prestador%20precisa%20retornar%20ao%20estabelecimento\"\n\n---\n\n### Tipo de Contratação - Mobilidade Urbana\n\n_Regras Gerais_\n\nO parceiro precisará informar os seguintes dados para que o registro do Período (Period) seja realizado:\n\n- Início da Cobertura: conforme informada pelo parceiro, podendo ser retroativa em até 10 minutos\n \n- Fim da Cobertura: conforme informada pelo parceiro\\*\n \n\n\\*Se não for encaminhada a data fim da cobertura, automaticamente é registrado 2 horas após início.\n\nCenário 1 - Cobertura Motorista
Quando o motorista inicia um trajeto, cada corrida deve possuir sua **própria chamada de Period**.\n\n**Exemplo:** Se o motorista aceita uma corrida:\n\n1. É realizada uma chamada à API informando o horário de início, criando o **Period**.\n \n2. Após a corrida ser finalizada, o período correspondente deverá ser encerrado.\n \n3. Caso o motorista aceite uma próxima corrida, deverá ser criado um novo período e informado o início da nova corrida, garantindo que a cobertura seja contínua e associada a cada trajeto percorrido.\n \n4. O mesmo fluxo se repete toda vez que o motorista aceitar e iniciar uma nova corrida.\n \n\nCenário 2 - Cobertura Motorista e Passageiro
O fluxo de criação de Period para este cenário é igualmente ao aplicado acima (Cenário 1 - Cobertura Motorista). A diferença desse modelo de contratação somente se dará em caso de sinistro, o qual o passageiro também estará coberto e passível de recebimento de indenização.\n\n---\n\n### Tipo de Contratação - Longa Duração\n\n_Regras Gerais_\n\nO parceiro precisará informar os seguintes dados para que o registro do Período (Period) seja realizado:\n\n- Início da Cobertura: conforme informada pelo parceiro, podendo ser retroativa em até 7 dias (168 horas)\n \n- Fim da Cobertura: conforme informada pelo parceiro\\*\n \n\n\\*Se não for encaminhada a data fim da cobertura, automaticamente é registrado 7 dias (168 horas) após início.\n\nCenário 1 - Frete
Quando a fretadora possuir o itinerário do motorista, poderá realizar o envio do Period para cada trajeto que será percorrido, sendo assim cada corrida deve possuir sua **própria chamada de Period**.\n\n**Exemplo:** Se o motorista tem viagem agendada:\n\n1. É realizada uma chamada à API informando o horário de início, criando o **Period**.\n \n2. Após a viagem ser finalizada, o período correspondente deverá ser encerrado.\n \n3. Caso o motorista tenha uma nova rota definida, deverá ser criado um novo período e informado o início da nova viagem, garantindo que a cobertura seja contínua e associada a cada trajeto percorrido.\n \n4. O mesmo fluxo se repete toda vez que o motorista iniciar e finalizar um trajeto.\n \n\n---\n\n### **Proteção Deslocamento**\n\nTrata-se de uma cobertura adicional, destinada a ampliar a segurança do prestador além do período estrito das entregas. Sendo assim, a proteção de deslocamento garante cobertura enquanto o entregador estiver em trânsito entre sua residência e o estabelecimento.\n\nSua ativação e condições serão parametrizadas conforme a negociação contratual, respeitando as necessidades e características operacionais de cada parceiro.\n\n### **Envio de Geolocalizações**\n\nA partir da criação de cada **Period**, é necessário enviar os pontos geográficos do motorista **em tempo real, a cada minuto**. \nEsse envio contínuo de geolocalização contribui diretamente para uma **avaliação mais precisa e eficiente** em casos de sinistro, permitindo a análise do trajeto e do contexto operacional no momento do evento.\n\n_Leia mais sobre Geolocation_ [aqui.](https://intermitente.api.docs.iza.com.vc/#d39c813c-4af9-44ef-b7e4-8adf89157548)\n\n### **Persistência de Logs**\n\nPara uma gestão operacional eficiente e para facilitar eventuais análises de erros ou inconsistências, é fundamental **armazenar os logs das requisições que resultarem em erros inesperados por, no mínimo, 30 dias**. Recomendamos que sejam registrados:\n\n- **URL (endpoint)** da requisição realizada\n \n- **Corpo (payload) enviado**\n \n- **Corpo da resposta** retornado pela API\n \n\nA manutenção desses registros auxilia a identificar comportamentos, ajustar integrações e agilizar diagnósticos quando necessário.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"18601615","collectionId":"29c24011-7bae-4f6f-9aba-dcc496107752","publishedId":"2s93Xzw294","public":true,"publicUrl":"https://intermitente.api.docs.iza.com.vc","privateUrl":"https://go.postman.co/documentation/18601615-29c24011-7bae-4f6f-9aba-dcc496107752","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-12-09T18:18:22.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/3447733862916c10d4e5d46c97121d6bd04548889ca5aa8a3b1eb419d36d0294","favicon":"https://iza.com.vc/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://intermitente.api.docs.iza.com.vc/view/metadata/2s93Xzw294"}