Onboarding Guide
This quickstart guide is crafted to streamline your integration process, providing clear steps and sample requests for each service. Whether you're a seasoned developer or just getting started, we've designed our API to be accessible, powerful, and developer-friendly.
Before you begin
Before diving in, make sure you have the necessary prerequisites, including API key registration and any service-specific requirements. Let's embark on a seamless integration journey that unlocks the potential of open banking.
- Sign up on the CrediPay Dashboard.
- Create an App and fetch the generated Public and Secret Key.
This is used to make an API call for most of our endpoints, and it’s to be passed to your headers as CrediPay-sec-key
This is used to initialize the CrediPay Connect widget for user enrolment. This can be found on your dashboard right on the apps page.
Quickstart setup
Sign Up
As a first step, you need to register on the CrediPay Dashboard. The Dashboard is a toolbox that enables you to manage your account, your apps, and your customers. It is where you can find your API keys, and also where you can get insights into all the data that flows between your app, the CrediPay APIs, your customers, and their banks. The dashboard requires verification for the email you register - make sure that you confirm your email address.
Complete Compliance
After you’ve verified your email address, you can start signing up your business via the CrediPay Dashboard. This compliance process has 4 steps:
- Company info: provide your company name, its RC number, and select the country of registration. The dashboard verifies your RC number before you can continue.
- Registration documents: upload your company’s CAC certificate, and a proof of your company status on the CAC platform.
- Business profile: select your industry, provide your business’s name, and write a short summary about what your business does. Creating this business profile helps CrediPay provide more accurate support in case you need help.
- SLA: the last step is to accept CrediPay’s Service Level Agreement. You can request a copy of this agreement to your email address. Once you agree to the terms, you can launch the dashboard and start building.