Returns currently effective DTCC participant records wrapped in a standard
reference envelope { "referenceType": "dtcc-participants", "results": [...] }.
All query parameters are optional and combined with AND logic when supplied.
Valid filter combinations: participantId alone, companyId alone,
companyId + planCode, or any combination of the three.
Expired and future-dated records are automatically excluded.
Filter by company identifier (exact, case-sensitive). Blank treated as absent.
Example:ABC
Filter by plan code (exact, case-sensitive). Blank treated as absent.
Example:ANN100
Filter by participant identifier (exact, case-sensitive). May be used alone or combined with companyId/planCode. Blank treated as absent.
Example:PART001
Wrapped list of matching effective DTCC participant records. results is empty when no records match.
Wrapped response envelope for the dtcc-participants reference endpoint.
Example:dtcc-participants
A single DTCC participant record. Only currently effective records are returned.
Returns currently effective product transaction records wrapped in a standard
reference envelope { "referenceType": "product-transactions", "results": [...] }.
All query parameters are optional and combined with AND logic when supplied.
Expired and future-dated records are automatically excluded.
Filter by rule-engine client code (exact, case-sensitive). Blank treated as absent.
Example:OTP_BPM
Filter by plan code (exact, case-sensitive). Blank treated as absent.
Example:ANN100
Wrapped list of matching effective product transaction records. results is empty when no records match.
Wrapped response envelope for the product-transactions reference endpoint.
Example:product-transactions
A single product transaction record. Only currently effective records are returned.
Returns currently effective restriction type records wrapped in a standard
reference envelope { "referenceType": "restriction-list", "results": [...] }.
The restrictionSubTypes array is always present — empty [] when no sub-types
exist, never null. A null description is preserved as null.
Expired and future-dated records are automatically excluded.
Filter by restriction type code (exact, case-sensitive). Blank treated as absent.
Example:OVERPAYMENT
Wrapped list of matching effective restriction type records. results is empty when no records match.
Wrapped response envelope for the restriction-list reference endpoint.
Example:restriction-list
A single restriction type record. restrictionSubTypes is always present (empty array when none exist, never null). description may be null.
Transaction eligibility evaluation (pa-transactions-configurations)
Evaluates whether the authenticated user may perform one or more transactions on the
given policy. Runs policy eligibility, user permission, and restriction mappings for
the dedicated transaction eligibility type.
Plan code (exact, case-sensitive).
Example:ANN100
Policy number (exact, case-sensitive).
Example:POL123456
Optional request body for path-based transaction eligibility. planCode and policyNumber are supplied as path parameters, not in the body.
Transaction type identifiers to evaluate. When absent or empty, all transactions configured for the plan in product-transactions reference data are evaluated.
Example:FullSurrender, PartialWithdrawalOneTime
Eligibility evaluation completed. One result entry per evaluated subject.
Top-level transaction eligibility response envelope.
Eligibility type evaluated. Always transaction for this endpoint.
Example:transaction
Composed eligibility result for a single transaction subject. Null fields are omitted from the JSON response. Three shapes exist: evaluated (sections present), notAvailable (subject absent from product-transactions), or notConfigured (subject absent from transactions-params).