Authentication
Host
The base domain for the Real ID API is https://real-id.getverdict.com/api/v1.
All endpoints use this as the base URL.
API keys
Real ID's REST API uses Bearer tokens for authentication.
- Shopify
- WooCommerce
- BigCommerce
- Custom
You can find your token within the Real ID dashboard, under Settings > DevTools.
Your license key is also your Real ID API token. You can find your live license keys by logging into the billing dashboard, or opening the settings of the plugin and opening the Billing section.
API access is included on the Automate plan. Once you're on Automate, contact support to have a token issued for your store — BigCommerce stores aren't given one automatically. Your token then appears in the Real ID app under Settings > Dev Tools > API.
You can find your live and test API keys in the Real ID dashboard under Developers.
Once you have your API key, pass it into the Authorization header, and prefix the token with Bearer {{yourApiKey}}.
import axios from "axios";
// Send an ID check to John Smith at [email protected]
await axios.post(
"https://real-id.getverdict.com/api/v1/checks",
{
firstName: "John",
lastName: "Smith",
email: "[email protected]",
},
{
headers: {
Authorization: `Bearer ${yourApiKey}`,
},
}
);