Forms

Provider forms, the options their fields load remotely, and upload slots.

GET/products/{providerId}/{productId}/formThe form to collect for a product

The form to collect for a product

Returns the insurer's form document for one context. The form is validated against the OIIS form schema before it is served: a form that fails validation is 422, with the validator's findings in fieldErrors. Keep formId and formVersion, because quoting requires them. The renewal and endorsement contexts can be fetched but have no submit route in this version, so build no flow on them yet.

lock

Requires API key authentication. The API key issued to the business, sent as `<keyId>:<secret>`, for example `sk_test_0123456789abcdef0123456789abcdef:<secret>`. The key id prefix selects the environment: `sk_test_` keys read and write test data, `sk_live_` keys production data.

Parameters

contextquerystringrequireddefault: Which form to serve.

Responses

The form document.

null

boltTry it

env

GET/api/v1/products/{providerId}/{productId}/form

Query parameters

context*

Code samples

curl -X GET '/api/v1/products/{providerId}/{productId}/form'

POST/forms/{providerId}/{formId}/{formVersion}/optionsLoad the options of one form field

Load the options of one form field

For fields whose options come from the insurer rather than the form document. The field's declared options URL is interpolated from values, so send the answers it names; a placeholder with no answer, a non-scalar answer, or an answer that would escape the insurer's namespace is 400 and names the offending path. A field that loads no options remotely (and a form version this business never fetched) is 404. Searchable fields refuse a query shorter than the field's minimum.

lock

Parameters

formIdpathstringrequireddefault: The formId the form was served with.

formVersionpathintegerrequireddefault: The formVersion the form was served with.

Request body

application/json

{
  "fieldId": "",
  "query": ""
}

Responses

The options for the field.

{
  "options": [],
  "nextCursor": null
}

boltTry it

env

POST/api/v1/forms/{providerId}/{formId}/{formVersion}/options

Path parameters

formId*

formVersion*

Request body

{
  "fieldId": "",
  "query": ""
}

Code samples

curl -X POST '/api/v1/forms/{providerId}/{formId}/{formVersion}/options' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "fieldId": "",
  "query": ""
}'

POST/uploadsAsk for an upload slot

Ask for an upload slot

Reserves a slot with the insurer for one file and hands back the URL to PUT the bytes to. Upload the file yourself, then quote the fileId in a claim's attachments[] or in an attach-document request. An insurer that caps out on the size answers 413 UPLOAD_TOO_LARGE.

lock

Request body

application/json

{
  "providerId": null,
  "purpose": "",
  "filename": "",
  "mediaType": "",
  "bytes": 0
}

Responses

The slot to upload into.

null

boltTry it

env

POST/api/v1/uploads

Request body

{
  "providerId": null,
  "purpose": "",
  "filename": "",
  "mediaType": "",
  "bytes": 0
}

Code samples

curl -X POST '/api/v1/uploads' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "providerId": null,
  "purpose": "",
  "filename": "",
  "mediaType": "",
  "bytes": 0
}'