SE · Cancellations API · 2021-01-01
CancellationsRequest
The authentication method used by the insurance holder to sign the power of attorney. Also used for viewing document if not specified separately. Required for SCRIVE cancellations, not used for MANUAL cancellations.
BANK_ID or STANDARD.The email address of the cancellation author.
The id of the collection in which the insurances were fetched.
The method used by Scrive to deliver the power of attorney to the insurance holder. Required for SCRIVE cancellations, not used for MANUAL cancellations.
EMAIL, SMS or API.The type of cancellation. Defaults to SCRIVE, where the power of attorney is sent to the insurance holder for signing through Scrive. With MANUAL, the power of attorney is created but not sent: fetch the unsigned PDF via GET /cancellations/{documentId}/pdf, have it signed outside the platform, and report the outcome via POST /cancellations/{documentId}/status. deliveryMethod and the other Scrive fields are not used for MANUAL.
SCRIVE or MANUAL.The email address of the insurance holder. Only required if deliveryMethod is EMAIL. Not used for MANUAL cancellations.
Optionally supply the insurance holder full name to use for the cancellation.
The insurances to create cancellations for.
Optionally assign personal number unless present on collected insurance.
The phone number of the insurance holder. Only required if deliveryMethod is SMS. Not used for MANUAL cancellations.
Scrive redirects the insurance holder here if they reject the document. Not used for MANUAL cancellations.
Scrive redirects the insurance holder here after signing the document. Not used for MANUAL cancellations.
Tags added to the Scrive document. Not used for MANUAL cancellations.
The authentication method used by the insurance holder to view the power of attorney. Default value is same as authenticationMethod. Not used for MANUAL cancellations.
BANK_ID or STANDARD.{ "authenticationMethod": "BANK_ID", "authorEmail": { "value": "insurance.admin@anessa.co" }, "collectionId": "08a7c9b2-77a0-462f-907d-461a94158872", "deliveryMethod": "SMS", "documentType": "SCRIVE", "email": { "value": "insurance.admin@anessa.co" }, "insuranceHolderName": "Astrid Svensson", "insurances": [], "personalNumber": "198312151234", "phoneNumber": { "countryCode": "SE", "number": 701234567 }, "rejectedRedirectUrl": "https://www.your-site.com/customer-rejected-document", "signSuccessRedirectUrl": "https://www.your-site.com/customer-signed-document", "tags": [], "viewAuthenticationMethod": "BANK_ID"}