Skip to main content

​
1. Get an API key

Go to API Keys and generate a key. It will look like cur_live_xxxxxxxxxxxx. 
curl -X POST https://api.getcurrent.ca/v1/search \
  -H "Authorization: Bearer cur_live_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"name": "Shopify Inc"}'
Searches typically take 20–40 seconds to complete. The business registry lookup is the bottleneck.

​
3. Read the response

A successful response returns a JSON object with several top-level sections: 
{
  "meta": {
    "searchId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "searchedBy": "user@example.com",
    "searchedAt": "2024-01-15T10:30:00Z",
    "submitted": {
      "name": "Shopify Inc",
      "website": null,
      "params": {
        "businessRegistry": true,
        "regulatoryRegistry": true,
        "sanctionsScreening": false,
        "sanctionsThreshold": 85,
        "websiteAnalysis": false
      }
    },
    "status": "completed",
    "duration": 24318
  },
  "businesses": [
    {
      "legalName": { "name": "Shopify Inc.", "matchScore": 0.98 },
      "jurisdiction": "Federal",
      "status": "Active",
      "incorporationDate": "2011-09-14",
      "registrationNumbers": [
        { "label": "Federal Corporation Number", "value": "796223-2" }
      ]
    }
  ],
  "regulatory": {
    "craCharities": [],
    "fintracMsb": [],
    "agcoCannabis": [],
    "healthCanadaCannabis": [],
    "mohServiceProviders": []
  },
  "sanctions": null,
  "website": null,
  "errors": null
}
FieldDescription
meta.searchIdSave this to retrieve the result later via GET /search/{id}
meta.submittedYour original query and the parameters used (with defaults applied)
meta.statuscompleted, completed-with-errors, or error
businessesRegistry matches, sorted by confidence score
regulatoryCharity, MSB, cannabis, and health service provider registrations
sanctionsSanctions matches (null when screening not enabled)
websiteWebsite analysis results (null when not enabled)
errorsPer-source errors (null when all sources succeeded)

​
Next steps

Authentication

Learn about API key formats and best practices

Search guide

Explore all search parameters and what they return

Sanctions screening

Add global watchlist screening to your searches

Response structure

Full reference for every field in the response