Skip to navigation

Submit Prefill Data

View as Markdown

Overview

The Prefill Data Transfer API accepts customer and vehicle data from a partner system and stores it temporarily so that the Co‑operators RQB quote journey can be pre-populated when the customer arrives. This is a single POST call. On success, you receive a recordId and a redirect url to send to the customer.    

Endpoint

POST https://{{base_url}}/api/1.0/prefill/transfer

Request Headers

HeaderRequiredDescription
AuthorizationYesBearer [access_token] obtained from the Token API
Content-TypeYesapplication/json
Idempotency-KeyYesA unique UUID per logical submission. See Sections 5 & 8 for details.

Sample Request Body

{ 
  "firstName": "Jane", 
  "lastName": "Smith", 
  "dateOfBirth": "1988-04-15", 
  "phone": "+16135550194", 
  "email": "jane.smith@example.com", 
  "language": "en", 
  "product": "a", 
  "isPrefill": true, 
  "referrer": "Abc.ca", 
  "partner": "Abc", 
  "address": { 
    "unitNumber": "204", 
    "street": "170 Jackson St E", 
    "city": "Hamilton", 
    "state": "ON", 
    "postalCode": "L8N 1L4", 
    "country": "CA" 
  }, 
  "vehicles": [ 
    { 
      "vin": "WAUSAAF52PA838501", 
      "make": "FORD", 
      "model": "F-150 XLT SUPERCREW 4X4", 
      "year": "2023"
    } 
  ] 
}
 

Successful Response — 200 (No Warnings)

If the request is accepted, Co‑operators returns a recordId and redirect url.

{
"recordId": "prefill_123456",
"url": "https://{{quote_url}}?prefillId=prefill_123456",
"warnings": []
}

Store the recordId for logging and support. Redirect the customer to the returned url without modifying or re-encoding it. 

Successful Response — 200 (With Warnings)

Some optional fields may be accepted with warnings. In that case, the customer can still continue to the quote journey.

Log warnings and monitor them for recurring data quality issues. Do not show technical warning messages to the customer.

Example response:

{ 
  "recordId": "prefill_123456", 
  "url": "https://{{quote_url}}?prefillId=prefill_123456", 
  "warnings": [ 
    { 
      "field": "vehicles[0].vin", 
      "code": "INVALID_FORMAT", 
      "message": "VIN must be 17 characters." 
    } 
  ] 
}  

What Happens After Redirect

When the customer starts the quote journey:

  • Co‑operators reads the prefill record.

  • Eligible fields are pre-populated in the quote experience.

  • The customer can edit or remove prefilled values.

  • Standard quote validation applies when the customer interacts with each field.

Prefill validation does not replace quote journey validation.