LogoLogo
  • Introduction
  • Core Concepts
  • Partner setup
  • Tutorials [WIP]
    • Create Identities
    • Create a Blockchain Address
    • Payout Service
  • Public Mint Widget
    • Getting started
    • Embed Widget
      • Deposit of funds
      • Withdraw of funds
  • Public Mint API
    • Getting started
    • Creating identities
    • Connecting to the blockchain
      • Running your own client node
    • Executing Transactions
      • Depositing
      • Wallet Transactions
      • Withdrawing
    • Sandbox
    • API Reference
      • Identities
      • Operations
      • Transfer Methods
      • Transactions
      • Withdrawals (deprecated)
      • Verifications
      • Identity Relations
      • Documents
      • Deposits (deprecated)
      • Authentication
      • Pagination
      • Errors
      • Core Resources
    • Webhooks
  • Public Mint Blockchain
    • Getting started
    • Transacting
    • Configuring Metamask for the Public Mint blockchain
    • Interoperability [WIP]
  • Other Information
    • Public Mint Wallet
    • Users and Accounts
Powered by GitBook
On this page

Was this helpful?

  1. Public Mint API
  2. API Reference

Authentication

Authenticate your connection to access API resources

PreviousDeposits (deprecated)NextPagination

Last updated 5 years ago

Was this helpful?

Public Mint uses an to authorize, authenticate and route requests to endpoints. All requests require an for authorization and authentication in the request header associated to the key apikey, like the example below demonstrates. The key serves to identify the app/partner behind the requests, and which resources they're permitted to access.

If you don't include your key, or use an invalid one, the request will return an error.

AUTHENTICATED REQUEST
$ curl https://api.sandbox.publicmint.io/identities/:id \
  -H "apikey:{YOUR_API_KEY}"
AUTHENTICATED REQUEST
$ curl https://api.publicmint.io/identities/:id \
  -H "apikey:{YOUR_API_KEY}"

Authorization and authentication

Authorization to our public APIs requires a partner API key. To be eligible, you need to be a verified business partner. You can learn more about how to apply at the Partners section.

When your application is successful you'll receive a confirmation email giving you access to the Partners Portal (coming soon), where you'll be able to generate, revoke and manage your API keys.

While we work on finalizing the Partner's Portal, please contact us directly to request early access to our API.

You'll need to pass on your API key in the request headers when making calls to Public Mint's endpoints to and identify witch application/partner is using the APIs.

API keys also serve to authenticate user sessions.

API gateway
API key
authenticate your requests