{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a4229405-f2ff-4426-9655-4dcbb9160a57","name":"EZLynxAPI","description":"The EZLynxAPI is primarily used to create and update applicants, contacts, prospects and opportunities. It's also used to create policy headers and get email templates, documents, user data and quote results.\n\nAs your organization uses EZLynx, events are generated that can optionally be consumed to provide additional functionality to your users. These events can be received in XML or JSON format and contain information about data which has changed in the platform.\n\n## Receiving events\n\nYou will configure a webhook url that will receive XML/json payloads. We will store the url for this webhook as part of your configuration during account setup. At setup, you will also tell us which events you'd like to receive. Available events are:\n\n- ApplicantCreated\n    \n- ApplicantQuoteCompleted\n    \n- CarrierQuoteCompleted\n    \n- DynamicPromptsRequired\n    \n- PolicyCreated\n    \n- PolicyUpdated\n    \n- CommissionStatementDownloaded\n    \n- PolicyDownloaded\n    \n- ApplicantUpdated\n    \n- ApplicantDeleted\n    \n- OpportunityCreated\n    \n- OpportunityUpdated\n    \n- ProspectCreated\n    \n- ProspectUpdated\n    \n- CoApplicantCreated\n    \n- CoApplicantUpdated\n    \n- PolicyDeleted\n    \n- DocumentCreated\n    \n- DocumentUpdated\n    \n- DocumentDeleted\n    \n- DiscussionCreated\n    \n- DiscussionUpdated\n    \n- DiscussionLastModifiedUpdated\n    \n- OrganizationCreated\n    \n- OrganizationUpdated\n    \n- OrganizationDeleted\n    \n- UserCreated\n    \n- UserUpdated\n    \n- UserDeleted\n    \n- CarrierCreated\n    \n- CarrierUpdated\n    \n- ExternalQuoteSubmissionUpdated\n    \n\n### **Example payload:**\n\n#### **PolicyUpdated**\n\n```\n<?xml version=\"1.0\"?><EventCallbackNotification xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n  <Name>PolicyUpdated</Name>\n  <Entity>Policy</Entity>\n  <EntityId>xy81dmaEfZIIGlkUaBbQ-ARyi8WhvqssUzPklbQe0XE1</EntityId>\n  <AppSecret>NtOYUeF_GCbJpDQCKOHUduV5imVeqaX9GWBcsSNH-4I1</AppSecret>\n  <EventData /></EventCallbackNotification>\n\n ```\n\n#### **PolicyCreated**\n\n```\n<?xml version=\"1.0\"?><EventCallbackNotification xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n  <Name>PolicyCreated</Name>\n  <Entity>Policy</Entity>\n  <EntityId>7MbDI-8IAMQarWLgM-V4MARyi8WhvqssUzPklbQe0XE1</EntityId>\n  <AppSecret>NtOYUeF_GCbJpDQCKOHUduV5imVeqaX9GWBcsSNH-4I1</AppSecret>\n  <EventData /></EventCallbackNotification>\n\n ```\n\n#### **ApplicantUpdated**\n\n```\n <?xml version=\"1.0\"?><EventCallbackNotification xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n  <Name>ApplicantUpdated</Name>\n  <Entity>Applicant</Entity>\n  <EntityId>Ra-3JqoXUymDrBgT-I3jjXzOTGC2Qicrbn41msTa7T81</EntityId>\n  <AppSecret>NtOYUeF_GCbJpDQCKOHUduV5imVeqaX9GWBcsSNH-4I1</AppSecret>\n  <EventData>\n    <DictionaryEntry>\n      <Key xsi:type=\"xsd:string\">OrganizationID</Key>\n      <Value xsi:type=\"xsd:int\">7449</Value>\n    </DictionaryEntry>\n    <DictionaryEntry>\n      <Key xsi:type=\"xsd:string\">EventCreatedBy</Key>\n      <Value xsi:type=\"xsd:int\">16127</Value>\n    </DictionaryEntry>\n  </EventData></EventCallbackNotification>\n\n ```\n\n#### **ApplicantCreated**\n\n```\n  <?xml version=\"1.0\"?><EventCallbackNotification xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n  <Name>ApplicantCreated</Name>\n  <Entity>Applicant</Entity>\n  <EntityId>Ra-3JqoXUymDrBgT-I3jjXzOTGC2Qicrbn41msTa7T81</EntityId>\n  <AppSecret>NtOYUeF_GCbJpDQCKOHUduV5imVeqaX9GWBcsSNH-4I1</AppSecret>\n  <EventData>\n    <DictionaryEntry>\n      <Key xsi:type=\"xsd:string\">OrganizationID</Key>\n      <Value xsi:type=\"xsd:int\">7449</Value>\n    </DictionaryEntry>\n    <DictionaryEntry>\n      <Key xsi:type=\"xsd:string\">EventCreatedBy</Key>\n      <Value xsi:type=\"xsd:int\">16127</Value>\n    </DictionaryEntry>\n  </EventData></EventCallbackNotification>\n\n ```\n\nNote: The `EntityId` field is an encrypted version of the Ezlynx EntityId (for instance, if this is a PolicyUpdated event, the `EntitiyId` will be a `PolicyId`). You can send this in as the Id in the URL of a request to our web services and it will work as the Id for that entity.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"17108315","team":67297,"collectionId":"a4229405-f2ff-4426-9655-4dcbb9160a57","publishedId":"UVXjHahb","public":true,"publicUrl":"https://documenter-api.postman.tech/view/17108315/UVXjHahb","privateUrl":"https://go.postman.co/documentation/17108315-a4229405-f2ff-4426-9655-4dcbb9160a57","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-01-13T19:47:13.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/453d06c4e167bfbd0f755b406d4006849c00cae95ac131873e96c3e031d6f26d","favicon":""},"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://documenter.gw.postman.com/view/metadata/UVXjHahb"}