Get search by ID
curl --request GET \
--url https://api.getcurrent.ca/v1/searches/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.getcurrent.ca/v1/searches/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getcurrent.ca/v1/searches/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getcurrent.ca/v1/searches/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.getcurrent.ca/v1/searches/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getcurrent.ca/v1/searches/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcurrent.ca/v1/searches/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"meta": {
"searchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"searchedAt": "2023-11-07T05:31:56Z",
"submitted": {
"name": "<string>",
"params": {
"businessRegistry": true,
"regulatoryRegistry": true,
"regulatoryRegistryThreshold": 85,
"sanctionsScreening": true,
"sanctionsThreshold": 85,
"websiteAnalysis": true
},
"website": "<string>"
},
"status": "completed",
"searchedBy": "jsmith@example.com",
"duration": 123
},
"businesses": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"registrationNumbers": [
{
"label": "<string>",
"value": "<string>"
}
],
"entityType": "<string>",
"jurisdiction": "<string>",
"status": "<string>",
"incorporationDate": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"alternateNames": [
"<string>"
],
"people": [
{
"name": "<string>",
"titles": [
"<string>"
],
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"ownership": "<string>"
}
],
"sourceUrl": "<string>",
"businessReport": {
"people": [
{
"name": "<string>",
"titles": [
"<string>"
],
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"ownership": "<string>"
}
],
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {
"goodStanding": true,
"nameHistory": [
{
"type": "<string>",
"name": "<string>",
"effectiveDate": "<string>",
"endDate": "<string>"
}
],
"naicsClassification": [
{
"code": "<string>",
"description": "<string>"
}
]
},
"reportUrl": "<string>",
"reportUrlExpiresAt": "2023-11-07T05:31:56Z"
}
}
],
"regulatory": {
"craCharities": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"fintracMsb": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"agcoCannabis": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"healthCanadaCannabis": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"mohServiceProviders": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"bankOfCanadaRps": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"wsibClassifications": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"onBusinessLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"torontoBusinessLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"vancouverBusinessLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"rbqLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
]
},
"sanctions": {
"query": "<string>",
"totalMatches": 1,
"matches": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5,
"matchedName": "<string>",
"nameScores": [
{
"name": "<string>",
"score": 0.5
}
]
},
"alternateNames": [
"<string>"
],
"entityType": "<string>",
"details": {
"source": "<string>",
"countries": [
"<string>"
],
"programs": [
"<string>"
],
"identifiers": [
"<string>"
],
"listingDate": "<string>",
"dateOfBirth": "<string>",
"remarks": "<string>",
"datasets": [
"<string>"
],
"topics": [
"<string>"
],
"legalForm": "<string>"
},
"sourceUrls": [
"<string>"
]
}
]
},
"website": {
"status": "success",
"url": "<string>",
"scrapedAt": "2023-11-07T05:31:56Z",
"extracted": {
"legalName": "<string>",
"descriptions": [
"<string>"
],
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"people": [
{
"name": "<string>",
"titles": [
"<string>"
],
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"ownership": "<string>"
}
],
"registrations": [
{
"label": "<string>",
"value": "<string>"
}
],
"contactInfo": {
"emails": [
"jsmith@example.com"
],
"phoneNumbers": [
"<string>"
]
}
},
"industry": {
"naicsCode": "<string>",
"naicsDescription": "<string>",
"reasoning": "<string>"
},
"domain": {
"url": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
},
"error": "<string>"
},
"errors": {
"businessRegistry": {
"code": "TIMEOUT",
"message": "<string>",
"retryable": true
},
"regulatoryRegistry": {
"code": "TIMEOUT",
"message": "<string>",
"retryable": true
},
"sanctionsScreening": {
"code": "TIMEOUT",
"message": "<string>",
"retryable": true
},
"websiteAnalysis": {
"code": "TIMEOUT",
"message": "<string>",
"retryable": true
},
"general": {
"code": "TIMEOUT",
"message": "<string>",
"retryable": true
}
}
}
Search
Get search by ID
Retrieve a specific search result by its ID. Plural-form alias of
GET /search/{id}.
GET
/
searches
/
{id}
Get search by ID
curl --request GET \
--url https://api.getcurrent.ca/v1/searches/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.getcurrent.ca/v1/searches/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getcurrent.ca/v1/searches/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getcurrent.ca/v1/searches/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.getcurrent.ca/v1/searches/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getcurrent.ca/v1/searches/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcurrent.ca/v1/searches/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"meta": {
"searchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"searchedAt": "2023-11-07T05:31:56Z",
"submitted": {
"name": "<string>",
"params": {
"businessRegistry": true,
"regulatoryRegistry": true,
"regulatoryRegistryThreshold": 85,
"sanctionsScreening": true,
"sanctionsThreshold": 85,
"websiteAnalysis": true
},
"website": "<string>"
},
"status": "completed",
"searchedBy": "jsmith@example.com",
"duration": 123
},
"businesses": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"registrationNumbers": [
{
"label": "<string>",
"value": "<string>"
}
],
"entityType": "<string>",
"jurisdiction": "<string>",
"status": "<string>",
"incorporationDate": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"alternateNames": [
"<string>"
],
"people": [
{
"name": "<string>",
"titles": [
"<string>"
],
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"ownership": "<string>"
}
],
"sourceUrl": "<string>",
"businessReport": {
"people": [
{
"name": "<string>",
"titles": [
"<string>"
],
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"ownership": "<string>"
}
],
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {
"goodStanding": true,
"nameHistory": [
{
"type": "<string>",
"name": "<string>",
"effectiveDate": "<string>",
"endDate": "<string>"
}
],
"naicsClassification": [
{
"code": "<string>",
"description": "<string>"
}
]
},
"reportUrl": "<string>",
"reportUrlExpiresAt": "2023-11-07T05:31:56Z"
}
}
],
"regulatory": {
"craCharities": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"fintracMsb": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"agcoCannabis": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"healthCanadaCannabis": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"mohServiceProviders": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"bankOfCanadaRps": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"wsibClassifications": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"onBusinessLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"torontoBusinessLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"vancouverBusinessLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
],
"rbqLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {},
"sourceUrl": "<string>"
}
]
},
"sanctions": {
"query": "<string>",
"totalMatches": 1,
"matches": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5,
"matchedName": "<string>",
"nameScores": [
{
"name": "<string>",
"score": 0.5
}
]
},
"alternateNames": [
"<string>"
],
"entityType": "<string>",
"details": {
"source": "<string>",
"countries": [
"<string>"
],
"programs": [
"<string>"
],
"identifiers": [
"<string>"
],
"listingDate": "<string>",
"dateOfBirth": "<string>",
"remarks": "<string>",
"datasets": [
"<string>"
],
"topics": [
"<string>"
],
"legalForm": "<string>"
},
"sourceUrls": [
"<string>"
]
}
]
},
"website": {
"status": "success",
"url": "<string>",
"scrapedAt": "2023-11-07T05:31:56Z",
"extracted": {
"legalName": "<string>",
"descriptions": [
"<string>"
],
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"people": [
{
"name": "<string>",
"titles": [
"<string>"
],
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"ownership": "<string>"
}
],
"registrations": [
{
"label": "<string>",
"value": "<string>"
}
],
"contactInfo": {
"emails": [
"jsmith@example.com"
],
"phoneNumbers": [
"<string>"
]
}
},
"industry": {
"naicsCode": "<string>",
"naicsDescription": "<string>",
"reasoning": "<string>"
},
"domain": {
"url": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
},
"error": "<string>"
},
"errors": {
"businessRegistry": {
"code": "TIMEOUT",
"message": "<string>",
"retryable": true
},
"regulatoryRegistry": {
"code": "TIMEOUT",
"message": "<string>",
"retryable": true
},
"sanctionsScreening": {
"code": "TIMEOUT",
"message": "<string>",
"retryable": true
},
"websiteAnalysis": {
"code": "TIMEOUT",
"message": "<string>",
"retryable": true
},
"general": {
"code": "TIMEOUT",
"message": "<string>",
"retryable": true
}
}
}
Authorizations
bearerAuthapiKeyHeader
API key as Bearer token: Authorization: Bearer cur_live_xxxxx
Path Parameters
Search ID (UUID)
Response
Search result
Show child attributes
Show child attributes
Business registry results sorted by match confidence
Show child attributes
Show child attributes
Regulatory registry matches — each key is a flat array (empty when no matches)
Show child attributes
Show child attributes
Sanctions screening results — null when sanctionsScreening is not enabled
Show child attributes
Show child attributes
Website analysis results — only present when websiteAnalysis is true or website URL was provided
Show child attributes
Show child attributes
Per-source errors — only present when one or more sources failed. Presence does not mean the search failed overall.
Show child attributes
Show child attributes
Was this page helpful?
⌘I