Setup

The sections below provide details about preparing to use the KyckGlobal Platform:

  • Onboarding - The Onboarding section describes how to create a KyckGlobal account and request API access.
  • Integration - The Integration section includes information about developing, certifying, and deploying your application.
  • Authentication - Protect your KyckGlobal account and your users' personal information with your account credentials and auth tokens.

Onboarding#

KyckGlobal provides API access to two types of organizations:

  • Payers - Payers are organizations who use the KyckGlobal platform to submit payments to payees.
  • Partners - Partners are organizations who bundle KyckGlobal features with their own software suites. Partner organizations are able to create new Payers. The type of organization you belong determines the set of operations that you are able to perform using the KyckGlobal platform.

You must contact support to request Payer or Partner access to the API.

Integration#

The KyckGlobal Platform is designed to be incorporated into existing business software. In order to support development and ensure the quality of the software, KyckGlobal provides both sandbox and production environments. The steps below describe how to get access to the KyckGlobal Platform and release your application once it has been developed and tested:

  1. Work with KyckGlobal to set up the KyckGlobal API sandbox environment for your account. During this step, your will create an Organization. The email address and password that you use will act as your Organization's credentials on the platform.
  2. During your development phase, use the KyckGlobal sandbox URL as the base path for your requests, and use your Organization's credentials for authentication.
  3. Once you have developed and tested your application, submit your application to KyckGlobal support for certification. Contact support@kyckglobal.com for details about application certification.
  4. Once your application has been certified, KyckGlobal support will update your Organization's privileges and provide you with the production environment base path.
  5. Update your application to use the KyckGlobal production base path and your production credentials.
  6. Release your application using your Organization's typical procedure.

Contact KyckGlobal support if you have any questions about incorporating the KyckGlobal Platform into your application.

Authentication#

The KyckGlobal Platform uses a combination of roles and auth tokens to identify users. The Account Roles and Auth Tokens sections define their uses and features.

Account Roles#

KyckGlobal accounts have one the following roles, which determine the user's privileges on the platform:

  • Partner Organizations - Partner Organizations are the parent accounts for the organizations that integrate with the KyckGlobal Platform. Partner Organizations can onboard Payer Organizations.
  • Payer Organizations - Payer Organizations can create payees and payments. Payer Organizations can integrate with the KyckGlobal Platform directly, or they can be maintained by a Partner Organization.
  • Payer Users - Payer Users are members of the Payer Organization. Payer Users can onboard Payees and submit payments for authorization. Payer users with admin privileges can create new Payer Users. the new Payer User's permissions are set by the Payer Admin User when the account is created.
  • Payees - Payees are individuals or companies that your organization pays using KyckGlobal. Payee records include details like mailing address and bank account information associated with the Payee. Payees can maintain their own accounts once they are created. A Payer User creates a Payee for each person or organization that will be paid using KyckGlobal. Each account is identified with an email address and password, which can be used to generate auth tokens, as described in the Auth Tokens section.

The KyckGlobal Platform includes features for managing each of the roles described above as well as submitting payments for processing and for reviewing reports about roles and payments.

Auth Tokens#

Auth tokens identify your account to the KyckGlobal APIs and protect your requests. Every request you submit to the KyckGlobal Platform (except for requests to the UserAuth endpoint) must include the following header:

Auth {Token}

For more details on the UserAuth endpoint, refer to the API Documentation area of the site.