Generate Policy Reference (Synchronous)

Generates a policy reference number by forwarding the request to the outbound-services-call API. Returns the generated policy reference along with policy keys and status.

Required fields

insured, producer, product, underwriter.

Optional fields

mop, notes, policyyearnumber, policyyear, quote.

Lookup objects

insured, producer, product, and underwriter accept id only. mop and quote accept code only.

Response timing

Expected API response time is two minutes or less, subject to XFI availability and performance.

post
https://apinonprod.mosaicinsurance.com/policy/generatereference

Headers

X-Origination-Sourcestringrequired

Identifies the calling system or channel that originated this request. Used for traceability and auditing across the platform.

Example:S01x

X-Audit-UserIdstringrequired

Identifier of the end user on whose behalf this request is made, recorded for audit trail purposes.

Example:jsmith

Body

application/json

Policy reference generation payload.

PolicyReferenceGenerationRequest

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.

Example:[ "" ]

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

Response

application/json

Policy reference generated successfully.

PolicyReferenceResponse

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 | null

Notes echoed from the request.

Example:[ "" ]

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

post/policy/generatereference

Body

{ "insured": { "id": "4040940" }, "producer": { "id": "4031515" }, "mop": { "code": "STD" }, "notes": "", "policyyearnumber": "26", "policyyear": "26", "product": { "id": "4" }, "underwriter": { "id": "2001685" } }
 
application/json

Get Policy Status (Synchronous)

Retrieves policy details including status, key identifiers, and metadata for a given policy key.

Monitoring policy progression

Poll this endpoint and inspect policyStatus and policyActivityStatus until the policy reaches the desired Quote In Preparation, Quote, or Bound state, or an errorMessage block appears. XFI may report Quote In Preparation as Quote Preparation. When errorMessage is present, the transaction could not progress to the desired state; treat the error as the outcome even if a target status is also shown, and use its details to determine the next steps. An HTTP 200 response means the status was retrieved, not necessarily that the transaction succeeded.

Response timing

Expected API response time is two minutes or less, subject to XFI availability and performance.

get
https://apinonprod.mosaicinsurance.com/policy/status

Query Parameters

policyKeystringrequired

Policy key (mandatory)

Example:22170

Headers

X-Origination-Sourcestringrequired

Identifies the calling system or channel that originated this request. Used for traceability and auditing across the platform.

Example:S01x

X-Audit-UserIdstringrequired

Identifier of the end user on whose behalf this request is made, recorded for audit trail purposes.

Example:jsmith

Response

application/json

Policy status retrieved successfully

PolicyStatusSummary

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

Example:0

policyStatusstring

Current status of the policy

Example:Bound

policyActivityStatusstring

Status of the policy

Example:Bound

errorMessageobject

Present when an XFI error prevents the policy from progressing to its desired state. Use these details to determine the next steps.

Show Child Parameters
get/policy/status
 
application/json

Promote Policy to Live (Synchronous)

Fetches live policy details for the given policyKey and policyActivityKey.

Response timing

Expected API response time is two minutes or less, subject to XFI availability and performance.

post
https://apinonprod.mosaicinsurance.com/policy/Live

Query Parameters

policyKeystringrequired

Policy key

Example:1087638

policyActivityKeystringrequired

Policy activity key

Example:1142564

Headers

X-Origination-Sourcestringrequired

Identifies the calling system or channel that originated this request. Used for traceability and auditing across the platform.

Example:S01x

X-Audit-UserIdstringrequired

Identifier of the end user on whose behalf this request is made, recorded for audit trail purposes.

Example:jsmith

Response

application/json

Live policy details fetched successfully

LivePolicyResponse

policyStatusstringrequired

Example:Live Policy

policyNostringrequired

Example:Q1100077

referencestringrequired

Example:F0025667

policyKeystringrequired

Example:1087748

policyActivityKeystringrequired

Example:1142676

policyActivityStatusstringrequired

Example:Issued

post/policy/Live
 
application/json

Complete Peer Review (Synchronous)

Completing the peer review check for the given policyKey and policyActivityKey.

Response timing

Expected API response time is two minutes or less, subject to XFI availability and performance.

post
https://apinonprod.mosaicinsurance.com/policy/peerReview

Query Parameters

policyKeystringrequired

Policy key

Example:1087648

policyActivityKeystringrequired

Policy activity key

Example:1142574

Headers

X-Origination-Sourcestringrequired

Identifies the calling system or channel that originated this request. Used for traceability and auditing across the platform.

Example:S01x

X-Audit-UserIdstringrequired

Identifier of the end user on whose behalf this request is made, recorded for audit trail purposes.

Example:jsmith

Body

application/json

PeerReviewCheckRequest

checkedByobjectrequired
Show Child Parameters
checkedDatestring(date)required

Example:2026-09-10

Response

application/json

Peer review check completed successfully

LivePolicyResponse

policyStatusstringrequired

Example:Live Policy

policyNostringrequired

Example:Q1100077

referencestringrequired

Example:F0025667

policyKeystringrequired

Example:1087748

policyActivityKeystringrequired

Example:1142676

policyActivityStatusstringrequired

Example:Issued

post/policy/peerReview

Body

{ "checkedBy": { "id": 545 }, "checkedDate": "2026-09-10" }
 
application/json

Document Upload to DMS

Upload supporting documents to a policy’s DMS folder.