> For the complete documentation index, see [llms.txt](https://detected.gitbook.io/detected-api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://detected.gitbook.io/detected-api-docs/api-reference/profiles.md).

# Profiles

A profile is the container for all the information the platform holds about an entity, including its risk analysis, representative details and verification results. Think of a profile as a 'case' to be processed.

## List profiles

> Returns all the profiles for your account. Use the query parameters to filter the results.

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"tags":[{"name":"Profiles","description":"A profile is the container for all the information the platform holds about an entity, including its risk analysis, representative details and verification results. Think of a profile as a 'case' to be processed."}],"servers":[{"url":"https://api.detected.app/api/v2/public","description":"Production"}],"security":[{"AccessToken":[]}],"components":{"securitySchemes":{"AccessToken":{"type":"http","description":"The API uses OAuth 2.0. Request an access token with **Create an access token** (`POST /oauth/token`), sending the client ID and client secret of your integration client, and your account slug. Send the access token in the `Authorization` header of every request, in the format `Authorization: Bearer <access_token>`. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.","bearerFormat":"OAuth 2.0 access token","scheme":"bearer"}},"parameters":{"order_by":{"name":"order_by","in":"query","description":"Direction to sort the results in: `asc` for ascending or `desc` for descending. Use it together with `sort_by`; it has no effect if `sort_by` is omitted. The default is `asc`.","schema":{"type":"string","enum":["desc","asc"]}},"page":{"name":"page","in":"query","description":"Page number of the results to return, starting from 1. The number of items per page is returned in `meta.per_page`.","schema":{"type":"integer","minimum":1}}},"headers":{"X-RateLimit-Limit":{"description":"Maximum number of requests allowed in the rate limit window.","schema":{"type":"number","nullable":false}},"X-RateLimit-Remaining":{"description":"Number of requests remaining in the current rate limit window.","schema":{"type":"number","nullable":false}},"Retry-After":{"description":"Number of seconds to wait before making another request. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}},"X-RateLimit-Reset":{"description":"Unix timestamp (in seconds) at which the rate limit resets. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}}},"schemas":{"ProfileListResource":{"title":"Profile List Resource","required":["id","customer_reference","review_status","updated_at","created_at"],"properties":{"id":{"description":"Profile UUID.","type":"string","nullable":false},"entity_type":{"description":"Entity type information.","properties":{"id":{"description":"Entity type ID.","type":"integer","nullable":true},"type":{"description":"Entity type value.","type":"string","enum":["company","sole_trader","partnership","charity","government_entity","incorporated_syndicate","company_syndicate","syndicate","association","trust","fund","club","individual","joint_individual"],"nullable":false},"label":{"description":"Entity type label.","type":"string","nullable":false}},"type":"object","nullable":false},"customer_reference":{"description":"Your unique reference for the profile.","type":"string","nullable":false},"company_name":{"description":"Name of the company.","type":"string","nullable":false},"risk":{"description":"Risk category assigned to the profile, or `null` if there is none.","properties":{"id":{"description":"Risk category ID.","type":"string","nullable":false},"label":{"description":"Label of the risk category.","type":"string","nullable":true},"category":{"description":"Category of the risk.","type":"string","nullable":true}},"type":"object","nullable":true},"team":{"description":"Team the profile is assigned to, or `null` if there is none.","properties":{"id":{"description":"Team ID.","type":"integer","nullable":false},"label":{"description":"Label of the team.","type":"string","nullable":true}},"type":"object","nullable":true},"configuration":{"description":"Configuration assigned to the profile, or `null` if there is none.","properties":{"id":{"description":"Configuration ID.","type":"integer","nullable":false},"name":{"description":"Name of the configuration.","type":"string","nullable":true}},"type":"object","nullable":true},"brand":{"description":"Brand assigned to the profile, or `null` if there is none.","properties":{"id":{"description":"Brand UUID.","type":"string","nullable":false},"name":{"description":"Brand name.","type":"string","nullable":false},"slug":{"description":"Brand slug.","type":"string","nullable":false}},"type":"object","nullable":true},"review_status":{"description":"Review status of the profile.","type":"string","enum":["Processed","Incomplete","Needs Review","Additional Info Required","Approved","Declined","Archived"],"nullable":false},"assignee":{"description":"Case management user the profile is assigned to, or `null` if there is none.","properties":{"id":{"description":"ID of the case management user.","type":"string","nullable":false},"name":{"description":"Name of the case management user.","type":"string","nullable":true}},"type":"object","nullable":true},"review_at":{"description":"Date the profile's current review period started. The next review falls a configured review period after this date. `null` if no review period has started.","type":"string","nullable":true},"updated_at":{"description":"Date and time the profile was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the profile was created.","type":"string","nullable":false}},"type":"object"},"LinksResource":{"title":"Links Resource","properties":{"first":{"description":"URL of the first page of results.","type":"string","nullable":false},"last":{"description":"URL of the last page of results.","type":"string","nullable":false},"prev":{"description":"URL of the previous page of results, or null if there is none.","type":"string","nullable":true},"next":{"description":"URL of the next page of results, or null if there is none.","type":"string","nullable":true}},"type":"object"},"MetaResource":{"title":"Meta Resource","properties":{"current_page":{"description":"Number of the current page.","type":"integer","nullable":false},"from":{"description":"Position of the first item on this page, counted across all pages, or `null` if there are no results.","type":"integer","nullable":true},"last_page":{"description":"Number of the last page.","type":"integer","nullable":false},"links":{"description":"Pagination links, including links to the previous and next pages.","type":"array","items":{"properties":{"url":{"description":"URL of the page, or `null` if there is no such page.","type":"string","nullable":true},"label":{"description":"Text to display for the link, for example a page number or \"Previous\".","type":"string","nullable":false},"page":{"description":"Number of the page the link points to, or `null` if there is no such page.","type":"integer","nullable":true},"active":{"description":"Whether this link is for the current page.","type":"boolean","nullable":false}},"type":"object"},"nullable":false},"path":{"description":"Base URL of the endpoint, without query parameters.","type":"string","nullable":false},"per_page":{"description":"Number of items per page.","type":"integer","nullable":false},"to":{"description":"Position of the last item on this page, counted across all pages, or `null` if there are no results.","type":"integer","nullable":true},"total":{"description":"Total number of items across all pages.","type":"integer","nullable":false}},"type":"object"}},"responses":{"401":{"description":"Unauthorized. The access token is missing, invalid or has expired.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}},"422":{"description":"Unprocessable Content. The request was understood but failed validation. `errors` lists each field that failed and why.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A human-readable description of the first error.","type":"string"},"errors":{"description":"Validation errors, keyed by the name of the field that failed. Each field has a list of messages.","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}},"429":{"description":"Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the `Retry-After` header before trying again.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}}}},"paths":{"/profiles":{"get":{"tags":["Profiles"],"summary":"List profiles","description":"Returns all the profiles for your account. Use the query parameters to filter the results.","operationId":"5b1ecce433c6ba5699ce22c2218b9dba","parameters":[{"$ref":"#/components/parameters/order_by"},{"name":"sort_by","in":"query","description":"The field to sort the results by. Use it together with `order_by` to choose the direction; if `order_by` is omitted, results are sorted in ascending order (`asc`). If `sort_by` is omitted, results are returned in no guaranteed order.\n\nSupported fields:\n- `id`\n- `configuration_id`\n- `review_status`\n- `created_at`\n- `updated_at`\n","schema":{"type":"string"}},{"$ref":"#/components/parameters/page"},{"name":"id","in":"query","description":"Filter by profile UUID. If a match is found, only that profile is returned.","schema":{"type":"string","format":"uuid"}},{"name":"entity_type","in":"query","description":"Filter by entity type.","schema":{"type":"string","enum":["company","sole_trader","partnership","charity","government_entity","incorporated_syndicate","company_syndicate","syndicate","association","trust","fund","club","individual","joint_individual"]}},{"name":"review_status","in":"query","description":"Filter by review status.","schema":{"type":"string","enum":["Processed","Incomplete","Needs Review","Additional Info Required","Approved","Declined","Archived"]}},{"name":"team_id","in":"query","description":"Filter by the ID of the team the profile is assigned to.","schema":{"type":"integer"}},{"name":"assignee_id","in":"query","description":"Filter by the ID of the case management user the profile is assigned to.","schema":{"type":"string"}},{"name":"risk_id","in":"query","description":"Filter by the ID of the risk category assigned to the profile.","schema":{"type":"string","format":"uuid"}},{"name":"customer_reference","in":"query","description":"Filter by customer reference.","schema":{"type":"string"}},{"name":"configuration_id","in":"query","description":"Filter by the ID of the configuration assigned to the profile.","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"properties":{"data":{"description":"List of profiles","type":"array","items":{"$ref":"#/components/schemas/ProfileListResource"}},"links":{"$ref":"#/components/schemas/LinksResource"},"meta":{"$ref":"#/components/schemas/MetaResource"}},"type":"object"}}}},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"}}}}}}
```

## Retrieve a profile

> Returns a single profile, including core details, data retrieved from the data sources, screenings and more.\
> \
> Company data comes from a range of data providers. Not all of it is normalised, so the fields returned vary by provider and may be \`null\` or empty.

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"tags":[{"name":"Profiles","description":"A profile is the container for all the information the platform holds about an entity, including its risk analysis, representative details and verification results. Think of a profile as a 'case' to be processed."}],"servers":[{"url":"https://api.detected.app/api/v2/public","description":"Production"}],"security":[{"AccessToken":[]}],"components":{"securitySchemes":{"AccessToken":{"type":"http","description":"The API uses OAuth 2.0. Request an access token with **Create an access token** (`POST /oauth/token`), sending the client ID and client secret of your integration client, and your account slug. Send the access token in the `Authorization` header of every request, in the format `Authorization: Bearer <access_token>`. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.","bearerFormat":"OAuth 2.0 access token","scheme":"bearer"}},"parameters":{"profileUuid":{"name":"uuid","in":"path","description":"UUID of the profile.","required":true,"schema":{"type":"string","format":"uuid","nullable":false}}},"headers":{"X-RateLimit-Limit":{"description":"Maximum number of requests allowed in the rate limit window.","schema":{"type":"number","nullable":false}},"X-RateLimit-Remaining":{"description":"Number of requests remaining in the current rate limit window.","schema":{"type":"number","nullable":false}},"Retry-After":{"description":"Number of seconds to wait before making another request. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}},"X-RateLimit-Reset":{"description":"Unix timestamp (in seconds) at which the rate limit resets. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}}},"schemas":{"ProfileResource":{"title":"Profile Resource","required":["id","customer_reference","review_status","updated_at","created_at"],"type":"object","allOf":[{"$ref":"#/components/schemas/ProfileListResource"},{"properties":{"id":{"description":"Profile UUID.","type":"string","nullable":false},"entity_type":{"description":"Entity type information.","properties":{"id":{"description":"Entity type ID.","type":"integer","nullable":true},"type":{"description":"Entity type value.","type":"string","enum":["company","sole_trader","partnership","charity","government_entity","incorporated_syndicate","company_syndicate","syndicate","association","trust","fund","club","individual","joint_individual"],"nullable":false},"label":{"description":"Entity type label.","type":"string","nullable":false}},"type":"object","nullable":false},"customer_reference":{"description":"Your unique reference for the profile.","type":"string","nullable":false},"risk":{"description":"Risk category assigned to the profile, or `null` if there is none.","properties":{"id":{"description":"Risk category ID.","type":"string","nullable":false},"label":{"description":"Label of the risk category.","type":"string","nullable":true},"category":{"description":"Category of the risk.","type":"string","nullable":true}},"type":"object","nullable":true},"team":{"description":"Team the profile is assigned to, or `null` if there is none.","properties":{"id":{"description":"Team ID.","type":"integer","nullable":false},"label":{"description":"Label of the team.","type":"string","nullable":true}},"type":"object","nullable":true},"configuration":{"description":"Configuration assigned to the profile, or `null` if there is none.","properties":{"id":{"description":"Configuration ID.","type":"integer","nullable":false},"name":{"description":"Name of the configuration.","type":"string","nullable":true}},"type":"object","nullable":true},"review_status":{"description":"Review status of the profile.","type":"string","enum":["Processed","Incomplete","Needs Review","Additional Info Required","Approved","Declined","Archived"],"nullable":false},"onboarding_statuses":{"description":"Portal onboarding statuses.","type":"array","items":{"properties":{"title":{"description":"Onboarding step name.","type":"string","nullable":false},"status":{"description":"Status of onboarding step.","type":"string","enum":["pending","completed","in-progress","in-complete"],"nullable":false}},"type":"object"},"nullable":true},"assignee":{"description":"Case management user the profile is assigned to, or `null` if there is none.","properties":{"id":{"description":"ID of the case management user.","type":"string","nullable":false},"name":{"description":"Name of the case management user.","type":"string","nullable":true}},"type":"object","nullable":true},"review_at":{"description":"Date the profile's current review period started. The next review falls a configured review period after this date. `null` if no review period has started.","type":"string","nullable":true},"company":{"description":"Company data from the data providers. See the notes on **Retrieve a profile** (`GET /profiles/{uuid}`).","properties":{"profile":{"description":"Core details of the company. The fields returned vary by data provider, and providers may return fields not listed here.","properties":{"ProfileCompanyCapital":{"description":"Capital.","type":"number","nullable":true},"ProfileCompanyCreditContractLimit":{"description":"Credit contract limit.","type":"number","nullable":true},"ProfileCompanyCreditLimit":{"description":"Credit limit.","type":"number","nullable":true},"ProfileCompanyCreditPreviousLimit":{"description":"Previous credit limit.","type":"number","nullable":true},"ProfileCompanyCreditPreviousProviderDescription":{"description":"Previous credit provider description.","type":"string","nullable":true},"ProfileCompanyCreditPreviousProviderMax":{"description":"Previous credit provider maximum.","type":"number","nullable":true},"ProfileCompanyCreditPreviousProviderMin":{"description":"Previous credit provider minimum.","type":"number","nullable":true},"ProfileCompanyCreditPreviousProviderValue":{"description":"Previous credit provider value.","type":"number","nullable":true},"ProfileCompanyCreditPreviousRating":{"description":"Previous credit rating.","type":"string","nullable":true},"ProfileCompanyCreditPreviousRatingDescription":{"description":"Previous credit rating description.","type":"string","nullable":true},"ProfileCompanyCreditProbabilityOfDefault":{"description":"Credit probability of default.","type":"number","nullable":true},"ProfileCompanyCreditProviderDescription":{"description":"Credit provider description.","type":"string","nullable":true},"ProfileCompanyCreditProviderMax":{"description":"Credit provider maximum.","type":"number","nullable":true},"ProfileCompanyCreditProviderMin":{"description":"Credit provider minimum.","type":"number","nullable":true},"ProfileCompanyCreditProviderValue":{"description":"Credit provider value.","type":"number","nullable":true},"ProfileCompanyCreditRating":{"description":"Credit rating.","type":"string","nullable":true},"ProfileCompanyCreditRatingDate":{"description":"Credit rating date.","type":"string","nullable":true},"ProfileCompanyCreditRatingDescription":{"description":"Credit rating description.","type":"string","nullable":true},"ProfileCompanyCreditRatingHistory":{"description":"Credit rating history.","type":"array","items":{}},"ProfileCompanyCurrency":{"description":"Currency of the financial figures.","type":"string","nullable":true},"ProfileCompanyCurrentAssets":{"description":"Current assets.","type":"number","nullable":true},"ProfileCompanyDataSource":{"description":"Data provider the company data came from, for example `opencorporates`, `markaaz_v2`, `creditsafe` or `manual`.","type":"string","nullable":true},"ProfileCompanyEBITDA":{"description":"EBITDA.","type":"string","nullable":true},"ProfileCompanyEmail":{"description":"Company email address.","type":"string","nullable":true},"ProfileCompanyGrossProfit":{"description":"Gross profit.","type":"number","nullable":true},"ProfileCompanyHasVatNumber":{"description":"Whether the company has a VAT number.","type":"boolean","nullable":true},"ProfileCompanyIndustryClassifications":{"description":"Industry classifications.","type":"array","items":{"type":"string"},"nullable":true},"ProfileCompanyIndustryCodes":{"description":"Industry codes.","type":"array","items":{"type":"string"},"nullable":true},"ProfileCompanyIndustryDescriptions":{"description":"Industry descriptions.","type":"array","items":{"type":"string"},"nullable":true},"ProfileCompanyIsExporter":{"description":"Whether the company is an exporter.","type":"boolean","nullable":true},"ProfileCompanyIsImporter":{"description":"Whether the company is an importer.","type":"boolean","nullable":true},"ProfileCompanyLastAccountsDate":{"description":"Last accounts date.","type":"string","nullable":true},"ProfileCompanyLegalForm":{"description":"Legal form of the company.","type":"string","nullable":true},"ProfileCompanyLeiNumber":{"description":"Legal Entity Identifier (LEI), or `null` if not available."},"ProfileCompanyLongTermDebt":{"description":"Long term debt.","type":"number","nullable":true},"ProfileCompanyName":{"description":"Company name.","type":"string","nullable":true},"ProfileCompanyNumOfEmployees":{"description":"Number of employees.","type":"integer","nullable":true},"ProfileCompanyOriginalLanguageNames":{"description":"Names in the original language, or `null` if not available."},"ProfileCompanyOtherAddresses":{"description":"Other addresses.","type":"array","items":{},"nullable":true},"ProfileCompanyOtherLanguageNames":{"description":"Names in other languages, or `null` if not available."},"ProfileCompanyOtherRegistrationNumbers":{"description":"Other registration numbers.","type":"array","items":{}},"ProfileCompanyPhoneNumber":{"description":"Company phone number.","type":"string","nullable":true},"ProfileCompanyPreviousNames":{"description":"Previous names, or `null` if not available."},"ProfileCompanyProviderReference":{"description":"Reference for the company at the data provider, or `null` if not available."},"ProfileCompanyReference":{"description":"Company registration number.","type":"string","nullable":true},"ProfileCompanyRegisteredAddress":{"description":"Registered address.","type":"string","nullable":true},"ProfileCompanyRegisteredAddress1":{"description":"Registered address, line 1.","type":"string","nullable":true},"ProfileCompanyRegisteredAddress2":{"description":"Registered address, line 2.","type":"string","nullable":true},"ProfileCompanyRegisteredAddressCity":{"description":"Registered address city.","type":"string","nullable":true},"ProfileCompanyRegisteredAddressCountryCode":{"description":"Registered address country code.","type":"string","nullable":true},"ProfileCompanyRegisteredAddressPostCode":{"description":"Registered address postcode.","type":"string","nullable":true},"ProfileCompanyRegisteredAddressProvince":{"description":"Registered address province.","type":"string","nullable":true},"ProfileCompanyRegisteredCountry":{"description":"Country the company is registered in.","type":"string","nullable":true},"ProfileCompanyRegistrationDate":{"description":"Registration date.","type":"string","nullable":true},"ProfileCompanyRegistrationYear":{"description":"Year of registration.","type":"string","nullable":true},"ProfileCompanyStatusActive":{"description":"Whether the company is active.","type":"boolean","nullable":true},"ProfileCompanyStatusProvider":{"description":"Company status, as reported by the provider.","type":"string","nullable":true},"ProfileCompanyTotalAssets":{"description":"Total assets.","type":"number","nullable":true},"ProfileCompanyTradingNames":{"description":"Trading names.","type":"string","nullable":true},"ProfileCompanyTurnover":{"description":"Turnover.","type":"number","nullable":true},"ProfileCompanyVatNumber":{"description":"VAT number.","type":"string","nullable":true}},"type":"object","nullable":true,"additionalProperties":true},"directors":{"description":"Directors from the data source: `data` lists them and `summary` counts them. An empty list (`[]`) when there are none.","properties":{"data":{"description":"Data.","type":"array","items":{"properties":{"director_id":{"description":"Director ID.","type":"string","nullable":true},"job_title":{"description":"Job title.","type":"string","nullable":true},"gender":{"description":"Gender.","type":"string","nullable":true},"appointment_date":{"description":"Appointment date.","type":"string","nullable":true},"resignation_date":{"description":"Resignation date.","type":"string","nullable":true},"dob":{"description":"Date of birth.","type":"string","nullable":true},"address":{"description":"Address.","type":"string","nullable":true},"country":{"description":"Country.","type":"string","nullable":true},"nationality":{"description":"Nationality.","type":"string","nullable":true},"company_number":{"description":"Company number.","type":"string","nullable":true},"screenings":{"description":"Screenings.","type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"is_active":{"description":"Whether this entry is active.","type":"boolean","nullable":true},"suffix":{"description":"Suffix.","type":"string","nullable":true},"salutation":{"description":"Salutation.","type":"string","nullable":true},"shareholder":{"description":"Shareholder.","type":"string","nullable":true},"position_type":{"description":"Position type.","type":"string","nullable":true},"responsibility":{"description":"Responsibility.","type":"string","nullable":true},"type":{"description":"Type.","type":"string","nullable":true},"title":{"description":"Title.","type":"string","nullable":true},"full_name":{"description":"Full name.","type":"string","nullable":true},"first_name":{"description":"First name.","type":"string","nullable":true},"last_name":{"description":"Last name.","type":"string","nullable":true},"middle_name":{"description":"Middle name.","type":"string","nullable":true}},"type":"object"},"nullable":false},"summary":{"description":"Counts of the directors.","type":"object","properties":{"total_count":{"type":"integer"},"active_count":{"type":"integer"},"inactive_count":{"type":"integer"}}}}},"share_structure":{"description":"Details of the share structure including shareholders. Provider data, or an empty list (`[]`) when there is none.","properties":{"data":{"description":"Data.","properties":{"share_holders":{"description":"List of shareholders.","type":"array","items":{"properties":{"id":{"description":"ID.","type":"string","nullable":true},"name":{"description":"Name.","type":"string","nullable":true},"currency":{"description":"Currency.","type":"string","nullable":true},"share_type":{"description":"Share type.","type":"string","nullable":true},"share_types":{"description":"Share types.","type":"array","items":{"properties":{"currency":{"description":"Currency.","type":"string","nullable":true},"share_type":{"description":"Share type.","type":"string","nullable":true},"value_of_shares":{"description":"Value of shares.","type":"number","nullable":true},"value_per_share":{"description":"Value per share.","type":"number","nullable":true},"number_of_shares":{"description":"Number of shares.","type":"number","nullable":true},"company_reference":{"description":"Company reference.","type":"string","nullable":true}},"type":"object"},"nullable":true},"value_of_shares":{"description":"Value of shares.","type":"number","nullable":true},"number_of_shares":{"description":"Number of shares.","type":"number","nullable":true},"shareholder_type":{"description":"Shareholder type.","type":"string","nullable":true},"percentage_shares_held":{"description":"Percentage shares held.","type":"number","nullable":true},"address":{"description":"Address.","type":"number","nullable":true}},"type":"object"}}},"type":"object"},"issued_shares_total":{"description":"Issued shares total.","type":"number","nullable":true},"issued_shares_capital_value":{"description":"Issued shares capital value.","type":"number","nullable":true}}},"structure":{"description":"Structure of company. Provider data, or an empty list (`[]`) when there is none.","properties":{"ultimate_parent":{"description":"Ultimate parent.","properties":{"provider_id":{"description":"Provider ID.","type":"string","nullable":true},"name":{"description":"Name.","type":"string","nullable":true},"country_code":{"description":"Country code.","type":"string","nullable":true},"type":{"description":"Type.","type":"string","nullable":true},"status":{"description":"Status.","type":"string","nullable":true},"company_reference":{"description":"Company reference.","type":"string","nullable":true},"address":{"description":"Address.","type":"string","nullable":true}},"type":"object"},"immediate_parent":{"description":"Immediate parent.","properties":{"provider_id":{"description":"Provider ID.","type":"string","nullable":true},"name":{"description":"Name.","type":"string","nullable":true},"country_code":{"description":"Country code.","type":"string","nullable":true},"type":{"description":"Type.","type":"string","nullable":true},"status":{"description":"Status.","type":"string","nullable":true},"company_reference":{"description":"Company reference.","type":"string","nullable":true},"address":{"description":"Address.","type":"string","nullable":true}},"type":"object"}}},"financials":{"description":"Financials of company. Provider data, or an empty list (`[]`) when there is none.","properties":{"data":{"description":"Data.","type":"array","items":{"properties":{"ratios":{"description":"Ratios.","properties":{"gearing":{"description":"Gearing.","type":"number","nullable":true},"debtor_days":{"description":"Debtor days.","type":"number","nullable":true},"creditor_days":{"description":"Creditor days.","type":"number","nullable":true},"current_ratio":{"description":"Current ratio.","type":"number","nullable":true},"total_debt_ratio":{"description":"Total debt ratio.","type":"number","nullable":true},"current_debt_ratio":{"description":"Current debt ratio.","type":"number","nullable":true},"equity_in_percentage":{"description":"Equity in percentage.","type":"number","nullable":true},"stock_turnover_ratio":{"description":"Stock turnover ratio.","type":"number","nullable":true},"pre_tax_profit_margin":{"description":"Pre tax profit margin.","type":"number","nullable":true},"return_on_capital_employed":{"description":"Return on capital employed.","type":"number","nullable":true},"liquidity_ratio_or_acid_test":{"description":"Liquidity ratio or acid test.","type":"number","nullable":true},"sales_or_net_working_capital":{"description":"Sales or net working capital.","type":"number","nullable":true},"return_on_net_assets_employed":{"description":"Return on net assets employed.","type":"number","nullable":true},"return_on_total_assets_employed":{"description":"Return on total assets employed.","type":"number","nullable":true}},"type":"object"},"general":{"description":"General.","properties":{"type":{"description":"Type.","type":"string","nullable":true},"currency":{"description":"Currency.","type":"string","nullable":true},"year_end_date":{"description":"Year end date.","type":"string","nullable":true},"number_of_weeks":{"description":"Number of weeks.","type":"number","nullable":true},"consolidated_accounts":{"description":"Consolidated accounts.","type":"boolean","nullable":true}},"type":"object"},"balance_sheet":{"description":"Balance sheet figures.","properties":{"cash":{"description":"Cash.","type":"number","nullable":true},"total_assets":{"description":"Total assets.","type":"number","nullable":true},"other_reserves":{"description":"Other reserves.","type":"number","nullable":true},"trade_payables":{"description":"Trade payables.","type":"number","nullable":true},"bank_liabilities":{"description":"Bank liabilities.","type":"number","nullable":true},"revenue_reserves":{"description":"Revenue reserves.","type":"number","nullable":true},"total_inventories":{"description":"Total inventories.","type":"number","nullable":true},"total_liabilities":{"description":"Total liabilities.","type":"number","nullable":true},"total_receivables":{"description":"Total receivables.","type":"number","nullable":true},"trade_receivables":{"description":"Trade receivables.","type":"number","nullable":true},"total_fixed_assets":{"description":"Total fixed assets.","type":"number","nullable":true},"other_current_assets":{"description":"Other current assets.","type":"number","nullable":true},"total_current_assets":{"description":"Total current assets.","type":"number","nullable":true},"total_tangible_assets":{"description":"Total tangible assets.","type":"number","nullable":true},"other_loans_or_finance":{"description":"Other loans or finance.","type":"number","nullable":true},"called_up_share_capital":{"description":"Called up share capital.","type":"number","nullable":true},"total_intangible_assets":{"description":"Total intangible assets.","type":"number","nullable":true},"total_other_fixed_assets":{"description":"Total other fixed assets.","type":"number","nullable":true},"miscellaneous_liabilities":{"description":"Miscellaneous liabilities.","type":"number","nullable":true},"miscellaneous_receivables":{"description":"Miscellaneous receivables.","type":"number","nullable":true},"total_current_liabilities":{"description":"Total current liabilities.","type":"number","nullable":true},"total_shareholders_equity":{"description":"Total shareholders equity.","type":"number","nullable":true},"total_long_term_liabilities":{"description":"Total long term liabilities.","type":"number","nullable":true},"bank_liabilities_due_after1year":{"description":"Bank liabilities due after 1 year.","type":"number","nullable":true},"other_loans_or_finance_due_after1year":{"description":"Other loans or finance due after 1 year.","type":"number","nullable":true},"miscellaneous_liabilities_due_after1year":{"description":"Miscellaneous liabilities due after 1 year.","type":"number","nullable":true}},"type":"object"},"profit_and_loss":{"description":"Profit and loss.","properties":{"tax":{"description":"Tax.","type":"number","nullable":true},"revenue":{"description":"Revenue.","type":"number","nullable":true},"dividends":{"description":"Dividends.","type":"number","nullable":true},"amortisation":{"description":"Amortisation.","type":"number","nullable":true},"depreciation":{"description":"Depreciation.","type":"number","nullable":true},"pension_costs":{"description":"Pension costs.","type":"number","nullable":true},"operating_costs":{"description":"Operating costs.","type":"number","nullable":true},"retained_profit":{"description":"Retained profit.","type":"number","nullable":true},"operating_profit":{"description":"Operating profit.","type":"number","nullable":true},"profit_after_tax":{"description":"Profit after tax.","type":"number","nullable":true},"profit_before_tax":{"description":"Profit before tax.","type":"number","nullable":true},"financial_expenses":{"description":"Financial expenses.","type":"number","nullable":true},"minority_interests":{"description":"Minority interests.","type":"number","nullable":true},"wages_and_salaries":{"description":"Wages and salaries.","type":"number","nullable":true},"other_appropriations":{"description":"Other appropriations.","type":"number","nullable":true}},"type":"object"},"other_financials":{"description":"Other financials.","properties":{"net_worth":{"description":"Net worth.","type":"number","nullable":true},"working_capital":{"description":"Working capital.","type":"number","nullable":true},"contingent_liabilities":{"description":"Contingent liabilities.","type":"string","nullable":true}},"type":"object"}},"type":"object"}}}},"psc":{"description":"People with significant control.","type":"array","items":{"properties":{"nature_of_control":{"description":"Nature of control.","type":"array","items":{"type":"string"},"nullable":true},"is_active":{"description":"Whether this entry is active.","type":"boolean","nullable":true},"name":{"description":"Name.","type":"string","nullable":true},"kind":{"description":"Kind.","type":"string","nullable":true},"entityType":{"description":"Type of entity.","type":"string","nullable":true},"address":{"description":"Address.","type":"string","nullable":true},"notified_on":{"description":"Notified on.","type":"string","nullable":true},"ceased_on":{"description":"Ceased on.","type":"string","nullable":true},"dob_day":{"description":"Day of birth.","type":"number","nullable":true},"dob_month":{"description":"Month of birth.","type":"number","nullable":true},"dob_year":{"description":"Year of birth.","type":"number","nullable":true}},"type":"object"}},"domain":{"description":"The profile's website domain, or `null` if none has been added. For the full analysis, see **Retrieve online presence analysis** (`GET /profiles/{uuid}/domain`).","type":"object","nullable":true,"properties":{"domain":{"description":"The domain name.","type":"string"},"online_presence":{"description":"Online presence details, or `null` if not yet available."}}},"screenings":{"description":"Screenings.","type":"array","items":{"type":"object","additionalProperties":true},"nullable":true}},"type":"object","nullable":true},"updated_at":{"description":"Date and time the profile was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the profile was created.","type":"string","nullable":false}},"type":"object"}]},"ProfileListResource":{"title":"Profile List Resource","required":["id","customer_reference","review_status","updated_at","created_at"],"properties":{"id":{"description":"Profile UUID.","type":"string","nullable":false},"entity_type":{"description":"Entity type information.","properties":{"id":{"description":"Entity type ID.","type":"integer","nullable":true},"type":{"description":"Entity type value.","type":"string","enum":["company","sole_trader","partnership","charity","government_entity","incorporated_syndicate","company_syndicate","syndicate","association","trust","fund","club","individual","joint_individual"],"nullable":false},"label":{"description":"Entity type label.","type":"string","nullable":false}},"type":"object","nullable":false},"customer_reference":{"description":"Your unique reference for the profile.","type":"string","nullable":false},"company_name":{"description":"Name of the company.","type":"string","nullable":false},"risk":{"description":"Risk category assigned to the profile, or `null` if there is none.","properties":{"id":{"description":"Risk category ID.","type":"string","nullable":false},"label":{"description":"Label of the risk category.","type":"string","nullable":true},"category":{"description":"Category of the risk.","type":"string","nullable":true}},"type":"object","nullable":true},"team":{"description":"Team the profile is assigned to, or `null` if there is none.","properties":{"id":{"description":"Team ID.","type":"integer","nullable":false},"label":{"description":"Label of the team.","type":"string","nullable":true}},"type":"object","nullable":true},"configuration":{"description":"Configuration assigned to the profile, or `null` if there is none.","properties":{"id":{"description":"Configuration ID.","type":"integer","nullable":false},"name":{"description":"Name of the configuration.","type":"string","nullable":true}},"type":"object","nullable":true},"brand":{"description":"Brand assigned to the profile, or `null` if there is none.","properties":{"id":{"description":"Brand UUID.","type":"string","nullable":false},"name":{"description":"Brand name.","type":"string","nullable":false},"slug":{"description":"Brand slug.","type":"string","nullable":false}},"type":"object","nullable":true},"review_status":{"description":"Review status of the profile.","type":"string","enum":["Processed","Incomplete","Needs Review","Additional Info Required","Approved","Declined","Archived"],"nullable":false},"assignee":{"description":"Case management user the profile is assigned to, or `null` if there is none.","properties":{"id":{"description":"ID of the case management user.","type":"string","nullable":false},"name":{"description":"Name of the case management user.","type":"string","nullable":true}},"type":"object","nullable":true},"review_at":{"description":"Date the profile's current review period started. The next review falls a configured review period after this date. `null` if no review period has started.","type":"string","nullable":true},"updated_at":{"description":"Date and time the profile was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the profile was created.","type":"string","nullable":false}},"type":"object"}},"responses":{"401":{"description":"Unauthorized. The access token is missing, invalid or has expired.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}},"404":{"description":"Not Found. The requested resource does not exist, or is not available to your account.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"},"error":{"description":"Machine-readable details of the error.","type":"object","properties":{"key":{"description":"Error code, for example `error.generic`.","type":"string"},"params":{"description":"Values used in the error message, if any.","type":"array","items":{}}}}},"type":"object"}}}},"429":{"description":"Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the `Retry-After` header before trying again.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}}}},"paths":{"/profiles/{uuid}":{"get":{"tags":["Profiles"],"summary":"Retrieve a profile","description":"Returns a single profile, including core details, data retrieved from the data sources, screenings and more.\n\nCompany data comes from a range of data providers. Not all of it is normalised, so the fields returned vary by provider and may be `null` or empty.","operationId":"8f62ce17008beef766982c01243b184f","parameters":[{"$ref":"#/components/parameters/profileUuid"}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ProfileResource"}},"type":"object"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}}}}}
```

## Delete a profile

> Deletes a profile. This cannot be undone. All active monitoring for the profile is stopped first. If monitoring cannot be fully stopped, the profile is not deleted and a \`502\` response is returned. You can safely retry the request.

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"tags":[{"name":"Profiles","description":"A profile is the container for all the information the platform holds about an entity, including its risk analysis, representative details and verification results. Think of a profile as a 'case' to be processed."}],"servers":[{"url":"https://api.detected.app/api/v2/public","description":"Production"}],"security":[{"AccessToken":[]}],"components":{"securitySchemes":{"AccessToken":{"type":"http","description":"The API uses OAuth 2.0. Request an access token with **Create an access token** (`POST /oauth/token`), sending the client ID and client secret of your integration client, and your account slug. Send the access token in the `Authorization` header of every request, in the format `Authorization: Bearer <access_token>`. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.","bearerFormat":"OAuth 2.0 access token","scheme":"bearer"}},"parameters":{"profileUuid":{"name":"uuid","in":"path","description":"UUID of the profile.","required":true,"schema":{"type":"string","format":"uuid","nullable":false}}},"headers":{"X-RateLimit-Limit":{"description":"Maximum number of requests allowed in the rate limit window.","schema":{"type":"number","nullable":false}},"X-RateLimit-Remaining":{"description":"Number of requests remaining in the current rate limit window.","schema":{"type":"number","nullable":false}},"Retry-After":{"description":"Number of seconds to wait before making another request. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}},"X-RateLimit-Reset":{"description":"Unix timestamp (in seconds) at which the rate limit resets. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}}},"responses":{"401":{"description":"Unauthorized. The access token is missing, invalid or has expired.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}},"429":{"description":"Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the `Retry-After` header before trying again.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}}}},"paths":{"/profiles/{uuid}":{"delete":{"tags":["Profiles"],"summary":"Delete a profile","description":"Deletes a profile. This cannot be undone. All active monitoring for the profile is stopped first. If monitoring cannot be fully stopped, the profile is not deleted and a `502` response is returned. You can safely retry the request.","operationId":"delete-profile-endpoint","parameters":[{"$ref":"#/components/parameters/profileUuid"}],"responses":{"204":{"description":"No Content. Monitoring was stopped and the profile was deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}}},"401":{"$ref":"#/components/responses/401"},"404":{"description":"Not Found. The profile does not exist, or is not available to your account."},"429":{"$ref":"#/components/responses/429"},"502":{"description":"Bad Gateway. Monitoring could not be fully stopped, so the profile was not deleted. It is safe to retry.","content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}}}}}}}}
```

## Update a profile

> Updates a profile. You can update \`customer\_reference\`, \`risk\_id\`, \`configuration\_id\`, \`team\_id\`, \`assignee\_id\`, \`brand\_id\` and \`review\_status\`:\
> \
> \- \`assignee\_id\`: the ID of a user from \*\*List case management users\*\* (\`GET /users\`)\
> \- \`brand\_id\`: the UUID of a brand from \*\*List brands\*\* (\`GET /brands\`)\
> \- \`configuration\_id\`: the ID of a configuration from \*\*List portal configurations\*\* (\`GET /portal-configurations\`)\
> \- \`review\_status\`: one of \`Processed\`, \`Needs Review\`, \`Additional Info Required\`, \`Approved\`, \`Declined\` or \`Archived\`\
> \
> Setting \`review\_status\` to \`Archived\` or \`Declined\` stops all ongoing monitoring for the profile and its representatives, including company alert monitoring and screening monitoring. Monitoring cannot be restarted. The status change only succeeds once the provider has confirmed that monitoring has stopped.

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"tags":[{"name":"Profiles","description":"A profile is the container for all the information the platform holds about an entity, including its risk analysis, representative details and verification results. Think of a profile as a 'case' to be processed."}],"servers":[{"url":"https://api.detected.app/api/v2/public","description":"Production"}],"security":[{"AccessToken":[]}],"components":{"securitySchemes":{"AccessToken":{"type":"http","description":"The API uses OAuth 2.0. Request an access token with **Create an access token** (`POST /oauth/token`), sending the client ID and client secret of your integration client, and your account slug. Send the access token in the `Authorization` header of every request, in the format `Authorization: Bearer <access_token>`. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.","bearerFormat":"OAuth 2.0 access token","scheme":"bearer"}},"parameters":{"profileUuid":{"name":"uuid","in":"path","description":"UUID of the profile.","required":true,"schema":{"type":"string","format":"uuid","nullable":false}}},"schemas":{"ProfileUpdateRequest":{"title":"Profile Update Request","description":"The fields to change on a profile. Send only the fields you want to change.","properties":{"assignee_id":{"description":"ID of the case management user to assign to the profile, or `null` to unassign the current user.","type":"string","nullable":true},"risk_id":{"description":"ID of the risk category to assign to the profile, or `null` to unassign the current category.","type":"string","nullable":true},"team_id":{"description":"ID of the team to assign to the profile, or `null` to unassign the current team.","type":"integer","nullable":true},"customer_reference":{"description":"Your unique reference for the profile.","type":"string","nullable":false},"configuration_id":{"description":"ID of the configuration to assign to the profile, or `null` to unassign the current configuration.","type":"integer","nullable":true},"brand_id":{"description":"Assign a brand to a profile by brand UUID, or unassign by setting the value `null`.","type":"string","format":"uuid","nullable":true},"review_status":{"description":"Review status of the profile. Setting it to `Archived` or `Declined` stops all monitoring, and monitoring cannot be restarted.","type":"string","enum":["Processed","Needs Review","Additional Info Required","Approved","Declined","Archived"],"nullable":false}},"type":"object"},"ProfileResource":{"title":"Profile Resource","required":["id","customer_reference","review_status","updated_at","created_at"],"type":"object","allOf":[{"$ref":"#/components/schemas/ProfileListResource"},{"properties":{"id":{"description":"Profile UUID.","type":"string","nullable":false},"entity_type":{"description":"Entity type information.","properties":{"id":{"description":"Entity type ID.","type":"integer","nullable":true},"type":{"description":"Entity type value.","type":"string","enum":["company","sole_trader","partnership","charity","government_entity","incorporated_syndicate","company_syndicate","syndicate","association","trust","fund","club","individual","joint_individual"],"nullable":false},"label":{"description":"Entity type label.","type":"string","nullable":false}},"type":"object","nullable":false},"customer_reference":{"description":"Your unique reference for the profile.","type":"string","nullable":false},"risk":{"description":"Risk category assigned to the profile, or `null` if there is none.","properties":{"id":{"description":"Risk category ID.","type":"string","nullable":false},"label":{"description":"Label of the risk category.","type":"string","nullable":true},"category":{"description":"Category of the risk.","type":"string","nullable":true}},"type":"object","nullable":true},"team":{"description":"Team the profile is assigned to, or `null` if there is none.","properties":{"id":{"description":"Team ID.","type":"integer","nullable":false},"label":{"description":"Label of the team.","type":"string","nullable":true}},"type":"object","nullable":true},"configuration":{"description":"Configuration assigned to the profile, or `null` if there is none.","properties":{"id":{"description":"Configuration ID.","type":"integer","nullable":false},"name":{"description":"Name of the configuration.","type":"string","nullable":true}},"type":"object","nullable":true},"review_status":{"description":"Review status of the profile.","type":"string","enum":["Processed","Incomplete","Needs Review","Additional Info Required","Approved","Declined","Archived"],"nullable":false},"onboarding_statuses":{"description":"Portal onboarding statuses.","type":"array","items":{"properties":{"title":{"description":"Onboarding step name.","type":"string","nullable":false},"status":{"description":"Status of onboarding step.","type":"string","enum":["pending","completed","in-progress","in-complete"],"nullable":false}},"type":"object"},"nullable":true},"assignee":{"description":"Case management user the profile is assigned to, or `null` if there is none.","properties":{"id":{"description":"ID of the case management user.","type":"string","nullable":false},"name":{"description":"Name of the case management user.","type":"string","nullable":true}},"type":"object","nullable":true},"review_at":{"description":"Date the profile's current review period started. The next review falls a configured review period after this date. `null` if no review period has started.","type":"string","nullable":true},"company":{"description":"Company data from the data providers. See the notes on **Retrieve a profile** (`GET /profiles/{uuid}`).","properties":{"profile":{"description":"Core details of the company. The fields returned vary by data provider, and providers may return fields not listed here.","properties":{"ProfileCompanyCapital":{"description":"Capital.","type":"number","nullable":true},"ProfileCompanyCreditContractLimit":{"description":"Credit contract limit.","type":"number","nullable":true},"ProfileCompanyCreditLimit":{"description":"Credit limit.","type":"number","nullable":true},"ProfileCompanyCreditPreviousLimit":{"description":"Previous credit limit.","type":"number","nullable":true},"ProfileCompanyCreditPreviousProviderDescription":{"description":"Previous credit provider description.","type":"string","nullable":true},"ProfileCompanyCreditPreviousProviderMax":{"description":"Previous credit provider maximum.","type":"number","nullable":true},"ProfileCompanyCreditPreviousProviderMin":{"description":"Previous credit provider minimum.","type":"number","nullable":true},"ProfileCompanyCreditPreviousProviderValue":{"description":"Previous credit provider value.","type":"number","nullable":true},"ProfileCompanyCreditPreviousRating":{"description":"Previous credit rating.","type":"string","nullable":true},"ProfileCompanyCreditPreviousRatingDescription":{"description":"Previous credit rating description.","type":"string","nullable":true},"ProfileCompanyCreditProbabilityOfDefault":{"description":"Credit probability of default.","type":"number","nullable":true},"ProfileCompanyCreditProviderDescription":{"description":"Credit provider description.","type":"string","nullable":true},"ProfileCompanyCreditProviderMax":{"description":"Credit provider maximum.","type":"number","nullable":true},"ProfileCompanyCreditProviderMin":{"description":"Credit provider minimum.","type":"number","nullable":true},"ProfileCompanyCreditProviderValue":{"description":"Credit provider value.","type":"number","nullable":true},"ProfileCompanyCreditRating":{"description":"Credit rating.","type":"string","nullable":true},"ProfileCompanyCreditRatingDate":{"description":"Credit rating date.","type":"string","nullable":true},"ProfileCompanyCreditRatingDescription":{"description":"Credit rating description.","type":"string","nullable":true},"ProfileCompanyCreditRatingHistory":{"description":"Credit rating history.","type":"array","items":{}},"ProfileCompanyCurrency":{"description":"Currency of the financial figures.","type":"string","nullable":true},"ProfileCompanyCurrentAssets":{"description":"Current assets.","type":"number","nullable":true},"ProfileCompanyDataSource":{"description":"Data provider the company data came from, for example `opencorporates`, `markaaz_v2`, `creditsafe` or `manual`.","type":"string","nullable":true},"ProfileCompanyEBITDA":{"description":"EBITDA.","type":"string","nullable":true},"ProfileCompanyEmail":{"description":"Company email address.","type":"string","nullable":true},"ProfileCompanyGrossProfit":{"description":"Gross profit.","type":"number","nullable":true},"ProfileCompanyHasVatNumber":{"description":"Whether the company has a VAT number.","type":"boolean","nullable":true},"ProfileCompanyIndustryClassifications":{"description":"Industry classifications.","type":"array","items":{"type":"string"},"nullable":true},"ProfileCompanyIndustryCodes":{"description":"Industry codes.","type":"array","items":{"type":"string"},"nullable":true},"ProfileCompanyIndustryDescriptions":{"description":"Industry descriptions.","type":"array","items":{"type":"string"},"nullable":true},"ProfileCompanyIsExporter":{"description":"Whether the company is an exporter.","type":"boolean","nullable":true},"ProfileCompanyIsImporter":{"description":"Whether the company is an importer.","type":"boolean","nullable":true},"ProfileCompanyLastAccountsDate":{"description":"Last accounts date.","type":"string","nullable":true},"ProfileCompanyLegalForm":{"description":"Legal form of the company.","type":"string","nullable":true},"ProfileCompanyLeiNumber":{"description":"Legal Entity Identifier (LEI), or `null` if not available."},"ProfileCompanyLongTermDebt":{"description":"Long term debt.","type":"number","nullable":true},"ProfileCompanyName":{"description":"Company name.","type":"string","nullable":true},"ProfileCompanyNumOfEmployees":{"description":"Number of employees.","type":"integer","nullable":true},"ProfileCompanyOriginalLanguageNames":{"description":"Names in the original language, or `null` if not available."},"ProfileCompanyOtherAddresses":{"description":"Other addresses.","type":"array","items":{},"nullable":true},"ProfileCompanyOtherLanguageNames":{"description":"Names in other languages, or `null` if not available."},"ProfileCompanyOtherRegistrationNumbers":{"description":"Other registration numbers.","type":"array","items":{}},"ProfileCompanyPhoneNumber":{"description":"Company phone number.","type":"string","nullable":true},"ProfileCompanyPreviousNames":{"description":"Previous names, or `null` if not available."},"ProfileCompanyProviderReference":{"description":"Reference for the company at the data provider, or `null` if not available."},"ProfileCompanyReference":{"description":"Company registration number.","type":"string","nullable":true},"ProfileCompanyRegisteredAddress":{"description":"Registered address.","type":"string","nullable":true},"ProfileCompanyRegisteredAddress1":{"description":"Registered address, line 1.","type":"string","nullable":true},"ProfileCompanyRegisteredAddress2":{"description":"Registered address, line 2.","type":"string","nullable":true},"ProfileCompanyRegisteredAddressCity":{"description":"Registered address city.","type":"string","nullable":true},"ProfileCompanyRegisteredAddressCountryCode":{"description":"Registered address country code.","type":"string","nullable":true},"ProfileCompanyRegisteredAddressPostCode":{"description":"Registered address postcode.","type":"string","nullable":true},"ProfileCompanyRegisteredAddressProvince":{"description":"Registered address province.","type":"string","nullable":true},"ProfileCompanyRegisteredCountry":{"description":"Country the company is registered in.","type":"string","nullable":true},"ProfileCompanyRegistrationDate":{"description":"Registration date.","type":"string","nullable":true},"ProfileCompanyRegistrationYear":{"description":"Year of registration.","type":"string","nullable":true},"ProfileCompanyStatusActive":{"description":"Whether the company is active.","type":"boolean","nullable":true},"ProfileCompanyStatusProvider":{"description":"Company status, as reported by the provider.","type":"string","nullable":true},"ProfileCompanyTotalAssets":{"description":"Total assets.","type":"number","nullable":true},"ProfileCompanyTradingNames":{"description":"Trading names.","type":"string","nullable":true},"ProfileCompanyTurnover":{"description":"Turnover.","type":"number","nullable":true},"ProfileCompanyVatNumber":{"description":"VAT number.","type":"string","nullable":true}},"type":"object","nullable":true,"additionalProperties":true},"directors":{"description":"Directors from the data source: `data` lists them and `summary` counts them. An empty list (`[]`) when there are none.","properties":{"data":{"description":"Data.","type":"array","items":{"properties":{"director_id":{"description":"Director ID.","type":"string","nullable":true},"job_title":{"description":"Job title.","type":"string","nullable":true},"gender":{"description":"Gender.","type":"string","nullable":true},"appointment_date":{"description":"Appointment date.","type":"string","nullable":true},"resignation_date":{"description":"Resignation date.","type":"string","nullable":true},"dob":{"description":"Date of birth.","type":"string","nullable":true},"address":{"description":"Address.","type":"string","nullable":true},"country":{"description":"Country.","type":"string","nullable":true},"nationality":{"description":"Nationality.","type":"string","nullable":true},"company_number":{"description":"Company number.","type":"string","nullable":true},"screenings":{"description":"Screenings.","type":"array","items":{"type":"object","additionalProperties":true},"nullable":true},"is_active":{"description":"Whether this entry is active.","type":"boolean","nullable":true},"suffix":{"description":"Suffix.","type":"string","nullable":true},"salutation":{"description":"Salutation.","type":"string","nullable":true},"shareholder":{"description":"Shareholder.","type":"string","nullable":true},"position_type":{"description":"Position type.","type":"string","nullable":true},"responsibility":{"description":"Responsibility.","type":"string","nullable":true},"type":{"description":"Type.","type":"string","nullable":true},"title":{"description":"Title.","type":"string","nullable":true},"full_name":{"description":"Full name.","type":"string","nullable":true},"first_name":{"description":"First name.","type":"string","nullable":true},"last_name":{"description":"Last name.","type":"string","nullable":true},"middle_name":{"description":"Middle name.","type":"string","nullable":true}},"type":"object"},"nullable":false},"summary":{"description":"Counts of the directors.","type":"object","properties":{"total_count":{"type":"integer"},"active_count":{"type":"integer"},"inactive_count":{"type":"integer"}}}}},"share_structure":{"description":"Details of the share structure including shareholders. Provider data, or an empty list (`[]`) when there is none.","properties":{"data":{"description":"Data.","properties":{"share_holders":{"description":"List of shareholders.","type":"array","items":{"properties":{"id":{"description":"ID.","type":"string","nullable":true},"name":{"description":"Name.","type":"string","nullable":true},"currency":{"description":"Currency.","type":"string","nullable":true},"share_type":{"description":"Share type.","type":"string","nullable":true},"share_types":{"description":"Share types.","type":"array","items":{"properties":{"currency":{"description":"Currency.","type":"string","nullable":true},"share_type":{"description":"Share type.","type":"string","nullable":true},"value_of_shares":{"description":"Value of shares.","type":"number","nullable":true},"value_per_share":{"description":"Value per share.","type":"number","nullable":true},"number_of_shares":{"description":"Number of shares.","type":"number","nullable":true},"company_reference":{"description":"Company reference.","type":"string","nullable":true}},"type":"object"},"nullable":true},"value_of_shares":{"description":"Value of shares.","type":"number","nullable":true},"number_of_shares":{"description":"Number of shares.","type":"number","nullable":true},"shareholder_type":{"description":"Shareholder type.","type":"string","nullable":true},"percentage_shares_held":{"description":"Percentage shares held.","type":"number","nullable":true},"address":{"description":"Address.","type":"number","nullable":true}},"type":"object"}}},"type":"object"},"issued_shares_total":{"description":"Issued shares total.","type":"number","nullable":true},"issued_shares_capital_value":{"description":"Issued shares capital value.","type":"number","nullable":true}}},"structure":{"description":"Structure of company. Provider data, or an empty list (`[]`) when there is none.","properties":{"ultimate_parent":{"description":"Ultimate parent.","properties":{"provider_id":{"description":"Provider ID.","type":"string","nullable":true},"name":{"description":"Name.","type":"string","nullable":true},"country_code":{"description":"Country code.","type":"string","nullable":true},"type":{"description":"Type.","type":"string","nullable":true},"status":{"description":"Status.","type":"string","nullable":true},"company_reference":{"description":"Company reference.","type":"string","nullable":true},"address":{"description":"Address.","type":"string","nullable":true}},"type":"object"},"immediate_parent":{"description":"Immediate parent.","properties":{"provider_id":{"description":"Provider ID.","type":"string","nullable":true},"name":{"description":"Name.","type":"string","nullable":true},"country_code":{"description":"Country code.","type":"string","nullable":true},"type":{"description":"Type.","type":"string","nullable":true},"status":{"description":"Status.","type":"string","nullable":true},"company_reference":{"description":"Company reference.","type":"string","nullable":true},"address":{"description":"Address.","type":"string","nullable":true}},"type":"object"}}},"financials":{"description":"Financials of company. Provider data, or an empty list (`[]`) when there is none.","properties":{"data":{"description":"Data.","type":"array","items":{"properties":{"ratios":{"description":"Ratios.","properties":{"gearing":{"description":"Gearing.","type":"number","nullable":true},"debtor_days":{"description":"Debtor days.","type":"number","nullable":true},"creditor_days":{"description":"Creditor days.","type":"number","nullable":true},"current_ratio":{"description":"Current ratio.","type":"number","nullable":true},"total_debt_ratio":{"description":"Total debt ratio.","type":"number","nullable":true},"current_debt_ratio":{"description":"Current debt ratio.","type":"number","nullable":true},"equity_in_percentage":{"description":"Equity in percentage.","type":"number","nullable":true},"stock_turnover_ratio":{"description":"Stock turnover ratio.","type":"number","nullable":true},"pre_tax_profit_margin":{"description":"Pre tax profit margin.","type":"number","nullable":true},"return_on_capital_employed":{"description":"Return on capital employed.","type":"number","nullable":true},"liquidity_ratio_or_acid_test":{"description":"Liquidity ratio or acid test.","type":"number","nullable":true},"sales_or_net_working_capital":{"description":"Sales or net working capital.","type":"number","nullable":true},"return_on_net_assets_employed":{"description":"Return on net assets employed.","type":"number","nullable":true},"return_on_total_assets_employed":{"description":"Return on total assets employed.","type":"number","nullable":true}},"type":"object"},"general":{"description":"General.","properties":{"type":{"description":"Type.","type":"string","nullable":true},"currency":{"description":"Currency.","type":"string","nullable":true},"year_end_date":{"description":"Year end date.","type":"string","nullable":true},"number_of_weeks":{"description":"Number of weeks.","type":"number","nullable":true},"consolidated_accounts":{"description":"Consolidated accounts.","type":"boolean","nullable":true}},"type":"object"},"balance_sheet":{"description":"Balance sheet figures.","properties":{"cash":{"description":"Cash.","type":"number","nullable":true},"total_assets":{"description":"Total assets.","type":"number","nullable":true},"other_reserves":{"description":"Other reserves.","type":"number","nullable":true},"trade_payables":{"description":"Trade payables.","type":"number","nullable":true},"bank_liabilities":{"description":"Bank liabilities.","type":"number","nullable":true},"revenue_reserves":{"description":"Revenue reserves.","type":"number","nullable":true},"total_inventories":{"description":"Total inventories.","type":"number","nullable":true},"total_liabilities":{"description":"Total liabilities.","type":"number","nullable":true},"total_receivables":{"description":"Total receivables.","type":"number","nullable":true},"trade_receivables":{"description":"Trade receivables.","type":"number","nullable":true},"total_fixed_assets":{"description":"Total fixed assets.","type":"number","nullable":true},"other_current_assets":{"description":"Other current assets.","type":"number","nullable":true},"total_current_assets":{"description":"Total current assets.","type":"number","nullable":true},"total_tangible_assets":{"description":"Total tangible assets.","type":"number","nullable":true},"other_loans_or_finance":{"description":"Other loans or finance.","type":"number","nullable":true},"called_up_share_capital":{"description":"Called up share capital.","type":"number","nullable":true},"total_intangible_assets":{"description":"Total intangible assets.","type":"number","nullable":true},"total_other_fixed_assets":{"description":"Total other fixed assets.","type":"number","nullable":true},"miscellaneous_liabilities":{"description":"Miscellaneous liabilities.","type":"number","nullable":true},"miscellaneous_receivables":{"description":"Miscellaneous receivables.","type":"number","nullable":true},"total_current_liabilities":{"description":"Total current liabilities.","type":"number","nullable":true},"total_shareholders_equity":{"description":"Total shareholders equity.","type":"number","nullable":true},"total_long_term_liabilities":{"description":"Total long term liabilities.","type":"number","nullable":true},"bank_liabilities_due_after1year":{"description":"Bank liabilities due after 1 year.","type":"number","nullable":true},"other_loans_or_finance_due_after1year":{"description":"Other loans or finance due after 1 year.","type":"number","nullable":true},"miscellaneous_liabilities_due_after1year":{"description":"Miscellaneous liabilities due after 1 year.","type":"number","nullable":true}},"type":"object"},"profit_and_loss":{"description":"Profit and loss.","properties":{"tax":{"description":"Tax.","type":"number","nullable":true},"revenue":{"description":"Revenue.","type":"number","nullable":true},"dividends":{"description":"Dividends.","type":"number","nullable":true},"amortisation":{"description":"Amortisation.","type":"number","nullable":true},"depreciation":{"description":"Depreciation.","type":"number","nullable":true},"pension_costs":{"description":"Pension costs.","type":"number","nullable":true},"operating_costs":{"description":"Operating costs.","type":"number","nullable":true},"retained_profit":{"description":"Retained profit.","type":"number","nullable":true},"operating_profit":{"description":"Operating profit.","type":"number","nullable":true},"profit_after_tax":{"description":"Profit after tax.","type":"number","nullable":true},"profit_before_tax":{"description":"Profit before tax.","type":"number","nullable":true},"financial_expenses":{"description":"Financial expenses.","type":"number","nullable":true},"minority_interests":{"description":"Minority interests.","type":"number","nullable":true},"wages_and_salaries":{"description":"Wages and salaries.","type":"number","nullable":true},"other_appropriations":{"description":"Other appropriations.","type":"number","nullable":true}},"type":"object"},"other_financials":{"description":"Other financials.","properties":{"net_worth":{"description":"Net worth.","type":"number","nullable":true},"working_capital":{"description":"Working capital.","type":"number","nullable":true},"contingent_liabilities":{"description":"Contingent liabilities.","type":"string","nullable":true}},"type":"object"}},"type":"object"}}}},"psc":{"description":"People with significant control.","type":"array","items":{"properties":{"nature_of_control":{"description":"Nature of control.","type":"array","items":{"type":"string"},"nullable":true},"is_active":{"description":"Whether this entry is active.","type":"boolean","nullable":true},"name":{"description":"Name.","type":"string","nullable":true},"kind":{"description":"Kind.","type":"string","nullable":true},"entityType":{"description":"Type of entity.","type":"string","nullable":true},"address":{"description":"Address.","type":"string","nullable":true},"notified_on":{"description":"Notified on.","type":"string","nullable":true},"ceased_on":{"description":"Ceased on.","type":"string","nullable":true},"dob_day":{"description":"Day of birth.","type":"number","nullable":true},"dob_month":{"description":"Month of birth.","type":"number","nullable":true},"dob_year":{"description":"Year of birth.","type":"number","nullable":true}},"type":"object"}},"domain":{"description":"The profile's website domain, or `null` if none has been added. For the full analysis, see **Retrieve online presence analysis** (`GET /profiles/{uuid}/domain`).","type":"object","nullable":true,"properties":{"domain":{"description":"The domain name.","type":"string"},"online_presence":{"description":"Online presence details, or `null` if not yet available."}}},"screenings":{"description":"Screenings.","type":"array","items":{"type":"object","additionalProperties":true},"nullable":true}},"type":"object","nullable":true},"updated_at":{"description":"Date and time the profile was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the profile was created.","type":"string","nullable":false}},"type":"object"}]},"ProfileListResource":{"title":"Profile List Resource","required":["id","customer_reference","review_status","updated_at","created_at"],"properties":{"id":{"description":"Profile UUID.","type":"string","nullable":false},"entity_type":{"description":"Entity type information.","properties":{"id":{"description":"Entity type ID.","type":"integer","nullable":true},"type":{"description":"Entity type value.","type":"string","enum":["company","sole_trader","partnership","charity","government_entity","incorporated_syndicate","company_syndicate","syndicate","association","trust","fund","club","individual","joint_individual"],"nullable":false},"label":{"description":"Entity type label.","type":"string","nullable":false}},"type":"object","nullable":false},"customer_reference":{"description":"Your unique reference for the profile.","type":"string","nullable":false},"company_name":{"description":"Name of the company.","type":"string","nullable":false},"risk":{"description":"Risk category assigned to the profile, or `null` if there is none.","properties":{"id":{"description":"Risk category ID.","type":"string","nullable":false},"label":{"description":"Label of the risk category.","type":"string","nullable":true},"category":{"description":"Category of the risk.","type":"string","nullable":true}},"type":"object","nullable":true},"team":{"description":"Team the profile is assigned to, or `null` if there is none.","properties":{"id":{"description":"Team ID.","type":"integer","nullable":false},"label":{"description":"Label of the team.","type":"string","nullable":true}},"type":"object","nullable":true},"configuration":{"description":"Configuration assigned to the profile, or `null` if there is none.","properties":{"id":{"description":"Configuration ID.","type":"integer","nullable":false},"name":{"description":"Name of the configuration.","type":"string","nullable":true}},"type":"object","nullable":true},"brand":{"description":"Brand assigned to the profile, or `null` if there is none.","properties":{"id":{"description":"Brand UUID.","type":"string","nullable":false},"name":{"description":"Brand name.","type":"string","nullable":false},"slug":{"description":"Brand slug.","type":"string","nullable":false}},"type":"object","nullable":true},"review_status":{"description":"Review status of the profile.","type":"string","enum":["Processed","Incomplete","Needs Review","Additional Info Required","Approved","Declined","Archived"],"nullable":false},"assignee":{"description":"Case management user the profile is assigned to, or `null` if there is none.","properties":{"id":{"description":"ID of the case management user.","type":"string","nullable":false},"name":{"description":"Name of the case management user.","type":"string","nullable":true}},"type":"object","nullable":true},"review_at":{"description":"Date the profile's current review period started. The next review falls a configured review period after this date. `null` if no review period has started.","type":"string","nullable":true},"updated_at":{"description":"Date and time the profile was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the profile was created.","type":"string","nullable":false}},"type":"object"}},"headers":{"X-RateLimit-Limit":{"description":"Maximum number of requests allowed in the rate limit window.","schema":{"type":"number","nullable":false}},"X-RateLimit-Remaining":{"description":"Number of requests remaining in the current rate limit window.","schema":{"type":"number","nullable":false}},"Retry-After":{"description":"Number of seconds to wait before making another request. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}},"X-RateLimit-Reset":{"description":"Unix timestamp (in seconds) at which the rate limit resets. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}}},"responses":{"401":{"description":"Unauthorized. The access token is missing, invalid or has expired.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}},"404":{"description":"Not Found. The requested resource does not exist, or is not available to your account.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"},"error":{"description":"Machine-readable details of the error.","type":"object","properties":{"key":{"description":"Error code, for example `error.generic`.","type":"string"},"params":{"description":"Values used in the error message, if any.","type":"array","items":{}}}}},"type":"object"}}}},"422":{"description":"Unprocessable Content. The request was understood but failed validation. `errors` lists each field that failed and why.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A human-readable description of the first error.","type":"string"},"errors":{"description":"Validation errors, keyed by the name of the field that failed. Each field has a list of messages.","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}},"429":{"description":"Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the `Retry-After` header before trying again.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}}}},"paths":{"/profiles/{uuid}":{"patch":{"tags":["Profiles"],"summary":"Update a profile","description":"Updates a profile. You can update `customer_reference`, `risk_id`, `configuration_id`, `team_id`, `assignee_id`, `brand_id` and `review_status`:\n\n- `assignee_id`: the ID of a user from **List case management users** (`GET /users`)\n- `brand_id`: the UUID of a brand from **List brands** (`GET /brands`)\n- `configuration_id`: the ID of a configuration from **List portal configurations** (`GET /portal-configurations`)\n- `review_status`: one of `Processed`, `Needs Review`, `Additional Info Required`, `Approved`, `Declined` or `Archived`\n\nSetting `review_status` to `Archived` or `Declined` stops all ongoing monitoring for the profile and its representatives, including company alert monitoring and screening monitoring. Monitoring cannot be restarted. The status change only succeeds once the provider has confirmed that monitoring has stopped.","operationId":"e9f9efbaf3c1186981085c70d0807e82","parameters":[{"$ref":"#/components/parameters/profileUuid"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileUpdateRequest"}}}},"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ProfileResource"}},"type":"object"}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"502":{"description":"Bad Gateway. Monitoring could not be fully stopped when setting `review_status` to `Archived` or `Declined`, so the status was not changed. It is safe to retry, because monitoring that has already stopped is skipped."}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://detected.gitbook.io/detected-api-docs/api-reference/profiles.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.