operation post api v1 apply sessions parameter expire.md
Expire a session
POST /api/v1/apply/sessions/{session}/expire
Expires the insurance application session with the given ID. An insurance application session can't be expired if the application status is complete.
After it expires, a contractor can’t complete an insurance application session and contractors loading the insurance application session see a message saying the insurance application session is expired.
Servers
- Production server: https://api.1099policy.com (Production server)
Parameters
Path parameters
- session (string)
The ID of the desired session (e.g.,ias_01FVCHXE7PNQHA1T3S2AXL2QZE).
Responses
200
Returns a session object if the expiration succeeded. Returns an error if the session is already expired or isn't in an expireable state.
Body: application/json (object)
cancel_url (string)
The URL the contractor will be directed to if they are ineligible or decide to abandon the insurance application and return to your website.created (integer(int64))
expired (boolean)
Indicates whether the insurance application session has expired. If true, the contractor will be redirected to the cancel_url.id (string)
quote (string)
The ID of the quote associated with the insurance application session.step (string)
The step in the insurance application process that the contractor is currently on. The contractor will be redirected to this step when they return to the insurance application. One ofverify_info,application_questions,esignature_document,add_card_details,final_review, orapplication_complete.success_url (string)
The URL to which 1099Policy should direct independent contractors when a contractor successfully procures insurance coverage.url (string)
The URL to the insurance application Session. Redirect customers to this URL to take them to their insurance application. The domain will use apply.1099policy.com.