{"info":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","description":"

Introduction
The 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.
In 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).

Authorisation
All 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.

Database Fields
The 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.

Key-Value Pairs

The 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.

As a JSON this is expressed as:

{\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

Dynamic JSON Forms
At 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.

Repeatable Groups of Data

It 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.

When 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.

As a JSON this is expressed as:

{\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

Each entry in the CustomerAddresses array becomes one repeated group entry — no groupIndex or groupFieldName needed.

A 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.

Updating Repeatable Groups

To 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    \"CustomerAddresses\": [\n        { \"AddressType\": \"Home\", \"AddressLine1\": \"123 Main Street\" },\n        { \"AddressType\": \"Business\", \"AddressLine1\": \"456 Park Avenue\" }\n    ]\n}\n\n

Removing Data from a Repeatable Group

To remove one entry from a group, resend the array without it — for example, to drop the second address above, send only the first:

{\n    \"CustomerAddresses\": [\n        { \"AddressType\": \"Home\", \"AddressLine1\": \"123 Main Street\" }\n    ]\n}\n\n

To remove all entries from a group, send an empty array:

{\n    \"CustomerAddresses\": []\n}\n\n

Nested Repeatable Groups

Groups 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    \"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

As 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.

*(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.)

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10911710","collectionId":"ddd9a1b6-5e6d-4432-979a-edebe0862529","publishedId":"2sBYArVCuL","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-08-21T08:35:44.000Z"},"item":[{"name":"Onboarding","item":[{"name":"Create Customers","item":[{"name":"Create Customers","id":"440a579c-8741-45a8-97b4-81fe7a4bf63e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"InsurerCustomerReference\": \"Test-009\",\n \"UniqueRegistrationId\": \"\",\n \"PersonTitle\": \"Mr\",\n \"FirstName\": \"John\",\n \"MiddleName\": \"R\",\n \"LastName\": \"Smith\",\n \"DateOfBirth\": \"01/01/1969\",\n \"Address\": \"Apartment 17\",\n \"AddressLine2\": \"1 ManageMy Towers\",\n \"AddressLine3\": \"Square Mile\",\n \"City\": \"London\",\n \"County\": \"Greater London\",\n \"PostCode\": \"E1 1AB\",\n \"Country\": \"GBR\",\n \"PhoneNumber\": \"+44777777777\",\n \"HomePhoneNumber\": \"+441011111111\",\n \"Email\": \"noreply@managemy.com\"\n }\n },\n {\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"InsurerCustomerReference\": \"Test-002\",\n \"UniqueRegistrationId\": \"URI_002\",\n \"PersonTitle\": \"Mrs\",\n \"FirstName\": \"Alice\",\n \"MiddleName\": \"\",\n \"LastName\": \"Jones\",\n \"DateOfBirth\": \"01/01/1969\",\n \"Address\": \"3 Pigeon Street\",\n \"AddressLine2\": \"\",\n \"AddressLine3\": \"\",\n \"City\": \"Leeds\",\n \"County\": \"West Yorkshire\",\n \"PostCode\": \"LS1 1LS\",\n \"Country\": \"GBR\",\n \"PhoneNumber\": \"+447111111111\",\n \"HomePhoneNumber\": \"+441131111111\",\n \"Email\": \"noreply2@managemy.com\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/create/batch","description":"

Creates new customer records, to which policies can be added and messages can be sent.

Multiple customers can be created in a single API call, using the 'entityFieldValueModels' array structure.

A 'commmandName' parameter must be passed within each request in the array.

By default, certain fields will be validated to ensure uniqueness:

InsurerCustomerReference (a8c97a3ce9f74b8ca8228692950f4a7c) - this is the customer's Unique Reference Number (URN) used by the source system, that maps to CustomerPublicId (7ba9f6c52b004c9e89259408d70b1123) on the ManageMy platform.
Email (18973b0de8da498f8e8d02e36f95bf61) - this is the default login username and therefore must be unique.
UniqueRegistrationId (1e4bd4813948408282d2860241636a8c) - this is used to allow customer to register without receiving a unique registration invite - e.g. via direct mail.

NB: where a field value is passed using the \"publicId\" as the field identifier, it is possible to instead use \"name\" and provide the field name to identify the field to be created/updated.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}},"urlObject":{"path":["customer","create","batch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9057ceb5-d12a-4cc9-b2dd-4017f6dabd70","name":"Create New Customer - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"InsurerCustomerReference\": \"Test-001\",\n \"UniqueRegistrationId\": \"URI_001\",\n \"PersonTitle\": \"Mr\",\n \"FirstName\": \"John\",\n \"MiddleName\": \"R\",\n \"LastName\": \"Smith\",\n \"DateOfBirth\": \"01/01/1969\",\n \"Address\": \"Apartment 17\",\n \"AddressLine2\": \"1 ManageMy Towers\",\n \"AddressLine3\": \"Square Mile\",\n \"City\": \"London\",\n \"County\": \"Greater London\",\n \"PostCode\": \"E1 1AB\",\n \"Country\": \"GBR\",\n \"PhoneNumber\": \"+447777777777\",\n \"HomePhoneNumber\": \"+441011111111\",\n \"Email\": \"noreply@managemy.com\"\n }\n },\n {\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"InsurerCustomerReference\": \"Test-002\",\n \"UniqueRegistrationId\": \"URI_002\",\n \"PersonTitle\": \"Mrs\",\n \"FirstName\": \"Alice\",\n \"MiddleName\": \"\",\n \"LastName\": \"Jones\",\n \"DateOfBirth\": \"01/01/1969\",\n \"Address\": \"3 Pigeon Street\",\n \"AddressLine2\": \"\",\n \"AddressLine3\": \"\",\n \"City\": \"Leeds\",\n \"County\": \"West Yorkshire\",\n \"PostCode\": \"LS1 1LS\",\n \"Country\": \"GBR\",\n \"PhoneNumber\": \"+447111111111\",\n \"HomePhoneNumber\": \"+441131111111\",\n \"Email\": \"noreply2@managemy.com\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/create/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 09:09:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"entitiesResult\": [\n {\n \"success\": true,\n \"publicId\": \"3ccbfed78c8a4d9aa1aacb5ad5614219\",\n \"reference\": \"Test-001\"\n },\n {\n \"success\": true,\n \"publicId\": \"07bf438c63704e70b8c0fc64740a2db6\",\n \"reference\": \"Test-002\"\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"4a688f2a-631a-41a9-912a-d9d89b7bb233","name":"Create New Customers - Falied - Data Validation Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"InsurerCustomerReference\": \"Test-101\",\n \"UniqueRegistrationId\": \"URI_101\",\n \"PersonTitle\": \"Mr\",\n \"FirstName\": \"John\",\n \"MiddleName\": \"R\",\n \"LastName\": \"Smith\",\n \"DateOfBirth\": \"01/01/1969\",\n \"Address\": \"Apartment 17\",\n \"AddressLine2\": \"1 ManageMy Towers\",\n \"AddressLine3\": \"Square Mile\",\n \"City\": \"London\",\n \"County\": \"Greater London\",\n \"PostCode\": \"E1 1AB\",\n \"Country\": \"UK\",\n \"PhoneNumber\": \"+447777777777\",\n \"HomePhoneNumber\": \"+441011111111\",\n \"Email\": \"noreply@managemy.com\"\n }\n },\n {\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"InsurerCustomerReference\": \"Test-102\",\n \"UniqueRegistrationId\": \"URI_102\",\n \"PersonTitle\": \"Mrs\",\n \"FirstName\": \"Alice\",\n \"MiddleName\": \"\",\n \"LastName\": \"Jones\",\n \"DateOfBirth\": \"01/01/1969\",\n \"Address\": \"3 Pigeon Street\",\n \"AddressLine2\": \"\",\n \"AddressLine3\": \"\",\n \"City\": \"Leeds\",\n \"County\": \"West Yorkshire\",\n \"PostCode\": \"LS1 1LS\",\n \"Country\": \"UK\",\n \"PhoneNumber\": \"+447111111111\",\n \"HomePhoneNumber\": \"+441131111111\",\n \"Email\": \"noreply2@managemy.com\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/create/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 09:28:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"entitiesResult\": [\n {\n \"success\": false,\n \"reference\": \"Test-101\",\n \"errorMessage\": \"Validation Error\",\n \"validationErrors\": [\n {\n \"publicId\": \"a7198856e43941dc900285a9ca4fb2f0\",\n \"field\": \"Country\",\n \"message\": \"Value should be in GBR,USA,FRA,DEU,POL,ZAF,AFG,ALB,DZA,ASM,AND,AGO,AIA,ATA,ATG,ARG,ARM,ABW,AUS,AUT,AZE,BHS,BHR,BGD,BRB,BLR,BEL,BLZ,BEN,BMU,BTN,BOL,BIH,BWA,BVT,BRA,IOT,BRN,BGR,BFA,MMR,BDI,KHM,CMR,CAN,CPV,CYM,CAF,TCD,CHL,CHN,CXR,CCK,COL,COM,COG,COD,COK,CRI,HRV,CUB,CYP,CZE,DNK,DJI,DMA,DOM,ECU,EGY,SLV,GNQ,ERI,EST,ETH,FLK,FRO,FJI,FIN,GUF,PYF,ATF,GAB,GMB,GEO,GHA,GIB,GRC,GRL,GRD,GLP,GUM,GTM,GGY,GIN,GNB,GUY,HTI,HMD,VAT,HND,HKG,HUN,ISL,IND,IDN,IRN,IRQ,IRL,IMN,ISR,ITA,CIV,JAM,JPN,JEY,JOR,KAZ,KEN,KIR,PRK,KWT,KGZ,LAO,LVA,LBN,LSO,LBR,LBY,LIE,LTU,LUX,MAC,MKD,MDG,MWI,MYS,MDV,MLI,MLT,MHL,MTQ,MRT,MUS,MYT,MEX,FSM,MDA,MCO,MNG,MNE,MSR,MAR,MOZ,NAM,NRU,NPL,NLD,ANT,NCL,NZL,NIC,NER,NGA,NIU,NFK,MNP,NOR,OMN,PAK,PLW,PSE,PAN,PNG,PRY,PER,PHL,PCN,PRT,PRI,QAT,REU,ROU,RUS,RWA,SHN,KNA,LCA,SPM,WSM,SMR,STP,SAU,SEN,SRB,SYC,SLE,SGP,SVK,SVN,SLB,SOM,SGS,KOR,ESP,LKA,VCT,SDN,SUR,SJM,SWZ,SWE,CHE,SYR,TWN,TJK,TZA,THA,TLS,TGO,TKL,TON,TTO,TUN,TUR,TKM,TCA,TUV,UGA,UKR,ARE,UMI,URY,UZB,VUT,VEN,VNM,VGB,VIR,WLF,ESH,YEM,ZMB,ZWE\"\n }\n ]\n },\n {\n \"success\": false,\n \"reference\": \"Test-102\",\n \"errorMessage\": \"Validation Error\",\n \"validationErrors\": [\n {\n \"publicId\": \"a7198856e43941dc900285a9ca4fb2f0\",\n \"field\": \"Country\",\n \"message\": \"Value should be in GBR,USA,FRA,DEU,POL,ZAF,AFG,ALB,DZA,ASM,AND,AGO,AIA,ATA,ATG,ARG,ARM,ABW,AUS,AUT,AZE,BHS,BHR,BGD,BRB,BLR,BEL,BLZ,BEN,BMU,BTN,BOL,BIH,BWA,BVT,BRA,IOT,BRN,BGR,BFA,MMR,BDI,KHM,CMR,CAN,CPV,CYM,CAF,TCD,CHL,CHN,CXR,CCK,COL,COM,COG,COD,COK,CRI,HRV,CUB,CYP,CZE,DNK,DJI,DMA,DOM,ECU,EGY,SLV,GNQ,ERI,EST,ETH,FLK,FRO,FJI,FIN,GUF,PYF,ATF,GAB,GMB,GEO,GHA,GIB,GRC,GRL,GRD,GLP,GUM,GTM,GGY,GIN,GNB,GUY,HTI,HMD,VAT,HND,HKG,HUN,ISL,IND,IDN,IRN,IRQ,IRL,IMN,ISR,ITA,CIV,JAM,JPN,JEY,JOR,KAZ,KEN,KIR,PRK,KWT,KGZ,LAO,LVA,LBN,LSO,LBR,LBY,LIE,LTU,LUX,MAC,MKD,MDG,MWI,MYS,MDV,MLI,MLT,MHL,MTQ,MRT,MUS,MYT,MEX,FSM,MDA,MCO,MNG,MNE,MSR,MAR,MOZ,NAM,NRU,NPL,NLD,ANT,NCL,NZL,NIC,NER,NGA,NIU,NFK,MNP,NOR,OMN,PAK,PLW,PSE,PAN,PNG,PRY,PER,PHL,PCN,PRT,PRI,QAT,REU,ROU,RUS,RWA,SHN,KNA,LCA,SPM,WSM,SMR,STP,SAU,SEN,SRB,SYC,SLE,SGP,SVK,SVN,SLB,SOM,SGS,KOR,ESP,LKA,VCT,SDN,SUR,SJM,SWZ,SWE,CHE,SYR,TWN,TJK,TZA,THA,TLS,TGO,TKL,TON,TTO,TUN,TUR,TKM,TCA,TUV,UGA,UKR,ARE,UMI,URY,UZB,VUT,VEN,VNM,VGB,VIR,WLF,ESH,YEM,ZMB,ZWE\"\n }\n ]\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"db973c57-4e1f-4710-9a92-47dcb7691e1f","name":"Create New Customer - Failed - Uniqueness Validation Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"InsurerCustomerReference\": \"Test-001\",\n \"UniqueRegistrationId\": \"URI_001\",\n \"PersonTitle\": \"Mr\",\n \"FirstName\": \"John\",\n \"MiddleName\": \"R\",\n \"LastName\": \"Smith\",\n \"DateOfBirth\": \"01/01/1969\",\n \"Address\": \"Apartment 17\",\n \"AddressLine2\": \"1 ManageMy Towers\",\n \"AddressLine3\": \"Square Mile\",\n \"City\": \"London\",\n \"County\": \"Greater London\",\n \"PostCode\": \"E1 1AB\",\n \"Country\": \"GBR\",\n \"PhoneNumber\": \"+447777777777\",\n \"HomePhoneNumber\": \"+441011111111\",\n \"Email\": \"noreply@managemy.com\"\n }\n },\n {\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"InsurerCustomerReference\": \"Test-002\",\n \"UniqueRegistrationId\": \"URI_002\",\n \"PersonTitle\": \"Mrs\",\n \"FirstName\": \"Alice\",\n \"MiddleName\": \"\",\n \"LastName\": \"Jones\",\n \"DateOfBirth\": \"01/01/1969\",\n \"Address\": \"3 Pigeon Street\",\n \"AddressLine2\": \"\",\n \"AddressLine3\": \"\",\n \"City\": \"Leeds\",\n \"County\": \"West Yorkshire\",\n \"PostCode\": \"LS1 1LS\",\n \"Country\": \"GBR\",\n \"PhoneNumber\": \"+447111111111\",\n \"HomePhoneNumber\": \"+441131111111\",\n \"Email\": \"noreply2@managemy.com\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/create/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 09:10:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"entitiesResult\": [\n {\n \"success\": false,\n \"reference\": \"Test-001\",\n \"errorMessage\": \"Validation Error\",\n \"validationErrors\": [\n {\n \"publicId\": \"1e4bd4813948408282d2860241636a8c\",\n \"field\": \"UniqueRegistrationId\",\n \"message\": \"This UniqueRegistrationId has already been used for a different customer - please use a different UniqueRegistrationId.\"\n }\n ]\n },\n {\n \"success\": false,\n \"reference\": \"Test-002\",\n \"errorMessage\": \"Validation Error\",\n \"validationErrors\": [\n {\n \"field\": \"UniqueRegistrationId\",\n \"message\": \"This UniqueRegistrationId has already been used for a different customer - please use a different UniqueRegistrationId.\"\n }\n ]\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"16abe909-66d5-4054-b8cb-e938617cd408","name":"Create New Customer - Failed - Unique Email Validation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"InsurerCustomerReference\": \"Test-001\",\n \"UniqueRegistrationId\": \"URI_001\",\n \"PersonTitle\": \"Mr\",\n \"FirstName\": \"John\",\n \"MiddleName\": \"R\",\n \"LastName\": \"Smith\",\n \"DateOfBirth\": \"01/01/1969\",\n \"Address\": \"Apartment 17\",\n \"AddressLine2\": \"1 ManageMy Towers\",\n \"AddressLine3\": \"Square Mile\",\n \"City\": \"London\",\n \"County\": \"Greater London\",\n \"PostCode\": \"E1 1AB\",\n \"Country\": \"GBR\",\n \"PhoneNumber\": \"+447777777777\",\n \"HomePhoneNumber\": \"+441011111111\",\n \"Email\": \"noreply@managemy.com\"\n }\n },\n {\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"InsurerCustomerReference\": \"Test-002\",\n \"UniqueRegistrationId\": \"URI_002\",\n \"PersonTitle\": \"Mrs\",\n \"FirstName\": \"Alice\",\n \"MiddleName\": \"\",\n \"LastName\": \"Jones\",\n \"DateOfBirth\": \"01/01/1969\",\n \"Address\": \"3 Pigeon Street\",\n \"AddressLine2\": \"\",\n \"AddressLine3\": \"\",\n \"City\": \"Leeds\",\n \"County\": \"West Yorkshire\",\n \"PostCode\": \"LS1 1LS\",\n \"Country\": \"GBR\",\n \"PhoneNumber\": \"+447111111111\",\n \"HomePhoneNumber\": \"+441131111111\",\n \"Email\": \"noreply2@managemy.com\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/create/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 09:12:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"entitiesResult\": [\n {\n \"success\": false,\n \"reference\": \"Test-003\",\n \"errorMessage\": \"User name 'noreply@managemy.com' is already taken.\"\n },\n {\n \"success\": false,\n \"reference\": \"Test-004\",\n \"errorMessage\": \"User name 'noreply2@managemy.com' is already taken.\"\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"679a5d17-77a7-4957-8819-8ed6f96d43fe","name":"Create New Customer - Failed - Customer Reference Uniqueness Validation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"InsurerCustomerReference\": \"Test-001\",\n \"UniqueRegistrationId\": \"URI_001\",\n \"PersonTitle\": \"Mr\",\n \"FirstName\": \"John\",\n \"MiddleName\": \"R\",\n \"LastName\": \"Smith\",\n \"DateOfBirth\": \"01/01/1969\",\n \"Address\": \"Apartment 17\",\n \"AddressLine2\": \"1 ManageMy Towers\",\n \"AddressLine3\": \"Square Mile\",\n \"City\": \"London\",\n \"County\": \"Greater London\",\n \"PostCode\": \"E1 1AB\",\n \"Country\": \"GBR\",\n \"PhoneNumber\": \"+447777777777\",\n \"HomePhoneNumber\": \"+441011111111\",\n \"Email\": \"noreply@managemy.com\"\n }\n },\n {\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"InsurerCustomerReference\": \"Test-002\",\n \"UniqueRegistrationId\": \"URI_002\",\n \"PersonTitle\": \"Mrs\",\n \"FirstName\": \"Alice\",\n \"MiddleName\": \"\",\n \"LastName\": \"Jones\",\n \"DateOfBirth\": \"01/01/1969\",\n \"Address\": \"3 Pigeon Street\",\n \"AddressLine2\": \"\",\n \"AddressLine3\": \"\",\n \"City\": \"Leeds\",\n \"County\": \"West Yorkshire\",\n \"PostCode\": \"LS1 1LS\",\n \"Country\": \"GBR\",\n \"PhoneNumber\": \"+447111111111\",\n \"HomePhoneNumber\": \"+441131111111\",\n \"Email\": \"noreply2@managemy.com\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/create/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 09:11:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"entitiesResult\": [\n {\n \"success\": false,\n \"reference\": \"Test-001\",\n \"errorMessage\": \"Validation Error\",\n \"validationErrors\": [\n {\n \"publicId\": \"1e4bd4813948408282d2860241636a8c\",\n \"field\": \"InsurerCustomerReference\",\n \"message\": \"This InsurerCustomerReference has already been used for a different customer - please use a different InsurerCustomerReference.\"\n }\n ]\n },\n {\n \"success\": false,\n \"reference\": \"Test-002\",\n \"errorMessage\": \"Validation Error\",\n \"validationErrors\": [\n {\n \"publicId\": \"1e4bd4813948408282d2860241636a8c\",\n \"field\": \"InsurerCustomerReference\",\n \"message\": \"This InsurerCustomerReference has already been used for a different customer - please use a different InsurerCustomerReference.\"\n }\n ]\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"fbf01c0b-b313-4b20-a94d-1f1d8561ce92","name":"Create New Customers - Mixed Response - Successes and Failures","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"InsurerCustomerReference\": \"Test-001\",\n \"UniqueRegistrationId\": \"URI_001\",\n \"PersonTitle\": \"Mr\",\n \"FirstName\": \"John\",\n \"MiddleName\": \"R\",\n \"LastName\": \"Smith\",\n \"DateOfBirth\": \"01/01/1969\",\n \"Address\": \"Apartment 17\",\n \"AddressLine2\": \"1 ManageMy Towers\",\n \"AddressLine3\": \"Square Mile\",\n \"City\": \"London\",\n \"County\": \"Greater London\",\n \"PostCode\": \"E1 1AB\",\n \"Country\": \"GBR\",\n \"PhoneNumber\": \"+447777777777\",\n \"HomePhoneNumber\": \"+441011111111\",\n \"Email\": \"noreply@managemy.com\"\n }\n },\n {\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"InsurerCustomerReference\": \"Test-001\",\n \"UniqueRegistrationId\": \"URI_002\",\n \"PersonTitle\": \"Mrs\",\n \"FirstName\": \"Alice\",\n \"MiddleName\": \"\",\n \"LastName\": \"Jones\",\n \"DateOfBirth\": \"01/01/1969\",\n \"Address\": \"3 Pigeon Street\",\n \"AddressLine2\": \"\",\n \"AddressLine3\": \"\",\n \"City\": \"Leeds\",\n \"County\": \"West Yorkshire\",\n \"PostCode\": \"LS1 1LS\",\n \"Country\": \"GBR\",\n \"PhoneNumber\": \"+447111111111\",\n \"HomePhoneNumber\": \"+441131111111\",\n \"Email\": \"noreply2@managemy.com\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/create/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 10:41:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"entitiesResult\": [\n {\n \"success\": true,\n \"publicId\": \"a6d0931a34ae4247bb498f4f5612f29c\",\n \"reference\": \"Test-001\"\n },\n {\n \"success\": false,\n \"reference\": \"Test-001\",\n \"errorMessage\": \"Validation Error\",\n \"validationErrors\": [\n {\n \"publicId\": \"1e4bd4813948408282d2860241636a8c\",\n \"field\": \"InsurerCustomerReference\",\n \"message\": \"This InsurerCustomerReference has already been used for a different customer - please use a different InsurerCustomerReference.\"\n }\n ]\n }\n ]\n },\n \"isSuccess\": true\n}"}],"_postman_id":"440a579c-8741-45a8-97b4-81fe7a4bf63e"}],"id":"2909ce52-3a8b-4299-b407-70102444f48c","_postman_id":"2909ce52-3a8b-4299-b407-70102444f48c","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Create Policies","item":[{"name":"Create Policies","id":"b22417c4-82b4-4314-924f-b16dab49ee6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"productPublicId\": \"94ae1ca46427402db584b49bbac1dfea\",\n \"customerPublicId\": \"\",\n \"customerReference\": \"Test-001\",\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"Reference\": \"Pol-001\",\n \"CoverType\": \"Buildings & Contents\",\n \"StartDate\": \"01/01/2020\",\n \"EndDate\": \"31/12/2020\",\n \"AnnualPremium\": \"462.64\",\n \"PaymentFrequency\": \"Monthly\",\n \"MonthlyPayment\": \"42.49\",\n \"TotalAnnualPayment\": \"509.88\",\n \"CreditCharge\": \"47.24\",\n \"APR\": \"19.90\",\n \"InsuredPropertyAddressLine1\": \"10 Lime Street\",\n \"InsuredPropertyAddressLine2\": \"Langbourn\",\n \"InsuredPropertyAddressLine3\": \"\",\n \"InsuredPropertyCity\": \"London\",\n \"InsuredPropertyCounty\": \"\",\n \"InsuredPropertyPostCode\": \"EC3M 7AA\",\n \"InsuredPropertyCountry\": \"GBR\",\n \"PropertyType\": \"Detached House\",\n \"YearOfBuild\": \"1950\",\n \"NoBedrooms\": \"5\",\n \"NoBathrooms\": \"3\",\n \"WallConstruction\": \"Brick\",\n \"RoofConstruction\": \"Tile\",\n \"BurglarAlarm\": \"Yes\",\n \"SmokeDetector\": \"Yes\",\n \"ListedBuilding\": \"No\",\n \"400mOfWater\": \"No\",\n \"BuildingsClaimsInLast3Years\": \"0\",\n \"ContentsClaimsInLast3Years\": \"0\",\n \"Occupancy\": \"Policyholder\",\n \"Adults\": \"2\",\n \"Children\": \"2\",\n \"Unoccupied\": \"Up to 30 days\",\n \"BusinessUse\": \"None\",\n \"BuildingsCoverLimit\": \"Unlimited\",\n \"BuildingsAccidentalDamage\": \"Yes\",\n \"BuildingsExcess\": \"100\",\n \"SubsidenceExcess\": \"1000\",\n \"BuildingsEscapeOfWaterExcess\": \"350\",\n \"ContentsCoverLimit\": \"50000\",\n \"ContentsAccidentalDamage\": \"Yes\",\n \"ContentsClaimExcess\": \"100\",\n \"PersonalEffectsExcess\": \"50\",\n \"EscapeOfWaterExcess\": \"350\",\n \"CoverAwayFromTheHome\": \"5000\",\n \"SingleItemCoverLimit\": \"5000\",\n \"SpecifiedItems\": \"Yes\",\n \"SpecifiedCycles\": \"No\",\n \"FamilyLegalCover\": \"Yes\",\n \"HomeEmergencyCover\": \"No\",\n \"PolicyStatus\": \"Active\",\n \"PolicyholdersGroup\": {\n \"PolicyholderFullName\": \"Mr John Smith\",\n \"PolicyholderOccupation\": \"Head of Product\",\n \"PolicyholderBusiness\": \"InsurTech\"\n },\n \"SpecifiedItemsGroup\": {\n \"SpecifiedItemType\": \"Art\",\n \"SpecifiedItemDescription\": \"Banksy Painting\",\n \"SpecifiedItemValue\": \"165000\"\n }\n }\n },\n {\n \"productPublicId\": \"94ae1ca46427402db584b49bbac1dfea\",\n \"customerPublicId\": \"\",\n \"customerReference\": \"Test-002\",\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"Reference\": \"Pol-002\",\n \"CoverType\": \"Buildings & Contents\",\n \"StartDate\": \"01/01/2020\",\n \"EndDate\": \"31/12/2020\",\n \"AnnualPremium\": \"462.64\",\n \"PaymentFrequency\": \"Monthly\",\n \"MonthlyPayment\": \"42.49\",\n \"TotalAnnualPayment\": \"509.88\",\n \"CreditCharge\": \"47.24\",\n \"APR\": \"19.90\",\n \"InsuredPropertyAddressLine1\": \"10 Lime Street\",\n \"InsuredPropertyAddressLine2\": \"Langbourn\",\n \"InsuredPropertyAddressLine3\": \"\",\n \"InsuredPropertyCity\": \"London\",\n \"InsuredPropertyCounty\": \"\",\n \"InsuredPropertyPostCode\": \"EC3M 7AA\",\n \"InsuredPropertyCountry\": \"GBR\",\n \"PropertyType\": \"Detached House\",\n \"YearOfBuild\": \"1950\",\n \"NoBedrooms\": \"5\",\n \"NoBathrooms\": \"3\",\n \"WallConstruction\": \"Brick\",\n \"RoofConstruction\": \"Tile\",\n \"BurglarAlarm\": \"Yes\",\n \"SmokeDetector\": \"Yes\",\n \"ListedBuilding\": \"No\",\n \"400mOfWater\": \"No\",\n \"BuildingsClaimsInLast3Years\": \"0\",\n \"ContentsClaimsInLast3Years\": \"0\",\n \"Occupancy\": \"Policyholder\",\n \"Adults\": \"2\",\n \"Children\": \"2\",\n \"Unoccupied\": \"Up to 30 days\",\n \"BusinessUse\": \"None\",\n \"BuildingsCoverLimit\": \"Unlimited\",\n \"BuildingsAccidentalDamage\": \"Yes\",\n \"BuildingsExcess\": \"100\",\n \"SubsidenceExcess\": \"1000\",\n \"BuildingsEscapeOfWaterExcess\": \"350\",\n \"ContentsCoverLimit\": \"50000\",\n \"ContentsAccidentalDamage\": \"Yes\",\n \"ContentsClaimExcess\": \"100\",\n \"PersonalEffectsExcess\": \"50\",\n \"EscapeOfWaterExcess\": \"350\",\n \"CoverAwayFromTheHome\": \"5000\",\n \"SingleItemCoverLimit\": \"5000\",\n \"SpecifiedItems\": \"Yes\",\n \"SpecifiedCycles\": \"No\",\n \"FamilyLegalCover\": \"Yes\",\n \"HomeEmergencyCover\": \"No\",\n \"PolicyStatus\": \"Active\",\n \"PolicyholdersGroup\": {\n \"PolicyholderFullName\": \"Mrs Alice Jones \",\n \"PolicyholderOccupation\": \"Head of Development\",\n \"PolicyholderBusiness\": \"InsurTech\"\n },\n \"SpecifiedItemsGroup\": {\n \"SpecifiedItemType\": \"Art\",\n \"SpecifiedItemDescription\": \"Banksy Painting\",\n \"SpecifiedItemValue\": \"165000\"\n }\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/policy/create/batch","description":"

Creates a new policy, of a specified product type, for specified customers. Multiple policies can be created in a single API call, using the 'entityFieldValueModels' array structure.

A 'commmandName' parameter must be passed within each object in the array.

By default, certain fields are validated to ensure uniqueness:

Reference (fdd85e5c827449aa82e2d09af23cfed8) - this is the Insurer's Policy ID as used by the source system, that maps to PolicyPublicId (63f8127f6a6647948fcf8703d89adc53) on the ManageMy platform.

Either CustomerPublicId or CustomerReference (insurerCustomerReference) can be used to key to the customer receiving the policy.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}},"urlObject":{"path":["policy","create","batch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7157d3cb-cd70-4d1e-abe1-16b712bce000","name":"Create Policy - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"productPublicId\": \"94ae1ca46427402db584b49bbac1dfea\",\n \"customerPublicId\": \"\",\n \"customerReference\": \"Test-001\",\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"Reference\": \"Pol-001\",\n \"CoverType\": \"Buildings & Contents\",\n \"StartDate\": \"01/01/2020\",\n \"EndDate\": \"31/12/2020\",\n \"AnnualPremium\": \"462.64\",\n \"PaymentFrequency\": \"Monthly\",\n \"MonthlyPayment\": \"42.49\",\n \"TotalAnnualPayment\": \"509.88\",\n \"CreditCharge\": \"47.24\",\n \"APR\": \"19.90\",\n \"InsuredPropertyAddressLine1\": \"10 Lime Street\",\n \"InsuredPropertyAddressLine2\": \"Langbourn\",\n \"InsuredPropertyAddressLine3\": \"\",\n \"InsuredPropertyCity\": \"London\",\n \"InsuredPropertyCounty\": \"\",\n \"InsuredPropertyPostCode\": \"EC3M 7AA\",\n \"InsuredPropertyCountry\": \"GBR\",\n \"PropertyType\": \"Detached House\",\n \"YearOfBuild\": \"1950\",\n \"NoBedrooms\": \"5\",\n \"NoBathrooms\": \"3\",\n \"WallConstruction\": \"Brick\",\n \"RoofConstruction\": \"Tile\",\n \"BurglarAlarm\": \"Yes\",\n \"SmokeDetector\": \"Yes\",\n \"ListedBuilding\": \"No\",\n \"400mOfWater\": \"No\",\n \"BuildingsClaimsInLast3Years\": \"0\",\n \"ContentsClaimsInLast3Years\": \"0\",\n \"Occupancy\": \"Policyholder\",\n \"Adults\": \"2\",\n \"Children\": \"2\",\n \"Unoccupied\": \"Up to 30 days\",\n \"BusinessUse\": \"None\",\n \"BuildingsCoverLimit\": \"Unlimited\",\n \"BuildingsAccidentalDamage\": \"Yes\",\n \"BuildingsExcess\": \"100\",\n \"SubsidenceExcess\": \"1000\",\n \"BuildingsEscapeOfWaterExcess\": \"350\",\n \"ContentsCoverLimit\": \"50000\",\n \"ContentsAccidentalDamage\": \"Yes\",\n \"ContentsClaimExcess\": \"100\",\n \"PersonalEffectsExcess\": \"50\",\n \"EscapeOfWaterExcess\": \"350\",\n \"CoverAwayFromTheHome\": \"5000\",\n \"SingleItemCoverLimit\": \"5000\",\n \"SpecifiedItems\": \"Yes\",\n \"SpecifiedCycles\": \"No\",\n \"FamilyLegalCover\": \"Yes\",\n \"HomeEmergencyCover\": \"No\",\n \"PolicyStatus\": \"Active\",\n \"PolicyholdersGroup\": {\n \"PolicyholderFullName\": \"Mr John Smith\",\n \"PolicyholderOccupation\": \"Head of Product\",\n \"PolicyholderBusiness\": \"InsurTech\"\n },\n \"SpecifiedItemsGroup\": {\n \"SpecifiedItemType\": \"Art\",\n \"SpecifiedItemDescription\": \"Banksy Painting\",\n \"SpecifiedItemValue\": \"165000\"\n }\n }\n },\n {\n \"productPublicId\": \"94ae1ca46427402db584b49bbac1dfea\",\n \"customerPublicId\": \"\",\n \"customerReference\": \"Test-002\",\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"Reference\": \"Pol-002\",\n \"CoverType\": \"Buildings & Contents\",\n \"StartDate\": \"01/01/2020\",\n \"EndDate\": \"31/12/2020\",\n \"AnnualPremium\": \"462.64\",\n \"PaymentFrequency\": \"Monthly\",\n \"MonthlyPayment\": \"42.49\",\n \"TotalAnnualPayment\": \"509.88\",\n \"CreditCharge\": \"47.24\",\n \"APR\": \"19.90\",\n \"InsuredPropertyAddressLine1\": \"10 Lime Street\",\n \"InsuredPropertyAddressLine2\": \"Langbourn\",\n \"InsuredPropertyAddressLine3\": \"\",\n \"InsuredPropertyCity\": \"London\",\n \"InsuredPropertyCounty\": \"\",\n \"InsuredPropertyPostCode\": \"EC3M 7AA\",\n \"InsuredPropertyCountry\": \"GBR\",\n \"PropertyType\": \"Detached House\",\n \"YearOfBuild\": \"1950\",\n \"NoBedrooms\": \"5\",\n \"NoBathrooms\": \"3\",\n \"WallConstruction\": \"Brick\",\n \"RoofConstruction\": \"Tile\",\n \"BurglarAlarm\": \"Yes\",\n \"SmokeDetector\": \"Yes\",\n \"ListedBuilding\": \"No\",\n \"400mOfWater\": \"No\",\n \"BuildingsClaimsInLast3Years\": \"0\",\n \"ContentsClaimsInLast3Years\": \"0\",\n \"Occupancy\": \"Policyholder\",\n \"Adults\": \"2\",\n \"Children\": \"2\",\n \"Unoccupied\": \"Up to 30 days\",\n \"BusinessUse\": \"None\",\n \"BuildingsCoverLimit\": \"Unlimited\",\n \"BuildingsAccidentalDamage\": \"Yes\",\n \"BuildingsExcess\": \"100\",\n \"SubsidenceExcess\": \"1000\",\n \"BuildingsEscapeOfWaterExcess\": \"350\",\n \"ContentsCoverLimit\": \"50000\",\n \"ContentsAccidentalDamage\": \"Yes\",\n \"ContentsClaimExcess\": \"100\",\n \"PersonalEffectsExcess\": \"50\",\n \"EscapeOfWaterExcess\": \"350\",\n \"CoverAwayFromTheHome\": \"5000\",\n \"SingleItemCoverLimit\": \"5000\",\n \"SpecifiedItems\": \"Yes\",\n \"SpecifiedCycles\": \"No\",\n \"FamilyLegalCover\": \"Yes\",\n \"HomeEmergencyCover\": \"No\",\n \"PolicyStatus\": \"Active\",\n \"PolicyholdersGroup\": {\n \"PolicyholderFullName\": \"Mrs Alice Jones \",\n \"PolicyholderOccupation\": \"Head of Development\",\n \"PolicyholderBusiness\": \"InsurTech\"\n },\n \"SpecifiedItemsGroup\": {\n \"SpecifiedItemType\": \"Art\",\n \"SpecifiedItemDescription\": \"Banksy Painting\",\n \"SpecifiedItemValue\": \"165000\"\n }\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/policy/create/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 16:56:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"entitiesResult\": [\n {\n \"success\": true,\n \"publicId\": \"4c9466a84d4243eab445cd58150b7678\",\n \"reference\": \"Pol-001\"\n },\n {\n \"success\": true,\n \"publicId\": \"292410ee6aa6434885dc93eb0746c755\",\n \"reference\": \"Pol-002\"\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"27d3994a-8f92-41ab-b3af-5389708be4fc","name":"Create Policy - Failed - Uniqueness Validation on Reference","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"productPublicId\": \"94ae1ca46427402db584b49bbac1dfea\",\n \"customerPublicId\": \"\",\n \"customerReference\": \"Test-001\",\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"Reference\": \"Pol-001\",\n \"CoverType\": \"Buildings & Contents\",\n \"StartDate\": \"01/01/2020\",\n \"EndDate\": \"31/12/2020\",\n \"AnnualPremium\": \"462.64\",\n \"PaymentFrequency\": \"Monthly\",\n \"MonthlyPayment\": \"42.49\",\n \"TotalAnnualPayment\": \"509.88\",\n \"CreditCharge\": \"47.24\",\n \"APR\": \"19.90\",\n \"InsuredPropertyAddressLine1\": \"10 Lime Street\",\n \"InsuredPropertyAddressLine2\": \"Langbourn\",\n \"InsuredPropertyAddressLine3\": \"\",\n \"InsuredPropertyCity\": \"London\",\n \"InsuredPropertyCounty\": \"\",\n \"InsuredPropertyPostCode\": \"EC3M 7AA\",\n \"InsuredPropertyCountry\": \"GBR\",\n \"PropertyType\": \"Detached House\",\n \"YearOfBuild\": \"1950\",\n \"NoBedrooms\": \"5\",\n \"NoBathrooms\": \"3\",\n \"WallConstruction\": \"Brick\",\n \"RoofConstruction\": \"Tile\",\n \"BurglarAlarm\": \"Yes\",\n \"SmokeDetector\": \"Yes\",\n \"ListedBuilding\": \"No\",\n \"400mOfWater\": \"No\",\n \"BuildingsClaimsInLast3Years\": \"0\",\n \"ContentsClaimsInLast3Years\": \"0\",\n \"Occupancy\": \"Policyholder\",\n \"Adults\": \"2\",\n \"Children\": \"2\",\n \"Unoccupied\": \"Up to 30 days\",\n \"BusinessUse\": \"None\",\n \"BuildingsCoverLimit\": \"Unlimited\",\n \"BuildingsAccidentalDamage\": \"Yes\",\n \"BuildingsExcess\": \"100\",\n \"SubsidenceExcess\": \"1000\",\n \"BuildingsEscapeOfWaterExcess\": \"350\",\n \"ContentsCoverLimit\": \"50000\",\n \"ContentsAccidentalDamage\": \"Yes\",\n \"ContentsClaimExcess\": \"100\",\n \"PersonalEffectsExcess\": \"50\",\n \"EscapeOfWaterExcess\": \"350\",\n \"CoverAwayFromTheHome\": \"5000\",\n \"SingleItemCoverLimit\": \"5000\",\n \"SpecifiedItems\": \"Yes\",\n \"SpecifiedCycles\": \"No\",\n \"FamilyLegalCover\": \"Yes\",\n \"HomeEmergencyCover\": \"No\",\n \"PolicyStatus\": \"Active\",\n \"PolicyholdersGroup\": {\n \"PolicyholderFullName\": \"Mr John Smith\",\n \"PolicyholderOccupation\": \"Head of Product\",\n \"PolicyholderBusiness\": \"InsurTech\"\n },\n \"SpecifiedItemsGroup\": {\n \"SpecifiedItemType\": \"Art\",\n \"SpecifiedItemDescription\": \"Banksy Painting\",\n \"SpecifiedItemValue\": \"165000\"\n }\n }\n },\n {\n \"productPublicId\": \"94ae1ca46427402db584b49bbac1dfea\",\n \"customerPublicId\": \"\",\n \"customerReference\": \"Test-002\",\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"Reference\": \"Pol-002\",\n \"CoverType\": \"Buildings & Contents\",\n \"StartDate\": \"01/01/2020\",\n \"EndDate\": \"31/12/2020\",\n \"AnnualPremium\": \"462.64\",\n \"PaymentFrequency\": \"Monthly\",\n \"MonthlyPayment\": \"42.49\",\n \"TotalAnnualPayment\": \"509.88\",\n \"CreditCharge\": \"47.24\",\n \"APR\": \"19.90\",\n \"InsuredPropertyAddressLine1\": \"10 Lime Street\",\n \"InsuredPropertyAddressLine2\": \"Langbourn\",\n \"InsuredPropertyAddressLine3\": \"\",\n \"InsuredPropertyCity\": \"London\",\n \"InsuredPropertyCounty\": \"\",\n \"InsuredPropertyPostCode\": \"EC3M 7AA\",\n \"InsuredPropertyCountry\": \"GBR\",\n \"PropertyType\": \"Detached House\",\n \"YearOfBuild\": \"1950\",\n \"NoBedrooms\": \"5\",\n \"NoBathrooms\": \"3\",\n \"WallConstruction\": \"Brick\",\n \"RoofConstruction\": \"Tile\",\n \"BurglarAlarm\": \"Yes\",\n \"SmokeDetector\": \"Yes\",\n \"ListedBuilding\": \"No\",\n \"400mOfWater\": \"No\",\n \"BuildingsClaimsInLast3Years\": \"0\",\n \"ContentsClaimsInLast3Years\": \"0\",\n \"Occupancy\": \"Policyholder\",\n \"Adults\": \"2\",\n \"Children\": \"2\",\n \"Unoccupied\": \"Up to 30 days\",\n \"BusinessUse\": \"None\",\n \"BuildingsCoverLimit\": \"Unlimited\",\n \"BuildingsAccidentalDamage\": \"Yes\",\n \"BuildingsExcess\": \"100\",\n \"SubsidenceExcess\": \"1000\",\n \"BuildingsEscapeOfWaterExcess\": \"350\",\n \"ContentsCoverLimit\": \"50000\",\n \"ContentsAccidentalDamage\": \"Yes\",\n \"ContentsClaimExcess\": \"100\",\n \"PersonalEffectsExcess\": \"50\",\n \"EscapeOfWaterExcess\": \"350\",\n \"CoverAwayFromTheHome\": \"5000\",\n \"SingleItemCoverLimit\": \"5000\",\n \"SpecifiedItems\": \"Yes\",\n \"SpecifiedCycles\": \"No\",\n \"FamilyLegalCover\": \"Yes\",\n \"HomeEmergencyCover\": \"No\",\n \"PolicyStatus\": \"Active\",\n \"PolicyholdersGroup\": {\n \"PolicyholderFullName\": \"Mrs Alice Jones \",\n \"PolicyholderOccupation\": \"Head of Development\",\n \"PolicyholderBusiness\": \"InsurTech\"\n },\n \"SpecifiedItemsGroup\": {\n \"SpecifiedItemType\": \"Art\",\n \"SpecifiedItemDescription\": \"Banksy Painting\",\n \"SpecifiedItemValue\": \"165000\"\n }\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/policy/create/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 16:57:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"entitiesResult\": [\n {\n \"success\": false,\n \"reference\": \"Pol-001\",\n \"validationErrors\": [\n {\n \"publicId\": \"fdd85e5c827449aa82e2d09af23cfed8\",\n \"field\": \"Reference\",\n \"message\": \"The Policy Reference 'Pol-001' has already been used for a different policy - please use a different Policy Reference.\"\n }\n ]\n },\n {\n \"success\": false,\n \"reference\": \"Pol-002\",\n \"validationErrors\": [\n {\n \"publicId\": \"fdd85e5c827449aa82e2d09af23cfed8\",\n \"field\": \"Reference\",\n \"message\": \"The Policy Reference 'Pol-002' has already been used for a different policy - please use a different Policy Reference.\"\n }\n ]\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"85bbf049-550d-446c-b925-12c63b35de53","name":"Create Policies - Mixed Response - Success and Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"productPublicId\": \"94ae1ca46427402db584b49bbac1dfea\",\n \"customerPublicId\": \"\",\n \"customerReference\": \"Test-001\",\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"Reference\": \"\",\n \"CoverType\": \"Buildings & Contents\",\n \"StartDate\": \"01/01/2020\",\n \"EndDate\": \"31/12/2020\",\n \"AnnualPremium\": \"462.64\",\n \"PaymentFrequency\": \"Monthly\",\n \"MonthlyPayment\": \"42.49\",\n \"TotalAnnualPayment\": \"509.88\",\n \"CreditCharge\": \"47.24\",\n \"APR\": \"19.90\",\n \"InsuredPropertyAddressLine1\": \"10 Lime Street\",\n \"InsuredPropertyAddressLine2\": \"Langbourn\",\n \"InsuredPropertyAddressLine3\": \"\",\n \"InsuredPropertyCity\": \"London\",\n \"InsuredPropertyCounty\": \"\",\n \"InsuredPropertyPostCode\": \"EC3M 7AA\",\n \"InsuredPropertyCountry\": \"GBR\",\n \"PropertyType\": \"Detached House\",\n \"YearOfBuild\": \"1950\",\n \"NoBedrooms\": \"5\",\n \"NoBathrooms\": \"3\",\n \"WallConstruction\": \"Brick\",\n \"RoofConstruction\": \"Tile\",\n \"BurglarAlarm\": \"Yes\",\n \"SmokeDetector\": \"Yes\",\n \"ListedBuilding\": \"No\",\n \"400mOfWater\": \"No\",\n \"BuildingsClaimsInLast3Years\": \"0\",\n \"ContentsClaimsInLast3Years\": \"0\",\n \"Occupancy\": \"Policyholder\",\n \"Adults\": \"2\",\n \"Children\": \"2\",\n \"Unoccupied\": \"Up to 30 days\",\n \"BusinessUse\": \"None\",\n \"BuildingsCoverLimit\": \"Unlimited\",\n \"BuildingsAccidentalDamage\": \"Yes\",\n \"BuildingsExcess\": \"100\",\n \"SubsidenceExcess\": \"1000\",\n \"BuildingsEscapeOfWaterExcess\": \"350\",\n \"ContentsCoverLimit\": \"50000\",\n \"ContentsAccidentalDamage\": \"Yes\",\n \"ContentsClaimExcess\": \"100\",\n \"PersonalEffectsExcess\": \"50\",\n \"EscapeOfWaterExcess\": \"350\",\n \"CoverAwayFromTheHome\": \"5000\",\n \"SingleItemCoverLimit\": \"5000\",\n \"SpecifiedItems\": \"Yes\",\n \"SpecifiedCycles\": \"No\",\n \"FamilyLegalCover\": \"Yes\",\n \"HomeEmergencyCover\": \"No\",\n \"PolicyStatus\": \"Active\",\n \"PolicyholdersGroup\": {\n \"PolicyholderFullName\": \"Mr John Smith\",\n \"PolicyholderOccupation\": \"Head of Product\",\n \"PolicyholderBusiness\": \"InsurTech\"\n },\n \"SpecifiedItemsGroup\": {\n \"SpecifiedItemType\": \"Art\",\n \"SpecifiedItemDescription\": \"Banksy Painting\",\n \"SpecifiedItemValue\": \"165000\"\n }\n }\n },\n {\n \"productPublicId\": \"94ae1ca46427402db584b49bbac1dfea\",\n \"customerPublicId\": \"\",\n \"customerReference\": \"Test-002\",\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"Reference\": \"Pol-003\",\n \"CoverType\": \"Buildings & Contents\",\n \"StartDate\": \"01/01/2020\",\n \"EndDate\": \"31/12/2020\",\n \"AnnualPremium\": \"462.64\",\n \"PaymentFrequency\": \"Monthly\",\n \"MonthlyPayment\": \"42.49\",\n \"TotalAnnualPayment\": \"509.88\",\n \"CreditCharge\": \"47.24\",\n \"APR\": \"19.90\",\n \"InsuredPropertyAddressLine1\": \"10 Lime Street\",\n \"InsuredPropertyAddressLine2\": \"Langbourn\",\n \"InsuredPropertyAddressLine3\": \"\",\n \"InsuredPropertyCity\": \"London\",\n \"InsuredPropertyCounty\": \"\",\n \"InsuredPropertyPostCode\": \"EC3M 7AA\",\n \"InsuredPropertyCountry\": \"GBR\",\n \"PropertyType\": \"Detached House\",\n \"YearOfBuild\": \"1950\",\n \"NoBedrooms\": \"5\",\n \"NoBathrooms\": \"3\",\n \"WallConstruction\": \"Brick\",\n \"RoofConstruction\": \"Tile\",\n \"BurglarAlarm\": \"Yes\",\n \"SmokeDetector\": \"Yes\",\n \"ListedBuilding\": \"No\",\n \"400mOfWater\": \"No\",\n \"BuildingsClaimsInLast3Years\": \"0\",\n \"ContentsClaimsInLast3Years\": \"0\",\n \"Occupancy\": \"Policyholder\",\n \"Adults\": \"2\",\n \"Children\": \"2\",\n \"Unoccupied\": \"Up to 30 days\",\n \"BusinessUse\": \"None\",\n \"BuildingsCoverLimit\": \"Unlimited\",\n \"BuildingsAccidentalDamage\": \"Yes\",\n \"BuildingsExcess\": \"100\",\n \"SubsidenceExcess\": \"1000\",\n \"BuildingsEscapeOfWaterExcess\": \"350\",\n \"ContentsCoverLimit\": \"50000\",\n \"ContentsAccidentalDamage\": \"Yes\",\n \"ContentsClaimExcess\": \"100\",\n \"PersonalEffectsExcess\": \"50\",\n \"EscapeOfWaterExcess\": \"350\",\n \"CoverAwayFromTheHome\": \"5000\",\n \"SingleItemCoverLimit\": \"5000\",\n \"SpecifiedItems\": \"Yes\",\n \"SpecifiedCycles\": \"No\",\n \"FamilyLegalCover\": \"Yes\",\n \"HomeEmergencyCover\": \"No\",\n \"PolicyStatus\": \"Active\",\n \"PolicyholdersGroup\": {\n \"PolicyholderFullName\": \"Mrs Alice Jones \",\n \"PolicyholderOccupation\": \"Head of Development\",\n \"PolicyholderBusiness\": \"InsurTech\"\n },\n \"SpecifiedItemsGroup\": {\n \"SpecifiedItemType\": \"Art\",\n \"SpecifiedItemDescription\": \"Banksy Painting\",\n \"SpecifiedItemValue\": \"165000\"\n }\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/policy/create/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 17:49:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"entitiesResult\": [\n {\n \"success\": false,\n \"reference\": \"\",\n \"validationErrors\": [\n {\n \"publicId\": \"fdd85e5c827449aa82e2d09af23cfed8\",\n \"field\": \"Reference\",\n \"message\": \"Please enter the Policy ID \"\n }\n ]\n },\n {\n \"success\": true,\n \"publicId\": \"fc9ee60b537348b495fb25496275b001\",\n \"reference\": \"Pol-003\"\n }\n ]\n },\n \"isSuccess\": true\n}"}],"_postman_id":"b22417c4-82b4-4314-924f-b16dab49ee6c"}],"id":"b64c3220-2505-481b-856a-fb66b1854c9f","_postman_id":"b64c3220-2505-481b-856a-fb66b1854c9f","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Invite Customers","item":[{"name":"Invite Customers","id":"bf3e8876-a44b-4f52-a937-41d42749ee55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"publicId\": \"\",\n \"reference\": \"Test-001\",\n \"values\": {\n \"CustomerInviteReason\": \"NewCustomer\",\n \"InvitationMethod\": \"[\\\"Email\\\",\\\"SMS\\\"]\"\n }\n },\n {\n \"publicId\": \"\",\n \"reference\": \"Test-002\",\n \"values\": {\n \"CustomerInviteReason\": \"NewCustomer\",\n \"InvitationMethod\": \"[\\\"Email\\\"]\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/invite","description":"

Triggers the registration invite for customers. Multiple customers can be invited in a single API call, using the 'entityFieldValueModels' array structure.

The Invite workflow and method must be specified in each object in the array.

Either Customer PublicId or Customer Reference must be supplied in the request body of each array object.

When triggering a customer invite, 2 parameters must be passed:

Invite Workflow: \"publicId\": \"28bb3c12c081457fb061c9423417de6f\"
Valid Values: [\"SMS\"; \"Email\"] (at least one must be passed)

Invite Method: \"publicId\": \"3fa5ec015bfa4f2aa9405f8b74d863ac
Valid Values: “NewCustomer”; “ExistingCustomer”; “Renewal”; “Claim” (only one can be passed)

Optional Parameters:

Email Template: \"publicId\": \"5e73dfb6bb4b4bf68dafc316a5013e62\", \"value\": \"EmailTemplatePublicId\"
Allows a specified email template to be used for the invite email

SMS Template: \"publicId\": \"54d022191ef946088170c821d99df2c0\", \"value\": \"SmsTemplatePublicId\"
Allows a specified SMS template to be used for the invite SMS

NB: where a field value is passed using the \"publicId\" as the field identifier, it is possible to instead use \"name\" and provide the field name to identify the field to be created/updated

The following examples illustrate how to onboard customers, policies and documents to the ManageMy platform.

\n","_postman_id":"1e587b09-a284-4c41-93c3-a931baeddea8","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Document Uploads","item":[{"name":"Get CloudFront Upload URLs","id":"02af19d0-24bb-49e6-ada1-e151e4bd9374","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"entities\": [\r\n {\r\n \"entityType\": \"policy\",\r\n \"publicId\": \"\",\r\n \"reference\": \"Pol-001\",\r\n \"documentDate\": \"2021-09-17 23:12:50\",\r\n \"documentType\": \"policyDocument\",\r\n \"documentName\": \"Policy Document 2\",\r\n \"fileName\": \"Policy Document.pdf\",\r\n \"documentReference\": \"PolDoc-Pol-001-1\"\r\n },\r\n {\r\n \"entityType\": \"policy\",\r\n \"publicId\": \"\",\r\n \"reference\": \"Pol-001\",\r\n \"documentDate\": \"2021-09-17 23:12:50\",\r\n \"documentType\": \"policyDocument\",\r\n \"documentName\": \"Policy Document\",\r\n \"fileName\": \"Policy Document.pdf\",\r\n \"documentReference\": \"PolDoc-Pol-001-2\"\r\n },\r\n {\r\n \"entityType\": \"policy\",\r\n \"publicId\": \"\",\r\n \"reference\": \"Pol-001\",\r\n \"documentDate\": \"2021-09-17 23:12:50\",\r\n \"documentType\": \"policyDocument\",\r\n \"documentName\": \"Policy Document\",\r\n \"fileName\": \"Policy Document.pdf\",\r\n \"documentReference\": \"PolDoc-Pol-001-3\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/docs/upload/cloudfront/url/batch","description":"

This endpoint forms stage 1 of the Document Upload flow where the file meta-data can be pre-validated and a File Upload URL can be obtained for each file that will be uploaded.

\n\n

All of the properties within the request are optional, but it recommended that these properties are included in the request. This allows the properties to be validated, to ensure they can be used in the final step of the flow.

Properties:

entityType - one of the valid entity types for which files can be uploaded
publicId - optional - the Public ID of the entity for which the file upload is intended
reference - optional - the Reference of the entity for which the file upload is intended
documentDate - optional - the intended date of the document - must use the format yyyy-MM-dd HH:mm:ss.
documentType - the intended document type - must be one of the valid document types
fileName - the intended file name - must have one of the configured allowed extensions
documentReference - optional - the intended document reference - must be unique

As this is a batch endpoint it is possible to request multiple \"upload URLs\" in a single call. In this scenario, the endpoint will return a response for the call itself, which if successful will then provide a success status for each entry within the call. For each successful entry, an upload URL and a filePublicId is provided. Each upload URL can be used to upload a single file in stage 2.

Note: filePublicId is required to link the file recorded to the uploaded file, via the API call in stage 3.

If any of the entries within the API fails, for example due to validation errors on any of the fields included, the endpoint will respond with a 200 status code and the corresponding entry will have “success” = false and include an “errorMessage”.

Currently supported document types:

billingDocument
brochure
claimDocument
contract
creditAgreement
form
image
insuranceCertificate
iPID
keyFacts
other
otherPolicyDocument
passport
photo
policyBooklet
policyDocument
policySchedule
receipt
renewalDocument
renewalInvite
scan
statement
termsAndConditions
video

entityType must match one of the following valid values:

amendment
claim
customerAmend
policy
policyAddon
quote

Stage 2 requires each file to be uploaded as a binary to the uploadUrls received in stage 1, using a PUT request.

\n\n

The request should also include the following header key-value pairs:

“x-amz-acl” = “bucket-owner-full-control“

“content-type”= the content type corresponding to the file being uploaded i.e. \"application/pdf\"

Note that a generic content type of “application/octet-stream” will result in the “View” feature not working on web front-ends as browsers reject opening such files

Note that the uploadUrl links are only valid for 1 minute, however the expiry time can be configured as required. It is expected that all requests will be successful with a response code of 200 unless the uploadUrl being used has expired. where it returns a 403 response.

If you're not sure what content type value to use please check out the link to 'IANA' the official registry of MIME media types.

Note: the URL above is a placeholder. In practice, PUT to the exact uploadUrl returned for each file by the 'Get CloudFront Upload URLs' step — it's a real, time-limited, pre-signed URL and will differ on every call.

\n\nThe request should also include the following header key-value pairs:\n\n`“x-amz-acl” = “bucket-owner-full-control“`\n\n“`content-type`”= the content type corresponding to the file being uploaded i.e. \"application/pdf\"\n\nNote that a generic content type of “`application/octet-stream`” will result in the “View” feature not working on web front-ends as browsers reject opening such files\n\nNote that the `uploadUrl` links are only valid for 1 minute, however the expiry time can be configured as required. It is expected that all requests will be successful with a response code of 200 unless the `uploadUrl` being used has expired. where it returns a 403 response.\n\nIf you're not sure what content type value to use please check out the link to '[IANA](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types)' the official registry of MIME media types.\n\n**Note:** the URL above is a placeholder. In practice, PUT to the exact `uploadUrl` returned for each file by the 'Get CloudFront Upload URLs' step — it's a real, time-limited, pre-signed URL and will differ on every call."},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 21 Jun 2022 15:15:32 GMT"},{"key":"x-amz-version-id","value":"UaV0ziZbaSaVKvjpbpknoK4nktKNdvoO"},{"key":"x-amz-expiration","value":"expiry-date=\"Wed, 29 Jun 2022 00:00:00 GMT\", rule-id=\"uploads_cleanup\""},{"key":"x-amz-server-side-encryption","value":"AES256"},{"key":"ETag","value":"\"7d9917d62056a0686f14a171a34dcbc6\""},{"key":"Server","value":"AmazonS3"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 73afe8565c6794e933a665f6672c4b12.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"LHR50-P4"},{"key":"X-Amz-Cf-Id","value":"iUGAZVLipU_MiDtAbOi6l0ahSCS7U7pgxeac83bio0mcC8r0B00guQ=="}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f45229cd-c958-4d82-81f9-66712a192a0b"},{"name":"Confirm CloudFront Uploads","id":"a29e8f10-9cf6-452e-a197-6bb39558ff76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"entities\": [\r\n {\r\n \"entityType\": \"policy\",\r\n \"publicId\": \"\",\r\n \"reference\": \"Pol-001\",\r\n \"documentDate\": \"2021-09-17 23:12:50\",\r\n \"documentType\": \"policyDocument\",\r\n \"documentName\": \"Policy Document 2\",\r\n \"fileName\": \"Policy Document.pdf\",\r\n \"documentReference\": \"PolDoc-Pol-001-1\",\r\n \"filePublicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\",\r\n \"notifyCustomer\": false\r\n },\r\n {\r\n \"entityType\": \"policy\",\r\n \"publicId\": \"\",\r\n \"reference\": \"Pol-001\",\r\n \"documentDate\": \"2021-09-17 23:12:50\",\r\n \"documentType\": \"policyDocument\",\r\n \"documentName\": \"Policy Document\",\r\n \"fileName\": \"Policy Document.pdf\",\r\n \"documentReference\": \"PolDoc-Pol-001-2\",\r\n \"filePublicId\": \"4b541ead53284464a30ee40f7d6c8a7f\",\r\n \"notifyCustomer\": true\r\n },\r\n {\r\n \"entityType\": \"policy\",\r\n \"publicId\": \"\",\r\n \"reference\": \"Pol-001\",\r\n \"documentDate\": \"2021-09-17 23:12:50\",\r\n \"documentType\": \"policyDocument\",\r\n \"documentName\": \"Policy Document\",\r\n \"fileName\": \"Policy Document.pdf\",\r\n \"documentReference\": \"PolDoc-Pol-001-3\",\r\n \"filePublicId\": \"c47f6bb28d034a50b39cb6082070f035\",\r\n \"notifyCustomer\": false\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/docs/upload/cloudfront/confirm/batch","description":"

Stage 3 requires the file parameters that have been validated in stage 1 to be stored against the uploaded files.

\n\n

Once this stage is complete the files are available within the platform.

The below list details the different properties for the API call and whether they are mandatory or optional:

entityType - mandatory - the entity type for which the file is being created - must be one
of the valid entity types
publicId - mandatory if reference is not provided - the Public ID of the entity for which the file is being created
reference - mandatory if publicId is not provided - the Reference of the entity for which the file is being created
documentName - mandatory - the user-facing name of the document
fileName - mandatory - the file name being used if the document’s file is downloaded - must have one of the configured allowed extensions
documentDate - optional - the date of the document - must use the format yyyy-MM-dd HH:mm:ss
documentType - mandatory - the document type - must be one of the valid document types
documentReference - optional - the document reference - must be unique if provided
filePublicId - mandatory - this must be the same filePublicId that was returned by the 'Get CloudFront Upload URLs' endpoint and must correspond to the uploadUrl that the file was successfully
uploaded to
notifyCustomer - optional - whether to notify the customers who have access to the newly uploaded files/s. Each customer will only be notified once per batch request, even if multiple files are uploaded for the same customer

As this is a batch endpoint it is possible to confirm multiple uploads in a single call. In this scenario, the endpoint will return a response for the call itself, which if successful will then provide a success status for each entry within the call.

This endpoint allows the retreval of previously uploaded files. Using the filePublicIdprovided on a previous call it is possible to request a URL in order to download the file.

\n\n

As this is a batch endpoint it is possible to submit public IDs for multiple files in a single call. Where a batch of public IDs are provided, the endpoint will return a response for the call itself, which if successful will then detail the response for each entry in the request. Where an entry is successful a download URL will be provided. each unique URL can then be used to download the file from CloudFront.

Type of entity the documents are being attached to

\n","type":"text"},{"key":"entityPublicId","value":"","description":"

PublicId of the specific entity to upload the documents to

\n","type":"text"},{"key":"entityReference","value":"EXT-D24148FD","description":"

'External Reference' of the specific entity to upload the documents to

\n","type":"text"},{"key":"Documents[0].DocumentName","value":"Insurance Terms.pdf","description":"

Name of the document being uploaded

\n","type":"text"},{"key":"Documents[0].DocumentReference","value":"My Claim 1","description":"

'External Reference' of the document being uploaded. Must be unique.

\n","type":"text"},{"key":"Documents[0].DocumentDate","value":"2020-09-11 00:11:42","description":"

Creation date of the document being uploaded. Optional. If left blank, will default to the timestamp that the document is uploaded to the ManageMy platform.

\n","type":"text"},{"key":"Documents[0].Type","value":"termsAndConditions","description":"

Type or category of the document being uploaded. Must match a valid type on the ManageMy platform.

\n","type":"text"},{"key":"Documents[1].DocumentName","value":"Insurance Certificate.pdf","description":"

Name of the document being uploaded

\n","type":"text"},{"key":"Documents[1].DocumentReference","value":"My Claim 2","description":"

'External Reference' of the document being uploaded. Must be unique.

\n","type":"text"},{"key":"Documents[1].DocumentDate","value":"2020-09-11 01:12:03","description":"

Creation date of the document being uploaded. Optional. If left blank, will default to the timestamp that the document is uploaded to the ManageMy platform.

\n","type":"text"},{"key":"Documents[1].Type","value":"insuranceCertificate","description":"

Type or category of the document being uploaded. Must match a valid type on the ManageMy platform.

\n","type":"text"},{"key":"Files","description":"

Path to the file to be uploaded

\n","type":"file","src":"/Users/Mark/ManageMy ltd/Product Development - Documents/Prototype/MM Demo Platform/Forms/API/Home Stubbed Policies/Ins_Terms_2020.pdf"},{"key":"Files","description":"

Path to the file to be uploaded

\n","type":"file","src":"/Users/Mark/ManageMy ltd/Product Development - Documents/Prototype/MM Demo Platform/Forms/API/Home Stubbed Policies/Ins_Cert_MM28681.pdf"},{"key":"NotifyCustomer","value":"true","description":"

Sets whether a notification is triggered to the customer that a new document have been uploaded to the entity

\n","type":"text"}]},"url":"{{base_url}}/docs/upload/batch","description":"

An alternative to the CloudFront upload flow above for smaller/simpler cases: upload the file(s) and their metadata in a single multipart/form-data call, rather than the get-URL / PUT / confirm three-step flow. entityType must match one of: amendment, claim, customer, customerAmend, policy, policyAddon, product, productAddon, quote, renewal.

Each DocumentName / Reference / Type / Date field in the array should be appended with the array sequence number, e.g.

“DocumentName[0]”: “Document1”\n“DocumentReference[0]”: “Reference1”\n“DocumentDate[0]”: “2020-01-01 00:00:01”\n“Type[0]”:  “Insurance Certificate”\n“DocumentName[1]”: “Document2” \n“DocumentReference[1]”: “Reference2”\n“DocumentDate[1]”: “2020-01-01 00:00:02”\n“Type[1]”:  “Insurance Certificate”\nFile/Document1.pdf\nFile/Document2.pdf\n\n

DocumentDate is an optional parameter. If the parameter is not passed, or left blank, the system will auto-populate the field with the date the document is added to the ManageMy platform. The data will be appended to the documents in the order that they are passed to the end point.

Currently supported document types:

\"other\"; \"insuranceCertificate\"; \"insuranceSchedule\"; \"ipid\"; \"policyBooklet\"; \"policyDocument\"; \"keyFacts\"; \"brochure\"; \"termsConditions\"; \"renewalInvite\"; \"renewalDocument\"; \"form\"; \"creditAgreement”; “billingDocument”

‘entityType’ must match one of the following valid values:

“amendment”; “claim”; “customer”; “policy”; “policyAddon”; “product”; “productAddon”; “quote”; “renewal”

Note: a JSON-body variant of this same endpoint (docs/upload/batch, Content-Type: application/json) also exists for uploading pre-hosted files by URL rather than as multipart form data — not illustrated here.

The document upload flow is the same for every entity type in this API (Customers, Policies, Claims, Quotes, Policy Amends, Customer Amends) — only the entityType value in the request body changes. It's documented once here rather than repeated in every entity section below.

Process Flow (CloudFront, recommended for most files):

Get CloudFront Upload URLs — validates the intended file metadata and returns a pre-signed upload URL per file
Upload CloudFront File — PUT the raw file bytes to that URL
Confirm CloudFront Uploads — links the uploaded file(s) to the entity record

Use Get File Download URLs afterwards (or any time) to retrieve a download link for a previously uploaded file by its filePublicId.

See Upload Documents (Multipart, Single Call) for a simpler one-call alternative.

\n","_postman_id":"97545adf-6132-4627-b4de-aadeaaa4ccae","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Updates","item":[{"name":"Update Customer Details","id":"f31b5d4d-3225-4043-98c5-e71ca7e2acde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"publicId\": \"\",\n \"reference\": \"Test-001\",\n \"commandName\": \"ExternalApiUpdate\",\n \"values\": {\n \"InsurerCustomerReference\": \"Test-001\",\n \"UniqueRegistrationId\": \"URI_001\",\n \"PersonTitle\": \"Mr\",\n \"FirstName\": \"John\",\n \"MiddleName\": \"R\",\n \"LastName\": \"Smith\",\n \"DateOfBirth\": \"01/01/1969\",\n \"Address\": \"Apartment 17\",\n \"AddressLine2\": \"1 ManageMy Towers\",\n \"AddressLine3\": \"Square Mile\",\n \"City\": \"London\",\n \"County\": \"Greater London\",\n \"PostCode\": \"E1 1AB\",\n \"Country\": \"GBR\",\n \"PhoneNumber\": \"+44777777777\",\n \"HomePhoneNumber\": \"+441011111111\",\n \"Email\": \"noreply@managemy.com\"\n }\n },\n {\n \"publicId\": \"\",\n \"reference\": \"Test-002\",\n \"commandName\": \"ExternalApiUpdate\",\n \"values\": {\n \"InsurerCustomerReference\": \"Test-002\",\n \"UniqueRegistrationId\": \"URI_002\",\n \"PersonTitle\": \"Mrs\",\n \"FirstName\": \"Alice\",\n \"MiddleName\": \"\",\n \"LastName\": \"Jones\",\n \"DateOfBirth\": \"01/01/1969\",\n \"Address\": \"3 Pigeon Street\",\n \"AddressLine2\": \"\",\n \"AddressLine3\": \"\",\n \"City\": \"Leeds\",\n \"County\": \"West Yorkshire\",\n \"PostCode\": \"LS1 1LS\",\n \"Country\": \"GBR\",\n \"PhoneNumber\": \"+447111111111\",\n \"HomePhoneNumber\": \"+441131111111\",\n \"Email\": \"noreply2@managemy.com\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/update/batch","description":"

Updates data on a customer record.

Multiple customers can be updated in a single API call, using the 'entityFieldValueModels' array structure.

A 'commmandName' parameter must be passed within each request in the array.

Either CustomerPublicId or CustomerReference (InsurerCustomerReference) can be used to key to the customer receiving the update.

By default, certain fields are validated as unique if passed in the call:

InsurerCustomerReference (a8c97a3ce9f74b8ca8228692950f4a7c) - this is the customer's Unique Reference Number (URN) used by the source system, that maps to CustomerPublicId (7ba9f6c52b004c9e89259408d70b1123) on the ManageMy platform.
Email (18973b0de8da498f8e8d02e36f95bf61) - this is the default login username and therefore must be unique. It cannot be changed to an email already allocated to another customer.
UniqueRegistrationId (1e4bd4813948408282d2860241636a8c) - this is used to allow customer to register without receiving a unique registration invite - e.g. via direct mail.

NB: where a field value is passed using the \"publicId\" as the field identifier, it is possible to instead use \"name\" and provide the field name to identify the field to be created/updated.

Fixed in this collection: corrected 'publicID' typo to 'publicId' for consistency (the API binds case-insensitively so the original worked, but the casing was inconsistent with every other example).

Updates details on specific policies.

Multiple policies can be created in a single API call, using the 'entityFieldValueModels' array structure.

'commmandName' must be passed within each object in the array.

By default, certain fields are validated as unique, if passed in the call:

Reference (fdd85e5c827449aa82e2d09af23cfed8) - this is the Insurer Policy ID used by the source system, that maps to PolicyPublicId (63f8127f6a6647948fcf8703d89adc53) on the ManageMy platform.

Either PolicyPublicId or Reference (Insurer Policy ID) can be used to key to the policy being updated.

NB: where a field value is passed using the \"publicId\" as the field identifier, it is possible to instead use \"name\" and provide the field name to identify the field to be created/updated.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}},"urlObject":{"path":["policy","update","batch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"47bd9d79-a902-409f-a45a-d20b6171b609","name":"Update Policy Details - Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"publicId\": \"\",\n \"reference\": \"Pol-001\",\n \"commandName\": \"ExternalApiUpdate\",\n \"values\": {\n \"Reference\": \"Pol-001\",\n \"CoverType\": \"Buildings & Contents\",\n \"StartDate\": \"01/01/2020\",\n \"EndDate\": \"31/12/2020\",\n \"AnnualPremium\": \"462.64\",\n \"PaymentFrequency\": \"Monthly\",\n \"MonthlyPayment\": \"42.49\",\n \"TotalAnnualPayment\": \"509.88\",\n \"CreditCharge\": \"47.24\",\n \"APR\": \"19.90\",\n \"InsuredPropertyAddressLine1\": \"10 Lime Street\",\n \"InsuredPropertyAddressLine2\": \"Langbourn\",\n \"InsuredPropertyAddressLine3\": \"\",\n \"InsuredPropertyCity\": \"London\",\n \"InsuredPropertyCounty\": \"\",\n \"InsuredPropertyPostCode\": \"EC3M 7AA\",\n \"InsuredPropertyCountry\": \"GBR\",\n \"PropertyType\": \"Detached House\",\n \"YearOfBuild\": \"1950\",\n \"NoBedrooms\": \"5\",\n \"NoBathrooms\": \"3\",\n \"WallConstruction\": \"Brick\",\n \"RoofConstruction\": \"Tile\",\n \"BurglarAlarm\": \"Yes\",\n \"SmokeDetector\": \"Yes\",\n \"ListedBuilding\": \"No\",\n \"400mOfWater\": \"No\",\n \"BuildingsClaimsInLast3Years\": \"0\",\n \"ContentsClaimsInLast3Years\": \"0\",\n \"Occupancy\": \"Policyholder\",\n \"Adults\": \"2\",\n \"Children\": \"2\",\n \"Unoccupied\": \"Up to 30 days\",\n \"BusinessUse\": \"None\",\n \"BuildingsCoverLimit\": \"Unlimited\",\n \"BuildingsAccidentalDamage\": \"Yes\",\n \"BuildingsExcess\": \"100\",\n \"SubsidenceExcess\": \"1000\",\n \"BuildingsEscapeOfWaterExcess\": \"350\",\n \"ContentsCoverLimit\": \"50000\",\n \"ContentsAccidentalDamage\": \"Yes\",\n \"ContentsClaimExcess\": \"100\",\n \"PersonalEffectsExcess\": \"50\",\n \"EscapeOfWaterExcess\": \"350\",\n \"CoverAwayFromTheHome\": \"5000\",\n \"SingleItemCoverLimit\": \"5000\",\n \"SpecifiedItems\": \"Yes\",\n \"SpecifiedCycles\": \"No\",\n \"FamilyLegalCover\": \"Yes\",\n \"HomeEmergencyCover\": \"No\",\n \"PolicyStatus\": \"Active\",\n \"PolicyholdersGroup\": {\n \"PolicyholderFullName\": \"Mr John Smith\",\n \"PolicyholderOccupation\": \"Head of Product\",\n \"PolicyholderBusiness\": \"InsurTech\"\n },\n \"SpecifiedItemsGroup\": {\n \"SpecifiedItemType\": \"Art\",\n \"SpecifiedItemDescription\": \"Banksy Painting\",\n \"SpecifiedItemValue\": \"165000\"\n }\n }\n },\n {\n \"productPublicId\": \"94ae1ca46427402db584b49bbac1dfea\",\n \"customerPublicId\": \"\",\n \"customerReference\": \"Test-002\",\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"Reference\": \"Pol-002\",\n \"CoverType\": \"Buildings & Contents\",\n \"StartDate\": \"01/01/2020\",\n \"EndDate\": \"31/12/2020\",\n \"AnnualPremium\": \"462.64\",\n \"PaymentFrequency\": \"Monthly\",\n \"MonthlyPayment\": \"42.49\",\n \"TotalAnnualPayment\": \"509.88\",\n \"CreditCharge\": \"47.24\",\n \"APR\": \"19.90\",\n \"InsuredPropertyAddressLine1\": \"10 Lime Street\",\n \"InsuredPropertyAddressLine2\": \"Langbourn\",\n \"InsuredPropertyAddressLine3\": \"\",\n \"InsuredPropertyCity\": \"London\",\n \"InsuredPropertyCounty\": \"\",\n \"InsuredPropertyPostCode\": \"EC3M 7AA\",\n \"InsuredPropertyCountry\": \"GBR\",\n \"PropertyType\": \"Detached House\",\n \"YearOfBuild\": \"1950\",\n \"NoBedrooms\": \"5\",\n \"NoBathrooms\": \"3\",\n \"WallConstruction\": \"Brick\",\n \"RoofConstruction\": \"Tile\",\n \"BurglarAlarm\": \"Yes\",\n \"SmokeDetector\": \"Yes\",\n \"ListedBuilding\": \"No\",\n \"400mOfWater\": \"No\",\n \"BuildingsClaimsInLast3Years\": \"0\",\n \"ContentsClaimsInLast3Years\": \"0\",\n \"Occupancy\": \"Policyholder\",\n \"Adults\": \"2\",\n \"Children\": \"2\",\n \"Unoccupied\": \"Up to 30 days\",\n \"BusinessUse\": \"None\",\n \"BuildingsCoverLimit\": \"Unlimited\",\n \"BuildingsAccidentalDamage\": \"Yes\",\n \"BuildingsExcess\": \"100\",\n \"SubsidenceExcess\": \"1000\",\n \"BuildingsEscapeOfWaterExcess\": \"350\",\n \"ContentsCoverLimit\": \"50000\",\n \"ContentsAccidentalDamage\": \"Yes\",\n \"ContentsClaimExcess\": \"100\",\n \"PersonalEffectsExcess\": \"50\",\n \"EscapeOfWaterExcess\": \"350\",\n \"CoverAwayFromTheHome\": \"5000\",\n \"SingleItemCoverLimit\": \"5000\",\n \"SpecifiedItems\": \"Yes\",\n \"SpecifiedCycles\": \"No\",\n \"FamilyLegalCover\": \"Yes\",\n \"HomeEmergencyCover\": \"No\",\n \"PolicyStatus\": \"Active\",\n \"PolicyholdersGroup\": {\n \"PolicyholderFullName\": \"Mrs Alice Jones \",\n \"PolicyholderOccupation\": \"Head of Development\",\n \"PolicyholderBusiness\": \"InsurTech\"\n },\n \"SpecifiedItemsGroup\": {\n \"SpecifiedItemType\": \"Art\",\n \"SpecifiedItemDescription\": \"Banksy Painting\",\n \"SpecifiedItemValue\": \"165000\"\n }\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/policy/update/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 25 Nov 2020 09:14:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"entitiesResult\": [\n {\n \"success\": true,\n \"publicId\": \"4c9466a84d4243eab445cd58150b7678\",\n \"reference\": \"Pol-001\"\n },\n {\n \"success\": true,\n \"publicId\": \"292410ee6aa6434885dc93eb0746c755\",\n \"reference\": \"Pol-002\"\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"5cb1385a-b2d5-482f-b1b7-57ed100f930d","name":"Update Policy Details - Failure - Uniqueness Validation Failure","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"publicId\": \"\",\n \"reference\": \"Pol-001\",\n \"commandName\": \"ExternalApiUpdate\",\n \"values\": {\n \"Reference\": \"Pol-002\",\n \"CoverType\": \"Buildings & Contents\",\n \"StartDate\": \"01/01/2020\",\n \"EndDate\": \"31/12/2020\",\n \"AnnualPremium\": \"462.64\",\n \"PaymentFrequency\": \"Monthly\",\n \"MonthlyPayment\": \"42.49\",\n \"TotalAnnualPayment\": \"509.88\",\n \"CreditCharge\": \"47.24\",\n \"APR\": \"19.90\",\n \"InsuredPropertyAddressLine1\": \"10 Lime Street\",\n \"InsuredPropertyAddressLine2\": \"Langbourn\",\n \"InsuredPropertyAddressLine3\": \"\",\n \"InsuredPropertyCity\": \"London\",\n \"InsuredPropertyCounty\": \"\",\n \"InsuredPropertyPostCode\": \"EC3M 7AA\",\n \"InsuredPropertyCountry\": \"GBR\",\n \"PropertyType\": \"Detached House\",\n \"YearOfBuild\": \"1950\",\n \"NoBedrooms\": \"5\",\n \"NoBathrooms\": \"3\",\n \"WallConstruction\": \"Brick\",\n \"RoofConstruction\": \"Tile\",\n \"BurglarAlarm\": \"Yes\",\n \"SmokeDetector\": \"Yes\",\n \"ListedBuilding\": \"No\",\n \"400mOfWater\": \"No\",\n \"BuildingsClaimsInLast3Years\": \"0\",\n \"ContentsClaimsInLast3Years\": \"0\",\n \"Occupancy\": \"Policyholder\",\n \"Adults\": \"2\",\n \"Children\": \"2\",\n \"Unoccupied\": \"Up to 30 days\",\n \"BusinessUse\": \"None\",\n \"BuildingsCoverLimit\": \"Unlimited\",\n \"BuildingsAccidentalDamage\": \"Yes\",\n \"BuildingsExcess\": \"100\",\n \"SubsidenceExcess\": \"1000\",\n \"BuildingsEscapeOfWaterExcess\": \"350\",\n \"ContentsCoverLimit\": \"50000\",\n \"ContentsAccidentalDamage\": \"Yes\",\n \"ContentsClaimExcess\": \"100\",\n \"PersonalEffectsExcess\": \"50\",\n \"EscapeOfWaterExcess\": \"350\",\n \"CoverAwayFromTheHome\": \"5000\",\n \"SingleItemCoverLimit\": \"5000\",\n \"SpecifiedItems\": \"Yes\",\n \"SpecifiedCycles\": \"No\",\n \"FamilyLegalCover\": \"Yes\",\n \"HomeEmergencyCover\": \"No\",\n \"PolicyStatus\": \"Active\",\n \"PolicyholdersGroup\": {\n \"PolicyholderFullName\": \"Mr John Smith\",\n \"PolicyholderOccupation\": \"Head of Product\",\n \"PolicyholderBusiness\": \"InsurTech\"\n },\n \"SpecifiedItemsGroup\": {\n \"SpecifiedItemType\": \"Art\",\n \"SpecifiedItemDescription\": \"Banksy Painting\",\n \"SpecifiedItemValue\": \"165000\"\n }\n }\n },\n {\n \"productPublicId\": \"94ae1ca46427402db584b49bbac1dfea\",\n \"customerPublicId\": \"\",\n \"customerReference\": \"Pol-002\",\n \"commandName\": \"ExternalApiUpdate\",\n \"values\": {\n \"Reference\": \"Pol-001\",\n \"CoverType\": \"Buildings & Contents\",\n \"StartDate\": \"01/01/2020\",\n \"EndDate\": \"31/12/2020\",\n \"AnnualPremium\": \"462.64\",\n \"PaymentFrequency\": \"Monthly\",\n \"MonthlyPayment\": \"42.49\",\n \"TotalAnnualPayment\": \"509.88\",\n \"CreditCharge\": \"47.24\",\n \"APR\": \"19.90\",\n \"InsuredPropertyAddressLine1\": \"10 Lime Street\",\n \"InsuredPropertyAddressLine2\": \"Langbourn\",\n \"InsuredPropertyAddressLine3\": \"\",\n \"InsuredPropertyCity\": \"London\",\n \"InsuredPropertyCounty\": \"\",\n \"InsuredPropertyPostCode\": \"EC3M 7AA\",\n \"InsuredPropertyCountry\": \"GBR\",\n \"PropertyType\": \"Detached House\",\n \"YearOfBuild\": \"1950\",\n \"NoBedrooms\": \"5\",\n \"NoBathrooms\": \"3\",\n \"WallConstruction\": \"Brick\",\n \"RoofConstruction\": \"Tile\",\n \"BurglarAlarm\": \"Yes\",\n \"SmokeDetector\": \"Yes\",\n \"ListedBuilding\": \"No\",\n \"400mOfWater\": \"No\",\n \"BuildingsClaimsInLast3Years\": \"0\",\n \"ContentsClaimsInLast3Years\": \"0\",\n \"Occupancy\": \"Policyholder\",\n \"Adults\": \"2\",\n \"Children\": \"2\",\n \"Unoccupied\": \"Up to 30 days\",\n \"BusinessUse\": \"None\",\n \"BuildingsCoverLimit\": \"Unlimited\",\n \"BuildingsAccidentalDamage\": \"Yes\",\n \"BuildingsExcess\": \"100\",\n \"SubsidenceExcess\": \"1000\",\n \"BuildingsEscapeOfWaterExcess\": \"350\",\n \"ContentsCoverLimit\": \"50000\",\n \"ContentsAccidentalDamage\": \"Yes\",\n \"ContentsClaimExcess\": \"100\",\n \"PersonalEffectsExcess\": \"50\",\n \"EscapeOfWaterExcess\": \"350\",\n \"CoverAwayFromTheHome\": \"5000\",\n \"SingleItemCoverLimit\": \"5000\",\n \"SpecifiedItems\": \"Yes\",\n \"SpecifiedCycles\": \"No\",\n \"FamilyLegalCover\": \"Yes\",\n \"HomeEmergencyCover\": \"No\",\n \"PolicyStatus\": \"Active\",\n \"PolicyholdersGroup\": {\n \"PolicyholderFullName\": \"Mrs Alice Jones \",\n \"PolicyholderOccupation\": \"Head of Development\",\n \"PolicyholderBusiness\": \"InsurTech\"\n },\n \"SpecifiedItemsGroup\": {\n \"SpecifiedItemType\": \"Art\",\n \"SpecifiedItemDescription\": \"Banksy Painting\",\n \"SpecifiedItemValue\": \"165000\"\n }\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/policy/update/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 25 Nov 2020 09:15:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"entitiesResult\": [\n {\n \"success\": false,\n \"reference\": \"Pol-001\",\n \"validationErrors\": [\n {\n \"field\": \"Reference\",\n \"message\": \"The Policy Reference 'Pol-002' has already been used for a different policy - please use a different Policy Reference.\"\n }\n ]\n },\n {\n \"success\": false,\n \"reference\": \"Pol-001\",\n \"validationErrors\": [\n {\n \"field\": \"Reference\",\n \"message\": \"The Policy Reference 'Pol-001' has already been used for a different policy - please use a different Policy Reference.\"\n }\n ]\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"83d0acfa-c5c1-4e7d-b63c-1f6e8bca2f43","name":"Update Policy Details - Mixed Response - Success and Failures","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"publicId\": \"\",\n \"reference\": \"Pol-001\",\n \"commandName\": \"ExternalApiUpdate\",\n \"values\": {\n \"Reference\": \"Pol-001\",\n \"CoverType\": \"Buildings & Contents\",\n \"StartDate\": \"\",\n \"EndDate\": \"31/12/2020\",\n \"AnnualPremium\": \"462.64\",\n \"PaymentFrequency\": \"Monthly\",\n \"MonthlyPayment\": \"42.49\",\n \"TotalAnnualPayment\": \"509.88\",\n \"CreditCharge\": \"47.24\",\n \"APR\": \"19.90\",\n \"InsuredPropertyAddressLine1\": \"10 Lime Street\",\n \"InsuredPropertyAddressLine2\": \"Langbourn\",\n \"InsuredPropertyAddressLine3\": \"\",\n \"InsuredPropertyCity\": \"London\",\n \"InsuredPropertyCounty\": \"\",\n \"InsuredPropertyPostCode\": \"EC3M 7AA\",\n \"InsuredPropertyCountry\": \"GBR\",\n \"PropertyType\": \"Detached House\",\n \"YearOfBuild\": \"1950\",\n \"NoBedrooms\": \"5\",\n \"NoBathrooms\": \"3\",\n \"WallConstruction\": \"Brick\",\n \"RoofConstruction\": \"Tile\",\n \"BurglarAlarm\": \"Yes\",\n \"SmokeDetector\": \"Yes\",\n \"ListedBuilding\": \"No\",\n \"400mOfWater\": \"No\",\n \"BuildingsClaimsInLast3Years\": \"0\",\n \"ContentsClaimsInLast3Years\": \"0\",\n \"Occupancy\": \"Policyholder\",\n \"Adults\": \"2\",\n \"Children\": \"2\",\n \"Unoccupied\": \"Up to 30 days\",\n \"BusinessUse\": \"None\",\n \"BuildingsCoverLimit\": \"Unlimited\",\n \"BuildingsAccidentalDamage\": \"Yes\",\n \"BuildingsExcess\": \"100\",\n \"SubsidenceExcess\": \"1000\",\n \"BuildingsEscapeOfWaterExcess\": \"350\",\n \"ContentsCoverLimit\": \"50000\",\n \"ContentsAccidentalDamage\": \"Yes\",\n \"ContentsClaimExcess\": \"100\",\n \"PersonalEffectsExcess\": \"50\",\n \"EscapeOfWaterExcess\": \"350\",\n \"CoverAwayFromTheHome\": \"5000\",\n \"SingleItemCoverLimit\": \"5000\",\n \"SpecifiedItems\": \"Yes\",\n \"SpecifiedCycles\": \"No\",\n \"FamilyLegalCover\": \"Yes\",\n \"HomeEmergencyCover\": \"No\",\n \"PolicyStatus\": \"Active\",\n \"PolicyholdersGroup\": {\n \"PolicyholderFullName\": \"Mr John Smith\",\n \"PolicyholderOccupation\": \"Head of Product\",\n \"PolicyholderBusiness\": \"InsurTech\"\n },\n \"SpecifiedItemsGroup\": {\n \"SpecifiedItemType\": \"Art\",\n \"SpecifiedItemDescription\": \"Banksy Painting\",\n \"SpecifiedItemValue\": \"165000\"\n }\n }\n },\n {\n \"productPublicId\": \"94ae1ca46427402db584b49bbac1dfea\",\n \"customerPublicId\": \"\",\n \"customerReference\": \"Pol-002\",\n \"commandName\": \"ExternalApiUpdate\",\n \"values\": {\n \"Reference\": \"Pol-002\",\n \"CoverType\": \"Buildings & Contents\",\n \"StartDate\": \"01/01/2020\",\n \"EndDate\": \"31/12/2020\",\n \"AnnualPremium\": \"462.64\",\n \"PaymentFrequency\": \"Monthly\",\n \"MonthlyPayment\": \"42.49\",\n \"TotalAnnualPayment\": \"509.88\",\n \"CreditCharge\": \"47.24\",\n \"APR\": \"19.90\",\n \"InsuredPropertyAddressLine1\": \"10 Lime Street\",\n \"InsuredPropertyAddressLine2\": \"Langbourn\",\n \"InsuredPropertyAddressLine3\": \"\",\n \"InsuredPropertyCity\": \"London\",\n \"InsuredPropertyCounty\": \"\",\n \"InsuredPropertyPostCode\": \"EC3M 7AA\",\n \"InsuredPropertyCountry\": \"GBR\",\n \"PropertyType\": \"Detached House\",\n \"YearOfBuild\": \"1950\",\n \"NoBedrooms\": \"5\",\n \"NoBathrooms\": \"3\",\n \"WallConstruction\": \"Brick\",\n \"RoofConstruction\": \"Tile\",\n \"BurglarAlarm\": \"Yes\",\n \"SmokeDetector\": \"Yes\",\n \"ListedBuilding\": \"No\",\n \"400mOfWater\": \"No\",\n \"BuildingsClaimsInLast3Years\": \"0\",\n \"ContentsClaimsInLast3Years\": \"0\",\n \"Occupancy\": \"Policyholder\",\n \"Adults\": \"2\",\n \"Children\": \"2\",\n \"Unoccupied\": \"Up to 30 days\",\n \"BusinessUse\": \"None\",\n \"BuildingsCoverLimit\": \"Unlimited\",\n \"BuildingsAccidentalDamage\": \"Yes\",\n \"BuildingsExcess\": \"100\",\n \"SubsidenceExcess\": \"1000\",\n \"BuildingsEscapeOfWaterExcess\": \"350\",\n \"ContentsCoverLimit\": \"50000\",\n \"ContentsAccidentalDamage\": \"Yes\",\n \"ContentsClaimExcess\": \"100\",\n \"PersonalEffectsExcess\": \"50\",\n \"EscapeOfWaterExcess\": \"350\",\n \"CoverAwayFromTheHome\": \"5000\",\n \"SingleItemCoverLimit\": \"5000\",\n \"SpecifiedItems\": \"Yes\",\n \"SpecifiedCycles\": \"No\",\n \"FamilyLegalCover\": \"Yes\",\n \"HomeEmergencyCover\": \"No\",\n \"PolicyStatus\": \"Active\",\n \"PolicyholdersGroup\": {\n \"PolicyholderFullName\": \"Mrs Alice Jones \",\n \"PolicyholderOccupation\": \"Head of Development\",\n \"PolicyholderBusiness\": \"InsurTech\"\n },\n \"SpecifiedItemsGroup\": {\n \"SpecifiedItemType\": \"Art\",\n \"SpecifiedItemDescription\": \"Banksy Painting\",\n \"SpecifiedItemValue\": \"165000\"\n }\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/policy/update/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 25 Nov 2020 09:19:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"entitiesResult\": [\n {\n \"success\": false,\n \"publicId\": \"4c9466a84d4243eab445cd58150b7678\",\n \"reference\": \"Pol-001\",\n \"validationErrors\": [\n {\n \"field\": \"StartDate\",\n \"message\": \"Please enter the Start Date\"\n }\n ]\n },\n {\n \"success\": true,\n \"publicId\": \"292410ee6aa6434885dc93eb0746c755\",\n \"reference\": \"Pol-002\"\n }\n ]\n },\n \"isSuccess\": true\n}"}],"_postman_id":"15c6499c-51a4-4e58-a44e-4af15eb408fb"},{"name":"Manage Customer Access","id":"ad27b163-fa54-43c9-9b0a-680eb87de40d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"commandName\": \"ApiSuspendCustomer\",\n \"publicId\": \"\",\n \"reference\": \"Test-001\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/change-state","description":"

Allows customer accounts to be suspended, re-enabled or archived.

Either CustomerPublicId or CustomerReference (InsurerCustomerReference) can be used to key to the customer receiving the update.

The required command must be passed in the 'commandName' field:

\"ApiSuspendCustomer\" - suspends customer access to their account.
\"ApiReenableCustomer\" - re-enables access for customers that have previous been suspended.
\"ApiArchiveCustomer\" - removed access permanently. This action cannot be undone.

APIs used to update customers, policies and documents throughout their lifecycle.

\n","_postman_id":"5f18ad44-3497-43b5-840c-cccdce118ab0","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Deletions","item":[{"name":"Delete Customers","id":"0c866b48-fd1b-4cbb-ad99-570f2fba8b55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entities\": [\n {\n \"reference\": \"Test-260\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/delete/batch","description":"

Can be used to delete one or more customer accounts from the ManageMy platform.

Deletion of the customer account also deletes and policies, documents, and other entities (such as claims) attached to the customer account.

CustomerPublicID (publicId) or InsurerCustomerReference (reference) can be used to key to the customer records being deleted.

Can be used to delete one or more policies from the ManageMy platform.

Deletion of the policy also deletes any documents and other entities (such as claims) attached to the policy.

PolicyPublicID (publicId) or Reference (reference) can be used to key to the policies being deleted.

Can be used to delete one or more documents from an entity on the ManageMy platform.

entityPublicID (e.g. policyPublicId) or entityReference (e.g. Insurer policy ID / reference) can be used to key to the entity the documents are attached to.

documentPublicIdList or documentReferenceList can be used to delete specific documents attached to the entity.

If documentPublicIdList and documentReferenceList are blank, all documents attached to the entity will be deleted.

APIs used to delete customer and policy data and documents from the ManageMy platform.

\n","_postman_id":"91854308-f9a1-4d95-bf5a-a51518beee96","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Reading Data","item":[{"name":"All Customers List","id":"645e25ef-4e49-421b-b1d3-4ea9bf9d7dfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/customer/read/list?pageSize=&pageIndex=","description":"

Gets a list of all customers on the ManageMy Platform, their status and any policies linked to their account.

Retrieves the data stored on a specified customer record.

Either Customer Public ID (publicId) or Insurer Customer Reference (reference) must be supplied.

A JSON Form is also returned at the end of the request, to allow the key-value pairs to be read.

The PublicID of the customer record.

\n","type":"text/plain"},"key":"publicId","value":""},{"description":{"content":"

The Insurer Customer Reference for the customer record.

\n","type":"text/plain"},"key":"reference","value":"Test-001"}],"variable":[]}},"response":[{"id":"36aa9d8f-7b79-4331-a80d-ec604ee1000f","name":"Read Customer Details - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/customer/read/?publicId=&reference=Test-001","host":["{{base_url}}"],"path":["customer","read",""],"query":[{"key":"publicId","value":"","description":"The PublicID of the customer record."},{"key":"reference","value":"Test-001","description":"The Insurer Customer Reference for the customer record."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Nov 2020 11:14:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"reference\": \"Test-001\",\n \"publicId\": \"b93a95995dc94a249bd11d0cf09e74ae\",\n \"fieldValues\": [\n {\n \"publicId\": \"b43c4236359645ca81208733357ff7c9\",\n \"value\": \"Mr\"\n },\n {\n \"publicId\": \"c6739ac3200948c5af020eac016f3c26\",\n \"value\": \"John\"\n },\n {\n \"publicId\": \"64b54e6fe80c42df8d3ccf70e2d4c5ef\",\n \"value\": \"R\"\n },\n {\n \"publicId\": \"2097b0bbdd8b45cc88c86d11144065f1\",\n \"value\": \"Smith\"\n },\n {\n \"publicId\": \"02bf84b1f6034c8cada5258329f57805\",\n \"value\": \"1969-01-01\"\n },\n {\n \"publicId\": \"7912c385e5344e159e73c7e71c153af8\",\n \"value\": \"Apartment 17\"\n },\n {\n \"publicId\": \"566a3f1c837f474b8618bf7c9e976e63\",\n \"value\": \"1 ManageMy Towers\"\n },\n {\n \"publicId\": \"e5f433cf77d94713b637eb80bde4e68c\",\n \"value\": \"Square Mile\"\n },\n {\n \"publicId\": \"3c231611a84e4944b9d67ebb4ce52556\",\n \"value\": \"London\"\n },\n {\n \"publicId\": \"ccf5b21071e24e5bb82620fc9635ca2d\",\n \"value\": \"Greater London\"\n },\n {\n \"publicId\": \"26c349a53e7c4bf5a0824e4b61aafc7e\",\n \"value\": \"E1 1AB\"\n },\n {\n \"publicId\": \"a7198856e43941dc900285a9ca4fb2f0\",\n \"value\": \"GBR\"\n },\n {\n \"publicId\": \"d7b7170ab5c74596a5ec49fd0483618f\",\n \"value\": \"+447777777777\"\n },\n {\n \"publicId\": \"9d5370ffd30d4674a84278df70e97bd1\",\n \"value\": \"+441011111111\"\n },\n {\n \"publicId\": \"18973b0de8da498f8e8d02e36f95bf61\",\n \"value\": \"noreply@managemy.com\"\n },\n {\n \"publicId\": \"0a95ad6542674072b34e7079bb728e17\",\n \"value\": \"Unregistered\"\n }\n ],\n \"form\": {\n \"publicId\": \"03b4b10f300d4261975b0df75890a6dc\",\n \"name\": \"External API - Customer Profile View Form\",\n \"pages\": [\n {\n \"name\": \"Customer Profile View\",\n \"fields\": [\n {\n \"publicId\": \"b43c4236359645ca81208733357ff7c9\",\n \"name\": \"PersonTitle\",\n \"type\": \"label\",\n \"options\": {\n \"label\": \"Title\"\n }\n },\n {\n \"publicId\": \"c6739ac3200948c5af020eac016f3c26\",\n \"name\": \"FirstName\",\n \"type\": \"label\",\n \"options\": {\n \"label\": \"First Name\"\n }\n },\n {\n \"publicId\": \"64b54e6fe80c42df8d3ccf70e2d4c5ef\",\n \"name\": \"MiddleName\",\n \"type\": \"label\",\n \"options\": {\n \"label\": \"Middle Name\"\n }\n },\n {\n \"publicId\": \"2097b0bbdd8b45cc88c86d11144065f1\",\n \"name\": \"LastName\",\n \"type\": \"label\",\n \"options\": {\n \"label\": \"Last Name\"\n }\n },\n {\n \"publicId\": \"02bf84b1f6034c8cada5258329f57805\",\n \"name\": \"DateOfBirth\",\n \"type\": \"label\",\n \"options\": {\n \"label\": \"Date Of Birth\"\n }\n },\n {\n \"publicId\": \"7912c385e5344e159e73c7e71c153af8\",\n \"name\": \"Address\",\n \"type\": \"label\",\n \"options\": {\n \"label\": \"Address\"\n }\n },\n {\n \"publicId\": \"566a3f1c837f474b8618bf7c9e976e63\",\n \"name\": \"AddressLine2\",\n \"type\": \"label\",\n \"options\": {\n \"label\": \"Address Line 2\"\n }\n },\n {\n \"publicId\": \"e5f433cf77d94713b637eb80bde4e68c\",\n \"name\": \"AddressLine3\",\n \"type\": \"label\",\n \"options\": {\n \"label\": \"Address Line 3\"\n }\n },\n {\n \"publicId\": \"3c231611a84e4944b9d67ebb4ce52556\",\n \"name\": \"City\",\n \"type\": \"label\",\n \"options\": {\n \"label\": \"City\"\n }\n },\n {\n \"publicId\": \"ccf5b21071e24e5bb82620fc9635ca2d\",\n \"name\": \"County\",\n \"type\": \"label\",\n \"options\": {\n \"label\": \"County\"\n }\n },\n {\n \"publicId\": \"26c349a53e7c4bf5a0824e4b61aafc7e\",\n \"name\": \"PostCode\",\n \"type\": \"label\",\n \"options\": {\n \"label\": \"Post Code\"\n }\n },\n {\n \"publicId\": \"a7198856e43941dc900285a9ca4fb2f0\",\n \"name\": \"Country\",\n \"type\": \"label\",\n \"options\": {\n \"label\": \"Country\",\n \"selectOptions\": [\n {\n \"value\": \"GBR\",\n \"text\": \"United Kingdom\"\n },\n {\n \"value\": \"USA\",\n \"text\": \"United States\"\n },\n {\n \"value\": \"OTH\",\n \"text\": \"Other\"\n }\n ]\n }\n },\n {\n \"publicId\": \"d7b7170ab5c74596a5ec49fd0483618f\",\n \"name\": \"PhoneNumber\",\n \"type\": \"label\",\n \"options\": {\n \"label\": \"Phone Number\"\n }\n },\n {\n \"publicId\": \"9d5370ffd30d4674a84278df70e97bd1\",\n \"name\": \"HomePhoneNumber\",\n \"type\": \"label\",\n \"options\": {\n \"label\": \"Home Phone Number\"\n }\n },\n {\n \"publicId\": \"18973b0de8da498f8e8d02e36f95bf61\",\n \"name\": \"Email\",\n \"type\": \"label\",\n \"options\": {\n \"label\": \"Email\"\n }\n },\n {\n \"publicId\": \"0a95ad6542674072b34e7079bb728e17\",\n \"name\": \"Status\",\n \"type\": \"label\",\n \"options\": {\n \"label\": \"Status\"\n }\n },\n {\n \"publicId\": \"28bb3c12c081457fb061c9423417de6f\",\n \"name\": \"CustomerInviteReason\",\n \"type\": \"label\",\n \"options\": {\n \"label\": \"CustomerInviteReason\",\n \"selectOptions\": [\n {\n \"value\": \"NewCustomer\",\n \"text\": \"NewCustomer\"\n },\n {\n \"value\": \"ExistingCustomer\",\n \"text\": \"ExistingCustomer\"\n },\n {\n \"value\": \"Renewal\",\n \"text\": \"Renewal\"\n },\n {\n \"value\": \"Claim\",\n \"text\": \"Claim\"\n }\n ]\n }\n },\n {\n \"publicId\": \"3fa5ec015bfa4f2aa9405f8b74d863ac\",\n \"name\": \"InvitationMethod\",\n \"type\": \"select\",\n \"options\": {\n \"selectType\": \"checkbox\",\n \"readonly\": true,\n \"selectOptions\": [\n {\n \"value\": \"SMS\",\n \"text\": \"SMS\"\n },\n {\n \"value\": \"Email\",\n \"text\": \"Email\"\n }\n ],\n \"selectMultiple\": true\n }\n },\n {\n \"publicId\": \"b9d9e1a303104bc79fc3c9b43112fc47\",\n \"name\": \"MarketingConsents\",\n \"type\": \"select\",\n \"options\": {\n \"selectType\": \"checkbox\",\n \"readonly\": true,\n \"selectOptions\": [\n {\n \"value\": \"Email\",\n \"text\": \"Email\"\n },\n {\n \"value\": \"Phone\",\n \"text\": \"Phone\"\n },\n {\n \"value\": \"SMS\",\n \"text\": \"SMS\"\n },\n {\n \"value\": \"Post\",\n \"text\": \"Post\"\n }\n ],\n \"selectMultiple\": true\n }\n }\n ]\n }\n ],\n \"showFooter\": true\n }\n },\n \"isSuccess\": true\n}"},{"id":"f28e6fbe-a8c2-40c0-ae2c-fd9a0784f565","name":"Read Customer Details - Failure - Customer Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/customer/read/?publicId=&reference=Test-0010","host":["{{base_url}}"],"path":["customer","read",""],"query":[{"key":"publicId","value":"","description":"The PublicID of the customer record."},{"key":"reference","value":"Test-0010","description":"The Insurer Customer Reference for the customer record."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Nov 2020 11:15:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": false,\n \"failure\": {\n \"message\": \"Customer with Public Id or Reference Test-0010 doesn't exist\"\n }\n}"}],"_postman_id":"fb905018-cacc-4a38-a2bc-8ef154d3dddd"},{"name":"All Policies List","id":"60cb8a8b-136f-44a9-9e0b-ace33678aa84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/policy/read/list?pageSize=&pageIndex=","description":"

Gets a list of all policies on the ManageMy Platform, and their status.

The number of results to provide in the response. If blank, defaults to 1000.

\n","type":"text/plain"},"key":"pageSize","value":""},{"description":{"content":"

The results page to be returned, taking the pageSize parameter into account. If blanks, defaults to the first page.

\n","type":"text/plain"},"key":"pageIndex","value":""}],"variable":[]}},"response":[{"id":"a39496b3-8956-44e5-abd7-eecf094ff7a8","name":"All Policies List - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/policy/read/list?pageSize=10&pageIndex=1","host":["{{base_url}}"],"path":["policy","read","list"],"query":[{"key":"pageSize","value":"10"},{"key":"pageIndex","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Nov 2020 11:17:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"items\": [\n {\n \"publicId\": \"85c852e196704621afad2de026a45997\",\n \"reference\": \"MM23657\",\n \"status\": \"Active\"\n },\n {\n \"publicId\": \"a5058b9a37d4463da88e3f8d8d7e02c6\",\n \"reference\": \"5150-OU812\",\n \"status\": \"Active\"\n },\n {\n \"publicId\": \"759d9e695ea847939c0185da1254c540\",\n \"reference\": \"5150-OU789\",\n \"status\": \"Active\"\n },\n {\n \"publicId\": \"0b01213ac1804f4fa69f153c6a70c181\",\n \"reference\": \"DB2273BB\",\n \"status\": \"Active\"\n },\n {\n \"publicId\": \"68c918e18a0b4683805a70f92661e07d\",\n \"reference\": \"MM23657\",\n \"status\": \"Active\"\n },\n {\n \"publicId\": \"4af39e8b8b6c431a88cef683cfe0e395\",\n \"reference\": \"5482DBF2\",\n \"status\": \"Active\"\n },\n {\n \"publicId\": \"43e79f7a098644d29717410f3bc016c1\",\n \"reference\": \"MM23657\",\n \"status\": \"Active\"\n },\n {\n \"publicId\": \"ee693fcfc4824fcead67db2507922f50\",\n \"reference\": \"MM23657\",\n \"status\": \"Active\"\n },\n {\n \"publicId\": \"b7447865bb0c4e9681d1e09f69e9a215\",\n \"reference\": \"6F7ABB9A\",\n \"status\": \"Active\"\n },\n {\n \"publicId\": \"03815c5c8a054ff1819c569a832de972\",\n \"reference\": \"91170A81\",\n \"status\": \"Active\"\n }\n ],\n \"count\": 46\n },\n \"isSuccess\": true\n}"}],"_postman_id":"60cb8a8b-136f-44a9-9e0b-ace33678aa84"},{"name":"Read Policy Details","id":"e19f8278-f823-4f56-b968-4522aa1c51fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/policy/read?publicId=&reference=Pol-001","description":"

Retrieves the data stored on a specified policy record.

Either Policy Public ID (publicId) or Insurer Policy ID (reference) must be supplied.

A JSON Form is also returned at the end of the request, to allow the key-value pairs to be read.

The PublicID of the customer record.

\n","type":"text/plain"},"key":"publicId","value":""},{"description":{"content":"

The Insurer Policy ID for the policy.

\n","type":"text/plain"},"key":"reference","value":"Pol-001"}],"variable":[]}},"response":[{"id":"43ae91c8-5d41-44de-9f51-19e3b9dbc9f3","name":"Read Policy Details - Success","originalRequest":{"method":"GET","header":[{"key":"publicId","type":"text","value":"6cd188c0af80458bb71652fe228f4bd4","disabled":true},{"key":"reference","type":"text","value":"","disabled":true}],"url":{"raw":"{{base_url}}/policy/read?publicId=&reference=Pol-001","host":["{{base_url}}"],"path":["policy","read"],"query":[{"key":"publicId","value":"","description":"The PublicID of the customer record."},{"key":"reference","value":"Pol-001","description":"The Insurer Policy ID for the policy."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Nov 2020 11:27:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"reference\": \"Pol-001\",\n \"publicId\": \"edeabfaa3ffb434ea03fe3e8392998a8\",\n \"fieldValues\": [\n {\n \"publicId\": \"fdd85e5c827449aa82e2d09af23cfed8\",\n \"value\": \"Pol-001\"\n },\n {\n \"publicId\": \"186b0301eac24f74b4da98a60f3e871a\",\n \"value\": \"Active\"\n },\n {\n \"publicId\": \"29ce174b9ad744279b26fe80633155fc\",\n \"value\": \"Buildings & Contents\"\n },\n {\n \"publicId\": \"8cf22861fe294d02b284faa5278db081\",\n \"value\": \"2020-01-01\"\n },\n {\n \"publicId\": \"bd487b2b9598458c949a9272ac8d8041\",\n \"value\": \"2020-12-31\"\n },\n {\n \"publicId\": \"def625ab6b68436bb0efd809dc79464c\",\n \"value\": \"462.64\"\n },\n {\n \"publicId\": \"5ccbee73caa44f13975c43dc78b6a1d0\",\n \"value\": \"Monthly\"\n },\n {\n \"publicId\": \"d608358d2c3e4d05926780f7ed153bbf\",\n \"value\": \"42.49\"\n },\n {\n \"publicId\": \"0cb7f4998c0d46e6a0fb9f70a618f7d7\",\n \"value\": \"509.88\"\n },\n {\n \"publicId\": \"b9c2dee846c64c0eba775b3c9ef26a3d\",\n \"value\": \"47.24\"\n },\n {\n \"publicId\": \"bab6949b0cc040179dfb2a2829b618f8\",\n \"value\": \"19.90\"\n },\n {\n \"publicId\": \"1c8e7fe07c134edf994178d0a2b668fe\",\n \"value\": \"Mr John Smith\",\n \"groupIndex\": 0,\n \"groupFieldPublicId\": \"31ce5e268cb64cbbbad054e8fdd5152b\"\n },\n {\n \"publicId\": \"ac18246b846c410bb30af108c7409198\",\n \"value\": \"Head of Product\",\n \"groupIndex\": 0,\n \"groupFieldPublicId\": \"31ce5e268cb64cbbbad054e8fdd5152b\"\n },\n {\n \"publicId\": \"b3438754bb2446be85929f5366dbf2c6\",\n \"value\": \"InsurTech\",\n \"groupIndex\": 0,\n \"groupFieldPublicId\": \"31ce5e268cb64cbbbad054e8fdd5152b\"\n },\n {\n \"publicId\": \"fa5335584845417faeaef1646ca9ad3e\",\n \"value\": \"10 Lime Street\"\n },\n {\n \"publicId\": \"52bb7ae75c1f48c0942206a46f9eb668\",\n \"value\": \"Langbourn\"\n },\n {\n \"publicId\": \"a33ac17a33a044639914a7f62eea7d4a\",\n \"value\": \"\"\n },\n {\n \"publicId\": \"3311eb4b13d746439dbaabac327a374e\",\n \"value\": \"\"\n },\n {\n \"publicId\": \"fb6e0db330f7454fb23760d4a439a814\",\n \"value\": \"EC3M 7AA\"\n },\n {\n \"publicId\": \"07e1d066ba93492298f4e30e8f0745d4\",\n \"value\": \"GBR\"\n },\n {\n \"publicId\": \"843300e3b1414f948f0f4ded9034a961\",\n \"value\": \"Detached House\"\n },\n {\n \"publicId\": \"cd4e887f057e450fbf664e15781db3e9\",\n \"value\": \"1950\"\n },\n {\n \"publicId\": \"a641da47dc3d4aefb79397d1ceefb87a\",\n \"value\": \"5\"\n },\n {\n \"publicId\": \"9051c11bf769409cb0fdeb1fed05e036\",\n \"value\": \"3\"\n },\n {\n \"publicId\": \"f290ea2fbf4b431f814e00393a007d49\",\n \"value\": \"Brick\"\n },\n {\n \"publicId\": \"1edec6140c934d5fb77d448ca7a58bf1\",\n \"value\": \"Yes\"\n },\n {\n \"publicId\": \"bff46c34c8d84d178e5163712b580c1b\",\n \"value\": \"Yes\"\n },\n {\n \"publicId\": \"306b19a888a3442dbfa833a4f4fbc369\",\n \"value\": \"No\"\n },\n {\n \"publicId\": \"7ca581bb91dd4427ad8f2d861bd6e747\",\n \"value\": \"No\"\n },\n {\n \"publicId\": \"6d45e016ede44643b895edffb6eb6886\",\n \"value\": \"0\"\n },\n {\n \"publicId\": \"48119d84259f47a4b64fdfd9a68018da\",\n \"value\": \"0\"\n },\n {\n \"publicId\": \"88a1501e02c14b499f8f5b376324f5c0\",\n \"value\": \"Policyholder\"\n },\n {\n \"publicId\": \"10c42c67365644cd93a574a5b6c0e357\",\n \"value\": \"2\"\n },\n {\n \"publicId\": \"9392d26b0c2c4810ae5d5a136d3e56f4\",\n \"value\": \"2\"\n },\n {\n \"publicId\": \"0cb34d157f134c1ca82a5074923864a6\",\n \"value\": \"Up to 30 days\"\n },\n {\n \"publicId\": \"f5ee351af37642eeb5b8757cb04206a2\",\n \"value\": \"None\"\n },\n {\n \"publicId\": \"67cfabf474fd4e859c7af3c2210947be\",\n \"value\": \"Unlimited\"\n },\n {\n \"publicId\": \"edd3f6d4b979446cb2cd76e6df8bb11f\",\n \"value\": \"Yes\"\n },\n {\n \"publicId\": \"5ef429a2e3fa42bbaa74146d34137e10\",\n \"value\": \"100\"\n },\n {\n \"publicId\": \"1688c88525514e00a2d2129508a474b6\",\n \"value\": \"1000\"\n },\n {\n \"publicId\": \"54d09afc045247d0a10eb873b5d21174\",\n \"value\": \"350\"\n },\n {\n \"publicId\": \"65b62a8af491472b8c432b4f8ef9ba56\",\n \"value\": \"50000\"\n },\n {\n \"publicId\": \"4344a3e3c3a0441b98d8b861592cd503\",\n \"value\": \"Yes\"\n },\n {\n \"publicId\": \"997d1b6d4ec34dbfaccac8a9a157af56\",\n \"value\": \"100\"\n },\n {\n \"publicId\": \"7a3f6a4c975946a28fa194e403d488c2\",\n \"value\": \"50\"\n },\n {\n \"publicId\": \"7d23adca81aa4f99b4d95624ac7c830c\",\n \"value\": \"350\"\n },\n {\n \"publicId\": \"363d6e454803490ba2cd0c9d68274655\",\n \"value\": \"5000\"\n },\n {\n \"publicId\": \"fad109b67a704e5c8516b93e5a813ed8\",\n \"value\": \"5000\"\n },\n {\n \"publicId\": \"930585088c624f6994c595703f59730c\",\n \"value\": \"Yes\"\n },\n {\n \"publicId\": \"0a6165bbe3504ce6a471cbddcd293b55\",\n \"value\": \"No\"\n },\n {\n \"publicId\": \"4f666c0b85ae497f9c2f26ccf88f54eb\",\n \"value\": \"Art\",\n \"groupIndex\": 0,\n \"groupFieldPublicId\": \"29f4b7d599004a6590f2610aafbae288\"\n },\n {\n \"publicId\": \"731b963a5556493797e8b7fcc3cf9b66\",\n \"value\": \"Banksy Painting\",\n \"groupIndex\": 0,\n \"groupFieldPublicId\": \"29f4b7d599004a6590f2610aafbae288\"\n },\n {\n \"publicId\": \"ec951205e76b416a85eaab3920dcae16\",\n \"value\": \"165000\",\n \"groupIndex\": 0,\n \"groupFieldPublicId\": \"29f4b7d599004a6590f2610aafbae288\"\n },\n {\n \"publicId\": \"52383ca0b58b40c2868c93467b17af2d\",\n \"value\": \"Yes\"\n },\n {\n \"publicId\": \"2962aa618d97468a84542d165e8846ba\",\n \"value\": \"No\"\n }\n ],\n \"form\": {\n \"publicId\": \"8f4bb56bc7cb4cadb7f8479f88cb81ee\",\n \"name\": \"External API - Home - Read Policy Details Form\",\n \"pages\": [\n {\n \"name\": \"\",\n \"fields\": [\n {\n \"publicId\": \"fdd85e5c827449aa82e2d09af23cfed8\",\n \"name\": \"Reference\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Policy ID: \",\n \"placeholder\": \"Policy ID \"\n }\n },\n {\n \"publicId\": \"186b0301eac24f74b4da98a60f3e871a\",\n \"name\": \"PolicyStatus\",\n \"type\": \"select\",\n \"options\": {\n \"selectType\": \"dropdown\",\n \"label\": \"Policy Status:\",\n \"selectOptions\": [\n {\n \"value\": \"Active\",\n \"text\": \"Active\"\n }\n ],\n \"placeholder\": \"Please select\"\n }\n },\n {\n \"publicId\": \"29ce174b9ad744279b26fe80633155fc\",\n \"name\": \"coverType\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Cover Type\"\n }\n },\n {\n \"publicId\": \"8cf22861fe294d02b284faa5278db081\",\n \"name\": \"StartDate\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"date\",\n \"label\": \" Start Date:\",\n \"mask\": \"00/00/0000\",\n \"placeholder\": \" Start Date\"\n }\n },\n {\n \"publicId\": \"bd487b2b9598458c949a9272ac8d8041\",\n \"name\": \"EndDate\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"date\",\n \"label\": \"End Date:\",\n \"mask\": \"00/00/0000\",\n \"placeholder\": \"End Date\"\n }\n },\n {\n \"publicId\": \"def625ab6b68436bb0efd809dc79464c\",\n \"name\": \"AnnualPremium\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"number\",\n \"label\": \"Annual Premium:\",\n \"format\": \"£{N2}\"\n }\n },\n {\n \"publicId\": \"5ccbee73caa44f13975c43dc78b6a1d0\",\n \"name\": \"PaymentFrequency\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"number\",\n \"label\": \"Payment Frequency:\"\n }\n },\n {\n \"publicId\": \"d608358d2c3e4d05926780f7ed153bbf\",\n \"name\": \"MonthlyPayment\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"number\",\n \"label\": \"Monthly Payment:\",\n \"format\": \"£{N2}\"\n }\n },\n {\n \"publicId\": \"0cb7f4998c0d46e6a0fb9f70a618f7d7\",\n \"name\": \"TotalAnnualPayment\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"number\",\n \"label\": \"Total Annual Payment:\",\n \"format\": \"£{N2}\"\n }\n },\n {\n \"publicId\": \"b9c2dee846c64c0eba775b3c9ef26a3d\",\n \"name\": \"CreditCharge\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"number\",\n \"label\": \"Credit Charge:\",\n \"format\": \"£{N2}\"\n }\n },\n {\n \"publicId\": \"bab6949b0cc040179dfb2a2829b618f8\",\n \"name\": \"APR\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"number\",\n \"label\": \"APR:\",\n \"format\": \"{N2}%\"\n }\n },\n {\n \"publicId\": \"31ce5e268cb64cbbbad054e8fdd5152b\",\n \"name\": \"PolicyholdersGroup\",\n \"type\": \"group\",\n \"options\": {\n \"label\": \"Policyholder\",\n \"repeatableGroupFields\": true,\n \"groupType\": \"column\"\n },\n \"groupFields\": [\n {\n \"publicId\": \"1c8e7fe07c134edf994178d0a2b668fe\",\n \"name\": \"PolicyholderFullName\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Name:\"\n }\n },\n {\n \"publicId\": \"ac18246b846c410bb30af108c7409198\",\n \"name\": \"PolicyholderOccupation\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Occupation: \"\n }\n },\n {\n \"publicId\": \"b3438754bb2446be85929f5366dbf2c6\",\n \"name\": \"PolicyholderBusiness\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Business: \"\n }\n },\n {\n \"publicId\": \"1fbedee35b014ae192ab15c147646bec\",\n \"name\": \"RelationshipToPolicyholder\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Relationship: \"\n }\n }\n ]\n },\n {\n \"publicId\": \"fa5335584845417faeaef1646ca9ad3e\",\n \"name\": \"InsuredPropertyAddressLine1\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \" \"\n }\n },\n {\n \"publicId\": \"52bb7ae75c1f48c0942206a46f9eb668\",\n \"name\": \"InsuredPropertyAddressLine2\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \" \"\n }\n },\n {\n \"publicId\": \"a33ac17a33a044639914a7f62eea7d4a\",\n \"name\": \"InsuredPropertyAddressLine3\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \" \"\n }\n },\n {\n \"publicId\": \"3311eb4b13d746439dbaabac327a374e\",\n \"name\": \"InsuredPropertyCounty\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \" \"\n }\n },\n {\n \"publicId\": \"fb6e0db330f7454fb23760d4a439a814\",\n \"name\": \"InsuredPropertyPostCode\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \" \"\n }\n },\n {\n \"publicId\": \"07e1d066ba93492298f4e30e8f0745d4\",\n \"name\": \"InsuredPropertyCountry\",\n \"type\": \"select\",\n \"options\": {\n \"label\": \" \",\n \"selectOptions\": [\n {\n \"value\": \"GBR\",\n \"text\": \"United Kingdom\"\n },\n {\n \"value\": \"USA\",\n \"text\": \"United States\"\n },\n {\n \"value\": \"OTH\",\n \"text\": \"Other\"\n }\n ]\n }\n },\n {\n \"publicId\": \"843300e3b1414f948f0f4ded9034a961\",\n \"name\": \"PropertyType\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Property Type:\"\n }\n },\n {\n \"publicId\": \"cd4e887f057e450fbf664e15781db3e9\",\n \"name\": \"YearOfBuild\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Year of Build:\"\n }\n },\n {\n \"publicId\": \"a641da47dc3d4aefb79397d1ceefb87a\",\n \"name\": \"NoBedrooms\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Bedrooms:\"\n }\n },\n {\n \"publicId\": \"9051c11bf769409cb0fdeb1fed05e036\",\n \"name\": \"NoBathrooms\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"No Bathrooms:\"\n }\n },\n {\n \"publicId\": \"f290ea2fbf4b431f814e00393a007d49\",\n \"name\": \"WallConstruction\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Wall Construction:\"\n }\n },\n {\n \"publicId\": \"5144fd2bc83c45f897db2d8906d219dd\",\n \"name\": \"RoofConstruction\",\n \"type\": \"label\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Roof Construction:\"\n }\n },\n {\n \"publicId\": \"1edec6140c934d5fb77d448ca7a58bf1\",\n \"name\": \"BurglarAlarm\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Burglar Alarm:\"\n }\n },\n {\n \"publicId\": \"bff46c34c8d84d178e5163712b580c1b\",\n \"name\": \"SmokeDetector\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Smoke Detector:\"\n }\n },\n {\n \"publicId\": \"306b19a888a3442dbfa833a4f4fbc369\",\n \"name\": \"ListedBuilding\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Listed Building:\"\n }\n },\n {\n \"publicId\": \"7ca581bb91dd4427ad8f2d861bd6e747\",\n \"name\": \"400mOfWater\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"400m of Water:\"\n }\n },\n {\n \"publicId\": \"6d45e016ede44643b895edffb6eb6886\",\n \"name\": \"BuildingsClaimsInLast3Years\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Buildings Claims in Last 3 years:\"\n }\n },\n {\n \"publicId\": \"48119d84259f47a4b64fdfd9a68018da\",\n \"name\": \"ContentsClaimsInLast3Years\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Contents Claims in Last 3 years:\"\n }\n },\n {\n \"publicId\": \"88a1501e02c14b499f8f5b376324f5c0\",\n \"name\": \"Occupancy\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Occupancy\"\n }\n },\n {\n \"publicId\": \"10c42c67365644cd93a574a5b6c0e357\",\n \"name\": \"Adults\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Adults:\"\n }\n },\n {\n \"publicId\": \"9392d26b0c2c4810ae5d5a136d3e56f4\",\n \"name\": \"Children\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Children:\"\n }\n },\n {\n \"publicId\": \"0cb34d157f134c1ca82a5074923864a6\",\n \"name\": \"Unoccupied\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Unoccupied:\"\n }\n },\n {\n \"publicId\": \"f5ee351af37642eeb5b8757cb04206a2\",\n \"name\": \"BusinessUse\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Business Use:\"\n }\n },\n {\n \"publicId\": \"67cfabf474fd4e859c7af3c2210947be\",\n \"name\": \"BuildingsCoverLimit\",\n \"type\": \"select\",\n \"options\": {\n \"selectType\": \"dropdown\",\n \"label\": \"Buildings Cover Limit\",\n \"selectOptions\": [\n {\n \"value\": \"50000\",\n \"text\": \"£50,000\"\n },\n {\n \"value\": \"100000\",\n \"text\": \"£100,000\"\n },\n {\n \"value\": \"150000\",\n \"text\": \"£150,000\"\n },\n {\n \"value\": \"200000\",\n \"text\": \"£200,000\"\n },\n {\n \"value\": \"250000\",\n \"text\": \"£250,000\"\n },\n {\n \"value\": \"350000\",\n \"text\": \"£350,000\"\n },\n {\n \"value\": \"400000\",\n \"text\": \"£400,000\"\n },\n {\n \"value\": \"450000\",\n \"text\": \"£450,000\"\n },\n {\n \"value\": \"500000\",\n \"text\": \"£500,000\"\n },\n {\n \"value\": \"600000\",\n \"text\": \"£600,000\"\n },\n {\n \"value\": \"750000\",\n \"text\": \"£750,000\"\n },\n {\n \"value\": \"Unlimited\",\n \"text\": \"Unlimited\"\n }\n ],\n \"placeholder\": \"Please select\",\n \"hint\": \"This is the amount required to rebuild your property\"\n },\n \"style\": {\n \"inlineLabel\": true\n }\n },\n {\n \"publicId\": \"edd3f6d4b979446cb2cd76e6df8bb11f\",\n \"name\": \"BuildingsAccidentalDamage\",\n \"type\": \"select\",\n \"options\": {\n \"selectType\": \"toggle\",\n \"label\": \"Buildings Accidental Damage\",\n \"selectOptions\": [\n {\n \"value\": \"Yes\",\n \"text\": \"Included\"\n },\n {\n \"value\": \"No\",\n \"text\": \"Not Included\"\n }\n ],\n \"hint\": \"Accidental damage cover for your building, its fixtures and fittings\"\n },\n \"style\": {\n \"inlineLabel\": true\n }\n },\n {\n \"publicId\": \"5ef429a2e3fa42bbaa74146d34137e10\",\n \"name\": \"BuildingsExcess\",\n \"type\": \"select\",\n \"options\": {\n \"selectType\": \"dropdown\",\n \"label\": \"Buildings Claim Excess\",\n \"selectOptions\": [\n {\n \"value\": \"50\",\n \"text\": \"£50\"\n },\n {\n \"value\": \"100\",\n \"text\": \"£100\"\n },\n {\n \"value\": \"150\",\n \"text\": \"£150\"\n },\n {\n \"value\": \"200\",\n \"text\": \"£200\"\n },\n {\n \"value\": \"250\",\n \"text\": \"£250\"\n },\n {\n \"value\": \"300\",\n \"text\": \"£300\"\n },\n {\n \"value\": \"350\",\n \"text\": \"£350\"\n },\n {\n \"value\": \"400\",\n \"text\": \"£400\"\n },\n {\n \"value\": \"500\",\n \"text\": \"£500\"\n },\n {\n \"value\": \"750\",\n \"text\": \"£750\"\n },\n {\n \"value\": \"1000\",\n \"text\": \"£1000\"\n }\n ],\n \"placeholder\": \"Please select\",\n \"hint\": \"This is the amount you'd have to pay of any successful claim\"\n },\n \"style\": {\n \"inlineLabel\": true\n }\n },\n {\n \"publicId\": \"1688c88525514e00a2d2129508a474b6\",\n \"name\": \"SubsidenceExcess\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"number\",\n \"label\": \"Subsidence Excess\",\n \"format\": \"£{N2}\"\n }\n },\n {\n \"publicId\": \"54d09afc045247d0a10eb873b5d21174\",\n \"name\": \"BuildingsEscapeOfWaterExcess\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"number\",\n \"label\": \"Escape of Water Excess\",\n \"format\": \"£{N2}\"\n }\n },\n {\n \"publicId\": \"65b62a8af491472b8c432b4f8ef9ba56\",\n \"name\": \"ContentsCoverLimit\",\n \"type\": \"select\",\n \"options\": {\n \"selectType\": \"dropdown\",\n \"label\": \"Contents Cover Limit\",\n \"selectOptions\": [\n {\n \"value\": \"5000\",\n \"text\": \"£5000\"\n },\n {\n \"value\": \"10000\",\n \"text\": \"£10,000\"\n },\n {\n \"value\": \"15000\",\n \"text\": \"£15,000\"\n },\n {\n \"value\": \"20000\",\n \"text\": \"£20,000\"\n },\n {\n \"value\": \"25000\",\n \"text\": \"£25,000\"\n },\n {\n \"value\": \"30000\",\n \"text\": \"£30,000\"\n },\n {\n \"value\": \"40000\",\n \"text\": \"£40,000\"\n },\n {\n \"value\": \"50000\",\n \"text\": \"£50,000\"\n },\n {\n \"value\": \"75000\",\n \"text\": \"£75,000\"\n },\n {\n \"value\": \"100000\",\n \"text\": \"£100,000\"\n }\n ],\n \"placeholder\": \"Please select\",\n \"hint\": \"This is the amount required to replace the entire contents of your property\"\n },\n \"style\": {\n \"inlineLabel\": true\n }\n },\n {\n \"publicId\": \"4344a3e3c3a0441b98d8b861592cd503\",\n \"name\": \"ContentsAccidentalDamage\",\n \"type\": \"select\",\n \"options\": {\n \"selectType\": \"toggle\",\n \"label\": \"Contents Accidental Damage\",\n \"selectOptions\": [\n {\n \"value\": \"Yes\",\n \"text\": \"Included\"\n },\n {\n \"value\": \"No\",\n \"text\": \"Not Included\"\n }\n ],\n \"hint\": \"Accidental damage cover for your contents whilst at your property\"\n },\n \"style\": {\n \"inlineLabel\": true\n }\n },\n {\n \"publicId\": \"997d1b6d4ec34dbfaccac8a9a157af56\",\n \"name\": \"ContentsClaimExcess\",\n \"type\": \"select\",\n \"options\": {\n \"selectType\": \"dropdown\",\n \"label\": \"Contents Claim Excess\",\n \"selectOptions\": [\n {\n \"value\": \"50\",\n \"text\": \"£50\"\n },\n {\n \"value\": \"100\",\n \"text\": \"£100\"\n },\n {\n \"value\": \"150\",\n \"text\": \"£150\"\n },\n {\n \"value\": \"200\",\n \"text\": \"£200\"\n },\n {\n \"value\": \"250\",\n \"text\": \"£250\"\n },\n {\n \"value\": \"300\",\n \"text\": \"£300\"\n },\n {\n \"value\": \"350\",\n \"text\": \"£350\"\n },\n {\n \"value\": \"400\",\n \"text\": \"£400\"\n },\n {\n \"value\": \"500\",\n \"text\": \"£500\"\n },\n {\n \"value\": \"750\",\n \"text\": \"£750\"\n },\n {\n \"value\": \"1000\",\n \"text\": \"£1000\"\n }\n ],\n \"placeholder\": \"Please select\",\n \"hint\": \"This is the amount you'd have to pay of any successful claim\"\n },\n \"style\": {\n \"inlineLabel\": true\n }\n },\n {\n \"publicId\": \"7a3f6a4c975946a28fa194e403d488c2\",\n \"name\": \"PersonalEffectsExcess\",\n \"type\": \"select\",\n \"options\": {\n \"selectType\": \"dropdown\",\n \"label\": \"Contents Personal Effects Excess\",\n \"selectOptions\": [\n {\n \"value\": \"50\",\n \"text\": \"£50\"\n },\n {\n \"value\": \"100\",\n \"text\": \"£100\"\n },\n {\n \"value\": \"150\",\n \"text\": \"£150\"\n },\n {\n \"value\": \"200\",\n \"text\": \"£200\"\n },\n {\n \"value\": \"250\",\n \"text\": \"£250\"\n },\n {\n \"value\": \"300\",\n \"text\": \"£300\"\n },\n {\n \"value\": \"350\",\n \"text\": \"£350\"\n },\n {\n \"value\": \"400\",\n \"text\": \"£400\"\n },\n {\n \"value\": \"500\",\n \"text\": \"£500\"\n },\n {\n \"value\": \"750\",\n \"text\": \"£750\"\n },\n {\n \"value\": \"1000\",\n \"text\": \"£1000\"\n }\n ],\n \"placeholder\": \"Please select\",\n \"hint\": \"This is the amount you'd have to pay of any successful claim for your personal effects whilst away from the property\"\n },\n \"style\": {\n \"inlineLabel\": true\n }\n },\n {\n \"publicId\": \"7d23adca81aa4f99b4d95624ac7c830c\",\n \"name\": \"EscapeOfWaterExcess\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"number\",\n \"label\": \"Escape of Water Excess\",\n \"format\": \"£{N2}\"\n }\n },\n {\n \"publicId\": \"363d6e454803490ba2cd0c9d68274655\",\n \"name\": \"CoverAwayFromTheHome\",\n \"type\": \"select\",\n \"options\": {\n \"selectType\": \"dropdown\",\n \"label\": \"Cover Away from the Home Limit\",\n \"selectOptions\": [\n {\n \"value\": \"0\",\n \"text\": \"£0\"\n },\n {\n \"value\": \"500\",\n \"text\": \"£500\"\n },\n {\n \"value\": \"1000\",\n \"text\": \"£1,000\"\n },\n {\n \"value\": \"2000\",\n \"text\": \"£2,000\"\n },\n {\n \"value\": \"3000\",\n \"text\": \"£3,000\"\n },\n {\n \"value\": \"4000\",\n \"text\": \"£4,000\"\n },\n {\n \"value\": \"5000\",\n \"text\": \"£5,000\"\n },\n {\n \"value\": \"7500\",\n \"text\": \"£7,500\"\n },\n {\n \"value\": \"10000\",\n \"text\": \"£10,000\"\n }\n ],\n \"placeholder\": \"Please select\",\n \"hint\": \"This is limit you can claim for any of your valuables if lost or damaged whilst away from your home\"\n },\n \"style\": {\n \"inlineLabel\": true\n }\n },\n {\n \"publicId\": \"fad109b67a704e5c8516b93e5a813ed8\",\n \"name\": \"SingleItemCoverLimit\",\n \"type\": \"select\",\n \"options\": {\n \"selectType\": \"dropdown\",\n \"label\": \"Single Item Limit\",\n \"selectOptions\": [\n {\n \"value\": \"500\",\n \"text\": \"£500\"\n },\n {\n \"value\": \"1000\",\n \"text\": \"£1,000\"\n },\n {\n \"value\": \"2000\",\n \"text\": \"£2,000\"\n },\n {\n \"value\": \"3000\",\n \"text\": \"£3,000\"\n },\n {\n \"value\": \"4000\",\n \"text\": \"£4,000\"\n },\n {\n \"value\": \"5000\",\n \"text\": \"£5,000\"\n },\n {\n \"value\": \"7500\",\n \"text\": \"£7,500\"\n },\n {\n \"value\": \"10000\",\n \"text\": \"£10,000\"\n }\n ],\n \"placeholder\": \"Please select\",\n \"hint\": \"This is the value if your most expensive possession that is not listed as a specified item\"\n },\n \"style\": {\n \"inlineLabel\": true\n }\n },\n {\n \"publicId\": \"930585088c624f6994c595703f59730c\",\n \"name\": \"SpecifiedItems\",\n \"type\": \"input\",\n \"options\": {\n \"label\": \"Specified Items\"\n }\n },\n {\n \"publicId\": \"0a6165bbe3504ce6a471cbddcd293b55\",\n \"name\": \"SpecifiedCycles\",\n \"type\": \"input\",\n \"options\": {\n \"label\": \"Specified Cycles\"\n }\n },\n {\n \"publicId\": \"29f4b7d599004a6590f2610aafbae288\",\n \"name\": \"SpecifiedItemsGroup\",\n \"type\": \"group\",\n \"options\": {\n \"label\": \"Specified Item\",\n \"hint\": \"Specified items are those valued at over £1,500\",\n \"repeatableGroupFields\": true,\n \"groupType\": \"row\",\n \"repeatableAddButtonText\": \"Add Specified Item\"\n },\n \"groupFields\": [\n {\n \"publicId\": \"4f666c0b85ae497f9c2f26ccf88f54eb\",\n \"name\": \"SpecifiedItemType\",\n \"type\": \"select\",\n \"options\": {\n \"selectType\": \"dropdown\",\n \"label\": \"Type\",\n \"selectOptions\": [\n {\n \"value\": \"Antiques\",\n \"text\": \"Antiques\"\n },\n {\n \"value\": \"Art\",\n \"text\": \"Art\"\n },\n {\n \"value\": \"Electronics\",\n \"text\": \"Electronics\"\n },\n {\n \"value\": \"Jewellery\",\n \"text\": \"Jewellery\"\n },\n {\n \"value\": \"Furs/Clothing\",\n \"text\": \"Furs/Clothing\"\n },\n {\n \"value\": \"Musical Instruments\",\n \"text\": \"Musical Instruments\"\n },\n {\n \"value\": \"Stamp, Coin and Medal Collections\",\n \"text\": \"Stamp, Coin and Medal Collections\"\n },\n {\n \"value\": \"Watches and Clocks\",\n \"text\": \"Watches and Clocks\"\n },\n {\n \"value\": \"Rare or Collectable Items\",\n \"text\": \"Rare or Collectable Items\"\n },\n {\n \"value\": \"Other\",\n \"text\": \"Other\"\n }\n ],\n \"placeholder\": \"Please select\"\n }\n },\n {\n \"publicId\": \"731b963a5556493797e8b7fcc3cf9b66\",\n \"name\": \"SpecifiedItemDescription\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Description\",\n \"placeholder\": \"Item description\"\n }\n },\n {\n \"publicId\": \"ec951205e76b416a85eaab3920dcae16\",\n \"name\": \"SpecifiedItemValue\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"number\",\n \"label\": \"Value\",\n \"placeholder\": \"Item Value\"\n }\n }\n ]\n },\n {\n \"publicId\": \"e06fcc1b18ce4fd38bc4d61d41652a75\",\n \"name\": \"SpecifiedCyclesGroup\",\n \"type\": \"group\",\n \"options\": {\n \"label\": \"Specified Cycle\",\n \"hint\": \"Specified cycles are those valued at over £350\",\n \"repeatableGroupFields\": true,\n \"groupType\": \"row\",\n \"repeatableAddButtonText\": \"Add Specified Cycle\"\n },\n \"groupFields\": [\n {\n \"publicId\": \"6403f90410ea4932b02f655439a1b4a8\",\n \"name\": \"SpecifiedCycleDescription\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"text\",\n \"label\": \"Description\",\n \"placeholder\": \"Item description\"\n }\n },\n {\n \"publicId\": \"fdf1a00a77144a6d974d835333228c55\",\n \"name\": \"SpecifiedCycleValue\",\n \"type\": \"input\",\n \"options\": {\n \"inputType\": \"number\",\n \"label\": \"Value\",\n \"placeholder\": \"Item Value\"\n }\n }\n ]\n },\n {\n \"publicId\": \"52383ca0b58b40c2868c93467b17af2d\",\n \"name\": \"FamilyLegalCover\",\n \"type\": \"select\",\n \"options\": {\n \"selectType\": \"toggle\",\n \"label\": \"Family Legal Protection\",\n \"selectOptions\": [\n {\n \"value\": \"Yes\",\n \"text\": \"Included\"\n },\n {\n \"value\": \"No\",\n \"text\": \"Not Included\"\n }\n ],\n \"hint\": \"Family Legal Protection offers you access to legal advice whenever you need it.\"\n },\n \"style\": {\n \"inlineLabel\": true\n }\n },\n {\n \"publicId\": \"2962aa618d97468a84542d165e8846ba\",\n \"name\": \"HomeEmergencyCover\",\n \"type\": \"select\",\n \"options\": {\n \"selectType\": \"toggle\",\n \"label\": \"Home Emergency Cover\",\n \"selectOptions\": [\n {\n \"value\": \"Yes\",\n \"text\": \"Included\"\n },\n {\n \"value\": \"No\",\n \"text\": \"Not Included\"\n }\n ],\n \"hint\": \"Home Emergency Cover offers emergency assistance to make your home safe and secure, 24 hours a day.\"\n },\n \"style\": {\n \"inlineLabel\": true\n }\n }\n ]\n }\n ],\n \"showFooter\": true\n }\n },\n \"isSuccess\": true\n}"},{"id":"c546edbd-dbf8-432d-82ad-b04af21cc9e2","name":"Read Policy Details - Falied - Policy Not Found","originalRequest":{"method":"GET","header":[{"key":"publicId","type":"text","value":"6cd188c0af80458bb71652fe228f4bd4","disabled":true},{"key":"reference","type":"text","value":"","disabled":true}],"url":{"raw":"{{base_url}}/policy/read?publicId=&reference=Pol-0010","host":["{{base_url}}"],"path":["policy","read"],"query":[{"key":"publicId","value":"","description":"The PublicID of the customer record."},{"key":"reference","value":"Pol-0010","description":"The Insurer Policy ID for the policy."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Nov 2020 11:27:51 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": false,\n \"failure\": {\n \"message\": \"Policy with Public Id '' or Reference 'Pol-0010' doesn't exist\"\n }\n}"}],"_postman_id":"e19f8278-f823-4f56-b968-4522aa1c51fc"},{"name":"Documents List","id":"ec9abca1-b6e0-40b7-8d52-558871d0931c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/docs/:entityType/list?entityPublicId=&entityReference=Pol-001","description":"

Obtains a list of documents attached to a specific entity (e.g. Cusotmer, Policy, Claim)

Either the Public ID (entityPublicId) or the Insurer's Reference (entityReference) must be passed as a query parameter.

The entity type must be passed in the path, and match one of the following values:

“amendment”; “claim”; “customer”; “policy”; “policyAddon”; “product”; “productAddon”; “quote”; “renewal”;

The PublicID of the entity being queried.

\n","type":"text/plain"},"key":"entityPublicId","value":""},{"description":{"content":"

The Insurer's reference for the entity being queried.

\n","type":"text/plain"},"key":"entityReference","value":"Pol-001"}],"variable":[{"id":"73d3ed65-443d-443b-bd22-54d2eb09265d","description":{"content":"

The type of entity being queried. Mist match a valid entity type.

\n","type":"text/plain"},"type":"any","value":"policy","key":"entityType"}]}},"response":[{"id":"f80db2a5-4e15-431c-8d4e-c7e656dbec84","name":"Documents List - Success","originalRequest":{"method":"GET","header":[{"key":"publicId","type":"text","value":"9b55c0ae7eff418d8b55f5ac7b9d131a","disabled":true}],"url":{"raw":"{{base_url}}/docs/:entityType/list?entityPublicId=&entityReference=Pol-001","host":["{{base_url}}"],"path":["docs",":entityType","list"],"query":[{"key":"entityPublicId","value":"","description":"The PublicID of the entity being queried."},{"key":"entityReference","value":"Pol-001","description":"The Insurer's reference for the entity being queried."}],"variable":[{"key":"entityType","value":"policy","description":"The type of entity being queried. Mist match a valid entity type."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Nov 2020 11:32:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"items\": [\n {\n \"publicId\": \"3e4dfca853e64ee08c06fd0066e44d7a\",\n \"documentReference\": \"My Reference 2\",\n \"name\": \"Insurance Certificate.pdf\",\n \"type\": \"InsuranceCertificate\"\n }\n ],\n \"count\": 1\n },\n \"isSuccess\": true\n}"},{"id":"0cb39374-78dc-4fdc-af5f-dda378cfe063","name":"Documents List - Success - No Documents Found","originalRequest":{"method":"GET","header":[{"key":"publicId","type":"text","value":"9b55c0ae7eff418d8b55f5ac7b9d131a","disabled":true}],"url":{"raw":"{{base_url}}/docs/:entityType/list?entityPublicId=&entityReference=Pol-001","host":["{{base_url}}"],"path":["docs",":entityType","list"],"query":[{"key":"entityPublicId","value":"","description":"The PublicID of the entity being queried."},{"key":"entityReference","value":"Pol-001","description":"The Insurer's reference for the entity being queried."}],"variable":[{"key":"entityType","value":"policy","description":"The type of entity being queried. Mist match a valid entity type."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Nov 2020 11:34:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"items\": [],\n \"count\": 0\n },\n \"isSuccess\": true\n}"},{"id":"487bdc92-5adf-4a44-a5c4-a568274e2241","name":"Documents List - Failed - Entity Not Found","originalRequest":{"method":"GET","header":[{"key":"publicId","type":"text","value":"9b55c0ae7eff418d8b55f5ac7b9d131a","disabled":true}],"url":{"raw":"{{base_url}}/docs/:entityType/list?entityPublicId=&entityReference=Pol-0001","host":["{{base_url}}"],"path":["docs",":entityType","list"],"query":[{"key":"entityPublicId","value":"","description":"The PublicID of the entity being queried."},{"key":"entityReference","value":"Pol-0001","description":"The Insurer's reference for the entity being queried."}],"variable":[{"key":"entityType","value":"policy","description":"The type of entity being queried. Mist match a valid entity type."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Nov 2020 11:33:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": false,\n \"failure\": {\n \"message\": \"EntityType with Public Id 'Pol-0001' or Reference 'Pol-0001' doesn't exist\"\n }\n}"}],"_postman_id":"ec9abca1-b6e0-40b7-8d52-558871d0931c"},{"name":"Download All Documents","id":"d64242e2-2278-4be8-94b7-70285fd87208","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"entityType\": \"policy\",\n \"entityPublicId\": \"71d6f75a8c2f45eab00cbb62797f3e13\",\n \"entityReference\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/docs/:entityType/download/batch?entityPublicId=&entityReference=Pol-001","description":"

Allows the download of a zip file containing all documents attached to a specific entity.

Either the Public ID (entityPublicId) or the Insurer's Reference (entityReference) must be passed as a query parameter.

The entity type must be passed in the path, and match one of the following values:

“amendment”; “claim”; “customer”; “policy”; “policyAddon”; “product”; “productAddon”; “quote”; “renewal”;

The PublicID of the entity being queried.

\n","type":"text/plain"},"key":"entityPublicId","value":""},{"description":{"content":"

The Insurer's reference for the entity being queried.

\n","type":"text/plain"},"key":"entityReference","value":"Pol-001"}],"variable":[{"id":"575c75ba-e275-4ddf-b128-137e60bb9942","description":{"content":"

The type of entity being queried. Mist match a valid entity type.

\n","type":"text/plain"},"type":"any","value":"policy","key":"entityType"}]}},"response":[],"_postman_id":"d64242e2-2278-4be8-94b7-70285fd87208"},{"name":"Download Specific Document","id":"fcd63159-cd37-44f7-b44f-5e6acd2bd021","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"entityType\": \"policy\",\n \"entityPublicId\": \"71d6f75a8c2f45eab00cbb62797f3e13\",\n \"entityReference\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/docs/download?PublicId=&documentReference=My Reference 1","description":"

Allows the download of a specific document.

Either the Public ID (publicId) or the Insurer's Unique Document Reference (documentReference) must be passed as a query parameter.

The PublicID of the entity being queried.

\n","type":"text/plain"},"key":"PublicId","value":""},{"description":{"content":"

The Insurer's reference for the entity being queried.

\n","type":"text/plain"},"key":"documentReference","value":"My Reference 1"}],"variable":[]}},"response":[],"_postman_id":"fcd63159-cd37-44f7-b44f-5e6acd2bd021"},{"name":"Get File Download URLs","id":"90a747d4-2b86-414c-ab4b-fc9eec808689","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"publicIds\": [\r\n \"dd13a3dc715b4a6f9fc22a9de82cd781\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/file/url/batch","description":"

Obtains a list of documents attached to a specific entity (e.g. Cusotmer, Policy, Claim)

Either the Public ID (entityPublicId) or the Insurer's Reference (entityReference) must be passed as a query parameter.

The entity type must be passed in the path, and match one of the following values:

“amendment”; “claim”; “customer”; “policy”; “policyAddon”; “product”; “productAddon”; “quote”; “renewal”;

APIs used to read customer and policy data, and download documents, from the ManageMy platform

\n","_postman_id":"72478e9b-e81b-408e-ab9d-0d9154dcff92","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Claims","item":[{"name":"Create Claim","item":[{"name":"Create New Claim","id":"4951998b-6f6f-44f9-9b98-3f9eaa9a7745","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"policyPublicId\": \"cb7ddc766d7149c7a0f0f12b75075afc\",\n \"policyReference\": \"\",\n \"commandName\": \"ApiCreateDraft\",\n \"values\": {\n \"Reference\": \"MMTest001\",\n \"DateOfIncident\": \"2020-12-03\",\n \"IncidentType\": \"Damage to Underground Services\",\n \"CauseOfLeak\": \"No\",\n \"ClaimDetails\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\n \"IsHabitable\": \"No\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/claim/create/batch","description":"

Creates a new claim against a specific policy.

The 'commmandName' command must be passed within the body of the request. The following commands are available:

ApiCreateDraft - creates a draft claim which can then be completed, reviewed and submitted by the customer.
ApiSubmitClaim - creates and submits a draft claim. Claim details cannot be updated once this command has been executed.

Either PolicyPublicId or policyReference (Insurer Policy ID) can be used to key to the policy the new claim relates to.

NB: where a field value is passed using the \"publicId\" as the field identifier, it is possible to instead use \"name\" and provide the field name to identify the field to be created/updated.

Fixed in this collection: corrected request path/method/body shape to match the live API (see accompanying review notes).

Updates details of an existing claim record.

The 'commmandName' command must be passed within the body of the request. The following commands are available:

ApiUpdateDraft - updates a draft claim with new or additional data
ApiSubmitDraft - submits the draft claim. Claim details cannot be updated once this command has been executed.
ApiCancelDraft - cancels a draft claim.

Either publicId or reference (Claim Reference Number) can be used to key to the claim being updated.

NB: where a field value is passed using the \"publicId\" as the field identifier, it is possible to instead use \"name\" and provide the field name to identify the field to be created/updated.

Fixed in this collection: corrected request path/method/body shape to match the live API (see accompanying review notes).

Gets a list of all claims on the ManageMy Platform, and their status.

The number of results to provide in the response. If blank, defaults to 1000.

\n","type":"text/plain"},"key":"pageSize","value":""},{"description":{"content":"

The results page to be returned, taking the pageSize parameter into account. If blanks, defaults to the first page.

\n","type":"text/plain"},"key":"pageIndex","value":""}],"variable":[]}},"response":[{"id":"e959aad0-c43f-4003-9da7-09ce955a81f2","name":"All Customers List - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/customer/read/list?pageSize=5&pageIndex=4","host":["{{base_url}}"],"path":["customer","read","list"],"query":[{"key":"pageSize","value":"5","description":"The number of results to provide in the response. If blank, defaults to 1000"},{"key":"pageIndex","value":"4","description":"The results page to be returned, taking the pageSize parameter into account"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Nov 2020 11:04:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"items\": [\n {\n \"publicId\": \"d06ebee1a28a4318874926760e38c571\",\n \"firstName\": \"Monitoring\",\n \"lastName\": \"Monitoring\",\n \"policyNumber\": [],\n \"postCode\": \"Monitoring\",\n \"dateOfBirth\": \"2002-08-01T01:00:00Z\",\n \"email\": \"monitoring@managemy.com\",\n \"status\": \"Active\"\n },\n {\n \"publicId\": \"5ea6ecfc6daf400988060030527734aa\",\n \"firstName\": \"Mark\",\n \"lastName\": \"Moran\",\n \"policyNumber\": [\n \"MM23657\"\n ],\n \"postCode\": \"LS8 1BE\",\n \"dateOfBirth\": \"1981-01-01T00:00:00Z\",\n \"email\": \"mark2@managemy.com\",\n \"status\": \"Active\"\n },\n {\n \"publicId\": \"21b825504d3849b6b25b830238ccb9af\",\n \"firstName\": \"Mark\",\n \"lastName\": \"Moran\",\n \"policyNumber\": [],\n \"postCode\": \"LS17 6JS\",\n \"dateOfBirth\": \"1981-06-28T00:00:00Z\",\n \"email\": \"mark1@managemy.com\",\n \"status\": \"Active\"\n },\n {\n \"publicId\": \"b93a95995dc94a249bd11d0cf09e74ae\",\n \"reference\": \"Test-001\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"policyNumber\": [\n \"Pol-001\"\n ],\n \"postCode\": \"E1 1AB\",\n \"dateOfBirth\": \"1969-01-01T00:00:00Z\",\n \"email\": \"noreply@managemy.com\",\n \"status\": \"Unregistered\"\n },\n {\n \"publicId\": \"c231e0fe2c904821b0ee094fc90cd191\",\n \"reference\": \"Test-002\",\n \"firstName\": \"Alice\",\n \"lastName\": \"Jones\",\n \"policyNumber\": [],\n \"postCode\": \"LS1 1LS\",\n \"dateOfBirth\": \"1969-01-01T00:00:00Z\",\n \"email\": \"noreply2@managemy.com\",\n \"status\": \"Unregistered\"\n }\n ],\n \"count\": 25\n },\n \"isSuccess\": true\n}"}],"_postman_id":"3c6ebd41-655d-4fb8-84bb-5b68882f788e"},{"name":"Read Claim Details","id":"bd18e942-8eb4-431e-9f98-149c8c917198","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"policyPublicId\": \"string\",\n \"policyReference\": \"string\",\n \"commandName\": \"string\",\n \"values\": {\n \"string\": {\n \"string\": \"string\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/claim/read?publicId=&reference=EXT-B4504249","description":"

Retrieves the data stored on a specified claim record.

Either Claim Public ID (publicId) or Insurer Claim Reference (reference) must be supplied.

A JSON Form is also returned at the end of the request, to allow the key-value pairs to be read.

The PublicID of the claim.

\n","type":"text/plain"},"key":"publicId","value":""},{"description":{"content":"

The Insurer Claim Reference for the claim.

\n","type":"text/plain"},"key":"reference","value":"EXT-B4504249"}],"variable":[]}},"response":[{"id":"70bd1856-6b07-4b6c-9998-ca0ac6678928","name":"Read Claim Details - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/claim/read?publicId=&reference=EXT-B4504249","host":["{{base_url}}"],"path":["claim","read"],"query":[{"key":"publicId","value":"","description":"The PublicID of the claim."},{"key":"reference","value":"EXT-B4504249","description":"The Insurer Claim Reference for the claim."}]},"description":"Retrieves the data stored on a specified claim record.\n\nEither Claim Public ID (`publicId`) or Insurer Claim Reference (`reference`) must be supplied.\n\nA JSON Form is also returned at the end of the request, to allow the key-value pairs to be read."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jul 2026 09:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"publicId\": \"clm001a2b3c4d5e6f7a8b9c0d1e2f3a4\",\n \"reference\": \"EXT-EE397262\",\n \"fieldValues\": [\n {\n \"publicId\": \"fld_incidenttype\",\n \"value\": \"Damage to Underground Services\"\n },\n {\n \"publicId\": \"fld_dateofincident\",\n \"value\": \"2020-12-03\"\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"769d0d37-b445-4a52-91e9-de421f79e0ec","name":"Read Claim Details - Failure - Claim Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/claim/read?publicId=&reference=EXT-B4504249","host":["{{base_url}}"],"path":["claim","read"],"query":[{"key":"publicId","value":"","description":"The PublicID of the claim."},{"key":"reference","value":"EXT-B4504249","description":"The Insurer Claim Reference for the claim."}]},"description":"Retrieves the data stored on a specified claim record.\n\nEither Claim Public ID (`publicId`) or Insurer Claim Reference (`reference`) must be supplied.\n\nA JSON Form is also returned at the end of the request, to allow the key-value pairs to be read."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jul 2026 09:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": false,\n \"failure\": {\n \"message\": \"Claim with Public Id or Reference EXT-99999999 doesn't exist\"\n }\n}"}],"_postman_id":"bd18e942-8eb4-431e-9f98-149c8c917198"}],"id":"47581371-eed8-4a67-9d86-13d09eb2cee2","_postman_id":"47581371-eed8-4a67-9d86-13d09eb2cee2","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Delete Claim","item":[{"name":"Delete Claim","id":"5321d26c-6aab-4eac-81f2-73ab325e2697","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entities\": [\n {\n \"reference\": \"355CF9F8\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/claim/delete/batch","description":"

Deletes a claim from the ManageMy platform.

Either publicId or reference (Insurer Claim Reference) can be used to key to the Claim.

Fixed in this collection: corrected request path/method/body shape to match the live API (see accompanying review notes).

⚠ Response examples in this folder are drafted, not captured from a live API call — verified against the actual response models and controller code for shape and field names, but sample values and error-message wording are illustrative. See each example's own note for detail.

Document uploads: see the shared Document Uploads section (use entityType: \"claim\") rather than a copy here.

\n","_postman_id":"975ae895-d841-45c1-98cb-09725fe9eba6","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Quotes","item":[{"name":"Create Quotes","item":[{"name":"Create New Quote","id":"6803e682-6dec-4833-ba60-c71985c00b91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"productPublicId\": \"94ae1ca46427402db584b49bbac1dfea\",\n \"customerPublicId\": \"\",\n \"customerReference\": \"Test-001\",\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"Reference\": \"QRT01002\",\n \"CoverType\": \"Buildings & Contents\",\n \"StartDate\": \"01/01/2020\",\n \"EndDate\": \"31/12/2020\",\n \"AnnualPremium\": \"462.64\",\n \"PaymentFrequency\": \"Monthly\",\n \"PropertyType\": \"Detached House\",\n \"BuildingsCoverLimit\": \"Unlimited\",\n \"ContentsCoverLimit\": \"50000\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote/create/batch","description":"

Creates a new quote for a customer, against a specific product. Multiple quotes can be created in a single API call, using the entityFieldValuesModels array structure.

The commandName command must be passed within the body of each entry in the array. The following commands are available:

ApiCreateDraft - creates a draft quote which can then be completed, reviewed, and submitted by the customer.
ApiSubmitQuote - creates and submits a quote directly. Quote details cannot be updated once this command has been executed.

Either customerPublicId or customerReference (Insurer Customer Reference) must be provided to identify the customer the quote is for, along with the productPublicId of the product being quoted. Unlike Claims and Policy Amendments, a Quote is not created against an existing policy — it's a pre-policy step, so there's no policyPublicId on this model.

NB: where a field value is passed using the \"publicId\" as the field identifier, it is possible to instead use \"name\" and provide the field name to identify the field to be created/updated.

Fixed in this collection: corrected request path/method/body shape to match the live API — the previous example had copy-pasted Claim-specific fields and used the wrong identifying properties (see the accompanying review notes).

Updates details of an existing quote.

The 'commmandName' command must be passed within the body of the request. The following commands are available:

ApiUpdateDraft - updates a draft quote with new or additional data
ApiSubmitDraft - submits the quote. Quote details cannot be updated once this command has been executed.
ApiCancelDraft - cancels a draft quote.

Either publicId or reference (Quote Reference Number) can be used to key to the quote being updated.

NB: where a field value is passed using the \"publicId\" as the field identifier, it is possible to instead use \"name\" and provide the field name to identify the field to be created/updated.

Fixed in this collection: corrected request path/method/body shape to match the live API (see accompanying review notes).

Gets a list of all quotes on the ManageMy Platform, and their status.

The number of results to provide in the response. If blank, defaults to 1000.

\n","type":"text/plain"},"key":"pageSize","value":""},{"description":{"content":"

The results page to be returned, taking the pageSize parameter into account. If blanks, defaults to the first page.

\n","type":"text/plain"},"key":"pageIndex","value":""}],"variable":[]}},"response":[{"id":"44583a51-e114-40a1-94ab-39625666a54e","name":"All Quotes List - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/quote/read/list?pageSize=&pageIndex=","host":["{{base_url}}"],"path":["quote","read","list"],"query":[{"key":"pageSize","value":"","description":"The number of results to provide in the response. If blank, defaults to 1000."},{"key":"pageIndex","value":"","description":"The results page to be returned, taking the pageSize parameter into account. If blanks, defaults to the first page."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 04 Dec 2020 11:20:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"items\": [\n {\n \"publicId\": \"ed48e15f6bc0414d8b1a7276aa284ca7\",\n \"reference\": \"QRT01001\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"6f0865ee54a742a1aebae4c54aee2ada\",\n \"reference\": \"QRT01002\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"9c5161ddd3e142a1903ef69aeeebb32c\",\n \"reference\": \"QRT01003\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"26030c40ccb84f0ebc00fe11bf33568e\",\n \"reference\": \"QRT01010\",\n \"status\": \"Pending\"\n },\n {\n \"publicId\": \"0dd335809cea4031b06762be4c92b3a6\",\n \"reference\": \"QRT01012\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"ecf31eef5c6848a4ae63262845e48ed1\",\n \"reference\": \"QRT01013\",\n \"status\": \"Pending\"\n },\n {\n \"publicId\": \"e6bfdd0baef646b6aa97660625681cbf\",\n \"reference\": \"QRT01014\",\n \"status\": \"DraftCancelled\"\n },\n {\n \"publicId\": \"a6f7147e721141b48dd9c36157a7907f\",\n \"reference\": \"QRT01016\",\n \"status\": \"DraftCancelled\"\n },\n {\n \"publicId\": \"8002da196e454761bf8c81b567d9edad\",\n \"reference\": \"QRT01018\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"b54bc0c977974de388dc0e6bc1e74e94\",\n \"reference\": \"QRT01023\",\n \"status\": \"Draft\"\n },\n {\n \"publicId\": \"fa628d400f844ad289e5313d387f13e2\",\n \"reference\": \"QRT01025\",\n \"status\": \"Draft\"\n },\n {\n \"publicId\": \"eb10c3d1484d41578daa19057f2fb849\",\n \"reference\": \"QRT01028\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"9ef7179a7e3941929f22fc4eea2b6626\",\n \"reference\": \"QRT01029\",\n \"status\": \"Draft\"\n },\n {\n \"publicId\": \"36a1a0c9f07a42bcb26b2f118ba190ac\",\n \"reference\": \"QRT01030\",\n \"status\": \"Pending\"\n },\n {\n \"publicId\": \"00f6795af4fd45eda6b3a03bca93cb1e\",\n \"reference\": \"QRT01032\",\n \"status\": \"DraftCancelled\"\n },\n {\n \"publicId\": \"aef39ea38ed942a8ba160a61c6589ad7\",\n \"reference\": \"QRT01033\",\n \"status\": \"Submitted\"\n },\n {\n \"publicId\": \"d6293ad5c10a4a15b11c34cfbe600453\",\n \"reference\": \"QRT01034\",\n \"status\": \"DraftCancelled\"\n },\n {\n \"publicId\": \"1172f6b81dd04bb5b6934b4305346fb5\",\n \"reference\": \"QRT01036\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"2bae51df322d48d4ac282965d3a556e5\",\n \"reference\": \"QRT01038\",\n \"status\": \"Pending\"\n },\n {\n \"publicId\": \"2dbdb042fe8445dfb3595822e701b732\",\n \"reference\": \"QRT01039\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"d20f7af440cc4e0ba55c6d02b457e937\",\n \"reference\": \"QRT01040\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"6da36763f89a47aa91212dca5bea73c1\",\n \"reference\": \"QRT01041\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"96334c0398664cc6b5961b27236a77e7\",\n \"reference\": \"QRT01042\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"a476f5bc27eb4c6a9d70ed6c00430ab7\",\n \"reference\": \"QRT01044\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"7eeaa38d6ca949a1844a061056439fdf\",\n \"reference\": \"QRT01045\",\n \"status\": \"DraftCancelled\"\n },\n {\n \"publicId\": \"29efdf75ba3e43cfac3123c0e323ab6a\",\n \"reference\": \"QRT01046\",\n \"status\": \"Draft\"\n },\n {\n \"publicId\": \"fd9d9b7f35584addaccb998f32869ea9\",\n \"reference\": \"QRT01048\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"5070f280f8434b02ac427ada8263728e\",\n \"reference\": \"QRT01049\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"da2a0299333947e6b3b2f9f436fc187b\",\n \"reference\": \"QRT01050\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"b3df52e8592d4d288cddef26bbc7bcae\",\n \"reference\": \"QRT01051\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"bef419cb17a64cb7a6a90d2bec1d68d8\",\n \"reference\": \"QRT01052\",\n \"status\": \"Pending\"\n },\n {\n \"publicId\": \"41b4f30069e14f758abd39caed3ec7d5\",\n \"reference\": \"QRT01053\",\n \"status\": \"DraftCancelled\"\n },\n {\n \"publicId\": \"d8974e7612be442aba634b4b6e5582bc\",\n \"reference\": \"QRT01056\",\n \"status\": \"Draft\"\n },\n {\n \"publicId\": \"b3bad8bbe5074848b4b4d62736decffe\",\n \"reference\": \"QRT01057\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"380f6a906ecb412e8ae39554138c6a02\",\n \"reference\": \"QRT01058\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"6dd21427087f4e2eb609a23b6cbff757\",\n \"reference\": \"QRT01059\",\n \"status\": \"Draft\"\n },\n {\n \"publicId\": \"36c6a3cc6bc74134a4c7af7a85326e74\",\n \"reference\": \"QRT01060\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"506e72230e504f5090ebe1662d78cb84\",\n \"reference\": \"QRT01061\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"2607e7fe7ec047e985e7d1a9b8d02aaf\",\n \"reference\": \"QRT01062\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"118a7d56138c4b418247b044da55f6cb\",\n \"reference\": \"QRT01063\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"3e1feb617d6c4cc98f53459af0e69b06\",\n \"reference\": \"QRT01064\",\n \"status\": \"Draft\"\n },\n {\n \"publicId\": \"d21235d9d2d14b659f35081657581f86\",\n \"reference\": \"QRT01065\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"69da2df792fc400ba8fed3bd2693adad\",\n \"reference\": \"QRT01067\",\n \"status\": \"Draft\"\n },\n {\n \"publicId\": \"49bbec79a5cf410dad9c7cdfccd36040\",\n \"reference\": \"QRT01068\",\n \"status\": \"Draft\"\n },\n {\n \"publicId\": \"4cd7d72c182047f6a823d9186b5faba7\",\n \"reference\": \"QRT01069\",\n \"status\": \"Draft\"\n },\n {\n \"publicId\": \"7a7d7591d44346fb894f8deae9243857\",\n \"reference\": \"QRT01070\",\n \"status\": \"Pending\"\n },\n {\n \"publicId\": \"4ed837658c7c44d899ec22ce85005da6\",\n \"reference\": \"QRT01071\",\n \"status\": \"Draft\"\n },\n {\n \"publicId\": \"09ab81e3163b46e6baf82a4faf42b356\",\n \"reference\": \"QRT01072\",\n \"status\": \"Draft\"\n },\n {\n \"publicId\": \"ef62eb7787a3437abfc226ee92d2cc0d\",\n \"reference\": \"QRT01074\",\n \"status\": \"DraftCancelled\"\n },\n {\n \"publicId\": \"a7a45eafad1f4da3a73d5359b769661d\",\n \"reference\": \"QRT01076\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"b1f4a513ea78401b9ed550c22f10e4e4\",\n \"reference\": \"QRT01077\",\n \"status\": \"Purchased\"\n },\n {\n \"publicId\": \"fb690080b1fb44cb86b12a004d18cb75\",\n \"reference\": \"QRT01078\",\n \"status\": \"Draft\"\n },\n {\n \"publicId\": \"ed8be4a38818426a9502adbdb16d63fb\",\n \"reference\": \"QRT01079\",\n \"status\": \"Submitted\"\n },\n {\n \"publicId\": \"3c23678557ff4a3a91b22f80f7f4bb57\",\n \"reference\": \"QRT01080\",\n \"status\": \"Draft\"\n }\n ],\n \"count\": 54\n },\n \"isSuccess\": true\n}"}],"_postman_id":"173fdb84-e7f8-4a12-8b6d-154168a0bc06"},{"name":"Read Quote Details","id":"ef30e222-949a-4754-aa8b-e0de9bc4d65c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"policyPublicId\": \"string\",\n \"policyReference\": \"string\",\n \"commandName\": \"string\",\n \"values\": {\n \"string\": {\n \"string\": \"string\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote/read?publicId=&reference=QRT01001","description":"

Retrieves the data stored on a specified quote record.

Either Quote Public ID (publicId) or Insurer Quote Reference (reference) must be supplied.

A JSON Form is also returned at the end of the request, to allow the key-value pairs to be read.

The PublicID of the quote.

\n","type":"text/plain"},"key":"publicId","value":""},{"description":{"content":"

The Insurer Quote Reference for the quote.

\n","type":"text/plain"},"key":"reference","value":"QRT01001"}],"variable":[]}},"response":[{"id":"49b93677-836c-4229-8f16-7dc36a50d57d","name":"Read Quote Details - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/quote/read?publicId=&reference=QRT01001","host":["{{base_url}}"],"path":["quote","read"],"query":[{"key":"publicId","value":"","description":"The PublicID of the quote."},{"key":"reference","value":"QRT01001","description":"The Insurer Quote Reference for the quote."}]},"description":"Retrieves the data stored on a specified quote record.\n\nEither Quote Public ID (`publicId`) or Insurer Quote Reference (`reference`) must be supplied.\n\nA JSON Form is also returned at the end of the request, to allow the key-value pairs to be read."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jul 2026 09:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"publicId\": \"qte001a2b3c4d5e6f7a8b9c0d1e2f3a4\",\n \"reference\": \"QRT01001\",\n \"fieldValues\": [\n {\n \"publicId\": \"fld_annualpremium\",\n \"value\": \"462.64\"\n },\n {\n \"publicId\": \"fld_paymentfrequency\",\n \"value\": \"Monthly\"\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"82a613eb-1947-4a14-9394-ed18f82c6dc9","name":"Read Quote Details - Failure - Quote Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/quote/read?publicId=&reference=QRT01001","host":["{{base_url}}"],"path":["quote","read"],"query":[{"key":"publicId","value":"","description":"The PublicID of the quote."},{"key":"reference","value":"QRT01001","description":"The Insurer Quote Reference for the quote."}]},"description":"Retrieves the data stored on a specified quote record.\n\nEither Quote Public ID (`publicId`) or Insurer Quote Reference (`reference`) must be supplied.\n\nA JSON Form is also returned at the end of the request, to allow the key-value pairs to be read."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jul 2026 09:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": false,\n \"failure\": {\n \"message\": \"Quote with Public Id or Reference QRT09999 doesn't exist\"\n }\n}"}],"_postman_id":"ef30e222-949a-4754-aa8b-e0de9bc4d65c"}],"id":"a8619365-ca54-49a6-b8e1-e17d6468c67b","_postman_id":"a8619365-ca54-49a6-b8e1-e17d6468c67b","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Delete Quotes","item":[{"name":"Delete Quote","id":"bf0179eb-0cb7-4e42-b309-f14d37c21c91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entities\": [\n {\n \"reference\": \"Quote-001\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote/delete/batch","description":"

Deletes a quote from the ManageMy platform.

Either publicId or reference (Insurer Quote Reference) can be used to key to the Quote.

Fixed in this collection: corrected request path/method/body shape to match the live API (see accompanying review notes). Also corrected body to the required {entities:[...]} wrapper used by every other Delete endpoint.

Document uploads: see the shared Document Uploads section (use entityType: \"quote\") rather than a copy here.

\n","_postman_id":"43331df6-650a-4bcc-a719-b8f948a21927","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Policy Amends","item":[{"name":"Create Policy Amends","item":[{"name":"Create New Policy Amendment","id":"a5e19d39-d70b-4b46-9f21-7b1551e9ff80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"policyPublicId\": \"cb7ddc766d7149c7a0f0f12b75075afc\",\n \"policyReference\": \"\",\n \"commandName\": \"ApiCreateDraft\",\n \"values\": {\n \"Reference\": \"MMTest001\",\n \"BuildingsCoverLimit\": \"1000000\",\n \"BuildingsExcess\": \"350\",\n \"SubsidenceExcess\": \"1000\",\n \"BuildingsEscapeOfWaterExcess\": \"500\",\n \"FamilyLegalCover\": \"Yes\",\n \"HomeEmergencyCover\": \"No\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/policy-amend/create/batch","description":"

Creates a new amendment request against a specific policy.

The 'commmandName' command must be passed within the body of the request. The following commands are available:

ApiCreateDraft - creates a draft amendment which can then be completed, reviewed and submitted by the customer.
ApiSubmitAmend - creates and submits a draft amendment. Amendment details cannot be updated once this command has been executed.

Either PolicyPublicId or policyReference (Insurer Policy ID) can be used to key to the policy the Amendment relates to.

NB: where a field value is passed using the \"publicId\" as the field identifier, it is possible to instead use \"name\" and provide the field name to identify the field to be created/updated.

Fixed in this collection: corrected request path/method/body shape to match the live API (see accompanying review notes).

Updates details of an existing amendment record.

The 'commmandName' command must be passed within the body of the request. The following commands are available:

ApiUpdateDraft - updates a draft amendment with new or additional data
ApiSubmitDraft - submits the draft amendment. Amendment details cannot be updated once this command has been executed.
ApiCancelDraft - cancels a draft amendment.

Either publicId or reference (Amendment Reference Number) can be used to key to the amend being updated.

NB: where a field value is passed using the \"publicId\" as the field identifier, it is possible to instead use \"name\" and provide the field name to identify the field to be created/updated.

Fixed in this collection: corrected request path/method/body shape to match the live API (see accompanying review notes). Also corrected HTTP method from POST to PUT to match the API.

Retrieves the data stored on a specified amendment record.

Either Amendment Public ID (publicId) or Insurer Amendment Reference (reference) must be supplied.

A JSON Form is also returned at the end of the request, to allow the key-value pairs to be read.

The PublicID of the amendment.

\n","type":"text/plain"},"key":"publicId","value":""},{"description":{"content":"

The Insurer Amendment Reference for the amendment.

\n","type":"text/plain"},"key":"reference","value":"14B2FF1C"}],"variable":[]}},"response":[{"id":"3c0d8e0d-2ff5-43f1-ab39-f9a5ad91b25a","name":"Read Amendment Details - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/policy-amend/read?publicId=&reference=14B2FF1C","host":["{{base_url}}"],"path":["policy-amend","read"],"query":[{"key":"publicId","value":"","description":"The PublicID of the amendment."},{"key":"reference","value":"14B2FF1C","description":"The Insurer Amendment Reference for the amendment."}]},"description":"Retrieves the data stored on a specified amendment record.\n\nEither Amendment Public ID (`publicId`) or Insurer Amendment Reference (`reference`) must be supplied.\n\nA JSON Form is also returned at the end of the request, to allow the key-value pairs to be read."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jul 2026 09:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"publicId\": \"pam001a2b3c4d5e6f7a8b9c0d1e2f3a4\",\n \"reference\": \"EXT-2DDB990F\",\n \"fieldValues\": [\n {\n \"publicId\": \"fld_buildingscoverlimit\",\n \"value\": \"1000000\"\n },\n {\n \"publicId\": \"fld_familylegalcover\",\n \"value\": \"Yes\"\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"b0ba4b0a-be2b-4dce-8968-1bd2e8f3eace","name":"Read Amendment Details - Failure - Amendment Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/policy-amend/read?publicId=&reference=14B2FF1C","host":["{{base_url}}"],"path":["policy-amend","read"],"query":[{"key":"publicId","value":"","description":"The PublicID of the amendment."},{"key":"reference","value":"14B2FF1C","description":"The Insurer Amendment Reference for the amendment."}]},"description":"Retrieves the data stored on a specified amendment record.\n\nEither Amendment Public ID (`publicId`) or Insurer Amendment Reference (`reference`) must be supplied.\n\nA JSON Form is also returned at the end of the request, to allow the key-value pairs to be read."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 22 Jul 2026 09:00:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": false,\n \"failure\": {\n \"message\": \"PolicyAmend with Public Id or Reference 14B2FF1C doesn't exist\"\n }\n}"}],"_postman_id":"368473e5-2ecf-48b3-8c92-3f1ea5c7f32a"},{"name":"All Amends List","id":"67b7a1db-d0e5-432c-9461-f6b2c312ac57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/policy-amend/read/list?pageSize=&pageIndex=","description":"

Gets a list of all amendments on the ManageMy Platform, and their status.

The number of results to provide in the response. If blank, defaults to 1000.

\n","type":"text/plain"},"key":"pageSize","value":""},{"description":{"content":"

The results page to be returned, taking the pageSize parameter into account. If blanks, defaults to the first page.

\n","type":"text/plain"},"key":"pageIndex","value":""}],"variable":[]}},"response":[{"id":"c6c3e995-b253-445b-88b9-dafe2c4eccba","name":"All Customers List - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/customer/read/list?pageSize=5&pageIndex=4","host":["{{base_url}}"],"path":["customer","read","list"],"query":[{"key":"pageSize","value":"5","description":"The number of results to provide in the response. If blank, defaults to 1000"},{"key":"pageIndex","value":"4","description":"The results page to be returned, taking the pageSize parameter into account"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Nov 2020 11:04:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"items\": [\n {\n \"publicId\": \"d06ebee1a28a4318874926760e38c571\",\n \"firstName\": \"Monitoring\",\n \"lastName\": \"Monitoring\",\n \"policyNumber\": [],\n \"postCode\": \"Monitoring\",\n \"dateOfBirth\": \"2002-08-01T01:00:00Z\",\n \"email\": \"monitoring@managemy.com\",\n \"status\": \"Active\"\n },\n {\n \"publicId\": \"5ea6ecfc6daf400988060030527734aa\",\n \"firstName\": \"Mark\",\n \"lastName\": \"Moran\",\n \"policyNumber\": [\n \"MM23657\"\n ],\n \"postCode\": \"LS8 1BE\",\n \"dateOfBirth\": \"1981-01-01T00:00:00Z\",\n \"email\": \"mark2@managemy.com\",\n \"status\": \"Active\"\n },\n {\n \"publicId\": \"21b825504d3849b6b25b830238ccb9af\",\n \"firstName\": \"Mark\",\n \"lastName\": \"Moran\",\n \"policyNumber\": [],\n \"postCode\": \"LS17 6JS\",\n \"dateOfBirth\": \"1981-06-28T00:00:00Z\",\n \"email\": \"mark1@managemy.com\",\n \"status\": \"Active\"\n },\n {\n \"publicId\": \"b93a95995dc94a249bd11d0cf09e74ae\",\n \"reference\": \"Test-001\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"policyNumber\": [\n \"Pol-001\"\n ],\n \"postCode\": \"E1 1AB\",\n \"dateOfBirth\": \"1969-01-01T00:00:00Z\",\n \"email\": \"noreply@managemy.com\",\n \"status\": \"Unregistered\"\n },\n {\n \"publicId\": \"c231e0fe2c904821b0ee094fc90cd191\",\n \"reference\": \"Test-002\",\n \"firstName\": \"Alice\",\n \"lastName\": \"Jones\",\n \"policyNumber\": [],\n \"postCode\": \"LS1 1LS\",\n \"dateOfBirth\": \"1969-01-01T00:00:00Z\",\n \"email\": \"noreply2@managemy.com\",\n \"status\": \"Unregistered\"\n }\n ],\n \"count\": 25\n },\n \"isSuccess\": true\n}"}],"_postman_id":"67b7a1db-d0e5-432c-9461-f6b2c312ac57"}],"id":"21b262f8-83eb-413f-98a4-3a02bfb9416e","_postman_id":"21b262f8-83eb-413f-98a4-3a02bfb9416e","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Delete Policy Amends","item":[{"name":"Delete Policy Amendment","id":"e335568e-f925-4bdd-b536-2a51794872fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entities\": [\n {\n \"publicId\": \"string\",\n \"reference\": \"string\",\n \"customerPublicId\": \"string\",\n \"customerReference\": \"string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/policy-amend/delete/batch","description":"

Deletes a policy amendment request from the ManageMy platform.

Either publicId or reference (Insurer Amendment Reference) can be used to key to the Amendment.

Document uploads: see the shared Document Uploads section (use entityType: \"amendment\") rather than a copy here.

\n","_postman_id":"1788a65b-eb3c-4813-8913-0ff10af5162d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Customer Amends","item":[{"name":"Create Customer Amends","item":[{"name":"Create Customer Amends","id":"248f0530-f354-4c60-a95f-51df3467f81e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"customerPublicId\": \"\",\n \"customerReference\": \"Test-001\",\n \"commandName\": \"ApiCreateDraft\",\n \"values\": {\n \"AmendmentReason\": \"Change of address\",\n \"AddressLine1\": \"22 New Street\",\n \"City\": \"Manchester\",\n \"PostCode\": \"M1 2AB\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer-amend/create/batch","description":"

Creates one or more Customer Amendments in a single batch call. Each entry requires customerPublicId or customerReference to identify the customer being amended, a workflow commandName, and the field values for the amendment. Mirrors the Create Policy Amendment pattern but keys off the customer rather than a policy.

Previously an empty placeholder in the published docs — filled in with a working example matching the CustomerAmendController API.

\n","_postman_id":"b4554901-db8a-4325-a7c1-6bfe4b018a97","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Update Customer Amends","item":[{"name":"Update Customer Amends","id":"e8743426-bac9-442b-b716-bc3794c216ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"publicId\": \"\",\n \"reference\": \"EXT-CA00123\",\n \"commandName\": \"ApiUpdateDraft\",\n \"values\": {\n \"AddressLine1\": \"23 New Street\",\n \"City\": \"Manchester\",\n \"PostCode\": \"M1 2AB\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer-amend/update/batch","description":"

Updates one or more existing Customer Amendments. Identify each amendment by publicId or reference, and pass the workflow commandName plus the field values to change.

Previously an empty placeholder in the published docs — filled in with a working example matching the CustomerAmendController API.

\n","_postman_id":"0261d809-9f20-4d9d-bf52-91ad99b663cd","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Read Customer Amends","item":[{"name":"All Customer Amends List","id":"66d983f7-2ed2-4b9e-be4d-e7e53a4832ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/customer-amend/read/list?pageSize=&pageIndex=&customerReference=Test-001","description":"

Returns a paginated list of Customer Amendments. Supports optional pageSize/pageIndex paging and customerPublicId/customerReference filters.

Returns full details for a single Customer Amendment, identified by publicId or reference.

Previously an empty placeholder in the published docs — filled in with a working example matching the CustomerAmendController API.

\n","_postman_id":"c8c52b55-e56c-4bee-bfd4-e2ec051ce461","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Delete Customer Amends","item":[{"name":"Delete Customer Amends","id":"a8f8282c-6333-4459-a0a9-cc0950602944","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entities\": [\n {\n \"reference\": \"EXT-CA00123\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer-amend/delete/batch","description":"

Deletes one or more Customer Amendments, identified by publicId or reference.

Previously an empty placeholder in the published docs — filled in with a working example matching the CustomerAmendController API.

\n","_postman_id":"18a6bf28-be5d-4f99-8719-9f6d2e5de0a7","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}}],"id":"7d8882c8-93e0-42ab-8479-d0cd1a61676d","description":"

