Create a policy receipt

Once a policy has been issued, it is important that a receipt is created which verifies that the new policyholder has received their actual policy. This receipt can either be in the form of a tracking pixel in an email which contains the policy document, or it could be a custom method (subject to approval).

To add a tracking pixel to a policy email, you create an <img/> tag which looks like the following:

  <img src="https://sandbox.root.co.za/v1/insurance/policies/receipts/(:organisation_id).png?policy_id=128ba0c0-3f6a-4f8b-9b40-e2066b02b59e&version=1" />

Important to note is that the tag includes the policy version number and the policy unique identifier in the query string, while the image name that of your organisation_id.

Alternatively if you wish to use a custom receipt method, you can POST to the receipt endpoint. This endpoint accepts any valid JSON object, but MUST include the version number in the body. The body value should be any data which could be reasonably said to be evidence of the policyholder receiving the policy document.

Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!