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.
Headers
Identifies the calling system or channel that originated this request. Used for traceability and auditing across the platform.
Example:S01x
Identifier of the end user on whose behalf this request is made, recorded for audit trail purposes.
Example:jsmith
Body
application/json
Body
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.
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.
Example:[ "" ]
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
Response
application/json
Response
Policy reference generated successfully.
PolicyReferenceResponse
Response 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.
Example:[ "" ]
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
Authentication
Headers
Body
Get Policy Status (Synchronous)
Retrieves policy details including status, key identifiers, and metadata for a given policy key. Returns a list of policy summaries from the outbound-services-call API.
Response timing
Expected API response time is two minutes or less, subject to XFI availability and performance.
Query Parameters
Policy key (mandatory)
Example:22170
Headers
Identifies the calling system or channel that originated this request. Used for traceability and auditing across the platform.
Example:S01x
Identifier of the end user on whose behalf this request is made, recorded for audit trail purposes.
Example:jsmith
Response
application/json
Response
Policy status retrieved successfully
PolicyStatusSummary
Summary 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
Example:0
Current status of the policy
Allowed values:Quote PreparationQuoteBoundSubmission DeclinedQuote NTU
Example:Bound
Status of the policy
Allowed values:ActiveBoundCompletedPendingCancelledQuote NTU
Example:Bound
Authentication
Query Parameters
Headers
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.
Query Parameters
Policy key
Example:1087638
Policy activity key
Example:1142564
Headers
Identifies the calling system or channel that originated this request. Used for traceability and auditing across the platform.
Example:S01x
Identifier of the end user on whose behalf this request is made, recorded for audit trail purposes.
Example:jsmith
Response
application/json
Response
Live policy details fetched successfully
LivePolicyResponse
Example:Live Policy
Example:Q1100077
Example:F0025667
Example:1087748
Example:1142676
Example:Issued
Authentication
Query Parameters
Headers
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.
Query Parameters
Policy key
Example:1087648
Policy activity key
Example:1142574
Headers
Identifies the calling system or channel that originated this request. Used for traceability and auditing across the platform.
Example:S01x
Identifier of the end user on whose behalf this request is made, recorded for audit trail purposes.
Example:jsmith
Body
application/json
Body
PeerReviewCheckRequest
Show Child Parameters
Example:2026-09-10
Response
application/json
Response
Peer review check completed successfully
LivePolicyResponse
Example:Live Policy
Example:Q1100077
Example:F0025667
Example:1087748
Example:1142676
Example:Issued
Authentication
Query Parameters
Headers
Body
Submission Data Extraction
Extract submission data for use in other systems.