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.
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
Example:Bound
Status of the policy
Example:Bound
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
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
Document Upload to DMS
Upload supporting documents to a policy’s DMS folder.
Upload document (Synchronous)
Uploads a document to the DMS for a specific policy. Supports file uploads to designated locations within the policy’s DMS folder structure.
Response timing
Expected API response time is two minutes or less, subject to XFI availability and performance.
Query Parameters
Unique identifier of the policy
Example:20740
Folder location within the DMS structure where the document should be uploaded. Spaces and special characters (%20 for space, %26 for &) are URL-encoded and will be decoded.
Example:Supporting Documents
Reference identifier for the policy (e.g., quote reference)
Example:F0022390
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
multipart/form-data
Body
File to be uploaded to the DMS
File to be uploaded
Response
text/plain
Response
Document uploaded successfully