curl --request POST \
--url https://api.getcurrent.ca/v1/searches \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Shopify Inc"
}
'{
"meta": {
"searchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"searchedAt": "2023-11-07T05:31:56Z",
"submitted": {
"name": "<string>",
"params": {
"businessRegistry": true,
"regulatoryRegistry": true,
"regulatoryRegistryThreshold": 0.85,
"sanctionsScreening": true,
"sanctionsThreshold": 0.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>"
}
],
"matchId": "8f14e45f-ceea-467a-9f8e-2bd1f3a1c7d2",
"entityType": "<string>",
"jurisdiction": "FED",
"jurisdictionLabel": "Federal",
"status": "<string>",
"incorporationDate": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"alternateNames": [
"<string>"
],
"people": [
{
"name": "<string>",
"roles": [
"<string>"
],
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"roleDetails": [
{
"category": "director",
"label": "<string>"
}
],
"ownership": 123,
"sharesHeld": "<string>",
"status": "<string>"
}
],
"sourceUrl": "<string>",
"businessReport": {
"people": [
{
"name": "<string>",
"roles": [
"<string>"
],
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"roleDetails": [
{
"category": "director",
"label": "<string>"
}
],
"ownership": 123,
"sharesHeld": "<string>",
"status": "<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
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"fintracMsb": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"agcoCannabis": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"healthCanadaCannabis": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"mohServiceProviders": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"bankOfCanadaRps": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"wsibClassifications": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"onBusinessLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"torontoBusinessLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"vancouverBusinessLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"rbqLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"aglcGamingRegistrants": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"aglcCannabis": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"bcCannabisRetail": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"montrealCommercialEstablishments": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"calgaryBusinessLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"edmontonBusinessLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"gleif": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"agcoManufacturers": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"agcoLiquorSales": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"agcoGroceryConvenience": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"nhpLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"ifoiFederalOrgs": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
]
},
"sanctions": {
"query": "<string>",
"totalMatches": 1,
"matches": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5,
"matchedName": "<string>",
"nameScores": [
{
"name": "<string>",
"score": 0.5
}
]
},
"alternateNames": [
"<string>"
],
"entityType": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<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>",
"extracted": {
"legalName": "<string>",
"descriptions": [
"<string>"
],
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"people": [
{
"name": "<string>",
"roles": [
"<string>"
]
}
],
"registrations": [
{
"label": "<string>",
"value": "<string>"
}
],
"contactInfo": {
"emails": [
"jsmith@example.com"
],
"phoneNumbers": [
"<string>"
]
}
},
"industry": {
"naicsCode": "<string>",
"naicsCodeName": "<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
}
},
"matchSelection": {
"status": "auto_selected",
"selectedMatchId": "8f14e45f-ceea-467a-9f8e-2bd1f3a1c7d2",
"statusUrl": "/api/v1/search/550e8400-e29b-41d4-a716-446655440000",
"selectionUrl": "/api/v1/search/550e8400-e29b-41d4-a716-446655440000/selection"
}
}Create Search
Create a new business verification search. Plural-form alias of
POST /search — identical request and response. See POST /search for
the full set of request examples (website analysis, sanctions, etc.).
curl --request POST \
--url https://api.getcurrent.ca/v1/searches \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Shopify Inc"
}
'{
"meta": {
"searchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"searchedAt": "2023-11-07T05:31:56Z",
"submitted": {
"name": "<string>",
"params": {
"businessRegistry": true,
"regulatoryRegistry": true,
"regulatoryRegistryThreshold": 0.85,
"sanctionsScreening": true,
"sanctionsThreshold": 0.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>"
}
],
"matchId": "8f14e45f-ceea-467a-9f8e-2bd1f3a1c7d2",
"entityType": "<string>",
"jurisdiction": "FED",
"jurisdictionLabel": "Federal",
"status": "<string>",
"incorporationDate": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"alternateNames": [
"<string>"
],
"people": [
{
"name": "<string>",
"roles": [
"<string>"
],
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"roleDetails": [
{
"category": "director",
"label": "<string>"
}
],
"ownership": 123,
"sharesHeld": "<string>",
"status": "<string>"
}
],
"sourceUrl": "<string>",
"businessReport": {
"people": [
{
"name": "<string>",
"roles": [
"<string>"
],
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"roleDetails": [
{
"category": "director",
"label": "<string>"
}
],
"ownership": 123,
"sharesHeld": "<string>",
"status": "<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
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"fintracMsb": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"agcoCannabis": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"healthCanadaCannabis": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"mohServiceProviders": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"bankOfCanadaRps": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"wsibClassifications": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"onBusinessLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"torontoBusinessLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"vancouverBusinessLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"rbqLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"aglcGamingRegistrants": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"aglcCannabis": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"bcCannabisRetail": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"montrealCommercialEstablishments": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"calgaryBusinessLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"edmontonBusinessLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"gleif": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"agcoManufacturers": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"agcoLiquorSales": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"agcoGroceryConvenience": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"nhpLicences": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
],
"ifoiFederalOrgs": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5
},
"match": {
"score": 0.5,
"baseline": "record",
"fields": [
{
"field": "name",
"label": "<string>",
"score": 0.5,
"status": "matched"
}
]
},
"alternateNames": [
"<string>"
],
"registrationNumber": "<string>",
"status": "<string>",
"derivedStatus": "active",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"details": {}
}
]
},
"sanctions": {
"query": "<string>",
"totalMatches": 1,
"matches": [
{
"legalName": {
"name": "<string>",
"matchScore": 0.5,
"matchedName": "<string>",
"nameScores": [
{
"name": "<string>",
"score": 0.5
}
]
},
"alternateNames": [
"<string>"
],
"entityType": "<string>",
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<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>",
"extracted": {
"legalName": "<string>",
"descriptions": [
"<string>"
],
"addresses": [
{
"street": "<string>",
"city": "<string>",
"province": "<string>",
"postalCode": "<string>",
"country": "<string>",
"raw": "<string>"
}
],
"people": [
{
"name": "<string>",
"roles": [
"<string>"
]
}
],
"registrations": [
{
"label": "<string>",
"value": "<string>"
}
],
"contactInfo": {
"emails": [
"jsmith@example.com"
],
"phoneNumbers": [
"<string>"
]
}
},
"industry": {
"naicsCode": "<string>",
"naicsCodeName": "<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
}
},
"matchSelection": {
"status": "auto_selected",
"selectedMatchId": "8f14e45f-ceea-467a-9f8e-2bd1f3a1c7d2",
"statusUrl": "/api/v1/search/550e8400-e29b-41d4-a716-446655440000",
"selectionUrl": "/api/v1/search/550e8400-e29b-41d4-a716-446655440000/selection"
}
}Authorizations
Body
- Option 1
- Option 2
- Option 3
Provide a name to search, or a businessId / businessExternalId to run the search against one of your stored business records. Any check flag omitted from the request falls back to your account's configured search settings (managed by an owner or admin in the dashboard); an explicit value in the request overrides that default.
Run the search against one of your existing business records. Its name and website are used when omitted from the request, and the full record is snapshotted so the search's comparison / discrepancy view diffs the registry results against it. Must reference a business owned by your tenant, otherwise the request fails with 404 NOT_FOUND.
Your own id for one of your stored business records (the external_id you set via CSV import or the businesses API). Resolves to that record exactly like businessId does — name/website are hydrated from it and the record is snapshotted for comparison. Unknown id → 404 NOT_FOUND. If both businessId and businessExternalId are supplied they must point at the same record, otherwise 400.
Enable match selection: resolve which registry result is the entity you searched for. The top-ranked result is auto-selected when it clears your account's auto-select rule, otherwise the search is flagged needs_review for you to resolve via POST /search/{id}/selection. If omitted, uses your account's configured search settings. The auto-select confidence and eligible statuses are account settings and cannot be set per request.
Response
Search result
Was this page helpful?