Reinstatements
A reinstatement is a policy transaction that reinstates a previously canceled policy. This topic covers how to manage cancellations through Cloud API.
For details on the business functionality reinstatements, see the Application Guide.
Initiating a reinstatement
Reinstatements are initiated from the policy itself. Reinstatements can be initiated only from canceled policies.
Use the following endpoint to create a reinstatement for a given canceled policy:
- POST
/policy/v1/policies/{policyId}/reinstate
You must specify the following fields:
reinstateCode
: A typecode from theReinstateCode
typelist
For example, the following initiates a reinstatement for policy pc:44.
POST /policy/v1/policies/pc:44/reinstate
{
"data": {
"attributes": {
"reinstateCode": {
"code": "payment"
}
}
}
}
This call creates a new job instance whose job type is "Reinstatement". The job's state
is Draft. The reinstatement's jobEffectiveDate
is automatically set to
the job effective date of the corresponding cancellation.
Modifying and quoting the reinstatement
Typically, a policy is not modified when it is reinstated. The most common intent of a reinstatement is to reinstate the policy in the state it was in when it was canceled.
However, it is necessary to quote the reinstatement. This is because additional charges
may have been added as a result of the reinstatement, such as a reinstatement fee. To
quote the reinstatement, use the POST /job/v1/jobs/{jobId}/quote
endpoint. The request object does not require a request body.
POST /job/v1/jobs/pc:4040/quote
<no request body>
Completing the reinstatement
The following table summarizes the different endpoints that can be used to complete a reinstatement.
Outcome | Endpoint |
---|---|
Reinstate the policy | /job/v1/jobs/{jobId}/bind-and-issue |
Withdraw the reinstatement | /job/v1/jobs/{jobId}/withdraw |
Example of binding the reinstatement
Use the following endpoint to bind a reinstatement:
- POST
/job/v1/jobs/{jobId}/bind-and-issue
The request object does not require a request body.
For example, the following request binds and issues job pc:333.
POST /job/v1/jobs/pc:333/bind-and-issue
<no request body>
The reinstatement's status is changed to "Bound".
Example of withdrawing the reinstatement
Use the following endpoint to withdraw the reinstatement:
- POST
/job/v1/jobs/{jobId}/withdraw
The request object does not require a body.
For example, the following request withdraws job pc:333.
POST /job/v1/jobs/pc:333/withdraw
<no request body>
The reinstatement's status is changed to "Withdrawn".