> ## Documentation Index
> Fetch the complete documentation index at: https://docs.niobi.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> This section outlines the initial steps needed to begin using the Niobi Payments API, including account setup and API authentication.

## Setup your Environment

Niobi provides both a sandbox and live environments to successfully integrate with our API. This will allow your organization to work with our APIs without any compliance or security risks.

Details of Niobi's sandbox and live environments are as below

<AccordionGroup>
  <Accordion icon="github" title="Sandbox">
    During the development process, you will use a sandbox environment where you can easily interact with our APIs without making simulated / mocked transactions.

    1. To get started, follow the signup instructions using this link for the [sandbox account](https://payments.niobi.co).
    2. The base URL for our sandbox APIs is ([https://sandbox.users.niobi.co](https://sandbox.users.niobi.co)).
    3. The rest of the steps, including creating an account, verifying it and fetching API credentials are all same for both our sandbox and live environments.
  </Accordion>

  <Accordion icon="rectangle-terminal" title="Live">
    After testing with the sandbox and ready for production.Follow these steps.

    1. Follow the signup instructions using this link
       [Live](https://payments.niobi.co).
    2. Change the API endpoints from
       `https://sandbox.users.niobi.co` to  `https://users.niobi.co`
    3. Make sure your live account is ***verified*** by our compliance team to be ready to accept and send payments. [Account Verification](https://docs.niobi.co/quickstart).

    (Please Note: Live transactions are subject to a transaction fee.)
  </Accordion>
</AccordionGroup>

## Authentication

To begin using the Niobi Payments API, you will require an API key for authentication. Please follow these steps to set it up:

**Obtain API Key:** You can set up an account with Niobi to obtain API key required for authentication. (see steps below)

**Authenticate API Requests:** Use your API keys to generate a unique signature for each request you make to the Niobi API. (see steps [here](https://docs.niobi.co/authentication))

**Whitelist IPs** In addition to creating an account on our payment portal and generating new API keys, you must also request IP whitelisting for all your sandbox and live servers. You can do this by requesting on our support channel or emailing support at [support@niobi.co](mailto:support@niobi.co)

## Setting up a Niobi Account

To access the Niobi Payments API, you need to create an account on our platform and then add a developer account in the Workspace section. Follow the steps below to get started:

<Steps>
  <Step title="Niobi Payment Portal">
    <ol type="a">
      <li>
        {' '}

        The Niobi Payment Portal gives you access to both sandbox and live environments
        with Niobi so you can use it to transact with our APIs
      </li>

      <li>
        {' '}

        When you register for an account you would need to submit all compliance
        documents in order to have your account verified. You can choose to do this
        via the portal or request for verification via our compliance team at [support@niobi.co](mailto:support@niobi.co){' '}
      </li>

      <li>
        {' '}

        You can use the same portal for sandbox and production environment access
        by clicking the toggle on the top right at any time
      </li>
    </ol>
  </Step>

  <Step title="Registration">
    <ol type="a">
      <li>
        {' '}

        Open your web browser and visit [https://payments.niobi.co/register](https://payments.niobi.co/register) if you
        are just starting out integrating Niobi and want to register on our payment
        portal{' '}
      </li>

      <li>
        Under the sign up page, fill in the required information, such as your
        name, email address, and password.
      </li>

      <li>
        {' '}

        Accept the terms and conditions, and then click on "Sign Up" to proceed to
        register your business.
      </li>

      <li>
        Fill in the required information about your business and click on "Save
        Business Details" to proceed.
      </li>

      We ask that only managers/owners of the business set up their business
      account first and then invite other team members to the platform later.
    </ol>
  </Step>

  <Step title="Inviting a user">
    <ol type="a">
      <li>
        Once you have created your account, you need to invite the developer who
        will be working on the integration. To do this, navigate to the
        "Workspace" section on the left sidebar.
      </li>

      <li>
        Within the Workspace tab, you will see an option to manage your "Team".
        Navigate to it and click the "Invite Users" button.
      </li>

      <li>
        Once you click it, you will see the option of adding emails and roles of
        the team members you want to invite.
      </li>

      <li>
        Please add the email of the team member that needs to be invited and set
        their role as "Developer".
      </li>

      <li>
        The invited team member will now receive an email invitation to sign up.
      </li>
    </ol>
  </Step>

  <Step title="Registering developer account">
    <ol type="a">
      <li>
        The developer should sign up using the link provided in their
        email.{' '}
      </li>

      <li>
        Once the account has been created the user can navigate through the
        sidebar and interact with the dashboard to see a snapshot of the API
        activity, see transactions on the balance screen as well as generate API
        keys.{' '}
      </li>
    </ol>
  </Step>

  <Step title="Creating a new integration">
    <ol type="a">
      <li>
        In the developer account, on the sidebar menu under "Workspace", select
        the option "Integration" where you will be able to generate API keys.
        Click on the "API Keys" button.
      </li>

      <li>
        Begin by creating your first integration by clicking the "Create
        Integration" button. We recommend creating one integration for each of
        the projects you are using the APIs with.
      </li>

      <li>
        You would need to create separate integrations for both sandbox and live
        accounts in the respective environment.
      </li>
    </ol>
  </Step>

  <Step title="Generating API Credentials">
    <ol type="a">
      <li>
        Within the Integration settings, the developer can generate the required
        credentials for the integration.{' '}
      </li>

      <li>
        These credentials typically consist of a Client ID and Secret Key. Make
        sure to save these credentials securely.
      </li>

      <li>
        This key serves as your authentication mechanism when making API
        requests. Once generated, make sure to securely store your API key and
        avoid sharing it publicly.
      </li>
    </ol>
  </Step>

  <Step title="Using the credentials">
    You are now ready to integrate the Niobi Payments API into your application.
    Please follow our details [Authentication
    Guide](https://docs.niobi.co/Authentication) to securely access our APIs and
    protect the integrity of your requests.
  </Step>
</Steps>

## Account Verification

Once you have integrated with our sandbox and finished testing the API, you can migrate to generating live API Integration credentials and following the other steps highlighted above.

Before going live with Niobi Payments, it's mandatory for all businesses to complete our ***Know Your Customer (KYC)*** and ***Know Your Business (KYB)*** verification processes. This is a critical step to ensure compliance with financial regulations and to maintain the integrity and security of our platform.

During ***KYC***, we require individual users to provide valid identification documents.

For ***KYB***, businesses must submit specific registration documents, including details about the business and its shareholders.

This process helps us verify the legitimacy of your business and its stakeholders, ensuring a secure and trustworthy environment for all transactions. We are committed to maintaining the highest standards of security and compliance, and we appreciate your cooperation in providing these necessary documents to complete the verification process.

## Next Steps

Once you have followed these steps you can move to the next part of our documentation to understand how Niobi Payments work.

1. To integrate with Niobi to collect payments, click [here](https://docs.niobi.co/collectingpayments)
2. To integrate with Niobi to make payments, click [here](https://docs.niobi.co/makingpayments)