GlobalSubmissionResponse
objectMinimal response returned after the base Step Function completes.
Correlation id for tracing the background full + quote executions in logs
Example:9b3f7c1c-1f0a-4e2d-9d7c-2e3a8b4c6d2e
Policy number produced by the base submission step
Example:Q0038456
Policy key produced by the base submission step, propagated to the async steps
Example:20894
Policy activity key produced by the base submission step
Example:45632
ACCEPTED means the full step is running in background; FAILED means the base step failed
Allowed values:ACCEPTEDFAILED
Example:ACCEPTED
Human-readable message
Example:Base submission succeeded. The full step is running asynchronously.
PolicyReferenceGenerationRequest
objectRequest payload for generating a policy reference. Supply the insured, producer, product, and underwriter at minimum — all as id references.
Insured contact — id only.
Show Child Parameters
Producer (broker) — id only.
Show Child Parameters
MOP (Method of Placement) code only.
Show Child Parameters
Optional free-text notes for the policy reference.
Policy year number.
Example:26
Policy year.
Example:26
Product reference id only.
Show Child Parameters
Quote type code only (e.g. Q).
Show Child Parameters
Underwriter reference id only.
Show Child Parameters
PolicyReferenceResponse
objectResponse returned after generating a policy reference. Contains the generated reference, associated keys, and input echo fields.
Contact key of the user who created the reference.
Example:2000574
The generated policy reference string.
Example:PCY2434926AA
Insured contact id echoed from the request.
Example:3000211
Internal policy reference key identifier.
Example:646
Notes echoed from the request.
Policy year echoed from the request.
Example:26
Policy year number echoed from the request.
Example:26
Producer contact id echoed from the request.
Example:2000987
Product identifier.
Example:4
Underwriter contact key.
Example:2000310
PolicyStatusSummary
objectSummary of a policy returned by the /policies/status endpoint.
Internal policy key identifier
Example:1086334
Internal policy key identifier
Example:1141169
Account contact key
Example:4040940
Insured contact key
Example:4040940
Producer contact key
Example:2000556
Product identifier
Example:4
Policy effective date
Example:2026-01-15
Policy expiry date
Example:2027-01-15
Identifier
Current status of the policy
Allowed values:Quote PreparationQuoteBoundSubmission DeclinedQuote NTU
Example:Bound
Status of the policy
Allowed values:ActiveBoundCompletedPendingCancelledQuote NTU
Example:Bound
ContactFuzzySearchItem
objectA 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.