Create an API Client

Before you begin

You need the API Management permission to set up a new client. You will need to request it from your admin if you can't access the following steps

Step 1: Create an OAuth 2.0 client on the Verified Carrier Portal

• Log in to the Verified Carrier Portal,
• Select the Account Page in the left sidebar. Select the API Management tab
  (or follow this link:https://portal.verifiedcarrier.com/broker/company/account)

• Click Create New App, enter a name for the app, and save

Step 2: Note the client ID and client secret

• Click on the newly created app to access its details and settings.
• The client ID and client secret will be used to authenticate your application when users grant access to your application.
• If the client secret ever becomes compromised and needs to be reset, contact customer support.
  • Note that once the client secret is reset, it cannot be undone. Your app will immediately lose access to Lucid until the client secret is updated in your app as well.

Step 3: Register a Redirect URI

• On the newly created app page under the OAuth 2.0 Integration section, input the Success Redirect URI that you want to redirect users back to once they have granted permissions to your app.
  • This should be a URL that the app controls. Verified Carrier will append the authorization code to the URL in the code query parameter.
  • For more more information, reference the glossary

Step 4: Set Client Scopes

• Scroll down on this page to the Permissions sections
• Select the Scopes that this client has access to

You can find more information about the client scopes on our scope definition page.