Retrieve a profile
1 min
GET
https://api.detected.app/api/v2/public/profiles/{uuid}
Path Parameters
- uuidstringrequiredDescription
Responses
200
- object
- dataProfileResource
- ProfileListResource
- idstringrequiredDescription
- entity_typeobjectDescription
- idintegerDescription
- 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
- labelstringDescription
- customer_referencestringrequiredDescription
- company_namestringDescription
- riskobjectDescription
- idstringDescription
- labelstringDescription
- categorystringDescription
- teamobjectDescription
- idnumberDescription
- labelstringDescription
- configurationobjectDescription
- idnumberDescription
- namestringDescription
- brandobjectDescription
- idstringDescription
- namestringDescription
- slugstringDescription
- review_statusstring<Processed | Needs Review | Additional Info Required | Approved | Declined | Archived>requiredDescriptionAllowedProcessedNeeds ReviewAdditional Info RequiredApprovedDeclinedArchived
- assigneeobjectDescription
- idstringDescription
- namestringDescription
- review_atstringDescription
- updated_atstringrequiredDescription
- created_atstringrequiredDescription
- object
- idstringDescription
- entity_typeobjectDescription
- idintegerDescription
- 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
- labelstringDescription
- customer_referencestringDescription
- riskobjectDescription
- idstringDescription
- labelstringDescription
- categorystringDescription
- teamobjectDescription
- idnumberDescription
- labelstringDescription
- configurationobjectDescription
- idnumberDescription
- namestringDescription
- review_statusstring<Processed | Needs Review | Additional Info Required | Approved | Declined | Archived>DescriptionAllowedProcessedNeeds ReviewAdditional Info RequiredApprovedDeclinedArchived
- onboarding_statusesobject[]Description
- titlestringDescription
- statusstring<pending | completed | in-progress | in-complete>DescriptionAllowedpendingcompletedin-progressin-complete
- assigneeobjectDescription
- idstringDescription
- namestringDescription
- review_atstringDescription
- companyobjectDescription
- profileobjectDescription
- ProfileCompanyNamestringDescription
- ProfileCompanyStatusActivebooleanDescription
- ProfileCompanyRegisteredCountrystringDescription
- ProfileCompanyReferencestringDescription
- ProfileCompanyStatusProviderstringDescription
- ProfileCompanyLegalFormstringDescription
- ProfileCompanyRegistrationDatestringDescription
- ProfileCompanyDataSourcestring<bolddata | creditsafe | enigma | globaldatabase | manual | nuna | opencorporates | orbis | soletrader>DescriptionAllowedbolddatacreditsafeenigmaglobaldatabasemanualnunaopencorporatesorbissoletrader
- ProfileCompanyVatNumberstringDescription
- ProfileCompanyHasVatNumberbooleanDescription
- ProfileCompanyNumOfEmployeesnumberDescription
- ProfileCompanyPhoneNumberstringDescription
- ProfileCompanyEmailstringDescription
- ProfileCompanyIsExporterbooleanDescription
- ProfileCompanyIsImporterbooleanDescription
- ProfileCompanyRegisteredAddressstringDescription
- ProfileCompanyRegisteredAddress1stringDescription
- ProfileCompanyRegisteredAddress2stringDescription
- ProfileCompanyRegisteredAddressCitystringDescription
- ProfileCompanyRegisteredAddressProvincestringDescription
- ProfileCompanyRegisteredAddressPostCodestringDescription
- ProfileCompanyRegisteredAddressCountryCodestringDescription
- ProfileCompanyCapitalnumberDescription
- ProfileCompanyCurrencystringDescription
- ProfileCompanyCurrentAssetsnumberDescription
- ProfileCompanyEBITDAstringDescription
- ProfileCompanyGrossProfitnumberDescription
- ProfileCompanyLastAccountsDatestringDescription
- ProfileCompanyLongTermDebtnumberDescription
- ProfileCompanyTotalAssetsnumberDescription
- ProfileCompanyTurnovernumberDescription
- ProfileCompanyIndustryClassificationsobject[]Description
- ProfileCompanyIndustryCodesobject[]Description
- ProfileCompanyIndustryDescriptionsobject[]Description
- ProfileCompanyCreditProbabilityOfDefaultnumberDescription
- ProfileCompanyCreditRatingDatestringDescription
- ProfileCompanyCreditContractLimitnumberDescription
- ProfileCompanyCreditRatingstringDescription
- ProfileCompanyCreditRatingDescriptionstringDescription
- ProfileCompanyCreditLimitnumberDescription
- ProfileCompanyCreditProviderMaxnumberDescription
- ProfileCompanyCreditProviderMinnumberDescription
- ProfileCompanyCreditProviderValuenumberDescription
- ProfileCompanyCreditProviderDescriptionstringDescription
- ProfileCompanyCreditPreviousRatingstringDescription
- ProfileCompanyCreditPreviousRatingDescriptionstringDescription
- ProfileCompanyCreditPreviousLimitnumberDescription
- ProfileCompanyCreditPreviousProviderMaxnumberDescription
- ProfileCompanyCreditPreviousProviderMinnumberDescription
- ProfileCompanyCreditPreviousProviderValuenumberDescription
- ProfileCompanyCreditPreviousProviderDescriptionstringDescription
- directorobjectDescription
- dataobject[]Description
- director_idstringDescription
- job_titlestringDescription
- genderstringDescription
- appointment_datestringDescription
- resignation_datestringDescription
- dobstringDescription
- addressstringDescription
- countrystringDescription
- nationalitystringDescription
- company_numberstringDescription
- screeningsobject[]Description
- is_activebooleanDescription
- suffixstringDescription
- salutationstringDescription
- shareholderstringDescription
- position_typestringDescription
- responsibilitystringDescription
- typestringDescription
- titlestringDescription
- full_namestringDescription
- first_namestringDescription
- last_namestringDescription
- middle_namestringDescription
- summaryobjectDescription
- total_countnumberDescription
- active_countnumberDescription
- inactive_countnumberDescription
- share_structureobjectDescription
- dataobjectDescription
- share_holdersobject[]Description
- idstringDescription
- namestringDescription
- currencystringDescription
- share_typestringDescription
- share_typesobject[]Description
- currencystringDescription
- share_typestringDescription
- value_of_sharesnumberDescription
- value_per_sharenumberDescription
- number_of_sharesnumberDescription
- company_referencestringDescription
- value_of_sharesnumberDescription
- number_of_sharesnumberDescription
- shareholder_typestringDescription
- percentage_shares_heldnumberDescription
- addressnumberDescription
- issued_shares_totalnumberDescription
- issued_shares_capital_valuenumberDescription
- structureobjectDescription
- ultimate_parentobjectDescription
- provider_idstringDescription
- namestringDescription
- country_codestringDescription
- typestringDescription
- statusstringDescription
- company_referencestringDescription
- addressstringDescription
- immediate_parentobjectDescription
- provider_idstringDescription
- namestringDescription
- country_codestringDescription
- typestringDescription
- statusstringDescription
- company_referencestringDescription
- addressstringDescription
- financialsobjectDescription
- dataobject[]Description
- ratiosobjectDescription
- gearingnumberDescription
- debtor_daysnumberDescription
- creditor_daysnumberDescription
- current_rationumberDescription
- total_debt_rationumberDescription
- current_debt_rationumberDescription
- equity_in_percentagenumberDescription
- stock_turnover_rationumberDescription
- pre_tax_profit_marginnumberDescription
- return_on_capital_employednumberDescription
- liquidity_ratio_or_acid_testnumberDescription
- sales_or_net_working_capitalnumberDescription
- return_on_net_assets_employednumberDescription
- return_on_total_assets_employednumberDescription
- generalobjectDescription
- typestringDescription
- currencystringDescription
- year_end_datestringDescription
- number_of_weeksnumberDescription
- consolidated_accountsbooleanDescription
- balance_sheetobjectDescription
- cashnumberDescription
- total_assetsnumberDescription
- other_reservesnumberDescription
- trade_payablesnumberDescription
- bank_liabilitiesnumberDescription
- revenue_reservesnumberDescription
- total_inventoriesnumberDescription
- total_liabilitiesnumberDescription
- total_receivablesnumberDescription
- trade_receivablesnumberDescription
- total_fixed_assetsnumberDescription
- other_current_assetsnumberDescription
- total_current_assetsnumberDescription
- total_tangible_assetsnumberDescription
- other_loans_or_financenumberDescription
- called_up_share_capitalnumberDescription
- total_intangible_assetsnumberDescription
- total_other_fixed_assetsnumberDescription
- miscellaneous_liabilitiesnumberDescription
- miscellaneous_receivablesnumberDescription
- total_current_liabilitiesnumberDescription
- total_shareholders_equitynumberDescription
- total_long_term_liabilitiesnumberDescription
- bank_liabilities_due_after1yearnumberDescription
- other_loans_or_finance_due_after1yearnumberDescription
- miscellaneous_liabilities_due_after1yearnumberDescription
- profit_and_lossobjectDescription
- taxnumberDescription
- revenuenumberDescription
- dividendsnumberDescription
- amortisationnumberDescription
- depreciationnumberDescription
- pension_costsnumberDescription
- operating_costsnumberDescription
- retained_profitnumberDescription
- operating_profitnumberDescription
- profit_after_taxnumberDescription
- profit_before_taxnumberDescription
- financial_expensesnumberDescription
- minority_interestsnumberDescription
- wages_and_salariesnumberDescription
- other_appropriationsnumberDescription
- other_financialsobjectDescription
- net_worthnumberDescription
- working_capitalnumberDescription
- contingent_liabilitiesstringDescription
- pscobject[]Description
- nature_of_controlobject[]Description
- is_activebooleanDescription
- namestringDescription
- kindstringDescription
- entityTypestringDescription
- addressstringDescription
- notified_onstringDescription
- ceased_onstringDescription
- dob_daynumberDescription
- dob_monthnumberDescription
- dob_yearnumberDescription
- domainobject[]Description
- domainstringDescription
- online_presenceobject[]Description
- founding_yearstringDescription
- phone_numberstringDescription
- industrystringDescription
- tagsstring[]Description
- addressstringDescription
- screeningsobject[]Description
- updated_atstringDescription
- created_atstringDescription
Response Headers
- X-RateLimit-Limit
- X-RateLimit-Remaining
- x-ratelimit-reset
- retry-after
401
- object
- messagestringDescription
404
- object
- messagestringDescription
429
- object
- messagestringDescription
curl
curl --request GET \
--url https://api.detected.app/api/v2/public/profiles/{uuid} \
--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/profiles/{uuid}", 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/profiles/{uuid}")
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/profiles/{uuid}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// OK
{
"data": {}
}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": ""
}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": ""
}