Document uploads: see the shared Document Uploads section (use entityType: \"customerAmend\") rather than a copy here.

\n","_postman_id":"7d8882c8-93e0-42ab-8479-d0cd1a61676d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Agencies","item":[{"name":"All Agencies List","id":"64d6e2fb-54a0-4336-baf8-58d6034a2683","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/agency/read/list?pageSize=&pageIndex=","description":"

Returns a paginated list of Agencies.

Returns full details for a single Agency, identified by publicId or code.

Returns the hierarchy of agents (workspace users) associated with an Agency, identified by publicId or code.

Creates one or more Agencies in a single batch call. Optionally set parentAgencyPublicId/parentAgencyCode to create the new agency as a child of an existing agency in the hierarchy. Field names inside \"values\" are illustrative — this API's forms are per-product configurable, so use GET config/product/{publicId}/workflows and GET config/form/{publicId} to discover the actual field set configured for your product before building integration payloads.

Updates one or more existing Agencies, identified by publicId or code. Field names inside \"values\" are illustrative — this API's forms are per-product configurable, so use GET config/product/{publicId}/workflows and GET config/form/{publicId} to discover the actual field set configured for your product before building integration payloads.

Deletes one or more Agencies, identified by publicId or code.

Assigns one or more Workspace Users (agents) to an Agency, identified by publicId or code. Agents are identified by publicId or staffId.

Removes one or more agents from an Agency.

Creates a reporting/hierarchy relationship between two agents already assigned to the same Agency (e.g. manager/subordinate).

Removes an existing parent/child relationship between two agents on an Agency.

Links one or more existing Agencies as children of a parent Agency, building the agency hierarchy (e.g. Broker Network > Broker Company > Broker Branch).

Unlinks one or more child Agencies from a parent Agency.

Manage Agencies and the agent hierarchy beneath them. Not present in the previously published collection — added to cover the full AgencyController surface.

\n","_postman_id":"f9758d0d-8c24-49cc-8eb4-c54bd9a5af60","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Workspace Users","item":[{"name":"All Workspace Users List","id":"8122720c-fb47-4531-bc59-099d0c6792b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/ws-user/read/list?pageSize=&pageIndex=","description":"

Returns a paginated list of Workspace Users (agents/staff).

Returns full details for a single Workspace User, identified by publicId or staffId.

Creates one or more Workspace Users in a single batch call. Field names inside \"values\" are illustrative — this API's forms are per-product configurable, so use GET config/product/{publicId}/workflows and GET config/form/{publicId} to discover the actual field set configured for your product before building integration payloads.

Updates one or more existing Workspace Users, identified by publicId or staffId. Field names inside \"values\" are illustrative — this API's forms are per-product configurable, so use GET config/product/{publicId}/workflows and GET config/form/{publicId} to discover the actual field set configured for your product before building integration payloads.

(Re)sends the registration invite email/link to one or more Workspace Users, identified by publicId or staffId.

Changes the status of one or more Workspace Users. Valid status values: Active, Suspended, Archived.

Deletes one or more Workspace Users, identified by publicId or staffId.

Manage Workspace Users (internal staff/agents). Not present in the previously published collection — added to cover the full WorkspaceUserController surface.

\n","_postman_id":"97faf3a0-8dc0-4131-b5b8-a5a70418cf56","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Payments","item":[{"name":"All Payments List","id":"62e1844c-2569-433e-b77f-ede861f62ae2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/payment/:entityType/list?entityPublicId=&entityReference=Pol-001&pageSize=&pageIndex=","description":"

Returns a paginated list of Payments linked to a parent entity. :entityType is one of Policy, Claim, Amendment, PolicyAddon; provide entityPublicId or entityReference to identify the parent entity.

Returns full details for a single Payment, identified by publicId or reference.

Creates one or more Payments against a parent entity (Policy/Claim/Amendment/PolicyAddon), identified by entityType + entityPublicId or entityReference. Field names inside \"values\" are illustrative — this API's forms are per-product configurable, so use GET config/product/{publicId}/workflows and GET config/form/{publicId} to discover the actual field set configured for your product before building integration payloads.

Updates one or more existing Payments, identified by publicId or reference. Field names inside \"values\" are illustrative — this API's forms are per-product configurable, so use GET config/product/{publicId}/workflows and GET config/form/{publicId} to discover the actual field set configured for your product before building integration payloads.

Deletes one or more Payments, identified by publicId or reference.

Read and manage Payments linked to Policies, Claims, Amendments, or Policy Addons. Not present in the previously published collection — added to cover the full PaymentController surface.

\n","_postman_id":"404cc57c-2253-425e-b91b-3d3ecc9e95b9","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Tasks","item":[{"name":"All Tasks List","id":"eec03451-d3a0-4cdd-8e79-8cf994278629","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/task/list?entityType=Policy&entityPublicId=&entityReference=Pol-001&pageSize=&pageIndex=","description":"

Returns a paginated list of Tasks. entityType/entityPublicId/entityReference optionally filter to tasks linked to a specific parent entity (e.g. a Policy or Claim).

Returns full details for a single Task, identified by publicId or reference.

Creates one or more Tasks, optionally linked to a parent entity (entityType + entityPublicId/entityReference), and against a Task Type (taskTypePublicId). Field names inside \"values\" are illustrative — this API's forms are per-product configurable, so use GET config/product/{publicId}/workflows and GET config/form/{publicId} to discover the actual field set configured for your product before building integration payloads.

Updates one or more existing Tasks, identified by publicId or reference. Field names inside \"values\" are illustrative — this API's forms are per-product configurable, so use GET config/product/{publicId}/workflows and GET config/form/{publicId} to discover the actual field set configured for your product before building integration payloads.

Deletes one or more Tasks, identified by publicId or reference.

Read and manage Tasks, optionally linked to a parent entity. Not present in the previously published collection — added to cover the full TaskController surface.

\n","_postman_id":"0737e58f-cc13-43f5-a7c7-7f44676781dd","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Messages","item":[{"name":"All Message Templates List","id":"4a215fb8-9a7a-4114-b588-7b30f7ddfcc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/message/templates/read/list?pageSize=&pageIndex=&type=","description":"

Returns a paginated list of Message Templates. type optionally filters to System, Workflow, or Campaign templates.

Returns a paginated list of Campaign Messages. status optionally filters to Scheduled or Sent campaigns.

Creates a single Campaign Message. Unlike most Create endpoints in this API, this is not a batch call — one campaign is created per request. siteType must be Customer or Workspace.

Updates an existing Campaign Message, identified by publicId.

Deletes an existing Campaign Message, identified by publicId.

Triggers a Workflow-type Message Template immediately for one or more recipients. Each recipient identifies the customer (publicId/reference) and, optionally, a related entity (entityType: one of Policy/Claim/Quote/Amendment/PolicyAddon + its own publicId/reference) plus freeform notificationData merge fields used by the template.

Read Message Templates, and create/manage/trigger Campaign Messages. Not present in the previously published collection — added to cover the full MessageController surface.

\n","_postman_id":"7c3c0044-27ad-431b-ad51-1659d0da336c","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Config","item":[{"name":"Products List","id":"ebad0133-e530-489e-8d4f-7dc1f1f2764d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/config/products","description":"

Returns the list of Products configured for this tenant, including their available workflow Commands and Queries.

Returns the list of Workflows (e.g. Policy, Claim, Quote workflows) configured for a given Product, identified by its publicId in the URL path.

Returns the field definitions of a single JSON Form, identified by its publicId in the URL path. Use this to discover the actual field names/types available before building Create/Update payloads.

Returns platform reference data: configured Document Types, Customer Statuses, and Policy Statuses.

Returns a paginated list of Theme Packages available to assign to Agencies/branding.

Read-only reference/configuration endpoints: Products, Product Workflows, Forms, platform reference data, and Theme Packages. Not present in the previously published collection — added to cover the full ConfigController surface. Especially useful for discovering the actual configurable field names referenced elsewhere in this collection's example bodies.

\n","_postman_id":"1af6619d-a128-41b7-a556-480f58c35e42","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}},{"name":"Action Logs","item":[{"name":"All Action Logs List","id":"fb82e5b6-4c80-4afd-9451-22e0b7285bae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/log/read/list?pageSize=&pageIndex=&entityId=&entityType=Policy&actionType=Update&applicationType=ExternalAPI&userId=","description":"

Returns a paginated, filterable audit trail of actions taken across the platform (create/update/delete/status-change/etc.) for compliance and integration monitoring. All filters are optional.

Read the platform's action/audit log. Not present in the previously published collection — added to cover the ActionLogController.

\n","_postman_id":"f3fd8e50-0f27-4983-8794-705544d27435","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","id":"ddd9a1b6-5e6d-4432-979a-edebe0862529","name":"ManageMy Published APIs (V5)","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"e77e66db-f547-479d-9e21-ff6da27c280c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"d39dd753-e689-4175-8a9c-d86064dc6255"}}]}