Here you can find the documentation for various Public APIs. For most of the APIs you will need an API Key and most of the times it makes more sense if the API Key is assigned to a CRM User.
\nFor any clarifications on how to use the APIs please follow the article here [Article on how you can Import APIs in Postman]
\nFor any additional questions or support please contact us at support@impactechs.com
\nIn order to setup your Postman collection you will have to setup a setup of environment variables. You can find more information on a specific API documentation
\nLOGIN
\n","urlObject":{"path":["login"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"5e88d7f0-5efe-420c-8188-65c55b6dacc8","name":"Get API Token (Success)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json"},{"key":"Date","value":"Tue, 26 Sep 2017 23:56:00 GMT"},{"key":"X-Api-Key","value":"{{apiKey}}"},{"key":"X-Domain","type":"text","value":"{{xDomain}}"}],"body":{"mode":"raw","raw":"{\r\n \"email\" : \"is@impactechs.com\",\r\n \"rememberMe\" : true,\r\n \"password\" : \"myAwesomePassword\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"X-Date","value":"Fri, 30 Oct 2020 16:20:59 GMT"},{"key":"Referrer-Policy","value":"origin-when-cross-origin, strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Date","value":"Fri, 30 Oct 2020 16:20:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"754"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"name\": \"Impact Support\",\n \"firstName\": \"Impact\",\n \"lastName\": \"Support\",\n \"email\": \"is@impactechs.com\",\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxLUlcL1drUDl2NHdoZ3c5UUdZTjN0aUZcL2cyS3pzQlNLVHFBMUFjcUVuRFZPMm9iN09mMXhCQW9kamRNTEFzRDVWSXVlQlRoYkJ2bWtGNW9XOVRoUUEyIiwiaXNzIjoiaW1wLWNybSIsImV4cCI6MTYwNDUwNjg1OSwiaWF0IjoxNjA0MDc0ODU5LCJqdGkiOiIzNjViY2NmMmQ5NjM2Y2U2YTRjYmE5ZjQ3ODQ5MzU0Y2JkMDcyNDE3YTUyMmQ2NzU4MjUyMmJhZDhjMTA0MTNhN2VjZWY0ZjE3ZDhmOWM5N2U3OWM0OWRlYmMyZWZhZjliYWM0ODYxOGQ0M2Y0ODRlNjFlYTEwMjNiZDhiYzM2MWUwNTk0MGEzNTg1MWJhMjI1NzE2MDhjZTcyNWM0NWFlZjBmMjkxNDQ1ODMyODFhYzJkNjQ4YmM1MmNmYWQxZDJlZGEzNmE0YTM5YzY3ZTE2YTUzNzIzOTY1YTVhMjVhYTM4MGEzNzRmMTRhNjZjY2MyMjczZTFiZGY1NzhkYmZiIn0.Nx0m7UCj6O0ZOqk41-6vKHa5_qC13Pl0XPoRwUEfAnw\"\n}"},{"id":"8d6ca5de-d260-46f7-a5c3-bfed5cc57d78","name":"Get API Token (Error)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json"},{"key":"Date","value":"Tue, 26 Sep 2017 23:56:00 GMT"},{"key":"X-Api-Key","value":"{{apiKey}}"},{"key":"X-Domain","type":"text","value":"{{xDomain}}"}],"body":{"mode":"raw","raw":"{\r\n \"email\" : \"is@impactechs.com\",\r\n \"rememberMe\" : true,\r\n \"password\" : \"myAwesomePassword\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/login"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"X-Date","value":"Fri, 30 Oct 2020 16:22:18 GMT"},{"key":"Referrer-Policy","value":"origin-when-cross-origin, strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"Date","value":"Fri, 30 Oct 2020 16:22:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"39"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 109,\n \"message\": \"User not found\"\n}"}],"_postman_id":"82159bc2-ad2a-4e51-9fd6-4d729cb224d6"}],"id":"51febe4d-b71b-4ffb-87ae-303c78a499a3","event":[{"listen":"prerequest","script":{"id":"4352fb2a-8321-481b-8d91-98be3a7505eb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6e88c2fe-01e2-4bbb-a438-1fd2a7857572","type":"text/javascript","exec":[""]}}],"_postman_id":"51febe4d-b71b-4ffb-87ae-303c78a499a3","description":""},{"name":"General APIs","item":[{"name":"v2","item":[{"name":"Lead","event":[{"listen":"test","script":{"id":"d23ce042-8a07-497d-b05d-bddf1dee085b","exec":["pm.test(\"Status code is 201\", function () {"," pm.response.to.have.status(201);","});","","","pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include(\"pong\");","});"],"type":"text/javascript"}}],"id":"ab0b1a2d-17ba-426d-9837-a1ab0594740f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Date","value":"Wed, 20 Dec 2017 07:28:00 GMT"},{"key":"X-Api-Key","value":"{{apiKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"personalInformation\": {\r\n \"email\":\"ironmanco@marvel.com\",\r\n \"firstName\": \"\",\r\n \"lastName\": \"\",\r\n \"companyName\": \"Iron Man Co\",\r\n \"vatNo\": \"US123456\",\r\n \"eType\": 2,\r\n \"title\": \"\",\r\n \"gender\": \"\",\r\n \"birthday\": \"1990-10-25\",\r\n \"countryOfResidence\": \"\",\r\n \"countryOfIncorporation\": \"US\",\r\n \"preferredLanguageCode\": \"EN\",\r\n \"timezone\": \"gmt\",\r\n \"telephones\": [\r\n {\r\n \"number\": \"+447911123451\"\r\n }\r\n ],\r\n \"addresses\": [\r\n {\r\n \"street\": \"Wall Street\",\r\n \"streetNum\": \"422\",\r\n \"city\": \"NY\",\r\n \"postalCode\": \"NY1 23\",\r\n \"state\": \"NY\",\r\n \"countryCode\": \"US\",\r\n \"typeOf\": \"residential\"\r\n }\r\n ]\r\n },\r\n \"utmDetails\": {\r\n \"utmCampaign\": \"utmCampaign\",\r\n \"utmMedium\": \"utmMedium\",\r\n \"utmSource\": \"utmSource\",\r\n \"affiliateId\": \"123\",\r\n \"campaignId\": \"campaignId\",\r\n \"utmTerm\": \"utmTerm\",\r\n \"utmAdGroup\": \"utmAdGroup\",\r\n \"utmPlacement\": \"utmPlacement\",\r\n \"utmDevice\": \"utmDevice\",\r\n \"sourcePage\": \"sourcePage\",\r\n \"dataReferrer\": \"dataReferrer\",\r\n \"gclId\": \"gclId\",\r\n \"cxd\": \"cxd\",\r\n \"utmContent\": \"utmContent\",\r\n \"registrationUrl\": \"registrationUrl\"\r\n },\r\n \"poolId\": 28,\r\n \"assignedTo\": 12,\r\n \"referrer\": \"referrerId\",\r\n \"generalInformation\": {\r\n \"termsAndConditions\": true,\r\n \"comments\": \"Here is a comment\",\r\n \"optInMarketing\": true\r\n },\r\n \"metadata\": {\r\n \"additionalMeta\": \"additionalMeta1\",\r\n \"additionalMeta2\": \"additionalMeta2\"\r\n }\r\n}"},"url":"{{domainv2}}/lead","description":"This API is responsible for creating a new lead in the CRM
\nThe newly created lead will be automatically marked as duplicate with another lead if a lead with the same email already exists in the CRM. If not, a new lead will be created.
All additional parameters sent with the request will be associated with the lead and saved as metadata.
\n_**source**_ of the customerpersonalInformation:
\naddresses:
\nutmDetails:
\ngeneralInformation:
\nmetadata:
\nThis API is responsible for creating a new customer in the CRM
\nThe newly created customer will be automatically associated with a lead if a lead with the same email already exists in the CRM. If not, a new lead will be created.
\nAll additional parameters sent with the request will be associated with the lead and saved as metadata.
\nsource of the customerpersonalInformation:
\naddresses:
\nutmDetails:
\ngeneralInformation:
\nmetadata:
\ntradingAccount:
\nThis API is responsible to login in a customer to the CRM
\nThis API is responsible to login the customer to the Members Area of the CRM and return the relevant token
\nThis API is responsible to initiate the forgot password procedure
\nThis API is responsible to initiate the forgot password procedure. As a result, It will construct and send the reset password link with the reset password token.
\nThis API is responsible to reset the password of the customer
\nThis API is responsible to reset the password of the customer and redirect him to the login page
\nAll general APIs assume that you already have an API key in place, X-Api-Key. You can either set it manually or you can set it up as an environment variable.
For most of the requests it makes sense if you assign the API key to a specific CRM user of your choice. Each API below provides additional details on what are the benefits of assigning the API Key to a CRM User.
\n\n![](\"https://mermaid.ink/img/eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0NyZWF0ZSBDUk0gVXNlcl1cbiAgICBBIC0tPiBCW1ByZXBhcmUgdXNlcidzIHJvbGUgYW5kIHBlcm1pc3Npb25zXVxuICAgIEIgLS0-IEVbQ3JlYXRlIEFQSSBLZXldXG4gICAgRSAtLT58IEFzc2lnbiBBUEkgS2V5IHRvIENSTSBVc2VyIGFuZCB1c2UgQVBJIEtleSAgfCBGW0xlYWQgQVBJXVxuICAgIEUgLS0-fCBBc3NpZ24gQVBJIEtleSB0byBDUk0gVXNlciBhbmQgdXNlIEFQSSBLZXkgIHwgR1tDdXN0b21lciBBUEldXG4gICAgICAgICAgICAiLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCIsInRoZW1lVmFyaWFibGVzIjp7ImJhY2tncm91bmQiOiJ3aGl0ZSIsInByaW1hcnlDb2xvciI6IiNFQ0VDRkYiLCJzZWNvbmRhcnlDb2xvciI6IiNmZmZmZGUiLCJ0ZXJ0aWFyeUNvbG9yIjoiaHNsKDgwLCAxMDAlLCA5Ni4yNzQ1MDk4MDM5JSkiLCJwcmltYXJ5Qm9yZGVyQ29sb3IiOiJoc2woMjQwLCA2MCUsIDg2LjI3NDUwOTgwMzklKSIsInNlY29uZGFyeUJvcmRlckNvbG9yIjoiaHNsKDYwLCA2MCUsIDgzLjUyOTQxMTc2NDclKSIsInRlcnRpYXJ5Qm9yZGVyQ29sb3IiOiJoc2woODAsIDYwJSwgODYuMjc0NTA5ODAzOSUpIiwicHJpbWFyeVRleHRDb2xvciI6IiMxMzEzMDAiLCJzZWNvbmRhcnlUZXh0Q29sb3IiOiIjMDAwMDIxIiwidGVydGlhcnlUZXh0Q29sb3IiOiJyZ2IoOS41MDAwMDAwMDAxLCA5LjUwMDAwMDAwMDEsIDkuNTAwMDAwMDAwMSkiLCJsaW5lQ29sb3IiOiIjMzMzMzMzIiwidGV4dENvbG9yIjoiIzMzMyIsIm1haW5Ca2ciOiIjRUNFQ0ZGIiwic2Vjb25kQmtnIjoiI2ZmZmZkZSIsImJvcmRlcjEiOiIjOTM3MERCIiwiYm9yZGVyMiI6IiNhYWFhMzMiLCJhcnJvd2hlYWRDb2xvciI6IiMzMzMzMzMiLCJmb250RmFtaWx5IjoiXCJ0cmVidWNoZXQgbXNcIiwgdmVyZGFuYSwgYXJpYWwiLCJmb250U2l6ZSI6IjE2cHgiLCJsYWJlbEJhY2tncm91bmQiOiIjZThlOGU4Iiwibm9kZUJrZyI6IiNFQ0VDRkYiLCJub2RlQm9yZGVyIjoiIzkzNzBEQiIsImNsdXN0ZXJCa2ciOiIjZmZmZmRlIiwiY2x1c3RlckJvcmRlciI6IiNhYWFhMzMiLCJkZWZhdWx0TGlua0NvbG9yIjoiIzMzMzMzMyIsInRpdGxlQ29sb3IiOiIjMzMzIiwiZWRnZUxhYmVsQmFja2dyb3VuZCI6IiNlOGU4ZTgiLCJhY3RvckJvcmRlciI6ImhzbCgyNTkuNjI2MTY4MjI0MywgNTkuNzc2NTM2MzEyOCUsIDg3LjkwMTk2MDc4NDMlKSIsImFjdG9yQmtnIjoiI0VDRUNGRiIsImFjdG9yVGV4dENvbG9yIjoiYmxhY2siLCJhY3RvckxpbmVDb2xvciI6ImdyZXkiLCJzaWduYWxDb2xvciI6IiMzMzMiLCJzaWduYWxUZXh0Q29sb3IiOiIjMzMzIiwibGFiZWxCb3hCa2dDb2xvciI6IiNFQ0VDRkYiLCJsYWJlbEJveEJvcmRlckNvbG9yIjoiaHNsKDI1OS42MjYxNjgyMjQzLCA1OS43NzY1MzYzMTI4JSwgODcuOTAxOTYwNzg0MyUpIiwibGFiZWxUZXh0Q29sb3IiOiJibGFjayIsImxvb3BUZXh0Q29sb3IiOiJibGFjayIsIm5vdGVCb3JkZXJDb2xvciI6IiNhYWFhMzMiLCJub3RlQmtnQ29sb3IiOiIjZmZmNWFkIiwibm90ZVRleHRDb2xvciI6ImJsYWNrIiwiYWN0aXZhdGlvbkJvcmRlckNvbG9yIjoiIzY2NiIsImFjdGl2YXRpb25Ca2dDb2xvciI6IiNmNGY0ZjQiLCJzZXF1ZW5jZU51bWJlckNvbG9yIjoid2hpdGUiLCJzZWN0aW9uQmtnQ29sb3IiOiJyZ2JhKDEwMiwgMTAyLCAyNTUsIDAuNDkpIiwiYWx0U2VjdGlvbkJrZ0NvbG9yIjoid2hpdGUiLCJzZWN0aW9uQmtnQ29sb3IyIjoiI2ZmZjQwMCIsInRhc2tCb3JkZXJDb2xvciI6IiM1MzRmYmMiLCJ0YXNrQmtnQ29sb3IiOiIjOGE5MGRkIiwidGFza1RleHRMaWdodENvbG9yIjoid2hpdGUiLCJ0YXNrVGV4dENvbG9yIjoid2hpdGUiLCJ0YXNrVGV4dERhcmtDb2xvciI6ImJsYWNrIiwidGFza1RleHRPdXRzaWRlQ29sb3IiOiJibGFjayIsInRhc2tUZXh0Q2xpY2thYmxlQ29sb3IiOiIjMDAzMTYzIiwiYWN0aXZlVGFza0JvcmRlckNvbG9yIjoiIzUzNGZiYyIsImFjdGl2ZVRhc2tCa2dDb2xvciI6IiNiZmM3ZmYiLCJncmlkQ29sb3IiOiJsaWdodGdyZXkiLCJkb25lVGFza0JrZ0NvbG9yIjoibGlnaHRncmV5IiwiZG9uZVRhc2tCb3JkZXJDb2xvciI6ImdyZXkiLCJjcml0Qm9yZGVyQ29sb3IiOiIjZmY4ODg4IiwiY3JpdEJrZ0NvbG9yIjoicmVkIiwidG9kYXlMaW5lQ29sb3IiOiJyZWQiLCJsYWJlbENvbG9yIjoiYmxhY2siLCJlcnJvckJrZ0NvbG9yIjoiIzU1MjIyMiIsImVycm9yVGV4dENvbG9yIjoiIzU1MjIyMiIsImNsYXNzVGV4dCI6IiMxMzEzMDAiLCJmaWxsVHlwZTAiOiIjRUNFQ0ZGIiwiZmlsbFR5cGUxIjoiI2ZmZmZkZSIsImZpbGxUeXBlMiI6ImhzbCgzMDQsIDEwMCUsIDk2LjI3NDUwOTgwMzklKSIsImZpbGxUeXBlMyI6ImhzbCgxMjQsIDEwMCUsIDkzLjUyOTQxMTc2NDclKSIsImZpbGxUeXBlNCI6ImhzbCgxNzYsIDEwMCUsIDk2LjI3NDUwOTgwMzklKSIsImZpbGxUeXBlNSI6ImhzbCgtNCwgMTAwJSwgOTMuNTI5NDExNzY0NyUpIiwiZmlsbFR5cGU2IjoiaHNsKDgsIDEwMCUsIDk2LjI3NDUwOTgwMzklKSIsImZpbGxUeXBlNyI6ImhzbCgxODgsIDEwMCUsIDkzLjUyOTQxMTc2NDclKSJ9fSwidXBkYXRlRWRpdG9yIjpmYWxzZX0\")
","event":[{"listen":"prerequest","script":{"id":"4994180d-874b-4138-b56b-79f218776969","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fcfa5a6c-6d9e-4c84-a9e8-528cf99a247f","type":"text/javascript","exec":[""]}}],"_postman_id":"6af4550a-b480-4954-82be-d2ce1b87808d"},{"name":"IB Reports","item":[{"name":"Available Servers","id":"a2ecea94-d4b9-44e2-8273-969bb85dbe30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Date","value":"Tue, 26 Sep 2017 23:56:00 GMT"},{"key":"X-Api-Key","value":"{{apiKey}}"},{"key":"X-Auth-Token","value":"{{token}}"},{"key":"X-Domain","type":"text","value":"{{xDomain}}"}],"url":"{{domain}}/ib/servers","description":"This API is responsible for getting all available servers.
\n\n\nPlease keep in mind that if the permission \"Services - Full IB Report\" is assigned to the role of the user, he/she will have access to all servers and not only to the servers associated with the leads / customers that he/she created.
\n
This API is responsible to return all available leads.
\n\n\nPlease keep in mind that if the permission \"Services - Full IB Report\" is assigned to the role of the user, he/she will have access to all leads and not only to the leads / customers that he/she created.
\n
This API is responsible to return all available registrations (converted leads / customers) and their corresponding accounts.
\n\n\nPlease keep in mind that if the permission \"Services - Full IB Report\" is assigned to the role of the user, he/she will have access to all registrations and not only to the registrations associated with the leads / customers that he/she created.
\n
This API is responsible to return all available transactions.
\n\n\nPlease keep in mind that if the permission \"Services - Full IB Report\" is assigned to the role of the user, he/she will have access to all transactions and not only to the transactions associated with the leads / customers that he/she created.
\n
This API is responsible to return all available positions / trades.
\n\n\nPlease keep in mind that if the permission \"Services - Full IB Report\" is assigned to the role of the user, he/she will have access to all positions and not only to the positions associated with the leads / customers that he/she created.
\n
![](\"https://mermaid.ink/img/eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0NyZWF0ZSBDUk0gVXNlcl1cbiAgICBBIC0tPiBCe1ByZXBhcmUgdXNlcidzIHJvbGUgYW5kIHBlcm1pc3Npb25zfVxuICAgIEIgLS0-IHxPbmV8IENbQ3JlYXRlIFJvbGVdXG4gICAgQiAtLT4gfFR3b3wgRFtBc3NpZ24gcGVybWlzc2lvbjogSUIgUmVwb3J0cyB0byByb2xlXVxuICAgIEMgLS0-IEVbQ3JlYXRlIEFQSSBLZXldXG4gICAgRCAtLT4gRVtDcmVhdGUgQVBJIEtleV0gXG4gICAgRSAtLT58IEFzc2lnbiBBUEkgS2V5IHRvIENSTSBVc2VyIGFuZCB1c2UgQVBJIEtleSAgfCBGW0FQSSBMb2dpbl1cbiAgICBGW0FQSSBMb2dpbl0gLS0-fFVzZSB0b2tlbiArIEFQSSBLZXl8IEcoQXZhaWxhYmxlIFNlcnZlcnMpXG4gICAgRyAtLT4gSHtDYWxsIHlvdXIgQVBJfVxuICAgIEggLS0-fE9uZXwgS1tMZWFkc11cbiAgICBIIC0tPnxUd298IExbUmVnaXN0cmF0aW9uc11cbiAgICBIIC0tPnxUaHJlZXwgTVtUcmFuc2FjdGlvbnNdXG4gICAgSCAtLT58Rm91cnwgTltQb3NpdGlvbnNdXG4gICAgICAgICAgICAiLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCIsInRoZW1lVmFyaWFibGVzIjp7ImJhY2tncm91bmQiOiJ3aGl0ZSIsInByaW1hcnlDb2xvciI6IiNFQ0VDRkYiLCJzZWNvbmRhcnlDb2xvciI6IiNmZmZmZGUiLCJ0ZXJ0aWFyeUNvbG9yIjoiaHNsKDgwLCAxMDAlLCA5Ni4yNzQ1MDk4MDM5JSkiLCJwcmltYXJ5Qm9yZGVyQ29sb3IiOiJoc2woMjQwLCA2MCUsIDg2LjI3NDUwOTgwMzklKSIsInNlY29uZGFyeUJvcmRlckNvbG9yIjoiaHNsKDYwLCA2MCUsIDgzLjUyOTQxMTc2NDclKSIsInRlcnRpYXJ5Qm9yZGVyQ29sb3IiOiJoc2woODAsIDYwJSwgODYuMjc0NTA5ODAzOSUpIiwicHJpbWFyeVRleHRDb2xvciI6IiMxMzEzMDAiLCJzZWNvbmRhcnlUZXh0Q29sb3IiOiIjMDAwMDIxIiwidGVydGlhcnlUZXh0Q29sb3IiOiJyZ2IoOS41MDAwMDAwMDAxLCA5LjUwMDAwMDAwMDEsIDkuNTAwMDAwMDAwMSkiLCJsaW5lQ29sb3IiOiIjMzMzMzMzIiwidGV4dENvbG9yIjoiIzMzMyIsIm1haW5Ca2ciOiIjRUNFQ0ZGIiwic2Vjb25kQmtnIjoiI2ZmZmZkZSIsImJvcmRlcjEiOiIjOTM3MERCIiwiYm9yZGVyMiI6IiNhYWFhMzMiLCJhcnJvd2hlYWRDb2xvciI6IiMzMzMzMzMiLCJmb250RmFtaWx5IjoiXCJ0cmVidWNoZXQgbXNcIiwgdmVyZGFuYSwgYXJpYWwiLCJmb250U2l6ZSI6IjE2cHgiLCJsYWJlbEJhY2tncm91bmQiOiIjZThlOGU4Iiwibm9kZUJrZyI6IiNFQ0VDRkYiLCJub2RlQm9yZGVyIjoiIzkzNzBEQiIsImNsdXN0ZXJCa2ciOiIjZmZmZmRlIiwiY2x1c3RlckJvcmRlciI6IiNhYWFhMzMiLCJkZWZhdWx0TGlua0NvbG9yIjoiIzMzMzMzMyIsInRpdGxlQ29sb3IiOiIjMzMzIiwiZWRnZUxhYmVsQmFja2dyb3VuZCI6IiNlOGU4ZTgiLCJhY3RvckJvcmRlciI6ImhzbCgyNTkuNjI2MTY4MjI0MywgNTkuNzc2NTM2MzEyOCUsIDg3LjkwMTk2MDc4NDMlKSIsImFjdG9yQmtnIjoiI0VDRUNGRiIsImFjdG9yVGV4dENvbG9yIjoiYmxhY2siLCJhY3RvckxpbmVDb2xvciI6ImdyZXkiLCJzaWduYWxDb2xvciI6IiMzMzMiLCJzaWduYWxUZXh0Q29sb3IiOiIjMzMzIiwibGFiZWxCb3hCa2dDb2xvciI6IiNFQ0VDRkYiLCJsYWJlbEJveEJvcmRlckNvbG9yIjoiaHNsKDI1OS42MjYxNjgyMjQzLCA1OS43NzY1MzYzMTI4JSwgODcuOTAxOTYwNzg0MyUpIiwibGFiZWxUZXh0Q29sb3IiOiJibGFjayIsImxvb3BUZXh0Q29sb3IiOiJibGFjayIsIm5vdGVCb3JkZXJDb2xvciI6IiNhYWFhMzMiLCJub3RlQmtnQ29sb3IiOiIjZmZmNWFkIiwibm90ZVRleHRDb2xvciI6ImJsYWNrIiwiYWN0aXZhdGlvbkJvcmRlckNvbG9yIjoiIzY2NiIsImFjdGl2YXRpb25Ca2dDb2xvciI6IiNmNGY0ZjQiLCJzZXF1ZW5jZU51bWJlckNvbG9yIjoid2hpdGUiLCJzZWN0aW9uQmtnQ29sb3IiOiJyZ2JhKDEwMiwgMTAyLCAyNTUsIDAuNDkpIiwiYWx0U2VjdGlvbkJrZ0NvbG9yIjoid2hpdGUiLCJzZWN0aW9uQmtnQ29sb3IyIjoiI2ZmZjQwMCIsInRhc2tCb3JkZXJDb2xvciI6IiM1MzRmYmMiLCJ0YXNrQmtnQ29sb3IiOiIjOGE5MGRkIiwidGFza1RleHRMaWdodENvbG9yIjoid2hpdGUiLCJ0YXNrVGV4dENvbG9yIjoid2hpdGUiLCJ0YXNrVGV4dERhcmtDb2xvciI6ImJsYWNrIiwidGFza1RleHRPdXRzaWRlQ29sb3IiOiJibGFjayIsInRhc2tUZXh0Q2xpY2thYmxlQ29sb3IiOiIjMDAzMTYzIiwiYWN0aXZlVGFza0JvcmRlckNvbG9yIjoiIzUzNGZiYyIsImFjdGl2ZVRhc2tCa2dDb2xvciI6IiNiZmM3ZmYiLCJncmlkQ29sb3IiOiJsaWdodGdyZXkiLCJkb25lVGFza0JrZ0NvbG9yIjoibGlnaHRncmV5IiwiZG9uZVRhc2tCb3JkZXJDb2xvciI6ImdyZXkiLCJjcml0Qm9yZGVyQ29sb3IiOiIjZmY4ODg4IiwiY3JpdEJrZ0NvbG9yIjoicmVkIiwidG9kYXlMaW5lQ29sb3IiOiJyZWQiLCJsYWJlbENvbG9yIjoiYmxhY2siLCJlcnJvckJrZ0NvbG9yIjoiIzU1MjIyMiIsImVycm9yVGV4dENvbG9yIjoiIzU1MjIyMiIsImNsYXNzVGV4dCI6IiMxMzEzMDAiLCJmaWxsVHlwZTAiOiIjRUNFQ0ZGIiwiZmlsbFR5cGUxIjoiI2ZmZmZkZSIsImZpbGxUeXBlMiI6ImhzbCgzMDQsIDEwMCUsIDk2LjI3NDUwOTgwMzklKSIsImZpbGxUeXBlMyI6ImhzbCgxMjQsIDEwMCUsIDkzLjUyOTQxMTc2NDclKSIsImZpbGxUeXBlNCI6ImhzbCgxNzYsIDEwMCUsIDk2LjI3NDUwOTgwMzklKSIsImZpbGxUeXBlNSI6ImhzbCgtNCwgMTAwJSwgOTMuNTI5NDExNzY0NyUpIiwiZmlsbFR5cGU2IjoiaHNsKDgsIDEwMCUsIDk2LjI3NDUwOTgwMzklKSIsImZpbGxUeXBlNyI6ImhzbCgxODgsIDEwMCUsIDkzLjUyOTQxMTc2NDclKSJ9fSwidXBkYXRlRWRpdG9yIjpmYWxzZX0\")
\n\n\n\n","event":[{"listen":"prerequest","script":{"id":"d54c52cd-1399-4392-82d2-454841d2cfe6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ed472b06-105a-46d2-a368-72a8dfa23ca8","type":"text/javascript","exec":[""]}}],"_postman_id":"eb0ec364-ff4b-405e-97cc-06e46f64394f"},{"name":"Sales Hero","item":[{"name":"Get API Token","event":[{"listen":"test","script":{"id":"8516c3da-50fa-4533-86bf-00c1d4114ffd","exec":["pm.test('get token', () => {\r"," const data = pm.response.json();\r"," pm.collectionVariables.set(\"ai-stage-token\", data.token);\r","});\r",""],"type":"text/javascript"}}],"id":"295af262-5660-4817-9b8d-8e68fd4d3ad0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOjEsImF1dGhIYXNoIjoiZDg5ZjAxYTFiZDRlZWFmMmIzM2ZhNThhZDZlNTA2MDAyOTE3MDc0OTg2ZDk4ZGNjYzI1NGU4N2IwMzlkMjQ1ZjUyM2MzNGQxZjNhOGYxZjUwZjg5OGJjMTg0YTFmYzhiYzAzMTVjYzg4ZGVlMDVlMWNhNDg4N2JlZDRmMjU0MzciLCJpYXQiOjE2NjM1ODExMzgsImV4cCI6MTY2MzU4MjkzOH0.S83PLB3iSHtog8rEV1IfszONR9urobyALK9GI2cVXrU"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": \"pbx-staging\",\n \"key\": \"pbx-staging-key\"\n}\n"},"url":"{{ai-stage-domain}}/api/v1/auth/login","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"5b340925-391f-4ee1-ae03-ec5f2db45f76","id":"5b340925-391f-4ee1-ae03-ec5f2db45f76","name":"Sales Hero","type":"folder"}},"urlObject":{"path":["api","v1","auth","login"],"host":["{{ai-stage-domain}}"],"query":[],"variable":[]}},"response":[{"id":"38da310d-9f3d-498a-8ddf-904c583dcc65","name":"Get API Token","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOjEsImF1dGhIYXNoIjoiZDg5ZjAxYTFiZDRlZWFmMmIzM2ZhNThhZDZlNTA2MDAyOTE3MDc0OTg2ZDk4ZGNjYzI1NGU4N2IwMzlkMjQ1ZjUyM2MzNGQxZjNhOGYxZjUwZjg5OGJjMTg0YTFmYzhiYzAzMTVjYzg4ZGVlMDVlMWNhNDg4N2JlZDRmMjU0MzciLCJpYXQiOjE2NjM1ODExMzgsImV4cCI6MTY2MzU4MjkzOH0.S83PLB3iSHtog8rEV1IfszONR9urobyALK9GI2cVXrU"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\": \"pbx-staging\",\n \"key\": \"pbx-staging-key\"\n}\n"},"url":"https://ai.stage.impactechs.io/api/v1/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Content-Length","value":"345"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Date","value":"Wed, 26 Oct 2022 13:51:21 GMT"},{"key":"Server","value":"gunicorn"}],"cookie":[],"responseTime":null,"body":"{\"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOjEsImF1dGhIYXNoIjoiODllZDI3MGZkOTY2N2MxMTYzYzBkYTM2MWY3MDVlYWQwODAzMjcyYmE5MzNiZmJkNGExZGJiOThkYTRjODJkOGE0ZTgwMWRhOWE4M2IyNjczMDU0ZjE4MDhjZTgyZWZhNmZjMjg3MjJmMGU4YjY3NzdjZDM4MmY0MzQ3YmUzYjgiLCJpYXQiOjE2NjY3OTIyODEsImV4cCI6MTY2Njc5NDA4MX0.2Hebn3auPJ7t2cXbI2DCCZpAGBN152Rt-y9HgZVHuXM\"}"}],"_postman_id":"295af262-5660-4817-9b8d-8e68fd4d3ad0"},{"name":"Webhook","id":"9c4aaba5-e975-4596-8285-759879a0ce82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer "},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://webhook.site/8e5c7746-fdf1-4993-9a9e-1af466747775\"\n}\n"},"url":"https://ai.stage.impactechs.io/api/v1/hook","description":"Please keep in mind that if the permission \"Services - Full IB Report\" is assigned to the role of the user, he/she will have access to the whole database and not only to leads / customers that he/she created.
\n
With this API you can setup an external url, where you want to receive a notification for any completed Sales Hero tasks.
\nStartFragment
\nTo use this API call, an API key is required.
\nEndFragment
\nThere are two types of notifications
\nThe notification includes the following parameters.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"5b340925-391f-4ee1-ae03-ec5f2db45f76","id":"5b340925-391f-4ee1-ae03-ec5f2db45f76","name":"Sales Hero","type":"folder"}},"urlObject":{"path":["hook"],"host":["https://ai.stage.impactechs.io/api/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c4aaba5-e975-4596-8285-759879a0ce82"},{"name":"Task","id":"3b0ef2a0-384c-47b6-8a31-5dc597a081ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"path\": \"cli/083b1ed3-3db0-4d39-a38c-522d4d77d884.wav\",\r\n \"language_code\": \"en-us\",\r\n \"available_languages\": [\"en-us\"],\r\n \"channels\":[\r\n {\"type\": \"agent\"},\r\n {\"type\": \"customer\"}\r\n ]\r\n}\r\n\r\n","options":{"raw":{"language":"json"}}},"url":"{{ai-stage-domain}}/api/v1/asr/task","description":"With this API you can send a new transcription request for an existing audio file.
\nREQUIREMENTS
\nTo use this API call, an API key is requred
\nREQUEST PARAMETERS
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"5b340925-391f-4ee1-ae03-ec5f2db45f76","id":"5b340925-391f-4ee1-ae03-ec5f2db45f76","name":"Sales Hero","type":"folder"}},"urlObject":{"path":["api","v1","asr","task"],"host":["{{ai-stage-domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3b0ef2a0-384c-47b6-8a31-5dc597a081ec"},{"name":"Compliance","id":"38f503c3-923e-45f4-8527-0a591f835f95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{ai-token}}"}],"url":"{{ai-stage-domain}}/api/v1/compliance/:taskid","description":"With this API you can get the results for a completed task.
\nTo use this API call, an API key is required.
\nThe response parameters are:
\nThe compliance data parameters are:
\nThe dialog_data parameters are:
\nThe dialog_turs data parameters are:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"5b340925-391f-4ee1-ae03-ec5f2db45f76","id":"5b340925-391f-4ee1-ae03-ec5f2db45f76","name":"Sales Hero","type":"folder"}},"urlObject":{"path":["api","v1","compliance",":taskid"],"host":["{{ai-stage-domain}}"],"query":[],"variable":[{"description":{"content":"Target asr transcription to retrieve
\n","type":"text/plain"},"type":"any","value":"36942","key":"taskid"}]}},"response":[{"id":"9e636492-9bad-4750-9d5c-c1fe3145b456","name":"Compliance","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{ai-token}}"}],"url":{"raw":"{{ai-stage-domain}}/api/v1/compliance/:taskid","host":["{{ai-stage-domain}}"],"path":["api","v1","compliance",":taskid"],"variable":[{"key":"taskid","value":"36942","description":"Target asr transcription to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"3105"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 27 Oct 2022 06:59:30 GMT"},{"key":"Server","value":"gunicorn"}],"cookie":[],"responseTime":null,"body":"{\n \"blob\": \"recordings\",\n \"call_duration\": 2,\n \"cdr_uuid\": null,\n \"channels\": [\n {\n \"type\": \"agent\"\n },\n {\n \"type\": \"agent\"\n }\n ],\n \"compliance\": {\n \"explanation\": {\n \"text\": \"This call is not APPROVED. The agent did one of the following: exercised pressure on the customer, made an unwarranted claim or used a bad word. It is also possible that the agent did not start with greeting or a formal introduction and that the total talk to listen is too high. The agent should listen more and speak less!\"\n },\n \"inference\": {\n \"compliant_call\": false,\n \"send_sms_notification\": false\n },\n \"scores_l1\": {\n \"talk_to_listen_above_60\": 1\n },\n \"scores_l2\": {\n \"compliant_call\": 0,\n \"send_sms_notification\": 0\n },\n \"tags\": [\n \"talk_to_listen_above_60\"\n ]\n },\n \"dialog_data\": {\n \"agent_aggregation\": {\n \"sentiment\": {\n \"negative\": 0,\n \"neutral\": 1,\n \"positive\": 0\n },\n \"tags\": [],\n \"top_sentiment\": \"neutral\"\n },\n \"customer_aggregation\": {\n \"sentiment\": {\n \"negative\": 0,\n \"neutral\": 0,\n \"positive\": 0\n },\n \"tags\": [],\n \"top_sentiment\": \"positive\"\n },\n \"dialog_turns\": [\n {\n \"asr_confidence\": 1,\n \"dialog_turn_index\": 1,\n \"end_time_sec\": 1.159999966621399,\n \"original_text\": \"\",\n \"rules\": [],\n \"sentiment\": {\n \"confidence\": {\n \"negative\": 0.1473929226398468,\n \"neutral\": 0.9290712594985961,\n \"positive\": -0.07646420449018479\n },\n \"label\": \"neutral\"\n },\n \"speaker\": \"agent\",\n \"speaker_turn_index\": 1,\n \"start_time_sec\": 0,\n \"text\": \"[noise]\",\n \"text_lemmas\": \"[\",\n \"words\": [\n {\n \"asr_confidence\": 1,\n \"duration\": 0.029999971389770508,\n \"end_time_sec\": 1.1399999856948853,\n \"ent_type_\": \"\",\n \"entities\": [],\n \"id\": 0,\n \"lemma\": \"[\",\n \"lemma_pos\": \"[_PUNCT\",\n \"sentiment_explanation\": \"neutral\",\n \"simple_rules\": [],\n \"start_index\": 0,\n \"start_time_sec\": 1.1100000143051147,\n \"word\": \"[noise]\"\n }\n ]\n }\n ],\n \"language_code\": \"\",\n \"talk_to_listen\": {\n \"agent_sec\": 1.159999966621399,\n \"customer_sec\": 0,\n \"ratio\": 1\n },\n \"talk_to_listen_per_word\": {\n \"agent_sec\": 0.029999971389770508,\n \"customer_sec\": 0,\n \"ratio\": 1\n }\n },\n \"entities\": {\n \"agent\": [],\n \"customer\": []\n },\n \"features\": {\n \"agent_entities\": {\n \"CARDINAL\": 0,\n \"DATE\": 0,\n \"FAC\": 0,\n \"GPE\": 0,\n \"IMPACT-PROD\": 0,\n \"LANGUAGE\": 0,\n \"LOC\": 0,\n \"MONEY\": 0,\n \"NORP\": 0,\n \"ORDINAL\": 0,\n \"ORG\": 0,\n \"PERCENT\": 0,\n \"PERSON\": 0,\n \"PROD\": 0,\n \"PRODUCT\": 0,\n \"QUANTITY\": 0,\n \"TIME\": 0\n },\n \"agent_is_compliant\": 0,\n \"agent_tags\": {\n \"bad_words\": 0,\n \"email_promise\": 0,\n \"exercise_of_pressure\": 0,\n \"formal_introduction\": 0,\n \"greetings\": 0,\n \"leverage\": 0,\n \"manager_request\": 0,\n \"reason_to_call\": 0,\n \"unwarranted_claim\": 0\n },\n \"agent_top_sentiment\": {\n \"negative\": 0,\n \"neutral\": 1,\n \"positive\": 0\n },\n \"call_duration\": 1.159999966621399,\n \"customer_entities\": {\n \"CARDINAL\": 0,\n \"DATE\": 0,\n \"FAC\": 0,\n \"GPE\": 0,\n \"IMPACT-PROD\": 0,\n \"LANGUAGE\": 0,\n \"LOC\": 0,\n \"MONEY\": 0,\n \"NORP\": 0,\n \"ORDINAL\": 0,\n \"ORG\": 0,\n \"PERCENT\": 0,\n \"PERSON\": 0,\n \"PROD\": 0,\n \"PRODUCT\": 0,\n \"QUANTITY\": 0,\n \"TIME\": 0\n },\n \"customer_tags\": {\n \"bad_words\": 0,\n \"email_promise\": 0,\n \"exercise_of_pressure\": 0,\n \"formal_introduction\": 0,\n \"greetings\": 0,\n \"leverage\": 0,\n \"manager_request\": 0,\n \"reason_to_call\": 0,\n \"unwarranted_claim\": 0\n },\n \"customer_top_sentiment\": {\n \"negative\": 0,\n \"neutral\": 0,\n \"positive\": 1\n },\n \"language\": {\n \"en-us\": 1\n },\n \"talk_to_listen\": 1,\n \"talk_to_listen_per_word\": 1\n },\n \"id\": 36942,\n \"language_code\": \"en-us\",\n \"language_codes\": null,\n \"modelID\": 1,\n \"notification_phone\": null,\n \"path\": \"dev0-pbx.impactpbx.com/4302faee-2477-48ed-9d3e-adf75a54cdc6.wav\",\n \"pbx_retry\": 0,\n \"pbx_status\": \"NEW\",\n \"reason\": \"\",\n \"status\": \"DONE\",\n \"transfer_id\": null,\n \"user_id\": 1\n}"}],"_postman_id":"38f503c3-923e-45f4-8527-0a591f835f95"}],"id":"5b340925-391f-4ee1-ae03-ec5f2db45f76","description":"This is the Sales Hero API documentation. With this API you can:
\n![](\"https://mermaid.ink/img/pako:eNpFj8sKgzAQRX8lzFp_IIuCDyjdFWrpwriYmrGKJhFNFsX4741NobOaORwuczdojSTg8Fpw7llVCs3CZPWZLMuuF1aZkXTD0vTk7yv9kWd5VPP6Qc_emPErsSLSoq5wjcgfUTZcbJD-l1_WhVHzNKBuqYkIElC0KBxk-GY7mADbkyIBPKySOnSTFSD0HlR01tzeugVuF0cJuFmipXLA0EMB73Baaf8APRxF7Q?type=png\")
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"869701f2-6dcd-4346-b04f-05d615098576","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2887d356-021d-4c32-a05e-f4f137309e47","type":"text/javascript","exec":[""]}}],"_postman_id":"5b340925-391f-4ee1-ae03-ec5f2db45f76"},{"name":"Finexware Integration","item":[{"name":"Account data","id":"aee91332-678b-4cc5-bef4-30c4bcf22ff8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Date","value":"Tue, 26 Sep 2017 23:56:00 GMT"},{"key":"X-Api-Key","value":"{{apiKey}}"},{"key":"X-Auth-Token","value":"{{token}}"},{"key":"X-Domain","type":"text","value":"{{xDomain}}"}],"url":"{{domain}}/finexware-accounts/1/10520","description":"This API is responsible for getting information about selected account.
\nAPI Key: To use this API call, an API Key is required.
\nFinexware integration permission: The user who has the API key assigned on him has to have the aforementioned permission
\n\n\nPlease keep in mind that if the permission \"Services - Finexware integration\" is assigned to the role of the user, he/she will have access to all servers and not only to the servers associated with the leads / customers that he/she created.
\n
/finexware-accounts/{{portalId}/{{platformLogin}}
\nNote: For Finexware integration, additional IP Whitelisting is required under Portal Settings.
\n","event":[{"listen":"prerequest","script":{"id":"d54c52cd-1399-4392-82d2-454841d2cfe6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ed472b06-105a-46d2-a368-72a8dfa23ca8","type":"text/javascript","exec":[""]}}],"_postman_id":"16bd73d0-b569-4476-a810-f6a27f5f62c0"}],"event":[{"listen":"prerequest","script":{"id":"51ec8df4-4bbf-439d-ab3a-ce4f175a5ef5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bbfb76f3-59a8-40bd-8da5-7dc36748532f","type":"text/javascript","exec":[""]}}],"variable":[{"key":"ai-domain","value":"https://ai.stage.impactechs.io/api/v1"},{"key":"ai-stage-token","value":""}]}