PolicyStreamObject

PolicyStreamObject

fieldtypedescriptionproperties
idstring(uuid)ID of the object. Pass it to GET /teams/{teamId}/policystream/objects/{objectId} for the full pull behind it.
policy_stream_idstring(uuid)ID of the Policy Stream that found the object
carrierstringCarrier ID of the agent portal
policy_numberstring | nullPolicy number the object belongs to
policy_idstring(uuid) | nullID of the object's policy among pull.policies in the object's detail
carrier_customer_identifierstring | nullThe carrier's identifier for the customer this object belongs to
typestringWhat kind of object this is. A POLICY_TERM is one term of a policy and has a state. A NOTICE is a notice the carrier issued, such as a pending cancellation, and has no state.enum: POLICY_TERM, NOTICE
detailsobject | nullThe record's own fields, keyed as the Pulls API keys them: a Policy for a POLICY_TERM, a PolicyNotice for a NOTICE. policy_id is left out, since it is on the object itself.
statestring | nullA policy term's lifecycle state; null for a notice. details.status holds the carrier's finer status, such as PENDING_CANCELLATION while state is ACTIVE. A non-renewed term stays ACTIVE until it expires; the non-renewal shows up as a NON_RENEWAL notice. NO_LONGER_VISIBLE means the portal stopped showing the policy.enum: ACTIVE, CANCELLED, EXPIRED, NO_LONGER_VISIBLE, null
changestring | nullThe kind of the object's latest change. Objects are never removed: a policy the portal stops showing moves to NO_LONGER_VISIBLE.enum: ADDED, MODIFIED, null
last_verified_atstring(date-time)When the stream last saw the object, changed or not
changed_atstring(date-time)When the object last changed, or when a policy term was sent again right after a new notice on its policy
effective_atstring(date-time) | nullWhen the object takes effect at the carrier, such as a term's start or a notice's effective date. Customer data, not the sync order.