Skip to main content
POST
/
policies
Issue policy
curl --request POST \
  --url https://staging.yasmina.ai/api/v1/car-comp/policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "quote_request_id": 123,
  "quote_reference_id": "550e8400-e29b-41d4-a716-446655440000",
  "quote_price_id": "550e8400-e29b-41d4-a716-446655440001"
}'
{
  "id": 123,
  "meta_data": {},
  "start_date": "<string>",
  "provider_policy_id": 123,
  "provider_policy": "<string>",
  "order_status": 123,
  "approval_status": 123,
  "end_date": "<string>",
  "is_claimed": true,
  "created_at": "<string>",
  "updated_at": "<string>",
  "client_id": "<string>",
  "canceled_at": "<string>",
  "invoice": "<string>",
  "cancellation_document": "<string>"
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme

Body

application/json
​
quote_request_id
integer
required

ID of the car quote request

Example:

123

​
quote_reference_id
string<uuid>
required

Unique identifier for the quote reference ID (coming from POST /quote-requests)

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
quote_price_id
string<uuid>
required

Unique identifier for the quote price ID that exists inside a quote item (coming from POST /quote-requests)

Example:

"550e8400-e29b-41d4-a716-446655440001"

​
benefits
string<uuid>[]

List of benefit UUIDs

UUID of a benefit (coming from POST /quote-request)

Example:
[
  "6f45768d-edcd-4bb0-ab8a-712d549deee9",
  "2f276e18-0c6e-49ca-b6e6-64700a1bef90"
]
​
extra_fields
object

Optional free-form object with additional fields. Total JSON-encoded size must not exceed 255 characters.

Example:
{
  "some_key": "some value",
  "another_key": 123
}

Response

Created

​
id
integer
​
meta_data
object
​
start_date
string
​
provider_policy_id
integer
​
provider_policy
string
​
order_status
integer
​
approval_status
integer
​
end_date
string
​
is_claimed
boolean
​
created_at
string
​
updated_at
string
​
client_id
string
​
canceled_at
string | null
​
invoice
string
​
cancellation_document
string