Policy number of the failed submission
Example:Q0038456
Starts a new state machine execution that resumes from the failed step (current_step on the status row). The original {base, full, quote, bind} payload is read back from the failed execution’s input via DescribeExecution; policyKey / policyActivityKey produced by the successful base step are taken from the status row.
Only allowed when overall_status = FAILED.
Policy number of the failed submission
Example:Q0038456
Retry accepted; new execution started.
Minimal 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.
Handles CORS preflight requests for the file upload endpoint
CORS preflight successful
Uploads a document to the DMS for a specific policy. Supports file uploads to designated locations within the policy’s DMS folder structure.
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
File to be uploaded to the DMS
File to be uploaded
Document uploaded successfully
Returns the allowed values for a named field scoped to an existing policy’s first active section.
Requires a valid policyKey + policyActivityKey (returned by POST /submission/full). The service opens a temporary XFI section-edit session to read the live schema and closes it immediately — no data is modified.
Supported fieldNames: coverage (only)
Typical use: populate the Coverage dropdown in the portal UI before the user fills in quote section data.
XFI policy key returned by POST /submission/full.
Example:21660
XFI policy activity key returned by POST /submission/full.
Example:33159
Comma-separated field names to look up. Currently only coverage is supported.
Allowed values:coverage
Example:coverage
Field values retrieved successfully.
Response returned by /lookup/fields and /lookup/agreement. Contains the field name resolved by the server and the list of allowed values read from the live XFI section schema.
Outcome of the lookup call.
Allowed values:SUCCESSFAILED
Example:SUCCESS
The XFI field name whose allowed values are returned. One of coverage, agreement, agreementActivity, or agreementSection.
Example:agreement
A single lookup value entry
Returns XFI contacts filtered by the specified role code. Supports optional free-text filter on contact name/code and page-based pagination.
Common role codes:
| Code | Role |
|---|---|
USR |
Internal User (Underwriters) |
ACC |
Account / Insured |
PRD |
Producer / Broker |
AGR |
Agreement Partner |
OBG |
Obligor |
REIND |
Reinsured |
SCM |
Syndicate Capital Management |
INS |
Insurer |
COV |
Coverholder |
DIV |
Division |
SYN |
Syndicate |
MBK |
Master Broker |
All supported codes: INS, ATT, ACC, PRD, TAX, OTH, CLM, REIN, BCT, USR, EW, IA, EA, CA, AGR, PI, BINS, DIV, SYN, TCC, SRV, COV, LF, AUD, EXUSR, FRC, BA, SA, SOS, OFFTEAM, OBG, LG, RGA, INV, FIN, TAD, ENV, ITA, INA, BEN, ADO, ACF, UWC, BUY, SEL, TGT, PTF, REIND, SCM, PEB, MBK
XFI role code to filter contacts by. See description for full list.
Allowed values:INSATTACCPRDTAXOTHCLMREINBCTUSREWIAEACAAGRPIBINSDIVSYNTCCSRVCOVLFAUDEXUSRFRCBASASOSOFFTEAMOBGLGRGAINVFINTADENVITAINABENADOACFUWCBUYSELTGTPTFREINDSCMPEBMBK
Example:USR
Optional partial match on contact name or code (e.g. “Enbridge Inc.”, “MSR”).
Example:Enbridge Inc.
Page number, 1-based. Defaults to 1.
Default:1
>= 1
Example:1
Number of results per page. Defaults to 25. Maximum 100.
Default:25
>= 1<= 100
Example:25
Contacts retrieved successfully
Paginated response returned by the /lookup/contacts endpoint.
Total number of matching contacts in XFI (may exceed the count on this page).
Current page number (1-based).
Number of items per page.
A single contact entry returned by the /lookup/contacts endpoint.