Issue a policy

post

https://sandbox.uk.rootplatform.com/v1/insurance/policies

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.

Body Params

application_id

string

required

Must be a UUID. Unique identifier of the created application.

app_data

object | null

null is allowed. An object containing additional custom data for the policy.

billing_day

integer | null

null is allowed. The day of month on which the policy is billed. Should be between 1 and 31, or null. If it falls on a day that does not exist in the month (for example, 31 in February) the policy will be billed on the last day of the month. Setting this value to 31 will ensure that the policy is billed on the last day of every month.

user_group_id

string | null

null is allowed. When provided, the policy will be assigned to the corresponding user group. If omitted or null, no user group will be assigned.

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

200Success