Retrieve search type configuration
1 min
GET
https://api.detected.app/api/v2/public/search/types/{type}/{countryCode}
Path Parameters
- typestringrequiredDescription
- countryCodestringrequiredDescription
Responses
200
- SearchTypeResponse
- companyEntityTypeConfig
- typestringDescription
- labelstringDescription
- search_enabledbooleanDescription
- search_fieldsobjectDescription
- address.country_codeSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- customer_referenceSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- nameSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.citySearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.stateSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- company_numberSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- domainSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- sole_traderEntityTypeConfig
- typestringDescription
- labelstringDescription
- search_enabledbooleanDescription
- search_fieldsobjectDescription
- address.country_codeSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- customer_referenceSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- nameSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.citySearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.stateSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- company_numberSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- domainSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- partnershipEntityTypeConfig
- typestringDescription
- labelstringDescription
- search_enabledbooleanDescription
- search_fieldsobjectDescription
- address.country_codeSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- customer_referenceSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- nameSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.citySearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.stateSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- company_numberSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- domainSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- charityEntityTypeConfig
- typestringDescription
- labelstringDescription
- search_enabledbooleanDescription
- search_fieldsobjectDescription
- address.country_codeSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- customer_referenceSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- nameSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.citySearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.stateSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- company_numberSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- domainSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- government_entityEntityTypeConfig
- typestringDescription
- labelstringDescription
- search_enabledbooleanDescription
- search_fieldsobjectDescription
- address.country_codeSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- customer_referenceSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- nameSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.citySearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.stateSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- company_numberSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- domainSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- syndicateEntityTypeConfig
- typestringDescription
- labelstringDescription
- search_enabledbooleanDescription
- search_fieldsobjectDescription
- address.country_codeSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- customer_referenceSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- nameSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.citySearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.stateSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- company_numberSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- domainSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- associationEntityTypeConfig
- typestringDescription
- labelstringDescription
- search_enabledbooleanDescription
- search_fieldsobjectDescription
- address.country_codeSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- customer_referenceSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- nameSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.citySearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.stateSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- company_numberSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- domainSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- trustEntityTypeConfig
- typestringDescription
- labelstringDescription
- search_enabledbooleanDescription
- search_fieldsobjectDescription
- address.country_codeSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- customer_referenceSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- nameSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.citySearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.stateSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- company_numberSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- domainSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- fundEntityTypeConfig
- typestringDescription
- labelstringDescription
- search_enabledbooleanDescription
- search_fieldsobjectDescription
- address.country_codeSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- customer_referenceSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- nameSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.citySearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- address.stateSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- company_numberSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
- domainSearchField
- is_requiredbooleanDescription
- labelstringDescription
- positionintegerDescription
Response Headers
- X-RateLimit-Limit
- X-RateLimit-Remaining
401
- object
- messagestringDescription
429
- object
- messagestringDescription
curl
curl --request GET \
--url https://api.detected.app/api/v2/public/search/types/{type}/{countryCode} \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.detected.app/api/v2/public/search/types/{type}/{countryCode}", 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/types/{type}/{countryCode}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.detected.app/api/v2/public/search/types/{type}/{countryCode}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// OK
{
"company": {
"type": "",
"label": "",
"search_enabled": false,
"search_fields": {
"address.country_code": {
"is_required": false,
"label": "",
"position": 0
},
"customer_reference": {
"is_required": false,
"label": "",
"position": 0
},
"name": {
"is_required": false,
"label": "",
"position": 0
},
"address.city": {
"is_required": false,
"label": "",
"position": 0
},
"address.state": {
"is_required": false,
"label": "",
"position": 0
},
"company_number": {
"is_required": false,
"label": "",
"position": 0
},
"domain": {
"is_required": false,
"label": "",
"position": 0
}
}
},
"sole_trader": {
"type": "",
"label": "",
"search_enabled": false,
"search_fields": {
"address.country_code": {
"is_required": false,
"label": "",
"position": 0
},
"customer_reference": {
"is_required": false,
"label": "",
"position": 0
},
"name": {
"is_required": false,
"label": "",
"position": 0
},
"address.city": {
"is_required": false,
"label": "",
"position": 0
},
"address.state": {
"is_required": false,
"label": "",
"position": 0
},
"company_number": {
"is_required": false,
"label": "",
"position": 0
},
"domain": {
"is_required": false,
"label": "",
"position": 0
}
}
},
"partnership": {
"type": "",
"label": "",
"search_enabled": false,
"search_fields": {
"address.country_code": {
"is_required": false,
"label": "",
"position": 0
},
"customer_reference": {
"is_required": false,
"label": "",
"position": 0
},
"name": {
"is_required": false,
"label": "",
"position": 0
},
"address.city": {
"is_required": false,
"label": "",
"position": 0
},
"address.state": {
"is_required": false,
"label": "",
"position": 0
},
"company_number": {
"is_required": false,
"label": "",
"position": 0
},
"domain": {
"is_required": false,
"label": "",
"position": 0
}
}
},
"charity": {
"type": "",
"label": "",
"search_enabled": false,
"search_fields": {
"address.country_code": {
"is_required": false,
"label": "",
"position": 0
},
"customer_reference": {
"is_required": false,
"label": "",
"position": 0
},
"name": {
"is_required": false,
"label": "",
"position": 0
},
"address.city": {
"is_required": false,
"label": "",
"position": 0
},
"address.state": {
"is_required": false,
"label": "",
"position": 0
},
"company_number": {
"is_required": false,
"label": "",
"position": 0
},
"domain": {
"is_required": false,
"label": "",
"position": 0
}
}
},
"government_entity": {
"type": "",
"label": "",
"search_enabled": false,
"search_fields": {
"address.country_code": {
"is_required": false,
"label": "",
"position": 0
},
"customer_reference": {
"is_required": false,
"label": "",
"position": 0
},
"name": {
"is_required": false,
"label": "",
"position": 0
},
"address.city": {
"is_required": false,
"label": "",
"position": 0
},
"address.state": {
"is_required": false,
"label": "",
"position": 0
},
"company_number": {
"is_required": false,
"label": "",
"position": 0
},
"domain": {
"is_required": false,
"label": "",
"position": 0
}
}
},
"syndicate": {
"type": "",
"label": "",
"search_enabled": false,
"search_fields": {
"address.country_code": {
"is_required": false,
"label": "",
"position": 0
},
"customer_reference": {
"is_required": false,
"label": "",
"position": 0
},
"name": {
"is_required": false,
"label": "",
"position": 0
},
"address.city": {
"is_required": false,
"label": "",
"position": 0
},
"address.state": {
"is_required": false,
"label": "",
"position": 0
},
"company_number": {
"is_required": false,
"label": "",
"position": 0
},
"domain": {
"is_required": false,
"label": "",
"position": 0
}
}
},
"association": {
"type": "",
"label": "",
"search_enabled": false,
"search_fields": {
"address.country_code": {
"is_required": false,
"label": "",
"position": 0
},
"customer_reference": {
"is_required": false,
"label": "",
"position": 0
},
"name": {
"is_required": false,
"label": "",
"position": 0
},
"address.city": {
"is_required": false,
"label": "",
"position": 0
},
"address.state": {
"is_required": false,
"label": "",
"position": 0
},
"company_number": {
"is_required": false,
"label": "",
"position": 0
},
"domain": {
"is_required": false,
"label": "",
"position": 0
}
}
},
"trust": {
"type": "",
"label": "",
"search_enabled": false,
"search_fields": {
"address.country_code": {
"is_required": false,
"label": "",
"position": 0
},
"customer_reference": {
"is_required": false,
"label": "",
"position": 0
},
"name": {
"is_required": false,
"label": "",
"position": 0
},
"address.city": {
"is_required": false,
"label": "",
"position": 0
},
"address.state": {
"is_required": false,
"label": "",
"position": 0
},
"company_number": {
"is_required": false,
"label": "",
"position": 0
},
"domain": {
"is_required": false,
"label": "",
"position": 0
}
}
},
"fund": {
"type": "",
"label": "",
"search_enabled": false,
"search_fields": {
"address.country_code": {
"is_required": false,
"label": "",
"position": 0
},
"customer_reference": {
"is_required": false,
"label": "",
"position": 0
},
"name": {
"is_required": false,
"label": "",
"position": 0
},
"address.city": {
"is_required": false,
"label": "",
"position": 0
},
"address.state": {
"is_required": false,
"label": "",
"position": 0
},
"company_number": {
"is_required": false,
"label": "",
"position": 0
},
"domain": {
"is_required": false,
"label": "",
"position": 0
}
}
}
}401
// Unauthorized. The access token is missing, invalid or has expired.
{
"message": ""
}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": ""
}