Esta 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.
O 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.
Todos 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\nAuthorization: Basic <Token>
\n
Armazenamento seguro do token:
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.
Uso obrigatório de HTTPS:
Todas as comunicações devem ocorrer exclusivamente via HTTPS, garantindo a criptografia dos dados e reduzindo o risco de interceptações ou acessos indevidos.
A validação da credencial de acesso e os dados cadastrados poderão ser realizados via rota get_partner_info
Essa rota poderá ser utilizada para validação do token de autenticação, onde:
\nRetorno 200 indica sucesso
\nRetorno 401 indica que há algum problema nas informações inseridas
\nAlém disso, poderão ser validadas as seguintes informações:
\nDados gerais de endereço
\nCNPJ
\nData de ativação da credencial de acesso
\nO fluxo tem início com a criação de uma Pessoa (person). Nesta etapa será necessário informar os seguintes dados:
\nNome - obrigatório
\nCPF - obrigatório
\nTelefone - opcional
\nData de Nascimento - opcional
\nE-mail - opcional
\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.
\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.
\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.
\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.
\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.
\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.
\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.
\nRegras Gerais
\nO parceiro precisará informar os seguintes dados para que o registro do Período (Period) seja realizado:
\nInício da Cobertura: conforme informada pelo parceiro, podendo ser retroativa em até 10 minutos
\nFim da Cobertura: conforme informada pelo parceiro*
\n*Se não for encaminhada a data fim da cobertura, automaticamente é registrado 45 min após início.
\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.
Exemplo: Se o prestador sai com quatro pedidos (1, 2, 3 e 4):
\nÉ realizada uma chamada à API informando o horário de saída, criando o Period do Pedido 1 (garantia de início de cobertura).
\nAo concluir o Pedido 1, o período deve ser finalizado.
\nEm seguida, deve-se abrir o período do Pedido 2.
\nO 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
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.
Assim como no cenário anterior, cada pedido exige sua própria chamada de Period para garantir a rastreabilidade e a cobertura individual da entrega.
Exemplo: Se o prestador aceita simultaneamente quatro pedidos (1, 2, 3 e 4):
\nDeve 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.
\nApós a conclusão do Pedido 1, o período correspondente deve ser finalizado.
\nEm seguida, deve-se iniciar o período do Pedido 2, garantindo que a cobertura seja contínua e associada a cada entrega individual.
\nO mesmo fluxo se repete para os pedidos seguintes: finalizar o período do pedido concluído e iniciar o período do próximo.
\nSe houver cancelamento ou impossibilidade de concluir as entregas, os períodos subsequentes não precisam ser criados.
\nNo 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.
\nQuando 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.
\nCaso o cancelamento da entrega seja realizado em até 2 minutos, não será realizada a cobrança do período.
\n
Cenário 3
Quando 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.
Esse registro é essencial para garantir que o motorista permaneça coberto durante todo o trajeto de retorno, assegurando continuidade e rastreabilidade da operação.
\nExemplo: Após finalizar a entrega de um pedido:
\nO período referente à entrega deve ser devidamente finalizado.
\nEm seguida, deve ser criada uma nova chamada de Period, registrando o início do deslocamento de retorno ao estabelecimento.
\nAo chegar ao ponto de origem, esse novo período deve ser encerrado, concluindo o ciclo da operação.
\nRegras Gerais
\nO parceiro precisará informar os seguintes dados para que o registro do Período (Period) seja realizado:
\nInício da Cobertura: conforme informada pelo parceiro, podendo ser retroativa em até 10 minutos
\nFim da Cobertura: conforme informada pelo parceiro*
\n*Se não for encaminhada a data fim da cobertura, automaticamente é registrado 2 horas após início.
\nCenário 1 - Cobertura Motorista
Quando o motorista inicia um trajeto, cada corrida deve possuir sua própria chamada de Period.
Exemplo: Se o motorista aceita uma corrida:
\nÉ realizada uma chamada à API informando o horário de início, criando o Period.
\nApós a corrida ser finalizada, o período correspondente deverá ser encerrado.
\nCaso 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.
\nO mesmo fluxo se repete toda vez que o motorista aceitar e iniciar uma nova corrida.
\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.
Regras Gerais
\nO parceiro precisará informar os seguintes dados para que o registro do Período (Period) seja realizado:
\nInício da Cobertura: conforme informada pelo parceiro, podendo ser retroativa em até 7 dias (168 horas)
\nFim da Cobertura: conforme informada pelo parceiro*
\n*Se não for encaminhada a data fim da cobertura, automaticamente é registrado 7 dias (168 horas) após início.
\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.
Exemplo: Se o motorista tem viagem agendada:
\nÉ realizada uma chamada à API informando o horário de início, criando o Period.
\nApós a viagem ser finalizada, o período correspondente deverá ser encerrado.
\nCaso 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.
\nO mesmo fluxo se repete toda vez que o motorista iniciar e finalizar um trajeto.
\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.
\nSua ativação e condições serão parametrizadas conforme a negociação contratual, respeitando as necessidades e características operacionais de cada parceiro.
\nA partir da criação de cada Period, é necessário enviar os pontos geográficos do motorista em tempo real, a cada minuto.
Esse 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.
Leia mais sobre Geolocation aqui.
\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:
\nURL (endpoint) da requisição realizada
\nCorpo (payload) enviado
\nCorpo da resposta retornado pela API
\nA manutenção desses registros auxilia a identificar comportamentos, ajustar integrações e agilizar diagnósticos quando necessário.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Autenticação","slug":"autenticacao"},{"content":"Segurança","slug":"seguranca"},{"content":"Validação de Credencial de Acesso","slug":"validacao-de-credencial-de-acesso"},{"content":"Cadastro","slug":"cadastro"},{"content":"Registro de Períodos (Periods)","slug":"registro-de-periodos-periods"}],"owner":"18601615","collectionId":"29c24011-7bae-4f6f-9aba-dcc496107752","publishedId":"2s93Xzw294","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-12-09T18:18:22.000Z"},"item":[{"name":"Person","item":[{"name":"Create Person","event":[{"listen":"prerequest","script":{"id":"b034f93b-e50a-415a-bb87-5a23f5b94f40","exec":["// var moment = require('moment')","","name = \"Tester\" + random().padStart(4, '0')","pm.environment.set(\"cpf\", gen_cpf())","pm.environment.set(\"email\", \"backdev23\" + random().padStart(4, '0') + \"@iza.com.vc\")","pm.environment.set(\"name\", name + \" iza23\")","pm.environment.set(\"phone\", random().padStart(11, '0'))","","function random() {"," return \"\" + Math.floor(Math.random() * 999)","}","","function gen_cpf() {"," const num = () => (\"\" + Math.floor(Math.random() * 999)).padStart(3, '0');"," const n1 = num(), n2 = num(), n3 = num(), d1 = security(n1, n2, n3);"," return `${n1}${n2}${n3}${d1}${security(n1, n2, n3, d1)}`;","}","","function security(n1, n2, n3, n4) { "," let nums = n1.split(\"\").concat(n2.split(\"\"), n3.split(\"\")), x = 0;"," if (n4 !== undefined) nums[9] = n4;"," for (let i = (n4 !== undefined ? 11:10), j = 0; i >= 2; i--, j++) x += parseInt(nums[j]) * i;"," return (y = x % 11) < 2 ? 0 : 11 - (y = x % 11); ","}"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"24cf8e2a-c139-45ac-b82f-bc8169a1519a","exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"person_id\", jsonData.id);","pm.environment.set(\"person_doc\", jsonData.doc);","pm.environment.set(\"person_name\", jsonData.name);","pm.environment.set(\"person_email\", jsonData.email);","","pm.test(\"response should be okay to process\", function () {"," pm.response.to.not.be.error;",""," pm.expect(jsonData.cpf).to.equal(pm.environment.cpf)"," pm.expect(jsonData.cpf).to.equal(pm.environment.person_doc)"," // pm.expect(jsonData.name).to.equal(pm.environment.name)"," // pm.expect(jsonData.email).to.equal(pm.environment.email)"," pm.expect(jsonData.phone).to.equal(pm.environment.main_cell_phone)",""," pm.response.to.not.have.jsonBody(\"error\");","});"],"type":"text/javascript","packages":{}}}],"id":"228253bb-79f3-4236-b471-2f01fe5935d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{intermittent_auth_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"doc\": \"{{cpf}}\",\n \"name\": \"{{name}}\",\n \"birthed_at\": \"2012-02-01\",\n \"email\": \"{{email}}\",\n \"main_cell_phone\": \"{{phone}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_integration_url}}/persons","description":"Você deve criar um cliente para cada usuário assegurado,
\nRetorno esperado : 201 Created
\nPossiveis Retornos:
\n","urlObject":{"path":["persons"],"host":["{{base_integration_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"228253bb-79f3-4236-b471-2f01fe5935d1"},{"name":"Person Detail","event":[{"listen":"test","script":{"id":"f16669cc-d004-4e82-9b05-d047e6c5587c","exec":["var jsonData = JSON.parse(responseBody);\r","\r","pm.test(\"response should be okay to process\", function () {\r"," pm.response.to.not.be.error;\r","\r"," // pm.expect(jsonData.cpf).to.equal(pm.environment.cpf)\r","\r"," pm.response.to.not.have.jsonBody(\"error\");\r","});"],"type":"text/javascript"}}],"id":"832e20e6-9e2a-4fd6-83c5-9a793a948270","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{intermittent_auth_token}}","type":"text"}],"url":"{{base_integration_url}}/persons?doc={{person_doc}}","description":"Detalha as informações do segurado
\nEste endpoint pode ser utilizado para checar a existencia do segurado e existencia de contrato para aquele segurado.
\n","urlObject":{"path":["persons"],"host":["{{base_integration_url}}"],"query":[{"key":"doc","value":"{{person_doc}}"}],"variable":[]}},"response":[{"id":"d48b889e-e82f-45dc-ae80-6450fd13e89d","name":"Person Detail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"basic auth-token","type":"text"}],"url":{"raw":"{{base_integration_url}}/persons?doc=40226079040","host":["{{base_integration_url}}"],"path":["persons"],"query":[{"key":"doc","value":"40226079040"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-expose-headers","value":""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"content-length","value":"209"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"date","value":"Thu, 10 Jun 2021 20:10:50 GMT"},{"key":"server","value":"Cowboy"},{"key":"x-request-id","value":"FodRi46fwGqhQM8AAAAI"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"address\": [],\n \"birthed_at\": \"1970-02-01\",\n \"contracts\": [\n {\n \"contract_contact\": null,\n \"cotract_type\": \"corporate\",\n \"date_begin\": null,\n \"date_end\": null,\n \"id\": \"f5bbc303-3082-42fd-ab5c-9f54dbb71f9a\",\n \"name\": \"Corporate S.A\",\n \"payment_origin\": \"company_payment\",\n \"payment_way_id\": null,\n \"person_type\": \"user\",\n \"sies_id\": null,\n \"status\": \"opened\",\n \"to_cancel\": false\n }\n ],\n \"cpf\": \"40226079040\",\n \"email\": \"harold@iza.com.vc\",\n \"has_password\": false,\n \"id\": \"2142adbf-ef03-498d-8244-c5331c34b004\",\n \"main_cell_phone\": \"21994075890\",\n \"name\": \"Harold Finch\"\n }\n]"}],"_postman_id":"832e20e6-9e2a-4fd6-83c5-9a793a948270"},{"name":"Add Geolocation","event":[{"listen":"test","script":{"id":"18b6817b-332e-4c51-8c51-127e0c13b008","exec":["//var jsonData = JSON.parse(responseBody);\r","\r","//pm.test(\"response should be okay to process\", function () {\r"," pm.response.to.not.be.error;\r","\r"," // pm.expect(jsonData.cpf).to.equal(pm.environment.cpf)\r","\r","// pm.response.to.not.have.jsonBody(\"error\");\r","//});"],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"1bb52671-dac5-4547-bf96-34b080c02dd8","exec":["var moment = require('moment');\r","\r","pm.environment.set('now', moment());"],"type":"text/javascript","packages":{}}}],"id":"d39c813c-4af9-44ef-b7e4-8adf89157548","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic ZGY4ODhkYWUtNmEwNS00MDBiLTk0YzItNjk2MmMwOWY3ODQyOmxhOTAzeVgxSHcrcjI3UlpMNURmT0NJdkZxMHFLdmhxeHJkLzZDM0xVdFNneW5lMzUyeHRTMUZNVURwdGZ2T2w=","type":"text"}],"body":{"mode":"raw","raw":"{\n \"doc\": \"92200899041\",\n \"datetime\": \"{{now}}\",\n \"lat\": \"-23.289173\",\n \"long\": \"-47.313065\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_integration_url}}/intermittent/persons/geolocation","description":"Adiciona um ponto de geolocalização ao segurado.
\nLat. e Long. precisam conter 6 casas decimais.
\n","urlObject":{"path":["intermittent","persons","geolocation"],"host":["{{base_integration_url}}"],"query":[],"variable":[]}},"response":[{"id":"56aa9964-a752-4cf5-8ab1-5244169c8b58","name":"Add Geolocation","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"basic auth-token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"doc\": \"40226079040\",\n \"datetime\": \"datetime\",\n \"lat\": \"latitude\",\n \"long\": \"longitude\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_integration_url}}/intermittent/persons/geolocation"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-expose-headers","value":""},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"content-type","value":"application/json"},{"key":"date","value":"Tue, 27 Apr 2021 17:21:45 GMT"},{"key":"server","value":"Cowboy"},{"key":"x-request-id","value":"FnnGyIsyo87Lc90AAAtD"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d39c813c-4af9-44ef-b7e4-8adf89157548"}],"id":"baf8590e-cbe7-4ede-97e8-fed32b6973c3","_postman_id":"baf8590e-cbe7-4ede-97e8-fed32b6973c3","description":""},{"name":"Contract","item":[{"name":"Create Contract","event":[{"listen":"prerequest","script":{"id":"884650a8-2ce7-4855-b371-7da5612551f0","exec":["var moment = require('moment')","","pm.environment.set(\"date_begin\", moment().format(\"YYYY-MM-DD\"))","pm.environment.set(\"date_end\", moment().add(1, 'year').format(\"YYYY-MM-DD\"))"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"80402b0d-3723-40f4-aacb-9f7873360c68","exec":["// var jsonData = JSON.parse(responseBody);","// pm.environment.set(\"contract_id\", jsonData.id);","","// pm.test(\"response should be okay to process\", function () {","// pm.response.to.not.be.error;","","// // pm.expect(jsonData.cpf).to.equal(pm.environment.cpf)","","// pm.response.to.not.have.jsonBody(\"error\");","// });"],"type":"text/javascript","packages":{}}}],"id":"5ef595b7-5901-4db3-b6ff-ca63b963bddc","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"connection":true,"accept":true,"accept-encoding":true,"user-agent":true,"host":true,"content-length":true}},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{intermittent_auth_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"doc\": \"25084932010\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_integration_url}}/contracts","description":"Cria contrato do segurado intermitente
\nRetorno esperado :
\n201 - Created
\n{\n \"id\": \"7b5dac5e-a578-4377-b8d9-77cb40a2d4ce\"\n}\n\nPossiveis Retornos:
\n","urlObject":{"path":["contracts"],"host":["{{base_integration_url}}"],"query":[],"variable":[]}},"response":[{"id":"b53ad140-a6ae-4958-83b7-1f698f84b6d0","name":"Create Contract","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"doc\": \"40226079040\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_integration_url}}/contracts"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization, Origin, X-Requested-With, Content-Type, Accept"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT"},{"key":"Access-Control-Allow-Origin","value":"https://payment.iza.com.vc"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 21 Jun 2021 17:01:24 GMT"},{"key":"Server","value":"nginx/1.19.9"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"x-request-id","value":"Foqnl2lLG0_YqNsAAK7R"},{"key":"Content-Length","value":"45"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"f5bbc303-3082-42fd-ab5c-9f54dbb75f9a\"\n}"},{"id":"55f56bdd-560a-4a05-acd4-d3cefa0ff81a","name":"Create Contract","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"basic auth-token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"doc\": \"{{cpf}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_integration_url}}/contracts"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 16 Dec 2021 21:48:05 GMT"},{"key":"Server","value":"nginx/1.19.9"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"x-request-id","value":"FsFaiXjg3T15QNcAAZBh"},{"key":"Content-Length","value":"45"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"details\": \"already_has_contract\"\n }\n}"}],"_postman_id":"5ef595b7-5901-4db3-b6ff-ca63b963bddc"}],"id":"933c9616-88ec-46a4-a449-7d35a4eafd8f","_postman_id":"933c9616-88ec-46a4-a449-7d35a4eafd8f","description":""},{"name":"Period","item":[{"name":"Create Period","event":[{"listen":"prerequest","script":{"id":"60c51cb6-39a7-4720-a9a3-80dc8299535e","exec":["var moment = require('moment')","","pm.environment.set(\"now\", moment().add(-3, 'hour'))","var today = new Date();","today = `${today.getUTCFullYear()}-${today.getUTCMonth() + 1}-${today.getUTCDate()}`;","console.log(today);","pm.environment.set('today', today)",""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"10c8dbfb-59e6-4ec4-98cd-882f8bc65308","exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"period_id\", jsonData.id);","","pm.test(\"response should be okay to process\", function () {"," pm.response.to.not.be.error;",""," // pm.expect(jsonData.cpf).to.equal(pm.environment.cpf)",""," pm.response.to.not.have.jsonBody(\"error\");","});"],"type":"text/javascript","packages":{}}}],"id":"fadd9a63-09b4-46de-a525-44c75eca1a26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"doc\": \"{{cpf}}\",\n \"started_at\": \"{{now}}\",\n \"timezone\": \"America/Sao_Paulo\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_integration_url}}/intermittent/persons/periods","description":"Cria um Períod para um segurado.
O campo started_at deve ser enviado em Tempo Real.
O campo opcional timezone indica o fuso horário usado nos campos started_at e finished_at seguindo a tabela oficial de fusos do Brasil (abaixo), sendo o valor padrão America/Sao_Paulo.
Este endpoint retorna o period_id que é necessário para o encerramento do Períod.
Retorno esperado :
\n201 - Created
\n{\n \"id\": \"7b5dac5e-a578-4377-b8d9-77cb40a2d4ce\"\n}\n\nPossiveis Retornos:
\n","urlObject":{"path":["intermittent","persons","periods"],"host":["{{base_integration_url}}"],"query":[],"variable":[]}},"response":[{"id":"c6a20bc7-ec62-4d23-aadb-f26e00df2fcd","name":"Create Period","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"basic auth-token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"doc\": \"{{person_doc}}\",\n \"started_at\": \"2023-12-05T12:30:15\",\n \"timezone\": \"America/Rio_Branco\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_integration_url}}/intermittent/persons/periods"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization, Origin, X-Requested-With, Content-Type, Accept"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT"},{"key":"Access-Control-Allow-Origin","value":"https://payment.iza.com.vc"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 05 Jan 2022 15:01:41 GMT"},{"key":"Server","value":"nginx/1.19.9"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"x-request-id","value":"Fsdn93dFc9MesJYAATjR"},{"key":"Content-Length","value":"45"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"3b5b13ef-374a-4a4c-9b53-b0990d6afa26\"\n}"},{"id":"5aa16de0-bb77-42b6-9c6e-1d30b68ed844","name":"Create Period","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"basic auth-token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"doc\": \"{{person_doc}}\",\n \"started_at\": \"2023-12-05T12:30:15\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_integration_url}}/intermittent/persons/periods"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization, Origin, X-Requested-With, Content-Type, Accept"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT"},{"key":"Access-Control-Allow-Origin","value":"https://payment.iza.com.vc"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 05 Jan 2022 15:31:44 GMT"},{"key":"Server","value":"nginx/1.19.9"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"x-request-id","value":"Fsdpm0h6Bklj2SsAAVXx"},{"key":"Content-Length","value":"45"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"b9f2a28f-8662-4db7-8ca5-6ed1fae0d9f0\"\n}"}],"_postman_id":"fadd9a63-09b4-46de-a525-44c75eca1a26"},{"name":"Report Person Availability","event":[{"listen":"prerequest","script":{"id":"5a7aa87b-a5d9-4356-b676-bef3bd9a3ef3","exec":["var moment = require('moment')","","pm.environment.set(\"now\", moment())",""],"type":"text/javascript"}},{"listen":"test","script":{"id":"2a7b7da3-8c53-4247-86f6-934b597e571c","exec":["var jsonData = JSON.parse(responseBody);\r","\r","pm.test(\"response should be okay to process\", function () {\r"," pm.response.to.not.be.error;\r","\r"," // pm.expect(jsonData.cpf).to.equal(pm.environment.cpf)\r","\r"," pm.response.to.not.have.jsonBody(\"error\");\r","});"],"type":"text/javascript"}}],"id":"f75a2af7-05fb-4db0-98ae-2e2394ec582e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{intermittent_auth_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"doc\": \"{{person_doc}}\",\n \"state\": \"available\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_integration_url}}/intermittent/persons/availability","description":"Cria um período de ida e volta para o trabalho.
\nO valor 'available' cria o periodo de disponibilidade.
\nO valor 'unavailable' cria o periodo de encerramento de disponibilidade.
\nPossiveis Retornos:
\n","urlObject":{"path":["intermittent","persons","availability"],"host":["{{base_integration_url}}"],"query":[],"variable":[]}},"response":[{"id":"f1738c95-ae24-4e56-a1c5-f7e01eb40197","name":"Person Available","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"basic auth-token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"doc\": \"{{person_doc}}\",\n \"state\": \"available\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_integration_url}}/intermittent/persons/availability"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization, Origin, X-Requested-With, Content-Type, Accept"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT"},{"key":"Access-Control-Allow-Origin","value":"https://payment.iza.com.vc"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 04 Aug 2021 21:42:00 GMT"},{"key":"Server","value":"nginx/1.19.9"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"x-request-id","value":"Fpg4cFWTw4LkKX8AAA2R"},{"key":"Content-Length","value":"165"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"finished_at\": \"2021-08-04T21:42:00.466824\",\n \"id\": \"a88f77f1-11f1-4b50-b44d-38a7072a00ff\",\n \"started_at\": \"2021-08-05T00:12:00.466824\",\n \"status\": \"opened\",\n \"type\": \"to_work\"\n}"}],"_postman_id":"f75a2af7-05fb-4db0-98ae-2e2394ec582e"},{"name":"Report Person Unavailability","event":[{"listen":"prerequest","script":{"id":"5a7aa87b-a5d9-4356-b676-bef3bd9a3ef3","exec":["var moment = require('moment')","","pm.environment.set(\"now\", moment())",""],"type":"text/javascript"}},{"listen":"test","script":{"id":"2a7b7da3-8c53-4247-86f6-934b597e571c","exec":["var jsonData = JSON.parse(responseBody);\r","\r","pm.test(\"response should be okay to process\", function () {\r"," pm.response.to.not.be.error;\r","\r"," // pm.expect(jsonData.cpf).to.equal(pm.environment.cpf)\r","\r"," pm.response.to.not.have.jsonBody(\"error\");\r","});"],"type":"text/javascript"}}],"id":"c50570d0-981f-485d-be00-364fc6c54ef5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{intermittent_auth_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"doc\": \"{{person_doc}}\",\n \"state\": \"unavailable\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_integration_url}}/intermittent/persons/availability","description":"Cria um período de ida e volta para o trabalho.
\nO valor 'available' cria o periodo de disponibilidade.
\nO valor 'unavailable' cria o periodo de encerramento de disponibilidade.
\nPossiveis Retornos:
\n","urlObject":{"path":["intermittent","persons","availability"],"host":["{{base_integration_url}}"],"query":[],"variable":[]}},"response":[{"id":"ed80444d-4aa4-410b-a4b4-04cb394bbbbd","name":"Person Unavailable","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"basic auth-token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"doc\": \"{{person_doc}}\",\n \"state\": \"unavailable\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_integration_url}}/intermittent/persons/availability"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization, Origin, X-Requested-With, Content-Type, Accept"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT"},{"key":"Access-Control-Allow-Origin","value":"https://payment.iza.com.vc"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 04 Aug 2021 21:42:00 GMT"},{"key":"Server","value":"nginx/1.19.9"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"x-request-id","value":"Fpg4cFWTw4LkKX8AAA2R"},{"key":"Content-Length","value":"165"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"finished_at\": \"2021-08-04T21:42:00.466824\",\n \"id\": \"a88f77f1-11f1-4b50-b44d-38a7072a00ff\",\n \"started_at\": \"2021-08-05T00:12:00.466824\",\n \"status\": \"opened\",\n \"type\": \"from_work\"\n}"}],"_postman_id":"c50570d0-981f-485d-be00-364fc6c54ef5"},{"name":"List Periods By Person Document","event":[{"listen":"test","script":{"id":"e953c406-aad8-406f-8c03-bae21be7b0b6","exec":["var jsonData = JSON.parse(responseBody);\r","\r","pm.test(\"response should be okay to process\", function () {\r"," pm.response.to.not.be.error;\r","\r"," pm.response.to.not.have.jsonBody(\"error\");\r","});"],"type":"text/javascript","packages":{}}}],"id":"b2766d29-6a2e-4b5f-9677-2b9705d9e426","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"{{intermittent_auth_token}}","type":"text"}],"url":"{{base_integration_url}}/intermittent/persons/periods?doc={{person_doc}}","description":"Lista todos os Periods por um determinado tempo e de um segurado.\nExistem três possíveis filtros:
\nstarted_at e caso não seja informada seu valor padrão é a data atual.Este endpoint encerra um Period, ele deve ser chamado apenas uma vez. Uma vez encerado um Períod usa data de encerramento não pode ser atualizada.
\nPossiveis Retornos:
\n","urlObject":{"path":["intermittent","persons","periods",":period_id"],"host":["{{base_integration_url}}"],"query":[],"variable":[{"id":"c7a3f439-e740-4243-840b-cab0b5d00093","type":"any","value":"{{period_id}}","key":"period_id"}]}},"response":[{"id":"e39d5ebd-180f-48f6-9179-41d5bf6b4e46","name":"Update Period","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"basic auth-token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"finished_at\": \"{{one_hour_after}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_integration_url}}/intermittent/persons/periods/{{period_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization, Origin, X-Requested-With, Content-Type, Accept"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT"},{"key":"Access-Control-Allow-Origin","value":"https://payment.iza.com.vc"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 05 Jan 2022 14:54:41 GMT"},{"key":"Server","value":"nginx/1.19.9"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"x-request-id","value":"Fsdnlbe7BzQJL28AATTh"},{"key":"Content-Length","value":"180"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"finished_at\": \"2022-01-05T12:54:41.369000-03:00\",\n \"id\": \"8908730d-66b8-49a3-93a8-dd55a638793e\",\n \"started_at\": \"2022-01-04T23:42:15.000000-03:00\",\n \"status\": \"opened\",\n \"type\": \"in_transit\"\n}"}],"_postman_id":"a3bac3f5-e8d7-4a73-b1d2-9e2210e96ea4"},{"name":"Cancel Period","event":[{"listen":"test","script":{"id":"051159b7-c2fb-4a4c-a000-0a95d032f879","exec":["var jsonData = JSON.parse(responseBody);\r","\r","pm.test(\"response should be okay to process\", function () {\r"," pm.response.to.not.be.error;\r","\r"," // pm.expect(jsonData.cpf).to.equal(pm.environment.cpf)\r","\r"," pm.response.to.not.have.jsonBody(\"error\");\r","});"],"type":"text/javascript"}}],"id":"bdf41a4c-1a5a-4094-98d2-3d1ffd732446","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"{{intermittent_auth_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"finished_at\": \"{{one_hour_after}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_integration_url}}/intermittent/persons/periods/:period_id/cancel","description":"Endpoint de cancelamento do periodo, com limite de tempo para cancelamento
\nTempo Máximo para Cancelamento: 2 Minutos após a criacão do periodo
\nPossiveis Retornos:
\n","urlObject":{"path":["intermittent","persons","periods",":period_id","cancel"],"host":["{{base_integration_url}}"],"query":[],"variable":[{"id":"1d34bf43-9867-4388-92df-c1703c3eb4d0","type":"any","value":"cb87839b-3698-4525-ab06-7b14c034fa52","key":"period_id"}]}},"response":[{"id":"d8931db6-6111-46ff-b36b-858797dd317b","name":"Cancel Period Out of Time Limit","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"basic auth-token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"finished_at\": \"2021-04-27T19:22:18.144938\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_integration_url}}/intermittent/persons/periods/673d9ac8-c0e5-4e78-980f-5152cf4a8bb8/cancel"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 04 Aug 2021 20:19:15 GMT"},{"key":"Server","value":"nginx/1.19.9"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"x-request-id","value":"Fpgz7FMBgI_j-OYAAAaB"},{"key":"Content-Length","value":"54"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"details\": \"cancelation_out_of_time_limit\"\n }\n}"},{"id":"59945fb0-7f87-4a2a-9790-c237a7b673eb","name":"Cancel Period","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"basic auth-token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"finished_at\": \"{{one_hour_after}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_integration_url}}/intermittent/persons/periods/{{period_id}}/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Authorization, Origin, X-Requested-With, Content-Type, Accept"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT"},{"key":"Access-Control-Allow-Origin","value":"https://payment.iza.com.vc"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 05 Jan 2022 14:46:35 GMT"},{"key":"Server","value":"nginx/1.19.9"},{"key":"strict-transport-security","value":"max-age=31536000"},{"key":"x-request-id","value":"FsdnJFoeNlPvWowAAS9h"},{"key":"Content-Length","value":"153"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"finished_at\": null,\n \"id\": \"20b8f8b2-a6d7-4108-9569-d64f8ed60853\",\n \"started_at\": \"2022-01-04T23:42:15.000000-03:00\",\n \"status\": \"cancelled\",\n \"type\": \"in_transit\"\n}"}],"_postman_id":"bdf41a4c-1a5a-4094-98d2-3d1ffd732446"}],"id":"0a1f9807-d582-4aec-87a1-f4b72e44f477","description":"Períods são espaços de tempo onde o parceiro informa a IZA que naquele determinado período a pessoa estava segurada pela IZA.
\nUm Períod tem dois dados importantes, o started_at e finished_at esses datetimes ajudam a definir o range de tempo de cobertura.
Um Períod é linkado diretamente a um segurado e é fundamental o envio do documento (CPF), de uma Person cadastrado, no momento de criação do Períod.
\nO endpoint de Update Period é utilizado para finalização de periodos
\n","_postman_id":"0a1f9807-d582-4aec-87a1-f4b72e44f477"},{"name":"Validação Credencial","item":[{"name":"Partner Info","id":"72701e4a-1a9a-41ad-acfc-866930a7c795","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{intermittent_auth_token}}","type":"text"}],"url":"{{base_integration_url}}/partner-info","urlObject":{"path":["partner-info"],"host":["{{base_integration_url}}"],"query":[],"variable":[]}},"response":[{"id":"6b2572df-d0b8-47cd-9901-ace97772e184","name":"Partner Info","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{intermittent_auth_token}}","type":"text"}]},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"partner_info\": {\n \"address\": {\n \"city\": \"São Paulo\",\n \"number\": 377,\n \"postal_code\": \"01017-040\",\n \"state\": \"SP\",\n \"street\": \"Avenida Cidade Jardim\"\n },\n \"date_begin\": \"2021-04-07\",\n \"doc\": \"35206922000134\",\n \"name\": \"IZA Tecnologia\",\n \"external_id\": \"FILIAL 01\"\n }\n}"}],"_postman_id":"72701e4a-1a9a-41ad-acfc-866930a7c795"}],"id":"87dd8238-2d55-4ece-bc16-2c34677f1152","description":"Api utilizada para validar se a credencial está valida.
\nA rota `partner_info` além de validar a autencidade da credencial retorna os dados de cadastro da mesma.
\nO campo `external_id` é de uso livre, podendo por exemplo representar o número da filial ou credenciadora.
\n","_postman_id":"87dd8238-2d55-4ece-bc16-2c34677f1152"}],"event":[{"listen":"prerequest","script":{"id":"b94ab10d-70d5-4212-b0ea-768c24b0bc3a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"72fda27e-859e-4f9f-823d-4d47efdb4382","type":"text/javascript","exec":[""]}}],"variable":[{"key":"common_url","value":"integrations/intermittent"},{"key":"product_plan_id","value":"f7fef5c2-9554-4f15-934a-12b5e899efad","type":"string"}]}