Migrate to client key

If your Web integration uses the origin key or your iOS or Android integration uses the client encryption public key, switch to the client key. In future versions the client key will be the only way to do client-side authentication. The client key makes it easier for you to manage the origins for your integration.

With the client key, you have:

• A single key for all your allowed origins in an environment.
• Flexibility to add and remove origins without having to generate a new client key.
• A human-readable prefix, test or live, so you can easily tell which environment a client key is linked to.

The client key also enables card type detection through Bank Identification Number (BIN) lookup, which is not available when using the origin key.

Availability and compatibility

The client key is available for the following:

The client key is backwards compatible with the origin key and the public key. Generating a client key doesn't invalidate a pre-existing origin key or public key.

Switch to using the client key

To switch to using the client key, you must first generate your client key in your Customer Area:

1. Log in to your Customer Area.
   1. Go to Developers > API credentials, and select the credential username for your integration, for example ws@Company.[YourCompanyAccount].
   2. Under Client settings > Authentication select the Client key tab.
   3. Select Generate client key.
   4. Select the copy icon and store your client key securely in your system.
   5. Under Add allowed origins, enter your domains and select Add.
   6. Select Save changes.

Once you have your client key, you need to add it to your integration. Choose your platform:

See also