![](\"https://s3.eu-west-2.amazonaws.com/managemy.shared/Postman/Documentation/cloudfront_download_flow.png\")
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
\nThe ManageMy platform also supports data transmission through key-value pairs, where field names are used as keys. This method is often preferred by our Integration Partners, as it provides greater clarity in API calls by directly indicating what each value represents, eliminating the need to reference Public ID Data maps.
\nAs a JSON this is expressed as:
\n{\n \"entityFieldValuesModels\": [\n {\n \"commandName\": \"ExternalApiCreate\",\n \"values\": {\n \"InsurerCustomerReference\": \"CUST001\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"DateOfBirth\": \"19850105\",\n \"ZipCode\": \"30006\",\n \"PhoneNumber\": \"+44777777777\",\n \"PhoneNumberCountry\": \"us\",\n \"Email\": \"noreply@managemy.com\"\n }\n }\n ]\n}\n\nDyanmic 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, for multiple coverages on a policy, or multiple addresses for a customer. This enables the same field to be used in the data model for commonly re-used fields such as coverageName or addressLine1.
To support this, these re-used fields need to be encapsulated within what we refer to as a “repeatable group”. This means the data that is placed in this group can be entered multiple times. This encapsulation is done via the “groupFieldName” and “groupIndex” which must be provided alongside the individual field and its value.
\nThe below diagram represents this visually using a customer having multiple addresses as the example. The repeated elements are “AddressType” and “AddressLine1”. These are grouped using the “CustomerAddresses” group field
\nAs a JSON this is expressed as:
\n[\n {\n \"name\": \"AddressType\",\n \"value\": \"Home\",\n \"groupFieldName\": \"CustomerAddresses\",\n \"groupIndex\": 0\n },\n {\n \"name\": \"AddressLine1\",\n \"value\": \"123 Fake Street\",\n \"groupFieldName\": \" CustomerAddresses\",\n \"groupIndex\": 0\n },\n {\n \"name\": \"AddressType\",\n \"value\": \"Business\",\n \"groupFieldName\": \" CustomerAddresses\",\n \"groupIndex\": 1\n },\n {\n \"name\": \"AddressLine1\",\n \"value\": \"456 Park Avenue\",\n \"groupFieldName\": \" CustomerAddresses\",\n \"groupIndex\": 1\n }\n]\n\nThe groupIndex always starts at 0 for the first set of fields in any group, and increments upwards from there. The groupIndex numbering must always be sequential, without gaps, in the JSON.
\nUpdating Repeatable Groups
\nUpdating data in repeatable groups follows the same principles as creating repeatable group data, with the new values submitted instead.
Below is a diagram with the updated “AddressLine1” for the entry within “groupIndex”: 0
And as JSON:
\n[\n {\n \"name\": \"AddressType\",\n \"value\": \"Home\",\n \"groupFieldName\": \"CustomerAddresses\",\n \"groupIndex\": 0\n },\n {\n \"name\": \"AddressLine1\",\n \"value\": \"123 Main Street\",\n \"groupFieldName\": \" CustomerAddresses\",\n \"groupIndex\": 0\n },\n {\n \"name\": \"AddressType\",\n \"value\": \"Business\",\n \"groupFieldName\": \" CustomerAddresses\",\n \"groupIndex\": 1\n },\n {\n \"name\": \"AddressLine1\",\n \"value\": \"456 Park Avenue\",\n \"groupFieldName\": \" CustomerAddresses\",\n \"groupIndex\": 1\n }\n]\n\nRemoving Data from Repeatable Groups
\nIf you intend to delete only some of the repeatable groups you will need to include the data in the API call for the remaining groups and update the groupIndex values.
Please note - each remaining group must have at least one non ‘null’ field value.
E.g.
And as JSON:
JSON
[\n {\n \"name\": \"AddressType\",\n \"value\": \"Home\",\n \"groupFieldName\": \"CustomerAddresses\",\n \"groupIndex\": 0\n },\n {\n \"name\": \"AddressLine1\",\n \"value\": \"123 Main Street\",\n \"groupFieldName\": \" CustomerAddresses\",\n \"groupIndex\": 0\n }\n]\n\nRemoving all Data from a Repeatable Group
\nIt’s also possible to remove data across all repeatable groups by setting the first set of groupIndex values to ‘null’ (“groupIndex”: 0).
E.g.
And as JSON:
\n[\n {\n \"name\": \"AddressType\",\n \"value\": null,\n \"groupFieldName\": \"CustomerAddresses\",\n \"groupIndex\": 0\n },\n {\n \"name\": \"AddressLine1\",\n \"value\": null,\n \"groupFieldName\": \" CustomerAddresses\",\n \"groupIndex\": 0\n }\n]\n\nNested Repeatable Groups
It is also possible to nest repeatable groups within other repeatable groups. For example:
Coverages Group (“groupIndex”) > Beneficiaries Groups (“groupIndex2”) > Beneficiary Address Group (“groupIndex3”)
The platform supports up to 3 levels of nested groups, with the fields group beneath them, as per the example below.
Each level in the nested group will have its own groupFieldName and groupIndex.
E.g.
And as JSON:
JSON
[\n{\n\"name\": \"CoverageType\",\n\"value\": \"Term Life\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 0\n},\n{\n\"name\": \"CoverageAmount\",\n\"value\": \"100,000\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 0\n},\n{\n\"name\": \"BeneficiaryId\",\n\"value\": \"12345\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 0,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 0\n},\n{\n\"name\": \"BeneficiaryFullName\",\n\"value\": \"John Smith\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 0,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 0\n},\n{\n\"name\": \" AddressType\",\n\"value\": \"Residence\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 0,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 0,\n\"groupField3Name\": \"BeneficiaryAddresses\",\n\"groupIndex3\": 0\n},\n{\n\"name\": \"AddressLine1\",\n\"value\": \"123 Main Street\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 0,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 0,\n\"groupField3Name\": \"BeneficiaryAddresses\",\n\"groupIndex3\": 0\n}\n]\n\nFor a more complex example please see below:
\nAnd as JSON:
JSON
[\n{\n\"name\": \"CoverageType\",\n\"value\": \"Term Life\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 0\n},\n{\n\"name\": \"CoverageAmount\",\n\"value\": \"100,000\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 0\n},\n{\n\"name\": \"BeneficiaryId\",\n\"value\": \"12345\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 0,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 0\n},\n{\n\"name\": \"OwnerFirstName\",\n\"value\": \"John Smith\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 0,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 0\n},\n{\n\"name\": \" AdditionalCoveragePrimaryBeneAltAddressType\",\n\"value\": \"Residence\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 0,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 0,\n\"groupField3Name\": \"BeneficiaryAddresses\",\n\"groupIndex3\": 0\n},\n{\n\"name\": \"AdditionalCoveragePrimaryBeneAltAddressId\",\n\"value\": \"123 Main Street\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 0,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 0,\n\"groupField3Name\": \"BeneficiaryAddresses\",\n\"groupIndex3\": 0\n},\n{\n\"name\": \"CoverageType\",\n\"value\": \"Critical Illness\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 1\n},\n{\n\"name\": \"CoverageAmount\",\n\"value\": \"75,000\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 1\n},\n{\n\"name\": \"BeneficiaryId\",\n\"value\": \"12345\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 1,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 0\n},\n{\n\"name\": \"OwnerFirstName\",\n\"value\": \"John Smith\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 1,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 0\n},\n{\n\"name\": \"AdditionalCoveragePrimaryBeneAltAddressType\",\n\"value\": \"Residence\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 1,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 0,\n\"groupField3Name\": \"BeneficiaryAddresses\",\n\"groupIndex3\": 0\n},\n{\n\"name\": \"AdditionalCoveragePrimaryBeneAltAddressId\",\n\"value\": \"123 Main Street\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 1,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 0,\n\"groupField3Name\": \"BeneficiaryAddresses\",\n\"groupIndex3\": 0\n},\n{\n\"name\": \"BeneficiaryId\",\n\"value\": \"67890\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 1,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 1\n},\n{\n\"name\": \"OwnerFirstName\",\n\"value\": \"Jane Smith\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 1,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 1\n},\n{\n\"name\": \"AdditionalCoveragePrimaryBeneAltAddressType\",\n\"value\": \"Residence\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 1,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 1,\n\"groupField3Name\": \"BeneficiaryAddresses\",\n\"groupIndex3\": 0\n},\n{\n\"name\": \"AdditionalCoveragePrimaryBeneAltAddressId\",\n\"value\": \"21 Church Lane\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 1,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 1,\n\"groupField3Name\": \"BeneficiaryAddresses\",\n\"groupIndex3\": 0\n},\n{\n\"name\": \"AdditionalCoveragePrimaryBeneAltAddressType\",\n\"value\": \"Holiday\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 1,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 1,\n\"groupField3Name\": \"BeneficiaryAddresses\",\n\"groupIndex3\": 1\n},\n{\n\"name\": \"AdditionalCoveragePrimaryBeneAltAddressId\",\n\"value\": \"14 Lake View\",\n\"groupFieldName\": \"Coverages\",\n\"groupIndex\": 1,\n\"groupField2Name\": \"Beneficiaries\",\n\"groupIndex2\": 1,\n\"groupField3Name\": \"BeneficiaryAddresses\",\n\"groupIndex3\": 1\n}\n]\n\nUpdating and deleting data in nested repeatable groups follows the same principles as detailed in examples 2, 3 & 4 for repeatable groups, If you would like to remove group of data in a nested repeatable group, you must update the groupIndex values for all of the remaining nested groups to ensure numbering of the groupIndex values remain consecutive.
i.e. If you currently have data in nested repeatable groups with groupIndex:0 & groupIndex:1, (Beneficiary 1 and 2 for Coverage 2 in the above example), and you would like to remove the nested repeatable group ‘Beneficiary 1’ within ‘Coverage 2’, you will need to update the remaining groupIndex values for ‘Beneficiary 2’ to be groupIndex:0 , and it will now become ‘Beneficiary 1’.
E.g.
\nAnd as JSON:
\n[\n {\n \"name\": \"CoverageType\",\n \"value\": \"Term Life\",\n \"groupFieldName\": \"Coverages\",\n \"groupIndex\": 0\n },\n {\n \"name\": \"CoverageAmount\",\n \"value\": \"100,000\",\n \"groupFieldName\": \"Coverages\",\n \"groupIndex\": 0\n },\n {\n \"name\": \"BeneficiaryId\",\n \"value\": \"12345\",\n \"groupFieldName\": \"Coverages\",\n \"groupIndex\": 0,\n \"groupField2Name\": \"Beneficiaries\",\n \"groupIndex2\": 0\n },\n {\n \"name\": \"OwnerFirstName\",\n \"value\": \"John Smith\",\n \"groupFieldName\": \"Coverages\",\n \"groupIndex\": 0,\n \"groupField2Name\": \"Beneficiaries\",\n \"groupIndex2\": 0\n },\n {\n \"name\": \" AdditionalCoveragePrimaryBeneAltAddressType\",\n \"value\": \"Residence\",\n \"groupFieldName\": \"Coverages\",\n \"groupIndex\": 0,\n \"groupField2Name\": \"Beneficiaries\",\n \"groupIndex2\": 0,\n \"groupField3Name\": \"BeneficiaryAddresses\",\n \"groupIndex3\": 0\n },\n {\n \"name\": \"AdditionalCoveragePrimaryBeneAltAddressId\",\n \"value\": \"123 Main Street\",\n \"groupFieldName\": \"Coverages\",\n \"groupIndex\": 0,\n \"groupField2Name\": \"Beneficiaries\",\n \"groupIndex2\": 0,\n \"groupField3Name\": \"BeneficiaryAddresses\",\n \"groupIndex3\": 0\n },\n {\n \"name\": \"CoverageType\",\n \"value\": \"Critical Illness\",\n \"groupFieldName\": \"Coverages\",\n \"groupIndex\": 1\n },\n {\n \"name\": \"CoverageAmount\",\n \"value\": \"75,000\",\n \"groupFieldName\": \"Coverages\",\n \"groupIndex\": 1\n },\n {\n \"name\": \"BeneficiaryId\",\n \"value\": \"67890\",\n \"groupFieldName\": \"Coverages\",\n \"groupIndex\": 1,\n \"groupField2Name\": \"Beneficiaries\",\n \"groupIndex2\": 1\n },\n {\n \"name\": \"OwnerFirstName\",\n \"value\": \"Jane Smith\",\n \"groupFieldName\": \"Coverages\",\n \"groupIndex\": 1,\n \"groupField2Name\": \"Beneficiaries\",\n \"groupIndex2\": 1\n },\n {\n \"name\": \" AdditionalCoveragePrimaryBeneAltAddressType\",\n \"value\": \"Residence\",\n \"groupFieldName\": \"Coverages\",\n \"groupIndex\": 1,\n \"groupField2Name\": \"Beneficiaries\",\n \"groupIndex2\": 1,\n \"groupField3Name\": \"BeneficiaryAddresses\",\n \"groupIndex3\": 0\n },\n {\n \"name\": \"AdditionalCoveragePrimaryBeneAltAddressId\",\n \"value\": \"21 Church Lane\",\n \"groupFieldName\": \"Coverages\",\n \"groupIndex\": 1,\n \"groupField2Name\": \"Beneficiaries\",\n \"groupIndex2\": 1,\n \"groupField3Name\": \"BeneficiaryAddresses\",\n \"groupIndex3\": 0\n },\n {\n \"name\": \" AdditionalCoveragePrimaryBeneAltAddressType\",\n \"value\": \"Holiday\",\n \"groupFieldName\": \"Coverages\",\n \"groupIndex\": 1,\n \"groupField2Name\": \"Beneficiaries\",\n \"groupIndex2\": 1,\n \"groupField3Name\": \"BeneficiaryAddresses\",\n \"groupIndex3\": 1\n },\n {\n \"name\": \"AdditionalCoveragePrimaryBeneAltAddressId\",\n \"value\": \"14 Lake View\",\n \"groupFieldName\": \"Coverages\",\n \"groupIndex\": 1,\n \"groupField2Name\": \"Beneficiaries\",\n \"groupIndex2\": 1,\n \"groupField3Name\": \"BeneficiaryAddresses\",\n \"groupIndex3\": 1\n }\n]\n\nCreates new customer records, to which policies can be added and messages can be sent.
\nMultiple 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:
\nInsurerCustomerReference (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":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["customer","create","batch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"02a82557-6fcb-4874-905d-63840422c8cc","name":"Create New Customer - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"commandName\": \"ExternalApiCreate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-001\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_001\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mr\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"John\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"R\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Smith\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"Apartment 17\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"1 ManageMy Towers\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"Square Mile\"\n },\n {\n \"name\": \"City\",\n \"value\": \"London\"\n },\n {\n \"name\": \"County\",\n \"value\": \"Greater London\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"E1 1AB\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+447777777777\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441011111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply@managemy.com\"\n }\n ]\n },\n {\n \"commandName\": \"ExternalApiCreate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-002\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_002\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mrs\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"Alice\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Jones\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"3 Pigeon Street\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"City\",\n \"value\": \"Leeds\"\n },\n {\n \"name\": \"County\",\n \"value\": \"West Yorkshire\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"LS1 1LS\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+447111111111\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441131111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply2@managemy.com\"\n }\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":"2799d088-ad6e-464b-ab5d-dcb46148d0d4","name":"Create New Customers - Falied - Data Validation Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"commandName\": \"ExternalApiCreate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-101\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_101\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mr\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"John\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"R\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Smith\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"Apartment 17\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"1 ManageMy Towers\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"Square Mile\"\n },\n {\n \"name\": \"City\",\n \"value\": \"London\"\n },\n {\n \"name\": \"County\",\n \"value\": \"Greater London\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"E1 1AB\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"UK\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+447777777777\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441011111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply@managemy.com\"\n }\n ]\n },\n {\n \"commandName\": \"ExternalApiCreate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-102\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_102\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mrs\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"Alice\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Jones\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"3 Pigeon Street\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"City\",\n \"value\": \"Leeds\"\n },\n {\n \"name\": \"County\",\n \"value\": \"West Yorkshire\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"LS1 1LS\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"UK\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+447111111111\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441131111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply2@managemy.com\"\n }\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":"9f4b3945-ae19-41b5-832d-696b55dc5e89","name":"Create New Customer - Failed - Uniqueness Validation Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"commandName\": \"ExternalApiCreate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-001\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_001\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mr\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"John\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"R\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Smith\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"Apartment 17\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"1 ManageMy Towers\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"Square Mile\"\n },\n {\n \"name\": \"City\",\n \"value\": \"London\"\n },\n {\n \"name\": \"County\",\n \"value\": \"Greater London\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"E1 1AB\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+447777777777\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441011111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply@managemy.com\"\n }\n ]\n },\n {\n \"commandName\": \"ExternalApiCreate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-002\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_002\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mrs\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"Alice\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Jones\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"3 Pigeon Street\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"City\",\n \"value\": \"Leeds\"\n },\n {\n \"name\": \"County\",\n \"value\": \"West Yorkshire\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"LS1 1LS\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+447111111111\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441131111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply2@managemy.com\"\n }\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":"6dfddc80-510b-4528-987c-b3ec5c003a28","name":"Create New Customer - Failed - Unique Email Validation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"commandName\": \"ExternalApiCreate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-001\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_001\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mr\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"John\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"R\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Smith\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"Apartment 17\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"1 ManageMy Towers\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"Square Mile\"\n },\n {\n \"name\": \"City\",\n \"value\": \"London\"\n },\n {\n \"name\": \"County\",\n \"value\": \"Greater London\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"E1 1AB\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+447777777777\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441011111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply@managemy.com\"\n }\n ]\n },\n {\n \"commandName\": \"ExternalApiCreate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-002\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_002\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mrs\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"Alice\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Jones\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"3 Pigeon Street\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"City\",\n \"value\": \"Leeds\"\n },\n {\n \"name\": \"County\",\n \"value\": \"West Yorkshire\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"LS1 1LS\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+447111111111\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441131111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply2@managemy.com\"\n }\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":"68007fb0-408a-4c1c-8fc3-590dfc6de91e","name":"Create New Customer - Failed - Customer Reference Uniqueness Validation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"commandName\": \"ExternalApiCreate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-001\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_001\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mr\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"John\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"R\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Smith\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"Apartment 17\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"1 ManageMy Towers\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"Square Mile\"\n },\n {\n \"name\": \"City\",\n \"value\": \"London\"\n },\n {\n \"name\": \"County\",\n \"value\": \"Greater London\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"E1 1AB\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+447777777777\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441011111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply@managemy.com\"\n }\n ]\n },\n {\n \"commandName\": \"ExternalApiCreate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-002\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_002\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mrs\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"Alice\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Jones\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"3 Pigeon Street\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"City\",\n \"value\": \"Leeds\"\n },\n {\n \"name\": \"County\",\n \"value\": \"West Yorkshire\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"LS1 1LS\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+447111111111\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441131111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply2@managemy.com\"\n }\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":"e9243e60-9727-478b-af98-e7ebbd5e302a","name":"Create New Customers - Mixed Response - Successes and Failures","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"commandName\": \"ExternalApiCreate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-001\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_001\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mr\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"John\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"R\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Smith\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"Apartment 17\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"1 ManageMy Towers\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"Square Mile\"\n },\n {\n \"name\": \"City\",\n \"value\": \"London\"\n },\n {\n \"name\": \"County\",\n \"value\": \"Greater London\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"E1 1AB\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+447777777777\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441011111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply@managemy.com\"\n }\n ]\n },\n {\n \"commandName\": \"ExternalApiCreate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-001\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_002\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mrs\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"Alice\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Jones\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"3 Pigeon Street\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"City\",\n \"value\": \"Leeds\"\n },\n {\n \"name\": \"County\",\n \"value\": \"West Yorkshire\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"LS1 1LS\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+447111111111\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441131111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply2@managemy.com\"\n }\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":"852111ca-8d69-4fbb-8e1b-d061164234cd"}],"id":"13cbe7fe-8688-4eea-97ef-8f33193ad2c5","_postman_id":"13cbe7fe-8688-4eea-97ef-8f33193ad2c5","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Create Policies","item":[{"name":"Create Policies","id":"25aa624e-76a0-4f12-a519-1f986a9cb522","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 \"fieldValues\": [\n {\n \"name\": \"Reference\",\n \"value\": \"Pol-001\"\n },\n {\n \"name\": \"CoverType\",\n \"value\": \"Buildings & Contents\"\n },\n {\n \"name\": \"StartDate\",\n \"value\": \"01/01/2020\"\n },\n {\n \"name\": \"EndDate\",\n \"value\": \"31/12/2020\"\n },\n {\n \"name\": \"AnnualPremium\",\n \"value\": \"462.64\"\n },\n {\n \"name\": \"PaymentFrequency\",\n \"value\": \"Monthly\"\n },\n {\n \"name\": \"MonthlyPayment\",\n \"value\": \"42.49\"\n },\n {\n \"name\": \"TotalAnnualPayment\",\n \"value\": \"509.88\"\n },\n {\n \"name\": \"CreditCharge\",\n \"value\": \"47.24\"\n },\n {\n \"name\": \"APR\",\n \"value\": \"19.90\"\n },\n {\n \"name\": \"PolicyholderFullName\",\n \"value\": \"Mr John Smith\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderOccupation\",\n \"value\": \"Head of Product\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderBusiness\",\n \"value\": \"InsurTech\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine1\",\n \"value\": \"10 Lime Street\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine2\",\n \"value\": \"Langbourn\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyCity\",\n \"value\": \"London\"\n },\n {\n \"name\": \"InsuredPropertyCounty\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyPostCode\",\n \"value\": \"EC3M 7AA\"\n },\n {\n \"name\": \"InsuredPropertyCountry\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PropertyType\",\n \"value\": \"Detached House\"\n },\n {\n \"name\": \"YearOfBuild\",\n \"value\": \"1950\"\n },\n {\n \"name\": \"NoBedrooms\",\n \"value\": \"5\"\n },\n {\n \"name\": \"NoBathrooms\",\n \"value\": \"3\"\n },\n {\n \"name\": \"WallConstruction\",\n \"value\": \"Brick\"\n },\n {\n \"name\": \"RoofConstruction\",\n \"value\": \"Tile\"\n },\n {\n \"name\": \"BurglarAlarm\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SmokeDetector\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ListedBuilding\",\n \"value\": \"No\"\n },\n {\n \"name\": \"400mOfWater\",\n \"value\": \"No\"\n },\n {\n \"name\": \"BuildingsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"ContentsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"Occupancy\",\n \"value\": \"Policyholder\"\n },\n {\n \"name\": \"Adults\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Children\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Unoccupied\",\n \"value\": \"Up to 30 days\"\n },\n {\n \"name\": \"BusinessUse\",\n \"value\": \"None\"\n },\n {\n \"name\": \"BuildingsCoverLimit\",\n \"value\": \"Unlimited\"\n },\n {\n \"name\": \"BuildingsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"BuildingsExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"SubsidenceExcess\",\n \"value\": \"1000\"\n },\n {\n \"name\": \"BuildingsEscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"ContentsCoverLimit\",\n \"value\": \"50000\"\n },\n {\n \"name\": \"ContentsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ContentsClaimExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"PersonalEffectsExcess\",\n \"value\": \"50\"\n },\n {\n \"name\": \"EscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"CoverAwayFromTheHome\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SingleItemCoverLimit\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SpecifiedItems\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SpecifiedCycles\",\n \"value\": \"No\"\n },\n {\n \"name\": \"SpecifiedItemType\",\n \"value\": \"Art\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemDescription\",\n \"value\": \"Banksy Painting\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemValue\",\n \"value\": \"165000\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"FamilyLegalCover\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"HomeEmergencyCover\",\n \"value\": \"No\"\n },\n {\n \"name\": \"PolicyStatus\",\n \"value\": \"Active\"\n }\n ]\n },\n {\n \"productPublicId\": \"94ae1ca46427402db584b49bbac1dfea\",\n \"customerPublicId\": \"\",\n \"customerReference\": \"Test-002\",\n \"commandName\": \"ExternalApiCreate\",\n \"fieldValues\": [\n {\n \"name\": \"Reference\",\n \"value\": \"Pol-002\"\n },\n {\n \"name\": \"CoverType\",\n \"value\": \"Buildings & Contents\"\n },\n {\n \"name\": \"StartDate\",\n \"value\": \"01/01/2020\"\n },\n {\n \"name\": \"EndDate\",\n \"value\": \"31/12/2020\"\n },\n {\n \"name\": \"AnnualPremium\",\n \"value\": \"462.64\"\n },\n {\n \"name\": \"PaymentFrequency\",\n \"value\": \"Monthly\"\n },\n {\n \"name\": \"MonthlyPayment\",\n \"value\": \"42.49\"\n },\n {\n \"name\": \"TotalAnnualPayment\",\n \"value\": \"509.88\"\n },\n {\n \"name\": \"CreditCharge\",\n \"value\": \"47.24\"\n },\n {\n \"name\": \"APR\",\n \"value\": \"19.90\"\n },\n {\n \"name\": \"PolicyholderFullName\",\n \"value\": \"Mrs Alice Jones \",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderOccupation\",\n \"value\": \"Head of Development\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderBusiness\",\n \"value\": \"InsurTech\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine1\",\n \"value\": \"10 Lime Street\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine2\",\n \"value\": \"Langbourn\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyCity\",\n \"value\": \"London\"\n },\n {\n \"name\": \"InsuredPropertyCounty\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyPostCode\",\n \"value\": \"EC3M 7AA\"\n },\n {\n \"name\": \"InsuredPropertyCountry\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PropertyType\",\n \"value\": \"Detached House\"\n },\n {\n \"name\": \"YearOfBuild\",\n \"value\": \"1950\"\n },\n {\n \"name\": \"NoBedrooms\",\n \"value\": \"5\"\n },\n {\n \"name\": \"NoBathrooms\",\n \"value\": \"3\"\n },\n {\n \"name\": \"WallConstruction\",\n \"value\": \"Brick\"\n },\n {\n \"name\": \"RoofConstruction\",\n \"value\": \"Tile\"\n },\n {\n \"name\": \"BurglarAlarm\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SmokeDetector\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ListedBuilding\",\n \"value\": \"No\"\n },\n {\n \"name\": \"400mOfWater\",\n \"value\": \"No\"\n },\n {\n \"name\": \"BuildingsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"ContentsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"Occupancy\",\n \"value\": \"Policyholder\"\n },\n {\n \"name\": \"Adults\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Children\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Unoccupied\",\n \"value\": \"Up to 30 days\"\n },\n {\n \"name\": \"BusinessUse\",\n \"value\": \"None\"\n },\n {\n \"name\": \"BuildingsCoverLimit\",\n \"value\": \"Unlimited\"\n },\n {\n \"name\": \"BuildingsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"BuildingsExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"SubsidenceExcess\",\n \"value\": \"1000\"\n },\n {\n \"name\": \"BuildingsEscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"ContentsCoverLimit\",\n \"value\": \"50000\"\n },\n {\n \"name\": \"ContentsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ContentsClaimExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"PersonalEffectsExcess\",\n \"value\": \"50\"\n },\n {\n \"name\": \"EscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"CoverAwayFromTheHome\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SingleItemCoverLimit\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SpecifiedItems\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SpecifiedCycles\",\n \"value\": \"No\"\n },\n {\n \"name\": \"SpecifiedItemType\",\n \"value\": \"Art\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemDescription\",\n \"value\": \"Banksy Painting\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemValue\",\n \"value\": \"165000\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"FamilyLegalCover\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"HomeEmergencyCover\",\n \"value\": \"No\"\n },\n {\n \"name\": \"PolicyStatus\",\n \"value\": \"Active\"\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.
\nA 'commmandName' parameter must be passed within each object in the array.
By default, certain fields are validated to ensure uniqueness:
\nReference (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.
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.
\nAll 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.
\nProperties:
\nentityType - one of the valid entity types for which files can be uploadedpublicId - optional - the Public ID of the entity for which the file upload is intendedreference - optional - the Reference of the entity for which the file upload is intendeddocumentDate - 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 typesfileName - the intended file name - must have one of the configured allowed extensionsdocumentReference - optional - the intended document reference - must be uniqueAs 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.
\nIf 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”.
\nCurrently supported document types:
\nentityType must match one of the following valid values:
\nStage 2 requires each file to be uploaded as a binary to the uploadUrls received in stage 1, using a PUT request.
\nThe request should also include the following header key-value pairs:
\n“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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"protocol":"https","path":["uploads","6dbe6ec4e6494b429532f11905c9eb58"],"host":["cdn","managemy","managemy","com"],"query":[{"key":"Expires","value":"1705499489"},{"key":"Signature","value":"n03fbrOGO1xXOgd3z1-1iTbroTJcd-zNw5fAwrwiP95Eqx98bJ4lr-OF5KOWl8Qq0dWDNSseqm5z2FFQ1R0GJofzlHA4qv5Tx2Ef6cU0gt1HCE7BCklycaYeL8s9E0ytzS1JjIsUjAtBKLZpyCKpQHABgW9341fRxSReAJR-cWYBQtjpJ3BWboyBHpoPZWUf~BHxyn13XzZOHkGkAT62wXnHQjjjG-P9Fnnjtqb0Lp7aHvRU0fDlfFfXtelg6DWrh8Ntv0JQYfYLrCevv9OTyo2qnbMWfMpLAifFj0P62pqR2-SYT46pxVUEH4LU4k2Zd6pyEnh8O7CtaoongaFn6Q__"},{"key":"Key-Pair-Id","value":"K24PYBEIY6JP0"}],"variable":[]}},"response":[{"id":"516ff989-2167-4c95-ae66-2e13e7ea5fbb","name":"Upload CloudFront File - Success - 200 OK","originalRequest":{"method":"PUT","header":[{"key":"x-amz-acl","value":"bucket-owner-full-control","type":"text"},{"key":"Content-Type","value":"application/pdf","type":"text"}],"body":{"mode":"file","file":{"src":"/Users/jameshaig/Documents/Terms and conditions.pdf"}},"url":{"raw":"https://cdn.managemy.managemy.com/uploads/6dbe6ec4e6494b429532f11905c9eb58?Expires=1705499489&Signature=n03fbrOGO1xXOgd3z1-1iTbroTJcd-zNw5fAwrwiP95Eqx98bJ4lr-OF5KOWl8Qq0dWDNSseqm5z2FFQ1R0GJofzlHA4qv5Tx2Ef6cU0gt1HCE7BCklycaYeL8s9E0ytzS1JjIsUjAtBKLZpyCKpQHABgW9341fRxSReAJR-cWYBQtjpJ3BWboyBHpoPZWUf~BHxyn13XzZOHkGkAT62wXnHQjjjG-P9Fnnjtqb0Lp7aHvRU0fDlfFfXtelg6DWrh8Ntv0JQYfYLrCevv9OTyo2qnbMWfMpLAifFj0P62pqR2-SYT46pxVUEH4LU4k2Zd6pyEnh8O7CtaoongaFn6Q__&Key-Pair-Id=K24PYBEIY6JP0","protocol":"https","host":["cdn","managemy","managemy","com"],"path":["uploads","6dbe6ec4e6494b429532f11905c9eb58"],"query":[{"key":"Expires","value":"1705499489"},{"key":"Signature","value":"n03fbrOGO1xXOgd3z1-1iTbroTJcd-zNw5fAwrwiP95Eqx98bJ4lr-OF5KOWl8Qq0dWDNSseqm5z2FFQ1R0GJofzlHA4qv5Tx2Ef6cU0gt1HCE7BCklycaYeL8s9E0ytzS1JjIsUjAtBKLZpyCKpQHABgW9341fRxSReAJR-cWYBQtjpJ3BWboyBHpoPZWUf~BHxyn13XzZOHkGkAT62wXnHQjjjG-P9Fnnjtqb0Lp7aHvRU0fDlfFfXtelg6DWrh8Ntv0JQYfYLrCevv9OTyo2qnbMWfMpLAifFj0P62pqR2-SYT46pxVUEH4LU4k2Zd6pyEnh8O7CtaoongaFn6Q__"},{"key":"Key-Pair-Id","value":"K24PYBEIY6JP0"}]}},"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":"54e87826-11b9-4e9c-9ea3-bf48d3dfb120"},{"name":"Confirm CloudFront Uploads","id":"26ba730f-32f8-44ed-b1a1-b2d7f464d5f2","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.
\nOnce this stage is complete the files are available within the platform.
\nThe below list details the different properties for the API call and whether they are mandatory or optional:
\nentityType - mandatory - the entity type for which the file is being created - must be onepublicId - mandatory if reference is not provided - the Public ID of the entity for which the file is being createdreference - mandatory if publicId is not provided - the Reference of the entity for which the file is being createddocumentName - mandatory - the user-facing name of the documentfileName - mandatory - the file name being used if the document’s file is downloaded - must have one of the configured allowed extensionsdocumentDate - optional - the date of the document - must use the format yyyy-MM-dd HH:mm:ssdocumentType - mandatory - the document type - must be one of the valid document typesdocumentReference - optional - the document reference - must be unique if providedfilePublicId - 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 successfullynotifyCustomer - 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 customerAs 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.
\nIf 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”
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["docs","upload","cloudfront","confirm","batch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d58a3f0b-c1aa-4fbc-885e-592befb535ab","name":"Confirm CloudFront Uploads - Success","originalRequest":{"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"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jun 2022 15:16:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"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 \"filePublicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\",\n \"documentReference\": \"PolDoc-Pol-001-1\",\n \"success\": true \n },\n {\n \"filePublicId\": \"4b541ead53284464a30ee40f7d6c8a7f\",\n \"documentReference\": \"PolDoc-Pol-001-2\",\n \"success\": true\n },\n {\n \"filePublicId\": \"c47f6bb28d034a50b39cb6082070f035\",\n \"documentReference\": \"PolDoc-Pol-001-3\",\n \"success\": true\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"fa264981-27c0-419c-980d-e91a43a8f928","name":"Confirm CloudFront Uploads - Mixed Response","originalRequest":{"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"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"entitiesResult\": [\r\n {\r\n \"filePublicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\",\r\n \"documentReference\": \"PolDoc-Pol-001-1\",\r\n \"success\": false,\r\n \"errorMessage\": \"Error retrieving file meta-data from S3 storage. Status Code: NotFound for path: uploads/e67f344fd9ed4a79bfb520ce4337ed4e with Details: Error making request with Error Code NotFound and Http Status Code NotFound. No further error information was returned by the service.\"\r\n },\r\n {\r\n \"filePublicId\": \"4b541ead53284464a30ee40f7d6c8a7f\",\r\n \"documentReference\": \"PolDoc-Pol-001-2\",\r\n \"success\": false,\r\n \"errorMessage\": \"Error retrieving file meta-data from S3 storage. Status Code: NotFound for path: uploads/e67f344fd9ed4a79bfb520ce4337ed4e with Details: Error making request with Error Code NotFound and Http Status Code NotFound. No further error information was returned by the service.\"\r\n },\r\n {\r\n \"filePublicId\": \"c47f6bb28d034a50b39cb6082070f035\",\r\n \"documentReference\": \"PolDoc-Pol-001-3\",\r\n \"success\": true\r\n }\r\n ]\r\n },\r\n \"isSuccess\": true\r\n}"},{"id":"e38e7dda-a8f1-49ef-805a-8373d71ebb54","name":"Confirm CloudFront Uploads - Failed - No file found","originalRequest":{"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"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"entitiesResult\": [\r\n {\r\n \"filePublicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\",\r\n \"documentReference\": \"PolDoc-Pol-001-1\",\r\n \"success\": false,\r\n \"errorMessage\": \"Error retrieving file meta-data from S3 storage. Status Code: NotFound for path: uploads/e67f344fd9ed4a79bfb520ce4337ed4e with Details: Error making request with Error Code NotFound and Http Status Code NotFound. No further error information was returned by the service.\"\r\n },\r\n {\r\n \"filePublicId\": \"4b541ead53284464a30ee40f7d6c8a7f\",\r\n \"documentReference\": \"PolDoc-Pol-001-2\",\r\n \"success\": false,\r\n \"errorMessage\": \"Error retrieving file meta-data from S3 storage. Status Code: NotFound for path: uploads/e67f344fd9ed4a79bfb520ce4337ed4e with Details: Error making request with Error Code NotFound and Http Status Code NotFound. No further error information was returned by the service.\"\r\n },\r\n {\r\n \"filePublicId\": \"c47f6bb28d034a50b39cb6082070f035\",\r\n \"documentReference\": \"PolDoc-Pol-001-3\",\r\n \"success\": false,\r\n \"errorMessage\": \"Error retrieving file meta-data from S3 storage. Status Code: NotFound for path: uploads/e67f344fd9ed4a79bfb520ce4337ed4e with Details: Error making request with Error Code NotFound and Http Status Code NotFound. No further error information was returned by the service.\"\r\n }\r\n ]\r\n },\r\n \"isSuccess\": true\r\n}"}],"_postman_id":"26ba730f-32f8-44ed-b1a1-b2d7f464d5f2"},{"name":"Get File Download URLs","id":"a6b31796-b5c2-4cd3-a6dc-72e6a156ace4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n publicIds: [\r\n \"e67f344fd9ed4a79bfb520ce4337ed4e\",\r\n \"c47f6bb28d034a50b39cb6082070f035\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/file/url/batch","description":"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.
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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["file","url","batch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"28e95a9f-fb2f-49dd-afaa-7b4dd86fca77","name":"Get File Download URLs - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n publicIds: [\r\n \"e67f344fd9ed4a79bfb520ce4337ed4e\",\r\n \"c47f6bb28d034a50b39cb6082070f035\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/file/url/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jun 2022 15:17:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"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 \"url\": \"https://cdn.managemy.managemy.com/policies/233627/docs/e67f344fd9ed4a79bfb520ce4337ed4e?Expires=1705499496&Signature=WiCQpEbf2FAER-gsMilqZS1LtFNsF6PrjYfLxvUEwKrPlDzEHxYGbYvNxLbJAtL3AmOsjGbXdigfZ6kvfDVYBgHmd8FmZmypym26TfcX08Y7GxyFryf5fo6oK1I-rvZs679B4vTS8XfJ3KwjITP3ehBEvrXJi6JgOTEYCwjsCm0DHGryafAg77tZOQSRf6so-9epjvskhWCBSXULcxKMhWoj57We~6V1pv0P4yw2q0W3MHj8Ju2WAJ1RClB8F5BTT~3Og6JBxgWBoR2RKjWJqWlXrRoURmQdMBFIwQrsI0fWwId213WVgc1nolgHV5s1R-XVy-3XGE-naOx7K~0eZg__&Key-Pair-Id=K169JEIC6TX4IZ\",\n \"contentType\": \"\",\n \"fileName\": \"Policy Document.pdf\",\n \"success\": true,\n \"publicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\"\n },\n {\n \"url\": \"https://cdn.managemy.managemy.com/policies/233627/docs/c47f6bb28d034a50b39cb6082070f035?Expires=1705499496&Signature=WiCQpEbf2FAER-gsMilqZS1LtFNsF6PrjYfLxvUEwKrPlDzEHxYGbYvNxLbJAtL3AmOsjGbXdigfZ6kvfDVYBgHmd8FmZmypym26TfcX08Y7GxyFryf5fo6oK1I-rvZs679B4vTS8XfJ3KwjITP3ehBEvrXJi6JgOTEYCwjsCm0DHGryafAg77tZOQSRf6so-9epjvskhWCBSXULcxKMhWoj57We~6V1pv0P4yw2q0W3MHj8Ju2WAJ1RClB8F5BTT~3Og6JBxgWBoR2RKjWJqWlXrRoURmQdMBFIwQrsI0fWwId213WVgc1nolgHV5s1R-XVy-3XGE-naOx7K~0eZg__&Key-Pair-Id=K169JEIC6TX4IZ\",\n \"contentType\": \"\",\n \"fileName\": \"Policy Document.pdf\",\n \"success\": true,\n \"publicId\": \"c47f6bb28d034a50b39cb6082070f035\"\n },\n ]\n },\n \"isSuccess\": true\n}"},{"id":"00a7df64-6b59-4125-83d8-9e045474a536","name":"Get File Download URLs - Failed - File not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n publicIds: [\r\n \"e67f344fd9ed4a79bfb520ce4337ed4e\",\r\n \"5f30b9ffe87c4c3599f05eef2c84dcf5\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/file/url/batch"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"entitiesResult\": [\r\n {\r\n \"success\": false,\r\n \"publicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\",\r\n \"errorMessage\": \"File with PublicId: e67f344fd9ed4a79bfb520ce4337ed4e doesn't exist\"\r\n },\r\n {\r\n \"success\": false,\r\n \"publicId\": \"5f30b9ffe87c4c3599f05eef2c84dcf5\",\r\n \"errorMessage\": \"File with PublicId: 5f30b9ffe87c4c3599f05eef2c84dcf5 doesn't exist\"\r\n }\r\n ]\r\n },\r\n \"isSuccess\": true\r\n}"}],"_postman_id":"a6b31796-b5c2-4cd3-a6dc-72e6a156ace4"}],"id":"b134c46c-e58d-41c8-a985-ae2e3eb3df1a","description":"The document upload feature utilizes the Amazon Cloudfront services to ensure fast and efficient transfer of large quantities of digital files.
\nProcess Flow
\nIn order to upload files to the ManageMy platform using CloudFront a series of API calls need to be used in succession. These are covered in three different stages, as per the diagram below:
\nIt is possible to use the endpoints to upload multiple files.
\nThe diagram below shows how these endpoints should be coordinated to upload multiple files.
\nTriggers 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.
\nEither 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:
\nInvite 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:
\nEmail 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
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["customer","invite"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ee4fae19-63e2-47a3-b598-373d7bc3bd2b","name":"Invite Customers - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"publicId\": \"\",\n \"reference\": \"Test-001\",\n \"fieldValues\": [\n {\n \"name\": \"CustomerInviteReason\",\n \"value\": \"NewCustomer\"\n },\n {\n \"name\": \"InvitationMethod\",\n \"value\": \"[\\\"Email\\\",\\\"SMS\\\"]\"\n }\n ]\n },\n {\n \"publicId\": \"\",\n \"reference\": \"Test-002\",\n \"fieldValues\": [\n {\n \"name\": \"CustomerInviteReason\",\n \"value\": \"NewCustomer\"\n },\n {\n \"name\": \"InvitationMethod\",\n \"value\": \"[\\\"Email\\\"]\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/invite"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 18:13: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\": true,\n \"publicId\": \"a6d0931a34ae4247bb498f4f5612f29c\",\n \"reference\": \"Test-001\"\n },\n {\n \"success\": true,\n \"publicId\": \"9cef2637e20945e881ede7e50082f793\",\n \"reference\": \"Test-002\"\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"208415d5-0699-43d6-bbb1-8bfc66c625fe","name":"Invite Customers - Mixed Response - Success and Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"publicId\": \"\",\n \"reference\": \"Test-003\",\n \"fieldValues\": [\n {\n \"name\": \"CustomerInviteReason\",\n \"value\": \"NewCustomer\"\n },\n {\n \"name\": \"InvitationMethod\",\n \"value\": \"[\\\"Email\\\",\\\"SMS\\\"]\"\n }\n ]\n },\n {\n \"publicId\": \"\",\n \"reference\": \"Test-002\",\n \"fieldValues\": [\n {\n \"name\": \"CustomerInviteReason\",\n \"value\": \"NewCustomer\"\n },\n {\n \"name\": \"InvitationMethod\",\n \"value\": \"[\\\"Email\\\"]\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/invite"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 18:14:42 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\": \"\",\n \"reference\": \"Test-003\",\n \"errorMessage\": \"Customer with Public Id '' or Reference 'Test-003' doesn't exist\"\n },\n {\n \"success\": true,\n \"publicId\": \"9cef2637e20945e881ede7e50082f793\",\n \"reference\": \"Test-002\"\n }\n ]\n },\n \"isSuccess\": true\n}"}],"_postman_id":"2dc65aff-528d-46cd-8373-093949e0114b"}],"id":"64a2a7e3-c9a9-4b85-b6c5-0cfb4f63ab20","_postman_id":"64a2a7e3-c9a9-4b85-b6c5-0cfb4f63ab20","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}}],"id":"ab4decd7-0f0d-455c-aef0-1afde3256725","description":"The following examples illustrate how to onboard customers, policies and documents to the ManageMy platform.
\n","_postman_id":"ab4decd7-0f0d-455c-aef0-1afde3256725","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Updates","item":[{"name":"Update Customer Details","id":"3de0bc8a-d35c-4501-a191-b6b5eb0ae64f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"publicID\": \"\",\n \"reference\": \"Test-001\",\n \"commandName\": \"ExternalApiUpdate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-001\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_001\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mr\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"John\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"R\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Smith\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"Apartment 17\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"1 ManageMy Towers\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"Square Mile\"\n },\n {\n \"name\": \"City\",\n \"value\": \"London\"\n },\n {\n \"name\": \"County\",\n \"value\": \"Greater London\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"E1 1AB\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+44777777777\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441011111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply@managemy.com\"\n }\n ]\n },\n {\n \"publicID\": \"\",\n \"reference\": \"Test-002\",\n \"commandName\": \"ExternalApiUpdate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-002\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_002\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mrs\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"Alice\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Jones\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"3 Pigeon Street\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"City\",\n \"value\": \"Leeds\"\n },\n {\n \"name\": \"County\",\n \"value\": \"West Yorkshire\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"LS1 1LS\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+447111111111\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441131111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply2@managemy.com\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/update/batch","description":"Updates data on a customer record.
\nMultiple customers can be updated in a single API call, using the 'entityFieldValueModels' array structure.
\nA '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:
\nInsurerCustomerReference (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.
\n","urlObject":{"path":["customer","update","batch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"dd8d2ac9-203f-43df-9304-477f2de4c23b","name":"Update Customer Details - Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"publicID\": \"\",\n \"reference\": \"Test-001\",\n \"commandName\": \"ExternalApiUpdate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-001\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_001\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mr\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"John\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"R\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Smith\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"Apartment 17\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"1 ManageMy Towers\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"Square Mile\"\n },\n {\n \"name\": \"City\",\n \"value\": \"London\"\n },\n {\n \"name\": \"County\",\n \"value\": \"Greater London\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"E1 1AB\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+44777777777\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441011111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply@managemy.com\"\n }\n ]\n },\n {\n \"publicID\": \"\",\n \"reference\": \"Test-002\",\n \"commandName\": \"ExternalApiUpdate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-002\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_002\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mrs\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"Alice\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Jones\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"3 Pigeon Street\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"City\",\n \"value\": \"Leeds\"\n },\n {\n \"name\": \"County\",\n \"value\": \"West Yorkshire\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"LS1 1LS\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+447111111111\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441131111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply2@managemy.com\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/update/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 25 Nov 2020 08:33: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 \"entitiesResult\": [\n {\n \"success\": true,\n \"publicId\": \"a6d0931a34ae4247bb498f4f5612f29c\",\n \"reference\": \"Test-001\"\n },\n {\n \"success\": true,\n \"publicId\": \"9cef2637e20945e881ede7e50082f793\",\n \"reference\": \"Test-002\"\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"5d1a9e2f-21f2-4f33-a775-3e866b842e8c","name":"Update Customer Details - Failure - Invalid CommandName","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"publicID\": \"\",\n \"reference\": \"Test-001\",\n \"commandName\": \"ExternalApiUpdated\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-001\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_001\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mr\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"John\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"R\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Smith\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"Apartment 17\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"1 ManageMy Towers\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"Square Mile\"\n },\n {\n \"name\": \"City\",\n \"value\": \"London\"\n },\n {\n \"name\": \"County\",\n \"value\": \"Greater London\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"E1 1AB\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+44777777777\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441011111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply@managemy.com\"\n }\n ]\n },\n {\n \"publicID\": \"\",\n \"reference\": \"Test-002\",\n \"commandName\": \"ExternalApiUpdated\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-002\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_002\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mrs\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"Alice\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Jones\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"3 Pigeon Street\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"City\",\n \"value\": \"Leeds\"\n },\n {\n \"name\": \"County\",\n \"value\": \"West Yorkshire\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"LS1 1LS\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+447111111111\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441131111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply2@managemy.com\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/update/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 25 Nov 2020 08:36:03 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\": \"a6d0931a34ae4247bb498f4f5612f29c\",\n \"reference\": \"Test-001\",\n \"errorMessage\": \"Customer cannot be updated as the 'ExternalApiUpdated' cannot be found for the Customer workflow\"\n },\n {\n \"success\": false,\n \"publicId\": \"9cef2637e20945e881ede7e50082f793\",\n \"reference\": \"Test-002\",\n \"errorMessage\": \"Customer cannot be updated as the 'ExternalApiUpdated' cannot be found for the Customer workflow\"\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"00606568-0a00-4d71-ba76-c90292efcf17","name":"Update Customer Details - Failure - Uniqueness Validation Fails","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"publicID\": \"\",\n \"reference\": \"Test-001\",\n \"commandName\": \"ExternalApiUpdate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-002\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_001\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mr\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"John\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"R\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Smith\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"Apartment 17\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"1 ManageMy Towers\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"Square Mile\"\n },\n {\n \"name\": \"City\",\n \"value\": \"London\"\n },\n {\n \"name\": \"County\",\n \"value\": \"Greater London\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"E1 1AB\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+44777777777\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441011111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply@managemy.com\"\n }\n ]\n },\n {\n \"publicID\": \"\",\n \"reference\": \"Test-002\",\n \"commandName\": \"ExternalApiUpdate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-002\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_002\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mrs\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"Alice\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Jones\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"3 Pigeon Street\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"City\",\n \"value\": \"Leeds\"\n },\n {\n \"name\": \"County\",\n \"value\": \"West Yorkshire\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"LS1 1LS\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+447111111111\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441131111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply2@managemy.com\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/update/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 25 Nov 2020 08:34:46 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\": \"a6d0931a34ae4247bb498f4f5612f29c\",\n \"reference\": \"Test-001\",\n \"errorMessage\": \"Validation Error\",\n \"validationErrors\": [\n {\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 \"publicId\": \"9cef2637e20945e881ede7e50082f793\",\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":"4ef571d6-bff9-4219-ba44-202fdf476030","name":"Update Customer Details - Mixed Response - Success and Failure","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"publicID\": \"\",\n \"reference\": \"Test-004\",\n \"commandName\": \"ExternalApiUpdate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-001\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_001\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mr\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"John\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"R\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Smith\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"Apartment 17\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"1 ManageMy Towers\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"Square Mile\"\n },\n {\n \"name\": \"City\",\n \"value\": \"London\"\n },\n {\n \"name\": \"County\",\n \"value\": \"Greater London\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"E1 1AB\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+44777777777\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441011111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply@managemy.com\"\n }\n ]\n },\n {\n \"publicID\": \"\",\n \"reference\": \"Test-002\",\n \"commandName\": \"ExternalApiUpdate\",\n \"fieldValues\": [\n {\n \"name\": \"InsurerCustomerReference\",\n \"value\": \"Test-002\"\n },\n {\n \"name\": \"UniqueRegistrationId\",\n \"value\": \"URI_002\"\n },\n {\n \"name\": \"PersonTitle\",\n \"value\": \"Mrs\"\n },\n {\n \"name\": \"FirstName\",\n \"value\": \"Alice\"\n },\n {\n \"name\": \"MiddleName\",\n \"value\": \"\"\n },\n {\n \"name\": \"LastName\",\n \"value\": \"Jones\"\n },\n {\n \"name\": \"DateOfBirth\",\n \"value\": \"01/01/1969\"\n },\n {\n \"name\": \"Address\",\n \"value\": \"3 Pigeon Street\"\n },\n {\n \"name\": \"AddressLine2\",\n \"value\": \"\"\n },\n {\n \"name\": \"AddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"City\",\n \"value\": \"Leeds\"\n },\n {\n \"name\": \"County\",\n \"value\": \"West Yorkshire\"\n },\n {\n \"name\": \"PostCode\",\n \"value\": \"LS1 1LS\"\n },\n {\n \"name\": \"Country\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PhoneNumber\",\n \"value\": \"+447111111111\"\n },\n {\n \"name\": \"HomePhoneNumber\",\n \"value\": \"+441131111111\"\n },\n {\n \"name\": \"Email\",\n \"value\": \"noreply2@managemy.com\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/customer/update/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 25 Nov 2020 08:33: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 \"entitiesResult\": [\n {\n \"success\": false,\n \"publicId\": \"\",\n \"reference\": \"Test-004\",\n \"errorMessage\": \"Customer with Public Id '' or Reference 'Test-004' doesn't exist\"\n },\n {\n \"success\": true,\n \"publicId\": \"9cef2637e20945e881ede7e50082f793\",\n \"reference\": \"Test-002\"\n }\n ]\n },\n \"isSuccess\": true\n}"}],"_postman_id":"3de0bc8a-d35c-4501-a191-b6b5eb0ae64f"},{"name":"Update Policy Details","id":"f5b41a38-b723-4caa-9277-e612db0b8889","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"entityFieldValuesModels\": [\n {\n \"publicId\": \"\",\n \"reference\": \"Pol-001\",\n \"commandName\": \"ExternalApiUpdate\",\n \"fieldValues\": [\n {\n \"name\": \"Reference\",\n \"value\": \"Pol-001\"\n },\n {\n \"name\": \"CoverType\",\n \"value\": \"Buildings & Contents\"\n },\n {\n \"name\": \"StartDate\",\n \"value\": \"01/01/2020\"\n },\n {\n \"name\": \"EndDate\",\n \"value\": \"31/12/2020\"\n },\n {\n \"name\": \"AnnualPremium\",\n \"value\": \"462.64\"\n },\n {\n \"name\": \"PaymentFrequency\",\n \"value\": \"Monthly\"\n },\n {\n \"name\": \"MonthlyPayment\",\n \"value\": \"42.49\"\n },\n {\n \"name\": \"TotalAnnualPayment\",\n \"value\": \"509.88\"\n },\n {\n \"name\": \"CreditCharge\",\n \"value\": \"47.24\"\n },\n {\n \"name\": \"APR\",\n \"value\": \"19.90\"\n },\n {\n \"name\": \"PolicyholderFullName\",\n \"value\": \"Mr John Smith\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderOccupation\",\n \"value\": \"Head of Product\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderBusiness\",\n \"value\": \"InsurTech\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine1\",\n \"value\": \"10 Lime Street\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine2\",\n \"value\": \"Langbourn\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyCity\",\n \"value\": \"London\"\n },\n {\n \"name\": \"InsuredPropertyCounty\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyPostCode\",\n \"value\": \"EC3M 7AA\"\n },\n {\n \"name\": \"InsuredPropertyCountry\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PropertyType\",\n \"value\": \"Detached House\"\n },\n {\n \"name\": \"YearOfBuild\",\n \"value\": \"1950\"\n },\n {\n \"name\": \"NoBedrooms\",\n \"value\": \"5\"\n },\n {\n \"name\": \"NoBathrooms\",\n \"value\": \"3\"\n },\n {\n \"name\": \"WallConstruction\",\n \"value\": \"Brick\"\n },\n {\n \"name\": \"RoofConstruction\",\n \"value\": \"Tile\"\n },\n {\n \"name\": \"BurglarAlarm\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SmokeDetector\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ListedBuilding\",\n \"value\": \"No\"\n },\n {\n \"name\": \"400mOfWater\",\n \"value\": \"No\"\n },\n {\n \"name\": \"BuildingsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"ContentsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"Occupancy\",\n \"value\": \"Policyholder\"\n },\n {\n \"name\": \"Adults\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Children\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Unoccupied\",\n \"value\": \"Up to 30 days\"\n },\n {\n \"name\": \"BusinessUse\",\n \"value\": \"None\"\n },\n {\n \"name\": \"BuildingsCoverLimit\",\n \"value\": \"Unlimited\"\n },\n {\n \"name\": \"BuildingsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"BuildingsExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"SubsidenceExcess\",\n \"value\": \"1000\"\n },\n {\n \"name\": \"BuildingsEscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"ContentsCoverLimit\",\n \"value\": \"50000\"\n },\n {\n \"name\": \"ContentsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ContentsClaimExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"PersonalEffectsExcess\",\n \"value\": \"50\"\n },\n {\n \"name\": \"EscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"CoverAwayFromTheHome\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SingleItemCoverLimit\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SpecifiedItems\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SpecifiedCycles\",\n \"value\": \"No\"\n },\n {\n \"name\": \"SpecifiedItemType\",\n \"value\": \"Art\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemDescription\",\n \"value\": \"Banksy Painting\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemValue\",\n \"value\": \"165000\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"FamilyLegalCover\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"HomeEmergencyCover\",\n \"value\": \"No\"\n },\n {\n \"name\": \"PolicyStatus\",\n \"value\": \"Active\"\n }\n ]\n },\n {\n \"productPublicId\": \"94ae1ca46427402db584b49bbac1dfea\",\n \"customerPublicId\": \"\",\n \"customerReference\": \"Test-002\",\n \"commandName\": \"ExternalApiUpdate\",\n \"fieldValues\": [\n {\n \"name\": \"Reference\",\n \"value\": \"Pol-002\"\n },\n {\n \"name\": \"CoverType\",\n \"value\": \"Buildings & Contents\"\n },\n {\n \"name\": \"StartDate\",\n \"value\": \"01/01/2020\"\n },\n {\n \"name\": \"EndDate\",\n \"value\": \"31/12/2020\"\n },\n {\n \"name\": \"AnnualPremium\",\n \"value\": \"462.64\"\n },\n {\n \"name\": \"PaymentFrequency\",\n \"value\": \"Monthly\"\n },\n {\n \"name\": \"MonthlyPayment\",\n \"value\": \"42.49\"\n },\n {\n \"name\": \"TotalAnnualPayment\",\n \"value\": \"509.88\"\n },\n {\n \"name\": \"CreditCharge\",\n \"value\": \"47.24\"\n },\n {\n \"name\": \"APR\",\n \"value\": \"19.90\"\n },\n {\n \"name\": \"PolicyholderFullName\",\n \"value\": \"Mrs Alice Jones \",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderOccupation\",\n \"value\": \"Head of Development\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderBusiness\",\n \"value\": \"InsurTech\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine1\",\n \"value\": \"10 Lime Street\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine2\",\n \"value\": \"Langbourn\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyCity\",\n \"value\": \"London\"\n },\n {\n \"name\": \"InsuredPropertyCounty\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyPostCode\",\n \"value\": \"EC3M 7AA\"\n },\n {\n \"name\": \"InsuredPropertyCountry\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PropertyType\",\n \"value\": \"Detached House\"\n },\n {\n \"name\": \"YearOfBuild\",\n \"value\": \"1950\"\n },\n {\n \"name\": \"NoBedrooms\",\n \"value\": \"5\"\n },\n {\n \"name\": \"NoBathrooms\",\n \"value\": \"3\"\n },\n {\n \"name\": \"WallConstruction\",\n \"value\": \"Brick\"\n },\n {\n \"name\": \"RoofConstruction\",\n \"value\": \"Tile\"\n },\n {\n \"name\": \"BurglarAlarm\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SmokeDetector\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ListedBuilding\",\n \"value\": \"No\"\n },\n {\n \"name\": \"400mOfWater\",\n \"value\": \"No\"\n },\n {\n \"name\": \"BuildingsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"ContentsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"Occupancy\",\n \"value\": \"Policyholder\"\n },\n {\n \"name\": \"Adults\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Children\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Unoccupied\",\n \"value\": \"Up to 30 days\"\n },\n {\n \"name\": \"BusinessUse\",\n \"value\": \"None\"\n },\n {\n \"name\": \"BuildingsCoverLimit\",\n \"value\": \"Unlimited\"\n },\n {\n \"name\": \"BuildingsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"BuildingsExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"SubsidenceExcess\",\n \"value\": \"1000\"\n },\n {\n \"name\": \"BuildingsEscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"ContentsCoverLimit\",\n \"value\": \"50000\"\n },\n {\n \"name\": \"ContentsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ContentsClaimExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"PersonalEffectsExcess\",\n \"value\": \"50\"\n },\n {\n \"name\": \"EscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"CoverAwayFromTheHome\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SingleItemCoverLimit\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SpecifiedItems\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SpecifiedCycles\",\n \"value\": \"No\"\n },\n {\n \"name\": \"SpecifiedItemType\",\n \"value\": \"Art\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemDescription\",\n \"value\": \"Banksy Painting\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemValue\",\n \"value\": \"165000\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"FamilyLegalCover\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"HomeEmergencyCover\",\n \"value\": \"No\"\n },\n {\n \"name\": \"PolicyStatus\",\n \"value\": \"Active\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/policy/update/batch","description":"Updates details on specific policies.
\nMultiple policies can be created in a single API call, using the 'entityFieldValueModels' array structure.
\n'commmandName' must be passed within each object in the array.
\nBy default, certain fields are validated as unique, if passed in the call:
\nReference (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","urlObject":{"path":["policy","update","batch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1a2145ea-d598-4524-9d08-07ea21422927","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 \"fieldValues\": [\n {\n \"name\": \"Reference\",\n \"value\": \"Pol-001\"\n },\n {\n \"name\": \"CoverType\",\n \"value\": \"Buildings & Contents\"\n },\n {\n \"name\": \"StartDate\",\n \"value\": \"01/01/2020\"\n },\n {\n \"name\": \"EndDate\",\n \"value\": \"31/12/2020\"\n },\n {\n \"name\": \"AnnualPremium\",\n \"value\": \"462.64\"\n },\n {\n \"name\": \"PaymentFrequency\",\n \"value\": \"Monthly\"\n },\n {\n \"name\": \"MonthlyPayment\",\n \"value\": \"42.49\"\n },\n {\n \"name\": \"TotalAnnualPayment\",\n \"value\": \"509.88\"\n },\n {\n \"name\": \"CreditCharge\",\n \"value\": \"47.24\"\n },\n {\n \"name\": \"APR\",\n \"value\": \"19.90\"\n },\n {\n \"name\": \"PolicyholderFullName\",\n \"value\": \"Mr John Smith\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderOccupation\",\n \"value\": \"Head of Product\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderBusiness\",\n \"value\": \"InsurTech\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine1\",\n \"value\": \"10 Lime Street\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine2\",\n \"value\": \"Langbourn\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyCity\",\n \"value\": \"London\"\n },\n {\n \"name\": \"InsuredPropertyCounty\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyPostCode\",\n \"value\": \"EC3M 7AA\"\n },\n {\n \"name\": \"InsuredPropertyCountry\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PropertyType\",\n \"value\": \"Detached House\"\n },\n {\n \"name\": \"YearOfBuild\",\n \"value\": \"1950\"\n },\n {\n \"name\": \"NoBedrooms\",\n \"value\": \"5\"\n },\n {\n \"name\": \"NoBathrooms\",\n \"value\": \"3\"\n },\n {\n \"name\": \"WallConstruction\",\n \"value\": \"Brick\"\n },\n {\n \"name\": \"RoofConstruction\",\n \"value\": \"Tile\"\n },\n {\n \"name\": \"BurglarAlarm\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SmokeDetector\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ListedBuilding\",\n \"value\": \"No\"\n },\n {\n \"name\": \"400mOfWater\",\n \"value\": \"No\"\n },\n {\n \"name\": \"BuildingsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"ContentsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"Occupancy\",\n \"value\": \"Policyholder\"\n },\n {\n \"name\": \"Adults\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Children\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Unoccupied\",\n \"value\": \"Up to 30 days\"\n },\n {\n \"name\": \"BusinessUse\",\n \"value\": \"None\"\n },\n {\n \"name\": \"BuildingsCoverLimit\",\n \"value\": \"Unlimited\"\n },\n {\n \"name\": \"BuildingsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"BuildingsExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"SubsidenceExcess\",\n \"value\": \"1000\"\n },\n {\n \"name\": \"BuildingsEscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"ContentsCoverLimit\",\n \"value\": \"50000\"\n },\n {\n \"name\": \"ContentsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ContentsClaimExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"PersonalEffectsExcess\",\n \"value\": \"50\"\n },\n {\n \"name\": \"EscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"CoverAwayFromTheHome\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SingleItemCoverLimit\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SpecifiedItems\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SpecifiedCycles\",\n \"value\": \"No\"\n },\n {\n \"name\": \"SpecifiedItemType\",\n \"value\": \"Art\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemDescription\",\n \"value\": \"Banksy Painting\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemValue\",\n \"value\": \"165000\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"FamilyLegalCover\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"HomeEmergencyCover\",\n \"value\": \"No\"\n },\n {\n \"name\": \"PolicyStatus\",\n \"value\": \"Active\"\n }\n ]\n },\n {\n \"productPublicId\": \"94ae1ca46427402db584b49bbac1dfea\",\n \"customerPublicId\": \"\",\n \"customerReference\": \"Test-002\",\n \"commandName\": \"ExternalApiCreate\",\n \"fieldValues\": [\n {\n \"name\": \"Reference\",\n \"value\": \"Pol-002\"\n },\n {\n \"name\": \"CoverType\",\n \"value\": \"Buildings & Contents\"\n },\n {\n \"name\": \"StartDate\",\n \"value\": \"01/01/2020\"\n },\n {\n \"name\": \"EndDate\",\n \"value\": \"31/12/2020\"\n },\n {\n \"name\": \"AnnualPremium\",\n \"value\": \"462.64\"\n },\n {\n \"name\": \"PaymentFrequency\",\n \"value\": \"Monthly\"\n },\n {\n \"name\": \"MonthlyPayment\",\n \"value\": \"42.49\"\n },\n {\n \"name\": \"TotalAnnualPayment\",\n \"value\": \"509.88\"\n },\n {\n \"name\": \"CreditCharge\",\n \"value\": \"47.24\"\n },\n {\n \"name\": \"APR\",\n \"value\": \"19.90\"\n },\n {\n \"name\": \"PolicyholderFullName\",\n \"value\": \"Mrs Alice Jones \",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderOccupation\",\n \"value\": \"Head of Development\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderBusiness\",\n \"value\": \"InsurTech\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine1\",\n \"value\": \"10 Lime Street\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine2\",\n \"value\": \"Langbourn\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyCity\",\n \"value\": \"London\"\n },\n {\n \"name\": \"InsuredPropertyCounty\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyPostCode\",\n \"value\": \"EC3M 7AA\"\n },\n {\n \"name\": \"InsuredPropertyCountry\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PropertyType\",\n \"value\": \"Detached House\"\n },\n {\n \"name\": \"YearOfBuild\",\n \"value\": \"1950\"\n },\n {\n \"name\": \"NoBedrooms\",\n \"value\": \"5\"\n },\n {\n \"name\": \"NoBathrooms\",\n \"value\": \"3\"\n },\n {\n \"name\": \"WallConstruction\",\n \"value\": \"Brick\"\n },\n {\n \"name\": \"RoofConstruction\",\n \"value\": \"Tile\"\n },\n {\n \"name\": \"BurglarAlarm\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SmokeDetector\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ListedBuilding\",\n \"value\": \"No\"\n },\n {\n \"name\": \"400mOfWater\",\n \"value\": \"No\"\n },\n {\n \"name\": \"BuildingsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"ContentsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"Occupancy\",\n \"value\": \"Policyholder\"\n },\n {\n \"name\": \"Adults\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Children\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Unoccupied\",\n \"value\": \"Up to 30 days\"\n },\n {\n \"name\": \"BusinessUse\",\n \"value\": \"None\"\n },\n {\n \"name\": \"BuildingsCoverLimit\",\n \"value\": \"Unlimited\"\n },\n {\n \"name\": \"BuildingsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"BuildingsExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"SubsidenceExcess\",\n \"value\": \"1000\"\n },\n {\n \"name\": \"BuildingsEscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"ContentsCoverLimit\",\n \"value\": \"50000\"\n },\n {\n \"name\": \"ContentsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ContentsClaimExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"PersonalEffectsExcess\",\n \"value\": \"50\"\n },\n {\n \"name\": \"EscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"CoverAwayFromTheHome\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SingleItemCoverLimit\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SpecifiedItems\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SpecifiedCycles\",\n \"value\": \"No\"\n },\n {\n \"name\": \"SpecifiedItemType\",\n \"value\": \"Art\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemDescription\",\n \"value\": \"Banksy Painting\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemValue\",\n \"value\": \"165000\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"FamilyLegalCover\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"HomeEmergencyCover\",\n \"value\": \"No\"\n },\n {\n \"name\": \"PolicyStatus\",\n \"value\": \"Active\"\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":"f4538724-8fab-4709-a243-7e66ddc01d9e","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 \"fieldValues\": [\n {\n \"name\": \"Reference\",\n \"value\": \"Pol-002\"\n },\n {\n \"name\": \"CoverType\",\n \"value\": \"Buildings & Contents\"\n },\n {\n \"name\": \"StartDate\",\n \"value\": \"01/01/2020\"\n },\n {\n \"name\": \"EndDate\",\n \"value\": \"31/12/2020\"\n },\n {\n \"name\": \"AnnualPremium\",\n \"value\": \"462.64\"\n },\n {\n \"name\": \"PaymentFrequency\",\n \"value\": \"Monthly\"\n },\n {\n \"name\": \"MonthlyPayment\",\n \"value\": \"42.49\"\n },\n {\n \"name\": \"TotalAnnualPayment\",\n \"value\": \"509.88\"\n },\n {\n \"name\": \"CreditCharge\",\n \"value\": \"47.24\"\n },\n {\n \"name\": \"APR\",\n \"value\": \"19.90\"\n },\n {\n \"name\": \"PolicyholderFullName\",\n \"value\": \"Mr John Smith\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderOccupation\",\n \"value\": \"Head of Product\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderBusiness\",\n \"value\": \"InsurTech\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine1\",\n \"value\": \"10 Lime Street\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine2\",\n \"value\": \"Langbourn\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyCity\",\n \"value\": \"London\"\n },\n {\n \"name\": \"InsuredPropertyCounty\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyPostCode\",\n \"value\": \"EC3M 7AA\"\n },\n {\n \"name\": \"InsuredPropertyCountry\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PropertyType\",\n \"value\": \"Detached House\"\n },\n {\n \"name\": \"YearOfBuild\",\n \"value\": \"1950\"\n },\n {\n \"name\": \"NoBedrooms\",\n \"value\": \"5\"\n },\n {\n \"name\": \"NoBathrooms\",\n \"value\": \"3\"\n },\n {\n \"name\": \"WallConstruction\",\n \"value\": \"Brick\"\n },\n {\n \"name\": \"RoofConstruction\",\n \"value\": \"Tile\"\n },\n {\n \"name\": \"BurglarAlarm\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SmokeDetector\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ListedBuilding\",\n \"value\": \"No\"\n },\n {\n \"name\": \"400mOfWater\",\n \"value\": \"No\"\n },\n {\n \"name\": \"BuildingsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"ContentsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"Occupancy\",\n \"value\": \"Policyholder\"\n },\n {\n \"name\": \"Adults\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Children\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Unoccupied\",\n \"value\": \"Up to 30 days\"\n },\n {\n \"name\": \"BusinessUse\",\n \"value\": \"None\"\n },\n {\n \"name\": \"BuildingsCoverLimit\",\n \"value\": \"Unlimited\"\n },\n {\n \"name\": \"BuildingsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"BuildingsExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"SubsidenceExcess\",\n \"value\": \"1000\"\n },\n {\n \"name\": \"BuildingsEscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"ContentsCoverLimit\",\n \"value\": \"50000\"\n },\n {\n \"name\": \"ContentsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ContentsClaimExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"PersonalEffectsExcess\",\n \"value\": \"50\"\n },\n {\n \"name\": \"EscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"CoverAwayFromTheHome\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SingleItemCoverLimit\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SpecifiedItems\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SpecifiedCycles\",\n \"value\": \"No\"\n },\n {\n \"name\": \"SpecifiedItemType\",\n \"value\": \"Art\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemDescription\",\n \"value\": \"Banksy Painting\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemValue\",\n \"value\": \"165000\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"FamilyLegalCover\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"HomeEmergencyCover\",\n \"value\": \"No\"\n },\n {\n \"name\": \"PolicyStatus\",\n \"value\": \"Active\"\n }\n ]\n },\n {\n \"productPublicId\": \"94ae1ca46427402db584b49bbac1dfea\",\n \"customerPublicId\": \"\",\n \"customerReference\": \"Pol-002\",\n \"commandName\": \"ExternalApiUpdate\",\n \"fieldValues\": [\n {\n \"name\": \"Reference\",\n \"value\": \"Pol-001\"\n },\n {\n \"name\": \"CoverType\",\n \"value\": \"Buildings & Contents\"\n },\n {\n \"name\": \"StartDate\",\n \"value\": \"01/01/2020\"\n },\n {\n \"name\": \"EndDate\",\n \"value\": \"31/12/2020\"\n },\n {\n \"name\": \"AnnualPremium\",\n \"value\": \"462.64\"\n },\n {\n \"name\": \"PaymentFrequency\",\n \"value\": \"Monthly\"\n },\n {\n \"name\": \"MonthlyPayment\",\n \"value\": \"42.49\"\n },\n {\n \"name\": \"TotalAnnualPayment\",\n \"value\": \"509.88\"\n },\n {\n \"name\": \"CreditCharge\",\n \"value\": \"47.24\"\n },\n {\n \"name\": \"APR\",\n \"value\": \"19.90\"\n },\n {\n \"name\": \"PolicyholderFullName\",\n \"value\": \"Mrs Alice Jones \",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderOccupation\",\n \"value\": \"Head of Development\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderBusiness\",\n \"value\": \"InsurTech\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine1\",\n \"value\": \"10 Lime Street\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine2\",\n \"value\": \"Langbourn\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyCity\",\n \"value\": \"London\"\n },\n {\n \"name\": \"InsuredPropertyCounty\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyPostCode\",\n \"value\": \"EC3M 7AA\"\n },\n {\n \"name\": \"InsuredPropertyCountry\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PropertyType\",\n \"value\": \"Detached House\"\n },\n {\n \"name\": \"YearOfBuild\",\n \"value\": \"1950\"\n },\n {\n \"name\": \"NoBedrooms\",\n \"value\": \"5\"\n },\n {\n \"name\": \"NoBathrooms\",\n \"value\": \"3\"\n },\n {\n \"name\": \"WallConstruction\",\n \"value\": \"Brick\"\n },\n {\n \"name\": \"RoofConstruction\",\n \"value\": \"Tile\"\n },\n {\n \"name\": \"BurglarAlarm\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SmokeDetector\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ListedBuilding\",\n \"value\": \"No\"\n },\n {\n \"name\": \"400mOfWater\",\n \"value\": \"No\"\n },\n {\n \"name\": \"BuildingsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"ContentsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"Occupancy\",\n \"value\": \"Policyholder\"\n },\n {\n \"name\": \"Adults\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Children\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Unoccupied\",\n \"value\": \"Up to 30 days\"\n },\n {\n \"name\": \"BusinessUse\",\n \"value\": \"None\"\n },\n {\n \"name\": \"BuildingsCoverLimit\",\n \"value\": \"Unlimited\"\n },\n {\n \"name\": \"BuildingsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"BuildingsExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"SubsidenceExcess\",\n \"value\": \"1000\"\n },\n {\n \"name\": \"BuildingsEscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"ContentsCoverLimit\",\n \"value\": \"50000\"\n },\n {\n \"name\": \"ContentsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ContentsClaimExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"PersonalEffectsExcess\",\n \"value\": \"50\"\n },\n {\n \"name\": \"EscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"CoverAwayFromTheHome\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SingleItemCoverLimit\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SpecifiedItems\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SpecifiedCycles\",\n \"value\": \"No\"\n },\n {\n \"name\": \"SpecifiedItemType\",\n \"value\": \"Art\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemDescription\",\n \"value\": \"Banksy Painting\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemValue\",\n \"value\": \"165000\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"FamilyLegalCover\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"HomeEmergencyCover\",\n \"value\": \"No\"\n },\n {\n \"name\": \"PolicyStatus\",\n \"value\": \"Active\"\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":"298f2b0b-1353-4c34-8fe3-1c9711881ab6","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 \"fieldValues\": [\n {\n \"name\": \"Reference\",\n \"value\": \"Pol-001\"\n },\n {\n \"name\": \"CoverType\",\n \"value\": \"Buildings & Contents\"\n },\n {\n \"name\": \"StartDate\",\n \"value\": \"\"\n },\n {\n \"name\": \"EndDate\",\n \"value\": \"31/12/2020\"\n },\n {\n \"name\": \"AnnualPremium\",\n \"value\": \"462.64\"\n },\n {\n \"name\": \"PaymentFrequency\",\n \"value\": \"Monthly\"\n },\n {\n \"name\": \"MonthlyPayment\",\n \"value\": \"42.49\"\n },\n {\n \"name\": \"TotalAnnualPayment\",\n \"value\": \"509.88\"\n },\n {\n \"name\": \"CreditCharge\",\n \"value\": \"47.24\"\n },\n {\n \"name\": \"APR\",\n \"value\": \"19.90\"\n },\n {\n \"name\": \"PolicyholderFullName\",\n \"value\": \"Mr John Smith\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderOccupation\",\n \"value\": \"Head of Product\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderBusiness\",\n \"value\": \"InsurTech\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine1\",\n \"value\": \"10 Lime Street\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine2\",\n \"value\": \"Langbourn\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyCity\",\n \"value\": \"London\"\n },\n {\n \"name\": \"InsuredPropertyCounty\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyPostCode\",\n \"value\": \"EC3M 7AA\"\n },\n {\n \"name\": \"InsuredPropertyCountry\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PropertyType\",\n \"value\": \"Detached House\"\n },\n {\n \"name\": \"YearOfBuild\",\n \"value\": \"1950\"\n },\n {\n \"name\": \"NoBedrooms\",\n \"value\": \"5\"\n },\n {\n \"name\": \"NoBathrooms\",\n \"value\": \"3\"\n },\n {\n \"name\": \"WallConstruction\",\n \"value\": \"Brick\"\n },\n {\n \"name\": \"RoofConstruction\",\n \"value\": \"Tile\"\n },\n {\n \"name\": \"BurglarAlarm\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SmokeDetector\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ListedBuilding\",\n \"value\": \"No\"\n },\n {\n \"name\": \"400mOfWater\",\n \"value\": \"No\"\n },\n {\n \"name\": \"BuildingsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"ContentsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"Occupancy\",\n \"value\": \"Policyholder\"\n },\n {\n \"name\": \"Adults\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Children\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Unoccupied\",\n \"value\": \"Up to 30 days\"\n },\n {\n \"name\": \"BusinessUse\",\n \"value\": \"None\"\n },\n {\n \"name\": \"BuildingsCoverLimit\",\n \"value\": \"Unlimited\"\n },\n {\n \"name\": \"BuildingsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"BuildingsExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"SubsidenceExcess\",\n \"value\": \"1000\"\n },\n {\n \"name\": \"BuildingsEscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"ContentsCoverLimit\",\n \"value\": \"50000\"\n },\n {\n \"name\": \"ContentsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ContentsClaimExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"PersonalEffectsExcess\",\n \"value\": \"50\"\n },\n {\n \"name\": \"EscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"CoverAwayFromTheHome\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SingleItemCoverLimit\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SpecifiedItems\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SpecifiedCycles\",\n \"value\": \"No\"\n },\n {\n \"name\": \"SpecifiedItemType\",\n \"value\": \"Art\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemDescription\",\n \"value\": \"Banksy Painting\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemValue\",\n \"value\": \"165000\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"FamilyLegalCover\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"HomeEmergencyCover\",\n \"value\": \"No\"\n },\n {\n \"name\": \"PolicyStatus\",\n \"value\": \"Active\"\n }\n ]\n },\n {\n \"productPublicId\": \"94ae1ca46427402db584b49bbac1dfea\",\n \"customerPublicId\": \"\",\n \"customerReference\": \"Pol-002\",\n \"commandName\": \"ExternalApiUpdate\",\n \"fieldValues\": [\n {\n \"name\": \"Reference\",\n \"value\": \"Pol-002\"\n },\n {\n \"name\": \"CoverType\",\n \"value\": \"Buildings & Contents\"\n },\n {\n \"name\": \"StartDate\",\n \"value\": \"01/01/2020\"\n },\n {\n \"name\": \"EndDate\",\n \"value\": \"31/12/2020\"\n },\n {\n \"name\": \"AnnualPremium\",\n \"value\": \"462.64\"\n },\n {\n \"name\": \"PaymentFrequency\",\n \"value\": \"Monthly\"\n },\n {\n \"name\": \"MonthlyPayment\",\n \"value\": \"42.49\"\n },\n {\n \"name\": \"TotalAnnualPayment\",\n \"value\": \"509.88\"\n },\n {\n \"name\": \"CreditCharge\",\n \"value\": \"47.24\"\n },\n {\n \"name\": \"APR\",\n \"value\": \"19.90\"\n },\n {\n \"name\": \"PolicyholderFullName\",\n \"value\": \"Mrs Alice Jones \",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderOccupation\",\n \"value\": \"Head of Development\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"PolicyholderBusiness\",\n \"value\": \"InsurTech\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"PolicyholdersGroup\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine1\",\n \"value\": \"10 Lime Street\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine2\",\n \"value\": \"Langbourn\"\n },\n {\n \"name\": \"InsuredPropertyAddressLine3\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyCity\",\n \"value\": \"London\"\n },\n {\n \"name\": \"InsuredPropertyCounty\",\n \"value\": \"\"\n },\n {\n \"name\": \"InsuredPropertyPostCode\",\n \"value\": \"EC3M 7AA\"\n },\n {\n \"name\": \"InsuredPropertyCountry\",\n \"value\": \"GBR\"\n },\n {\n \"name\": \"PropertyType\",\n \"value\": \"Detached House\"\n },\n {\n \"name\": \"YearOfBuild\",\n \"value\": \"1950\"\n },\n {\n \"name\": \"NoBedrooms\",\n \"value\": \"5\"\n },\n {\n \"name\": \"NoBathrooms\",\n \"value\": \"3\"\n },\n {\n \"name\": \"WallConstruction\",\n \"value\": \"Brick\"\n },\n {\n \"name\": \"RoofConstruction\",\n \"value\": \"Tile\"\n },\n {\n \"name\": \"BurglarAlarm\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SmokeDetector\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ListedBuilding\",\n \"value\": \"No\"\n },\n {\n \"name\": \"400mOfWater\",\n \"value\": \"No\"\n },\n {\n \"name\": \"BuildingsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"ContentsClaimsInLast3Years\",\n \"value\": \"0\"\n },\n {\n \"name\": \"Occupancy\",\n \"value\": \"Policyholder\"\n },\n {\n \"name\": \"Adults\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Children\",\n \"value\": \"2\"\n },\n {\n \"name\": \"Unoccupied\",\n \"value\": \"Up to 30 days\"\n },\n {\n \"name\": \"BusinessUse\",\n \"value\": \"None\"\n },\n {\n \"name\": \"BuildingsCoverLimit\",\n \"value\": \"Unlimited\"\n },\n {\n \"name\": \"BuildingsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"BuildingsExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"SubsidenceExcess\",\n \"value\": \"1000\"\n },\n {\n \"name\": \"BuildingsEscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"ContentsCoverLimit\",\n \"value\": \"50000\"\n },\n {\n \"name\": \"ContentsAccidentalDamage\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"ContentsClaimExcess\",\n \"value\": \"100\"\n },\n {\n \"name\": \"PersonalEffectsExcess\",\n \"value\": \"50\"\n },\n {\n \"name\": \"EscapeOfWaterExcess\",\n \"value\": \"350\"\n },\n {\n \"name\": \"CoverAwayFromTheHome\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SingleItemCoverLimit\",\n \"value\": \"5000\"\n },\n {\n \"name\": \"SpecifiedItems\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"SpecifiedCycles\",\n \"value\": \"No\"\n },\n {\n \"name\": \"SpecifiedItemType\",\n \"value\": \"Art\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemDescription\",\n \"value\": \"Banksy Painting\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"SpecifiedItemValue\",\n \"value\": \"165000\",\n \"groupIndex\": 0,\n \"groupFieldName\": \"SpecifiedItemsGroup\"\n },\n {\n \"name\": \"FamilyLegalCover\",\n \"value\": \"Yes\"\n },\n {\n \"name\": \"HomeEmergencyCover\",\n \"value\": \"No\"\n },\n {\n \"name\": \"PolicyStatus\",\n \"value\": \"Active\"\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":"f5b41a38-b723-4caa-9277-e612db0b8889"},{"name":"Manage Customer Access","id":"ac8b50ce-f5c6-4ab4-b531-f5f1125eb7d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"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.
\nEither 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:
\nApiSuspendCustomer\" - 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":"65d585af-9c25-4bde-bc4e-a0bb44dce066","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Deletions","item":[{"name":"Delete Customers","id":"a003282a-00cc-48b5-94af-fd8d08c2f24a","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.
\nDeletion of the customer account also deletes and policies, documents, and other entities (such as claims) attached to the customer account.
\nCustomerPublicID (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.
\nDeletion of the policy also deletes any documents and other entities (such as claims) attached to the policy.
\nPolicyPublicID (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.
\nentityPublicID (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":"dc796c9b-2977-4b0a-96e1-5612b2af5993","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Reading Data","item":[{"name":"All Customers List","id":"3f6a6766-a893-4ee2-acbb-dc54659a2bd1","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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["customer","read","list"],"host":["{{base_url}}"],"query":[{"key":"pageSize","value":""},{"key":"pageIndex","value":""}],"variable":[]}},"response":[{"id":"a4dfe11d-104f-4a3f-a573-fdb02b1fa81e","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":"3f6a6766-a893-4ee2-acbb-dc54659a2bd1"},{"name":"Read Customer Details","id":"96eb953c-0ed8-493b-8fb6-cbab7187eb94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/customer/read/?publicId=&reference=Test-001","description":"Retrieves the data stored on a specified customer record.
\nEither 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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["customer","read",""],"host":["{{base_url}}"],"query":[{"description":{"content":"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":"05f701ec-fd8a-4bf4-a8a2-cfd455291218","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":"053bac43-2e2a-4046-b6b4-8bcbfd0c06b5","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":"96eb953c-0ed8-493b-8fb6-cbab7187eb94"},{"name":"All Policies List","id":"40c38233-cf89-4d24-8891-10803c86ee5a","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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["policy","read","list"],"host":["{{base_url}}"],"query":[{"description":{"content":"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":"9309a8cd-68d7-439b-9ded-397ca22e38e4","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":"40c38233-cf89-4d24-8891-10803c86ee5a"},{"name":"Read Policy Details","id":"a01f1b23-0bc8-4a16-8912-941afb091365","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"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.
\nEither 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.
\n","urlObject":{"path":["policy","read"],"host":["{{base_url}}"],"query":[{"description":{"content":"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":"96620b59-faa5-4e01-91c5-9ba5316b86fd","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":"ca55c2a5-f06b-4fe2-87ac-2873610d8ca4","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":"a01f1b23-0bc8-4a16-8912-941afb091365"},{"name":"Documents List","id":"7d1a6da6-ef74-4201-9e45-a87aaa04a8f4","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)
\nEither 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:
\n“amendment”; “claim”; “customer”; “policy”; “policyAddon”; “product”; “productAddon”; “quote”; “renewal”;
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["docs",":entityType","list"],"host":["{{base_url}}"],"query":[{"description":{"content":"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":"390cd7a4-b698-48f3-8c9d-cbc3dd38c17d","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":"d3ea7363-a4d7-4702-bf24-0d0b2ad8047e","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":"9c192fb9-2f64-4091-9348-3faeead0f90d","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":"d5fe00d4-bb14-4a4e-9488-de2086f02ea2","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":"7d1a6da6-ef74-4201-9e45-a87aaa04a8f4"},{"name":"Download All Documents","id":"4a63c809-215c-419e-aa99-9b80231476a9","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.
\nEither 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:
\n“amendment”; “claim”; “customer”; “policy”; “policyAddon”; “product”; “productAddon”; “quote”; “renewal”;
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["docs",":entityType","download","batch"],"host":["{{base_url}}"],"query":[{"description":{"content":"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":"bd0bdfb5-0fa4-4ddc-9674-11eb08f73b04","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":"4a63c809-215c-419e-aa99-9b80231476a9"},{"name":"Download Specific Document","id":"1d5c45a8-cfc6-4d12-ab65-ec1e0d6fd637","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"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.
\nEither 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":"1d5c45a8-cfc6-4d12-ab65-ec1e0d6fd637"}],"id":"6c06118c-7c6b-478d-ad1f-6b1847868fa3","description":"APIs used to read customer and policy data, and download documents, from the ManageMy platform
\n","_postman_id":"6c06118c-7c6b-478d-ad1f-6b1847868fa3","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Claims","item":[{"name":"Create Claim","item":[{"name":"Create New Claim","id":"c879516f-6cee-43cf-b348-c87ac8188453","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"policyPublicId\": \"cb7ddc766d7149c7a0f0f12b75075afc\",\n \"policyReference\": \"\",\n \"commandName\": \"ApiCreateDraft\",\n \"fieldValues\": [\n {\n \"name\": \"Reference\",\n \"value\": \"MMTest001\"\n },\n {\n \"name\": \"DateOfIncident\",\n \"value\": \"2020-12-03\"\n },\n {\n \"name\": \"IncidentType\",\n \"value\": \"Damage to Underground Services\"\n },\n {\n \"name\": \"CauseOfLeak\",\n \"value\": \"No\"\n },\n {\n \"name\": \"ClaimDetails\",\n \"value\": \"\"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\"\"\n },\n {\n \"name\": \"IsHabitable\",\n \"value\": \"No\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/claim/create","description":"Creates a new claim against a specific policy.
\nThe '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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["claim","create"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c879516f-6cee-43cf-b348-c87ac8188453"}],"id":"058961cf-38f6-400c-bb9d-4fb8fb88adca","_postman_id":"058961cf-38f6-400c-bb9d-4fb8fb88adca","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Update Claim","item":[{"name":"Update Claim Details","id":"2c87fc94-3dbf-4578-94a7-f03f9264d7a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"publicId\": \"\",\n \"reference\": \"EXT-EE397262\",\n \"commandName\": \"ApiUpdateDraft\",\n \"fieldValues\": [\n {\n \"publicId\": \"fdd85e5c827449aa82e2d09af23cfed8\",\n \"value\": \"MMTest001\"\n },\n {\n \"publicId\": \"02ce94958411415a80fb380bdfc1b0b6\",\n \"value\": \"2020-12-03\"\n },\n {\n \"publicId\": \"fb305a12628c451ebb59d2fcdd64606a\",\n \"value\": \"Damage to Underground Services\"\n },\n {\n \"publicId\": \"94ba1f61b7024f15bbcce543a9c859a8\",\n \"value\": \"No\"\n },\n {\n \"publicId\": \"815d95ca0633497ea4a0bb2c0c36faa8\",\n \"value\": \"abcdefghi\"\n },\n {\n \"publicId\": \"aed27fc007c742aa930c0cb497fa6304\",\n \"value\": \"No\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/claim/update","description":"Updates details of an existing claim record.
\nThe '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 dataApiSubmitDraft - 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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["claim","update"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c87fc94-3dbf-4578-94a7-f03f9264d7a9"}],"id":"da5d38fe-a984-4057-aa18-346589dedb08","_postman_id":"da5d38fe-a984-4057-aa18-346589dedb08","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Upload Documents Copy","item":[{"name":"Get CloudFront Upload URLs","id":"91828344-a0af-4d61-86d9-6216ecfe2266","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.
\nAll 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.
\nProperties:
\nentityType - one of the valid entity types for which files can be uploadedpublicId - optional - the Public ID of the entity for which the file upload is intendedreference - optional - the Reference of the entity for which the file upload is intendeddocumentDate - 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 typesfileName - the intended file name - must have one of the configured allowed extensionsdocumentReference - optional - the intended document reference - must be uniqueAs 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.
\nIf 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”.
\nCurrently supported document types:
\nentityType must match one of the following valid values:
\nStage 2 requires each file to be uploaded as a binary to the uploadUrls received in stage 1, using a PUT request.
\nThe request should also include the following header key-value pairs:
\n“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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"protocol":"https","path":["uploads","6dbe6ec4e6494b429532f11905c9eb58"],"host":["cdn","managemy","managemy","com"],"query":[{"key":"Expires","value":"1705499489"},{"key":"Signature","value":"n03fbrOGO1xXOgd3z1-1iTbroTJcd-zNw5fAwrwiP95Eqx98bJ4lr-OF5KOWl8Qq0dWDNSseqm5z2FFQ1R0GJofzlHA4qv5Tx2Ef6cU0gt1HCE7BCklycaYeL8s9E0ytzS1JjIsUjAtBKLZpyCKpQHABgW9341fRxSReAJR-cWYBQtjpJ3BWboyBHpoPZWUf~BHxyn13XzZOHkGkAT62wXnHQjjjG-P9Fnnjtqb0Lp7aHvRU0fDlfFfXtelg6DWrh8Ntv0JQYfYLrCevv9OTyo2qnbMWfMpLAifFj0P62pqR2-SYT46pxVUEH4LU4k2Zd6pyEnh8O7CtaoongaFn6Q__"},{"key":"Key-Pair-Id","value":"K24PYBEIY6JP0"}],"variable":[]}},"response":[{"id":"34097ccb-85c1-4f36-a445-823f33b3330c","name":"Upload CloudFront File - Success - 200 OK","originalRequest":{"method":"PUT","header":[{"key":"x-amz-acl","value":"bucket-owner-full-control","type":"text"},{"key":"Content-Type","value":"application/pdf","type":"text"}],"body":{"mode":"file","file":{"src":"/Users/jameshaig/Documents/Terms and conditions.pdf"}},"url":{"raw":"https://cdn.managemy.managemy.com/uploads/6dbe6ec4e6494b429532f11905c9eb58?Expires=1705499489&Signature=n03fbrOGO1xXOgd3z1-1iTbroTJcd-zNw5fAwrwiP95Eqx98bJ4lr-OF5KOWl8Qq0dWDNSseqm5z2FFQ1R0GJofzlHA4qv5Tx2Ef6cU0gt1HCE7BCklycaYeL8s9E0ytzS1JjIsUjAtBKLZpyCKpQHABgW9341fRxSReAJR-cWYBQtjpJ3BWboyBHpoPZWUf~BHxyn13XzZOHkGkAT62wXnHQjjjG-P9Fnnjtqb0Lp7aHvRU0fDlfFfXtelg6DWrh8Ntv0JQYfYLrCevv9OTyo2qnbMWfMpLAifFj0P62pqR2-SYT46pxVUEH4LU4k2Zd6pyEnh8O7CtaoongaFn6Q__&Key-Pair-Id=K24PYBEIY6JP0","protocol":"https","host":["cdn","managemy","managemy","com"],"path":["uploads","6dbe6ec4e6494b429532f11905c9eb58"],"query":[{"key":"Expires","value":"1705499489"},{"key":"Signature","value":"n03fbrOGO1xXOgd3z1-1iTbroTJcd-zNw5fAwrwiP95Eqx98bJ4lr-OF5KOWl8Qq0dWDNSseqm5z2FFQ1R0GJofzlHA4qv5Tx2Ef6cU0gt1HCE7BCklycaYeL8s9E0ytzS1JjIsUjAtBKLZpyCKpQHABgW9341fRxSReAJR-cWYBQtjpJ3BWboyBHpoPZWUf~BHxyn13XzZOHkGkAT62wXnHQjjjG-P9Fnnjtqb0Lp7aHvRU0fDlfFfXtelg6DWrh8Ntv0JQYfYLrCevv9OTyo2qnbMWfMpLAifFj0P62pqR2-SYT46pxVUEH4LU4k2Zd6pyEnh8O7CtaoongaFn6Q__"},{"key":"Key-Pair-Id","value":"K24PYBEIY6JP0"}]}},"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":"adc5b963-9cb7-471e-bdee-611b8430518c"},{"name":"Confirm CloudFront Uploads","id":"ed904ff9-dc42-4585-903e-3beb47da7f0a","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.
\nOnce this stage is complete the files are available within the platform.
\nThe below list details the different properties for the API call and whether they are mandatory or optional:
\nentityType - mandatory - the entity type for which the file is being created - must be onepublicId - mandatory if reference is not provided - the Public ID of the entity for which the file is being createdreference - mandatory if publicId is not provided - the Reference of the entity for which the file is being createddocumentName - mandatory - the user-facing name of the documentfileName - mandatory - the file name being used if the document’s file is downloaded - must have one of the configured allowed extensionsdocumentDate - optional - the date of the document - must use the format yyyy-MM-dd HH:mm:ssdocumentType - mandatory - the document type - must be one of the valid document typesdocumentReference - optional - the document reference - must be unique if providedfilePublicId - 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 successfullynotifyCustomer - 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 customerAs 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.
\nIf 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”
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["docs","upload","cloudfront","confirm","batch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"01c5c741-23c3-4d79-a4d4-61d645704c90","name":"Confirm CloudFront Uploads - Success","originalRequest":{"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"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jun 2022 15:16:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"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 \"filePublicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\",\n \"documentReference\": \"PolDoc-Pol-001-1\",\n \"success\": true \n },\n {\n \"filePublicId\": \"4b541ead53284464a30ee40f7d6c8a7f\",\n \"documentReference\": \"PolDoc-Pol-001-2\",\n \"success\": true\n },\n {\n \"filePublicId\": \"c47f6bb28d034a50b39cb6082070f035\",\n \"documentReference\": \"PolDoc-Pol-001-3\",\n \"success\": true\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"da98d15c-05f3-4089-97c3-8531c0d7bf9f","name":"Confirm CloudFront Uploads - Mixed Response","originalRequest":{"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"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"entitiesResult\": [\r\n {\r\n \"filePublicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\",\r\n \"documentReference\": \"PolDoc-Pol-001-1\",\r\n \"success\": false,\r\n \"errorMessage\": \"Error retrieving file meta-data from S3 storage. Status Code: NotFound for path: uploads/e67f344fd9ed4a79bfb520ce4337ed4e with Details: Error making request with Error Code NotFound and Http Status Code NotFound. No further error information was returned by the service.\"\r\n },\r\n {\r\n \"filePublicId\": \"4b541ead53284464a30ee40f7d6c8a7f\",\r\n \"documentReference\": \"PolDoc-Pol-001-2\",\r\n \"success\": false,\r\n \"errorMessage\": \"Error retrieving file meta-data from S3 storage. Status Code: NotFound for path: uploads/e67f344fd9ed4a79bfb520ce4337ed4e with Details: Error making request with Error Code NotFound and Http Status Code NotFound. No further error information was returned by the service.\"\r\n },\r\n {\r\n \"filePublicId\": \"c47f6bb28d034a50b39cb6082070f035\",\r\n \"documentReference\": \"PolDoc-Pol-001-3\",\r\n \"success\": true\r\n }\r\n ]\r\n },\r\n \"isSuccess\": true\r\n}"},{"id":"78b9e78c-e22b-43f3-aede-0263cad24c88","name":"Confirm CloudFront Uploads - Failed - No file found","originalRequest":{"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"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"entitiesResult\": [\r\n {\r\n \"filePublicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\",\r\n \"documentReference\": \"PolDoc-Pol-001-1\",\r\n \"success\": false,\r\n \"errorMessage\": \"Error retrieving file meta-data from S3 storage. Status Code: NotFound for path: uploads/e67f344fd9ed4a79bfb520ce4337ed4e with Details: Error making request with Error Code NotFound and Http Status Code NotFound. No further error information was returned by the service.\"\r\n },\r\n {\r\n \"filePublicId\": \"4b541ead53284464a30ee40f7d6c8a7f\",\r\n \"documentReference\": \"PolDoc-Pol-001-2\",\r\n \"success\": false,\r\n \"errorMessage\": \"Error retrieving file meta-data from S3 storage. Status Code: NotFound for path: uploads/e67f344fd9ed4a79bfb520ce4337ed4e with Details: Error making request with Error Code NotFound and Http Status Code NotFound. No further error information was returned by the service.\"\r\n },\r\n {\r\n \"filePublicId\": \"c47f6bb28d034a50b39cb6082070f035\",\r\n \"documentReference\": \"PolDoc-Pol-001-3\",\r\n \"success\": false,\r\n \"errorMessage\": \"Error retrieving file meta-data from S3 storage. Status Code: NotFound for path: uploads/e67f344fd9ed4a79bfb520ce4337ed4e with Details: Error making request with Error Code NotFound and Http Status Code NotFound. No further error information was returned by the service.\"\r\n }\r\n ]\r\n },\r\n \"isSuccess\": true\r\n}"}],"_postman_id":"ed904ff9-dc42-4585-903e-3beb47da7f0a"},{"name":"Get File Download URLs","id":"c7a08a60-062b-49a2-978b-8f7328457df3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n publicIds: [\r\n \"e67f344fd9ed4a79bfb520ce4337ed4e\",\r\n \"c47f6bb28d034a50b39cb6082070f035\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/file/url/batch","description":"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.
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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["file","url","batch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"64806588-d274-48d9-a283-dd0fca567d15","name":"Get File Download URLs - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n publicIds: [\r\n \"e67f344fd9ed4a79bfb520ce4337ed4e\",\r\n \"c47f6bb28d034a50b39cb6082070f035\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/file/url/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jun 2022 15:17:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"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 \"url\": \"https://cdn.managemy.managemy.com/policies/233627/docs/e67f344fd9ed4a79bfb520ce4337ed4e?Expires=1705499496&Signature=WiCQpEbf2FAER-gsMilqZS1LtFNsF6PrjYfLxvUEwKrPlDzEHxYGbYvNxLbJAtL3AmOsjGbXdigfZ6kvfDVYBgHmd8FmZmypym26TfcX08Y7GxyFryf5fo6oK1I-rvZs679B4vTS8XfJ3KwjITP3ehBEvrXJi6JgOTEYCwjsCm0DHGryafAg77tZOQSRf6so-9epjvskhWCBSXULcxKMhWoj57We~6V1pv0P4yw2q0W3MHj8Ju2WAJ1RClB8F5BTT~3Og6JBxgWBoR2RKjWJqWlXrRoURmQdMBFIwQrsI0fWwId213WVgc1nolgHV5s1R-XVy-3XGE-naOx7K~0eZg__&Key-Pair-Id=K169JEIC6TX4IZ\",\n \"contentType\": \"\",\n \"fileName\": \"Policy Document.pdf\",\n \"success\": true,\n \"publicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\"\n },\n {\n \"url\": \"https://cdn.managemy.managemy.com/policies/233627/docs/c47f6bb28d034a50b39cb6082070f035?Expires=1705499496&Signature=WiCQpEbf2FAER-gsMilqZS1LtFNsF6PrjYfLxvUEwKrPlDzEHxYGbYvNxLbJAtL3AmOsjGbXdigfZ6kvfDVYBgHmd8FmZmypym26TfcX08Y7GxyFryf5fo6oK1I-rvZs679B4vTS8XfJ3KwjITP3ehBEvrXJi6JgOTEYCwjsCm0DHGryafAg77tZOQSRf6so-9epjvskhWCBSXULcxKMhWoj57We~6V1pv0P4yw2q0W3MHj8Ju2WAJ1RClB8F5BTT~3Og6JBxgWBoR2RKjWJqWlXrRoURmQdMBFIwQrsI0fWwId213WVgc1nolgHV5s1R-XVy-3XGE-naOx7K~0eZg__&Key-Pair-Id=K169JEIC6TX4IZ\",\n \"contentType\": \"\",\n \"fileName\": \"Policy Document.pdf\",\n \"success\": true,\n \"publicId\": \"c47f6bb28d034a50b39cb6082070f035\"\n },\n ]\n },\n \"isSuccess\": true\n}"},{"id":"7860f594-b846-4945-8d54-9eab2b5113ad","name":"Get File Download URLs - Failed - File not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n publicIds: [\r\n \"e67f344fd9ed4a79bfb520ce4337ed4e\",\r\n \"5f30b9ffe87c4c3599f05eef2c84dcf5\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/file/url/batch"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"data\": {\r\n \"entitiesResult\": [\r\n {\r\n \"success\": false,\r\n \"publicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\",\r\n \"errorMessage\": \"File with PublicId: e67f344fd9ed4a79bfb520ce4337ed4e doesn't exist\"\r\n },\r\n {\r\n \"success\": false,\r\n \"publicId\": \"5f30b9ffe87c4c3599f05eef2c84dcf5\",\r\n \"errorMessage\": \"File with PublicId: 5f30b9ffe87c4c3599f05eef2c84dcf5 doesn't exist\"\r\n }\r\n ]\r\n },\r\n \"isSuccess\": true\r\n}"}],"_postman_id":"c7a08a60-062b-49a2-978b-8f7328457df3"}],"id":"69b79678-be82-428e-a491-b70bf3c223b6","description":"The document upload feature utilizes the Amazon Cloudfront services to ensure fast and efficient transfer of large quantities of digital files.
\nProcess Flow
\nIn order to upload files to the ManageMy platform using CloudFront a series of API calls need to be used in succession. These are covered in three different stages, as per the diagram below:
\nIt is possible to use the endpoints to upload multiple files.
\nThe diagram below shows how these endpoints should be coordinated to upload multiple files.
\nThe endpoint returns a URL for each file which requires uploading.
\nAll of the properties within the request are optional and as follows:
\nentityType - optional - one of the valid entity types for which files can be uploadedpublicId - optional - the Public ID of the entity for which the file upload is intendedreference - optional - the Reference of the entity for which the file upload is intendeddocumentDate - optional - the intended date of the document - must use the format yyyy-MM-dd HH:mm:ssdocumentType - optional - the intended document type - must be one of the valid document typesfileName - optional - the intended file name - must have one of the configured allowed extensionsdocumentReference - optional - the intended document reference - must be uniqueAs this is a batch endpoint it is possible to submit multiple 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 which elements of the call are successful within the body of the response.
\nDifferent types of validation are used for different properties, and the behaviour is therefore different depending on which property fails validation:
\nIf the “documentType”, “entityType”, “documentDate” or “fileName” are invalid, the endpoint will respond with a 400 status code
If the “publicId”, “reference” or “documentReference” are invalid, the endpoint will respond with a 200 status code and the corresponding object will have “success” = false and include an “errorMessage”
Currently supported document types:
\nentityType must match one of the following valid values:
\nThe next step is to upload files as binary to the given uploadUrls received in the 'Get CloudFront Upload URLs' API Call using a PUT request. The request should also include the following header key-value pairs:
\n“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.
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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"protocol":"https","path":["uploads","4b2b0750ac0242c18e9111692fc5b43d"],"host":["d264l087oq4w6s","cloudfront","net"],"query":[{"key":"Expires","value":"1640429922"},{"key":"Signature","value":"cRZ-2LBWQY0gQVv3bTFAK26FADcM-CJtSovTR5bN5X1iRb7CM5clgfKwp-LxSDrOMt7tEBiJi~60YH-ErOnj3RKlTC3JmwYUn1FQovE9~4uvUzJxhKojxk0ca9AvoyQ6XNFbxwZKD77cwHRllz3fUB-nsNnEHLoPFWsfpKO7FY3IMpNuz3FDedoxgNHpcC6otUqes6TLHIXVIpMydGLVqjxeTl8ZYTCG~JnHwtnY9Ccfp8ZVDvHjhO6H~QGOl-4U6r5k8eof6s6VGGtpoSgl7ap-7hvlLfwfQorJuIEuQIxHhfmn5SVjMejYdHrP4cdr~QvY3FxMOcYrIaAp7eWjQw__"},{"key":"Key-Pair-Id","value":"KJSQCHYPXDTFU"}],"variable":[]}},"response":[{"id":"7e938d02-adab-45bb-be9f-74047ec5e437","name":"Example - Upload CloudFront File","originalRequest":{"method":"PUT","header":[{"key":"x-amz-acl","value":"bucket-owner-full-control","type":"text"},{"key":"Content-Type","value":"","type":"text"}],"body":{"mode":"file","file":{}},"url":{"raw":"https://dvcj9x17jmn2n.cloudfront.net/uploads/e67f344fd9ed4a79bfb520ce4337ed4e?Expires=1655828095&Signature=BR-XLC83hoI1Kudw4y7ws5~SJZ65M4I6UkzV~UNpcLieBLSgrHbO2GN~fOnxfcLF~nGuM8AIlWmsoxU5Hr81SY8AOtGj27IiipacxyM3xoyyQeSVYLz3CiomPQS-U7bhWLvGfgKHcs59NOQRXuqU3rc2Lvho~j9sbZaLwyJGuHUTLyOs7YxK~0sjgccKqycyL0Ri9GbihQJ96gg9QHkD~~6SahjQQ9Gu90byxwWMzWLLB3dBKKyROGGmX3dlxDZk5ysR~e8PoCB0qybgi07NFizrdO7t0ZtRUP90K9cfEdqUWFTpqK34tXkpPMxAj2K9Gjpslmvfw2CsQ2dVHYvr8w__&Key-Pair-Id=K2UWSLA9D1TLZ7","protocol":"https","host":["dvcj9x17jmn2n","cloudfront","net"],"path":["uploads","e67f344fd9ed4a79bfb520ce4337ed4e"],"query":[{"key":"Expires","value":"1655828095"},{"key":"Signature","value":"BR-XLC83hoI1Kudw4y7ws5~SJZ65M4I6UkzV~UNpcLieBLSgrHbO2GN~fOnxfcLF~nGuM8AIlWmsoxU5Hr81SY8AOtGj27IiipacxyM3xoyyQeSVYLz3CiomPQS-U7bhWLvGfgKHcs59NOQRXuqU3rc2Lvho~j9sbZaLwyJGuHUTLyOs7YxK~0sjgccKqycyL0Ri9GbihQJ96gg9QHkD~~6SahjQQ9Gu90byxwWMzWLLB3dBKKyROGGmX3dlxDZk5ysR~e8PoCB0qybgi07NFizrdO7t0ZtRUP90K9cfEdqUWFTpqK34tXkpPMxAj2K9Gjpslmvfw2CsQ2dVHYvr8w__"},{"key":"Key-Pair-Id","value":"K2UWSLA9D1TLZ7"}]}},"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":"c9337129-1698-4e53-b900-2e3011cb8668"},{"name":"Confirm CloudFront Uploads","id":"0bdd487e-3443-4b81-ac90-f2c7c2281aa1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"entities\": [\r\n {\r\n \"entityType\": \"claim\",\r\n \"publicId\": \"\",\r\n \"reference\": \"MMTest001\",\r\n \"documentDate\": \"2023-09-17 23:12:50\",\r\n \"documentType\": \"claimDocument\",\r\n \"documentName\": \"Claim Document\",\r\n \"fileName\": \"Claim Document.pdf\",\r\n \"documentReference\": \"ClaimDocument2\",\r\n \"filePublicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\",\r\n \"notifyCustomer\": true\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/docs/upload/cloudfront/confirm/batch","description":"This endpoint is used to provide a confirmation as to what files have been uploaded and the respective properties. Once this confirmation step is complete the files are available within the platform.
\nThe below list details the different properties for the API call and whether they are mandatory or optional:
\nentityType - mandatory - the entity type for which the file is being created - must be onepublicId - mandatory if reference is not provided - the Public ID of the entity for which the file is being createdreference - mandatory if publicId is not provided - the Reference of the entity for which the file is being createddocumentName - mandatory - the user-facing name of the documentfileName - mandatory - the file name being used if the document’s file is downloaded - must have one of the configured allowed extensionsdocumentDate - optional - the date of the document - must use the format yyyy-MM-dd HH:mm:ssdocumentType - mandatory - the document type - must be one of the valid document typesdocumentReference - optional - the document reference - must be unique if providedfilePublicId - 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 successfullynotifyCustomer - 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 customerDifferent types of validation are used for different properties, and the behaviour is therefore different depending on which property fails validation:
\nIf the “documentType”, “entityType”, “documentDate”, “filePublicId” or “fileName” are invalid, or if any of the mandatory parameters are not provided, the endpoint will respond with a 400 status code
If the “publicId”, “reference” or “documentReference” are invalid, the endpoint will respond with a 200 status code and the corresponding object will have “success” = false and include an “errorMessage”
The use of this endpoint follows a previous call which provides the document public ID, which is used to obtain a URL where the file exists. The diagram below shows how the endpoints should be coordinated.
\n
The endpoint uses the public ID of a file provided in a previous call to return a URL where the file can be downloaded from.
\nAs this is a batch endpoint it is possible to submit multiple 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 which elements of the call are successful within the body of the response.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["file","url","batch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"074415c1-011a-44a5-8023-948922330f8a","name":"Example - Get File Download URLs","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n publicIds: [\"e67f344fd9ed4a79bfb520ce4337ed4e\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/file/url/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jun 2022 15:17:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"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 \"url\": \"https://dvcj9x17jmn2n.cloudfront.net/policies/289/docs/e67f344fd9ed4a79bfb520ce4337ed4e?Expires=1655824699&Signature=HouGX4fQ3qM54Vyo0EOxoCyUCbqBBBdlMxTeVEYM7oll69qWV5GBmevnBuqzCDYCTKvfdQAvDCrp2hi5JK3pF6Pjd4nVbpC1YCdnHXuK57p6KOyLZND1bU1~oHuZ4FcWzQLqUsYUrwHwRFay~nmJewmDTdP7b4NKVho8VPsePFKMDKRjFm0rTA20rYyMRMKJJkA9m1MAp4DyVhOtjx-Tlurxc3EXFRHQpFpmAYSOd6zjfYIttoCBYiGP~7zDQONshEy~-JATKzztnRpEZYQmgyJZ6EyGBqpOtwNORqsON4OnW3JBtqlBdJN0ElX1AZNrwZ7zynMXqe8L~YOHl7VtbA__&Key-Pair-Id=K2LMFP46XP7VXI\",\n \"contentType\": \"\",\n \"fileName\": \"Claim Document.pdf\",\n \"success\": true,\n \"publicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\"\n }\n ]\n },\n \"isSuccess\": true\n}"}],"_postman_id":"019e034f-5130-4b9d-ab41-dff76eb380bb"}],"id":"6315186f-b4e4-447c-9dc3-3760dc5deb9f","description":"The document upload feature utilizes the Amazon Cloudfront services to ensure fast and efficient transfer of large quantities of digital files
\nProcess Flow
\nIn order to upload files to the ManageMy platform using CloudFront a series of API calls need to be used in succession.
\nThe use of these endpoints could be on the back of a customer status update. i.e. following a successful account verification.
\nThe diagram below shows how these endpoints should be coordinated.
\n![](\"https://s3.eu-west-2.amazonaws.com/managemy.shared/Postman/Documentation/cloudfront_upload_flow.jpg\")
","_postman_id":"6315186f-b4e4-447c-9dc3-3760dc5deb9f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Read Claims","item":[{"name":"All Claims List","id":"7b5ecc4b-3acd-4d3a-9013-6b45dc5db8ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/claim/read/list?pageSize=&pageIndex=","description":"Gets a list of all claims on the ManageMy Platform, and their status.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["claim","read","list"],"host":["{{base_url}}"],"query":[{"description":{"content":"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":"8475c0bf-7000-40c4-b9a3-0438ea520530","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":"7b5ecc4b-3acd-4d3a-9013-6b45dc5db8ef"},{"name":"Read Claim Details","id":"d3141418-f84d-478b-b66e-ebe301ae9f29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"policyPublicId\": \"string\",\n \"policyReference\": \"string\",\n \"commandName\": \"string\",\n \"fieldValues\": [\n {\n \"publicId\": \"string\",\n \"value\": \"string\",\n \"groupIndex\": 0,\n \"groupFieldPublicId\": \"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.
\nEither 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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["claim","read"],"host":["{{base_url}}"],"query":[{"description":{"content":"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":[],"_postman_id":"d3141418-f84d-478b-b66e-ebe301ae9f29"}],"id":"b2c49934-3ead-4cff-9670-7ecd64265ce7","_postman_id":"b2c49934-3ead-4cff-9670-7ecd64265ce7","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Delete Claim","item":[{"name":"Delete Claim","id":"48a4d872-d997-41cb-8a81-f664b8a657ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"entities\": [\n {\n // \"publicId\": \"string\",\n \"reference\": \"355CF9F8\"\n // \"customerPublicId\": \"string\",\n // \"customerReference\": \"string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/claim/delete/batch","description":"Deletes a claim from the ManageMy platform.
\nEither publicId or reference (Insurer Claim Reference) can be used to key to the Claim.
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":"Each DocumentName / Reference / Type / Date field in the array should be appended with the array sequence number, e.g.
\n“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\nDocumentDate 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:
\n\"other\"; \"insuranceCertificate\"; \"insuranceSchedule\"; \"ipid\"; \"policyBooklet\"; \"policyDocument\"; \"keyFacts\"; \"brochure\"; \"termsConditions\"; \"renewalInvite\"; \"renewalDocument\"; \"form\"; \"creditAgreement”; “billingDocument”
\n‘entityType’ must match one of the following valid values:
“amendment”; “claim”; “customer”; “policy”; “policyAddon”; “product”; “productAddon”; “quote”; “renewal”
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["docs","upload","batch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"756052c3-8578-4ea9-a4f3-af876817415e","name":"Uplaod Documents - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"entityType","value":"policy","description":"Type of entity the documents are being attached to","type":"text"},{"key":"entityPublicId","value":"","description":"PublicId of the specific entity to upload the documents to","type":"text"},{"key":"entityReference","value":"Pol-001","description":"'External Reference' of the specific entity to upload the documents to","type":"text"},{"key":"Documents[0].DocumentName","value":"Insurance Terms.pdf","description":"Name of the document being uploaded","type":"text"},{"key":"Documents[0].DocumentReference","value":"My Reference A1","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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","type":"text"},{"key":"Documents[1].DocumentReference","value":"My Reference A2","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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.","type":"text"},{"key":"Files","description":"Path to the file to be uploaded","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","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","type":"text"}]},"url":"{{base_url}}/docs/upload/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 18:05:21 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 \"publicId\": \"4c9466a84d4243eab445cd58150b7678\",\n \"reference\": \"Pol-001\",\n \"entitiesResult\": [\n {\n \"documentPublicId\": \"bc620d586cc049df83fe440dcf2899c3\",\n \"documentReference\": \"My Reference A1\",\n \"success\": true\n },\n {\n \"documentPublicId\": \"03e478701f1d49f9bc1d8df0cf2e7658\",\n \"documentReference\": \"My Reference A2\",\n \"success\": true\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"7a710741-9f4c-4ca7-850c-bdf8262f4ab9","name":"Upload Documents - Falied - Uniqueness Validation of Document Reference","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"entityType","value":"policy","description":"Type of entity the documents are being attached to","type":"text"},{"key":"entityPublicId","value":"","description":"PublicId of the specific entity to upload the documents to","type":"text"},{"key":"entityReference","value":"Pol-001","description":"'External Reference' of the specific entity to upload the documents to","type":"text"},{"key":"Documents[0].DocumentName","value":"Insurance Terms.pdf","description":"Name of the document being uploaded","type":"text"},{"key":"Documents[0].DocumentReference","value":"My Reference A1","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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","type":"text"},{"key":"Documents[1].DocumentReference","value":"My Reference A2","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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.","type":"text"},{"key":"Files","description":"Path to the file to be uploaded","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","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","type":"text"}]},"url":"{{base_url}}/docs/upload/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 18:05:55 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 \"publicId\": \"4c9466a84d4243eab445cd58150b7678\",\n \"reference\": \"Pol-001\",\n \"entitiesResult\": [\n {\n \"success\": false,\n \"errorMessage\": \"The Document Reference 'My Reference A1' has already been used for a different document - please use a different Document Reference.\"\n },\n {\n \"success\": false,\n \"errorMessage\": \"The Document Reference 'My Reference A2' has already been used for a different document - please use a different Document Reference.\"\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"7adefe53-ca62-4c6d-842b-34c87c62d404","name":"Uplaod Documents - Mixed Response - Success and Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"entityType","value":"policy","description":"Type of entity the documents are being attached to","type":"text"},{"key":"entityPublicId","value":"","description":"PublicId of the specific entity to upload the documents to","type":"text"},{"key":"entityReference","value":"Pol-001","description":"'External Reference' of the specific entity to upload the documents to","type":"text"},{"key":"Documents[0].DocumentName","value":"Insurance Terms.pdf","description":"Name of the document being uploaded","type":"text"},{"key":"Documents[0].DocumentReference","value":"My Reference A1","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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","type":"text"},{"key":"Documents[1].DocumentReference","value":"My Reference A3","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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.","type":"text"},{"key":"Files","description":"Path to the file to be uploaded","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","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","type":"text"}]},"url":"{{base_url}}/docs/upload/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 18:08:42 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 \"publicId\": \"4c9466a84d4243eab445cd58150b7678\",\n \"reference\": \"Pol-001\",\n \"entitiesResult\": [\n {\n \"success\": false,\n \"errorMessage\": \"The Document Reference 'My Reference A1' has already been used for a different document - please use a different Document Reference.\"\n },\n {\n \"documentPublicId\": \"9468ecddb9ac49d5b79fde83d98ff480\",\n \"documentReference\": \"My Reference A3\",\n \"success\": true\n }\n ]\n },\n \"isSuccess\": true\n}"}],"_postman_id":"e7a66783-70e2-4a23-87af-baf6c41cbb4a"}],"id":"82026e4c-1d73-4ee2-846e-b48e03249443","_postman_id":"82026e4c-1d73-4ee2-846e-b48e03249443","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Quotes","item":[{"name":"Create Quotes","item":[{"name":"Create New Quote","id":"fa61daa2-4d37-43ad-9908-6c3eebd4eea6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"policyPublicId\": \"cb7ddc766d7149c7a0f0f12b75075afc\",\n \"policyReference\": \"\",\n \"commandName\": \"ApiCreateDraft\",\n \"fieldValues\": [\n {\n \"name\": \"Reference\",\n \"value\": \"MMTest001\"\n },\n {\n \"name\": \"DateOfIncident\",\n \"value\": \"2020-12-03\"\n },\n {\n \"name\": \"IncidentType\",\n \"value\": \"Damage to Underground Services\"\n },\n {\n \"name\": \"CauseOfLeak\",\n \"value\": \"No\"\n },\n {\n \"name\": \"ClaimDetails\",\n \"value\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\"\n },\n {\n \"name\": \"IsHabitable\",\n \"value\": \"No\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote/create","description":"Creates a new quote against a specific policy.
\nThe 'commmandName' command must be passed within the body of the request. 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 draft quote. Quote 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 Quote 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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["quote","create"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa61daa2-4d37-43ad-9908-6c3eebd4eea6"}],"id":"5533950c-1765-4e5c-98a8-ab9df5ab0f26","_postman_id":"5533950c-1765-4e5c-98a8-ab9df5ab0f26","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Update Quotes","item":[{"name":"Update Quote Details","id":"a196e786-5682-4c6c-b5ce-590b68acf928","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"publicId\": \"\",\n \"reference\": \"EXT-D24148FD\",\n \"commandName\": \"ApiUpdateDraft\",\n \"fieldValues\": [\n {\n \"publicId\": \"fdd85e5c827449aa82e2d09af23cfed8\",\n \"value\": \"MMTest001\"\n },\n {\n \"publicId\": \"02ce94958411415a80fb380bdfc1b0b6\",\n \"value\": \"2020-12-03\"\n },\n {\n \"publicId\": \"fb305a12628c451ebb59d2fcdd64606a\",\n \"value\": \"Damage to Underground Services\"\n },\n {\n \"publicId\": \"94ba1f61b7024f15bbcce543a9c859a8\",\n \"value\": \"No\"\n },\n {\n \"publicId\": \"815d95ca0633497ea4a0bb2c0c36faa8\",\n \"value\": \"abcdef\"\n },\n {\n \"publicId\": \"aed27fc007c742aa930c0cb497fa6304\",\n \"value\": \"No\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote/update","description":"Updates details of an existing quote.
\nThe '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 dataApiSubmitDraft - submits the quote claim. 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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["quote","update"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a196e786-5682-4c6c-b5ce-590b68acf928"}],"id":"2844e6c1-519e-447f-b1af-56f1fff089b3","_postman_id":"2844e6c1-519e-447f-b1af-56f1fff089b3","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Upload Documents Copy","item":[{"name":"Get CloudFront Upload URLs","id":"31889454-14cd-4f33-ac97-964eac42be60","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\": \"AED7CFBC\",\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\": \"PolicyDocument1\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/docs/upload/cloudfront/url/batch","description":"The endpoint returns a URL for each file which requires uploading.
\nAll of the properties within the request are optional and as follows:
\nentityType - optional - one of the valid entity types for which files can be uploadedpublicId - optional - the Public ID of the entity for which the file upload is intendedreference - optional - the Reference of the entity for which the file upload is intendeddocumentDate - optional - the intended date of the document - must use the format yyyy-MM-dd HH:mm:ssdocumentType - optional - the intended document type - must be one of the valid document typesfileName - optional - the intended file name - must have one of the configured allowed extensionsdocumentReference - optional - the intended document reference - must be uniqueAs this is a batch endpoint it is possible to submit multiple 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 which elements of the call are successful within the body of the response.
\nDifferent types of validation are used for different properties, and the behaviour is therefore different depending on which property fails validation:
\nIf the “documentType”, “entityType”, “documentDate” or “fileName” are invalid, the endpoint will respond with a 400 status code
If the “publicId”, “reference” or “documentReference” are invalid, the endpoint will respond with a 200 status code and the corresponding object will have “success” = false and include an “errorMessage”
Currently supported document types:
\nentityType must match one of the following valid values:
\nThe next step is to upload files as binary to the given uploadUrls received in the 'Get CloudFront Upload URLs' API Call using a PUT request. The request should also include the following header key-value pairs:
\n“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.
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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"protocol":"https","path":["uploads","4b2b0750ac0242c18e9111692fc5b43d"],"host":["d264l087oq4w6s","cloudfront","net"],"query":[{"key":"Expires","value":"1640429922"},{"key":"Signature","value":"cRZ-2LBWQY0gQVv3bTFAK26FADcM-CJtSovTR5bN5X1iRb7CM5clgfKwp-LxSDrOMt7tEBiJi~60YH-ErOnj3RKlTC3JmwYUn1FQovE9~4uvUzJxhKojxk0ca9AvoyQ6XNFbxwZKD77cwHRllz3fUB-nsNnEHLoPFWsfpKO7FY3IMpNuz3FDedoxgNHpcC6otUqes6TLHIXVIpMydGLVqjxeTl8ZYTCG~JnHwtnY9Ccfp8ZVDvHjhO6H~QGOl-4U6r5k8eof6s6VGGtpoSgl7ap-7hvlLfwfQorJuIEuQIxHhfmn5SVjMejYdHrP4cdr~QvY3FxMOcYrIaAp7eWjQw__"},{"key":"Key-Pair-Id","value":"KJSQCHYPXDTFU"}],"variable":[]}},"response":[{"id":"3bded6f1-357e-424b-8de9-1f069b634305","name":"Example - Upload CloudFront File","originalRequest":{"method":"PUT","header":[{"key":"x-amz-acl","value":"bucket-owner-full-control","type":"text"},{"key":"Content-Type","value":"","type":"text"}],"body":{"mode":"file","file":{}},"url":{"raw":"https://dvcj9x17jmn2n.cloudfront.net/uploads/e67f344fd9ed4a79bfb520ce4337ed4e?Expires=1655828095&Signature=BR-XLC83hoI1Kudw4y7ws5~SJZ65M4I6UkzV~UNpcLieBLSgrHbO2GN~fOnxfcLF~nGuM8AIlWmsoxU5Hr81SY8AOtGj27IiipacxyM3xoyyQeSVYLz3CiomPQS-U7bhWLvGfgKHcs59NOQRXuqU3rc2Lvho~j9sbZaLwyJGuHUTLyOs7YxK~0sjgccKqycyL0Ri9GbihQJ96gg9QHkD~~6SahjQQ9Gu90byxwWMzWLLB3dBKKyROGGmX3dlxDZk5ysR~e8PoCB0qybgi07NFizrdO7t0ZtRUP90K9cfEdqUWFTpqK34tXkpPMxAj2K9Gjpslmvfw2CsQ2dVHYvr8w__&Key-Pair-Id=K2UWSLA9D1TLZ7","protocol":"https","host":["dvcj9x17jmn2n","cloudfront","net"],"path":["uploads","e67f344fd9ed4a79bfb520ce4337ed4e"],"query":[{"key":"Expires","value":"1655828095"},{"key":"Signature","value":"BR-XLC83hoI1Kudw4y7ws5~SJZ65M4I6UkzV~UNpcLieBLSgrHbO2GN~fOnxfcLF~nGuM8AIlWmsoxU5Hr81SY8AOtGj27IiipacxyM3xoyyQeSVYLz3CiomPQS-U7bhWLvGfgKHcs59NOQRXuqU3rc2Lvho~j9sbZaLwyJGuHUTLyOs7YxK~0sjgccKqycyL0Ri9GbihQJ96gg9QHkD~~6SahjQQ9Gu90byxwWMzWLLB3dBKKyROGGmX3dlxDZk5ysR~e8PoCB0qybgi07NFizrdO7t0ZtRUP90K9cfEdqUWFTpqK34tXkpPMxAj2K9Gjpslmvfw2CsQ2dVHYvr8w__"},{"key":"Key-Pair-Id","value":"K2UWSLA9D1TLZ7"}]}},"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":"df60de87-4555-48c0-b626-1e9c5ceffb2d"},{"name":"Confirm CloudFront Uploads","id":"0b2f6935-4155-484a-9574-4bd4e552dd9c","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\": \"AED7CFBC\",\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\": \"PolicyDocument2\",\r\n \"filePublicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\",\r\n \"notifyCustomer\": true\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/docs/upload/cloudfront/confirm/batch","description":"This endpoint is used to provide a confirmation as to what files have been uploaded and the respective properties. Once this confirmation step is complete the files are available within the platform.
\nThe below list details the different properties for the API call and whether they are mandatory or optional:
\nentityType - mandatory - the entity type for which the file is being created - must be onepublicId - mandatory if reference is not provided - the Public ID of the entity for which the file is being createdreference - mandatory if publicId is not provided - the Reference of the entity for which the file is being createddocumentName - mandatory - the user-facing name of the documentfileName - mandatory - the file name being used if the document’s file is downloaded - must have one of the configured allowed extensionsdocumentDate - optional - the date of the document - must use the format yyyy-MM-dd HH:mm:ssdocumentType - mandatory - the document type - must be one of the valid document typesdocumentReference - optional - the document reference - must be unique if providedfilePublicId - 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 successfullynotifyCustomer - 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 customerDifferent types of validation are used for different properties, and the behaviour is therefore different depending on which property fails validation:
\nIf the “documentType”, “entityType”, “documentDate”, “filePublicId” or “fileName” are invalid, or if any of the mandatory parameters are not provided, the endpoint will respond with a 400 status code
If the “publicId”, “reference” or “documentReference” are invalid, the endpoint will respond with a 200 status code and the corresponding object will have “success” = false and include an “errorMessage”
The use of this endpoint follows a previous call which provides the document public ID, which is used to obtain a URL where the file exists. The diagram below shows how the endpoints should be coordinated.
\n
The endpoint uses the public ID of a file provided in a previous call to return a URL where the file can be downloaded from.
\nAs this is a batch endpoint it is possible to submit multiple 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 which elements of the call are successful within the body of the response.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["file","url","batch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f654ddef-0567-41f7-a731-e2dc34c52d8e","name":"Example - Get File Download URLs","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n publicIds: [\"e67f344fd9ed4a79bfb520ce4337ed4e\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/file/url/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jun 2022 15:17:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"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 \"url\": \"https://dvcj9x17jmn2n.cloudfront.net/policies/289/docs/e67f344fd9ed4a79bfb520ce4337ed4e?Expires=1655824699&Signature=HouGX4fQ3qM54Vyo0EOxoCyUCbqBBBdlMxTeVEYM7oll69qWV5GBmevnBuqzCDYCTKvfdQAvDCrp2hi5JK3pF6Pjd4nVbpC1YCdnHXuK57p6KOyLZND1bU1~oHuZ4FcWzQLqUsYUrwHwRFay~nmJewmDTdP7b4NKVho8VPsePFKMDKRjFm0rTA20rYyMRMKJJkA9m1MAp4DyVhOtjx-Tlurxc3EXFRHQpFpmAYSOd6zjfYIttoCBYiGP~7zDQONshEy~-JATKzztnRpEZYQmgyJZ6EyGBqpOtwNORqsON4OnW3JBtqlBdJN0ElX1AZNrwZ7zynMXqe8L~YOHl7VtbA__&Key-Pair-Id=K2LMFP46XP7VXI\",\n \"contentType\": \"\",\n \"fileName\": \"Policy Document.pdf\",\n \"success\": true,\n \"publicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\"\n }\n ]\n },\n \"isSuccess\": true\n}"}],"_postman_id":"d5317c28-d9e5-42d3-a1f6-c6d9c0524393"}],"id":"dccb5ddc-997c-48a5-91e5-7029b2a20269","description":"The document upload feature utilizes the Amazon Cloudfront services to ensure fast and efficient transfer of large quantities of digital files
\nProcess Flow
\nIn order to upload files to the ManageMy platform using CloudFront a series of API calls need to be used in succession.
\nThe use of these endpoints could be on the back of a customer status update. i.e. following a successful account verification.
\nThe diagram below shows how these endpoints should be coordinated.
\n","_postman_id":"dccb5ddc-997c-48a5-91e5-7029b2a20269","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Read Quotes","item":[{"name":"All Quotes List","id":"9f1a8b15-ec82-4a9f-ab51-b362e7476ab4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{base_url}}/quote/read/list?pageSize=&pageIndex=","description":"Gets a list of all quotes on the ManageMy Platform, and their status.
\n","urlObject":{"path":["quote","read","list"],"host":["{{base_url}}"],"query":[{"description":{"content":"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":"1277b2d6-561b-4bed-9806-7c393abc6fc2","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":"9f1a8b15-ec82-4a9f-ab51-b362e7476ab4"},{"name":"Read Quote Details","id":"d24376cc-a8f3-4a13-a298-87c35cc81c8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"policyPublicId\": \"string\",\n \"policyReference\": \"string\",\n \"commandName\": \"string\",\n \"fieldValues\": [\n {\n \"publicId\": \"string\",\n \"value\": \"string\",\n \"groupIndex\": 0,\n \"groupFieldPublicId\": \"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.
\nEither 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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["quote","read"],"host":["{{base_url}}"],"query":[{"description":{"content":"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":[],"_postman_id":"d24376cc-a8f3-4a13-a298-87c35cc81c8b"}],"id":"628e0f76-0989-4604-a9f3-0cfd5f8987d1","_postman_id":"628e0f76-0989-4604-a9f3-0cfd5f8987d1","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Delete Quotes","item":[{"name":"Delete Quote","id":"d9dab934-a96e-4077-9cf6-ec3b295f2300","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"reference\": \"Quote-001\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/quote/delete","description":"Deletes a quote from the ManageMy platform.
\nEither publicId or reference (Insurer Quote Reference) can be used to key to the Quote.
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":"Pol-001","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 Reference 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 Reference 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":"Each DocumentName / Reference / Type / Date field in the array should be appended with the array sequence number, e.g.
\n“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\nDocumentDate 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:
\n\"other\"; \"insuranceCertificate\"; \"insuranceSchedule\"; \"ipid\"; \"policyBooklet\"; \"policyDocument\"; \"keyFacts\"; \"brochure\"; \"termsConditions\"; \"renewalInvite\"; \"renewalDocument\"; \"form\"; \"creditAgreement”; “billingDocument”
\n‘entityType’ must match one of the following valid values:
“amendment”; “claim”; “customer”; “policy”; “policyAddon”; “product”; “productAddon”; “quote”; “renewal”
\n","urlObject":{"path":["docs","upload","batch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"65c9533c-2edd-4708-9cdd-06e7aa0e1cac","name":"Uplaod Documents - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"entityType","value":"policy","description":"Type of entity the documents are being attached to","type":"text"},{"key":"entityPublicId","value":"","description":"PublicId of the specific entity to upload the documents to","type":"text"},{"key":"entityReference","value":"Pol-001","description":"'External Reference' of the specific entity to upload the documents to","type":"text"},{"key":"Documents[0].DocumentName","value":"Insurance Terms.pdf","description":"Name of the document being uploaded","type":"text"},{"key":"Documents[0].DocumentReference","value":"My Reference A1","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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","type":"text"},{"key":"Documents[1].DocumentReference","value":"My Reference A2","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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.","type":"text"},{"key":"Files","description":"Path to the file to be uploaded","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","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","type":"text"}]},"url":"{{base_url}}/docs/upload/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 18:05:21 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 \"publicId\": \"4c9466a84d4243eab445cd58150b7678\",\n \"reference\": \"Pol-001\",\n \"entitiesResult\": [\n {\n \"documentPublicId\": \"bc620d586cc049df83fe440dcf2899c3\",\n \"documentReference\": \"My Reference A1\",\n \"success\": true\n },\n {\n \"documentPublicId\": \"03e478701f1d49f9bc1d8df0cf2e7658\",\n \"documentReference\": \"My Reference A2\",\n \"success\": true\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"6bc0434e-e042-4090-9a3d-a37b97e0ffed","name":"Upload Documents - Falied - Uniqueness Validation of Document Reference","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"entityType","value":"policy","description":"Type of entity the documents are being attached to","type":"text"},{"key":"entityPublicId","value":"","description":"PublicId of the specific entity to upload the documents to","type":"text"},{"key":"entityReference","value":"Pol-001","description":"'External Reference' of the specific entity to upload the documents to","type":"text"},{"key":"Documents[0].DocumentName","value":"Insurance Terms.pdf","description":"Name of the document being uploaded","type":"text"},{"key":"Documents[0].DocumentReference","value":"My Reference A1","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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","type":"text"},{"key":"Documents[1].DocumentReference","value":"My Reference A2","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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.","type":"text"},{"key":"Files","description":"Path to the file to be uploaded","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","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","type":"text"}]},"url":"{{base_url}}/docs/upload/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 18:05:55 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 \"publicId\": \"4c9466a84d4243eab445cd58150b7678\",\n \"reference\": \"Pol-001\",\n \"entitiesResult\": [\n {\n \"success\": false,\n \"errorMessage\": \"The Document Reference 'My Reference A1' has already been used for a different document - please use a different Document Reference.\"\n },\n {\n \"success\": false,\n \"errorMessage\": \"The Document Reference 'My Reference A2' has already been used for a different document - please use a different Document Reference.\"\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"658a0796-b2a2-4b63-941c-fd153f5d3f24","name":"Uplaod Documents - Mixed Response - Success and Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"entityType","value":"policy","description":"Type of entity the documents are being attached to","type":"text"},{"key":"entityPublicId","value":"","description":"PublicId of the specific entity to upload the documents to","type":"text"},{"key":"entityReference","value":"Pol-001","description":"'External Reference' of the specific entity to upload the documents to","type":"text"},{"key":"Documents[0].DocumentName","value":"Insurance Terms.pdf","description":"Name of the document being uploaded","type":"text"},{"key":"Documents[0].DocumentReference","value":"My Reference A1","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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","type":"text"},{"key":"Documents[1].DocumentReference","value":"My Reference A3","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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.","type":"text"},{"key":"Files","description":"Path to the file to be uploaded","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","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","type":"text"}]},"url":"{{base_url}}/docs/upload/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 18:08:42 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 \"publicId\": \"4c9466a84d4243eab445cd58150b7678\",\n \"reference\": \"Pol-001\",\n \"entitiesResult\": [\n {\n \"success\": false,\n \"errorMessage\": \"The Document Reference 'My Reference A1' has already been used for a different document - please use a different Document Reference.\"\n },\n {\n \"documentPublicId\": \"9468ecddb9ac49d5b79fde83d98ff480\",\n \"documentReference\": \"My Reference A3\",\n \"success\": true\n }\n ]\n },\n \"isSuccess\": true\n}"}],"_postman_id":"e286e5b1-6381-4e9b-9171-3d598efdb0c0"}],"id":"f40d6a05-0a94-4f8d-964e-28149abe5bdb","_postman_id":"f40d6a05-0a94-4f8d-964e-28149abe5bdb","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Policy Amends","item":[{"name":"Create Policy Amends","item":[{"name":"Create New Policy Amendment","id":"6f1455d0-8ee1-4c00-9989-3b2aea5c9a74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"policyPublicId\": \"cb7ddc766d7149c7a0f0f12b75075afc\",\n \"policyReference\": \"\",\n \"commandName\": \"ApiCreateDraft\",\n \"fieldValues\": [\n {\n \"publicId\": \"fdd85e5c827449aa82e2d09af23cfed8\",\n \"value\": \"MMTest001\"\n },\n {\n \"publicId\": \"67cfabf474fd4e859c7af3c2210947be\",\n \"value\": \"1000000\"\n },\n {\n \"publicId\": \"5ef429a2e3fa42bbaa74146d34137e10\",\n \"value\": \"350\"\n },\n {\n \"publicId\": \"1688c88525514e00a2d2129508a474b6\",\n \"value\": \"1000\"\n },\n {\n \"publicId\": \"54d09afc045247d0a10eb873b5d21174\",\n \"value\": \"500\"\n },\n {\n \"publicId\": \"52383ca0b58b40c2868c93467b17af2d\",\n \"value\": \"Yes\"\n },\n {\n \"publicId\": \"2962aa618d97468a84542d165e8846ba\",\n \"value\": \"No\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/policy-amend/create","description":"Creates a new amendment request against a specific policy.
\nThe '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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["policy-amend","create"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f1455d0-8ee1-4c00-9989-3b2aea5c9a74"}],"id":"8a3eee28-3148-4050-9763-8cdbcfd9d568","_postman_id":"8a3eee28-3148-4050-9763-8cdbcfd9d568","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Update Policy Amends","item":[{"name":"Update Amendment Details","id":"3f9bceb8-080c-4ce2-a8b8-9d0a5a6c318c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"publicId\": \"\",\n \"reference\": \"EXT-2DDB990F\",\n \"commandName\": \"ApiUpdateDraft\",\n \"fieldValues\": [\n {\n \"publicId\": \"fdd85e5c827449aa82e2d09af23cfed8\",\n \"value\": \"Unlimited\"\n },\n {\n \"publicId\": \"67cfabf474fd4e859c7af3c2210947be\",\n \"value\": \"1000000\"\n },\n {\n \"publicId\": \"5ef429a2e3fa42bbaa74146d34137e10\",\n \"value\": \"500\"\n },\n {\n \"publicId\": \"1688c88525514e00a2d2129508a474b6\",\n \"value\": \"1000\"\n },\n {\n \"publicId\": \"54d09afc045247d0a10eb873b5d21174\",\n \"value\": \"500\"\n },\n {\n \"publicId\": \"52383ca0b58b40c2868c93467b17af2d\",\n \"value\": \"Yes\"\n },\n {\n \"publicId\": \"2962aa618d97468a84542d165e8846ba\",\n \"value\": \"No\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/policy-amend/update","description":"Updates details of an existing amendment record.
\nThe '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 dataApiSubmitDraft - 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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["policy-amend","update"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3f9bceb8-080c-4ce2-a8b8-9d0a5a6c318c"}],"id":"8b3d50f6-d8f8-46de-a0c7-9142d1a3032b","_postman_id":"8b3d50f6-d8f8-46de-a0c7-9142d1a3032b","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Upload Documents Copy","item":[{"name":"Get CloudFront Upload URLs","id":"69af0341-cb9a-417f-ad8d-43856ab8cdca","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\": \"AED7CFBC\",\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\": \"PolicyDocument1\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/docs/upload/cloudfront/url/batch","description":"The endpoint returns a URL for each file which requires uploading.
\nAll of the properties within the request are optional and as follows:
\nentityType - optional - one of the valid entity types for which files can be uploadedpublicId - optional - the Public ID of the entity for which the file upload is intendedreference - optional - the Reference of the entity for which the file upload is intendeddocumentDate - optional - the intended date of the document - must use the format yyyy-MM-dd HH:mm:ssdocumentType - optional - the intended document type - must be one of the valid document typesfileName - optional - the intended file name - must have one of the configured allowed extensionsdocumentReference - optional - the intended document reference - must be uniqueAs this is a batch endpoint it is possible to submit multiple 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 which elements of the call are successful within the body of the response.
\nDifferent types of validation are used for different properties, and the behaviour is therefore different depending on which property fails validation:
\nIf the “documentType”, “entityType”, “documentDate” or “fileName” are invalid, the endpoint will respond with a 400 status code
If the “publicId”, “reference” or “documentReference” are invalid, the endpoint will respond with a 200 status code and the corresponding object will have “success” = false and include an “errorMessage”
Currently supported document types:
\nentityType must match one of the following valid values:
\nThe next step is to upload files as binary to the given uploadUrls received in the 'Get CloudFront Upload URLs' API Call using a PUT request. The request should also include the following header key-value pairs:
\n“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.
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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"protocol":"https","path":["uploads","4b2b0750ac0242c18e9111692fc5b43d"],"host":["d264l087oq4w6s","cloudfront","net"],"query":[{"key":"Expires","value":"1640429922"},{"key":"Signature","value":"cRZ-2LBWQY0gQVv3bTFAK26FADcM-CJtSovTR5bN5X1iRb7CM5clgfKwp-LxSDrOMt7tEBiJi~60YH-ErOnj3RKlTC3JmwYUn1FQovE9~4uvUzJxhKojxk0ca9AvoyQ6XNFbxwZKD77cwHRllz3fUB-nsNnEHLoPFWsfpKO7FY3IMpNuz3FDedoxgNHpcC6otUqes6TLHIXVIpMydGLVqjxeTl8ZYTCG~JnHwtnY9Ccfp8ZVDvHjhO6H~QGOl-4U6r5k8eof6s6VGGtpoSgl7ap-7hvlLfwfQorJuIEuQIxHhfmn5SVjMejYdHrP4cdr~QvY3FxMOcYrIaAp7eWjQw__"},{"key":"Key-Pair-Id","value":"KJSQCHYPXDTFU"}],"variable":[]}},"response":[{"id":"a23853aa-1748-4332-a15e-4ba4afae87fc","name":"Example - Upload CloudFront File","originalRequest":{"method":"PUT","header":[{"key":"x-amz-acl","value":"bucket-owner-full-control","type":"text"},{"key":"Content-Type","value":"","type":"text"}],"body":{"mode":"file","file":{}},"url":{"raw":"https://dvcj9x17jmn2n.cloudfront.net/uploads/e67f344fd9ed4a79bfb520ce4337ed4e?Expires=1655828095&Signature=BR-XLC83hoI1Kudw4y7ws5~SJZ65M4I6UkzV~UNpcLieBLSgrHbO2GN~fOnxfcLF~nGuM8AIlWmsoxU5Hr81SY8AOtGj27IiipacxyM3xoyyQeSVYLz3CiomPQS-U7bhWLvGfgKHcs59NOQRXuqU3rc2Lvho~j9sbZaLwyJGuHUTLyOs7YxK~0sjgccKqycyL0Ri9GbihQJ96gg9QHkD~~6SahjQQ9Gu90byxwWMzWLLB3dBKKyROGGmX3dlxDZk5ysR~e8PoCB0qybgi07NFizrdO7t0ZtRUP90K9cfEdqUWFTpqK34tXkpPMxAj2K9Gjpslmvfw2CsQ2dVHYvr8w__&Key-Pair-Id=K2UWSLA9D1TLZ7","protocol":"https","host":["dvcj9x17jmn2n","cloudfront","net"],"path":["uploads","e67f344fd9ed4a79bfb520ce4337ed4e"],"query":[{"key":"Expires","value":"1655828095"},{"key":"Signature","value":"BR-XLC83hoI1Kudw4y7ws5~SJZ65M4I6UkzV~UNpcLieBLSgrHbO2GN~fOnxfcLF~nGuM8AIlWmsoxU5Hr81SY8AOtGj27IiipacxyM3xoyyQeSVYLz3CiomPQS-U7bhWLvGfgKHcs59NOQRXuqU3rc2Lvho~j9sbZaLwyJGuHUTLyOs7YxK~0sjgccKqycyL0Ri9GbihQJ96gg9QHkD~~6SahjQQ9Gu90byxwWMzWLLB3dBKKyROGGmX3dlxDZk5ysR~e8PoCB0qybgi07NFizrdO7t0ZtRUP90K9cfEdqUWFTpqK34tXkpPMxAj2K9Gjpslmvfw2CsQ2dVHYvr8w__"},{"key":"Key-Pair-Id","value":"K2UWSLA9D1TLZ7"}]}},"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":"bda33b0a-e237-4649-a8ea-779ecb876f56"},{"name":"Confirm CloudFront Uploads","id":"2356ce8b-d47d-47bb-85c6-99685621a431","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\": \"AED7CFBC\",\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\": \"PolicyDocument2\",\r\n \"filePublicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\",\r\n \"notifyCustomer\": true\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/docs/upload/cloudfront/confirm/batch","description":"This endpoint is used to provide a confirmation as to what files have been uploaded and the respective properties. Once this confirmation step is complete the files are available within the platform.
\nThe below list details the different properties for the API call and whether they are mandatory or optional:
\nentityType - mandatory - the entity type for which the file is being created - must be onepublicId - mandatory if reference is not provided - the Public ID of the entity for which the file is being createdreference - mandatory if publicId is not provided - the Reference of the entity for which the file is being createddocumentName - mandatory - the user-facing name of the documentfileName - mandatory - the file name being used if the document’s file is downloaded - must have one of the configured allowed extensionsdocumentDate - optional - the date of the document - must use the format yyyy-MM-dd HH:mm:ssdocumentType - mandatory - the document type - must be one of the valid document typesdocumentReference - optional - the document reference - must be unique if providedfilePublicId - 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 successfullynotifyCustomer - 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 customerDifferent types of validation are used for different properties, and the behaviour is therefore different depending on which property fails validation:
\nIf the “documentType”, “entityType”, “documentDate”, “filePublicId” or “fileName” are invalid, or if any of the mandatory parameters are not provided, the endpoint will respond with a 400 status code
If the “publicId”, “reference” or “documentReference” are invalid, the endpoint will respond with a 200 status code and the corresponding object will have “success” = false and include an “errorMessage”
The use of this endpoint follows a previous call which provides the document public ID, which is used to obtain a URL where the file exists. The diagram below shows how the endpoints should be coordinated.
\n
The endpoint uses the public ID of a file provided in a previous call to return a URL where the file can be downloaded from.
\nAs this is a batch endpoint it is possible to submit multiple 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 which elements of the call are successful within the body of the response.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["file","url","batch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"47652847-1013-4a77-bf36-9607f6d9bf85","name":"Example - Get File Download URLs","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n publicIds: [\"e67f344fd9ed4a79bfb520ce4337ed4e\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/file/url/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jun 2022 15:17:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"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 \"url\": \"https://dvcj9x17jmn2n.cloudfront.net/policies/289/docs/e67f344fd9ed4a79bfb520ce4337ed4e?Expires=1655824699&Signature=HouGX4fQ3qM54Vyo0EOxoCyUCbqBBBdlMxTeVEYM7oll69qWV5GBmevnBuqzCDYCTKvfdQAvDCrp2hi5JK3pF6Pjd4nVbpC1YCdnHXuK57p6KOyLZND1bU1~oHuZ4FcWzQLqUsYUrwHwRFay~nmJewmDTdP7b4NKVho8VPsePFKMDKRjFm0rTA20rYyMRMKJJkA9m1MAp4DyVhOtjx-Tlurxc3EXFRHQpFpmAYSOd6zjfYIttoCBYiGP~7zDQONshEy~-JATKzztnRpEZYQmgyJZ6EyGBqpOtwNORqsON4OnW3JBtqlBdJN0ElX1AZNrwZ7zynMXqe8L~YOHl7VtbA__&Key-Pair-Id=K2LMFP46XP7VXI\",\n \"contentType\": \"\",\n \"fileName\": \"Policy Document.pdf\",\n \"success\": true,\n \"publicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\"\n }\n ]\n },\n \"isSuccess\": true\n}"}],"_postman_id":"9f5092d2-d2c6-4260-99d8-df9ccea71c15"}],"id":"15611402-13f2-4651-b7c0-7b298d204005","description":"The document upload feature utilizes the Amazon Cloudfront services to ensure fast and efficient transfer of large quantities of digital files
\nProcess Flow
\nIn order to upload files to the ManageMy platform using CloudFront a series of API calls need to be used in succession.
\nThe use of these endpoints could be on the back of a customer status update. i.e. following a successful account verification.
\nThe diagram below shows how these endpoints should be coordinated.
\n","_postman_id":"15611402-13f2-4651-b7c0-7b298d204005","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Read Policy Amends","item":[{"name":"Read Amendment Details","id":"6b210bf1-07f5-486b-8d2c-b59258cffdd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"policyPublicId\": \"string\",\n \"policyReference\": \"string\",\n \"commandName\": \"string\",\n \"fieldValues\": [\n {\n \"publicId\": \"string\",\n \"value\": \"string\",\n \"groupIndex\": 0,\n \"groupFieldPublicId\": \"string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/policy-amend/read?publicId=&reference=14B2FF1C","description":"Retrieves the data stored on a specified amendment record.
\nEither 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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["policy-amend","read"],"host":["{{base_url}}"],"query":[{"description":{"content":"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":[],"_postman_id":"6b210bf1-07f5-486b-8d2c-b59258cffdd8"},{"name":"All Amends List","id":"4236676f-a065-46fa-941a-d4674ad4f399","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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["policy-amend","read","list"],"host":["{{base_url}}"],"query":[{"description":{"content":"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":"615d1d02-46c9-4e1b-8234-e98ce0649948","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":"4236676f-a065-46fa-941a-d4674ad4f399"}],"id":"1b8da480-28a9-42d0-b658-ac4c8eb15a72","_postman_id":"1b8da480-28a9-42d0-b658-ac4c8eb15a72","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Delete Policy Amends","item":[{"name":"Delete Policy Amendment","id":"50bae965-6182-4779-a778-0c24d87feae6","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.
\nEither publicId or reference (Insurer Amendment Reference) can be used to key to the Amendment.
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-2DDB990F","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 Reference 1AM","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 Reference 2AM","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":"Each DocumentName / Reference / Type / Date field in the array should be appended with the array sequence number, e.g.
\n“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\nDocumentDate 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:
\n\"other\"; \"insuranceCertificate\"; \"insuranceSchedule\"; \"ipid\"; \"policyBooklet\"; \"policyDocument\"; \"keyFacts\"; \"brochure\"; \"termsConditions\"; \"renewalInvite\"; \"renewalDocument\"; \"form\"; \"creditAgreement”; “billingDocument”
\n‘entityType’ must match one of the following valid values:
“amendment”; “claim”; “customer”; “policy”; “policyAddon”; “product”; “productAddon”; “quote”; “renewal”
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["docs","upload","batch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"402900af-9665-423f-a90b-462c864d3574","name":"Uplaod Documents - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"entityType","value":"policy","description":"Type of entity the documents are being attached to","type":"text"},{"key":"entityPublicId","value":"","description":"PublicId of the specific entity to upload the documents to","type":"text"},{"key":"entityReference","value":"Pol-001","description":"'External Reference' of the specific entity to upload the documents to","type":"text"},{"key":"Documents[0].DocumentName","value":"Insurance Terms.pdf","description":"Name of the document being uploaded","type":"text"},{"key":"Documents[0].DocumentReference","value":"My Reference A1","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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","type":"text"},{"key":"Documents[1].DocumentReference","value":"My Reference A2","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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.","type":"text"},{"key":"Files","description":"Path to the file to be uploaded","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","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","type":"text"}]},"url":"{{base_url}}/docs/upload/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 18:05:21 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 \"publicId\": \"4c9466a84d4243eab445cd58150b7678\",\n \"reference\": \"Pol-001\",\n \"entitiesResult\": [\n {\n \"documentPublicId\": \"bc620d586cc049df83fe440dcf2899c3\",\n \"documentReference\": \"My Reference A1\",\n \"success\": true\n },\n {\n \"documentPublicId\": \"03e478701f1d49f9bc1d8df0cf2e7658\",\n \"documentReference\": \"My Reference A2\",\n \"success\": true\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"18484512-c2a3-4f61-aeb1-87f4a0a85e3d","name":"Upload Documents - Falied - Uniqueness Validation of Document Reference","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"entityType","value":"policy","description":"Type of entity the documents are being attached to","type":"text"},{"key":"entityPublicId","value":"","description":"PublicId of the specific entity to upload the documents to","type":"text"},{"key":"entityReference","value":"Pol-001","description":"'External Reference' of the specific entity to upload the documents to","type":"text"},{"key":"Documents[0].DocumentName","value":"Insurance Terms.pdf","description":"Name of the document being uploaded","type":"text"},{"key":"Documents[0].DocumentReference","value":"My Reference A1","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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","type":"text"},{"key":"Documents[1].DocumentReference","value":"My Reference A2","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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.","type":"text"},{"key":"Files","description":"Path to the file to be uploaded","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","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","type":"text"}]},"url":"{{base_url}}/docs/upload/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 18:05:55 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 \"publicId\": \"4c9466a84d4243eab445cd58150b7678\",\n \"reference\": \"Pol-001\",\n \"entitiesResult\": [\n {\n \"success\": false,\n \"errorMessage\": \"The Document Reference 'My Reference A1' has already been used for a different document - please use a different Document Reference.\"\n },\n {\n \"success\": false,\n \"errorMessage\": \"The Document Reference 'My Reference A2' has already been used for a different document - please use a different Document Reference.\"\n }\n ]\n },\n \"isSuccess\": true\n}"},{"id":"481c3c1c-bd16-4ad8-8c40-a3e9575d9475","name":"Uplaod Documents - Mixed Response - Success and Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"entityType","value":"policy","description":"Type of entity the documents are being attached to","type":"text"},{"key":"entityPublicId","value":"","description":"PublicId of the specific entity to upload the documents to","type":"text"},{"key":"entityReference","value":"Pol-001","description":"'External Reference' of the specific entity to upload the documents to","type":"text"},{"key":"Documents[0].DocumentName","value":"Insurance Terms.pdf","description":"Name of the document being uploaded","type":"text"},{"key":"Documents[0].DocumentReference","value":"My Reference A1","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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","type":"text"},{"key":"Documents[1].DocumentReference","value":"My Reference A3","description":"'External Reference' of the document being uploaded. Must be unique.","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.","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.","type":"text"},{"key":"Files","description":"Path to the file to be uploaded","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","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","type":"text"}]},"url":"{{base_url}}/docs/upload/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Nov 2020 18:08:42 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 \"publicId\": \"4c9466a84d4243eab445cd58150b7678\",\n \"reference\": \"Pol-001\",\n \"entitiesResult\": [\n {\n \"success\": false,\n \"errorMessage\": \"The Document Reference 'My Reference A1' has already been used for a different document - please use a different Document Reference.\"\n },\n {\n \"documentPublicId\": \"9468ecddb9ac49d5b79fde83d98ff480\",\n \"documentReference\": \"My Reference A3\",\n \"success\": true\n }\n ]\n },\n \"isSuccess\": true\n}"}],"_postman_id":"80f1cfb6-6a18-40f6-92d2-932d2bd57642"}],"id":"89e7df2e-7f72-42e8-b3d9-04e0c7b94a96","_postman_id":"89e7df2e-7f72-42e8-b3d9-04e0c7b94a96","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Customer Amends","item":[{"name":"Create Customer Amends","item":[],"id":"45b595e8-f6dd-47fd-b8fd-25368a4b72f0","_postman_id":"45b595e8-f6dd-47fd-b8fd-25368a4b72f0","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Update Customer Amends","item":[],"id":"7d7f507c-a219-44bf-9ed5-2d86f6c7e9bd","_postman_id":"7d7f507c-a219-44bf-9ed5-2d86f6c7e9bd","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Upload Documents Copy","item":[{"name":"Get CloudFront Upload URLs","id":"3432d9a3-3e7f-40a9-b1b6-318abd732365","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\": \"AED7CFBC\",\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\": \"PolicyDocument1\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/docs/upload/cloudfront/url/batch","description":"The endpoint returns a URL for each file which requires uploading.
\nAll of the properties within the request are optional and as follows:
\nentityType - optional - one of the valid entity types for which files can be uploadedpublicId - optional - the Public ID of the entity for which the file upload is intendedreference - optional - the Reference of the entity for which the file upload is intendeddocumentDate - optional - the intended date of the document - must use the format yyyy-MM-dd HH:mm:ssdocumentType - optional - the intended document type - must be one of the valid document typesfileName - optional - the intended file name - must have one of the configured allowed extensionsdocumentReference - optional - the intended document reference - must be uniqueAs this is a batch endpoint it is possible to submit multiple 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 which elements of the call are successful within the body of the response.
\nDifferent types of validation are used for different properties, and the behaviour is therefore different depending on which property fails validation:
\nIf the “documentType”, “entityType”, “documentDate” or “fileName” are invalid, the endpoint will respond with a 400 status code
If the “publicId”, “reference” or “documentReference” are invalid, the endpoint will respond with a 200 status code and the corresponding object will have “success” = false and include an “errorMessage”
Currently supported document types:
\nentityType must match one of the following valid values:
\nThe next step is to upload files as binary to the given uploadUrls received in the 'Get CloudFront Upload URLs' API Call using a PUT request. The request should also include the following header key-value pairs:
\n“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.
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.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"protocol":"https","path":["uploads","4b2b0750ac0242c18e9111692fc5b43d"],"host":["d264l087oq4w6s","cloudfront","net"],"query":[{"key":"Expires","value":"1640429922"},{"key":"Signature","value":"cRZ-2LBWQY0gQVv3bTFAK26FADcM-CJtSovTR5bN5X1iRb7CM5clgfKwp-LxSDrOMt7tEBiJi~60YH-ErOnj3RKlTC3JmwYUn1FQovE9~4uvUzJxhKojxk0ca9AvoyQ6XNFbxwZKD77cwHRllz3fUB-nsNnEHLoPFWsfpKO7FY3IMpNuz3FDedoxgNHpcC6otUqes6TLHIXVIpMydGLVqjxeTl8ZYTCG~JnHwtnY9Ccfp8ZVDvHjhO6H~QGOl-4U6r5k8eof6s6VGGtpoSgl7ap-7hvlLfwfQorJuIEuQIxHhfmn5SVjMejYdHrP4cdr~QvY3FxMOcYrIaAp7eWjQw__"},{"key":"Key-Pair-Id","value":"KJSQCHYPXDTFU"}],"variable":[]}},"response":[{"id":"d3498298-e276-4698-a183-df24650f8196","name":"Example - Upload CloudFront File","originalRequest":{"method":"PUT","header":[{"key":"x-amz-acl","value":"bucket-owner-full-control","type":"text"},{"key":"Content-Type","value":"","type":"text"}],"body":{"mode":"file","file":{}},"url":{"raw":"https://dvcj9x17jmn2n.cloudfront.net/uploads/e67f344fd9ed4a79bfb520ce4337ed4e?Expires=1655828095&Signature=BR-XLC83hoI1Kudw4y7ws5~SJZ65M4I6UkzV~UNpcLieBLSgrHbO2GN~fOnxfcLF~nGuM8AIlWmsoxU5Hr81SY8AOtGj27IiipacxyM3xoyyQeSVYLz3CiomPQS-U7bhWLvGfgKHcs59NOQRXuqU3rc2Lvho~j9sbZaLwyJGuHUTLyOs7YxK~0sjgccKqycyL0Ri9GbihQJ96gg9QHkD~~6SahjQQ9Gu90byxwWMzWLLB3dBKKyROGGmX3dlxDZk5ysR~e8PoCB0qybgi07NFizrdO7t0ZtRUP90K9cfEdqUWFTpqK34tXkpPMxAj2K9Gjpslmvfw2CsQ2dVHYvr8w__&Key-Pair-Id=K2UWSLA9D1TLZ7","protocol":"https","host":["dvcj9x17jmn2n","cloudfront","net"],"path":["uploads","e67f344fd9ed4a79bfb520ce4337ed4e"],"query":[{"key":"Expires","value":"1655828095"},{"key":"Signature","value":"BR-XLC83hoI1Kudw4y7ws5~SJZ65M4I6UkzV~UNpcLieBLSgrHbO2GN~fOnxfcLF~nGuM8AIlWmsoxU5Hr81SY8AOtGj27IiipacxyM3xoyyQeSVYLz3CiomPQS-U7bhWLvGfgKHcs59NOQRXuqU3rc2Lvho~j9sbZaLwyJGuHUTLyOs7YxK~0sjgccKqycyL0Ri9GbihQJ96gg9QHkD~~6SahjQQ9Gu90byxwWMzWLLB3dBKKyROGGmX3dlxDZk5ysR~e8PoCB0qybgi07NFizrdO7t0ZtRUP90K9cfEdqUWFTpqK34tXkpPMxAj2K9Gjpslmvfw2CsQ2dVHYvr8w__"},{"key":"Key-Pair-Id","value":"K2UWSLA9D1TLZ7"}]}},"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":"57afb8fb-558d-466a-916d-5dbf29941f7f"},{"name":"Confirm CloudFront Uploads","id":"b3313e53-3031-4660-9a17-dfb413543acc","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\": \"AED7CFBC\",\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\": \"PolicyDocument2\",\r\n \"filePublicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\",\r\n \"notifyCustomer\": true\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/docs/upload/cloudfront/confirm/batch","description":"This endpoint is used to provide a confirmation as to what files have been uploaded and the respective properties. Once this confirmation step is complete the files are available within the platform.
\nThe below list details the different properties for the API call and whether they are mandatory or optional:
\nentityType - mandatory - the entity type for which the file is being created - must be onepublicId - mandatory if reference is not provided - the Public ID of the entity for which the file is being createdreference - mandatory if publicId is not provided - the Reference of the entity for which the file is being createddocumentName - mandatory - the user-facing name of the documentfileName - mandatory - the file name being used if the document’s file is downloaded - must have one of the configured allowed extensionsdocumentDate - optional - the date of the document - must use the format yyyy-MM-dd HH:mm:ssdocumentType - mandatory - the document type - must be one of the valid document typesdocumentReference - optional - the document reference - must be unique if providedfilePublicId - 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 successfullynotifyCustomer - 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 customerDifferent types of validation are used for different properties, and the behaviour is therefore different depending on which property fails validation:
\nIf the “documentType”, “entityType”, “documentDate”, “filePublicId” or “fileName” are invalid, or if any of the mandatory parameters are not provided, the endpoint will respond with a 400 status code
If the “publicId”, “reference” or “documentReference” are invalid, the endpoint will respond with a 200 status code and the corresponding object will have “success” = false and include an “errorMessage”
The use of this endpoint follows a previous call which provides the document public ID, which is used to obtain a URL where the file exists. The diagram below shows how the endpoints should be coordinated.
\n
The endpoint uses the public ID of a file provided in a previous call to return a URL where the file can be downloaded from.
\nAs this is a batch endpoint it is possible to submit multiple 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 which elements of the call are successful within the body of the response.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}},"urlObject":{"path":["file","url","batch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"21105c6e-e5f8-4db9-bba5-8234bbf901cb","name":"Example - Get File Download URLs","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n publicIds: [\"e67f344fd9ed4a79bfb520ce4337ed4e\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/file/url/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jun 2022 15:17:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"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 \"url\": \"https://dvcj9x17jmn2n.cloudfront.net/policies/289/docs/e67f344fd9ed4a79bfb520ce4337ed4e?Expires=1655824699&Signature=HouGX4fQ3qM54Vyo0EOxoCyUCbqBBBdlMxTeVEYM7oll69qWV5GBmevnBuqzCDYCTKvfdQAvDCrp2hi5JK3pF6Pjd4nVbpC1YCdnHXuK57p6KOyLZND1bU1~oHuZ4FcWzQLqUsYUrwHwRFay~nmJewmDTdP7b4NKVho8VPsePFKMDKRjFm0rTA20rYyMRMKJJkA9m1MAp4DyVhOtjx-Tlurxc3EXFRHQpFpmAYSOd6zjfYIttoCBYiGP~7zDQONshEy~-JATKzztnRpEZYQmgyJZ6EyGBqpOtwNORqsON4OnW3JBtqlBdJN0ElX1AZNrwZ7zynMXqe8L~YOHl7VtbA__&Key-Pair-Id=K2LMFP46XP7VXI\",\n \"contentType\": \"\",\n \"fileName\": \"Policy Document.pdf\",\n \"success\": true,\n \"publicId\": \"e67f344fd9ed4a79bfb520ce4337ed4e\"\n }\n ]\n },\n \"isSuccess\": true\n}"}],"_postman_id":"4c4cce95-9a02-41b5-9e85-3788bc92cb38"}],"id":"693b1005-ab18-494c-b48f-9c42e1790407","description":"The document upload feature utilizes the Amazon Cloudfront services to ensure fast and efficient transfer of large quantities of digital files
\nProcess Flow
\nIn order to upload files to the ManageMy platform using CloudFront a series of API calls need to be used in succession.
\nThe use of these endpoints could be on the back of a customer status update. i.e. following a successful account verification.
\nThe diagram below shows how these endpoints should be coordinated.
\n","_postman_id":"693b1005-ab18-494c-b48f-9c42e1790407","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Read Customer Amends","item":[],"id":"81e9146a-6f59-4c38-8e30-ba65e31cd296","_postman_id":"81e9146a-6f59-4c38-8e30-ba65e31cd296","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}},{"name":"Delete Customer Amends","item":[],"id":"da28b3de-cdc4-43e7-a0aa-2c32e8f97823","_postman_id":"da28b3de-cdc4-43e7-a0aa-2c32e8f97823","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","type":"collection"}}}],"id":"aa1f1471-fd57-4dd2-acc7-4834d8c6d636","_postman_id":"aa1f1471-fd57-4dd2-acc7-4834d8c6d636","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","id":"d267a9c3-d9b6-48e8-9703-1b73d6769b53","name":"ManageMy Published APIs (V2)","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":"e5d840d9-d71e-46cd-85a4-69c3f35881b0"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"17146e31-44ca-4ab3-ae4f-66548006aad7"}}]}