FAQs
Where do I get the API token?
The API token will be provided by the Turaco team once the contracting terms have been agreed. In the meantime, feel free to explore the API on these pages using the API key provided.
Do all the requests require the API token?
Yes, all the requests are protected and therefore require the API token.
How can I test the API?
Using the bearer token provided on the Welcome page of this documentation, head over to the API section of the documentation and select the specific API you would like to test. On the top left corner, enter the bearer token. Depending on the API, you may be required to enter some test parameters before clicking the "Try It" button. This action will trigger an API call that will provide a response with a corresponding response/error code.
Where should I ask a question on a particular API?
If you have any inquiries, feel free to contact us using the email provided on our Contact Us page. Additionally, if we are in the process of establishing a partnership, we can offer a Slack channel, a Skype group, or a WhatsApp group where you can directly connect with our Engineering team for assistance.
What should I do if I get an unclear error after submitting my API request?
To begin, it would be beneficial to review the API section of the documentation, which provides information on common errors. This resource can help you gain a better understanding of any issues you may encounter. If you find this information insufficient, please contact our Engineering team through your preferred communication channel, as mentioned in the previous question. We will be glad to assist you with troubleshooting or resolving the problem. To facilitate the troubleshooting process, please have your payload ready.
How do I check the cover end date for a policy?
Using the policy ID generated during the creation of a policy, use the Get Policy API to get more information about the policy including the cover start and end dates.
How do I add beneficiaries to a policy?
You can add a beneficiary to an existing policy only during cover renewal. You can make use of the Create Policy API to Add a family member. You can make use of the same API during renewal to exclude a family member by failing to submit them in the request.
What is the Difference between Policy ID and Policy Number?
Policy ID is typically a unique identifier created by our system that can be used by an API user to query for the policy. The Policy number is a unique reference also generated by our system but typically used by customer facing users to identify the Policy that has been created. This is typically what is shared with the end user if necessary.