Kredibel API
  • Home
  • Knowledge Base
    • Security
    • Scoring Engine
    • Blacklist & Whitelist
    • Team Management
  • API Guide
  • Getting Started
  • Environment
  • Authorization
  • Responses & Errors
  • API References
    • Account Screening
      • Watchlist Screening
      • Bank Account
      • Phone Number
      • Email Address
      • IP Address
    • Electronic Certificate
      • Certificate Issuance
    • Identity Verification [Deprecated]
      • Biometric Verification
      • Demography Verification
      • Full Verification
    • Text Recognition
      • National Identity
      • Driver License
      • Passport
    • Face Recognition
      • Face Comparison
    • Billing
      • Credit
Powered by GitBook
On this page
  • Generating API Key
  • Using API Key

Was this helpful?

Authorization

PreviousEnvironmentNextResponses & Errors

Last updated 1 year ago

Was this helpful?

Synapses API uses API keys to authenticate requests. These API keys can be generated from or for development purposes and must be supplied with each request.

Generating API Key

  1. Login to

  2. Click on the Setting -> API Token or directly visit /developer/token

  3. Click “Generate”

Using API Key

An API key is a token that a client provides when making API calls. Synapses API provides two methods for authentication.

  1. As a query string parameter

    Method

    Key

    POST

    {

    "key": "YOUR_API_KEY"

    }

    GET

    <endpoint>/v1/example?key=YOUR_API_KEY

  2. In the authorization header "Authorization: Bearer YOUR_API_KEY"

Both of the methods above work with Synapses API. The query string is easier to implement. But, makes it easier to discover for someone who should not have access to it. For every API call, we recommend using an authorization header since it is more secure.

synapses.kredibel.com
synapses.sandbox.kredibel.com
Synapses dashboard
<dashboard>