Quick Start

📘

For ordering subscription

Feel free to get free trials.
Please contact JCV sales to make paid subscriptions.
The online subscription will be available soon.

Create a service instance of Liveness

To start using Liveness, you must have a service instance first.

1. Sign in to the management console of JCV Cloud (https://cloud.japancv.co.jp/en/signin).
   The dashboard screen appears.

2. Select an organization from the top bar.
   The hamburger button appears on the left.

3. Click the hamburger button to show the list of services.
   Click API Services - Liveness to enter the management console of Liveness.

4. Click Add instance to create a service instance.

5. On the service instance creation page, select the service region, select the service plan, enter a service instance name, and check the "I agree to the JCV Cloud Service Terms of Use". Then click the Add instance button to finish creating a service instance.🎉

Create an API key

After creating a service instance, you need to have an API key assigned to that instance to start using the service.

1. On the instance list screen, click the service instance you want to create an API key.
   The detailed information screen of that instance will appear at the bottom.

2. Click the API Keys tab, and the list of API keys appears.

3. Click the Create an API Key button to display the popup window of API key-creating.

4. Enter the name of the API key and click Create.

📘

About API keys

For each service instance, you can create up to 5 API keys.
The names of API keys cannot be duplicated.

5. The new API key screen appears when the API key is created successfully.
   Click the copy button on the right to copy the API key to the clipboard.
   Save the API key somewhere safe.
   You have the API key to access the Liveness service.🎉

🚧

Manage your API keys properly

Because JCV Cloud does not provide complex authentication methods, please keep your API keys in a safe place to keep your data safe.

Try it with the online API document

As you have the API key to access a service instance, you can try it now.

1. Click the questions mark on the top bar and the API references button.

2. On the API reference page, click the API you want to use on the left.

3. Paste the API key in the header.

4. Fill in the parameter values. The image should be base64-encoded.

5. Click the Try it! button.