{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"337ede19-81a5-4c0f-b42a-ce9030d4f26a","name":"IZA Web API","description":"Abaixo estão documentados visualmente os fluxos seguidos de explicação.\n\n<img src=\"https://i.imgur.com/VSNQYQC.png\" alt=\"\">\n\nO fluxo de pessoas se inicia com a checagem para validaar se existem os dados da pessoa, além de checar se ele já possui contratos na IZA.  \nValidar por CPF/CNPJ,Email e Telefone.\n\nApós criar a pessoa devemos criar o endereço dela, utilizando os IDs disponibilizados pelo endpoints de CEP\n\n<img src=\"https://i.imgur.com/ZnJBePe.png\" alt=\"\">\n\nO fluxo de contratos é mais complexo e utiliza os dados criados no fluxo de person.\n\nGet Products para conseguir produtos e formas de pagamento disponiveis.\n\nCaso exista, validar o promocode e pegar o valor atualizado do contrato.\n\nÉ possivel checar informações do cartão pela rota de Bin\n\n# Documentação IzaFrontAPI - Segurados B2C\n\nPara adicionar um segurado no modelo B2C, há duas modalidades: **Compra para si** e **compra para terceiros(patrocinados)**\n\nSegurados e patrocinadores são registrados como `Person`.\n\n## Diferenças entre compras: Para si x Para terceiros\n\n### Compra para si:  \n- As faturas são enviadas para o email do segurado\n- O endereço registrado deve ser o do segurado\n- O documento da Person criada obrigatoriamente deve ser um CPF\n\n### Compra para terceiros:\n- As faturas são enviadas para o email do patrocinador\n- O endereço registrado deve ser o do patrocinador\n- O documento da Person criada pode ser um CPF ou CNPJ\n\nA listagem de produtos também lista as formas de pagamentos. O id da forma de pagamento será necessário para gerar o contrato.\n\nSó será possível gerar apólices com os planos listados pelo endpoint `GET /api/products`.\n\nCaso haja cupom de desconto aplicável, o mesmo poderá ser verificado via API pelo endpoint `GET /api/promocode/:cupom`\n\nAntes da criação de uma Person, é possível verificar os dados sensíveis via API pelos endpoints abaixo:\n- Email: `GET /api/person/email/:email`\n- CPF: `GET /api/person/cpf/:cpf`\n- Telefone: `GET /api/person/phone/:phone`\n\nPara gerar uma apólice, é necessário efetuar o pagamento do contrato.\n\nA liberação da apólice via cartão de crédito é imediata. No boleto, ocorre após a compensação do pagamento ser reconhecida.\n\nO fluxo de criação de apólice é ilustrado no diagrama a seguir:\n\n![Diagrama do fluxo de criação de apólice](https://i.ibb.co/K2D3y6m/teste-drawio.png)\n\n\n\n## Documentação dos endpoints\n\n#### Lista todos os produtos e formas de pagamento disponíveis\n\n```http\n  GET /api/products\n```\n\n--- \n\n#### Verifica a validade do cupom de desconto\n\nCaso seja válido, retorna também o valor do plano com o cupom aplicado.\n\n```http\n  POST /api/payments/promocode/${cupom}\n```\n\n| Body   | Tipo       | Descrição                                   |\n| :---------- | :--------- | :------------------------------------------ |\n| `product_plan_id`      | `string` | **Obrigatório**. O ID do plano a ser verificado |\n\n--- \n\n#### Cria a Person\n\nCaso seja válido, retorna também o valor do plano com o cupom aplicado.\n\n```http\n  POST /api/persons\n```\n\n| Body   | Tipo       | Descrição                                   |\n| :---------- | :--------- | :------------------------------------------ |\n| `name`      | `string` | **Obrigatório**. Nome da pessoa a ser criada |\n| `birthed_at`      | `string` | **Obrigatório**. Data de nascimento no formato YYYY-MM-DD |\n| `doc`      | `string` | **Obrigatório**. CPF a ser cadastrado, deve conter apenas os números |\n| `email`      | `string` | **Opcional**. Email a ser cadastrado |\n| `main_cell_phone`      | `string` | **Opcional**. Telefone a ser cadastrado, deve conter apenas os números |\n\n--- \n\n#### Verifica se o CPF já existe na base\n\nCaso esteja disponível para cadastro, retorna erro `404 (Not Found)`\n\nSe já existir, retorna o `email`, `main_cell_phone`, `id` e `contracts`.\n\n\n```http\n  GET /api/persons/cpf/${cpf}\n```\n\n| Parâmetros   | Tipo       | Descrição                                   |\n| :---------- | :--------- | :------------------------------------------ |\n| `cpf`      | `string` | **Obrigatório**. CPF a ser verificado |\n\n--- \n\n#### Verifica se o TELEFONE já existe na base\n\nCaso esteja disponível para cadastro, retorna erro `404 (Not Found)`\n\nSe já existir, retorna o `email`, `main_cell_phone`, `id` e `contracts`.\n\n```http\n  GET /api/persons/phone/${telefone}\n```\n\n| Parâmetros   | Tipo       | Descrição                                   |\n| :---------- | :--------- | :------------------------------------------ |\n| `telefone`      | `string` | **Obrigatório**. Telefone a ser verificado |\n\n\n---\n\n#### Verifica se o EMAIL já existe na base\n\nCaso esteja disponível para cadastro, retorna erro `404 (Not Found)`\n\nSe já existir, retorna o `email`, `main_cell_phone`, `id` e `contracts`.\n\n\n```http\n  GET /api/persons/email/${email}\n```\n\n| Parâmetros   | Tipo       | Descrição                                   |\n| :---------- | :--------- | :------------------------------------------ |\n| `email`      | `string` | **Obrigatório**. Email a ser verificado |\n\n--- \n\n#### Busca CEP e retorna endereço + city_id\n\nO campo `city_id` é necessário para vincular o endereço a Person criada\n\n\n```http\n  GET /api/cep/${cep}\n```\n\n| Parâmetros   | Tipo       | Descrição                                   |\n| :---------- | :--------- | :------------------------------------------ |\n| `cep`      | `string` | **Obrigatório**. CEP a ser buscado |\n\n--- \n\n#### Vincula o endereço ao ID da Person\n\n```http\n  POST /api/persons/${person_id}/addresses\n```\n| Parâmetros   | Tipo       | Descrição                                   |\n| :---------- | :--------- | :------------------------------------------ |\n| `person_id`      | `string` | **Obrigatório**. ID da Person a ser vinculada ao endereço |\n\n\n| Body   | Tipo       | Descrição                                   |\n| :---------- | :--------- | :------------------------------------------ |\n| `postal_code`      | `string` | **Obrigatório**. CEP a ser vinculado |\n| `street`      | `string` | **Obrigatório**. Rua a ser vinculada |\n| `neighborhood`      | `string` | **Obrigatório**. Bairro a ser vinculado |\n| `city_id`      | `string` | **Obrigatório**. ID da cidade recebido na rota `GET /api/cep/${cep}` |\n| `additional`      | `string` | **Obrigatório**. Caso não haja complemento, enviar uma string vazia |\n| `number`      | `number` | **Obrigatório**. Número a ser vinculado |\n\n--- \n\n#### Cria o contrato\n\n```http\n  POST /api/contracts\n```\n\n| Body   | Tipo       | Descrição                                   |\n| :---------- | :--------- | :------------------------------------------ |\n| `payment_way_id`      | `string` | **Obrigatório**. ID da forma de pagamento, obtido pela rota `GET /api/products` |\n| `person_id`      | `string` | **Obrigatório**. ID da pessoa à quem se destina a apólice |\n| `product_plan_id`      | `string` | **Obrigatório**. ID do plano, obtido pela rota `GET /api/products` |\n| `sponsor_id`      | `string` | **Opcional**. ID da Person patrocinadora, só deve ser passado no caso de **COMPRA PARA TERCEIROS** |\n\n#### Pagamento via BOLETO BANCÁRIO\n\n```http\n  POST /api/payments\n```\n\n| Body   | Tipo       | Descrição                                   |\n| :---------- | :--------- | :------------------------------------------ |\n| `contract_id`      | `string` | **Obrigatório**. ID do contrato, obtido pela rota `POST /api/contracts` |\n| `person_id`      | `string` | **Obrigatório**. ID da pessoa à quem se destina a apólice |\n| `product_plan_id`      | `string` | **Obrigatório**. ID do plano, obtido pela rota `GET /api/products` |\n| `promocode_id`      | `string` | **Opcional**. Cupom a ser aplicado |\n\n#### Pagamento via CARTÃO DE CRÉDITO\n\n```http\n  POST /api/payments\n```\n\n| Body   | Tipo       | Descrição                                   |\n| :---------- | :--------- | :------------------------------------------ |\n| `contract_id`      | `string` | **Obrigatório**. ID do contrato, obtido pela rota `POST /api/contracts` |\n| `person_id`      | `string` | **Obrigatório**. ID da pessoa à quem se destina a apólice |\n| `product_plan_id`      | `string` | **Obrigatório**. ID do plano, obtido pela rota `GET /api/products` |\n| `card`      | `object` | **Obrigatório**. Cartão de crédito a ser utilizado, o objeto está descrito abaixo |\n| `promocode_id`      | `string` | **Opcional**. Cupom a ser aplicado |\n\nEstrutura do objeto `card`: \n``` \n{\n  number: string, // deve conter apenas os números\n  expiration_date: string, // formato MM/AAAA\n  brand: \"Master\", // \"Master\" || \"Visa\" || \"American Express\" || \"Elo\"\n  holder_name: string,\n  save: true,\n  security_code: string\n}\n```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"12303338","team":1001804,"collectionId":"337ede19-81a5-4c0f-b42a-ce9030d4f26a","publishedId":"TzCP6nGt","public":true,"publicUrl":"https://b2b2c.api.docs.iza.com.vc","privateUrl":"https://go.postman.co/documentation/12303338-337ede19-81a5-4c0f-b42a-ce9030d4f26a","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-09-16T13:04:21.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"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://b2b2c.api.docs.iza.com.vc/view/metadata/TzCP6nGt"}