Skip to main content
POST
Start an underwriting file

Authorizations

Authorization
string
header
required

Effective API key. Send Authorization: Bearer sk-eai-...

Body

application/json
manualId
string
required

The manual to pin the underwriting file to, for good.

Pattern: ^[a-f0-9]{64}$
agencyAccountId
string<uuid>
required

The agency account (the insured). You need edit access to it.

title
string

Defaults to “Underwriting file”.

Required string length: 1 - 500
productId
string<uuid>
status
enum<string>
default:received

The record status people set. It is a label: what a statement may do is decided from the log, never from it.

Available options:
draft,
received,
in_review,
needs_information,
accepted_for_quoting,
declined,
withdrawn
submissionReference
string
Required string length: 1 - 200
businessType
enum<string>
Available options:
new,
renewal
requestedEffectiveDate
string<date>
requestedExpirationDate
string<date>
receivedAt
string<date-time>
agencyMessage
string
Maximum string length: 20000
description
string
Maximum string length: 20000
statements
object[]

First statements, recorded with the underwriting file. If the manual refuses them, nothing is created.

Required array length: 1 - 200 elements

Open the underwriting file on products the manual sells.

Response

The new underwriting file, its view and what its first statements recorded.

file
object
required
lastSeq
integer
required

Send as after with your next statements.

actingAs
object
required

Who you act as here.

view
object
required

The workbench view as you may see it now. format, lastSeq, the offers’ id and stage, and ratings are this API’s contract; every other field is defined by the engine’s view format. Tolerate fields you do not know.

dryRun
boolean
required

True for dryRun=true: nothing was stored. entries, runs and view are what the statements would produce, priced; file is as stored.

applyId
string | null
required

This request; the entries it wrote carry it. Null on a dry run.

seqs
integer[]
required

Seqs of the entries your statements appended (the manual’s own entries after them are in entries); empty on a dry run.

replayed
boolean
required

True when this Idempotency-Key was already applied: nothing new was appended.

entries
object[]
required

The entries appended (on a dry run, that would be): your statements, then any the manual wrote itself after them.

runs
object[]
required

The ratings this request made with the manual’s bound rater bundles, each kept for good with a rater execution record. On a dry run the what-if is rated too, so the preview is priced, and nothing is kept. Ratings it did not make are in view.ratings as needed, with their reason.