Routes
Get the status of a cancellation
GEThttps://api.insurely.com/cancellations/{documentId}
Returns the status of an initiated insurance cancellation.
Request
Path Parameters
documentIdstring
Responses
Status successfully fetched.
Body
agentAgent
createdAtstring[date-time]
UTC timestamp of when the cancellation was created.
documentTypestring
Possible Enum values are
SCRIVE or MANUAL.documentUrlstring
URL to Scrive for signing document, only present for API delivery method.
emailstring
The email address of the insurance holder. Only present if delivery method is email.
idstring
The cancellation ID.
insuranceInsurance
The cancelled insurance
insurancesArray<Insurance>
The cancelled insurances
isSignedAndSealedboolean
Whether or not the insurance holder has signed the power of attorney.
newInsuranceNumberstring
Insurance number of new insurance after this one is cancelled
phoneNumberstring
The phone number of the insurance holder. Only present if delivery method is SMS.
statusstring
The status of the signing document.
Possible Enum values are
PREPARATION, CREATED, PENDING, CLOSED, CANCELED, TIMED_OUT, REJECTED or DOCUMENT_ERROR.terminationDatestring[date]
Date of insurance termination/expiry
updatedAtstring[date-time]
UTC timestamp of when the cancellation was last updated.
cURL
curl https://api.insurely.com/cancellations/{documentId}