> For the complete documentation index, see [llms.txt](https://detected.gitbook.io/detected-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-docs/models.md).

# Models

## The LinksResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"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":false},"next":{"description":"URL of the next page of results, or null if there is none.","type":"string","nullable":false}},"type":"object"}}}}
```

## The MetaResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"MetaResource":{"title":"Meta Resource","properties":{"current_page":{"description":"Number of the current page.","type":"number","nullable":false},"from":{"description":"Position of the first item on this page, counted across all pages.","type":"number","nullable":false},"last_page":{"description":"Number of the last page.","type":"number","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":false},"label":{"description":"Text to display for the link, for example a page number or \"Previous\".","type":"string","nullable":false},"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":"number","nullable":false},"to":{"description":"Position of the last item on this page, counted across all pages.","type":"number","nullable":false},"total":{"description":"Total number of items across all pages.","type":"number","nullable":false}},"type":"object"}}}}
```

## The AuditLogResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"AuditLogResource":{"title":"Audit Log Resource","required":["id","profile_id","profile_name","actioned_at","performed_by","auth_type","application","resource","action","reason"],"properties":{"id":{"description":"Audit log ID.","type":"integer","nullable":false},"profile_id":{"description":"UUID of the profile the audit log belongs to.","type":"string","nullable":false},"profile_name":{"description":"Name of the profile the audit log belongs to.","type":"string","nullable":true},"actioned_at":{"description":"Date and time the action was performed.","type":"string","nullable":false},"performed_by":{"description":"Name of the user or system that performed the action.","type":"string","nullable":false},"auth_type":{"description":"Authentication type used.","type":"string","nullable":true},"application":{"description":"Application that triggered the action.","type":"string","nullable":false},"resource":{"description":"Type of resource the action was performed on, for example `Company Profile`.","type":"string","nullable":false},"action":{"description":"Action that was performed, for example `updated`.","type":"string","nullable":false},"reason":{"description":"Reason for the action.","type":"string","nullable":true}},"type":"object"}}}}
```

## The CreateTokenRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"CreateTokenRequest":{"title":"Create Token Request","required":["grant_type","client_id","client_secret","slug"],"properties":{"grant_type":{"description":"Grant type to use. Use `app_credentials`.","type":"string","enum":["app_credentials"],"nullable":false},"client_id":{"description":"Client ID of your integration client, from the dashboard.","type":"string","nullable":false},"client_secret":{"description":"Client secret of your integration client, from the dashboard.","type":"string","nullable":false},"slug":{"description":"Account slug.","type":"string","nullable":false}},"type":"object"}}}}
```

## The TokenResourceResponse object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"TokenResourceResponse":{"title":"Token Resource Response","required":["token_type","expires_in","access_token"],"properties":{"token_type":{"description":"Type of the access token. Always `Bearer`.","type":"string","enum":["Bearer"],"nullable":false},"expires_in":{"description":"Number of seconds until the access token expires.","type":"number","nullable":false},"access_token":{"description":"Access token to send in the `Authorization` header.","type":"string","nullable":false}},"type":"object"}}}}
```

## The BrandResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"BrandResource":{"title":"Brand Resource","required":["id","name","slug","is_default","configuration","fonts","created_at","updated_at"],"properties":{"id":{"description":"Brand ID.","type":"string","nullable":false},"name":{"description":"Brand name.","type":"string","nullable":false},"slug":{"description":"Brand slug.","type":"string","nullable":false},"is_default":{"description":"Whether this brand is the default for the account.","type":"boolean","nullable":false},"configuration":{"description":"Brand configuration data.","properties":{"logo":{"description":"Logo configuration.","properties":{"url":{"description":"Logo URL location.","type":"string","nullable":true},"size":{"description":"Logo size.","type":"string","enum":["default","small","large"],"nullable":true}},"type":"object","nullable":true},"inputs":{"description":"Inputs configuration.","properties":{"text":{"description":"Text input configuration.","properties":{"corners":{"description":"Corner style.","type":"string","enum":["square","curved","round"],"nullable":true},"border-color":{"description":"Border hex colour.","type":"string","nullable":true},"background-color":{"description":"Background hex colour.","type":"string","nullable":true},"border-color-focus":{"description":"Border hex colour on focus.","type":"string","nullable":true}},"type":"object","nullable":true},"checkboxes":{"description":"Checkbox input configuration.","properties":{"icon-color":{"description":"Icon hex colour.","type":"string","nullable":true},"background-color-focus":{"description":"Background hex colour on focus.","type":"string","nullable":true}},"type":"object","nullable":true}},"type":"object","nullable":true},"buttons":{"description":"Buttons configuration.","properties":{"primary_button":{"description":"Primary button configuration.","properties":{"glow":{"description":"Whether the button has a glow effect.","type":"boolean","nullable":true},"color":{"description":"Text hex colour.","type":"string","nullable":true},"corners":{"description":"Corner style.","type":"string","enum":["square","curved","round"],"nullable":true},"border-color":{"description":"Border hex colour.","type":"string","nullable":true},"background-color":{"description":"Background hex colour.","type":"string","nullable":true}},"type":"object","nullable":true},"secondry_button":{"description":"Secondary button configuration. The property name is spelled this way in the API.","properties":{"glow":{"description":"Whether the button has a glow effect.","type":"boolean","nullable":true},"corners":{"description":"Corner style.","type":"string","enum":["square","curved","round"],"nullable":true},"border-color":{"description":"Border hex colour.","type":"string","nullable":true},"background-color":{"description":"Background hex colour.","type":"string","nullable":true}},"type":"object","nullable":true}},"type":"object","nullable":true}},"type":"object","nullable":false},"fonts":{"description":"Fonts configured for the brand, keyed by font type.","type":"object","nullable":false},"created_at":{"description":"Date and time the brand was created.","type":"string","nullable":false},"updated_at":{"description":"Date and time the brand was last updated.","type":"string","nullable":false}},"type":"object"}}}}
```

## The ChecklistResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"ChecklistResource":{"title":"Checklist Resource","required":["id","name"],"properties":{"id":{"description":"Checklist ID.","type":"number","nullable":false},"name":{"description":"Name of the checklist.","type":"string","nullable":false},"sections":{"description":"Sections of the checklist.","type":"array","items":{"properties":{"id":{"description":"Section ID.","type":"number","nullable":false},"name":{"description":"Name of the section.","type":"string","nullable":false},"tasks":{"description":"Tasks in the section.","type":"array","items":{"properties":{"id":{"description":"Task ID.","type":"number","nullable":false},"name":{"description":"Name of the task.","type":"string","nullable":false},"team":{"description":"Team the task is assigned to.","properties":{"id":{"description":"Team ID.","type":"number","nullable":false},"name":{"description":"Name of the team.","type":"string","nullable":false},"members_count":{"description":"Number of members in the team.","type":"number","nullable":false}},"type":"object","nullable":true}},"type":"object"}},"status":{"description":"Status of the section: `exempt`, `failed`, `passed` or `needs_review`.","type":"string","enum":["exempt","failed","passed","needs_review"],"nullable":false},"total_comments":{"description":"Total number of comments on the section.","type":"number","nullable":false},"member_belongs_to_team":{"description":"Whether the authenticated user is a member of the team the task is assigned to.","type":"boolean","nullable":false}},"type":"object"}},"uncompleted_tasks":{"description":"Number of tasks that have not yet been marked `Passed`, `Needs review` or `Failed`.","type":"number","nullable":false},"completed_tasks":{"description":"Number of tasks that have been marked `Passed`, `Needs review` or `Failed`, across all sections.","type":"number","nullable":false}},"type":"object"}}}}
```

## The BinaryFile object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"BinaryFile":{"title":"Binary File","type":"string","format":"binary"}}}}
```

## The DocumentLibraryListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"DocumentLibraryListResponse":{"title":"Document Library List Response","required":["id","name","type","label"],"properties":{"id":{"description":"Library ID.","type":"number","nullable":false},"name":{"description":"Name of the document library.","type":"string","nullable":false},"type":{"description":"Type of the document library.","type":"string","nullable":false},"label":{"description":"Display label of the document library.","type":"string","nullable":false}},"type":"object"}}}}
```

## The DocumentListResponse object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"DocumentListResponse":{"title":"Document List Response","required":["id","profile_id","library_id","category","name","created_at","updated_at"],"properties":{"id":{"description":"Document ID.","type":"number","nullable":false},"profile_id":{"description":"UUID of the profile the document belongs to.","type":"string","nullable":false},"library_id":{"description":"ID of the document library the document belongs to.","type":"string","nullable":false},"category":{"description":"Category of the document.","type":"string","nullable":false},"name":{"description":"Name of the document.","type":"string","nullable":false},"updated_at":{"description":"Date and time the document was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the document was created.","type":"string","nullable":false}},"type":"object"}}}}
```

## The DocumentViewResponse object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"DocumentViewResponse":{"title":"Document View Response","required":["id","profile_id","document_id","category","name","link","file_type","link_expires_at","created_at","updated_at"],"properties":{"id":{"description":"Document ID.","type":"number","nullable":false},"profile_id":{"description":"UUID of the profile the document belongs to.","type":"string","nullable":false},"document_id":{"description":"ID of the document type.","type":"string","nullable":false},"category":{"description":"Category of the document.","type":"string","nullable":false},"name":{"description":"Name of the document.","type":"string","nullable":false},"link":{"description":"Temporary URL to download the document. It stops working at the time given in `link_expires_at`.","type":"string","nullable":false},"file_type":{"description":"File type of the document.","type":"string","nullable":false},"link_expires_at":{"description":"Date and time at which `link` expires.","type":"string","nullable":false},"fraud_check":{"description":"Results of the AI fraud analysis of the document.","properties":{"processed_at":{"description":"Date and time the fraud analysis was processed.","type":"string","nullable":true},"analysis":{"description":"Details of the fraud analysis.","properties":{"score":{"description":"Fraud risk category of the document, for example `low`.","type":"string"},"document_type":{"description":"Type of document identified, in plain language.","type":"string"},"meta_data":{"description":"Metadata embedded in the document.","properties":{"producer":{"description":"Software that produced the file, from its metadata.","type":"string","nullable":true},"creator":{"description":"Software that created the original document, from its metadata.","type":"string","nullable":true},"creation_date":{"description":"Date the document was created, from its metadata.","type":"string","nullable":true},"mod_date":{"description":"Date the document was last modified, from its metadata.","type":"string","nullable":true},"author":{"description":"Author of the document, from its metadata.","type":"string","nullable":true},"keywords":{"description":"Keywords in the document metadata, separated by commas.","type":"string","nullable":true},"subject":{"description":"Subject of the document, from its metadata.","type":"string","nullable":true},"title":{"description":"Title of the document, from its metadata.","type":"string","nullable":true}},"type":"object"},"indicators":{"description":"Fraud indicators detected in the document.","type":"array","items":{"properties":{"type":{"description":"Type of fraud indicator, for example `anomaly`.","type":"string"},"category":{"description":"Category of the fraud indicator, for example `image_manipulation`.","type":"string"},"title":{"description":"Short title of the fraud indicator.","type":"string"},"description":{"description":"Explanation of what was detected.","type":"string"}},"type":"object"}}},"type":"object","nullable":true}},"type":"object","nullable":true},"translation":{"description":"Translation of the document.","properties":{"status":{"description":"Status of the translation.","type":"string","nullable":true},"link":{"description":"Temporary URL to download the translated document. It stops working at the time given in `link_expires_at`.","type":"string","nullable":true},"file_type":{"description":"File type of the translated document.","type":"string","nullable":true},"link_expires_at":{"description":"Date and time at which `link` expires.","type":"string","nullable":true},"extracted":{"description":"Translated text of the document.","type":"string","nullable":true}},"type":"object","nullable":true},"ocr":{"description":"Text extracted from the original document using OCR.","properties":{"extracted":{"description":"Text extracted from the document.","type":"string","nullable":true}},"type":"object","nullable":true},"updated_at":{"description":"Date and time the document was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the document was created.","type":"string","nullable":false}},"type":"object"}}}}
```

## The AssignFormToProfileRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"AssignFormToProfileRequest":{"title":"Assign Form To Profile Request","required":["id"],"properties":{"id":{"description":"ID of the form to assign.","type":"number","nullable":false}},"type":"object"}}}}
```

## The EntityFormResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"EntityFormResource":{"title":"Assigned Form Resource","required":["id","label","answers","updated_at","created_at"],"properties":{"id":{"description":"Form ID.","type":"number","nullable":false},"label":{"description":"Label of the form.","type":"string","nullable":false},"reference":{"description":"Reference of the form.","type":"string","nullable":false},"answers":{"description":"Answers given to the form.","type":"array","items":{"properties":{"label":{"description":"Label of the question.","type":"string","nullable":false},"answer":{"description":"Answer given.","type":"string","nullable":false}},"type":"object"}},"updated_at":{"description":"Date and time the form was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the form was created.","type":"string","nullable":false}},"type":"object"}}}}
```

## The FormResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"FormResource":{"title":"Form Resource","required":["id","label","version","provider","archived","updated_at","created_at"],"properties":{"id":{"description":"Form ID.","type":"number","nullable":false},"label":{"description":"Label of the form.","type":"string","nullable":false},"reference":{"description":"Reference of the form.","type":"string","nullable":true},"version":{"description":"Latest version of the form.","type":"number","nullable":false},"provider":{"description":"Form provider.","type":"string","enum":["vueform"],"nullable":false},"schema":{"description":"Schema of the form. Its structure is specific to the provider and is not normalised.","type":"array","items":{"type":"object","additionalProperties":true},"default":[],"nullable":false},"sections":{"description":"Sections of the form. Their structure is specific to the provider and is not normalised.","type":"array","items":{"type":"object","additionalProperties":true},"default":[],"nullable":false},"archived":{"description":"Whether the form is archived.","type":"boolean","enum":[false,true],"nullable":false},"updated_at":{"description":"Date and time the form was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the form was created.","type":"string","nullable":false}},"type":"object"}}}}
```

## The ShortFormResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"ShortFormResource":{"title":"Short Form Resource","required":["id","label","version","provider","archived","updated_at","created_at"],"properties":{"id":{"description":"Form ID.","type":"number","nullable":false},"label":{"description":"Label of the form.","type":"string","nullable":false},"reference":{"description":"Reference of the form.","type":"string","nullable":true},"version":{"description":"Latest version of the form.","type":"number","nullable":false},"provider":{"description":"Form provider.","type":"string","enum":["vueform"],"nullable":false},"archived":{"description":"Whether the form is archived.","type":"boolean","enum":[false,true],"nullable":false},"updated_at":{"description":"Date and time the form was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the form was created.","type":"string","nullable":false}},"type":"object"}}}}
```

## The OnboardingSubmissionCreateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"OnboardingSubmissionCreateRequest":{"title":"Onboarding Submission Create Request","required":["representative_id"],"properties":{"representative_id":{"description":"UUID of the declaratory representative submitting the profile.","type":"string","format":"uuid","nullable":false}},"type":"object"}}}}
```

## The OnboardingStatusResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"OnboardingStatusResource":{"title":"Onboarding Status Resource","properties":{"data":{"description":"List of onboarding steps and their statuses.","type":"array","items":{"properties":{"code":{"description":"Code for the step.","type":"string","nullable":false},"title":{"description":"Step title.","type":"string","nullable":false},"status":{"description":"Status of the step: `pending`, `in-progress`, `in-complete` or `completed`.","type":"string","enum":["pending","completed","in-progress","in-complete"],"nullable":false}},"type":"object"}}},"type":"object"}}}}
```

## The OnboardingSubmissionResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"OnboardingSubmissionResource":{"title":"Onboarding Submission Resource","properties":{"data":{"description":"The created submission.","properties":{"declared_at":{"description":"Date and time the submission was made.","type":"string","nullable":false},"representative_id":{"description":"UUID of the declaratory representative who submitted.","type":"string","format":"uuid","nullable":false}},"type":"object"}},"type":"object"}}}}
```

## The PersonCreateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"PersonCreateRequest":{"title":"Representative Create Request","required":["types","email","name","profile_id"],"properties":{"name":{"description":"Name of the representative.","required":["first_name","last_name"],"properties":{"first_name":{"description":"First name.","type":"string","nullable":false},"middle_name":{"description":"Middle name.","type":"string","nullable":false},"last_name":{"description":"Last name.","type":"string","nullable":false}},"type":"object","nullable":false},"email":{"description":"Email address of the representative.","type":"string","nullable":false},"title":{"description":"Title of the representative.","type":"string","enum":["Mr","Mrs","Ms","Miss","Mx","Dr","Rev"],"nullable":true},"profile_id":{"description":"ID of the profile to link the representative to.","type":"string","nullable":false},"review_status":{"description":"Review status of the representative.","type":"string","enum":["pending","needs_review","verified","rejected","fraud","additional_information","previously_verified"],"nullable":true},"types":{"description":"Types assigned to the representative. A representative can have more than one type.","type":"array","items":{"type":"string","enum":["director","identity","ownership","declaratory","principal","director_company","treasurer","secretary","syndicator","member","agent","designated_member","club_manager","authorised_representative","authorised_signatory","trustee_company","trustee","partner_company","partner","syndicate_manager","individual","lead_partner","shareholder","shareholder_company","shareholder_entity"]},"nullable":false},"dob":{"description":"Date of birth, in `YYYY-MM-DD` format.","type":"string","nullable":false},"role_type":{"description":"Role type of the representative.","type":"array","items":{"type":"string","enum":["Director","Designated Member","Partner","Company Principal","Other"]},"nullable":false},"professional_profile":{"description":"URL of the representative's professional profile.","type":"string","nullable":false},"job_title":{"description":"Job title.","type":"string","nullable":false},"residence_country_code":{"description":"Country of residence, ISO 3166-1 alpha-2 country code.","type":"string","nullable":false},"birth_country_code":{"description":"Country of birth, ISO 3166-1 alpha-2 country code.","type":"string","nullable":false},"nationality":{"description":"Nationality of the representative.","type":"string","nullable":false},"address":{"description":"Address of the representative.","properties":{"apartment_number":{"description":"Apartment number.","type":"string","nullable":false},"address_1":{"description":"First line of the address.","type":"string","nullable":false},"address_2":{"description":"Second line of the address.","type":"string","nullable":false},"city":{"description":"City.","type":"string","nullable":false},"state":{"description":"State or region.","type":"string","nullable":false},"postcode":{"description":"Postcode.","type":"string","nullable":false},"country":{"description":"Country of the address, ISO 3166-1 alpha-2 country code.","type":"string","nullable":false}},"type":"object","nullable":false},"personal_number":{"description":"Personal phone number.","type":"string","nullable":false},"shareholder_type":{"description":"Type of shareholding: `Direct` or `Indirect`.","type":"string","enum":["Direct","Indirect"],"nullable":false},"share_percentage":{"description":"Percentage of shares held by the representative.","type":"number","nullable":false}},"type":"object"}}}}
```

## The PersonLoginLinkCreateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"PersonLoginLinkCreateRequest":{"title":"Representative Login Link Create Request","required":["purpose"],"properties":{"purpose":{"description":"Purpose of the login link. Currently only `verify` is supported.","type":"string","enum":["verify"],"nullable":false}},"type":"object"}}}}
```

## The PersonUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"PersonUpdateRequest":{"title":"Representative Update Request","description":"Changes to a representative. All fields are optional; omitted fields keep their current values.","properties":{"name":{"description":"Name of the representative.","properties":{"first_name":{"description":"First name.","type":"string","nullable":false},"middle_name":{"description":"Middle name.","type":"string","nullable":false},"last_name":{"description":"Last name.","type":"string","nullable":false}},"type":"object","nullable":false},"email":{"description":"Email address of the representative.","type":"string","nullable":false},"title":{"description":"Title of the representative.","type":"string","enum":["Mr","Mrs","Ms","Miss","Mx","Dr","Rev"],"nullable":true},"review_status":{"description":"Review status of the representative.","type":"string","enum":["pending","needs_review","verified","rejected","fraud","additional_information","previously_verified"],"nullable":true},"types":{"description":"Types assigned to the representative. A representative can have more than one type. Types sent here are added to the representative's existing types.","type":"array","items":{"type":"string","enum":["director","identity","ownership","declaratory","principal","director_company","treasurer","secretary","syndicator","member","agent","designated_member","club_manager","authorised_representative","authorised_signatory","trustee_company","trustee","partner_company","partner","syndicate_manager","individual","lead_partner","shareholder","shareholder_company","shareholder_entity"]},"nullable":false},"dob":{"description":"Date of birth, in `YYYY-MM-DD` format.","type":"string","nullable":false},"role_type":{"description":"Role type of the representative.","type":"array","items":{"type":"string","enum":["Director","Designated Member","Partner","Company Principal","Other"]},"nullable":false},"professional_profile":{"description":"URL of the representative's professional profile.","type":"string","nullable":false},"job_title":{"description":"Job title.","type":"string","nullable":false},"residence_country_code":{"description":"Country of residence, ISO 3166-1 alpha-2 country code.","type":"string","nullable":false},"birth_country_code":{"description":"Country of birth, ISO 3166-1 alpha-2 country code.","type":"string","nullable":false},"nationality":{"description":"Nationality of the representative.","type":"string","nullable":false},"address":{"description":"Address of the representative.","properties":{"apartment_number":{"description":"Apartment number.","type":"string","nullable":false},"address_1":{"description":"First line of the address.","type":"string","nullable":false},"address_2":{"description":"Second line of the address.","type":"string","nullable":false},"city":{"description":"City.","type":"string","nullable":false},"state":{"description":"State or region.","type":"string","nullable":false},"postcode":{"description":"Postcode.","type":"string","nullable":false},"country":{"description":"Country of the address, ISO 3166-1 alpha-2 country code.","type":"string","nullable":false}},"type":"object","nullable":false},"personal_number":{"description":"Personal phone number.","type":"string","nullable":false},"shareholder_type":{"description":"Type of shareholding: `Direct` or `Indirect`.","type":"string","enum":["Direct","Indirect"],"nullable":false},"share_percentage":{"description":"Percentage of shares held by the representative.","type":"number","nullable":false}},"type":"object"}}}}
```

## The VerifyConfigurationUpsertRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"VerifyConfigurationUpsertRequest":{"title":"Verify Configuration Update Request","description":"Changes to the verification flow configuration of a representative. All fields are optional; omitted fields keep the values of the currently resolved configuration.","properties":{"forms":{"description":"Forms step configuration.","properties":{"enable":{"description":"Whether the representative is asked to complete forms.","type":"boolean"},"ids":{"description":"Ids of the forms assigned to the representative.","type":"array","items":{"type":"integer"}}},"type":"object"},"id3":{"description":"ID3 identity check step configuration.","properties":{"enable":{"description":"Whether the ID3 identity check is performed.","type":"boolean"}},"type":"object"},"personal_information":{"description":"Personal information (edit details) step configuration. `enable` is required when this object is sent.","required":["enable"],"properties":{"enable":{"description":"Whether the representative is asked to review and edit their personal information.","type":"boolean"}},"type":"object"},"id_document":{"description":"ID verification (document) step configuration.","properties":{"enable":{"description":"Whether the representative is asked to verify an identity document.","type":"boolean"}},"type":"object"}},"type":"object"}}}}
```

## The PersonLinkLoginResourceResponse object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"PersonLinkLoginResourceResponse":{"title":"Representative Login Link Resource","required":["purpose","link","expires_at"],"properties":{"purpose":{"description":"Purpose the login link was created for.","type":"string","enum":["verify"],"nullable":false},"link":{"description":"URL the representative uses to sign in.","type":"string","nullable":false},"expires_at":{"description":"Date and time at which the link expires.","type":"string","nullable":false}},"type":"object"}}}}
```

## The RepresentativesResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"RepresentativesResource":{"title":"Representative Resource","required":["id","profile_id","customer_reference","is_company","types"],"properties":{"id":{"description":"Representative UUID.","type":"string","nullable":false},"profile_id":{"description":"ID of the profile the representative is linked to.","type":"string","nullable":false},"customer_reference":{"description":"The customer reference of the profile the representative belongs to, as set when the profile was created.","type":"string","nullable":false},"is_company":{"description":"Whether the representative is a legal entity (`true`) or a natural person (`false`).","type":"boolean","nullable":false},"is_linked":{"description":"Whether the representative is linked to another representative record, either as the master or as a child of a link.","type":"boolean","nullable":false},"is_master_link":{"description":"Whether the representative is the master record of a representative link, i.e. other representative records are linked to it.","type":"boolean","nullable":false},"is_child_link":{"description":"Whether the representative is linked to a master representative record.","type":"boolean","nullable":false},"review_status":{"description":"Review status of the representative.","properties":{"status":{"description":"Current review status.","type":"string","enum":["pending","needs_review","verified","rejected","fraud","additional_information","previously_verified"],"nullable":false},"verified_at":{"description":"Date and time the representative was verified, or `null` if they have not been verified.","type":"string","nullable":true},"updated_at":{"description":"Date and time the review status was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the review status was created.","type":"string","nullable":false}},"type":"object","nullable":true},"types":{"description":"Types assigned to the representative.","type":"array","items":{"type":"string","enum":["director","identity","ownership","declaratory","principal","director_company","treasurer","secretary","syndicator","member","agent","designated_member","club_manager","authorised_representative","authorised_signatory","trustee_company","trustee","partner_company","partner","syndicate_manager","individual","lead_partner","shareholder","shareholder_company","shareholder_entity"]},"nullable":false},"role_type":{"description":"Role types assigned to the representative: `Director`, `Designated Member`, `Partner`, `Company Principal` or `Other`.","type":"array","items":{"type":"string"},"nullable":true},"full_name":{"description":"Full name of the representative, or the company/legal entity name.","type":"string","nullable":true},"title":{"description":"Title of the representative, for example `Mr` or `Dr`.","type":"string","nullable":true},"professional_profile":{"description":"URL of the representative's professional profile.","type":"string","nullable":true},"country":{"description":"Name of the country of the address.","type":"string","nullable":true},"country_code":{"description":"Country of the address, ISO 3166-1 alpha-2 country code.","type":"string","nullable":true},"country_of_residence":{"description":"Name of the country of residence.","type":"string","nullable":true},"residence_country_code":{"description":"Country of residence, ISO 3166-1 alpha-2 country code.","type":"string","nullable":true},"personal_number":{"description":"Personal phone number.","type":"string","nullable":true},"first_name":{"description":"First name.","type":"string","nullable":true},"middle_name":{"description":"Middle name.","type":"string","nullable":true},"last_name":{"description":"Last name.","type":"string","nullable":true},"dob":{"description":"Date of birth, in `YYYY-MM-DD` format.","type":"string","nullable":true},"email":{"description":"Email address of the representative.","type":"string","nullable":true},"job_title":{"description":"Job title.","type":"string","nullable":true},"social_security_number":{"description":"US Social Security number of the representative, in the format `XXX-XX-XXXX`.","type":"string","nullable":true},"social_security_number_last_4":{"description":"Last 4 digits of the representative's US Social Security number.","type":"string","nullable":true},"passport_number":{"description":"Passport number.","type":"string","nullable":true},"landline_number":{"description":"Landline phone number.","type":"string","nullable":true},"apartment_number":{"description":"Apartment number.","type":"string","nullable":true},"address_1":{"description":"First line of the address.","type":"string","nullable":true},"address_2":{"description":"Second line of the address.","type":"string","nullable":true},"city":{"description":"City.","type":"string","nullable":true},"state":{"description":"State or region.","type":"string","nullable":true},"post_code":{"description":"Postcode.","type":"string","nullable":true},"country_of_birth":{"description":"Name of the country of birth.","type":"string","nullable":true},"birth_country_code":{"description":"Country of birth, ISO 3166-1 alpha-2 country code.","type":"string","nullable":true},"share_percentage":{"description":"Percentage of shares held by the representative.","type":"number","nullable":true},"shareholder_type":{"description":"Type of shareholding. `Direct` or `Indirect` for representatives created through the API; representatives imported from a data source may carry provider-specific values.","type":"string","nullable":true},"nationality":{"description":"Nationality.","type":"string","nullable":true},"nationality_code":{"description":"Nationality, ISO 3166-1 alpha-2 country code.","type":"string","nullable":true},"person_type_details":{"description":"Extra details that depend on the representative's type, such as the appointment date or ownership percentage.","properties":{"appointment_date":{"description":"Date the representative was appointed.","type":"string","nullable":true},"majority":{"description":"Whether the representative's ownership meets the majority threshold given in `majority_percentage`.","type":"boolean","nullable":true},"governing":{"description":"Whether the representative has a governing role.","type":"boolean","nullable":true},"responsibility":{"description":"Whether the representative has significant responsibility.","type":"boolean","nullable":true},"majority_percentage":{"description":"The majority ownership threshold percentage, taken from the portal configuration.","type":"string","nullable":true},"specific_ownership_percentage":{"description":"Percentage of the company owned by the representative.","type":"string","nullable":true}},"type":"object","nullable":true},"copy_address":{"description":"Whether the trading address is the same as the registered address. Only set for `director_company` representatives.","type":"boolean","nullable":true},"updated_at":{"description":"Date and time the representative was last updated.","type":"string","nullable":true},"created_at":{"description":"Date and time the representative was created.","type":"string","nullable":true},"screenings":{"description":"AML screening results for the representative.","properties":{"details":{"description":"Details of the screening search that was performed.","properties":{"provider":{"description":"Screening provider the search was performed with.","type":"string","enum":["ion_group","comply_advantage","lseg_zfs"],"nullable":false},"performed_at":{"description":"Date the screening was performed.","type":"string","nullable":false},"search_term":{"description":"Term the representative was searched with against the provider.","type":"string","nullable":false},"search_payload":{"description":"Search request sent to the provider; its shape is provider-specific.","type":"object","nullable":true},"is_monitored":{"description":"Whether the representative is enrolled in ongoing monitoring with the provider.","type":"boolean","nullable":false}},"type":"object","nullable":false},"screenings":{"description":"List of screening matches returned by the provider.","type":"array","items":{"type":"object"},"nullable":true}},"type":"object","nullable":true}},"type":"object"}}}}
```

## The PersonVerificationsResourceResponse object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"PersonVerificationsResourceResponse":{"title":"Representative Verifications Resource Response","required":["type","info","provider"],"properties":{"type":{"description":"The type of verification.","type":"string","enum":["idv","id3","digital_foot_print"],"nullable":false},"provider":{"description":"The provider that carried out the verification.","type":"string","enum":["id_scan","yoti","risk_seal","id3"],"nullable":false},"info":{"description":"The provider's result. Its structure depends on the provider and may change without notice.","type":"object","nullable":false}},"type":"object"}}}}
```

## The PersonVerifyConfigurationVersionResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"PersonVerifyConfigurationVersionResource":{"title":"Verify Configuration Version","required":["id3","id_document","forms","personal_information"],"properties":{"people_types":{"description":"People types the configuration applies to. Only returned when the configuration type includes people types.","properties":{"enabled":{"type":"boolean"},"data":{"type":"array","items":{"properties":{"id":{"type":"integer"},"label":{"type":"string"},"type":{"type":"string"}},"type":"object"}}},"type":"object"},"id3":{"description":"ID3 identity check step.","properties":{"enabled":{"type":"boolean"}},"type":"object"},"id_document":{"description":"ID verification (document) step.","properties":{"enabled":{"type":"boolean"},"options":{"properties":{"fallback":{"properties":{"enabled":{"type":"boolean"}},"type":"object"},"liveness":{"properties":{"enabled":{"type":"boolean"}},"type":"object"},"facematch":{"properties":{"enabled":{"type":"boolean"}},"type":"object"},"document_upload":{"properties":{"enabled":{"type":"boolean"}},"type":"object"}},"type":"object"}},"type":"object"},"forms":{"description":"Forms step. `enabled` is true when the configuration version has forms assigned.","properties":{"enabled":{"type":"boolean"},"data":{"description":"Forms assigned to the representative.","type":"array","items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"reference":{"type":"string"}},"type":"object"}}},"type":"object"},"personal_information":{"description":"Personal information (edit details) step.","properties":{"enabled":{"type":"boolean"},"data":{"description":"People models defining the editable fields per people type.","type":"array","items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"code":{"description":"People type the model applies to.","type":"string"}},"type":"object"}}},"type":"object"}},"type":"object"}}}}
```

## The PersonVerifyDataConfigurationResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"PersonVerifyDataConfigurationResource":{"title":"Verify Configuration","required":["people_types","id3","id_document","forms","personal_information"],"properties":{"people_types":{"description":"The people types of the representative.","type":"array","items":{"properties":{"id":{"type":"integer"},"label":{"type":"string"},"type":{"type":"string"}},"type":"object"}},"id3":{"description":"ID3 identity check step.","properties":{"enabled":{"type":"boolean"}},"type":"object"},"id_document":{"description":"ID verification (document) step.","properties":{"enabled":{"type":"boolean"},"options":{"properties":{"fallback":{"properties":{"enabled":{"type":"boolean"}},"type":"object"},"liveness":{"properties":{"enabled":{"type":"boolean"}},"type":"object"},"facematch":{"properties":{"enabled":{"type":"boolean"}},"type":"object"},"document_upload":{"properties":{"enabled":{"type":"boolean"}},"type":"object"}},"type":"object"}},"type":"object"},"forms":{"description":"Forms step. `enabled` is true when the resolved configuration has forms assigned.","properties":{"enabled":{"type":"boolean"},"data":{"description":"Forms assigned to the representative.","type":"array","items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"reference":{"type":"string"}},"type":"object"}}},"type":"object"},"personal_information":{"description":"Personal information (edit details) step.","properties":{"enabled":{"type":"boolean"},"data":{"description":"People models defining the editable fields per people type.","type":"array","items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"code":{"description":"People type the model applies to.","type":"string"}},"type":"object"}}},"type":"object"}},"type":"object"}}}}
```

## The ProfilePortalConfigurationUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"ProfilePortalConfigurationUpdateRequest":{"title":"Profile Portal Configuration Update Request","properties":{"forms":{"description":"Form settings for the portal configuration.","properties":{"enabled":{"description":"Whether the forms section is shown in the portal.","type":"boolean","nullable":false},"form_ids":{"description":"IDs of the forms to assign to the configuration, or `null` to remove all forms.","type":"array","items":{"type":"number"},"nullable":true}},"type":"object","nullable":false}},"type":"object"}}}}
```

## The PortalConfigurationResponse object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"PortalConfigurationResponse":{"title":"Portal Configuration Resource","required":["id","name","updated_at","created_at"],"properties":{"id":{"description":"Portal configuration ID.","type":"number","nullable":false},"name":{"description":"Portal configuration name.","type":"string","nullable":false},"updated_at":{"description":"Date and time the portal configuration was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the portal configuration was created.","type":"string","nullable":false}},"type":"object"}}}}
```

## The ProfilePortalConfigurationResourceResponse object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"ProfilePortalConfigurationResourceResponse":{"title":"Profile Portal Configuration Response","properties":{"declaratory":{"description":"Declaratory settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"text":{"description":"Text of the declaration shown to the representative who submits the profile.","type":"string","nullable":true}},"type":"object","nullable":false},"document":{"description":"Document settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"documents":{"description":"List of documents.","type":"array","items":{"properties":{"uuid":{"description":"UUID of the document.","type":"string","nullable":false},"name":{"description":"Name of the document.","type":"string","nullable":false},"description":{"description":"Description of the document.","type":"string","nullable":false},"required":{"description":"Whether the customer must provide the document.","type":"boolean","nullable":false},"example_document":{"description":"Example of the document, shown to the customer.","type":"array","items":{"properties":{"options":{"description":"Example document options.","type":"array","items":{"type":"string"},"nullable":true},"document":{"description":"Example Document.","type":"string","nullable":false}},"type":"object"}}},"type":"object"}}},"type":"object","nullable":false},"advanced_documents":{"description":"Advanced documents settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"config_ids":{"description":"IDs of the advanced document configurations.","type":"array","items":{"type":"number"},"nullable":true}},"type":"object","nullable":true},"identity":{"description":"Identity settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false}},"type":"object","nullable":false},"director":{"description":"Director settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"enable_director_country_of_birth":{"description":"Whether the country of birth is collected for each director.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"max_number":{"description":"Maximum number of directors that can be added.","type":"number","nullable":true},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"director_company":{"description":"Company director settings.","properties":{"max_number":{"description":"Maximum number of company directors that can be added.","type":"number","nullable":true},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false}},"type":"object","nullable":false}},"type":"object","nullable":false},"submitter":{"description":"Submitter settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false}},"type":"object","nullable":false},"ownership":{"description":"Ownership settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"enable_ownership_percentage":{"description":"Whether the ownership percentage is collected for each owner.","type":"boolean","nullable":false},"enable_owner_country_of_birth":{"description":"Whether the country of birth is collected for each owner.","type":"boolean","nullable":false},"ownership_percentage":{"description":"Ownership percentage at or above which a representative is treated as an owner.","type":"string","nullable":false},"max_number":{"description":"Maximum number of owners that can be added.","type":"number","nullable":true},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false}},"type":"object","nullable":false},"company_principals":{"description":"Company principal settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of company principals that can be added.","type":"number","nullable":true}},"type":"object","nullable":false},"authorised_representative":{"description":"Authorised representative settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of authorised representatives that can be added.","type":"number","nullable":true}},"type":"object","nullable":false},"authorised_signatory":{"description":"Authorised signatory settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of authorised signatories that can be added.","type":"number","nullable":true}},"type":"object","nullable":false},"treasurer":{"description":"Treasurer settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of treasurers that can be added.","type":"number","nullable":true}},"type":"object","nullable":false},"secretary":{"description":"Secretary settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of secretaries that can be added.","type":"number","nullable":true}},"type":"object","nullable":false},"syndicator":{"description":"Syndicator settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of syndicators that can be added.","type":"number","nullable":true}},"type":"object","nullable":false},"member":{"description":"Member settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of members that can be added.","type":"number","nullable":true}},"type":"object","nullable":false},"agent":{"description":"Agent settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of agents that can be added.","type":"number","nullable":true}},"type":"object","nullable":false},"designated_member":{"description":"Designated member settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of designated members that can be added.","type":"number","nullable":true}},"type":"object","nullable":false},"club_manager":{"description":"Club manager settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of club managers that can be added.","type":"number","nullable":true}},"type":"object","nullable":false},"trustee":{"description":"Trustee settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"max_number":{"description":"Maximum number of trustees that can be added.","type":"number","nullable":true},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"trustee_company":{"description":"Trustee company settings.","properties":{"max_number":{"description":"Maximum number of trustee companies that can be added.","type":"number","nullable":true},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false}},"type":"object","nullable":false}},"type":"object","nullable":false},"partner":{"description":"Partner settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"max_number":{"description":"Maximum number of partners that can be added.","type":"number","nullable":true},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"partner_company":{"description":"Partner company settings.","properties":{"max_number":{"description":"Maximum number of partner companies that can be added.","type":"number","nullable":true},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false}},"type":"object","nullable":false}},"type":"object","nullable":false},"syndicate_manager":{"description":"Syndicate manager settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of syndicate managers that can be added.","type":"number","nullable":true}},"type":"object","nullable":false},"individual":{"description":"Individual representative settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of individual representatives that can be added.","type":"number","nullable":true}},"type":"object","nullable":false},"lead_partner":{"description":"Lead partner settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"people_model":{"description":"Representative model ID.","properties":{"id":{"description":"Model ID.","type":"number","nullable":true}},"type":"object","nullable":false},"auto_screening":{"description":"Whether representatives added in this section are screened automatically.","type":"boolean","nullable":false},"max_number":{"description":"Maximum number of lead partners that can be added.","type":"number","nullable":true}},"type":"object","nullable":false},"additional_locations":{"description":"Additional locations settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false}},"type":"object","nullable":false},"entities":{"description":"Entities settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false}},"type":"object","nullable":false},"forms":{"description":"Forms settings.","properties":{"enabled":{"description":"Whether this section is shown in the portal.","type":"boolean","nullable":false},"form_ids":{"description":"List of form IDs.","type":"array","items":{"type":"number"},"nullable":true}},"type":"object","nullable":false}},"type":"object"}}}}
```

## The CreateProfileRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"CreateProfileRequest":{"title":"Create Profile Request","description":"Send one of two kinds of request: create a profile from a search result, or create one manually.","oneOf":[{"$ref":"#/components/schemas/CreateProfileFromSearchRequest"},{"$ref":"#/components/schemas/CreateProfileManualRequest"}]},"CreateProfileFromSearchRequest":{"title":"Create Profile From Search Request","description":"Creates a profile from a search result. Send the `lookup_id` and `response_id` of the result you want. The company details come from the search result, so you cannot send them yourself.","required":["customer_reference","lookup_id","response_id"],"properties":{"type":{"description":"Entity type of the profile.","type":"string","enum":["company","sole_trader","partnership","charity","government_entity","incorporated_syndicate","company_syndicate","syndicate","association","trust","fund","club","individual","joint_individual"],"nullable":false},"lookup_id":{"description":"Lookup ID from a `POST /search` response. Send it with `response_id` to create the profile from a search result.","type":"integer","nullable":false},"response_id":{"description":"ID of the search result to create the profile from. Send it with `lookup_id`.","type":"integer","nullable":false},"customer_reference":{"description":"Your unique reference for the profile.","type":"string","nullable":false},"brand_id":{"description":"Brand UUID to assign to the profile.","type":"string","format":"uuid","nullable":true},"domain":{"description":"Company domain, without protocol or path, for example `detected.co`.","type":"string","nullable":false}},"type":"object","not":{"anyOf":[{"required":["name"]},{"required":["company_number"]},{"required":["vat_number"]},{"required":["address"]}]}},"CreateProfileManualRequest":{"title":"Create Profile Manual Request","description":"Creates a profile from company details that you provide. Use this when the company cannot be found by search.","required":["customer_reference","name","address"],"properties":{"type":{"description":"Entity type of the profile.","type":"string","enum":["company","sole_trader","partnership","charity","government_entity","incorporated_syndicate","company_syndicate","syndicate","association","trust","fund","club","individual","joint_individual"],"nullable":false},"customer_reference":{"description":"Your unique reference for the profile.","type":"string","nullable":false},"brand_id":{"description":"Brand UUID to assign to the profile.","type":"string","format":"uuid","nullable":true},"company_number":{"description":"Company registration number.","type":"string","nullable":false},"name":{"description":"Company name.","type":"string","nullable":false},"vat_number":{"description":"VAT number.","type":"string","nullable":false},"domain":{"description":"Company domain, without protocol or path, for example `detected.co`.","type":"string","nullable":false},"address":{"description":"Address of the company.","required":["country_code","city"],"properties":{"line_1":{"description":"First line of the address.","type":"string","nullable":false},"line_2":{"description":"Second line of the address.","type":"string","nullable":false},"country_code":{"description":"Country of the address, ISO 3166-1 alpha-2 country code.","type":"string","nullable":false},"town":{"description":"Town.","type":"string","nullable":false},"city":{"description":"City.","type":"string","nullable":false},"post_code":{"description":"Postcode.","type":"string","nullable":false},"province":{"description":"Province.","type":"string","nullable":false},"state":{"description":"State or region.","type":"string","nullable":false}},"type":"object","nullable":false}},"type":"object","not":{"anyOf":[{"required":["lookup_id"]},{"required":["response_id"]}]}}}}}
```

## The CreateProfileFromSearchRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"CreateProfileFromSearchRequest":{"title":"Create Profile From Search Request","description":"Creates a profile from a search result. Send the `lookup_id` and `response_id` of the result you want. The company details come from the search result, so you cannot send them yourself.","required":["customer_reference","lookup_id","response_id"],"properties":{"type":{"description":"Entity type of the profile.","type":"string","enum":["company","sole_trader","partnership","charity","government_entity","incorporated_syndicate","company_syndicate","syndicate","association","trust","fund","club","individual","joint_individual"],"nullable":false},"lookup_id":{"description":"Lookup ID from a `POST /search` response. Send it with `response_id` to create the profile from a search result.","type":"integer","nullable":false},"response_id":{"description":"ID of the search result to create the profile from. Send it with `lookup_id`.","type":"integer","nullable":false},"customer_reference":{"description":"Your unique reference for the profile.","type":"string","nullable":false},"brand_id":{"description":"Brand UUID to assign to the profile.","type":"string","format":"uuid","nullable":true},"domain":{"description":"Company domain, without protocol or path, for example `detected.co`.","type":"string","nullable":false}},"type":"object","not":{"anyOf":[{"required":["name"]},{"required":["company_number"]},{"required":["vat_number"]},{"required":["address"]}]}}}}}
```

## The CreateProfileManualRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"CreateProfileManualRequest":{"title":"Create Profile Manual Request","description":"Creates a profile from company details that you provide. Use this when the company cannot be found by search.","required":["customer_reference","name","address"],"properties":{"type":{"description":"Entity type of the profile.","type":"string","enum":["company","sole_trader","partnership","charity","government_entity","incorporated_syndicate","company_syndicate","syndicate","association","trust","fund","club","individual","joint_individual"],"nullable":false},"customer_reference":{"description":"Your unique reference for the profile.","type":"string","nullable":false},"brand_id":{"description":"Brand UUID to assign to the profile.","type":"string","format":"uuid","nullable":true},"company_number":{"description":"Company registration number.","type":"string","nullable":false},"name":{"description":"Company name.","type":"string","nullable":false},"vat_number":{"description":"VAT number.","type":"string","nullable":false},"domain":{"description":"Company domain, without protocol or path, for example `detected.co`.","type":"string","nullable":false},"address":{"description":"Address of the company.","required":["country_code","city"],"properties":{"line_1":{"description":"First line of the address.","type":"string","nullable":false},"line_2":{"description":"Second line of the address.","type":"string","nullable":false},"country_code":{"description":"Country of the address, ISO 3166-1 alpha-2 country code.","type":"string","nullable":false},"town":{"description":"Town.","type":"string","nullable":false},"city":{"description":"City.","type":"string","nullable":false},"post_code":{"description":"Postcode.","type":"string","nullable":false},"province":{"description":"Province.","type":"string","nullable":false},"state":{"description":"State or region.","type":"string","nullable":false}},"type":"object","nullable":false}},"type":"object","not":{"anyOf":[{"required":["lookup_id"]},{"required":["response_id"]}]}}}}}
```

## The CreateProfileDomainRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"CreateProfileDomainRequest":{"title":"Create Profile Domain Request","required":["domain"],"properties":{"domain":{"description":"Domain, without protocol or path, for example `subdomain.example.com`.","type":"string","nullable":false}},"type":"object"}}}}
```

## The ProfileMonitoringActionRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"ProfileMonitoringActionRequest":{"title":"Profile Monitoring Action Request","properties":{"scope":{"description":"What to stop: `all` (company-level alert monitoring and every screening, including representatives), `alerts` (company-level alert monitoring only) or `screenings` (the profile's own screenings only).","type":"string","default":"all","enum":["all","alerts","screenings"]}},"type":"object"}}}}
```

## The ProfileUpdateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"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"}}}}
```

## The AssignProfileUserRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"AssignProfileUserRequest":{"title":"Assign Profile User Request","required":["user_id"],"properties":{"user_id":{"description":"ID of the portal user to assign to the profile.","type":"number","nullable":false},"role":{"description":"Role of the portal user on the profile. Currently only `admin` is supported, and it is the default.","type":"string","enum":["admin"],"nullable":false},"notify":{"description":"Whether to send the portal user an invitation email. The default is `true`.","type":"boolean","nullable":false}},"type":"object"}}}}
```

## The ProfileCustomFieldResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"ProfileCustomFieldResource":{"title":"Profile Custom Field Resource","required":["label","type","is_required","value"],"properties":{"label":{"description":"The custom field label.","type":"string","nullable":false},"type":{"description":"Type of the custom field.","type":"string","enum":["text","select","multi_select","date"],"nullable":false},"is_required":{"description":"Whether the custom field is required.","type":"boolean","nullable":false},"value":{"description":"The value of the custom field for this profile.","nullable":true,"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"type":"object"}}}}
```

## The ProfileListResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"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":"number","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":"number","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","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.","type":"string","nullable":false},"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"}}}}
```

## The ProfileNotificationAlertsResourceResponse object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"ProfileNotificationAlertsResourceResponse":{"title":"Profile Notification Alerts Resource Response","properties":{"id":{"description":"Alert ID.","type":"integer","nullable":false},"profile_id":{"description":"The profile ID.","type":"string","nullable":false},"attribute":{"description":"Name of the attribute that changed.","type":"string","nullable":false},"change":{"description":"Details of the change.","properties":{"current":{"description":"Value after the change.","type":"string"},"previous":{"description":"Value before the change.","type":"string"}},"type":"object","nullable":false},"acknowledged":{"description":"Acknowledgement status of the alert: `acknowledged` if a user has acknowledged the alert, `cleared` if a user has cleared it. The same values are accepted by the `acknowledged` filter on `GET /alerts`.","type":"string","enum":["acknowledged","cleared"],"nullable":false},"acknowledged_by":{"description":"The user that acknowledged the alert.","type":"string","nullable":false},"acknowledged_at":{"description":"Date and time the alert was acknowledged.","type":"string","format":"date-time","nullable":true},"created_at":{"description":"Date and time the alert was created.","type":"string","format":"date-time","nullable":false}},"type":"object"}}}}
```

## The ProfileDomainResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"ProfileDomainResource":{"title":"Profile Domain Resource","required":["id","type","domain","updated_at","created_at"],"properties":{"id":{"description":"Domain ID.","type":"string","nullable":false},"type":{"description":"Type of the domain. Either `portal` or `api_import`.","type":"string","nullable":false},"domain":{"description":"The domain name.","type":"string","nullable":false},"whois":{"description":"Details about the WHOIS information of the domain.","properties":{"status":{"description":"WHOIS status of the domain.","type":"string","nullable":true},"age":{"description":"Human readable age of domain.","type":"string","nullable":true},"ageDays":{"description":"Age of the domain in days.","type":"integer","nullable":true},"createdAt":{"description":"Creation date of the domain.","type":"string","format":"date-time","nullable":true},"updatedAt":{"description":"Last updated date of domain WHOIS details.","type":"string","format":"date-time","nullable":true},"expiresAt":{"description":"Expiry date of the domain registration.","type":"string","format":"date-time","nullable":true}},"type":"object","nullable":true},"social":{"description":"Details about the social media presence of the company.","properties":{"title":{"description":"Title representing the company's online presence.","type":"string","nullable":true},"description":{"description":"Description about the company's objective or online presence.","type":"string","nullable":true},"responded":{"description":"Indicates if the website was active during the crawling.","type":"boolean","nullable":true},"twitter":{"description":"Twitter profile URL of the company.","type":"string","nullable":true},"facebook":{"description":"Facebook profile URL of the company.","type":"string","nullable":true},"linkedIn":{"description":"LinkedIn profile URL of the company.","type":"string","nullable":true},"instagram":{"description":"Instagram profile URL of the company.","type":"string","nullable":true}},"type":"object","nullable":true},"online_presence":{"description":"Online presence details for the domain.","type":"array","items":{"properties":{"founding_year":{"description":"Year the company was founded.","type":"string","nullable":true},"phone_number":{"description":"A contact phone number for the company.","type":"string","nullable":true},"industry":{"description":"The industry of the company.","type":"string","nullable":true},"tags":{"description":"Tags describing the company.","type":"array","items":{"type":"string"},"nullable":true},"address":{"description":"The company address.","type":"string","nullable":true}},"type":"object"},"nullable":true},"scam_advisor":{"description":"Scam advisor assessment details for the given domain.","properties":{"score":{"description":"The actual Trust Score of the Domain (0 = very likely a scam, 100 = very likely legit).","type":"integer","nullable":true},"blacklisted":{"description":"Whether the domain is blacklisted.","type":"boolean","nullable":true},"dns_threat_markers":{"description":"Number of DNS services identifying the domain as containing malicious (threat) content.","type":"integer","nullable":true},"dns_adult_content_markers":{"description":"Number of DNS services identifying the domain as containing adult content.","type":"integer","nullable":true},"website_title":{"description":"The meta-title of the website obtained by the scam advisor.","type":"string","nullable":true},"website_description":{"description":"The meta-description of the website retrieved by the scam advisor.","type":"string","nullable":true},"website_keywords":{"description":"Meta-keywords defined for the website.","type":"array","items":{"type":"string"},"nullable":true},"block_search_engines":{"description":"Whether the domain has a robots.txt that blocks search engines from indexing the site.","type":"boolean","nullable":true},"reviews":{"description":"List of reviews for the domain from various sources.","type":"array","items":{"properties":{"source":{"description":"The platform from which the review is sourced (e.g., Trustpilot).","type":"string","nullable":true},"source_url":{"description":"URL to the review source.","type":"string","format":"url","nullable":true},"count":{"description":"The total number of available reviews for this domain from the review source.","type":"integer","nullable":true},"avg_score":{"description":"The average review score (normalised between 1 [very bad] and 5 [very good]).","type":"number","format":"float","nullable":true}},"type":"object"},"nullable":true},"gca_domain_trust":{"description":"Assessment details for Global Cyber Alliance domain trust metrics.","properties":{"type":{"description":"The type of rating assigned (e.g., C = Third parties like Scamadviser/Spamhaus).","type":"string","nullable":true},"activity":{"description":"Domain activity status (A = active site, S = suspended, N = non-existing).","type":"string","nullable":true},"provider":{"description":"The name of the provider reporting the domain trust analysis.","type":"string","nullable":true},"created_at":{"description":"Date and time the trust data was first provided.","type":"string","format":"date-time","nullable":true},"is_blocked":{"description":"Indicates if the domain's trust level is blocked.","type":"boolean","nullable":true},"updated_at":{"description":"Date and time the trust data was last updated.","type":"string","format":"date-time","nullable":true},"source_name":{"description":"The source of the trust data (e.g., ScamAdviser).","type":"string","nullable":true},"provider_role":{"description":"The role of the provider (e.g., registry, registrar, or other).","type":"string","nullable":true},"classification":{"description":"Classification level of trustworthiness (e.g., 1 = Definitely legitimate).","type":"integer","nullable":true},"external_source":{"description":"Indicates if the data originates from an external source.","type":"boolean","nullable":true},"provider_rating":{"description":"The internal rating of the provider's reliability.","type":"string","nullable":true}},"type":"object","nullable":true},"antiphishing":{"description":"Domain data from the eCrime Exchange.","properties":{"count":{"description":"The count of sources that flagged the domain as being used for phishing.","type":"integer","nullable":true}},"type":"object","nullable":true},"certnz":{"description":"CERT NZ marker information.","properties":{"labels":{"description":"Labels describing the possible threat(s).","type":"array","items":{"type":"string"},"nullable":true},"marking":{"description":"Classification provided by CERT NZ (e.g., amber, red).","type":"string","nullable":true}},"type":"object","nullable":true},"maltiverse":{"description":"Maltiverse classification and threat tags for the domain.","properties":{"tags":{"description":"List of threat tags identified by Maltiverse.","type":"array","items":{"type":"string"},"nullable":true},"classification":{"description":"Domain threat classification by Maltiverse.","type":"string","nullable":true}},"type":"object","nullable":true},"ipqs":{"description":"IPQS domain analysis results.","properties":{"risk_score":{"description":"Overall risk score assigned by IPQS to the domain.","type":"integer","nullable":true},"unsafe":{"description":"Indicates if the domain is flagged as unsafe by IPQS.","type":"boolean","nullable":true},"dns_valid":{"description":"Whether IPQS considers the DNS of the domain valid.","type":"boolean","nullable":true},"parking":{"description":"Whether the domain is identified as parked.","type":"boolean","nullable":true},"spamming":{"description":"Indicates if significant spam activity originates from the domain.","type":"boolean","nullable":true},"malware":{"description":"Indicates if malware distribution has been detected for the domain.","type":"boolean","nullable":true},"phishing":{"description":"Indicates if phishing attempts are associated with the domain.","type":"boolean","nullable":true},"suspicious":{"description":"Identifies suspicious activity associated with the domain.","type":"boolean","nullable":true},"adult":{"description":"Whether adult content is hosted on the domain.","type":"boolean","nullable":true},"domain_age":{"description":"The age of the domain in timestamp form.","type":"integer","nullable":true}},"type":"object","nullable":true},"created_at":{"description":"Date and time this record was created.","type":"string","nullable":true},"updated_at":{"description":"Date and time this record was last updated.","type":"string","nullable":true}},"type":"object","nullable":true},"updated_at":{"description":"Date and time the domain was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the domain was created.","type":"string","nullable":false}},"type":"object"}}}}
```

## The ProfileResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"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":"number","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":"number","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","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.","type":"string","nullable":false},"company":{"description":"Company data from the data providers. See the notes on `GET /profiles/{uuid}`.","properties":{"profile":{"description":"Core details of the company.","properties":{"ProfileCompanyName":{"description":"Company name.","type":"string","nullable":true},"ProfileCompanyStatusActive":{"description":"Whether the company is active.","type":"boolean","nullable":true},"ProfileCompanyRegisteredCountry":{"description":"Country the company is registered in.","type":"string","nullable":true},"ProfileCompanyReference":{"description":"Company registration number.","type":"string","nullable":true},"ProfileCompanyStatusProvider":{"description":"Company status, as reported by the provider.","type":"string","nullable":true},"ProfileCompanyLegalForm":{"description":"Legal form of the company.","type":"string","nullable":true},"ProfileCompanyRegistrationDate":{"description":"Registration date.","type":"string","nullable":true},"ProfileCompanyDataSource":{"description":"Data provider the company data came from.","type":"string","enum":["bolddata","creditsafe","enigma","globaldatabase","manual","nuna","opencorporates","orbis","soletrader"],"nullable":true},"ProfileCompanyVatNumber":{"description":"VAT number.","type":"string","nullable":true},"ProfileCompanyHasVatNumber":{"description":"Whether the company has a VAT number.","type":"boolean","nullable":true},"ProfileCompanyNumOfEmployees":{"description":"Number of employees.","type":"number","nullable":true},"ProfileCompanyPhoneNumber":{"description":"Company phone number.","type":"string","nullable":true},"ProfileCompanyEmail":{"description":"Company email address.","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},"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},"ProfileCompanyRegisteredAddressProvince":{"description":"Registered address province.","type":"string","nullable":true},"ProfileCompanyRegisteredAddressPostCode":{"description":"Registered address postcode.","type":"string","nullable":true},"ProfileCompanyRegisteredAddressCountryCode":{"description":"Registered address country code.","type":"string","nullable":true},"ProfileCompanyCapital":{"description":"Capital.","type":"number","nullable":true},"ProfileCompanyCurrency":{"description":"Currency of the financial figures.","type":"string","nullable":true},"ProfileCompanyCurrentAssets":{"description":"Current assets.","type":"number","nullable":true},"ProfileCompanyEBITDA":{"description":"EBITDA.","type":"string","nullable":true},"ProfileCompanyGrossProfit":{"description":"Gross profit.","type":"number","nullable":true},"ProfileCompanyLastAccountsDate":{"description":"Last accounts date.","type":"string","nullable":true},"ProfileCompanyLongTermDebt":{"description":"Long term debt.","type":"number","nullable":true},"ProfileCompanyTotalAssets":{"description":"Total assets.","type":"number","nullable":true},"ProfileCompanyTurnover":{"description":"Turnover.","type":"number","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},"ProfileCompanyCreditProbabilityOfDefault":{"description":"Credit probability of default.","type":"number","nullable":true},"ProfileCompanyCreditRatingDate":{"description":"Credit rating date.","type":"string","nullable":true},"ProfileCompanyCreditContractLimit":{"description":"Credit contract limit.","type":"number","nullable":true},"ProfileCompanyCreditRating":{"description":"Credit rating.","type":"string","nullable":true},"ProfileCompanyCreditRatingDescription":{"description":"Credit rating description.","type":"string","nullable":true},"ProfileCompanyCreditLimit":{"description":"Credit limit.","type":"number","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},"ProfileCompanyCreditProviderDescription":{"description":"Credit provider description.","type":"string","nullable":true},"ProfileCompanyCreditPreviousRating":{"description":"Previous credit rating.","type":"string","nullable":true},"ProfileCompanyCreditPreviousRatingDescription":{"description":"Previous credit rating description.","type":"string","nullable":true},"ProfileCompanyCreditPreviousLimit":{"description":"Previous credit limit.","type":"number","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},"ProfileCompanyCreditPreviousProviderDescription":{"description":"Previous credit provider description.","type":"string","nullable":true}},"type":"object","nullable":true},"director":{"description":"List of data source directors.","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":"Summary of directors.","properties":{"total_count":{"description":"Total count.","type":"number","nullable":true},"active_count":{"description":"Active count.","type":"number","nullable":true},"inactive_count":{"description":"Inactive count.","type":"number","nullable":true}},"type":"object"}},"type":"object"},"share_structure":{"description":"Details of the share structure including shareholders.","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}},"type":"object"},"structure":{"description":"Structure of company.","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"}},"type":"object"},"financials":{"description":"Financials of company.","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"}}},"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":"Company domain information.","type":"array","items":{"properties":{"domain":{"description":"Domain.","type":"string","nullable":false},"online_presence":{"description":"Online presence.","type":"array","items":{"properties":{"founding_year":{"description":"Year the company was founded.","type":"string","nullable":true},"phone_number":{"description":"A contact phone number for the company.","type":"string","nullable":true},"industry":{"description":"The industry of the company.","type":"string","nullable":true},"tags":{"description":"Tags describing the company.","type":"array","items":{"type":"string"},"nullable":true},"address":{"description":"The company address.","type":"string","nullable":true}},"type":"object"},"nullable":true}},"type":"object"}},"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":"number","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":"number","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","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.","type":"string","nullable":false},"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"}}}}
```

## The ProfilesTypeConfigResponse object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"ProfilesTypeConfigResponse":{"title":"Profile Entity Type Configuration Response","properties":{"id":{"description":"ID of the entity type.","type":"integer","nullable":false},"type":{"description":"Entity type.","type":"string","nullable":false},"label":{"description":"Display name of the entity type.","type":"string","nullable":false},"fields":{"description":"Fields that can be provided when creating a profile of this type.","type":"array","items":{"properties":{"code":{"description":"Code of the field. It is the property name to use in the request.","type":"string","nullable":false},"label":{"description":"Display name of the field.","type":"string","nullable":false},"is_required":{"description":"Whether the field is required.","type":"boolean","nullable":false},"position":{"description":"Position of the field in the form.","type":"integer","nullable":false}},"type":"object"}}},"type":"object"}}}}
```

## The AnalysisResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"AnalysisResource":{"title":"Profile Analysis Response","properties":{"id":{"description":"Analysis UUID.","type":"string","nullable":false},"status":{"description":"Status of the analysis.","type":"string","enum":["failed","completed","pending","missing_data"],"nullable":false},"score":{"description":"Overall score of the analysis.","type":"integer","nullable":false},"workflow":{"description":"Workflow used to produce the analysis.","type":"array","items":{"properties":{"id":{"description":"Analysis workflow (profile) UUID.","type":"string","nullable":false},"name":{"description":"Analysis workflow (profile) name.","type":"string","nullable":false}},"type":"object"}},"risk":{"description":"Name of the risk level for the score.","type":"string","nullable":false},"report":{"description":"Detailed report, grouped by rule group.","type":"array","items":{"properties":{"name":{"description":"Name of the rule group.","type":"string","nullable":false},"total_rules":{"description":"Number of rules in the group.","type":"integer","nullable":false},"total_completed_rules":{"description":"Number of rules in the group that have completed.","type":"integer","nullable":false},"result":{"description":"Results of the rules in the group.","type":"array","items":{"properties":{"id":{"description":"Analysis report UUID.","type":"string","nullable":false},"analysis_id":{"description":"Analysis UUID.","type":"string","nullable":false},"score":{"description":"Analysis report score.","type":"integer","nullable":false},"state":{"description":"State of the rule: `skipped`, `analysed` or `failed`.","type":"string","enum":["skipped","analysed","failed"],"nullable":false},"label":{"description":"Name of the rule.","type":"string","nullable":false},"description":{"description":"What the rule checks.","type":"string","nullable":false},"result":{"description":"Outcome of the rule, for example `Passed`.","type":"string","nullable":false}},"type":"object"}}},"type":"object"}},"created_at":{"description":"Date and time the analysis was created.","type":"string","nullable":false}},"type":"object"}}}}
```

## The SearchRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"SearchRequest":{"title":"Search Request","required":["type","address"],"properties":{"type":{"description":"Entity type to search for.","type":"string","enum":["company","sole_trader","partnership","charity","government_entity","incorporated_syndicate","company_syndicate","syndicate","association","trust","fund","club","individual","joint_individual"],"nullable":false},"name":{"description":"Name of the company to search for. Required unless `company_number` is provided.","type":"string","nullable":false},"company_number":{"description":"Official company registration number or identifier used for searching.","type":"string","nullable":false},"address":{"description":"Address to search in.","required":["country_code"],"properties":{"country_code":{"description":"Country to search in, ISO 3166-1 alpha-2 country code.","type":"string","nullable":false},"city":{"description":"City. Required unless `company_number` is provided.","type":"string","nullable":false},"state":{"description":"State or region. Required when `country_code` is `US`, unless `company_number` is provided.","type":"string","nullable":false}},"type":"object","nullable":false}},"type":"object"}}}}
```

## The SearchResponse object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"SearchResponse":{"title":"Search Response","properties":{"data":{"description":"List of search results.","type":"array","items":{"properties":{"type":{"description":"Entity type of the result.","type":"string","enum":["company","sole_trader","partnership","charity","government_entity","incorporated_syndicate","company_syndicate","syndicate","association","trust","fund","club","individual","joint_individual"]},"name":{"description":"Company name.","type":"string"},"company_reference":{"description":"Company reference number, as supplied by the provider.","type":"string"},"provider":{"description":"Data provider that supplied the result.","type":"string"},"provider_reference":{"description":"Reference of the company at the provider.","type":"string"},"jurisdiction_code":{"description":"Jurisdiction code of the company, for example `gb`.","type":"string"},"company_type":{"description":"Type of company, for example `PRIVATE LIMITED COMPANY`.","type":"string"},"current_status":{"description":"Current status of the company, for example `Dissolved`.","type":"string"},"address":{"description":"Address of the company.","type":"string"},"vat_number":{"description":"VAT number of the company, if known.","type":"string","nullable":true},"province_code":{"description":"Province or region code of the company's address.","type":"string","nullable":true},"post_code":{"description":"Postcode of the company address.","type":"string"},"city":{"description":"City of the company address.","type":"string"},"confidence":{"description":"How closely the result matches your search criteria, as a score from 0 to 100.","type":"integer"},"response_id":{"description":"ID of this result. Send it, with `lookup_id`, to `POST /profiles` to create a profile from the result.","type":"integer"}},"type":"object"}},"status":{"description":"Outcome of the search: `EMPTY` if there are no results, `PARTIAL` if the results only partly match, or `MATCH` if there is a match.","type":"string","enum":["EMPTY","PARTIAL","MATCH"]},"lookup_id":{"description":"ID of this search. Send it, with the `response_id` of a result, to `POST /profiles` to create a profile from the result.","type":"integer"}},"type":"object"}}}}
```

## The SearchField object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"SearchField":{"title":"Search Field","properties":{"is_required":{"description":"Whether the field is required to run the search.","type":"boolean"},"label":{"description":"Display name of the field.","type":"string"},"position":{"description":"Position of the field in the search form.","type":"integer"}},"type":"object"}}}}
```

## The EntityTypeConfig object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"EntityTypeConfig":{"title":"Entity Type Config","properties":{"type":{"description":"Entity type.","type":"string"},"label":{"description":"Display name of the entity type.","type":"string"},"search_enabled":{"description":"Whether search is enabled for the entity type.","type":"boolean"},"search_fields":{"description":"Search fields available for the entity type, keyed by field name.","properties":{"address.country_code":{"$ref":"#/components/schemas/SearchField"},"customer_reference":{"$ref":"#/components/schemas/SearchField"},"name":{"$ref":"#/components/schemas/SearchField"},"address.city":{"$ref":"#/components/schemas/SearchField"},"address.state":{"$ref":"#/components/schemas/SearchField"},"company_number":{"$ref":"#/components/schemas/SearchField"},"domain":{"$ref":"#/components/schemas/SearchField"}},"type":"object"}},"type":"object"},"SearchField":{"title":"Search Field","properties":{"is_required":{"description":"Whether the field is required to run the search.","type":"boolean"},"label":{"description":"Display name of the field.","type":"string"},"position":{"description":"Position of the field in the search form.","type":"integer"}},"type":"object"}}}}
```

## The SearchTypeResponse object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"SearchTypeResponse":{"title":"Search Type Response","properties":{"company":{"$ref":"#/components/schemas/EntityTypeConfig"},"sole_trader":{"$ref":"#/components/schemas/EntityTypeConfig"},"partnership":{"$ref":"#/components/schemas/EntityTypeConfig"},"charity":{"$ref":"#/components/schemas/EntityTypeConfig"},"government_entity":{"$ref":"#/components/schemas/EntityTypeConfig"},"syndicate":{"$ref":"#/components/schemas/EntityTypeConfig"},"association":{"$ref":"#/components/schemas/EntityTypeConfig"},"trust":{"$ref":"#/components/schemas/EntityTypeConfig"},"fund":{"$ref":"#/components/schemas/EntityTypeConfig"}},"type":"object"},"EntityTypeConfig":{"title":"Entity Type Config","properties":{"type":{"description":"Entity type.","type":"string"},"label":{"description":"Display name of the entity type.","type":"string"},"search_enabled":{"description":"Whether search is enabled for the entity type.","type":"boolean"},"search_fields":{"description":"Search fields available for the entity type, keyed by field name.","properties":{"address.country_code":{"$ref":"#/components/schemas/SearchField"},"customer_reference":{"$ref":"#/components/schemas/SearchField"},"name":{"$ref":"#/components/schemas/SearchField"},"address.city":{"$ref":"#/components/schemas/SearchField"},"address.state":{"$ref":"#/components/schemas/SearchField"},"company_number":{"$ref":"#/components/schemas/SearchField"},"domain":{"$ref":"#/components/schemas/SearchField"}},"type":"object"}},"type":"object"},"SearchField":{"title":"Search Field","properties":{"is_required":{"description":"Whether the field is required to run the search.","type":"boolean"},"label":{"description":"Display name of the field.","type":"string"},"position":{"description":"Position of the field in the search form.","type":"integer"}},"type":"object"}}}}
```

## The EntityTypesConfig object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"EntityTypesConfig":{"title":"Entity Types Config","properties":{"label":{"description":"Display name of the entity type.","type":"string"},"search_enabled":{"description":"Whether search is enabled for the entity type.","type":"boolean"}},"type":"object"}}}}
```

## The SearchTypesResponse object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"SearchTypesResponse":{"title":"Search Types Response","properties":{"company":{"$ref":"#/components/schemas/EntityTypesConfig"},"sole_trader":{"$ref":"#/components/schemas/EntityTypesConfig"},"partnership":{"$ref":"#/components/schemas/EntityTypesConfig"},"charity":{"$ref":"#/components/schemas/EntityTypesConfig"},"government_entity":{"$ref":"#/components/schemas/EntityTypesConfig"},"incorporated_syndicate":{"$ref":"#/components/schemas/EntityTypesConfig"},"company_syndicate":{"$ref":"#/components/schemas/EntityTypesConfig"},"syndicate":{"$ref":"#/components/schemas/EntityTypesConfig"},"association":{"$ref":"#/components/schemas/EntityTypesConfig"},"trust":{"$ref":"#/components/schemas/EntityTypesConfig"},"fund":{"$ref":"#/components/schemas/EntityTypesConfig"},"individual":{"$ref":"#/components/schemas/EntityTypesConfig"},"joint_individual":{"$ref":"#/components/schemas/EntityTypesConfig"},"club":{"$ref":"#/components/schemas/EntityTypesConfig"}},"type":"object"},"EntityTypesConfig":{"title":"Entity Types Config","properties":{"label":{"description":"Display name of the entity type.","type":"string"},"search_enabled":{"description":"Whether search is enabled for the entity type.","type":"boolean"}},"type":"object"}}}}
```

## The PortalUserCreateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"PortalUserCreateRequest":{"title":"Portal User Create Request","required":["email"],"properties":{"email":{"description":"Email address of the portal user.","type":"string","nullable":false}},"type":"object"}}}}
```

## The PortalUserLoginLinkCreateRequest object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"PortalUserLoginLinkCreateRequest":{"title":"Portal User Login Link Create Request","required":["profile_id","purpose"],"properties":{"profile_id":{"description":"ID of the profile the login link is for.","type":"string","nullable":false},"purpose":{"description":"Purpose of the login link. Currently only `onboarding` is supported.","type":"string","enum":["onboarding"],"nullable":false}},"type":"object"}}}}
```

## The ProfilePortalUserActivityResponse object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"ProfilePortalUserActivityResponse":{"title":"Profile Portal User Activity Resource","required":["id","type","ip","updated_at","created_at"],"properties":{"id":{"description":"Activity ID.","type":"number","nullable":false},"type":{"description":"Type of activity.","type":"string","enum":["access_log"],"nullable":false},"user":{"description":"The portal user the activity belongs to.","required":["id","email"],"properties":{"id":{"description":"Portal user ID.","type":"number","nullable":false},"name":{"description":"Name of the portal user.","type":"string","nullable":true},"email":{"description":"Email address of the portal user.","type":"string","nullable":false}},"type":"object","nullable":true},"ip":{"description":"User IP address.","type":"string","nullable":false},"browser_agent":{"description":"Browser user agent string.","type":"string","nullable":true},"session_information":{"description":"Portal user session information.","properties":{"city":{"description":"City the session was started from.","type":"string","nullable":true},"region":{"description":"Region the session was started from.","type":"string","nullable":true},"country_code":{"description":"Country the session was started from, ISO 3166-1 alpha-2 country code.","type":"string","nullable":true},"latitude":{"description":"Approximate latitude of the session location.","type":"string","nullable":true},"longitude":{"description":"Approximate longitude of the session location.","type":"string","nullable":true},"time_zone":{"description":"Time zone of the session location.","type":"string","nullable":true},"privacy_node":{"description":"Session privacy information.","properties":{"tor":{"description":"Whether the session uses the Tor browser.","type":"boolean","nullable":false},"vpn":{"description":"Whether the portal user is using a VPN.","type":"boolean","nullable":false},"proxy":{"description":"Whether the session uses a proxy.","type":"boolean","nullable":false},"relay":{"description":"Whether the session uses a relay.","type":"boolean","nullable":false},"hosting":{"description":"Whether the session comes from a hosting provider.","type":"boolean","nullable":false},"service":{"description":"Name of the privacy service used, for example a VPN or proxy service.","type":"string","nullable":true}},"type":"object","nullable":true}},"type":"object","nullable":true},"updated_at":{"description":"Date and time the activity record was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the activity record was created.","type":"string","nullable":false}},"type":"object"}}}}
```

## The PortalUserLinkLoginResourceResponse object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"PortalUserLinkLoginResourceResponse":{"title":"Portal User Login Link Resource","required":["purpose","link","expires_at"],"properties":{"purpose":{"description":"Purpose the login link was created for.","type":"string","enum":["onboarding"],"nullable":false},"link":{"description":"URL the portal user uses to sign in.","type":"string","nullable":false},"expires_at":{"description":"Date and time at which the link expires.","type":"string","nullable":false}},"type":"object"}}}}
```

## The PortalUserViewResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"PortalUserViewResource":{"title":"Portal User View Resource","required":["id","email","updated_at","created_at"],"properties":{"id":{"description":"Portal user ID.","type":"integer","nullable":false},"name":{"description":"Name of the portal user.","type":"string","nullable":true},"email":{"description":"Email address of the portal user.","type":"string","nullable":false},"profiles":{"description":"Profiles the portal user is assigned to.","type":"array","items":{"required":["id","name","role"],"properties":{"id":{"description":"Profile ID.","type":"string","nullable":false},"name":{"description":"Name of the profile.","type":"string","nullable":false},"role":{"description":"Role of the portal user on the profile.","type":"string","enum":["admin","identity"],"nullable":false}},"type":"object"},"nullable":true},"updated_at":{"description":"Date and time the portal user was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the portal user was created.","type":"string","nullable":false}},"type":"object"}}}}
```

## The UserListResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"UserListResource":{"title":"Case Management User List Resource","required":["id","name","email","blocked","updated_at","created_at"],"properties":{"id":{"description":"User ID.","type":"string","nullable":false},"name":{"description":"Name of the user.","type":"string","nullable":false},"email":{"description":"Email address of the user.","type":"string","nullable":false},"blocked":{"description":"Whether the user is blocked.","type":"boolean","nullable":false},"updated_at":{"description":"Date and time the user was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the user was created.","type":"string","nullable":false}},"type":"object"}}}}
```

## The UserViewResource object

```json
{"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"components":{"schemas":{"UserViewResource":{"title":"Case Management User View Resource","required":["id","name","email","blocked","updated_at","created_at"],"properties":{"id":{"description":"User ID.","type":"string","nullable":false},"name":{"description":"Name of the user.","type":"string","nullable":false},"email":{"description":"Email address of the user.","type":"string","nullable":false},"blocked":{"description":"Whether the user is blocked.","type":"boolean","nullable":false},"teams":{"description":"Teams the user belongs to.","type":"array","items":{"properties":{"id":{"description":"Team ID.","type":"number","nullable":false},"name":{"description":"Name of team.","type":"string","nullable":false},"updated_at":{"description":"Date and time the team was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the team was created.","type":"string","nullable":false}},"type":"object"},"nullable":true},"profiles":{"description":"Profiles the user is assigned to.","type":"array","items":{"properties":{"id":{"description":"Profile ID.","type":"string","nullable":false},"review_status":{"description":"Review status of the profile.","type":"string","enum":["Processed","Needs Review","Additional Info Required","Approved","Declined","Archived"],"nullable":false},"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"},"nullable":true},"updated_at":{"description":"Date and time the user was last updated.","type":"string","nullable":false},"created_at":{"description":"Date and time the user was created.","type":"string","nullable":false}},"type":"object"}}}}
```


---

# 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-docs/models.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.