bullseye-arrowQuickstart

Overview

This guide will walk you through the steps to create an account, obtain your API keys, and begin using the BIVE.AI verification APIs.

Step 1: Create an Account

  1. Visit the BIVE.AI Registration Page:

  2. Provide Account Information:

    • Enter your name, work email address, and phone number.

    • You can also optionally provide business details.

    • Ensure your email address is a valid work email.

  3. Buy credits

    • Verifications require credits. Choose an amount to add to your account. Your first verification is free.

  4. Access the BIVE Dashboard:

    • BIVE.AI will instantly verify your provided information and process your payment.

    • Upon successful verification and payment, you will gain immediate access to the BIVE dashboard.

Two-Factor Authentication (2FA):

  • For enhanced security, BIVE.AI implements 2FA by default.

  • You will be required to enter your PIN and a One-Time Password (OTP) to access your account.

  • The OTP will be sent to your registered phone number.

  • You will be asked to set a PIN during account creation.

Step 2: API Authentication

  1. Navigate to the API Tab:

  2. Copy API Keys:

    • Locate and copy your "Publishable Key" and "Secret Key."

    • The publishable key is used for client-side operations, and the secret key is used for server-side operations.

  3. Securely Store API Keys:

    • Store your API keys securely and never expose your Secret Key in client-side code or commit it to version control.

  4. Begin Using the API:

    • You can now use your API keys to initiate verification requests.

API Key Usage:

  • Publishable Key:

    • Used for client-side operations, such as initializing the BIVE.AI JavaScript SDK.

  • Secret Key:

    • Used for server-side operations, such as making API requests to verify documents or persons. Set the key in the authorization header in all requests

circle-exclamation

Pass the secret key in the authorization header when you make api requests

Header

Api-Key

{Your BIVE secret key}

Host: https://api.bive.aiarrow-up-right

Last updated