API

CV Quo provides API for our partners to use the CVQ Score.

CVQ is dynamic and could potentially change on a daily basis due to several variables. Hence we advise our partners to pull the latest CVQ for their consumption.

Partners will have to register their APP, obtain an ID and a Key before they can start using the API. As part of the registration, partners will have to agree to the terms of use.

Scope

CV Quo makes three Scopes available for consumption.

CVQ	Provides the CVQ score
CVQ_LITE	Includes the scope of CVQ plus some additional data
CVQ_COMPREHENSIVE	Includes the scope of CVQ_LITE plus some incremental data

By default, scope CVQ is assigned when a partner registers their app. If any of the partners want to use scope CVQ_LITE or CVQ_COMPREHENSIVE, please contact us using the support link available under your ‘Account’ dropdown on the top navigation bar of the APP.

How to Register

Sign up for an account

In order to register an APP, first create a CVQ user account if you don’t already have one. This is the regular account anyone creates through the sign up page.

Note: Do not create a separate user account to register an APP. If John Doe is the user registering the APP, then John Doe will use his CVQ user account to register the APP. In other words John Doe will not have two separate user accounts – one for his CVQ Score and other for the APP.

Enable the Developer Menu

Follow the below steps to enable the developer menu.

1. Once the user account is created, go to the drop down menu on the top right corner, click on the drop down arrow and choose ‘Settings’.
2. This will bring the ‘Manage Your Account’ section. Under the ‘General’ tab, look for ‘Enable Developer Account’ at the bottom.
3. Toggle the switch from ‘No’ to ‘Yes’.
4. Save the changes.

This will enable the Developer menu.

Register the APP

Under the Developer Menu you will see the option ‘Manage App’.

Click on ‘Manage App’ to launch the registration form.

Note: If you already have an app registered, then you will see an ‘Add’ option to register another app instead of the registration form.

Provide the information asked and ‘Submit’ the form.

Upon submission an ‘ID’ and ‘Secret’ will be assigned to your app.

Use this ‘ID’ and ‘Secret’ in your app to pull the scores.