{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","description":"**Introduction**  \nThe ManageMy platform, and its APIs, is designed to facilitate easy integration with insurance administration platforms and other technology partners. The APIs exchange data using JSON data formats as well as supporting the transfer of digital files.  \nIn order to support the flexibility required to integrate with an extensive range of insurance administration systems, insurance product types and insurer-specific product configurations, the ManageMy platform consists of flexible database fields which are grouped in to JSON forms to effectively, quickly and securely receive and map insurer data to the ManageMy platform. Each field can be identified through its unique identifier referred to as a “Public ID”, or its field name (which is mapped to that Public ID).\n\n**Authorisation**  \nAll the ManageMy API end points use API key authorisation. A key-value pair is sent to the API in the request header. Access to individual end points can be restricted by using separate API keys, if required.\n\n**Database Fields**  \nThe ManageMy platform and its underlying data model, is very flexible and highly configurable, and as such can support the configuration of any insurance product and its underlying data. This involves using a mix of “default” fields and “custom” fields. Each field can be interacted with via its public ID or its field name, as both are unique. When a database field is created it has a particular data type to be able to accommodate a range of values These data types are: strings, integers, dates, dates and times.\n\n**Key-Value Pairs**\n\nThe ManageMy platform also supports data transmission through key-value pairs, where field names are used as keys. This method is often preferred by our Integration Partners, as it provides greater clarity in API calls by directly indicating what each value represents, eliminating the need to reference Public ID Data maps.\n\nAs a JSON this is expressed as:\n\n``` json\n{\n    \"entityFieldValuesModels\": [\n        {\n            \"commandName\": \"ExternalApiCreate\",\n            \"values\": {\n                \"InsurerCustomerReference\": \"CUST001\",\n                \"FirstName\": \"John\",\n                \"LastName\": \"Doe\",\n                \"DateOfBirth\": \"19850105\",\n                \"ZipCode\": \"30006\",\n                \"PhoneNumber\": \"+44777777777\",\n                \"PhoneNumberCountry\": \"us\",\n                \"Email\": \"noreply@managemy.com\"\n            }\n        }\n    ]\n}\n\n ```\n\n**Dynamic JSON Forms**  \nAt each point data is interacted with, it is done so via a JSON form. Our Dynamic JSON Forms are a highly flexible and configurable collection of database fields and all the related validations and conditions. When data is passed via an API, the individual data items are mapped to fields contained within the JSON form.\n\n**Repeatable Groups of Data**\n\nIt is possible to provide groups of data fields that can be repeated within the data model — for example, multiple coverages on a policy, or multiple addresses for a customer. This lets the same field name (e.g. `AddressLine1`) be reused across each repeated entry instead of needing separate fields per entry.\n\nWhen using the `values` key-value format (see **Key-Value Pairs** above — this is the recommended format for new integrations), a repeatable group is simply a **JSON array of objects** nested under the group's field name. Each object in the array is one repetition. There is no separate index or group-name property to set — the position in the array _is_ the index, and it's assigned automatically.\n\nAs a JSON this is expressed as:\n\n``` json\n{\n    \"entityFieldValuesModels\": [\n        {\n            \"commandName\": \"ExternalApiCreate\",\n            \"values\": {\n                \"InsurerCustomerReference\": \"CUST001\",\n                \"FirstName\": \"John\",\n                \"LastName\": \"Doe\",\n                \"CustomerAddresses\": [\n                    {\n                        \"AddressType\": \"Home\",\n                        \"AddressLine1\": \"123 Fake Street\"\n                    },\n                    {\n                        \"AddressType\": \"Business\",\n                        \"AddressLine1\": \"456 Park Avenue\"\n                    }\n                ]\n            }\n        }\n    ]\n}\n\n ```\n\nEach entry in the `CustomerAddresses` array becomes one repeated group entry — no `groupIndex` or `groupFieldName` needed.\n\nA group that only ever has a single entry can also be sent as a plain nested object instead of a one-item array (you'll see this in several examples elsewhere in this collection, e.g. `PolicyholdersGroup`) — both forms are accepted.\n\n**Updating Repeatable Groups**\n\nTo update repeatable group data, resend the array with the values you want — the platform matches array position to existing entries in the order they were created. Send only the entries you want to keep/update; omitting an entry from the array removes it, and adding more entries than currently exist adds new ones.\n\n``` json\n{\n    \"CustomerAddresses\": [\n        { \"AddressType\": \"Home\", \"AddressLine1\": \"123 Main Street\" },\n        { \"AddressType\": \"Business\", \"AddressLine1\": \"456 Park Avenue\" }\n    ]\n}\n\n ```\n\n**Removing Data from a Repeatable Group**\n\nTo remove one entry from a group, resend the array without it — for example, to drop the second address above, send only the first:\n\n``` json\n{\n    \"CustomerAddresses\": [\n        { \"AddressType\": \"Home\", \"AddressLine1\": \"123 Main Street\" }\n    ]\n}\n\n ```\n\nTo remove all entries from a group, send an empty array:\n\n``` json\n{\n    \"CustomerAddresses\": []\n}\n\n ```\n\n**Nested Repeatable Groups**\n\nGroups can be nested within other groups (up to 3 levels) by nesting arrays inside the objects of an outer array — for example, a policy's Coverages, each with its own Beneficiaries, each with their own Addresses:\n\n``` json\n{\n    \"Coverages\": [\n        {\n            \"CoverageType\": \"Term Life\",\n            \"CoverageAmount\": \"100000\",\n            \"Beneficiaries\": [\n                {\n                    \"BeneficiaryFullName\": \"John Smith\",\n                    \"BeneficiaryAddresses\": [\n                        { \"AddressType\": \"Residence\", \"AddressLine1\": \"123 Main Street\" }\n                    ]\n                },\n                {\n                    \"BeneficiaryFullName\": \"Jane Smith\",\n                    \"BeneficiaryAddresses\": [\n                        { \"AddressType\": \"Residence\", \"AddressLine1\": \"21 Church Lane\" },\n                        { \"AddressType\": \"Holiday\", \"AddressLine1\": \"14 Lake View\" }\n                    ]\n                }\n            ]\n        },\n        {\n            \"CoverageType\": \"Critical Illness\",\n            \"CoverageAmount\": \"75000\",\n            \"Beneficiaries\": []\n        }\n    ]\n}\n\n ```\n\nAs with a single-level group, updating or removing a nested entry is done by resending the parent array with the entries you want to keep, in the order you want them — the same \"array position = identity\" rule applies at every level.\n\n\\*(Note: the API also still accepts the older flat `fieldValues` array format — `[{\"publicId\" or \"name\": ..., \"value\": ..., \"groupFieldName\": ..., \"groupIndex\": ...}]` — where the client sets `groupIndex` explicitly. This remains supported for backwards compatibility, but the `values` array format above is simpler and is what this collection's examples use throughout.)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"10911710","team":1406864,"collectionId":"ddd9a1b6-5e6d-4432-979a-edebe0862529","publishedId":"2sBYArVCuL","public":true,"publicUrl":"https://api.managemy.com","privateUrl":"https://go.postman.co/documentation/10911710-ddd9a1b6-5e6d-4432-979a-edebe0862529","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.6","publishDate":"2026-08-21T08:35:44.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"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/1b55080d3ee59f4534b121e5f294fd723eba487bb78fc1182410c3431966064c","favicon":"https://res.cloudinary.com/postman/image/upload/v1625818215/team/gnpqnt3ojvxx4cbsc9jz.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://api.managemy.com/view/metadata/2sBYArVCuL"}