{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"79516ace-be87-408d-adba-1a02b4f2a96d","name":"IZA Web API B2B","description":"

Fluxo de Aquisição B2B

\n\nCriação das Pessoas

\nO fluxo de aquisição B2B inicia-se pela criação de pessoas (Jurídica e Física) onde a primeira etapa é validar se o documento, telefone e e-mail da pessoa já existem no banco de dados da IZA. Após validar todos esses itens, deve ser enviado um POST para o endpoint de Persons.\n\n * Sempre que um person é criado com sucesso, o id do mesmo é retornado * \n\n![Fluxo de Pessoa Jurídica](https://i.imgur.com/U4NnDxY.png)\n\n![Fluxo de Pessoa Física](https://i.imgur.com/xRvmZcf.png)\n\nCriação do Contrato
\n\nPara realizar a criação de um contrato, você precisará do id do sponsor (pessoa jurídica) e do id do sponsored (pessoa física). Ambos retornados quando o POST para Persons é realizado com sucesso. \n\nE por fim, deve ser feito um POST para o endpoint de Create Contract.\n\nModelo de requisição para criação de um contrato:\n\n![Fluxo de Contrato](https://i.imgur.com/TmLzKzc.png)\n\nOpções de Pagamento
\n\nPara obter todos os meios de pagamento disponíveis, deve ser feito um GET no endpoint de GET Products.\n\nCadastro de endereço
\n\nO cadastro do endereço é obrigatório antes de executar um pagamento. Para cadastrar um endereço, deve ser feito um POST para o endpoint de Create Person Address.\n\n![Cadastro de endereço](https://i.imgur.com/3gFMiuX.png)\n\nExecutando o pagamento
\n\nO pagamento pode ser realizado via cartão de crédito ou boleto, todos os id's necessários para envio desse endpoint foram retornados nos endpoints anteriores.\n\nAbaixo, modelo de request para o endpoint de Payments.\n\n![Payment](https://i.imgur.com/GZX5mIX.png)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"11296018","team":1001804,"collectionId":"79516ace-be87-408d-adba-1a02b4f2a96d","publishedId":"UVCCd3Av","public":true,"publicUrl":"https://b2b2b.iza.com.vc","privateUrl":"https://go.postman.co/documentation/11296018-79516ace-be87-408d-adba-1a02b4f2a96d","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2021-11-17T21:50:37.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"IZA - Homolog","id":"0209b5a7-9e24-4f5c-a3bc-89f6aa055654","owner":"12281090","values":[{"key":"base_url","value":"https://intermittent-web-api.hml.iza.com.vc/api","enabled":true,"type":"default"},{"key":"person_id","value":"29e1d7a4-75b8-4f0c-be32-268aba2ec4ef","enabled":true,"type":"default"},{"key":"sp_city_id","value":"dc24207e-adde-4daf-a5cc-bf1d6e9c7b8e","enabled":true,"type":"default"},{"key":"device_challenge_auth_code","value":"","enabled":true,"type":"default"},{"key":"device_access_token","value":"","enabled":true,"type":"default"},{"key":"rj_state_id","value":"","enabled":true,"type":"default"},{"key":"sp_state_id","value":"","enabled":true,"type":"default"},{"key":"client_id","value":"93b1757b-d31f-47d9-9379-57fc34b893a5","enabled":true,"type":"default"},{"key":"user_access_token","value":"","enabled":true,"type":"default"},{"key":"user_refresh_token","value":"","enabled":true,"type":"default"},{"key":"code_challenge","value":"jZae727K08KaOmKSgOaGzww_XVqGr_PKEgIMkjrcbJI","enabled":true,"type":"default"},{"key":"product_id","value":"","enabled":true,"type":"default"},{"key":"payment_way_id","value":"","enabled":true,"type":"default"},{"key":"current_timestamp","value":"2020-08-20T18:48:35.732Z","enabled":true,"type":"default"},{"key":"current_timestamp_one_year_ahead","value":"2021-08-20T18:48:35.733Z","enabled":true,"type":"default"},{"key":"user_id","value":"73c3b4b5-9f70-4f75-98ec-8716d0ccf9e9","enabled":true,"type":"default"},{"key":"date_begin","value":"2021-01-20","enabled":true,"type":"default"},{"key":"date_end","value":"2022-05-24","enabled":true,"type":"default"},{"key":"file_id","value":"","enabled":true,"type":"default"},{"key":"claim_id","value":"3504858e-c898-4d0d-9f8a-b2e41410c527","enabled":true,"type":"default"},{"key":"product_plan_id","value":"","enabled":true,"type":"default"},{"key":"change_request_id","value":"","enabled":true,"type":"default"},{"key":"profession_id","value":"","enabled":true,"type":"default"},{"key":"city_id","value":"","enabled":true,"type":"default"},{"key":"coverage_id","value":"","enabled":true,"type":"default"},{"key":"base_sies_url","value":"{{base_url}}/sies","enabled":true,"type":"default"},{"key":"user_change_request_id","value":"","enabled":true,"type":"default"},{"key":"claim_sies_id","value":"{{claim_sies_id}}","enabled":true,"type":"default"},{"key":"base_integration_url","value":"{{base_url}}/integrations","enabled":true,"type":"default"},{"key":"ocr_token","value":"7002b89eee34dc9c5103b0f892b4ad16","enabled":true,"type":"default"},{"key":"documentdata_token","value":"","enabled":true,"type":"default"},{"key":"date_happened","value":"","enabled":true,"type":"default"},{"key":"facematch_token","value":"","enabled":true,"type":"default"},{"key":"person_doc","value":"76904397802","enabled":true,"type":"default"},{"key":"person_name","value":"","enabled":true,"type":"default"},{"key":"cancellation_reason_id","value":"","enabled":true,"type":"default"},{"key":"email","value":"","enabled":true,"type":"default"},{"key":"name","value":"","enabled":true,"type":"default"},{"key":"phone","value":"","enabled":true,"type":"default"},{"key":"person_email","value":"","enabled":true,"type":"default"},{"key":"intermittent_auth_token","value":"Basic Njc2ZWRjM2MtZTdmNy00NjQ2LTllNWMtODAwODc2MmQyMzBiOjNVV0ZiWVpsQmJ5cFNoR3E3U1M5QVJTQTJWVko3RHBKdjFDKzA4czB0TWo5VDVxK2JxcWtrTCtxT0VHeXlUU1J=","enabled":true,"type":"default"},{"key":"now","value":"","enabled":true,"type":"default"},{"key":"zendesk_api_user","value":"676edc3c-e7f7-4646-9e5c-8008762d230b","enabled":true,"type":"secret"},{"key":"zendesk_api_key","value":"3UWFbYZlBbypShGq7SS9ARSA2VVJ7DpJv1C+08s0tMj9T5q+bqqkkL+qOEGyyTST","enabled":true,"type":"secret"},{"key":"izafront_url","value":"https://hmg.iza.com.vc/api","enabled":true,"type":"default"},{"key":"endorsement_id","value":"","enabled":true,"type":"default"},{"key":"bank_account_id","value":"","enabled":true,"type":"default"},{"key":"one_hour_after","value":"","enabled":true,"type":"default"},{"key":"period_id","value":"","enabled":true,"type":"default"},{"key":"idempotency_key","value":"","enabled":true,"type":"default"},{"key":"batch_id","value":"","enabled":true,"type":"default"},{"key":"contract_type","value":"corporate","enabled":true,"type":"default"},{"key":"document","value":"65928967000183","enabled":true,"type":"default"},{"key":"","value":"","enabled":true,"type":"default"},{"key":"payment_token","value":"","enabled":true,"type":"default"},{"key":"base_backoffice_url","value":"https://backoffice-izacorehmg.iza.com.vc/api","enabled":true,"type":"default"},{"key":"contract_id_backoffice","value":"82f4e30e-de63-4a3c-8e37-03183c527b9b","enabled":true,"type":"default"},{"key":"person_id_backoffice","value":"860b5ac9-7b2b-4339-91c9-c0cc6f7a1bbb","enabled":true,"type":"default"},{"key":"auth_backoffice","value":"Basic Njc2ZWRjM2MtZTdmNy00NjQ2LTllNWMtODAwODc2MmQyMzBiOjNVV0ZiWVpsQmJ5cFNoR3E3U1M5QVJTQTJWVko3RHBKdjFDKzA4czB0TWo5VDVxK2JxcWtrTCtxT0VHeXlUU1Q=","enabled":true,"type":"default"},{"key":"password_recovery_challenge_id","value":"","enabled":true,"type":"default"},{"key":"contract_id","value":"c4e9d0d3-e42a-4152-8ad4-e45d2e0ef98f","enabled":true,"type":"default"},{"key":"person_password","value":"","enabled":true,"type":"any"},{"key":"payment_way_card","value":"6efd84e0-b903-47a1-bcc6-f35e577011b0","enabled":true,"type":"default"},{"key":"today","value":"","enabled":true,"type":"any"},{"key":"two_hour_after","value":"","enabled":true,"type":"any"},{"key":"three_hour_after","value":"","enabled":true,"type":"any"},{"key":"four_hour_after","value":"","enabled":true,"type":"any"},{"key":"intermittent_auth_token_per_day","value":"","enabled":true,"type":"default"},{"key":"parent_contract_id","value":"204058db-df88-4fcf-9c26-985c21a9de7c","enabled":true,"type":"any"},{"key":"total","value":"","enabled":true,"type":"any"},{"key":"new_contract_id","value":"","enabled":true,"type":"any"},{"key":"begin_date","value":"2022-01-01T01:42:47.768","enabled":true,"type":"default"},{"key":"finish_date","value":"2022-10-29T19:22:00.368Z","enabled":true,"type":"default"},{"key":"endDate","value":"","enabled":true,"type":"any"},{"key":"startDate","value":"","enabled":true,"type":"any"},{"key":"user_api_id","value":"9b26c0cb-bf24-4e82-aed2-37cf02d6fdcd","enabled":true,"type":"default"},{"key":"user_api_secret","value":"rSVS6e8azS1aUEl3BDpYuvZIKzxLd+WeqrZ6pE+JBnOP6JSEV8WsIh7MBD9537op","enabled":true,"type":"default"},{"key":"inicio","value":"","enabled":true,"type":"any"},{"key":"fim","value":"","enabled":true,"type":"any"},{"key":"id_bilhete","value":"","enabled":true,"type":"any"},{"key":"plano_id","value":"","enabled":true,"type":"any"},{"key":"sync_token","value":"token-test","enabled":true,"type":"default"},{"key":"partner-token","value":"token-test","enabled":true,"type":"default"},{"key":"protocolo","value":"","enabled":true,"type":"any"},{"key":"plano","value":"","enabled":true,"type":"any"},{"key":"ten_minutes_after","value":"","enabled":true,"type":"any"},{"key":"one_minutes_after","value":"","enabled":true,"type":"any"},{"key":"base_izinha_url","value":"https://backoffice-api.hml.iza.digital/api","enabled":true,"type":"default"}],"published":true}],"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"},{"label":"IZA - Homolog","value":"12281090-0209b5a7-9e24-4f5c-a3bc-89f6aa055654"}],"canonicalUrl":"https://b2b2b.iza.com.vc/view/metadata/UVCCd3Av"}