Search for an entity
1 min
POST
https://api.detected.app/api/v2/public/search
Body Parameters
- bodySearchRequest
- typestring<company | sole_trader | partnership | charity | government_entity | incorporated_syndicate | company_syndicate | syndicate | association | trust | fund | club | individual | joint_individual>requiredDescriptionAllowedcompanysole_traderpartnershipcharitygovernment_entityincorporated_syndicatecompany_syndicatesyndicateassociationtrustfundclubindividualjoint_individual
- namestringrequiredDescription
- vat_numberstringDescription
- company_referencestringDescription
- company_numberstringDescription
- addressobjectrequiredDescription
- line_1stringDescription
- line_2stringDescription
- country_codestringrequiredDescription
- townstringDescription
- citystringrequiredDescription
- post_codestringDescription
- provincestringDescription
- statestringDescription
Responses
200
- SearchResponse
- dataobject[]Description
- typestring<company | sole_trader | partnership | charity | government_entity | incorporated_syndicate | company_syndicate | syndicate | association | trust | fund | club | individual | joint_individual>DescriptionAllowedcompanysole_traderpartnershipcharitygovernment_entityincorporated_syndicatecompany_syndicatesyndicateassociationtrustfundclubindividualjoint_individual
- namestringDescription
- company_referencestringDescription
- providerstringDescription
- provider_referencestringDescription
- jurisdiction_codestringDescription
- company_typestringDescription
- current_statusstringDescription
- addressstringDescription
- vat_numberstringDescription
- province_codestringDescription
- post_codestringDescription
- citystringDescription
- confidenceintegerDescription
- response_idintegerDescription
- statusstring<EMPTY | PARTIAL | MATCH>DescriptionAllowedEMPTYPARTIALMATCH
- lookup_idintegerDescription
Response Headers
- X-RateLimit-Limit
- X-RateLimit-Remaining
- x-ratelimit-reset
- retry-after
401
- object
- messagestringDescription
404
- object
- messagestringDescription
422
- object
- messagestringDescription
- example_fieldstring[]Description
429
- object
- messagestringDescription
curl
curl --request POST \
--url https://api.detected.app/api/v2/public/search \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"type": "",
"name": "",
"address": {
"country_code": "",
"city": ""
}
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"type": "",
"name": "",
"address": {
"country_code": "",
"city": ""
}
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.detected.app/api/v2/public/search", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.detected.app/api/v2/public/search")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"type": "",
"name": "",
"address": {
"country_code": "",
"city": ""
}
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.detected.app/api/v2/public/search"
payload = json.dumps({
"type": "",
"name": "",
"address": {
"country_code": "",
"city": ""
}
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// OK
{
"data": [
{
"type": "",
"name": "",
"company_reference": "",
"provider": "",
"provider_reference": "",
"jurisdiction_code": "",
"company_type": "",
"current_status": "",
"address": "",
"vat_number": "",
"province_code": "",
"post_code": "",
"city": "",
"confidence": 0,
"response_id": 0
}
],
"status": "",
"lookup_id": 0
}401
// Unauthorized. The access token is missing, invalid or has expired.
{
"message": ""
}404
// Not Found. The requested resource does not exist, or is not available to your account.
{
"message": ""
}422
// Unprocessable Content. The request was understood but failed validation. The response lists the fields that failed and why.
{
"message": "",
"example_field": [
""
]
}429
// Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the Retry-After header before trying again.
{
"message": ""
}