Create an aggregated application

post

https://sandbox.uk.rootplatform.com/v1/insurance/applications/create-aggregated

Creates a quote and an application in a single call, stopping before policy issuance. This is the application-only counterpart to the issue an aggregated policy endpoint — use it when you want to prepare an application (quote + application) without yet issuing a policy. Issue the policy afterwards via the create a policy endpoint using the returned application_id.

Query Params

idempotency_key

string

To perform an idempotent request, provide the idempotency_key query parameter with the request. An idempotency key is a unique value generated by the client which the platform uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using a V4 UUID, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.

version

string

The version of the product module definition used to generate the quote. Can be a UUID or one of live, draft.

Body Params

policyholder

object

required

quote

object

required

The quote input used to generate a quote package, which the application is then created from. Must include type (the product module identifier). Additional fields are product-module-specific quote inputs — see the create a quote endpoint and product modules for details. This is the quote request, not a quote package object.

application

object

required

The application input. Any fields other than billing_day are treated as product-module-specific application inputs and are validated against the product module's application schema — send them as top-level keys here, not wrapped in a custom_fields object.

user_group_id

uuid | null

Optional. Assign the created application to this user group. Only API-key requests may specify it, and the group must belong to your organization. If the API key is itself scoped to a user group, the application is automatically assigned to that group and passing a user_group_id is rejected.

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully created the quote and application