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
  • 1. Register as a Partner
  • 2. Complete your partner account KYC
  • 3. Obtain your API Key
  • 4. Receiving Callbacks

Was this helpful?

Partner setup

Registering as a Partner is necessary to access advanced features.

PreviousCore ConceptsNextTutorials [WIP]

Last updated 4 years ago

Was this helpful?

To be able to integrate with Public Mint services and APIs you need to register your company at the Public Mint Partnership Program. This requirement allows us to collect all the information we need to get started.

1. Register as a Partner

The registration process start with you sending an email to support@publicmint.com indicating your desire to become a Partner of Public Mint and a brief description of the business case you want to build.

2. Complete your partner account KYC

In order to complete the account registration process, we need to verify your identity and that of your company (via a KYC/KYB process).

After you send the initial email we will contact you to go through the KYC process, requesting the necessary information. Public Mint will review the information and contact you if additional information or documentation is needed.

As soon as that is cleared, your account will unlocked and you will be able to and start your development.

3. Obtain your API Key

With your account registered and the KYC process completed, you will receive a Sandbox API Key that will give you access to all of Public Mint's partner features in our sandbox environment. Use that environment to build your business integration. When you are ready to go to production, let us know through the email support@publicmint.com and we will kick-start the final validation phase that will end up with a production API Key that you can use with Public Mint's production environment.

With your API key in your hand, the next step is to start your integration development. Learn more on our .

4. Receiving Callbacks

When you register as partner at the Public API you must provide a webhook endpoint. This endpoint will receive any information sent from the API to a partner, like reference numbers for deposits, or the status of requests.

Some of the content notifications sent to parters are the following:

  • Deposits

    • status -> When a change occurs in the deposit status;

    • references -> When the reference for the deposit is made available.

  • Withdrawals

    • status -> When a change occurs in the withdrawal status.

The following snippet shows an example of data payload sent by our system to a partner's webhook.

/POST 

{
  type: 'deposits',
  data: {
    reference: 'dadas3112daSAas'
  } 
}
Development Quick Start Guide
Register as a Partner
Complete your partner account KYC
Obtain your API Key
generate an API Key