Get Started

This guide will quickly get you started with our powerful, easy-to-use APIs.

Introduction

This step-by-step guide will help you get up and running quickly with our powerful and easy-to-use APIs.


To use our API products, just create a Developer account. Creating an account is quick and easy.

  1. Visit the Registration Page
  2. Fill out the Registration Form
    • Provide your First name, Last name, Company Name, Company Email ID, and Mobile Number.
  3. Submit your registration request
    • Submit the registration request.
    • You will receive an email confirmation for your registration request.
    • HDFC Ergo administrator will create your credentials for login and share via a separate email.
    • Use the shared login credentials and perform further operations.
    • Contact our administrator in case you face any difficulties.

The authentication for APIs is done on the basis of JWT token. To obtain a JWT token, you need to call our authentication API. The authentication mechanism can vary as per API, depending on the required level of authentication.

  1. Log in to your account
    • Go to Login page.
    • Use your credentials to log in to the developer portal.
  2. Navigate to the Apps Section
    • Use any of your existing Apps or create a new Developer App.
    • While creating a new App, choose API products which you want to subscribe to.
  3. Generate new credentials for existing or newly created App
    • Click on "Generate New API Key" and follow the instructions.
  4. Save your credentials for further usage
    • Copy and securely store your client Id and Secret. You’ll need it to authenticate your API calls.
  • Want to be inspired and learn what you could build? Our available APIs are displayed on the API products page. From here you can navigate to the underlying API Overview pages for details of a specific API. Further you can also go to the Documentation pages for more technical information.
support
  • Questions or problems? We are happy to help. Please check our FAQs page for the answers to frequently asked questions.
  • Encountering an unusual use case or implementation? Post in our developer Forum and leverage the experience of our community.
  • Inspired by success stories? Check out our Blog and catch up on the latest ways businesses have integrated our API products.
  • Can’t find the answer you need? Please contact us and we will get back to you as soon as possible.