GlobalSubmissionResponse

object

Minimal response returned after the base Step Function completes.

submissionIdstring(uuid)

Correlation id for tracing the background full + quote executions in logs

Example:9b3f7c1c-1f0a-4e2d-9d7c-2e3a8b4c6d2e

policyNostring

Policy number produced by the base submission step

Example:Q0038456

policyKeystring

Policy key produced by the base submission step, propagated to the async steps

Example:20894

policyActivityKeystring

Policy activity key produced by the base submission step

Example:45632

statusstring

ACCEPTED means the full step is running in background; FAILED means the base step failed

Allowed values:ACCEPTEDFAILED

Example:ACCEPTED

messagestring

Human-readable message

Example:Base submission succeeded. The full step is running asynchronously.

Example

PolicyReferenceGenerationRequest

object

Request payload for generating a policy reference. Supply the insured, producer, product, and underwriter at minimum — all as id references.

insuredobjectrequired

Insured contact — id only.

* Additional properties are NOT allowed.
Show Child Parameters
producerobjectrequired

Producer (broker) — id only.

* Additional properties are NOT allowed.
Show Child Parameters
mopobjectrequired

MOP (Method of Placement) code only.

* Additional properties are NOT allowed.
Show Child Parameters
notesstring

Optional free-text notes for the policy reference.

policyyearnumberstringrequired

Policy year number.

Example:26

policyyearstring

Policy year.

Example:26

productobjectrequired

Product reference id only.

* Additional properties are NOT allowed.
Show Child Parameters
quoteobject

Quote type code only (e.g. Q).

* Additional properties are NOT allowed.
Show Child Parameters
underwriterobjectrequired

Underwriter reference id only.

* Additional properties are NOT allowed.
Show Child Parameters
Example

PolicyReferenceResponse

object

Response returned after generating a policy reference. Contains the generated reference, associated keys, and input echo fields.

createdByinteger(int32)

Contact key of the user who created the reference.

Example:2000574

generatedReferencestring

The generated policy reference string.

Example:PCY2434926AA

insuredstring

Insured contact id echoed from the request.

Example:3000211

policyreferencekeyinteger(int32)

Internal policy reference key identifier.

Example:646

notesstring

Notes echoed from the request.

policyYearstring

Policy year echoed from the request.

Example:26

policyYearNumberinteger(int32)

Policy year number echoed from the request.

Example:26

producerstring

Producer contact id echoed from the request.

Example:2000987

productinteger(int32)

Product identifier.

Example:4

underwriterinteger(int32)

Underwriter contact key.

Example:2000310

Example

PolicyStatusSummary

object

Summary of a policy returned by the /policies/status endpoint.

policykeyinteger

Internal policy key identifier

Example:1086334

policyactivitykeyinteger

Internal policy key identifier

Example:1141169

accountinteger

Account contact key

Example:4040940

insuredinteger

Insured contact key

Example:4040940

producerinteger

Producer contact key

Example:2000556

productinteger

Product identifier

Example:4

effectiveDatestring(date)

Policy effective date

Example:2026-01-15

expiryDatestring(date)

Policy expiry date

Example:2027-01-15

idinteger

Identifier

policyStatusstring

Current status of the policy

Allowed values:Quote PreparationQuoteBoundSubmission DeclinedQuote NTU

Example:Bound

policyActivityStatusstring

Status of the policy

Allowed values:ActiveBoundCompletedPendingCancelledQuote NTU

Example:Bound

Example

ContactFuzzySearchItem

object

A single contact entry returned by the /lookup/contacts endpoint, passed through from XFI’s summary object verbatim. Backing Java type is Map<String, Object> — keys are not fixed/known in advance (XFI may return any of contactKey, contactReference, code, roleCode, mainrole, email, mailingAddress1, mailingAddress2, mailingAddressCity, country, or others), so no fixed property list is declared here.

* Additional properties are allowed.