URL: /connect/docs/changelog # Changelog API Changelog: 2026-02-23 [#api-changelog-2026-02-23] This update includes a minor, non-breaking improvement to provide more clarity on an upcoming feature related to monitoring alerts. We've added a descriptive comment to an enum value to prepare for future functionality and prevent confusion. The update also introduces a set of generic, non-country-specific legal forms. This enhancement allows for better classification of custom companies or companies from jurisdictions not explicitly supported by our country-specific codes. This is a non-breaking change. Improvements [#improvements] * **Clarified status of `COMPANY_INFORMATION` alert kind** We've added a description to the `COMPANY_INFORMATION` value in the `DatasetKind` enum. This description clarifies that this alert kind is currently under development and not yet active. Alerts with this kind will not contain any change data for the time being. This is a preparatory, non-breaking change for a future feature. * **Added Global Legal Form Kinds** We've expanded the `LegalFormKind` enum with new generic values to represent common company structures in a globally-recognized, non-country-specific way. This is particularly useful when creating or updating custom companies where a precise, country-specific legal form is not available or applicable. The following new values have been added to the `LegalFormKind` enum: * `GLOBAL_COOPERATIVE` * `GLOBAL_FOUNDATION` * `GLOBAL_GOVERNMENT_ENTITY` * `GLOBAL_LIMITED_COMPANY` * `GLOBAL_LIMITED_PARTNERSHIP` * `GLOBAL_NON_PROFIT` * `GLOBAL_OTHER` * `GLOBAL_PARTNERSHIP` * `GLOBAL_PUBLIC_LIMITED_COMPANY` * `GLOBAL_SOLE_PROPRIETORSHIP` * `GLOBAL_TRUST` As this is an additive change to an enum, it is non-breaking and will not impact existing integrations. API Changelog: 2026-02-18 [#api-changelog-2026-02-18] This update introduces the ability to programmatically create reviews for private persons. This provides feature parity with the existing review creation functionality for companies, enabling more comprehensive automation of compliance workflows. Features [#features] * **Added mutation to create reviews for private persons** You can now programmatically initiate a review for a `PrivatePerson` using the new `reviewPrivatePersonCreate` mutation. This works similarly to the existing `reviewCompanyCreate` mutation for companies. Pass the `PrivatePersonId` to start a review, and the API will return a `PrivatePersonReviewPayload` containing the success status and the resulting risk class. API Changelog: 2026-02-13 [#api-changelog-2026-02-13] This update introduces a new mutation, `alertUpdate`, allowing you to programmatically manage the state of monitoring alerts. This is a non-breaking change. New Features [#new-features] * **New `alertUpdate` mutation for managing alerts** You can now programmatically update the state of one or more monitoring alerts using the new `alertUpdate` mutation. This allows you to mark alerts as `RESOLVED` or `UNRESOLVED` in bulk by providing a list of alert IDs. This change simplifies alert lifecycle management within your applications. The mutation uses the new `AlertUpdateInput` and returns an `AlertUpdatePayload`. **Example Usage:** ```graphql mutation UpdateAlerts { alertUpdate(where: { ids: ["alert-id-1", "alert-id-2"], state: RESOLVED }) { success } } ``` API Changelog: 2026-02-12 [#api-changelog-2026-02-12] This update introduces a powerful new Custom Risk Fields feature. You can now define, assign, and query your own risk attributes for companies and private persons, enabling more tailored and comprehensive risk assessments based on your organization's specific criteria. New Features [#new-features-1] * **Manage and query Custom Risk Fields on entities** You can now manage and retrieve custom risk data to enrich entity profiles. This feature allows for more flexible and specific risk scoring tailored to your needs. The workflow is as follows: * **Discover available fields:** Use the new `customRiskFields` query to get a list of all custom risk field definitions configured for your team. This will return each field's ID, name, type (e.g., `SINGLE_SELECT`, `MULTI_SELECT`), and available options. * **Assign values to an entity:** Use the new `entityUpdateCustomRiskField` mutation to set or update the value of a custom risk field for a specific company or person. You provide the entity's ID, the risk field's ID, and the selected option ID(s). * **Read assigned values:** The assigned custom risk field values for an entity can be retrieved via the `customRiskFields` field, now available on the `Company` and `PrivatePerson` types. API Changelog: 2026-02-11 [#api-changelog-2026-02-11] This update introduces a new mutation, `attachFormInstance`, which allows for associating an existing, externally initiated form instance with a specific company in the system. This provides greater flexibility for workflows where forms are handled outside of the standard API process. Features [#features-1] * **New `attachFormInstance` mutation** A new mutation has been added to enable linking a form instance to a company. This is useful when a form is initiated through an external process and needs to be programmatically associated with a company record. The mutation `attachFormInstance` requires the `companyId` and the `formInstanceId` to be attached. It returns a boolean `success` flag to indicate if the operation was successful. **Example Usage:** ```graphql mutation AttachFormInstanceToCompany($companyId: CompanyId!, $formInstanceId: FormInstanceId!) { attachFormInstance(where: { companyId: $companyId, formInstanceId: $formInstanceId }) { success } } ``` **Associated Schema Changes:** * New `Mutation` field: `attachFormInstance(where: AttachFormInstanceInput!): AttachFormInstancePayload!` * New `Input` type: `AttachFormInstanceInput` * New `Type`: `AttachFormInstancePayload` API Changelog: 2026-02-10 [#api-changelog-2026-02-10] This update introduces new capabilities for managing customer-facing forms. You can now programmatically generate a shareable URL for an existing form and cancel forms that are in progress. We've also updated the description of a related field to improve clarity. Features [#features-2] * **Added `createFormUrl` mutation to generate form URLs.** You can now create a shareable URL for an active customer-facing form. This is useful when you need to re-send a form link to a customer. Use the `createFormUrl` mutation with a `companyId` and `documentId`. You can also specify an optional `timeToLive` for the URL. * **Added `cancelForm` mutation to cancel active forms.** The new `cancelForm` mutation allows you to cancel an active customer-facing form that is currently in progress. This action requires the `companyId` and the `documentId` of the form instance. The associated document's status will be set to `CANCELLED`. * **Clarified `Company.documents` field description.** The description for the `Company.documents` field has been updated to clarify that it returns a list of both completed documents and document orders that are in progress. This is a non-functional change intended to improve documentation clarity in relation to the new form management capabilities. API Changelog: 2026-02-10 [#api-changelog-2026-02-10-1] This update introduces a new status for document uploads, allowing for more granular tracking of a document's lifecycle. This is a non-breaking change. Documents [#documents] * **New `CANCELLED` status for document uploads** The `DocumentStatus` enum has been expanded with a new `CANCELLED` value. This status will be returned in the `status` field of the `Document` type when a document upload has been cancelled by a user or the system. This provides more detailed information about the state of a document, in addition to the existing statuses: `PENDING`, `IN_PROGRESS`, `SUCCESS`, and `FAILED`. While this is a non-breaking change, we recommend updating your client to handle the new `CANCELLED` enum value. API Changelog: 2026-02-09 [#api-changelog-2026-02-09] This update introduces a new mutation for generating alerts in sandbox environments, providing a way for developers to test their alert-handling logic. This is a non-breaking update. New Features [#new-features-2] * **Generate sandbox alerts for testing** A new `sandboxAlertGenerate` mutation has been added. This mutation allows you to programmatically trigger PEP or sanction alerts for any monitored company within your sandbox environment. It's designed to help you test and validate your application's response to different alert scenarios. You can specify the entity to alert on, the type of alert (`PEP` or `SANCTION`), and whether to add or remove a screening hit to trigger the alert. This feature is exclusively available in the sandbox environment. API Changelog: 2026-02-06 [#api-changelog-2026-02-06] This update introduces the ability to query user-defined custom risk fields on `Company` and `PrivatePerson` entities. This allows you to retrieve values for custom risk criteria, enhancing tailored risk assessments. All changes in this release are non-breaking. New Features [#new-features-3] * **Query Custom Risk Fields on Entities** You can now retrieve the values for custom risk fields that have been configured and assigned to an entity. This is useful for integrating your organization's specific risk criteria into your applications. * A new `customRiskFields` field has been added to the `Company` and `PrivatePerson` types. * This field returns an array of `EntityCustomRiskField` objects. Each object contains the `riskField` definition and the `selectedOptions` for that entity. * This change introduces several new supporting types: * `EntityCustomRiskField`: Associates a risk field and its selected options with an entity. * `CustomRiskField`: Defines a custom risk field, including its `name`, `kind`, and all possible `options`. * `CustomRiskFieldKind`: An enum that specifies if the field is a `SINGLE_SELECT` or `MULTI_SELECT`. * `CustomRiskFieldOption`: Represents a possible option for a custom risk field. API Changelog: 2026-01-19 [#api-changelog-2026-01-19] This update introduces a comprehensive credit reporting feature. You can now order credit reports for companies and retrieve detailed credit score information directly through the API. This enhancement provides valuable financial insights, including credit ratings, payment remarks, and collateral summaries. New Features [#new-features-4] * **Added credit reporting for companies** This update adds the ability to order and query credit reports for companies. * You can now order a credit report for a company using the new `companyCreditReportOrder` mutation. This mutation takes a company ID and returns a `CreditReportPayload` containing the result. * The `Company` type now has a `creditScore` field, which provides data from the most recently ordered credit report. This field will be `null` if no report has been ordered. This feature is supported by several new types: * **`CreditReportPayload`**: The response object for the `companyCreditReportOrder` mutation. Contains: * `success`: Whether the credit report was successfully ordered. * `company`: The company for which the credit report was ordered. * `creditScore`: The credit score data. * **`CreditScore`**: Contains detailed credit information: * `reportDate`: The date when the credit report was ordered. * `rating`: The international credit rating (A-E). * `ratingDescription`: Description of the rating. * `creditRating`: The numerical credit score/rating value. * `creditLimit`: The company's credit limit. * `currencyCode`: Currency code for monetary values in this report. * `hasPaymentRemarks`: Whether the company has any payment remarks. * `remarks`: Summary of unsettled payment remarks. * `partiallySettledRemarks`: Summary of partially settled payment remarks. * `voluntaryCollateral`: Summary of voluntary collateral. * `scoreUnavailableReason`: Reason why the credit score is unavailable, if applicable. Only present when the company could not be scored. * **`CreditRating`**: An enum representing the international credit rating scale: * `A`: Very Low Risk (score 71-100) * `B`: Low Risk (score 51-70) * `C`: Moderate Risk (score 30-50) * `D`: High Risk (score 1-29) * `E`: No Rating * **`PaymentRemarksSummary`**: Provides a summarized count and total amount for payment remarks. * **`CollateralSummary`**: Provides a summarized count and total amount for voluntary collateral. **Example: Order a new credit report** ```graphql mutation OrderCreditReport { companyCreditReportOrder(where: { id: "your-company-id" }) { success company { id name } creditScore { reportDate rating ratingDescription creditRating creditLimit currencyCode hasPaymentRemarks scoreUnavailableReason remarks { count totalAmount } partiallySettledRemarks { count totalAmount } voluntaryCollateral { count totalAmount } } } } ``` **Example: Query existing credit score for a company** ```graphql query GetCompanyCreditScore { company(where: { id: "your-company-id" }) { name creditScore { reportDate creditLimit creditRating rating ratingDescription hasPaymentRemarks remarks { count totalAmount } partiallySettledRemarks { count totalAmount } voluntaryCollateral { count totalAmount } currencyCode scoreUnavailableReason } } } ``` API Changelog: 2026-01-16 [#api-changelog-2026-01-16] This update adds a new field to the `Review` object type. This enhancement allows for storing self-assessment notes from a review, providing additional context for due diligence and compliance records. New Features [#new-features-5] * **New `selfAssessment` field on `Review`** A new field, `selfAssessment`, of type `String` has been added to the `Review` object. This field can be used to retrieve the self-assessment notes that were captured during the review process. API Changelog: 2026-01-14 [#api-changelog-2026-01-14] This update enhances our risk assessment capabilities by providing more context around how risk scores are calculated. We've introduced a new status to indicate when a score could not be determined due to missing data, and a corresponding `INCONCLUSIVE` risk level. These changes are non-breaking. Risk Assessment [#risk-assessment] * **Added status field to `RiskScoreResult` to clarify score calculation** To provide more insight into risk calculations, we've added a new `status` field to the `RiskScoreResult` object. This field uses the new `RiskScoreStatus` enum to indicate whether a score was calculated successfully or if the necessary data was unavailable. This helps differentiate between a score of `0` due to low risk (`CALCULATED`) and a score of `0` due to a lack of data (`MISSING_DATA`). The new `status` field is available on all fields that return a `RiskScoreResult`, such as `RiskCalculationResult.countryScore` and `RiskCalculationResult.industryScore`. ```graphql "Indicates whether data was present for a risk score calculation" enum RiskScoreStatus { "Data was present and the score was calculated normally" CALCULATED "No data was available for this risk category" MISSING_DATA } "A risk score with its matched values that contributed to the score" type RiskScoreResult { score: Int! matchedValues: [String!]! "Indicates whether data was present for calculation or if it was missing" status: RiskScoreStatus! } ``` * **New `INCONCLUSIVE` value added to `RiskLevelKind` enum** We have added a new `INCONCLUSIVE` value to the `RiskLevelKind` enum. This new level is used when a final risk level cannot be determined because critical data required for the calculation is missing. Developers should update any client-side logic that consumes the `RiskLevelKind` enum to handle this new value. ```graphql enum RiskLevelKind { # ... existing values "Inconclusive risk level - critical data is missing for risk calculation" INCONCLUSIVE } ``` API Changelog: 2026-01-13 [#api-changelog-2026-01-13] This update enhances the automated risk calculation by introducing a new score component based on an entity's Relatives and Close Associates (RCAs). This change is non-breaking. Additions [#additions] * **Added RCA Count Score to Risk Calculation** The `RiskCalculationResult` type now includes the `rcaCountScore` field. This field provides a detailed risk score (of type `RiskScoreResult`) based on the number of Relatives and Close Associates (RCAs) found for an entity, contributing to a more granular total risk assessment. API Changelog: 2026-01-06 [#api-changelog-2026-01-06] This update introduces a comprehensive suite of features for advanced risk management and entity lifecycle tracking. You can now perform and query detailed reviews for private persons, access both calculated and user-assessed risk levels, and track an entity's portfolio status. These changes affect the `Company`, `PrivatePerson`, and `Review` types, and introduce new queries for private person reviews. This is a non-breaking update. Enhanced Risk and Review Management [#enhanced-risk-and-review-management] * **New risk assessment fields for `Company` and `PrivatePerson`** We have added several new fields to provide more granular risk information. The `automatedRiskLevel` field on `Company` is now deprecated. * `calculatedRiskLevel`: A new object on `Company` that provides a detailed breakdown of the automated risk calculation, including scores for country, industry, sanctions, and more. This field replaces the deprecated `automatedRiskLevel`. * `userAssessedRiskLevel`: A new field on both `Company` and `PrivatePerson` that stores the risk level (e.g., `HIGH`, `MEDIUM`, `LOW`) assigned by a user during a review. * `nextScheduledReviewDate`: A new field on both `Company` and `PrivatePerson` that shows the date for the next periodic review, which is based on the risk assessed in the latest review. * **Added reviews for `PrivatePerson`** You can now create and retrieve reviews for `PrivatePerson` entities, mirroring the existing functionality for companies. * `PrivatePerson.reviews`: A new field on the `PrivatePerson` type that returns a list of all completed reviews (`PrivatePersonReview`) for that person. * `Query.privatePersonReview` and `Query.privatePersonReviews`: New root queries to fetch a single `PrivatePersonReview` by its ID or list all private person reviews within a specified date range. * **Expanded `Review` type** The existing `Review` type (for companies) has been enhanced to store more contextual data from the review process. * `calculatedRiskLevel`: The calculated risk level at the time of the review. * `userAssessedRiskLevel`: The user-assessed risk level that was set during the review. * `validUntilDate`: The date until which the review is considered valid. Entity Portfolio Status [#entity-portfolio-status] * **Track entity status in your portfolio** A new `entityPortfolioStatusInfo` field has been added to both the `Company` and `PrivatePerson` types. This allows you to track an entity's status within your internal workflow. * The `entityPortfolioStatusInfo` field returns an `EntityPortfolioStatusInfo` object, which contains the current `status` (e.g., `PROSPECT`, `QUALIFIED`, `ACCOUNT`), the `previousStatus`, and when it was last `modifiedAt`. * A corresponding `entityStatus` field has also been added to the `Review` type to capture the entity's portfolio status at the time the review was conducted. API Changelog: 2025-12-19 [#api-changelog-2025-12-19] This release includes a documentation improvement to clarify the behavior of the `country` filter when searching for persons. There are no breaking changes. Improvements [#improvements-1] * **Clarified behavior of `PersonSearchInput.country`** The `country` field on the `PersonSearchInput` object now includes a description. This clarifies that the filter will be ignored if a developer provides a country code for a registry that is not supported by the API. This helps explain search results that might otherwise seem unexpected. API Changelog: 2025-12-19 [#api-changelog-2025-12-19-1] We've updated our API to support the new SNI 2025 industry classification standard. This is a non-breaking change that enhances our company data capabilities. Improvements [#improvements-2] * **Added `SNI_2025` to `IndustryCodeType`** A new enum value, `SNI_2025`, has been added to the `IndustryCodeType` enum. This represents the upcoming Swedish Standard Industrial Classification for 2025. You may encounter this value in the `codeType` field when querying for company industry information via the `Company.industriesV2` field. As this is a non-breaking addition, existing integrations will not be affected, but we recommend updating clients to recognize this new value. API Changelog: 2025-12-17 [#api-changelog-2025-12-17] This update introduces a more robust and detailed way to handle entity addresses. We have added a new `addresses` field to all entity types, which provides a comprehensive list of addresses, each categorized by its type (e.g., postal, registered). The previous `address` field is now deprecated in favor of this new, more structured approach. Improvements [#improvements-3] * **Enhanced Address Information** To provide more comprehensive and structured address data, we have introduced a new `addresses` field on `Company`, `BusinessPerson`, `CustomBusinessPerson`, and the `EntityLike` interface. This new field returns a list of all available addresses for an entity. To help distinguish between them, we've also added: * A new `addressKind` field to the `Address` type. * A new `AddressKind` enum with possible values: `POSTAL`, `REGISTERED`, `TRADING`, and `VISITING`. The existing `address` field is now **deprecated** and will be removed in a future version. We recommend updating your integrations to use the new `addresses` field to access this richer data and ensure future compatibility. API Changelog: 2025-12-17 [#api-changelog-2025-12-17-1] This update introduces enhancements to the `EntityIdentifier` type by adding a `description` field as well as a new `UNKNOWN` enum value to `EntityIdentifierKind`. New Features [#new-features-6] * **Added `UNKNOWN` emum value to `EntityIdentifierKind`.** When the identifier cannot be determined to be of type `PRIMARY` or `SECONDARY` the identifier kind will be `UNKNOWN`. * **Added `description` field on type `EntityIdentifier`.** The description field provides additional details on the type of identifier. API Changelog: 2025-12-16 [#api-changelog-2025-12-16] This update introduces significant enhancements to our monitoring and alerts capabilities, providing more specific types and new filtering options. We've also improved the usability of adverse media screening fields. This release includes several breaking changes related to the alerts feature that require developer attention. The alert queries are still subject to change and breaking changes should still be expected. Breaking Changes [#breaking-changes] * **Argument type for `Query.alertData` has changed.** The `alert` argument on the `Query.alertData` field now accepts a value of type `AlertId!` instead of `ID!`. The new `AlertId` scalar provides a more specific identifier for alerts, improving type safety. You must update your queries to use this new type. * **Type of `monitoredEntity` fields changed to `MonitoredEntityLike`.** The `monitoredEntity` field on the `AlertConnectionEdge` and `MonitoringChange` types has been updated from `EntityLike!` to the new, more specific `MonitoredEntityLike!` interface. This change ensures that only entities that can be monitored are returned in this context. New Features & Enhancements [#new-features--enhancements] * **Introduced `MonitoredEntityLike` interface for better type safety.** We've added a new interface, `MonitoredEntityLike`, to specifically represent entities that can be monitored. The `Company` and `PrivatePerson` types now implement this interface, distinguishing them from other entities in monitoring-related queries. * **Filter alerts by entity kind.** The `alerts` query now accepts a new `entityKind` argument within the `AlertsWhereInput` object. You can use this to filter alerts for a specific type of entity, such as `COMPANY` or `PRIVATE_PERSON`, using the new `EntityKind` enum. * **Improved pagination for `ams` fields.** The `pageInfo` argument on `PrivatePerson.ams` (and other fields implementing `EntityLike` or `MonitoredEntityLike`) is now optional and includes a default value of `{ size: 20, offset: 0 }`. This simplifies querying for the first page of adverse media events as the argument is no longer required. We've also added more detailed descriptions to the field and its arguments to clarify its usage. API Changelog: 2025-12-10 [#api-changelog-2025-12-10] This update introduces two non-breaking changes to improve data modeling. We've added a new field to the `Company` type to identify reference-only records and a new status to the `DocumentStatus` enum for better tracking of document uploads. Features [#features-3] * **New `isReferenceOnly` field on Company** A new boolean field, `isReferenceOnly`, has been added to the `Company` type. This field will be `true` for company records that are created as a reference from another entity's relationship data (e.g., a shareholder from an unsupported country). These reference-only companies exist to complete the graph but have limited data available. You can use this flag to identify and handle these partial records appropriately in your application. * **New `IN_PROGRESS` status for `DocumentStatus`** The `DocumentStatus` enum now includes the value `IN_PROGRESS`. This new status indicates that a document upload has been initiated and is currently in the process of being uploaded. This provides more granular tracking between the `PENDING` and `SUCCESS`/`FAILED` states. API Changelog: 2025-12-09 [#api-changelog-2025-12-09] This update introduces a new mutation for creating private persons, providing more control over the data enrichment process. As this is a non-breaking change, all existing integrations will continue to work without modification. New Features [#new-features-7] * **New `privatePersonCreateNoEnrich` mutation** A new mutation, `privatePersonCreateNoEnrich`, has been added to create a private person entity. Unlike the existing `privatePersonCreate` mutation, this new field does not automatically enrich the created person with data from external registries. It creates the person record using *only* the data you provide in the `PrivatePersonCreateInput`. This is useful when you have already verified the person's details, for example, by using the `privatePersonRegistrySearch` query, and want to create an entity with that exact data. API Changelog: 2025-12-08 [#api-changelog-2025-12-08] Improvements to the `privatePersonSearch` query * Added a new `hasNin` field to the `PersonSearchInput` query input that can be used to filter private persons that does or does not have a nin (national identification number). * Added pagination information in the search response, `PageInfo`, making it easier for the client to go through all the pages matching the query. * Order results by name ascending API Changelog: 2025-12-05 [#api-changelog-2025-12-05] This update introduces a new query, `privatePersonRegistrySearch`, allowing you to look up private individuals directly in official national registries. This provides a way to find and verify person data using a combination of identifiers before creating them in Strise. New Features [#new-features-8] * **New `privatePersonRegistrySearch` query** The query uses the new `PersonRegistrySearchInput` type, which requires `name` and `country`, and accepts optional fields like `nin` (national identifier number), `birthDate`, and address details to refine the search. You must provide Name combined with one of the following: National ID Number, Birth Date, or an Address (requires Street Name with either Zip Code or House Number) to get a result. A successful search returns a `ConnectPrivatePersonRegistrySearchResource` object containing the person's details from the registry, such as their name, birth date, address, and official identifier. **Example Query:** ```graphql query FindPersonInRegistry { privatePersonRegistrySearch( where: { name: "John Doe", country: "NO", birthDate: "1990-01-15" } ) { name birthDate address { addressLine city zipCode } identifier { value kind } } } ``` API Changelog: 2025-11-28 [#api-changelog-2025-11-28] This update expands our Adverse Media Screening (AMS) capabilities by incorporating a new data source. This change is non-breaking, but you may want to update your client to handle the new event kind. Additions [#additions-1] * **New Adverse Media Source: Dow Jones** The `AmsEventKind` enum, which specifies the origin of an adverse media event, now includes the value `DOW_JONES`. When querying for adverse media via the `ams` field on an entity, you may now receive `AmsEvent` objects where the `eventKind` field is `DOW_JONES`. API Changelog: 2025-11-27 [#api-changelog-2025-11-27] Listing tags is now available for companies and private persons New Features [#new-features-9] * **Added `tags` field to `Company` and `PrivatePerson` types**. This enables you to query for a list of tags added to these resources API Changelog: 2025-11-05 [#api-changelog-2025-11-05] New Features [#new-features-10] * **Added `shareholders` and `holdings` fields to `Company`, and `holdings` to `BusinessPerson`** New fields to retrieve shareholder and holding information for companies have been added. These fields return lists of `Ownership` objects, providing details about the direct shareholders and holdings of a company. In each `Ownership` object, you can find: * `entity`: The `Company` or `BusinessPerson` that is the shareholder, or `Company` that is being held. * `totalSharePercentage`: The total direct share percentage held by/in the entity. * `shareClasses`: A list that contains information about the share class and the share percentage held. * `editMetadata`: Metadata about potential edits that have been done to the item. * **Added `beneficialOwners` field to `Company`, and `beneficialOwnerships` field to `BusinessPerson`** These fields contain information about a company's beneficial owners and a business person's beneficial ownerships, respectively. They return lists of `BeneficialOwnership` objects, which include: * `entity`: The `Company` or `BusinessPerson` that is the beneficial owner/owned entity. * `reasons`: A list of reason enum values explaining why the entity is considered a beneficial owner. * `editMetadata`: Metadata about potential edits that have been done to the item. For all these fields, you can use the `ignoreEdits` parameter to see the original, unedited data. API Changelog: 2025-11-03 [#api-changelog-2025-11-03] We've introduced a new way to retrieve information about corporate roles. You can now query for the roles held by a specific `BusinessPerson` or see all the roles associated with a `Company`. This is a non-breaking feature addition. New Features [#new-features-11] * **Added `roles` field to `Company` and `BusinessPerson` types** A new `roles` field is now available on the `Company` and `BusinessPerson` types. This enables you to query for corporate role information, such as finding the CEO of a company or listing a person's board positions. This change introduces two new types: `Role` and `RolePeriod`. * The `roles` field returns a list of `Role` objects. Each `Role` includes the `roleTitle`, an `isActive` flag, the associated `entity` (the person or company), and a `period` object. * The `RolePeriod` object specifies the `from` and `to` dates for the role's tenure. * You can use the `includePrevious: true` argument to fetch historical roles in addition to current ones. API Changelog: 2025-10-29 [#api-changelog-2025-10-29] This update introduces a new capability to send customer-facing forms directly via the API. You can now trigger a form to be sent to a specific recipient's email and associate it with a company in your system. This is useful for processes like customer onboarding or information gathering. Features [#features-4] * **Added ability to send customer-facing forms** A new `sendForm` mutation is now available. It allows you to programmatically send a predefined customer-facing form to an email recipient. To use this mutation, provide the `companyId`, the `formId` of the form you wish to send, and the recipient's details in the `SendFormInput`. Upon success, the API will return a `SendFormPayload` containing `success: true` and the unique `formInstanceId` for the form that was sent. This change introduces the following new types and fields: * **Mutation:** `sendForm(where: SendFormInput!): SendFormPayload!` * **Input Type:** `SendFormInput`, which requires `companyId`, `formId`, `recipientEmail`, and `recipientName`. * **Payload Type:** `SendFormPayload`, which returns a `success` boolean and the new `formInstanceId`. * **Scalar IDs:** `CustomerFacingFormId` to identify the form template, and `FormInstanceId` to identify the specific instance that was sent. API Changelog: 2025-10-21 [#api-changelog-2025-10-21] This update introduces a more structured way to access company industry codes. We have deprecated the `industries` field on the `Company` type and replaced it with the new `industriesV2` field. This is a non-breaking change, but we encourage all developers to migrate to the new field to take advantage of the richer data. Improvements [#improvements-4] * **`Company.industries` field deprecated in favor of `industriesV2`** The `industries` field on the `Company` type is now deprecated and will be removed in a future API version. This field returned a simple list of strings representing industry codes. To provide more detailed information, we have introduced the new `industriesV2` field. This field returns a list of `ConnectIndustryCode` objects, each containing the industry `code`, its `description`, and the `codeType` (e.g., NACE, SIC). We recommend updating your queries to use `industriesV2` to access this more structured and informative data. API Changelog: 2025-10-16 [#api-changelog-2025-10-16] This update improves how you access Adverse Media Screening (AMS) data. We are deprecating the `amsCount` field on all relevant entities and introducing a more powerful `ams` field. This change allows you to retrieve detailed information about media events instead of just an approximate total count. This is a non-breaking change, but we encourage you to migrate to the new field. Adverse Media Screening [#adverse-media-screening] * **Deprecated `amsCount` in favor of new `ams` field** The `amsCount` integer field is now deprecated on the `EntityLike` interface and its implementing types: `Company`, `BusinessPerson`, and `CustomBusinessPerson`. It will be removed in a future release. We have introduced a new `ams` field which returns a paginated list of `AmsEvent` objects. This provides rich details for each adverse media article, such as the title, summary, publisher, and publication date. The new field provides more accurate and detailed results. Please note that the number returned by the deprecated `amsCount` may differ from the number of events returned by the new `ams` field due to improvements in our screening and event clustering logic. **Action Required:** Please update your integrations to use the `ams` field to fetch detailed adverse media events. ```graphql # DEPRECATED query GetAmsCount($id: CompanyId!) { company(where: {id: $id}) { amsCount } } # RECOMMENDED query GetAmsEvents($id: CompanyId!) { company(where: {id: $id}) { # Query for the list of events ams(pageInfo: {size: 10, offset: 0}) { id title published summary } } } ``` API Changelog: 2025-10-14 [#api-changelog-2025-10-14] This update expands our data coverage by introducing new legal form types for companies registered in Finland. This is a non-breaking change that allows for more precise classification of Finnish entities. Improvements [#improvements-5] * **Added new legal forms for Finland** We have added 21 new values to the `LegalFormKind` enum to support a wider range of company legal forms in Finland. This change enhances our data coverage for Finnish entities, enabling more accurate classification when using the `customCompanyCreate` and `customCompanyUpdate` mutations. While this is a non-breaking change, we recommend updating any client-side logic that handles `LegalFormKind` to recognize these new values. The new values added are: * `FI_ASH`: Resident-administered area * `FI_ASY`: Right-of-occupancy associationy * `FI_AYH`: Non-profit association * `FI_ETS`: Finnish branch of a European economic interest grouping * `FI_HY`: Mortgage Society * `FI_KOY`: Limited liability joint-stock property company * `FI_KVJ`: Public mutual insurance company * `FI_OP`: Co-operative bank * `FI_OSK`: Housing co-perative * `FI_OYJ`: Public Limited Company * `FI_SCE`: European co-operative society * `FI_SCP`: European co-operative bank * `FI_SE`: European Company * `FI_SL`: Branch of a foreign trader * `FI_SP`: Savings bank * `FI_TYH`: Association for carrying on economic activity * `FI_UNKNOWN`: Unknown * `FI_VALTLL`: State-owned company * `FI_VOJ`: Public limited insurance company * `FI_VOY`: Limited insurance company * `FI_VY`: Insurance association API Changelog: 2025-10-02 [#api-changelog-2025-10-02] This update introduces new fields to the `Company` type, providing more detailed information on a company's operational status and employee count. These additions are non-breaking. New Features [#new-features-12] * **Added company status and employee count information** We've enriched the `Company` type with two new fields to provide more context about a business: * The new `status` field returns a `ConnectCompanyStatus` object, which describes the company's operational status (e.g., "Active", "Dissolved"), the date the status was set, and an `isActive` boolean flag. * The new `numberOfEmployees` field returns an `EmployeeCountInterval` object. This provides a `from` and `to` integer value, representing the employee count as a range. API Changelog: 2025-09-29 [#api-changelog-2025-09-29] This update expands our support for German company data by introducing a new legal form. This is a non-breaking change. Enhancements [#enhancements] * **Added new legal form for German entities** We have added a new value, `DE_RV`, to the `LegalFormKind` enum. This value represents a "State-conferred Association" (*Rechtsfähiger Verein*), a type of legal entity in Germany. This change improves our data coverage for German companies. API Changelog: 2025-09-25 [#api-changelog-2025-09-25] This update introduces enhancements to our review functionality, making it easier to track and retrieve reviews. You can now fetch all reviews for a specific company and see exactly when a review was created. Additionally, it introduces a new way to classify entity identifiers, allowing you to distinguish between primary and secondary identifiers for companies and people. This provides more context and helps in programmatically selecting the most relevant identifier for an entity. There are no breaking changes in this release. Enhancements [#enhancements-1] * **Retrieve reviews for a company** A new `reviews` field has been added to the `Company` type. This allows you to directly query all reviews that have been created for a specific company, returning a list of `Review` objects. * **Added creation timestamp to reviews** The `Review` type now includes a `createdAt` field. This field provides a `DateTime` timestamp for when the review was generated, which is useful for auditing and sorting purposes. * **Added `kind` to `EntityIdentifier` to classify identifiers** We've added a new `kind` field to the `EntityIdentifier` type. This field helps categorize an entity's identifiers, making it easier to determine their purpose. The `kind` field is non-nullable and returns a value from the new `EntityIdentifierKind` enum: * `PRIMARY`: A primary, official identifier for the entity (e.g., a national organization number). * `SECONDARY`: A secondary identifier for the entity. You can now use this field to reliably select the primary identifier for an entity instead of relying on heuristics. **Example Query:** ```graphql query GetCompanyIdentifiers($id: CompanyId!) { company(where: { id: $id }) { name identifiers { value country kind # New field } } } ``` API Changelog: 2025-09-24 [#api-changelog-2025-09-24] This update introduces a significant new feature for visualizing and analyzing company ownership structures. You can now query the new `shareholderGraph` field on the `Company` type to retrieve a graph of its owners, including indirect ownership and beneficial owner information. This is a non-breaking change. Features [#features-5] * **Introduced Shareholder Graph for Company Ownership** A new `shareholderGraph` field has been added to the `Company` type, allowing you to traverse and analyze complex ownership structures. The field returns a `ShareholderGraph` object, which consists of `nodes` (the entities) and `edges` (the ownership links). * **Nodes (`ShareholderGraphNode`)**: Represent companies or individuals in the ownership chain. Each node includes the entity's details, their calculated `indirectSharePercentage` in the root company, and whether they qualify as a `isBeneficialOwner`. * **Edges (`ShareholderGraphEdge`)**: Represent the direct ownership percentage between two nodes in the graph. * To accommodate data from various sources where ownership is expressed as a range (e.g., 25-50%), ownership percentages are now represented by the `SharePercentageInterval` type, which provides `from` and `to` values. * You can control the granularity of the graph by using the `minimumSharePercentage` argument on the `shareholderGraph` field to filter out smaller shareholders. Refer to the documentation on this parameter to learn more about how it works. Example query: ```graphql query CompanyOwnershipGraph { company(where: {id: "company-id"}) { name shareholderGraph(minimumSharePercentage: 10.0) { rootId nodes { id entity { name } isBeneficialOwner shareClasses { shareClass sharePercentage { from to } } indirectSharePercentage { from to } } edges { parent child sharePercentage { from to } } } } } ``` ```` ## API Changelog: 2025-09-23 Today's update introduces several enhancements to provide more context for Adverse Media Screening (AMS) events. We've also added a new country relationship type and improved the flexibility of creating and updating custom companies by making the `shareholders` field optional. ### Enhancements * **Added More Context to Adverse Media Events** We've added several new fields to the `AmsEvent` type to give you a clearer understanding of each media article. * `eventKind: AmsEventKind!`: Identifies the source of the event. The new `AmsEventKind` enum can be `GEMINI`, `OPOINT`, or `USER_CREATED`. * `createdBy: SimpleUser`: Specifies which user created the event, if applicable. This introduces the new `SimpleUser` and `UserAccountKind` types to represent user information. * `behindPaywall: Boolean!`: A new boolean flag that indicates if the article content is behind a paywall. * **New `REGISTER` Value for Country Relationship** The `CountryRelationship` enum now includes `REGISTER` as a new value. For `BusinessPerson`s, person register countries are now classified as Register instead of Address. Residency, nationality, and citizenship data is included when available. For `Company`, register countries are moved to the new Register kind while other countries are set to Address. These changes are non-breaking but will result in country type changes for most entities. ### Improvements * **`shareholders` Field is Now Optional for Custom Companies** The `shareholders` field on the `CustomCompanyCreateInput` and `CustomCompanyUpdateInput` types is no longer a required list. You can now omit this field entirely when creating or updating a company that has no shareholders, whereas previously an empty array (`[]`) was required. ## API Changelog: 2025-09 This month's update introduces more structured data for adverse media events and clarifies date ranges for Politically Exposed Person (PEP) roles. We've added new fields to the `AmsEvent` and `PepRole` types and deprecated their older counterparts to provide a more robust and intuitive API experience. There are no breaking changes. ### Adverse Media Screening * **Richer Data for Clustered Media Events** The `AmsEvent` type now includes a `clusteredEvents` field, which returns a list of the new `ClusteredEvent` type. Each `ClusteredEvent` object contains an `id` and a `url`, providing a more structured way to access articles belonging to the same news cluster. The previous `clusteredUrls` field, which returned a simple list of URL strings, is now **deprecated**. Please update your integrations to use the new `clusteredEvents` field for more detailed information. * **New `isCustom` Field on `AmsEvent`** A new boolean field, `isCustom`, has been added to the `AmsEvent` type. This field allows you to easily identify whether an adverse media event was added manually by a user or discovered automatically by our system. ### Politically Exposed Persons (PEP) * **Clearer Date Ranges for PEP Roles** To better represent the duration of a politically exposed person's role, we have added `startDate` and `endDate` fields to the `PepRole` type. The existing `since` field is now **deprecated** in favor of `startDate`. We recommend updating your queries to use these new, more explicit fields. ## API Changelog: 2025-08 This month's update introduces a significant breaking change to how custom company shareholders are managed, splitting them into distinct fields for persons and companies. We've also added a new, more structured way to query for industry codes on companies and included external source URLs for PEP (Politically Exposed Person) data to improve traceability. ### Breaking Changes * **New required shareholder fields for custom companies** The `customCompanyCreate` and `customCompanyUpdate` mutations now require you to specify shareholders in two new distinct, non-nullable fields: `personShareholders` for individuals and `companyShareholders` for other companies. This change provides a clearer and more structured way to define the ownership of a custom company. Any integrations using these mutations must be updated to provide these new fields. **Affected Mutations:** * `customCompanyCreate(where: CustomCompanyCreateInput!)` * `customCompanyUpdate(where: CustomCompanyUpdateInput!)` **New Required Fields:** * `personShareholders: [BusinessPersonOwnershipInput!]!` * `companyShareholders: [CompanyOwnershipInput!]!` ### Features * **Added structured industry codes for companies** You can now query for detailed industry codes on the `Company` type using the new `industriesV2` field. This field returns a list of `ConnectIndustryCode` objects, each containing the `code`, its `description`, and the `codeType` (e.g., `SNI_2007`, `SIC_2007`) from the new `IndustryCodeType` enum. This provides a more structured alternative to the existing `industries` field, which returns a simple list of strings. * **Added external source URLs for PEP data** To improve data traceability, we've added a new `externalUrls: [String!]!` field to the `PepHit` and `PepRelation` types. This field provides a list of URLs pointing to the original sources for the Politically Exposed Person (PEP) information. * **Added clustered URLs to adverse media events** The `AmsEvent` type now includes a `clusteredUrls: [String!]!` field. This returns a list of URLs for articles that have been identified as reporting on the same media event, helping you consolidate related news coverage. ## API Changelog: 2025-07 This month's update introduces two major features. You can now create, update, and delete your own custom company and person entities directly via the API. We have also added a powerful new automated risk calculation feature for companies, providing a detailed breakdown of their computed risk level. ### New Features * **Manage Custom Company and Person Entities** You can now create, update, and delete custom company and person entities that are not available in public registries. This is useful for managing entities in jurisdictions we don't cover or for creating special-purpose entities. This functionality is supported by a set of new mutations and their corresponding input and payload types. * New mutations: `customCompanyCreate`, `customCompanyUpdate`, `customCompanyDelete`, `customPersonCreate`, `customPersonEdit`, `customPersonDelete`. * New supporting types: `CustomCompanyCreateInput`, `CustomCompanyUpdateInput`, `CustomPersonCreateInput`, `CustomPersonEditInput`, `CustomCompanyPayload`, `CustomPersonPayload`, `ConnectPartialDateInput`, `LegalFormKind`. * **Automated Risk Calculation for Companies** The `Company` type now features a new `automatedRiskLevel` field. This field returns a `RiskCalculationResult` object containing the company's calculated risk level, total score, and a detailed breakdown of scores from various risk factors like country, industry, and PEP/sanction screenings. * New field: `Company.automatedRiskLevel`. * New supporting types: `RiskCalculationResult`, `RiskScoreResult`, `CustomRiskFieldScore`, `RiskLevelSetting`, `RiskLevelKind`. ### Field Additions * **Added `entityId` to `AmsEvent`** The `AmsEvent` type now includes an `entityId` field. This provides a direct reference to the ID of the company or person the adverse media event is associated with, simplifying data retrieval and linking events back to their source entity. ## API Changelog: 2025-06 This month's update introduces enhancements to our Adverse Media Screening (AMS) capabilities. We've added a new field to the `AmsEvent` type to provide more detailed context about the topics detected in media articles, allowing for more precise analysis. These changes are non-breaking. ### Adverse Media Screening * **Added `topicMentions` to `AmsEvent` for detailed topic analysis** We've introduced the `topicMentions` field to the `AmsEvent` type. This field returns a list of the new `AmsTopicMentions` type, which groups specific text mentions from an article under their relevant topic. While the existing `topics` field provides a simple list of topic strings, `topicMentions` offers a structured way to see exactly which phrases in the text are associated with each identified topic, providing deeper context. ## API Changelog: 2025-05 This month's update introduces a significant refactoring of how adverse media topics are represented, a new mutation for editing business person details, and an enhancement to sanction filtering. Please note the **breaking change** related to the `AmsEvent` type, which requires an update to any queries fetching topic data. ### 💥 Breaking Changes * **Refactored Adverse Media Topics from `topicMentions` to `topics`** The field `topicMentions` and its associated type `TopicMention` have been removed from `AmsEvent`. This has been replaced by a simpler `topics` field that returns a list of strings. This change simplifies the data structure for easier consumption. **Action Required:** Any queries fetching `topicMentions` must be updated to use the new `topics` field. *Before:* ```graphql query GetAmsEventTopics { company(where: {id: "..."}) { ams { topicMentions { text } } } } ```` *After:* ```graphql query GetAmsEventTopics { company(where: {id: "..."}) { ams { topics } } } ``` ✨ New Features [#-new-features] * **Added Mutation to Edit Business Persons** A new `editPerson` mutation has been added, allowing you to modify the details of a `BusinessPerson`. This mutation uses the new `BusinessPersonEditInput` type to specify the person's ID and the fields to be updated (e.g., `birthDate`), and returns a `BusinessPersonPayload`. * **New Filtering Option for Sanctions** The `SanctionInfo.sanctions` field now accepts an optional `includeSuggestedFalse` argument. When set to `true`, the query will also return sanctions that have been suggested as false matches but not yet confirmed. The default value is `false`, so existing integrations are not affected. 📈 Improvements & Fixes [#-improvements--fixes] * **Clarified `CountryCode` Behavior** The description for the `CountryCode` scalar has been updated to clarify that providing an empty string will be handled as a `null` value. * **Improved Field Descriptions** Documentation for the `ams` field on `BusinessPerson`, `Company`, `CustomBusinessPerson`, and `EntityLike` has been standardized and improved for clarity. API Changelog: 2025-04 [#api-changelog-2025-04] This month's update introduces a major enhancement to our Adverse Media Screening (AMS) capabilities. You can now retrieve detailed information about media articles related to an entity, including sentiment analysis and named entity recognition. Additionally, we've improved our PEP screening data by adding aliases to PEP records. All changes are non-breaking. Adverse Media Screening [#adverse-media-screening-1] * **New `ams` field for detailed media screening results** A new `ams` field has been added to the `EntityLike` interface, making it available on `Company`, `BusinessPerson`, and `CustomBusinessPerson` types. This field provides access to detailed adverse media articles and is intended to replace the existing `amsCount` field, which will be deprecated in a future release. The `ams` field returns a paginated list of `AmsEvent` objects. Each `AmsEvent` represents a single news article and contains rich data, including: * `entityMentions`: Specific mentions of people or companies within the text. * `amsPredictions`: Sentiment analysis results (e.g., `NEGATIVE`, `NEUTRAL`) with confidence scores. * `topicMentions`: Key topics discussed in the article. This change introduces several new supporting types: `AmsEvent`, `AmsEntityMention`, `AmsPrediction`, `AmsClassificationKind`, `TopicMention`, `NamedEntityKind`, `TextSpan`, and the `ISODateTime` scalar. PEP Screening [#pep-screening] * **Added aliases to PEP records** The `PepHit` type now includes a new `aliases` field. This field returns a list of alternative names associated with the Politically Exposed Person, improving the ability to confirm a match. API Changelog: 2025-03 [#api-changelog-2025-03] This month's update focuses on enriching the data available for Politically Exposed Person (PEP) screenings. We've introduced several new fields to the `PepHit` type to provide more comprehensive details on potential matches. Additionally, we've added support for custom sanction sources and improved the clarity of our documentation for the `Review` type. New Features [#new-features-13] * **Enhanced `PepHit` Type for Richer PEP Data** To provide more detailed information on Politically Exposed Person (PEP) matches, the `PepHit` type has been expanded with several new fields: * `name: String`: The full name of the matched person. * `dateOfBirth: PartialDate!`: The date of birth of the matched person. This uses the new `PartialDate` type, which can represent incomplete dates (e.g., just a year and month). * `countries: [Country!]!`: A list of countries associated with the person. * **New `CUSTOM` Sanction Source** The `SanctionSource` enum now includes the `CUSTOM` value. This is used to identify sanctions that have been manually added by users within your organization, distinguishing them from official list sources like OFAC or the EU. Improvements [#improvements-6] * **Improved `Review` Field Descriptions** To improve clarity and provide better guidance, we've added detailed descriptions to the following fields on the `Review` type: * `id`: Now explicitly described as "The id of the review." * `pdf`: The description now clarifies that this field provides the review as a base64 encoded PDF and explains that it is generated asynchronously. As a result, the field may be `null` if the PDF is not yet ready. API Changelog: 2025-02 [#api-changelog-2025-02] This month's update includes one breaking change with the removal of the `Subscription` type. We've also introduced new fields to support sanction match verification and a new review trigger for risk level changes. Additionally, we have clarified the descriptions for several fields related to the PEP/RCA verification feature to make their behavior more explicit. 💥 Breaking Changes [#-breaking-changes] * **Removal of `Subscription` Type** The root `Subscription` type has been removed from the API. Any operations that relied on this type are no longer supported and will result in a validation error. Please remove any usage of `Subscription` from your client integrations. ✨ New Features [#-new-features-1] * **Verify Sanction Matches** The `Sanction` type now includes a `confirmedMatch: Boolean` field. This field allows you to see a user's verification status for a specific sanction match. It will return `true` or `false` if verified, and `null` if the match has not yet been reviewed. Note that this field will only return data for users who have access to the sanction verification feature. * **New Review Trigger for Risk Level Changes** A new enum value, `RISK_LEVEL_VALUE`, has been added to `ReviewTriggerStatementKind`. This allows you to identify review triggers that were initiated due to a change in an entity's risk level. 改善 Improvements [#改善-improvements] * **Clarified Behavior for PEP/RCA Verification Fields** The descriptions for several fields and arguments related to PEP/RCA data have been updated to clarify that their functionality is dependent on a user having access to the PEP/RCA verification feature. This makes the expected behavior more predictable for all users. The affected fields are: * `PepHit.confirmedMatch` * `PepHit.custom` * `PepInfo.confirmedPepStatus` * `PepInfo.confirmedRcaStatus` * The `includeSuggestedFalse` argument on `PepInfo.hits` API Changelog: 2025-01 [#api-changelog-2025-01] This month's update introduces a significant enhancement to how Politically Exposed Person (PEP) data is structured, providing more granular and verifiable information. We've also added more detailed fields for sanctions data and made other quality-of-life improvements across the API. While there are no breaking changes, we have deprecated several fields on `PepInfo` and encourage you to update your integrations. Enhanced PEP & Sanction Details [#enhanced-pep--sanction-details] * **Richer PEP/RCA Data with `PepHit` Type** We've refactored how PEP and RCA (Relatives and Close Associates) data is exposed to provide more detailed records. The `PepInfo` object now contains a `hits` field that returns a list of the new `PepHit` type. Each `PepHit` represents a distinct data source match for an individual, allowing you to see multiple PEP roles or RCA relationships separately. As part of this change, the `roles` and `relations` fields on `PepInfo` are now **deprecated**. Please update your integration to use the `roles` and `relations` fields inside each `PepHit` object instead. Additionally, `PepInfo` now includes `confirmedPepStatus` and `confirmedRcaStatus` fields to reflect any manual verification performed by users. * **Additional Sanction Information** The `Sanction` type has been enriched with more contextual data. You can now retrieve the following new fields: * `sanctionedSince`: The date the sanction was applied. * `program`: The specific sanction program the entity is listed under. * `sourceUrl`: A direct URL to the sanction data from the source. * **PEP Role Start Date** The `PepRole` type now includes a `since` field, which provides the date the person assumed that specific role. General API Improvements [#general-api-improvements] * **Related Entities in Company Review Triggers** The `CompanyReviewTriggerEvent` object now includes a `relations` field. This field returns a list of related entities that are relevant to the event, giving you more context about what caused the review to be triggered. * **More Flexible Private Person Search** The `country` field in the `PrivatePersonIdentifierSearchInput` is no longer a required field. This allows you to search for a person by an official identifier without needing to specify their country. API Changelog: 2024-12 [#api-changelog-2024-12] This month's update enhances the information available for Politically Exposed Persons (PEPs). We've added a new field to provide more specific details about a PEP's role, allowing for more comprehensive screening. This change is non-breaking and adds new functionality without affecting existing queries. Enhancements [#enhancements-2] * **Added `details` field to `PepRole`** A new `details` field of type `String` has been added to the `PepRole` object. This field provides further context about a person's role, supplementing the existing `description`. For example, while the `description` might be "Member of Parliament," the new `details` field could specify the constituency or term dates, offering more granular information for your compliance processes. API Changelog: 2024-11 [#api-changelog-2024-11] This month's update introduces a powerful new Risk Signals feature, allowing you to identify and understand potential risks associated with entities more effectively. We've also added several documentation improvements across the schema to enhance clarity and developer experience. New Features [#new-features-14] * **Introducing Risk Signals** We've added a new `riskSignals` field to the `Company`, `BusinessPerson`, `PrivatePerson`, `CustomBusinessPerson` types, and the `EntityLike` interface. This field provides structured information about potential risks associated with an entity. To support this, we've introduced several new types: * `RiskSignals`: The top-level object containing a list of `RiskSignal`s. * `RiskSignal`: Represents a specific risk that has been identified. * `RiskFactor`: A specific data point that contributes to a `RiskSignal`, including information about when it occurred and the path to the risk. * `PathConnection` and `PathConnectionEdge`: New types used within `RiskFactor` to describe the path of relationships from the queried entity to the source of the risk. Schema Improvements [#schema-improvements] * **Added Descriptions for Clarity** To improve developer experience and inline documentation, we've added descriptions to several existing types and input fields: * `EntityConnection`: Description added to clarify how it represents entity relationships. * `PersonSearchInput.gender`: Clarifies the purpose of the gender filter. * `PrivatePersonIdentifierSearchInput.identifiers`: Specifies that this field is for the identifiers being searched. * `SizePageInfoInput.offset` and `SizePageInfoInput.size`: Descriptions added to clarify their use in pagination. API Changelog: 2024-10 [#api-changelog-2024-10] There were no changes to the GraphQL API in October 2024. API Changelog: 2024-09 [#api-changelog-2024-09] This month's update introduces significant enhancements to our Politically Exposed Person (PEP) and Sanctions data, providing more detailed and structured information. We've also added a new query to retrieve review reports. As part of these changes, several boolean fields have been deprecated in favor of richer object types, and the `privatePersonUpdate` mutation has been made more flexible. New Features [#new-features-15] * **Enhanced PEP and Sanctions Information** We've replaced the simple `pep` and `sanctioned` boolean fields with new, more detailed object types: `pepInfo` and `sanctionInfo`. These new fields provide structured data, such as the specific sanctions an entity is listed on, the sanctioning body, and the specific roles that qualify a person as a PEP. This change affects the `BusinessPerson`, `Company`, `CustomBusinessPerson`, and `PrivatePerson` types. The following new types have been added to support this feature: * `PepInfo`, `PepRole`, `PepRelation` * `SanctionInfo`, `Sanction`, `SanctionSource` * **New Query for Retrieving Reviews** You can now fetch a completed review directly using the new `review` root query field. This query accepts a review ID and returns the `Review` object, which includes a `pdf` field containing the Base64 encoded review report. A new `Base64EncodedFile` scalar has been added for this purpose. Deprecations [#deprecations] * **Deprecated `pep` and `sanctioned` Fields** The `pep` and `sanctioned` boolean fields on `BusinessPerson`, `Company`, `CustomBusinessPerson`, `PrivatePerson`, and the `EntityLike` interface are now deprecated. Please update your integrations to use the new `pepInfo` and `sanctionInfo` fields to access richer data and ensure future compatibility. * Use `pepInfo` instead of `pep`. * Use `sanctionInfo` instead of `sanctioned`. Improvements [#improvements-7] * **More Flexible `privatePersonUpdate` Mutation** The `privatePersonUpdate` mutation is now more flexible. The `name`, `nin`, `country`, and `address` fields in the `PrivatePersonUpdateInput` are no longer required. This allows you to perform partial updates on a `PrivatePerson` without resubmitting all of their existing details. * **Clarified `amsCount` Description** The description for the `amsCount` field on `BusinessPerson`, `Company`, `CustomBusinessPerson`, `PrivatePerson`, and `EntityLike` has been updated to clarify that the count is an approximation. The new description is: "This is an approximation and the actual number may be lower, but never higher." URL: /connect/docs/examples/companies # Companies This guide covers common workflows for managing companies in Strise Connect: looking up companies, adding them to monitoring, and handling alerts. Look up a company [#look-up-a-company] Use [companyIdentifierSearch](../queries/company-identifier-search) to find a company by its national identifier (for example, an organisation number): ```graphql query CompanyIdentifierSearch { companyIdentifierSearch(where: { identifiers: ["918330100"], country: "NO" }) { edges { node { id name } } } } ``` The returned `id` is used in all subsequent operations for that company. If the company isn't found in a public registry, you can create one manually using the [customCompanyCreate mutation](../mutations/custom-company-create). Add a company to monitoring [#add-a-company-to-monitoring] To start receiving alerts on a company, add it to monitoring using the [companyAddToMonitoring mutation](../mutations/company-add-to-monitoring). The `id` is the Strise entity ID obtained from search: ```graphql mutation MonitorCompany { companyAddToMonitoring(where: { id: "" }) { success company { name } } } ``` Fetch monitoring alerts [#fetch-monitoring-alerts] After a company is monitored, you can query for alerts using the [alerts query](../queries/alerts). Alerts are triggered when changes are detected, such as new PEP or sanction hits: ```graphql query GetAlerts { alerts(where: { first: 10 }) { edges { node { id alertKind createdAt state } monitoredEntity { ... on Company { id name } } } pageInfo { hasNextPage endCursor } } } ``` You can filter alerts by entity kind to only retrieve alerts for companies or private persons: ```graphql query GetCompanyAlerts { alerts(where: { first: 10, entityKind: COMPANY }) { edges { node { id alertKind state } } } } ``` Resolve alerts [#resolve-alerts] Use the [alertUpdate mutation](../mutations/alert-update) to mark alerts as resolved or unresolved: ```graphql mutation ResolveAlerts { alertUpdate(where: { ids: ["", ""], state: RESOLVED }) { success } } ``` Generate sandbox alerts [#generate-sandbox-alerts] In sandbox environments, use [sandboxAlertGenerate](../mutations/sandbox-alert-generate) to create test alerts for validating your alert-handling logic: ```graphql mutation GenerateTestAlert { sandboxAlertGenerate(where: { entityId: "", alertKind: SANCTION, action: ADD }) { success } } ``` URL: /connect/docs/examples/custom-entities # Custom Entities Custom entities let you create and manage companies and persons that aren't found in public registries. This is useful for foreign entities, shell companies, or individuals without official identifiers in supported countries. Custom companies [#custom-companies] You can create, update, and delete companies that don't exist in a public registry. Create a custom company [#create-a-custom-company] Use [customCompanyCreate](../mutations/custom-company-create) to create a company: ```graphql mutation CreateCustomCompany { customCompanyCreate( where: { name: "Acme Holdings Ltd" country: "GB" orgNumber: "12345678" legalForm: LIMITED_COMPANY address: { addressLine: "10 Downing Street", city: "London", zipCode: "SW1A 2AA", country: "GB" } companyShareholders: [] personShareholders: [] } ) { success company { id name } } } ``` The returned `id` can be used in all subsequent operations, such as adding the company to monitoring or creating reviews. Create with shareholders [#create-with-shareholders] You can specify company and person shareholders at creation time: ```graphql mutation CreateCompanyWithOwners { customCompanyCreate( where: { name: "Acme Holdings Ltd" country: "GB" companyShareholders: [ { id: "", share: 60.0 } ] personShareholders: [ { id: "", share: 40.0 } ] } ) { success company { id name } } } ``` Update a custom company [#update-a-custom-company] Use [customCompanyUpdate](../mutations/custom-company-update) to modify a custom company's details: ```graphql mutation UpdateCustomCompany { customCompanyUpdate( where: { id: "" name: "Acme Holdings International Ltd" country: "GB" companyShareholders: [] personShareholders: [] } ) { success company { id name } } } ``` Delete a custom company [#delete-a-custom-company] Use [customCompanyDelete](../mutations/custom-company-delete) to remove a custom company: ```graphql mutation DeleteCustomCompany { customCompanyDelete(where: { id: "" }) { success } } ``` Custom persons [#custom-persons] Custom persons are business persons (officers, shareholders) that you create manually. These differ from private persons — custom persons represent publicly associated individuals in a business context. Create a custom person [#create-a-custom-person] Use [customPersonCreate](../mutations/custom-person-create) to create a person: ```graphql mutation CreateCustomPerson { customPersonCreate( where: { name: "Jane Smith" citizenship: "GB" birthDate: { year: 1985, month: 3, day: 15 } sex: FEMALE address: [{ addressLine: "10 Downing Street", city: "London", zipCode: "SW1A 2AA", country: "GB" }] } ) { success person { id name } } } ``` The returned `id` can be used when assigning the person as a shareholder on a custom company. Update a custom person [#update-a-custom-person] Use [customPersonEdit](../mutations/custom-person-edit) to modify a custom person's details: ```graphql mutation UpdateCustomPerson { customPersonEdit( where: { id: "" name: "Jane Smith-Johnson" citizenship: "GB" birthDate: { year: 1985, month: 3, day: 15 } sex: FEMALE address: [{ addressLine: "20 New Street", city: "London", zipCode: "EC2M 4TP", country: "GB" }] } ) { success person { id name } } } ``` Delete a custom person [#delete-a-custom-person] Use [customPersonDelete](../mutations/custom-person-delete) to remove a custom person: ```graphql mutation DeleteCustomPerson { customPersonDelete(where: { id: "" }) { success } } ``` Workflow: onboard a foreign entity [#workflow-onboard-a-foreign-entity] A typical workflow for onboarding a company not found in a public registry: 1. Create custom persons for known shareholders and officers. 2. Create the custom company with shareholders linked. 3. Add the company to monitoring using [companyAddToMonitoring](../mutations/company-add-to-monitoring). 4. Create a review using [reviewCompanyCreate](../mutations/review-company-create). ```graphql # Step 1: Create a shareholder mutation Step1 { customPersonCreate( where: { name: "Jane Smith", citizenship: "GB", address: [] } ) { success person { id } } } # Step 2: Create the company with the shareholder mutation Step2 { customCompanyCreate( where: { name: "Acme Holdings Ltd" country: "GB" companyShareholders: [] personShareholders: [{ id: "", share: 100.0 }] } ) { success company { id } } } # Step 3: Start monitoring mutation Step3 { companyAddToMonitoring(where: { id: "" }) { success } } ``` URL: /connect/docs/examples/custom-risk-fields # Custom Risk Fields Custom risk fields let you define and manage your own risk classification criteria on entities. This guide covers listing available fields with their options and programmatically updating field values on entities. List available custom risk fields [#list-available-custom-risk-fields] Use the [customRiskFields query](../queries/custom-risk-fields) to retrieve all custom risk field definitions configured for your team, including their available options: ```graphql query ListCustomRiskFields { customRiskFields { id name kind options { id name } } } ``` This returns all fields with their `id`, `name`, `kind` (`SINGLE_SELECT` or `MULTI_SELECT`), and the list of selectable options. Each option has its own `id` and `name`. Example response [#example-response] ```json { "data": { "customRiskFields": [ { "id": "crf_abc123", "name": "Industry Risk", "kind": "SINGLE_SELECT", "options": [ { "id": "opt_low", "name": "Low" }, { "id": "opt_medium", "name": "Medium" }, { "id": "opt_high", "name": "High" } ] }, { "id": "crf_def456", "name": "Red Flags", "kind": "MULTI_SELECT", "options": [ { "id": "opt_shell", "name": "Shell company" }, { "id": "opt_offshore", "name": "Offshore structure" }, { "id": "opt_cash", "name": "Cash-intensive business" } ] } ] } } ``` Build a mapping from internal data points [#build-a-mapping-from-internal-data-points] To automate updates, create a mapping from your internal data points to the Strise custom risk field IDs and option IDs. Fetch the fields once, then use the IDs when updating entities. For example, if your internal system classifies industry risk as `"high"`, map it to the corresponding option ID: ``` Internal value "high" → Custom risk field "crf_abc123", option "opt_high" Internal value "medium" → Custom risk field "crf_abc123", option "opt_medium" ``` For `MULTI_SELECT` fields, map to multiple option IDs: ``` Internal flags ["shell_company", "offshore"] → Custom risk field "crf_def456", options ["opt_shell", "opt_offshore"] ``` Update a custom risk field on an entity [#update-a-custom-risk-field-on-an-entity] Use the [entityUpdateCustomRiskField mutation](../mutations/entity-update-custom-risk-field) to set the selected options for a custom risk field on a company or private person: ```graphql mutation UpdateCustomRiskField { entityUpdateCustomRiskField( where: { id: "" riskFieldId: "" selectedOptionIds: ["", ""] } ) { riskField { id name } selectedOptions { id name } } } ``` The mutation returns all custom risk fields on the entity with their current values. Single-select field [#single-select-field] For a `SINGLE_SELECT` field, pass exactly one option ID: ```graphql mutation SetIndustryRisk { entityUpdateCustomRiskField( where: { id: "" riskFieldId: "crf_abc123" selectedOptionIds: ["opt_high"] } ) { riskField { id name } selectedOptions { id name } } } ``` Multi-select field [#multi-select-field] For a `MULTI_SELECT` field, pass one or more option IDs: ```graphql mutation SetRedFlags { entityUpdateCustomRiskField( where: { id: "" riskFieldId: "crf_def456" selectedOptionIds: ["opt_shell", "opt_offshore"] } ) { riskField { id name } selectedOptions { id name } } } ``` Clear a custom risk field [#clear-a-custom-risk-field] To remove all selected options from a field, pass an empty list: ```graphql mutation ClearCustomRiskField { entityUpdateCustomRiskField( where: { id: "" riskFieldId: "crf_abc123" selectedOptionIds: [] } ) { riskField { id name } selectedOptions { id name } } } ``` URL: /connect/docs/examples/forms # Forms Forms let you send customer-facing questionnaires to recipients and track their completion. This guide covers sending forms, monitoring their status, and managing form lifecycles. List available forms [#list-available-forms] Use the [listForms query](../queries/list-forms) to see all forms configured for your team: ```graphql query ListForms { listForms { id title description } } ``` Send a form [#send-a-form] Use the [sendForm mutation](../mutations/send-form) to send a form to a recipient: ```graphql mutation SendForm { sendForm( where: { companyId: "" formId: "" recipientEmail: "" recipientName: "" } ) { success formInstanceId } } ``` You need to provide the Strise entity ID of the company and the form ID from `listForms`. Obtain the company ID [#obtain-the-company-id] Use [companyIdentifierSearch](../queries/company-identifier-search) to find a company by its national identifier. If no matching company exists, create one using the [customCompanyCreate mutation](../mutations/custom-company-create). Monitor form status [#monitor-form-status] The `formInstanceId` returned from `sendForm` can be used to check the form's status with the [document query](../queries/document): ```graphql query GetFormStatus { document( where: { documentId: "" companyId: "" } ) { id fileName status downloadUrl lastModifiedAt } } ``` The `status` field indicates where the form is in its lifecycle: | Status | Description | | ------------- | ------------------------------------------------- | | `PENDING` | Form has been sent but not yet started | | `IN_PROGRESS` | Recipient has started filling out the form | | `SUCCESS` | Form has been completed and is ready for download | | `FAILED` | Form processing failed | | `CANCELLED` | Form was cancelled before completion | Once `status` is `SUCCESS`, you can download the completed form using the `downloadUrl`. List all company documents [#list-all-company-documents] A form submission may include multiple documents. Use [Company.documents](../types/company) to see all documents related to a company: ```graphql query GetCompanyDocuments { company(where: { id: "" }) { documents { id fileName status downloadUrl source lastModifiedAt } } } ``` Create a shareable form URL [#create-a-shareable-form-url] Use the [createFormUrl mutation](../mutations/create-form-url) to generate a shareable link for an active form. This is useful when you need to resend a form link to a customer: ```graphql mutation CreateFormUrl { createFormUrl( where: { companyId: "" documentId: "" } ) { url } } ``` Cancel a form [#cancel-a-form] Use the [cancelForm mutation](../mutations/cancel-form) to cancel an active form that is in progress. The associated document's status is set to `CANCELLED`: ```graphql mutation CancelForm { cancelForm( where: { companyId: "" documentId: "" } ) { success } } ``` Attach an external form instance [#attach-an-external-form-instance] If a form was initiated outside of the API, use the [attachFormInstance mutation](../mutations/attach-form-instance) to link it to a company: ```graphql mutation AttachFormInstance { attachFormInstance( where: { companyId: "" formInstanceId: "" } ) { success } } ``` URL: /connect/docs/examples/monitoring-alerts # Monitoring Alerts Monitoring generates alerts when it detects changes on your entities. This guide covers how to fetch alerts, investigate the underlying changes that triggered them, and resolve them. For adding entities to monitoring and basic alert handling, see the [Companies](./companies) or [Private persons](./private-persons) example. Fetch alerts [#fetch-alerts] Use the [alerts query](../queries/alerts) to list alerts. You can filter by entity, alert kind, state, time period, and entity kind: ```graphql query GetUnresolvedAlerts { alerts( where: { states: [UNRESOLVED] page: { size: 20 } } ) { edges { node { id kind insertedAt computedAt state } monitoredEntity { ... on Company { id name } ... on PrivatePerson { id name } } } pageInfo { totalSize nextPageOffset } } } ``` Filter by alert kind [#filter-by-alert-kind] Filter to specific change types using `kinds`: ```graphql query GetSanctionAlerts { alerts( where: { kinds: [SANCTION] states: [UNRESOLVED] page: { size: 20 } } ) { edges { node { id kind computedAt } monitoredEntity { ... on Company { id name } } } } } ``` Filter by entity [#filter-by-entity] Fetch alerts for a specific entity: ```graphql query GetEntityAlerts { alerts( where: { entity: "" states: [UNRESOLVED] page: { size: 20 } } ) { edges { node { id kind computedAt } } } } ``` Investigate alert details [#investigate-alert-details] Use the [alertData query](../queries/alert-data) to see exactly what changed. The `change` field structure depends on the alert `kind`. PEP changes [#pep-changes] When a PEP (Politically Exposed Person) status changes on a related person: ```graphql query InvestigatePepAlert { alertData(alert: "") { monitoredEntity { ... on Company { id name } } kind computedAt change { ... on CompanyPepChange { kind pepChanges { person { ... on BusinessPerson { id name } } relationsToMonitoredEntity toValue { pep rca hits { name roles { description startDate endDate } countries { name } } } fromValue { pep rca } } } } } } ``` The `fromValue` and `toValue` fields show the previous and new state, letting you see exactly what changed. Sanction changes [#sanction-changes] When sanction status changes on the entity or a related person: ```graphql query InvestigateSanctionAlert { alertData(alert: "") { monitoredEntity { ... on Company { id name } } kind change { ... on CompanySanctionChange { kind sanctionChanges { entity { ... on BusinessPerson { id name } ... on Company { id name } } relationsToMonitoredEntity toValue { sanctioned sanctions { sanctionedBy program sourceUrl sanctionedSince } } fromValue { sanctioned } } } } } } ``` Ownership and role changes [#ownership-and-role-changes] When company relationships change (new officers, ownership changes, beneficial owner updates): ```graphql query InvestigateRelationsAlert { alertData(alert: "") { monitoredEntity { ... on Company { id name } } kind change { ... on CompanyRelationsChange { kind roleChange { toValue { roleTitle isActive period { from to } entity { ... on BusinessPerson { id name } } } fromValue { roleTitle isActive } } ownershipChange { toValue { totalSharePercentage { from to } entity { ... on BusinessPerson { id name } ... on Company { id name } } } fromValue { totalSharePercentage { from to } } } beneficialOwnerChange { toValue { reasons entity { ... on BusinessPerson { id name } } } } } } } } ``` Resolve alerts [#resolve-alerts] After investigating, use the [alertUpdate mutation](../mutations/alert-update) to mark alerts as resolved: ```graphql mutation ResolveAlerts { alertUpdate( where: { ids: ["", ""] state: RESOLVED } ) { success } } ``` You can also reopen a previously resolved alert by setting the state back to `UNRESOLVED`. URL: /connect/docs/examples/private-persons # Private Persons This guide covers common workflows for managing private persons in Strise Connect: searching for individuals, creating them, adding them to monitoring, and handling updates. Search for a private person [#search-for-a-private-person] You can search for private persons by national identifier or by name. By national identifier [#by-national-identifier] Use [privatePersonIdentifierSearch](../queries/private-person-identifier-search) to find a person by their official identifier (for example, SSN): ```graphql query FindPersonBySSN { privatePersonIdentifierSearch(where: { identifiers: ["12345678901"], country: "NO" }) { edges { node { id name } } } } ``` By name [#by-name] Use [privatePersonSearch](../queries/private-person-search) to find persons by name. You can narrow results with optional filters: ```graphql query FindPersonByName { privatePersonSearch( where: { query: "Ola Nordmann", country: "NO" } pageInfo: { size: 10 } ) { edges { node { id name } } pageInfo { totalSize nextPageOffset } } } ``` Verify against official registries [#verify-against-official-registries] Before creating a private person, you can verify their details against official registries using [privatePersonRegistrySearch](../queries/private-person-registry-search): ```graphql query VerifyPerson { privatePersonRegistrySearch( where: { name: "Ola Nordmann" nin: "12345678901" country: "NO" } ) { name identifier { value kind } birthDate gender address { addressLine city zipCode } } } ``` This returns registry data that you can review before creating the person. Create a private person [#create-a-private-person] Use [privatePersonCreate](../mutations/private-person-create) to create a person. This automatically enriches their data from registries: ```graphql mutation CreatePerson { privatePersonCreate( where: { name: "Ola Nordmann" nin: "12345678901" country: "NO" address: [] } ) { success person { id name } } } ``` If you want to skip registry enrichment (for example, after verifying data with `privatePersonRegistrySearch`), use [privatePersonCreateNoEnrich](../mutations/private-person-create-no-enrich) instead: ```graphql mutation CreatePersonNoEnrich { privatePersonCreateNoEnrich( where: { name: "Ola Nordmann" nin: "12345678901" country: "NO" birthDate: "1990-01-15" gender: MALE address: [{ addressLine: "Storgata 1", zipCode: "0001", city: "Oslo", country: "NO" }] } ) { success person { id name } } } ``` Add a person to monitoring [#add-a-person-to-monitoring] Use [privatePersonAddToMonitoring](../mutations/private-person-add-to-monitoring) to start receiving alerts when changes are detected (for example, new PEP or sanction hits): ```graphql mutation MonitorPerson { privatePersonAddToMonitoring(where: { id: "" }) { success person { id name } } } ``` Fetch person details [#fetch-person-details] Use the [privatePerson query](../queries/private-person) to retrieve full details including PEP, sanctions, and screening results: ```graphql query GetPersonDetails { privatePerson(where: { id: "" }) { id name birthDate gender isMonitored pepInfo { pep rca } sanctionInfo { sanctioned sanctions { sanctionedBy program } } customRiskFields { riskField { id name } selectedOptions { id name } } } } ``` Update a person [#update-a-person] Use [privatePersonUpdate](../mutations/private-person-update) to modify a person's details. Only provide the fields you want to change: ```graphql mutation UpdatePerson { privatePersonUpdate( where: { id: "" address: [{ addressLine: "Ny gate 5", zipCode: "0002", city: "Oslo", country: "NO" }] } ) { success person { id name } } } ``` Remove from monitoring [#remove-from-monitoring] Use [privatePersonRemoveFromMonitoring](../mutations/private-person-remove-from-monitoring) to stop monitoring a person: ```graphql mutation StopMonitoringPerson { privatePersonRemoveFromMonitoring(where: { id: "" }) { success } } ``` Delete a person [#delete-a-person] Use [privatePersonDelete](../mutations/private-person-delete) to permanently remove a person: ```graphql mutation DeletePerson { privatePersonDelete(where: { id: "" }) { success } } ``` URL: /connect/docs/examples/reviews # Reviews Reviews are risk assessments generated for companies and private persons. This guide covers creating reviews, retrieving review details, and listing reviews across your portfolio. Create a company review [#create-a-company-review] Use [reviewCompanyCreate](../mutations/review-company-create) to generate a review for a company. The review calculates risk based on your team's configured risk settings: ```graphql mutation CreateCompanyReview { reviewCompanyCreate(where: { id: "" }) { success risk id context { explanations entity { ... on Company { id name } } } } } ``` The response includes: * `risk` — the calculated risk class (for example, `LOW`, `MEDIUM`, `HIGH`) * `id` — the review ID, present only when the review is automatically completed based on your risk class settings * `context` — risk explanations and the entities involved Create a private person review [#create-a-private-person-review] Use [reviewPrivatePersonCreate](../mutations/review-private-person-create) for individuals: ```graphql mutation CreatePersonReview { reviewPrivatePersonCreate(where: { id: "" }) { success risk id context { explanations entity { ... on PrivatePerson { id name } } } } } ``` Retrieve a review [#retrieve-a-review] You can fetch a specific review by its ID for both companies and private persons. Company review [#company-review] Use the [review query](../queries/review) to fetch a specific company review: ```graphql query GetCompanyReview { review(where: { id: "" }) { id createdAt calculatedRiskLevel userAssessedRiskLevel selfAssessment validUntilDate entityStatus pdf } } ``` The `pdf` field contains the review as a base64-encoded PDF. The PDF is generated asynchronously — if it hasn't been created yet, this field is `null`. Retry after a short delay if needed. Private person review [#private-person-review] Use [privatePersonReview](../queries/private-person-review) for individual reviews: ```graphql query GetPersonReview { privatePersonReview(where: { id: "" }) { id createdAt privatePersonId userAssessedRiskLevel validUntilDate pdf } } ``` List reviews by date range [#list-reviews-by-date-range] Both company and private person reviews support pagination with `pageSize` (max 100) and `offset`. Increment the `offset` by `pageSize` to fetch the next page. Company reviews [#company-reviews] Use the [reviews query](../queries/reviews) to list all company reviews completed within a date range: ```graphql query ListCompanyReviews { reviews( from: "2025-01-01T00:00:00Z" to: "2025-12-31T23:59:59Z" pageSize: 50 offset: 0 ) { id createdAt companyId calculatedRiskLevel userAssessedRiskLevel validUntilDate entityStatus } } ``` Private person reviews [#private-person-reviews] Use [privatePersonReviews](../queries/private-person-reviews) for individuals: ```graphql query ListPersonReviews { privatePersonReviews( from: "2025-01-01T00:00:00Z" to: "2025-12-31T23:59:59Z" pageSize: 50 offset: 0 ) { id createdAt privatePersonId userAssessedRiskLevel validUntilDate } } ``` Access reviews from an entity [#access-reviews-from-an-entity] Reviews are also available directly on the entity. Use the [privatePerson query](../queries/private-person) or [company query](../queries/company) to see all reviews for a specific entity: ```graphql query GetCompanyWithReviews { company(where: { id: "" }) { name reviews { id createdAt calculatedRiskLevel userAssessedRiskLevel validUntilDate } nextScheduledReviewDate } } ``` URL: /connect/docs/ # Introduction Strise Connect is a GraphQL API that lets you integrate Strise's AML compliance capabilities into your own systems and manage data in Strise from your own workflows. You can search for companies and persons, create and update entities, run PEP and sanction screenings, monitor entities for changes, manage risk assessments, and more. To experiment with queries, use the [Strise GraphQL Playground](https://graphql.strise.ai/connect/graphiql). Authentication [#authentication] All requests require a bearer token. Generate one by sending your `clientId` and `clientSecret` to the [clientAccessTokenGenerate mutation](../mutations/client-access-token-generate). If you haven't acquired your client credentials, [contact us](mailto:tech@strise.ai) to request access. ```graphql mutation ClientAccessTokenGenerate { clientAccessTokenGenerate( clientId: "YOUR_CLIENT_ID" clientSecret: "YOUR_CLIENT_SECRET" ) { expires token } } ``` Pass the returned token as a header for all subsequent requests: ```json { "Authorization": "Bearer " } ``` LLM-friendly documentation [#llm-friendly-documentation] These docs are available in machine-readable formats for use with LLMs: * [`/connect/docs/llms.txt`](/llms.txt) — Index of all pages with titles and descriptions * [`/connect/docs/llms-full.txt`](/llms-full.txt) — Full content of all pages in a single file * [`/connect/docs/llms.mdx/`](/llms.mdx/mutations/client-access-token-generate) — Individual page content as processed Markdown Verify your setup [#verify-your-setup] To verify your setup, [search for a company](../queries/company-identifier-search) and confirm you get results. The following query searches for Strise AS by its Norwegian organisation number: ```graphql query CompanyIdentifierSearch { companyIdentifierSearch(where: { identifiers: ["918330100"], country: "NO" }) { edges { node { id name } } } } ``` URL: /connect/docs/mutations/alert-update # alertUpdate import { Callout } from 'fumadocs-ui/components/callout'; Update one or more monitoring alerts. ```graphql mutation AlertUpdate($where: AlertUpdateInput!) { alertUpdate(where: $where) { success } } ``` ```graphql input AlertUpdateInput { ids: [AlertId!]! state: AlertState } ``` Arguments [#arguments] where AlertUpdateInput! non-null input [#wherealertupdateinput-non-null-input] [`AlertUpdateInput!`](/types/inputs/alert-update-input) Type [#type] AlertUpdatePayload object [#alertupdatepayload-object] [`AlertUpdatePayload`](/types/objects/alert-update-payload) Payload returned after updating alerts. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether the update was successful. URL: /connect/docs/mutations/attach-form-instance # attachFormInstance import { Callout } from 'fumadocs-ui/components/callout'; Attach an externally initiated form instance to a company. ```graphql mutation AttachFormInstance($where: AttachFormInstanceInput!) { attachFormInstance(where: $where) { success } } ``` ```graphql input AttachFormInstanceInput { companyId: CompanyId! formInstanceId: FormInstanceId! } ``` Arguments [#arguments] where AttachFormInstanceInput! non-null input [#whereattachforminstanceinput-non-null-input] [`AttachFormInstanceInput!`](/types/inputs/attach-form-instance-input) Type [#type] AttachFormInstancePayload object [#attachforminstancepayload-object] [`AttachFormInstancePayload`](/types/objects/attach-form-instance-payload) The payload for attaching an externally initiated form instance to a company. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) URL: /connect/docs/mutations/cancel-form # cancelForm import { Callout } from 'fumadocs-ui/components/callout'; Cancel an active customer facing form. ```graphql mutation CancelForm($where: CancelFormInput!) { cancelForm(where: $where) { success } } ``` ```graphql input CancelFormInput { companyId: CompanyId! documentId: ID! } ``` Arguments [#arguments] where CancelFormInput! non-null input [#wherecancelforminput-non-null-input] [`CancelFormInput!`](/types/inputs/cancel-form-input) Type [#type] CancelFormPayload object [#cancelformpayload-object] [`CancelFormPayload`](/types/objects/cancel-form-payload) The payload for cancelling a customer facing form. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) URL: /connect/docs/mutations/client-access-token-generate # clientAccessTokenGenerate import { Callout } from 'fumadocs-ui/components/callout'; Generate a new access token for a client, which can be used to authenticate with the API through a 'Authorization: Bearer \' header. ```graphql mutation ClientAccessTokenGenerate($clientId: String!, $clientSecret: String!) { clientAccessTokenGenerate(clientId: $clientId, clientSecret: $clientSecret) { expires token } } ``` Arguments [#arguments] clientId String! non-null scalar [#clientidstring-non-null-scalar] [`String!`](/types/scalars/string) clientSecret String! non-null scalar [#clientsecretstring-non-null-scalar] [`String!`](/types/scalars/string) Type [#type] AccessToken object [#accesstoken-object] [`AccessToken`](/types/objects/access-token) An access token used to communicate with the Strise.ai APIs. Response Fields [#response-fields] expires Int! non-null scalar [#expiresint-non-null-scalar] [`Int!`](/types/scalars/int) The timestamp representing when the token is expiring. This is seconds since epoch. token String! non-null scalar [#tokenstring-non-null-scalar] [`String!`](/types/scalars/string) The access token as a JWT. URL: /connect/docs/mutations/companies-add-to-monitoring # companiesAddToMonitoring import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql mutation CompaniesAddToMonitoring($where: CompaniesWhereInput!) { companiesAddToMonitoring(where: $where) { failed allSuccessful } } ``` ```graphql input CompaniesWhereInput { ids: [CompanyId!]! } ``` Arguments [#arguments] where CompaniesWhereInput! non-null input [#wherecompanieswhereinput-non-null-input] [`CompaniesWhereInput!`](/types/inputs/companies-where-input) Type [#type] CompanyBulkPayloadResource object [#companybulkpayloadresource-object] [`CompanyBulkPayloadResource`](/types/objects/company-bulk-payload-resource) Response for bulk adding companies to monitoring. Response Fields [#response-fields] failed [CompanyId!]! non-null scalar [#failedcompanyid-non-null-scalar] [`[CompanyId!]!`](/types/scalars/company-id) allSuccessful Boolean! non-null scalar [#allsuccessfulboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) URL: /connect/docs/mutations/company-add-to-monitoring # companyAddToMonitoring import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql mutation CompanyAddToMonitoring($where: CompanyWhereInput!) { companyAddToMonitoring(where: $where) { success company { id name } } } ``` ```graphql input CompanyWhereInput { id: CompanyId! } ``` Arguments [#arguments] where CompanyWhereInput! non-null input [#wherecompanywhereinput-non-null-input] [`CompanyWhereInput!`](/types/inputs/company-where-input) Type [#type] CompanyPayload object [#companypayload-object] [`CompanyPayload`](/types/objects/company-payload) The payload for a company mutation. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) company Company object [#companycompany-object] [`Company`](/types/objects/company) A company resource. URL: /connect/docs/mutations/company-credit-report-order # companyCreditReportOrder import { Callout } from 'fumadocs-ui/components/callout'; Order a credit report for a company. ```graphql mutation CompanyCreditReportOrder($where: CompanyWhereInput!) { companyCreditReportOrder(where: $where) { success company { id name } creditScore { reportDate creditLimit creditRating rating ratingDescription hasPaymentRemarks remarks { count totalAmount } partiallySettledRemarks { count totalAmount } voluntaryCollateral { count totalAmount } currencyCode scoreUnavailableReason } } } ``` ```graphql input CompanyWhereInput { id: CompanyId! } ``` Arguments [#arguments] where CompanyWhereInput! non-null input [#wherecompanywhereinput-non-null-input] [`CompanyWhereInput!`](/types/inputs/company-where-input) Type [#type] CreditReportPayload object [#creditreportpayload-object] [`CreditReportPayload`](/types/objects/credit-report-payload) The payload for ordering a credit report. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether the credit report was successfully ordered. company Company object [#companycompany-object] [`Company`](/types/objects/company) The company for which the credit report was ordered. creditScore CreditScore object [#creditscorecreditscore-object] [`CreditScore`](/types/objects/credit-score) The credit score data. URL: /connect/docs/mutations/company-enrich-global-entity # companyEnrichGlobalEntity import { Callout } from 'fumadocs-ui/components/callout'; Create a company from a global entity source (e.g., Orbis). Fetches entity data from the specified source and stores it. ```graphql mutation CompanyEnrichGlobalEntity($where: CreateCompanyFromGlobalEntityInput!) { companyEnrichGlobalEntity(where: $where) { success company { id name } } } ``` ```graphql input CreateCompanyFromGlobalEntityInput { globalDataSource: GlobalDataSource! sourceIdentifier: String! } ``` Arguments [#arguments] where CreateCompanyFromGlobalEntityInput! non-null input [#wherecreatecompanyfromglobalentityinput-non-null-input] [`CreateCompanyFromGlobalEntityInput!`](/types/inputs/create-company-from-global-entity-input) Type [#type] GlobalCompanyPayload object [#globalcompanypayload-object] [`GlobalCompanyPayload`](/types/objects/global-company-payload) The payload for creating a company from a global entity source. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) company Company object [#companycompany-object] [`Company`](/types/objects/company) The created company resource. URL: /connect/docs/mutations/company-owners-update # companyOwnersUpdate import { Callout } from 'fumadocs-ui/components/callout'; Use companyUpdateShareholders, companyUpdateBeneficialOwners and companyResetFields instead No description ```graphql companyOwnersUpdate( where: CustomOwnersInput! ): CompanyPayload! @deprecated ``` Arguments [#arguments] where CustomOwnersInput! non-null input [#wherecustomownersinput-non-null-input] [`CustomOwnersInput!`](/types/inputs/custom-owners-input) Type [#type] CompanyPayload object [#companypayload-object] [`CompanyPayload`](/types/objects/company-payload) The payload for a company mutation. URL: /connect/docs/mutations/company-remove-from-monitoring # companyRemoveFromMonitoring import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql mutation CompanyRemoveFromMonitoring($where: CompanyWhereInput!) { companyRemoveFromMonitoring(where: $where) { success company { id name } } } ``` ```graphql input CompanyWhereInput { id: CompanyId! } ``` Arguments [#arguments] where CompanyWhereInput! non-null input [#wherecompanywhereinput-non-null-input] [`CompanyWhereInput!`](/types/inputs/company-where-input) Type [#type] CompanyPayload object [#companypayload-object] [`CompanyPayload`](/types/objects/company-payload) The payload for a company mutation. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) company Company object [#companycompany-object] [`Company`](/types/objects/company) A company resource. URL: /connect/docs/mutations/company-reset-fields # companyResetFields import { Callout } from 'fumadocs-ui/components/callout'; Reset all edits to the given fields for a company. ```graphql companyResetFields( where: CompanyResetFieldsInput! ): Boolean! ``` Arguments [#arguments] where CompanyResetFieldsInput! non-null input [#wherecompanyresetfieldsinput-non-null-input] [`CompanyResetFieldsInput!`](/types/inputs/company-reset-fields-input) Type [#type] Boolean scalar [#boolean-scalar] [`Boolean`](/types/scalars/boolean) The `Boolean` scalar type represents `true` or `false`. URL: /connect/docs/mutations/company-update-beneficial-owners # companyUpdateBeneficialOwners import { Callout } from 'fumadocs-ui/components/callout'; Update (add/remove) beneficial owners of a company. ```graphql companyUpdateBeneficialOwners( where: CompanyUpdateBeneficialOwnersInput! ): Boolean! ``` Arguments [#arguments] where CompanyUpdateBeneficialOwnersInput! non-null input [#wherecompanyupdatebeneficialownersinput-non-null-input] [`CompanyUpdateBeneficialOwnersInput!`](/types/inputs/company-update-beneficial-owners-input) Type [#type] Boolean scalar [#boolean-scalar] [`Boolean`](/types/scalars/boolean) The `Boolean` scalar type represents `true` or `false`. URL: /connect/docs/mutations/company-update-shareholders # companyUpdateShareholders import { Callout } from 'fumadocs-ui/components/callout'; Update (add/edit/remove) direct shareholders of a company. ```graphql companyUpdateShareholders( where: CompanyUpdateShareholdersInput! ): Boolean! ``` Arguments [#arguments] where CompanyUpdateShareholdersInput! non-null input [#wherecompanyupdateshareholdersinput-non-null-input] [`CompanyUpdateShareholdersInput!`](/types/inputs/company-update-shareholders-input) Type [#type] Boolean scalar [#boolean-scalar] [`Boolean`](/types/scalars/boolean) The `Boolean` scalar type represents `true` or `false`. URL: /connect/docs/mutations/create-form-url # createFormUrl import { Callout } from 'fumadocs-ui/components/callout'; Create a new URL for an active customer facing form. ```graphql mutation CreateFormUrl($where: CreateFormUrlInput!) { createFormUrl(where: $where) { success url } } ``` ```graphql input CreateFormUrlInput { companyId: CompanyId! documentId: ID! timeToLive: Int } ``` Arguments [#arguments] where CreateFormUrlInput! non-null input [#wherecreateformurlinput-non-null-input] [`CreateFormUrlInput!`](/types/inputs/create-form-url-input) Type [#type] CreateFormUrlPayload object [#createformurlpayload-object] [`CreateFormUrlPayload`](/types/objects/create-form-url-payload) The payload for creating a new URL for a customer facing form. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) url String scalar [#urlstring-scalar] [`String`](/types/scalars/string) The newly created URL for the form. URL: /connect/docs/mutations/custom-company-create # customCompanyCreate import { Callout } from 'fumadocs-ui/components/callout'; Create a custom company. ```graphql mutation CustomCompanyCreate($where: CustomCompanyCreateInput!) { customCompanyCreate(where: $where) { success company { id name } } } ``` ```graphql input CustomCompanyCreateInput { name: String! country: CountryCode legalForm: LegalFormKind orgNumber: String inceptionDate: ConnectPartialDateInput address: AddressInput shareholders: [CompanyOwnershipInput!] companyShareholders: [CompanyOwnershipInput!]! personShareholders: [BusinessPersonOwnershipInput!]! } ``` Arguments [#arguments] where CustomCompanyCreateInput! non-null input [#wherecustomcompanycreateinput-non-null-input] [`CustomCompanyCreateInput!`](/types/inputs/custom-company-create-input) Type [#type] CustomCompanyPayload object [#customcompanypayload-object] [`CustomCompanyPayload`](/types/objects/custom-company-payload) The payload for a custom company mutation. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) company Company object [#companycompany-object] [`Company`](/types/objects/company) A company resource. URL: /connect/docs/mutations/custom-company-delete # customCompanyDelete import { Callout } from 'fumadocs-ui/components/callout'; Delete a custom company. ```graphql mutation CustomCompanyDelete($where: CustomCompanyWhereInput!) { customCompanyDelete(where: $where) { success company { id name } } } ``` ```graphql input CustomCompanyWhereInput { id: CompanyId! } ``` Arguments [#arguments] where CustomCompanyWhereInput! non-null input [#wherecustomcompanywhereinput-non-null-input] [`CustomCompanyWhereInput!`](/types/inputs/custom-company-where-input) Type [#type] CustomCompanyPayload object [#customcompanypayload-object] [`CustomCompanyPayload`](/types/objects/custom-company-payload) The payload for a custom company mutation. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) company Company object [#companycompany-object] [`Company`](/types/objects/company) A company resource. URL: /connect/docs/mutations/custom-company-update # customCompanyUpdate import { Callout } from 'fumadocs-ui/components/callout'; Update a custom company. ```graphql mutation CustomCompanyUpdate($where: CustomCompanyUpdateInput!) { customCompanyUpdate(where: $where) { success company { id name } } } ``` ```graphql input CustomCompanyUpdateInput { id: CompanyId! name: String! country: CountryCode legalForm: LegalFormKind orgNumber: String inceptionDate: ConnectPartialDateInput address: AddressInput shareholders: [CompanyOwnershipInput!] companyShareholders: [CompanyOwnershipInput!]! personShareholders: [BusinessPersonOwnershipInput!]! } ``` Arguments [#arguments] where CustomCompanyUpdateInput! non-null input [#wherecustomcompanyupdateinput-non-null-input] [`CustomCompanyUpdateInput!`](/types/inputs/custom-company-update-input) Type [#type] CustomCompanyPayload object [#customcompanypayload-object] [`CustomCompanyPayload`](/types/objects/custom-company-payload) The payload for a custom company mutation. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) company Company object [#companycompany-object] [`Company`](/types/objects/company) A company resource. URL: /connect/docs/mutations/custom-person-create # customPersonCreate import { Callout } from 'fumadocs-ui/components/callout'; Create a custom person. ```graphql mutation CustomPersonCreate($where: CustomPersonCreateInput!) { customPersonCreate(where: $where) { success person { id name } } } ``` ```graphql input CustomPersonCreateInput { name: String! citizenship: CountryCode birthDate: ConnectPartialDateInput nin: String sex: Gender address: [AddressInput!]! } ``` Arguments [#arguments] where CustomPersonCreateInput! non-null input [#wherecustompersoncreateinput-non-null-input] [`CustomPersonCreateInput!`](/types/inputs/custom-person-create-input) Type [#type] CustomPersonPayload object [#custompersonpayload-object] [`CustomPersonPayload`](/types/objects/custom-person-payload) The payload for a custom person mutation. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) person BusinessPerson object [#personbusinessperson-object] [`BusinessPerson`](/types/objects/business-person) A person resource. URL: /connect/docs/mutations/custom-person-delete # customPersonDelete import { Callout } from 'fumadocs-ui/components/callout'; Delete a custom person. ```graphql mutation CustomPersonDelete($where: BusinessPersonWhereInput!) { customPersonDelete(where: $where) { success person { id name } } } ``` ```graphql input BusinessPersonWhereInput { id: BusinessPersonId! } ``` Arguments [#arguments] where BusinessPersonWhereInput! non-null input [#wherebusinesspersonwhereinput-non-null-input] [`BusinessPersonWhereInput!`](/types/inputs/business-person-where-input) Type [#type] CustomPersonPayload object [#custompersonpayload-object] [`CustomPersonPayload`](/types/objects/custom-person-payload) The payload for a custom person mutation. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) person BusinessPerson object [#personbusinessperson-object] [`BusinessPerson`](/types/objects/business-person) A person resource. URL: /connect/docs/mutations/custom-person-edit # customPersonEdit import { Callout } from 'fumadocs-ui/components/callout'; Edit the details of a custom person. ```graphql mutation CustomPersonEdit($where: CustomPersonEditInput!) { customPersonEdit(where: $where) { success person { id name } } } ``` ```graphql input CustomPersonEditInput { id: BusinessPersonId! name: String! citizenship: CountryCode birthDate: ConnectPartialDateInput nin: String sex: Gender address: [AddressInput!]! } ``` Arguments [#arguments] where CustomPersonEditInput! non-null input [#wherecustompersoneditinput-non-null-input] [`CustomPersonEditInput!`](/types/inputs/custom-person-edit-input) Type [#type] CustomPersonPayload object [#custompersonpayload-object] [`CustomPersonPayload`](/types/objects/custom-person-payload) The payload for a custom person mutation. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) person BusinessPerson object [#personbusinessperson-object] [`BusinessPerson`](/types/objects/business-person) A person resource. URL: /connect/docs/mutations/entity-update-custom-risk-field # entityUpdateCustomRiskField import { Callout } from 'fumadocs-ui/components/callout'; Update the selected options for a custom risk field on an entity. ```graphql mutation EntityUpdateCustomRiskField($where: EntityCustomRiskFieldUpdateInput!) { entityUpdateCustomRiskField(where: $where) { riskField { id name kind options { id name } } selectedOptions { id name } } } ``` ```graphql input EntityCustomRiskFieldUpdateInput { id: ID! riskFieldId: ID! selectedOptionIds: [ID!]! } ``` Arguments [#arguments] where EntityCustomRiskFieldUpdateInput! non-null input [#whereentitycustomriskfieldupdateinput-non-null-input] [`EntityCustomRiskFieldUpdateInput!`](/types/inputs/entity-custom-risk-field-update-input) Type [#type] EntityCustomRiskField object [#entitycustomriskfield-object] [`EntityCustomRiskField`](/types/objects/entity-custom-risk-field) Response Fields [#response-fields] riskField CustomRiskField! non-null object [#riskfieldcustomriskfield-non-null-object] [`CustomRiskField!`](/types/objects/custom-risk-field) selectedOptions [CustomRiskFieldOption!]! non-null object [#selectedoptionscustomriskfieldoption-non-null-object] [`[CustomRiskFieldOption!]!`](/types/objects/custom-risk-field-option) URL: /connect/docs/mutations/private-person-add-to-monitoring # privatePersonAddToMonitoring import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql mutation PrivatePersonAddToMonitoring($where: PrivatePersonWhereInput!) { privatePersonAddToMonitoring(where: $where) { success person { id name } } } ``` ```graphql input PrivatePersonWhereInput { id: PrivatePersonId! } ``` Arguments [#arguments] where PrivatePersonWhereInput! non-null input [#whereprivatepersonwhereinput-non-null-input] [`PrivatePersonWhereInput!`](/types/inputs/private-person-where-input) Type [#type] PrivatePersonPayload object [#privatepersonpayload-object] [`PrivatePersonPayload`](/types/objects/private-person-payload) The payload for a PrivatePerson mutation. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) person PrivatePerson object [#personprivateperson-object] [`PrivatePerson`](/types/objects/private-person) URL: /connect/docs/mutations/private-person-create-no-enrich # privatePersonCreateNoEnrich import { Callout } from 'fumadocs-ui/components/callout'; Creates a private person without enriching their data with data from registries. Use together with privatePersonRegistrySearch to verify registry data before creating. ```graphql mutation PrivatePersonCreateNoEnrich($where: PrivatePersonCreateInput!) { privatePersonCreateNoEnrich(where: $where) { success person { id name } } } ``` ```graphql input PrivatePersonCreateInput { name: String! nin: String! country: CountryCode! birthDate: Date birthYear: Year gender: Gender address: [AddressInput!]! citizenship: CountryCode } ``` Arguments [#arguments] where PrivatePersonCreateInput! non-null input [#whereprivatepersoncreateinput-non-null-input] [`PrivatePersonCreateInput!`](/types/inputs/private-person-create-input) Type [#type] PrivatePersonPayload object [#privatepersonpayload-object] [`PrivatePersonPayload`](/types/objects/private-person-payload) The payload for a PrivatePerson mutation. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) person PrivatePerson object [#personprivateperson-object] [`PrivatePerson`](/types/objects/private-person) URL: /connect/docs/mutations/private-person-create # privatePersonCreate import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql mutation PrivatePersonCreate($where: PrivatePersonCreateInput!) { privatePersonCreate(where: $where) { success person { id name } } } ``` ```graphql input PrivatePersonCreateInput { name: String! nin: String! country: CountryCode! birthDate: Date birthYear: Year gender: Gender address: [AddressInput!]! citizenship: CountryCode } ``` Arguments [#arguments] where PrivatePersonCreateInput! non-null input [#whereprivatepersoncreateinput-non-null-input] [`PrivatePersonCreateInput!`](/types/inputs/private-person-create-input) Type [#type] PrivatePersonPayload object [#privatepersonpayload-object] [`PrivatePersonPayload`](/types/objects/private-person-payload) The payload for a PrivatePerson mutation. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) person PrivatePerson object [#personprivateperson-object] [`PrivatePerson`](/types/objects/private-person) URL: /connect/docs/mutations/private-person-delete # privatePersonDelete import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql mutation PrivatePersonDelete($where: PrivatePersonWhereInput!) { privatePersonDelete(where: $where) { success person { id name } } } ``` ```graphql input PrivatePersonWhereInput { id: PrivatePersonId! } ``` Arguments [#arguments] where PrivatePersonWhereInput! non-null input [#whereprivatepersonwhereinput-non-null-input] [`PrivatePersonWhereInput!`](/types/inputs/private-person-where-input) Type [#type] PrivatePersonPayload object [#privatepersonpayload-object] [`PrivatePersonPayload`](/types/objects/private-person-payload) The payload for a PrivatePerson mutation. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) person PrivatePerson object [#personprivateperson-object] [`PrivatePerson`](/types/objects/private-person) URL: /connect/docs/mutations/private-person-remove-from-monitoring # privatePersonRemoveFromMonitoring import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql mutation PrivatePersonRemoveFromMonitoring($where: PrivatePersonWhereInput!) { privatePersonRemoveFromMonitoring(where: $where) { success person { id name } } } ``` ```graphql input PrivatePersonWhereInput { id: PrivatePersonId! } ``` Arguments [#arguments] where PrivatePersonWhereInput! non-null input [#whereprivatepersonwhereinput-non-null-input] [`PrivatePersonWhereInput!`](/types/inputs/private-person-where-input) Type [#type] PrivatePersonPayload object [#privatepersonpayload-object] [`PrivatePersonPayload`](/types/objects/private-person-payload) The payload for a PrivatePerson mutation. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) person PrivatePerson object [#personprivateperson-object] [`PrivatePerson`](/types/objects/private-person) URL: /connect/docs/mutations/private-person-update # privatePersonUpdate import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql mutation PrivatePersonUpdate($where: PrivatePersonUpdateInput!) { privatePersonUpdate(where: $where) { success person { id name } } } ``` ```graphql input PrivatePersonUpdateInput { id: PrivatePersonId! name: String nin: String country: CountryCode birthDate: Date birthYear: Year gender: Gender address: [AddressInput!] citizenship: CountryCode } ``` Arguments [#arguments] where PrivatePersonUpdateInput! non-null input [#whereprivatepersonupdateinput-non-null-input] [`PrivatePersonUpdateInput!`](/types/inputs/private-person-update-input) Type [#type] PrivatePersonPayload object [#privatepersonpayload-object] [`PrivatePersonPayload`](/types/objects/private-person-payload) The payload for a PrivatePerson mutation. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) person PrivatePerson object [#personprivateperson-object] [`PrivatePerson`](/types/objects/private-person) URL: /connect/docs/mutations/private-persons-add-to-monitoring # privatePersonsAddToMonitoring import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql mutation PrivatePersonsAddToMonitoring($where: PrivatePersonsWhereInput!) { privatePersonsAddToMonitoring(where: $where) { failed allSuccessful } } ``` ```graphql input PrivatePersonsWhereInput { ids: [PrivatePersonId!]! } ``` Arguments [#arguments] where PrivatePersonsWhereInput! non-null input [#whereprivatepersonswhereinput-non-null-input] [`PrivatePersonsWhereInput!`](/types/inputs/private-persons-where-input) Type [#type] PersonBulkPayloadResource object [#personbulkpayloadresource-object] [`PersonBulkPayloadResource`](/types/objects/person-bulk-payload-resource) Response for bulk adding persons to monitoring. Response Fields [#response-fields] failed [PrivatePersonId!]! non-null scalar [#failedprivatepersonid-non-null-scalar] [`[PrivatePersonId!]!`](/types/scalars/private-person-id) allSuccessful Boolean! non-null scalar [#allsuccessfulboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) URL: /connect/docs/mutations/review-company-create # reviewCompanyCreate import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql mutation ReviewCompanyCreate($where: CompanyWhereInput!) { reviewCompanyCreate(where: $where) { success risk id context { triggerId relation { edges { kind explanation custom node { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } details { ... on OwnershipRelationDetails { share } } } } explanations entity { ... on Company { id name } ... on BusinessPerson { id name } ... on CustomBusinessPerson { id name } ... on PrivatePerson { id name } } } } } ``` ```graphql input CompanyWhereInput { id: CompanyId! } ``` Arguments [#arguments] where CompanyWhereInput! non-null input [#wherecompanywhereinput-non-null-input] [`CompanyWhereInput!`](/types/inputs/company-where-input) Type [#type] ReviewPayload object [#reviewpayload-object] [`ReviewPayload`](/types/objects/review-payload) Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) risk RiskClass! non-null enum [#riskriskclass-non-null-enum] [`RiskClass!`](/types/enums/risk-class) id ID scalar [#idid-scalar] [`ID`](/types/scalars/id) Has a value only when the review is automatically completed, which is dependent on configured risk class settings. context ReviewContext object [#contextreviewcontext-object] [`ReviewContext`](/types/objects/review-context) URL: /connect/docs/mutations/review-private-person-create # reviewPrivatePersonCreate import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql mutation ReviewPrivatePersonCreate($where: PrivatePersonWhereInput!) { reviewPrivatePersonCreate(where: $where) { success risk id context { triggerId relation { edges { kind explanation custom node { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } details { ... on OwnershipRelationDetails { share } } } } explanations entity { ... on Company { id name } ... on BusinessPerson { id name } ... on CustomBusinessPerson { id name } ... on PrivatePerson { id name } } } } } ``` ```graphql input PrivatePersonWhereInput { id: PrivatePersonId! } ``` Arguments [#arguments] where PrivatePersonWhereInput! non-null input [#whereprivatepersonwhereinput-non-null-input] [`PrivatePersonWhereInput!`](/types/inputs/private-person-where-input) Type [#type] PrivatePersonReviewPayload object [#privatepersonreviewpayload-object] [`PrivatePersonReviewPayload`](/types/objects/private-person-review-payload) Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) risk RiskClass! non-null enum [#riskriskclass-non-null-enum] [`RiskClass!`](/types/enums/risk-class) id ID scalar [#idid-scalar] [`ID`](/types/scalars/id) Has a value only when the review is automatically completed, which is dependent on configured risk class settings. context ReviewContext object [#contextreviewcontext-object] [`ReviewContext`](/types/objects/review-context) URL: /connect/docs/mutations/review-trigger-event-generate # reviewTriggerEventGenerate import { Callout } from 'fumadocs-ui/components/callout'; Mutate the database in such a way that it satisfies a review trigger and adds the given company to review. This is only available in sandbox. ```graphql mutation ReviewTriggerEventGenerate($where: CompanyWhereInput!) { reviewTriggerEventGenerate(where: $where) { success company { id name } } } ``` ```graphql input CompanyWhereInput { id: CompanyId! } ``` Arguments [#arguments] where CompanyWhereInput! non-null input [#wherecompanywhereinput-non-null-input] [`CompanyWhereInput!`](/types/inputs/company-where-input) Type [#type] CompanyPayload object [#companypayload-object] [`CompanyPayload`](/types/objects/company-payload) The payload for a company mutation. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) company Company object [#companycompany-object] [`Company`](/types/objects/company) A company resource. URL: /connect/docs/mutations/sandbox-alert-generate # sandboxAlertGenerate import { Callout } from 'fumadocs-ui/components/callout'; Generate a PEP or sanction alert for a monitored entity in sandbox. This mutation creates a new screening hit, builds the aggregate, and triggers an alert. Only available in sandbox environment. ```graphql mutation SandboxAlertGenerate($where: SandboxAlertInput!) { sandboxAlertGenerate(where: $where) { success } } ``` ```graphql input SandboxAlertInput { monitoredEntity: ID! alertType: SandboxAlertType! relatedEntity: ID action: SandboxAlertAction = ADD } ``` Arguments [#arguments] where SandboxAlertInput! non-null input [#wheresandboxalertinput-non-null-input] [`SandboxAlertInput!`](/types/inputs/sandbox-alert-input) Type [#type] SandboxAlertPayload object [#sandboxalertpayload-object] [`SandboxAlertPayload`](/types/objects/sandbox-alert-payload) Payload returned after generating a sandbox alert Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether the alert was successfully generated URL: /connect/docs/mutations/send-form # sendForm import { Callout } from 'fumadocs-ui/components/callout'; Send a customer facing form to an email. ```graphql mutation SendForm($where: SendFormInput!) { sendForm(where: $where) { success formInstanceId } } ``` ```graphql input SendFormInput { companyId: CompanyId! formId: CustomerFacingFormId! recipientEmail: String! recipientName: String! } ``` Arguments [#arguments] where SendFormInput! non-null input [#wheresendforminput-non-null-input] [`SendFormInput!`](/types/inputs/send-form-input) Type [#type] SendFormPayload object [#sendformpayload-object] [`SendFormPayload`](/types/objects/send-form-payload) The payload for sending a customer facing form. Response Fields [#response-fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) formInstanceId FormInstanceId scalar [#forminstanceidforminstanceid-scalar] [`FormInstanceId`](/types/scalars/form-instance-id) The id of the created form instance URL: /connect/docs/queries/alert-data # alertData import { Callout } from 'fumadocs-ui/components/callout'; BETA FEATURE: This query is in beta and will change without warning. Retrieve the change data that triggered the alert. ```graphql query AlertData($alert: AlertId!) { alertData(alert: $alert) { monitoredEntityId monitoredEntity { ... on Company { id name } ... on PrivatePerson { id name } } kind computedAt change { ... on CompanyPepChange { pepChanges { person { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } relationsToMonitoredEntity toValue { pep rca confirmedPepStatus confirmedRcaStatus hits { name aliases dateOfBirth { dayOfMonth month year } countries { code name } pep roles { description details startDate endDate } rca relations { description name birthDate roles { description details startDate endDate } externalUrls } custom externalUrls confirmedMatch } } fromValue { pep rca confirmedPepStatus confirmedRcaStatus hits { name aliases dateOfBirth { dayOfMonth month year } countries { code name } pep roles { description details startDate endDate } rca relations { description name birthDate roles { description details startDate endDate } externalUrls } custom externalUrls confirmedMatch } } } kind } ... on CompanyRelationsChange { roleChange { toValue { roleTitle period { from to } isActive entity { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } fromValue { roleTitle period { from to } isActive entity { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } } beneficialOwnerChange { toValue { reasons editMetadata { editKind updatedAt editedBy { id name avatar email accountKind } comment } entity { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } fromValue { reasons editMetadata { editKind updatedAt editedBy { id name avatar email accountKind } comment } entity { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } } ownershipChange { toValue { shareClasses { shareClass sharePercentage { from to } } totalSharePercentage { from to } editMetadata { editKind updatedAt editedBy { id name avatar email accountKind } comment } entity { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } fromValue { shareClasses { shareClass sharePercentage { from to } } totalSharePercentage { from to } editMetadata { editKind updatedAt editedBy { id name avatar email accountKind } comment } entity { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } } kind } ... on CompanySanctionChange { sanctionChanges { entity { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } relationsToMonitoredEntity toValue { sanctioned sanctions { sanctionedBy sourceReference sanctionedSince program sourceUrl confirmedMatch } } fromValue { sanctioned sanctions { sanctionedBy sourceReference sanctionedSince program sourceUrl confirmedMatch } } } kind } } } } ``` Arguments [#arguments] alert AlertId! non-null scalar [#alertalertid-non-null-scalar] [`AlertId!`](/types/scalars/alert-id) Type [#type] MonitoringChange object [#monitoringchange-object] [`MonitoringChange`](/types/objects/monitoring-change) The data change that triggered an alert. Response Fields [#response-fields] monitoredEntityId ID! non-null scalar [#monitoredentityidid-non-null-scalar] [`ID!`](/types/scalars/id) The ID of the monitored entity. Always present even if the entity itself has been deleted. monitoredEntity MonitoredEntityLike interface [#monitoredentitymonitoredentitylike-interface] [`MonitoredEntityLike`](/types/interfaces/monitored-entity-like) kind DatasetKind! non-null enum [#kinddatasetkind-non-null-enum] [`DatasetKind!`](/types/enums/dataset-kind) The type of change. Determines which 'xChanges' fields are populated with data. computedAt DateTime! non-null scalar [#computedatdatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) The time at which the change was seen (when the difference was computed). change ChangeLike! non-null interface [#changechangelike-non-null-interface] [`ChangeLike!`](/types/interfaces/change-like) The change data, whose structure is defined by 'kind'. URL: /connect/docs/queries/alerts # alerts import { Callout } from 'fumadocs-ui/components/callout'; BETA FEATURE: This query is in beta and will change without warning. Retrieve alerts. ```graphql query Alerts($where: AlertsWhereInput!) { alerts(where: $where) { pageInfo { size offset totalSize nextPageOffset } edges { node { id kind insertedAt computedAt state resolvedBy { id name avatar email accountKind } resolvedAt } monitoredEntityId monitoredEntity { ... on Company { id name } ... on PrivatePerson { id name } } } } } ``` ```graphql input AlertsWhereInput { entity: ID kinds: [DatasetKind!] states: [AlertState!] page: AlertPageInfoInput period: TimespanInput entityKind: EntityKind } ``` Arguments [#arguments] where AlertsWhereInput! non-null input [#wherealertswhereinput-non-null-input] [`AlertsWhereInput!`](/types/inputs/alerts-where-input) Type [#type] AlertConnection object [#alertconnection-object] [`AlertConnection`](/types/objects/alert-connection) Response Fields [#response-fields] pageInfo PageInfo! non-null object [#pageinfopageinfo-non-null-object] [`PageInfo!`](/types/objects/page-info) edges [AlertConnectionEdge!]! non-null object [#edgesalertconnectionedge-non-null-object] [`[AlertConnectionEdge!]!`](/types/objects/alert-connection-edge) URL: /connect/docs/queries/business-person-search # businessPersonSearch import { Callout } from 'fumadocs-ui/components/callout'; Search for a business person by certain parameters, such as name, country, and birth date. Returns the first 50 hits. If you can't find the person you're looking for, try to narrow down the search by further specifying the search parameters. ```graphql query BusinessPersonSearch($where: ConnectBusinessPersonSearchInput!) { businessPersonSearch(where: $where) { edges { node { id name } } } } ``` ```graphql input ConnectBusinessPersonSearchInput { query: String! country: CountryCode gender: Gender birthDate: Date birthYear: Year } ``` Arguments [#arguments] where ConnectBusinessPersonSearchInput! non-null input [#whereconnectbusinesspersonsearchinput-non-null-input] [`ConnectBusinessPersonSearchInput!`](/types/inputs/connect-business-person-search-input) Type [#type] BusinessPersonSearchConnection object [#businesspersonsearchconnection-object] [`BusinessPersonSearchConnection`](/types/objects/business-person-search-connection) Response Fields [#response-fields] edges [BusinessPersonSearchConnectionEdge!]! non-null object [#edgesbusinesspersonsearchconnectionedge-non-null-object] [`[BusinessPersonSearchConnectionEdge!]!`](/types/objects/business-person-search-connection-edge) URL: /connect/docs/queries/business-person # businessPerson import { Callout } from 'fumadocs-ui/components/callout'; Find a business person by their internal Strise ID. ```graphql query BusinessPerson($where: BusinessPersonWhereInput!) { businessPerson(where: $where) { id gender birthDate birthYear pepInfo { pep rca confirmedPepStatus confirmedRcaStatus hits { name aliases dateOfBirth { dayOfMonth month year } countries { code name } pep roles { description details startDate endDate } rca relations { description name birthDate roles { description details startDate endDate } externalUrls } custom externalUrls confirmedMatch } } beneficialOwnerships { reasons editMetadata { editKind updatedAt editedBy { id name avatar email accountKind } comment } entity { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } roles { roleTitle period { from to } isActive entity { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } holdings { shareClasses { shareClass sharePercentage { from to } } totalSharePercentage { from to } editMetadata { editKind updatedAt editedBy { id name avatar email accountKind } comment } entity { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } name addresses { country { code name } addressLine city zipCode addressKind } countries { relationship country { code name } } identifiers { value country kind description } relationships { edges { kind explanation custom node { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } details { ... on OwnershipRelationDetails { share } } } } sanctionInfo { sanctioned sanctions { sanctionedBy sourceReference sanctionedSince program sourceUrl confirmedMatch } } ams { id entityId published publisher title summary bodyText url clusteredEvents { id url } authors images entityMentions { text span { start end } entityType containingPhrase containingPhraseSpan { start end } amsPredictions { context { start end } classification score } field amsClassification } topicMentions { topic mentions } eventKind createdBy { id name avatar email accountKind } behindPaywall } flags riskSignals { signals { name riskFactors { name dateTime paths { edges { kinds node { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } } } } } } } ``` ```graphql input BusinessPersonWhereInput { id: BusinessPersonId! } ``` Arguments [#arguments] where BusinessPersonWhereInput! non-null input [#wherebusinesspersonwhereinput-non-null-input] [`BusinessPersonWhereInput!`](/types/inputs/business-person-where-input) Type [#type] BusinessPerson object [#businessperson-object] [`BusinessPerson`](/types/objects/business-person) A resource representing a business person. Response Fields [#response-fields] id BusinessPersonId! non-null scalar [#idbusinesspersonid-non-null-scalar] [`BusinessPersonId!`](/types/scalars/business-person-id) gender Gender enum [#gendergender-enum] [`Gender`](/types/enums/gender) The gender of the person. birthDate Date scalar [#birthdatedate-scalar] [`Date`](/types/scalars/date) The birth date of the person. birthYear Year scalar [#birthyearyear-scalar] [`Year`](/types/scalars/year) The birth year of the person. pepInfo PepInfo! non-null object [#pepinfopepinfo-non-null-object] [`PepInfo!`](/types/objects/pep-info) PEP information. beneficialOwnerships [BeneficialOwner!]! non-null object [#beneficialownershipsbeneficialowner-non-null-object] [`[BeneficialOwner!]!`](/types/objects/beneficial-owner) The beneficial ownerships that the person holds in companies. ignoreEdits Boolean scalar [#ignoreeditsboolean-scalar] [`Boolean`](/types/scalars/boolean) Whether to ignore edits made by users. If set to true, the returned beneficial ownerships will only be based on official registry data, disregarding any edits made by users. roles [Role!]! non-null object [#rolesrole-non-null-object] [`[Role!]!`](/types/objects/role) The roles that the person holds in companies. includePrevious Boolean scalar [#includepreviousboolean-scalar] [`Boolean`](/types/scalars/boolean) Whether to include previous roles, i.e., roles which have been terminated. ignoreEdits Boolean scalar [#ignoreeditsboolean-scalar-1] [`Boolean`](/types/scalars/boolean) Whether to ignore edits made by users. If set to true, the returned roles will only be based on official registry data, disregarding any edits made by users. holdings [Ownership!]! non-null object [#holdingsownership-non-null-object] [`[Ownership!]!`](/types/objects/ownership) The person's direct holdings, i.e., companies owned by this person. minimumSharePercentage Float scalar [#minimumsharepercentagefloat-scalar] [`Float`](/types/scalars/float) The lower bound of the share percentage range to include in the result. Must be greater than or equal to 0, and at most 100. ignoreEdits Boolean scalar [#ignoreeditsboolean-scalar-2] [`Boolean`](/types/scalars/boolean) Whether to ignore edits made by users. If set to true, the returned holdings will only be based on official registry data, disregarding any edits made by users. name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) Entity name. addresses [Address!]! non-null object [#addressesaddress-non-null-object] [`[Address!]!`](/types/objects/address) The available addresses of the entity. countries [CountryContext!]! non-null object [#countriescountrycontext-non-null-object] [`[CountryContext!]!`](/types/objects/country-context) The countries for the Entity. identifiers [EntityIdentifier!]! non-null object [#identifiersentityidentifier-non-null-object] [`[EntityIdentifier!]!`](/types/objects/entity-identifier) The official identifiers for this Entity. Since an Entity can have several ids (even within the same country), this is a list. relationships EntityConnection! non-null object [#relationshipsentityconnection-non-null-object] [`EntityConnection!`](/types/objects/entity-connection) Related entities (e.g. persons, companies) for this entity. Can be UBOs, board members, etc. kind [EntityRelationshipKind!]! non-null enum [#kindentityrelationshipkind-non-null-enum] [`[EntityRelationshipKind!]!`](/types/enums/entity-relationship-kind) The type of relationships to fetch. If not specified, all relationships will be fetched. Providing an empty list will return all relationship preferCustomRelations Boolean! non-null scalar [#prefercustomrelationsboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether or not to prefer custom relations. If true, only custom relations are returned if any exists. Otherwise, officially registered relations are returned sanctionInfo SanctionInfo! non-null object [#sanctioninfosanctioninfo-non-null-object] [`SanctionInfo!`](/types/objects/sanction-info) Sanction information related to this entity. ams [AmsEvent!]! non-null object [#amsamsevent-non-null-object] [`[AmsEvent!]!`](/types/objects/ams-event) Adverse media articles found for this entity. This field replaces the `amsCount` field, which will eventually be deprecated. The `amsCount` field might differ from the actual number returned here, due to different screening solutions being used. pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Used for pagination. Media articles are sorted by the highest relevance first. flags [FlagKind!]! non-null enum [#flagsflagkind-non-null-enum] [`[FlagKind!]!`](/types/enums/flag-kind) Flagged events found for this entity. riskSignals RiskSignals! non-null object [#risksignalsrisksignals-non-null-object] [`RiskSignals!`](/types/objects/risk-signals) Risk signals. Currently there is only one possible risk signal, 'flags', which is created if we find flags of negative severity. URL: /connect/docs/queries/company-identifier-search # companyIdentifierSearch import { Callout } from 'fumadocs-ui/components/callout'; Find companies their official identifier. ```graphql query CompanyIdentifierSearch($where: CompanyIdentifierSearchInput!, $pageInfo: SizePageInfoInput) { companyIdentifierSearch(where: $where, pageInfo: $pageInfo) { edges { node { id name } searchMatchMetadata { confidence score } } } } ``` ```graphql input CompanyIdentifierSearchInput { identifiers: [String!]! country: CountryCode! } input SizePageInfoInput { size: Int! offset: Int = 0 } ``` Arguments [#arguments] where CompanyIdentifierSearchInput! non-null input [#wherecompanyidentifiersearchinput-non-null-input] [`CompanyIdentifierSearchInput!`](/types/inputs/company-identifier-search-input) pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Type [#type] CompanySearchConnection object [#companysearchconnection-object] [`CompanySearchConnection`](/types/objects/company-search-connection) Response Fields [#response-fields] edges [CompanySearchConnectionEdge!]! non-null object [#edgescompanysearchconnectionedge-non-null-object] [`[CompanySearchConnectionEdge!]!`](/types/objects/company-search-connection-edge) URL: /connect/docs/queries/company-search # companySearch import { Callout } from 'fumadocs-ui/components/callout'; Find companies by search. ```graphql query CompanySearch($where: CompanyNameSearchInput!, $pageInfo: SizePageInfoInput) { companySearch(where: $where, pageInfo: $pageInfo) { edges { node { id name } searchMatchMetadata { confidence score } } } } ``` ```graphql input CompanyNameSearchInput { query: String! country: CountryCode source: CompanySearchSource } input SizePageInfoInput { size: Int! offset: Int = 0 } ``` Arguments [#arguments] where CompanyNameSearchInput! non-null input [#wherecompanynamesearchinput-non-null-input] [`CompanyNameSearchInput!`](/types/inputs/company-name-search-input) pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Type [#type] CompanySearchConnection object [#companysearchconnection-object] [`CompanySearchConnection`](/types/objects/company-search-connection) Response Fields [#response-fields] edges [CompanySearchConnectionEdge!]! non-null object [#edgescompanysearchconnectionedge-non-null-object] [`[CompanySearchConnectionEdge!]!`](/types/objects/company-search-connection-edge) URL: /connect/docs/queries/company # company import { Callout } from 'fumadocs-ui/components/callout'; Find a company by their internal Strise ID. ```graphql query Company($where: CompanyWhereInput!) { company(where: $where) { id industriesV2 { code description codeType } inception organisationFormCodes businessPurposes signatoryRights numberOfEmployees { from to } status { name date isActive } isMonitored isReferenceOnly globalDataSource sourceIdentifier tags { id name created } entityPortfolioStatusInfo { status previousStatus modifiedAt } calculatedRiskLevel { riskLevel { riskLevel label thresholdScore } totalScore countryScore { score matchedValues status } legalFormScore { score matchedValues status } industryScore { score matchedValues status } pepCountScore { score matchedValues status } rcaCountScore { score matchedValues status } sanctionCountScore { score matchedValues status } customRiskFieldsScore { customRiskFieldId scoreResult { score matchedValues status } } timestamp } userAssessedRiskLevel shareholderGraph { rootId nodes { id indirectSharePercentage { from to } shareClasses { shareClass sharePercentage { from to } } isBeneficialOwner entity { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } edges { parent child sharePercentage { from to } } } beneficialOwners { reasons editMetadata { editKind updatedAt editedBy { id name avatar email accountKind } comment } entity { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } roles { roleTitle period { from to } isActive entity { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } shareholders { shareClasses { shareClass sharePercentage { from to } } totalSharePercentage { from to } editMetadata { editKind updatedAt editedBy { id name avatar email accountKind } comment } entity { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } holdings { shareClasses { shareClass sharePercentage { from to } } totalSharePercentage { from to } editMetadata { editKind updatedAt editedBy { id name avatar email accountKind } comment } entity { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } reviews { id pdf createdAt companyId calculatedRiskLevel userAssessedRiskLevel selfAssessment validUntilDate entityStatus } nextScheduledReviewDate documents { id fileName contentType size lastModifiedAt downloadUrl source status } creditScore { reportDate creditLimit creditRating rating ratingDescription hasPaymentRemarks remarks { count totalAmount } partiallySettledRemarks { count totalAmount } voluntaryCollateral { count totalAmount } currencyCode scoreUnavailableReason } customRiskFields { riskField { id name kind options { id name } } selectedOptions { id name } } name addresses { country { code name } addressLine city zipCode addressKind } countries { relationship country { code name } } identifiers { value country kind description } relationships { edges { kind explanation custom node { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } details { ... on OwnershipRelationDetails { share } } } } sanctionInfo { sanctioned sanctions { sanctionedBy sourceReference sanctionedSince program sourceUrl confirmedMatch } } ams { id entityId published publisher title summary bodyText url clusteredEvents { id url } authors images entityMentions { text span { start end } entityType containingPhrase containingPhraseSpan { start end } amsPredictions { context { start end } classification score } field amsClassification } topicMentions { topic mentions } eventKind createdBy { id name avatar email accountKind } behindPaywall } flags riskSignals { signals { name riskFactors { name dateTime paths { edges { kinds node { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } } } } } } } ``` ```graphql input CompanyWhereInput { id: CompanyId! } ``` Arguments [#arguments] where CompanyWhereInput! non-null input [#wherecompanywhereinput-non-null-input] [`CompanyWhereInput!`](/types/inputs/company-where-input) Type [#type] Company object [#company-object] [`Company`](/types/objects/company) A resource representing a registered company. Response Fields [#response-fields] id CompanyId! non-null scalar [#idcompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) industriesV2 [ConnectIndustryCode!]! non-null object [#industriesv2connectindustrycode-non-null-object] [`[ConnectIndustryCode!]!`](/types/objects/connect-industry-code) inception DateTime scalar [#inceptiondatetime-scalar] [`DateTime`](/types/scalars/date-time) organisationFormCodes [String!]! non-null scalar [#organisationformcodesstring-non-null-scalar] [`[String!]!`](/types/scalars/string) businessPurposes [String!]! non-null scalar [#businesspurposesstring-non-null-scalar] [`[String!]!`](/types/scalars/string) signatoryRights String scalar [#signatoryrightsstring-scalar] [`String`](/types/scalars/string) numberOfEmployees EmployeeCountInterval object [#numberofemployeesemployeecountinterval-object] [`EmployeeCountInterval`](/types/objects/employee-count-interval) status ConnectCompanyStatus object [#statusconnectcompanystatus-object] [`ConnectCompanyStatus`](/types/objects/connect-company-status) isMonitored Boolean! non-null scalar [#ismonitoredboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether this company is monitored or not. isReferenceOnly Boolean! non-null scalar [#isreferenceonlyboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Indicates that this company is a reference-only record derived from relationship data. These references are created when a company in a supported market lists a related entity (i.e shareholder, role) from an unsupported jurisdiction. Consequently, the available data is limited to the basic fields provided by the originating market's registry. globalDataSource GlobalDataSource enum [#globaldatasourceglobaldatasource-enum] [`GlobalDataSource`](/types/enums/global-data-source) The global data source for this company (e.g. ORBIS, SAYARI). Null for companies from local registries. sourceIdentifier String scalar [#sourceidentifierstring-scalar] [`String`](/types/scalars/string) The source identifier in the global data source (e.g. BvD ID for Orbis). Null for local registry companies. tags [Tag!]! non-null object [#tagstag-non-null-object] [`[Tag!]!`](/types/objects/tag) Tags added to the company. entityPortfolioStatusInfo EntityPortfolioStatusInfo object [#entityportfoliostatusinfoentityportfoliostatusinfo-object] [`EntityPortfolioStatusInfo`](/types/objects/entity-portfolio-status-info) The entity portfolio status information for the company. calculatedRiskLevel RiskCalculationResult object [#calculatedrisklevelriskcalculationresult-object] [`RiskCalculationResult`](/types/objects/risk-calculation-result) Calculated risk level for the company. Based on team settings. userAssessedRiskLevel RiskLevelKind enum [#userassessedrisklevelrisklevelkind-enum] [`RiskLevelKind`](/types/enums/risk-level-kind) User-assessed risk level for the company. Determined by the user during the review process. shareholderGraph ShareholderGraph object [#shareholdergraphshareholdergraph-object] [`ShareholderGraph`](/types/objects/shareholder-graph) The company's shareholder graph minimumSharePercentage Float scalar [#minimumsharepercentagefloat-scalar] [`Float`](/types/scalars/float) The minimum amount of shares a shareholder must own to be included in the graph. Beneficial owner nodes are included regardless of their share. In addition, nodes that are part of the path between an included node and the root node are included. Must be greater than or equal to 5, and at most 100. beneficialOwners [BeneficialOwner!]! non-null object [#beneficialownersbeneficialowner-non-null-object] [`[BeneficialOwner!]!`](/types/objects/beneficial-owner) The company's beneficial owners ignoreEdits Boolean scalar [#ignoreeditsboolean-scalar] [`Boolean`](/types/scalars/boolean) Whether to ignore edits made by users. If set to true, the returned beneficial owners will only be based on official registry data, disregarding any edits made by users. roles [Role!]! non-null object [#rolesrole-non-null-object] [`[Role!]!`](/types/objects/role) The company's roles includePrevious Boolean scalar [#includepreviousboolean-scalar] [`Boolean`](/types/scalars/boolean) Whether to include previous roles, i.e., roles which have been terminated. ignoreEdits Boolean scalar [#ignoreeditsboolean-scalar-1] [`Boolean`](/types/scalars/boolean) Whether to ignore edits made by users. If set to true, the returned roles will only be based on official registry data, disregarding any edits made by users. shareholders [Ownership!]! non-null object [#shareholdersownership-non-null-object] [`[Ownership!]!`](/types/objects/ownership) The company's direct shareholders. minimumSharePercentage Float scalar [#minimumsharepercentagefloat-scalar-1] [`Float`](/types/scalars/float) The lower bound of the share percentage range to include in the result. Must be greater than or equal to 0, and at most 100. ignoreEdits Boolean scalar [#ignoreeditsboolean-scalar-2] [`Boolean`](/types/scalars/boolean) Whether to ignore edits made by users. If set to true, the returned shareholders will only be based on official registry data, disregarding any edits made by users. holdings [Ownership!]! non-null object [#holdingsownership-non-null-object] [`[Ownership!]!`](/types/objects/ownership) The company's direct holdings, i.e., companies owned by this company. minimumSharePercentage Float scalar [#minimumsharepercentagefloat-scalar-2] [`Float`](/types/scalars/float) The lower bound of the share percentage range to include in the result. Must be greater than or equal to 0, and at most 100. ignoreEdits Boolean scalar [#ignoreeditsboolean-scalar-3] [`Boolean`](/types/scalars/boolean) Whether to ignore edits made by users. If set to true, the returned holdings will only be based on official registry data, disregarding any edits made by users. reviews [Review!]! non-null object [#reviewsreview-non-null-object] [`[Review!]!`](/types/objects/review) Reviews created on this company. nextScheduledReviewDate DateTime scalar [#nextscheduledreviewdatedatetime-scalar] [`DateTime`](/types/scalars/date-time) The date of the next scheduled review, based on the latest review user-assessed risk. documents [Document!]! non-null object [#documentsdocument-non-null-object] [`[Document!]!`](/types/objects/document) List documents and document orders in progress related to the company. creditScore CreditScore object [#creditscorecreditscore-object] [`CreditScore`](/types/objects/credit-score) The company's credit score data from the most recent credit report. Returns null if no credit report has been ordered for this company. customRiskFields [EntityCustomRiskField!]! non-null object [#customriskfieldsentitycustomriskfield-non-null-object] [`[EntityCustomRiskField!]!`](/types/objects/entity-custom-risk-field) Custom risk field values assigned to this company. name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) Entity name. addresses [Address!]! non-null object [#addressesaddress-non-null-object] [`[Address!]!`](/types/objects/address) The available addresses of the entity. countries [CountryContext!]! non-null object [#countriescountrycontext-non-null-object] [`[CountryContext!]!`](/types/objects/country-context) The countries for the Entity. identifiers [EntityIdentifier!]! non-null object [#identifiersentityidentifier-non-null-object] [`[EntityIdentifier!]!`](/types/objects/entity-identifier) The official identifiers for this Entity. Since an Entity can have several ids (even within the same country), this is a list. relationships EntityConnection! non-null object [#relationshipsentityconnection-non-null-object] [`EntityConnection!`](/types/objects/entity-connection) Related entities (e.g. persons, companies) for this entity. Can be UBOs, board members, etc. kind [EntityRelationshipKind!]! non-null enum [#kindentityrelationshipkind-non-null-enum] [`[EntityRelationshipKind!]!`](/types/enums/entity-relationship-kind) The type of relationships to fetch. If not specified, all relationships will be fetched. Providing an empty list will return all relationship preferCustomRelations Boolean! non-null scalar [#prefercustomrelationsboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether or not to prefer custom relations. If true, only custom relations are returned if any exists. Otherwise, officially registered relations are returned sanctionInfo SanctionInfo! non-null object [#sanctioninfosanctioninfo-non-null-object] [`SanctionInfo!`](/types/objects/sanction-info) Sanction information related to this entity. ams [AmsEvent!]! non-null object [#amsamsevent-non-null-object] [`[AmsEvent!]!`](/types/objects/ams-event) Adverse media articles found for this entity. This field replaces the `amsCount` field, which will eventually be deprecated. The `amsCount` field might differ from the actual number returned here, due to different screening solutions being used. pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Used for pagination. Media articles are sorted by the highest relevance first. flags [FlagKind!]! non-null enum [#flagsflagkind-non-null-enum] [`[FlagKind!]!`](/types/enums/flag-kind) Flagged events found for this entity. riskSignals RiskSignals! non-null object [#risksignalsrisksignals-non-null-object] [`RiskSignals!`](/types/objects/risk-signals) Risk signals. Currently there is only one possible risk signal, 'flags', which is created if we find flags of negative severity. URL: /connect/docs/queries/custom-business-person # customBusinessPerson import { Callout } from 'fumadocs-ui/components/callout'; Find a custom business person by their internal Strise ID. ```graphql query CustomBusinessPerson($where: CustomBusinessPersonWhereInput!) { customBusinessPerson(where: $where) { id birthDate birthYear pepInfo { pep rca confirmedPepStatus confirmedRcaStatus hits { name aliases dateOfBirth { dayOfMonth month year } countries { code name } pep roles { description details startDate endDate } rca relations { description name birthDate roles { description details startDate endDate } externalUrls } custom externalUrls confirmedMatch } } name addresses { country { code name } addressLine city zipCode addressKind } countries { relationship country { code name } } identifiers { value country kind description } relationships { edges { kind explanation custom node { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } details { ... on OwnershipRelationDetails { share } } } } sanctionInfo { sanctioned sanctions { sanctionedBy sourceReference sanctionedSince program sourceUrl confirmedMatch } } ams { id entityId published publisher title summary bodyText url clusteredEvents { id url } authors images entityMentions { text span { start end } entityType containingPhrase containingPhraseSpan { start end } amsPredictions { context { start end } classification score } field amsClassification } topicMentions { topic mentions } eventKind createdBy { id name avatar email accountKind } behindPaywall } flags riskSignals { signals { name riskFactors { name dateTime paths { edges { kinds node { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } } } } } } } ``` ```graphql input CustomBusinessPersonWhereInput { id: CustomBusinessPersonId! } ``` Arguments [#arguments] where CustomBusinessPersonWhereInput! non-null input [#wherecustombusinesspersonwhereinput-non-null-input] [`CustomBusinessPersonWhereInput!`](/types/inputs/custom-business-person-where-input) Type [#type] CustomBusinessPerson object [#custombusinessperson-object] [`CustomBusinessPerson`](/types/objects/custom-business-person) A resource representing a user generated custom business person. Response Fields [#response-fields] id CustomBusinessPersonId! non-null scalar [#idcustombusinesspersonid-non-null-scalar] [`CustomBusinessPersonId!`](/types/scalars/custom-business-person-id) birthDate Date scalar [#birthdatedate-scalar] [`Date`](/types/scalars/date) birthYear Year scalar [#birthyearyear-scalar] [`Year`](/types/scalars/year) pepInfo PepInfo! non-null object [#pepinfopepinfo-non-null-object] [`PepInfo!`](/types/objects/pep-info) PEP information. name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) Entity name. addresses [Address!]! non-null object [#addressesaddress-non-null-object] [`[Address!]!`](/types/objects/address) The available addresses of the entity. countries [CountryContext!]! non-null object [#countriescountrycontext-non-null-object] [`[CountryContext!]!`](/types/objects/country-context) The countries for the Entity. identifiers [EntityIdentifier!]! non-null object [#identifiersentityidentifier-non-null-object] [`[EntityIdentifier!]!`](/types/objects/entity-identifier) The official identifiers for this Entity. Since an Entity can have several ids (even within the same country), this is a list. relationships EntityConnection! non-null object [#relationshipsentityconnection-non-null-object] [`EntityConnection!`](/types/objects/entity-connection) Related entities (e.g. persons, companies) for this entity. Can be UBOs, board members, etc. kind [EntityRelationshipKind!]! non-null enum [#kindentityrelationshipkind-non-null-enum] [`[EntityRelationshipKind!]!`](/types/enums/entity-relationship-kind) The type of relationships to fetch. If not specified, all relationships will be fetched. Providing an empty list will return all relationship preferCustomRelations Boolean! non-null scalar [#prefercustomrelationsboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether or not to prefer custom relations. If true, only custom relations are returned if any exists. Otherwise, officially registered relations are returned sanctionInfo SanctionInfo! non-null object [#sanctioninfosanctioninfo-non-null-object] [`SanctionInfo!`](/types/objects/sanction-info) Sanction information related to this entity. ams [AmsEvent!]! non-null object [#amsamsevent-non-null-object] [`[AmsEvent!]!`](/types/objects/ams-event) Adverse media articles found for this entity. This field replaces the `amsCount` field, which will eventually be deprecated. The `amsCount` field might differ from the actual number returned here, due to different screening solutions being used. pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Used for pagination. Media articles are sorted by the highest relevance first. flags [FlagKind!]! non-null enum [#flagsflagkind-non-null-enum] [`[FlagKind!]!`](/types/enums/flag-kind) Flagged events found for this entity. riskSignals RiskSignals! non-null object [#risksignalsrisksignals-non-null-object] [`RiskSignals!`](/types/objects/risk-signals) Risk signals. Currently there is only one possible risk signal, 'flags', which is created if we find flags of negative severity. URL: /connect/docs/queries/custom-risk-fields # customRiskFields import { Callout } from 'fumadocs-ui/components/callout'; List all available custom risk field definitions for the team. ```graphql query CustomRiskFields { customRiskFields { id name kind options { id name } } } ``` Type [#type] CustomRiskField object [#customriskfield-object] [`CustomRiskField`](/types/objects/custom-risk-field) Response Fields [#response-fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) kind CustomRiskFieldKind! non-null enum [#kindcustomriskfieldkind-non-null-enum] [`CustomRiskFieldKind!`](/types/enums/custom-risk-field-kind) options [CustomRiskFieldOption!]! non-null object [#optionscustomriskfieldoption-non-null-object] [`[CustomRiskFieldOption!]!`](/types/objects/custom-risk-field-option) URL: /connect/docs/queries/document # document import { Callout } from 'fumadocs-ui/components/callout'; Fetch a document by document and company id. ```graphql query Document($where: DocumentWhereInput!) { document(where: $where) { id fileName contentType size lastModifiedAt downloadUrl source status } } ``` ```graphql input DocumentWhereInput { companyId: CompanyId! documentId: ID! } ``` Arguments [#arguments] where DocumentWhereInput! non-null input [#wheredocumentwhereinput-non-null-input] [`DocumentWhereInput!`](/types/inputs/document-where-input) Type [#type] Document object [#document-object] [`Document`](/types/objects/document) An object representing a document related to a company. Response Fields [#response-fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) Unique identifier for the document. fileName String! non-null scalar [#filenamestring-non-null-scalar] [`String!`](/types/scalars/string) The file name of the document. contentType String scalar [#contenttypestring-scalar] [`String`](/types/scalars/string) The file's content type. size Long scalar [#sizelong-scalar] [`Long`](/types/scalars/long) The file size, given in bytes. lastModifiedAt ISODateTime scalar [#lastmodifiedatisodatetime-scalar] [`ISODateTime`](/types/scalars/isodate-time) The date and time the document was last modified. downloadUrl String scalar [#downloadurlstring-scalar] [`String`](/types/scalars/string) The URL where the document can be downloaded. source DocumentSource! non-null enum [#sourcedocumentsource-non-null-enum] [`DocumentSource!`](/types/enums/document-source) The source of the document. status DocumentStatus! non-null enum [#statusdocumentstatus-non-null-enum] [`DocumentStatus!`](/types/enums/document-status) The status of the document upload. URL: /connect/docs/queries/list-forms # listForms import { Callout } from 'fumadocs-ui/components/callout'; List the forms available. ```graphql query ListForms { listForms { id title description } } ``` Type [#type] Form object [#form-object] [`Form`](/types/objects/form) A form which can be sent out for a person to fill out. Response Fields [#response-fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) title String! non-null scalar [#titlestring-non-null-scalar] [`String!`](/types/scalars/string) description String scalar [#descriptionstring-scalar] [`String`](/types/scalars/string) URL: /connect/docs/queries/portfolio-companies # portfolioCompanies import { Callout } from 'fumadocs-ui/components/callout'; List companies in your portfolio. ```graphql query PortfolioCompanies($where: ConnectPortfolioCompaniesInput, $pageInfo: SizePageInfoInput) { portfolioCompanies(where: $where, pageInfo: $pageInfo) { edges { node { id name } } pageInfo { size offset totalSize nextPageOffset } } } ``` ```graphql input ConnectPortfolioCompaniesInput { countries: [CountryCode!] statuses: [EntityPortfolioStatus!] } input SizePageInfoInput { size: Int! offset: Int = 0 } ``` Arguments [#arguments] where ConnectPortfolioCompaniesInput input [#whereconnectportfoliocompaniesinput-input] [`ConnectPortfolioCompaniesInput`](/types/inputs/connect-portfolio-companies-input) pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Used for pagination. Default size is 20, max is 100. Type [#type] ConnectPortfolioCompaniesConnection object [#connectportfoliocompaniesconnection-object] [`ConnectPortfolioCompaniesConnection`](/types/objects/connect-portfolio-companies-connection) Response Fields [#response-fields] edges [ConnectPortfolioCompanyEdge!]! non-null object [#edgesconnectportfoliocompanyedge-non-null-object] [`[ConnectPortfolioCompanyEdge!]!`](/types/objects/connect-portfolio-company-edge) pageInfo PageInfo object [#pageinfopageinfo-object] [`PageInfo`](/types/objects/page-info) Will contain a value for paginated searches URL: /connect/docs/queries/private-person-identifier-search # privatePersonIdentifierSearch import { Callout } from 'fumadocs-ui/components/callout'; Find private persons by their official identifier, such as SSN. ```graphql query PrivatePersonIdentifierSearch($where: PrivatePersonIdentifierSearchInput!, $pageInfo: SizePageInfoInput) { privatePersonIdentifierSearch(where: $where, pageInfo: $pageInfo) { edges { node { id name } } pageInfo { size offset totalSize nextPageOffset } } } ``` ```graphql input PrivatePersonIdentifierSearchInput { identifiers: [String!]! country: CountryCode } input SizePageInfoInput { size: Int! offset: Int = 0 } ``` Arguments [#arguments] where PrivatePersonIdentifierSearchInput! non-null input [#whereprivatepersonidentifiersearchinput-non-null-input] [`PrivatePersonIdentifierSearchInput!`](/types/inputs/private-person-identifier-search-input) pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Type [#type] PrivatePersonSearchConnection object [#privatepersonsearchconnection-object] [`PrivatePersonSearchConnection`](/types/objects/private-person-search-connection) Response Fields [#response-fields] edges [PersonSearchConnectionEdge!]! non-null object [#edgespersonsearchconnectionedge-non-null-object] [`[PersonSearchConnectionEdge!]!`](/types/objects/person-search-connection-edge) pageInfo PageInfo object [#pageinfopageinfo-object] [`PageInfo`](/types/objects/page-info) Will contain a value for paginated searches URL: /connect/docs/queries/private-person-registry-search # privatePersonRegistrySearch import { Callout } from 'fumadocs-ui/components/callout'; Find a specific private person in official registries by a combination of identifiers. ```graphql query PrivatePersonRegistrySearch($where: PersonRegistrySearchInput!) { privatePersonRegistrySearch(where: $where) { identifier { value country kind description } name gender birthDate birthYear address { country { code name } addressLine city zipCode addressKind } citizenship { code name } } } ``` ```graphql input PersonRegistrySearchInput { name: String! nin: String birthDate: Date zipCode: String streetName: String houseNumber: String country: CountryCode! } ``` Arguments [#arguments] where PersonRegistrySearchInput! non-null input [#wherepersonregistrysearchinput-non-null-input] [`PersonRegistrySearchInput!`](/types/inputs/person-registry-search-input) Type [#type] ConnectPrivatePersonRegistrySearchResource object [#connectprivatepersonregistrysearchresource-object] [`ConnectPrivatePersonRegistrySearchResource`](/types/objects/connect-private-person-registry-search-resource) A private person search result from a registry. Response Fields [#response-fields] identifier EntityIdentifier object [#identifierentityidentifier-object] [`EntityIdentifier`](/types/objects/entity-identifier) name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) Person name. gender Gender enum [#gendergender-enum] [`Gender`](/types/enums/gender) The gender of the person. birthDate Date scalar [#birthdatedate-scalar] [`Date`](/types/scalars/date) The birth date of the person. birthYear Year scalar [#birthyearyear-scalar] [`Year`](/types/scalars/year) The birth year of the person. address [Address!]! non-null object [#addressaddress-non-null-object] [`[Address!]!`](/types/objects/address) citizenship [Country!]! non-null object [#citizenshipcountry-non-null-object] [`[Country!]!`](/types/objects/country) URL: /connect/docs/queries/private-person-review # privatePersonReview import { Callout } from 'fumadocs-ui/components/callout'; Retrieve a private person review by its id. ```graphql query PrivatePersonReview($where: ReviewWhereInput!) { privatePersonReview(where: $where) { id pdf createdAt privatePersonId userAssessedRiskLevel validUntilDate } } ``` ```graphql input ReviewWhereInput { id: ID! } ``` Arguments [#arguments] where ReviewWhereInput! non-null input [#wherereviewwhereinput-non-null-input] [`ReviewWhereInput!`](/types/inputs/review-where-input) Type [#type] PrivatePersonReview object [#privatepersonreview-object] [`PrivatePersonReview`](/types/objects/private-person-review) Response Fields [#response-fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) The id of the review. pdf Base64EncodedFile scalar [#pdfbase64encodedfile-scalar] [`Base64EncodedFile`](/types/scalars/base-64-encoded-file) The review as a base64 encoded PDF. The PDF is generated asynchronously, if it has not been created yet this field will be 'null'. createdAt DateTime! non-null scalar [#createdatdatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) The review's creation timestamp privatePersonId PrivatePersonId! non-null scalar [#privatepersonidprivatepersonid-non-null-scalar] [`PrivatePersonId!`](/types/scalars/private-person-id) The ID of the private person on which the review was created. userAssessedRiskLevel RiskLevelKind enum [#userassessedrisklevelrisklevelkind-enum] [`RiskLevelKind`](/types/enums/risk-level-kind) User-assessed risk level set during the review process. validUntilDate DateTime scalar [#validuntildatedatetime-scalar] [`DateTime`](/types/scalars/date-time) Date until which the review is valid URL: /connect/docs/queries/private-person-reviews # privatePersonReviews import { Callout } from 'fumadocs-ui/components/callout'; List reviews completed on all entities between the given dates. ```graphql query PrivatePersonReviews($from: DateTime!, $to: DateTime!, $pageSize: Int = 100, $offset: Int = 0) { privatePersonReviews(from: $from, to: $to, pageSize: $pageSize, offset: $offset) { id pdf createdAt privatePersonId userAssessedRiskLevel validUntilDate } } ``` Arguments [#arguments] from DateTime! non-null scalar [#fromdatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) The start date of the review period. to DateTime! non-null scalar [#todatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) The end date of the review period. pageSize Int scalar [#pagesizeint-scalar] [`Int`](/types/scalars/int) The number of items to return per page. Must be in the range \[1, 100]. offset Int scalar [#offsetint-scalar] [`Int`](/types/scalars/int) The offset of the first item to return. Use with pageSize to page through results. Type [#type] PrivatePersonReview object [#privatepersonreview-object] [`PrivatePersonReview`](/types/objects/private-person-review) Response Fields [#response-fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) The id of the review. pdf Base64EncodedFile scalar [#pdfbase64encodedfile-scalar] [`Base64EncodedFile`](/types/scalars/base-64-encoded-file) The review as a base64 encoded PDF. The PDF is generated asynchronously, if it has not been created yet this field will be 'null'. createdAt DateTime! non-null scalar [#createdatdatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) The review's creation timestamp privatePersonId PrivatePersonId! non-null scalar [#privatepersonidprivatepersonid-non-null-scalar] [`PrivatePersonId!`](/types/scalars/private-person-id) The ID of the private person on which the review was created. userAssessedRiskLevel RiskLevelKind enum [#userassessedrisklevelrisklevelkind-enum] [`RiskLevelKind`](/types/enums/risk-level-kind) User-assessed risk level set during the review process. validUntilDate DateTime scalar [#validuntildatedatetime-scalar] [`DateTime`](/types/scalars/date-time) Date until which the review is valid URL: /connect/docs/queries/private-person-search # privatePersonSearch import { Callout } from 'fumadocs-ui/components/callout'; Find private persons by name. ```graphql query PrivatePersonSearch($where: PersonSearchInput!, $pageInfo: SizePageInfoInput) { privatePersonSearch(where: $where, pageInfo: $pageInfo) { edges { node { id name } } pageInfo { size offset totalSize nextPageOffset } } } ``` ```graphql input PersonSearchInput { query: String! country: CountryCode gender: Gender birthDate: Date birthYear: Year hasNin: Boolean } input SizePageInfoInput { size: Int! offset: Int = 0 } ``` Arguments [#arguments] where PersonSearchInput! non-null input [#wherepersonsearchinput-non-null-input] [`PersonSearchInput!`](/types/inputs/person-search-input) pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Maximum page size is 100 Type [#type] PrivatePersonSearchConnection object [#privatepersonsearchconnection-object] [`PrivatePersonSearchConnection`](/types/objects/private-person-search-connection) Response Fields [#response-fields] edges [PersonSearchConnectionEdge!]! non-null object [#edgespersonsearchconnectionedge-non-null-object] [`[PersonSearchConnectionEdge!]!`](/types/objects/person-search-connection-edge) pageInfo PageInfo object [#pageinfopageinfo-object] [`PageInfo`](/types/objects/page-info) Will contain a value for paginated searches URL: /connect/docs/queries/private-person # privatePerson import { Callout } from 'fumadocs-ui/components/callout'; Find a private person by their internal Strise ID. ```graphql query PrivatePerson($where: PrivatePersonWhereInput!) { privatePerson(where: $where) { id name gender birthDate birthYear address { country { code name } addressLine city zipCode addressKind } countries { relationship country { code name } } identifiers { value country kind description } pepInfo { pep rca confirmedPepStatus confirmedRcaStatus hits { name aliases dateOfBirth { dayOfMonth month year } countries { code name } pep roles { description details startDate endDate } rca relations { description name birthDate roles { description details startDate endDate } externalUrls } custom externalUrls confirmedMatch } } tags { id name created } entityPortfolioStatusInfo { status previousStatus modifiedAt } sanctionInfo { sanctioned sanctions { sanctionedBy sourceReference sanctionedSince program sourceUrl confirmedMatch } } relationships { edges { kind explanation custom node { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } details { ... on OwnershipRelationDetails { share } } } } amsCount isMonitored flags riskSignals { signals { name riskFactors { name dateTime paths { edges { kinds node { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } } } } } } userAssessedRiskLevel reviews { id pdf createdAt privatePersonId userAssessedRiskLevel validUntilDate } nextScheduledReviewDate customRiskFields { riskField { id name kind options { id name } } selectedOptions { id name } } ams { id entityId published publisher title summary bodyText url clusteredEvents { id url } authors images entityMentions { text span { start end } entityType containingPhrase containingPhraseSpan { start end } amsPredictions { context { start end } classification score } field amsClassification } topicMentions { topic mentions } eventKind createdBy { id name avatar email accountKind } behindPaywall } } } ``` ```graphql input PrivatePersonWhereInput { id: PrivatePersonId! } ``` Arguments [#arguments] where PrivatePersonWhereInput! non-null input [#whereprivatepersonwhereinput-non-null-input] [`PrivatePersonWhereInput!`](/types/inputs/private-person-where-input) Type [#type] PrivatePerson object [#privateperson-object] [`PrivatePerson`](/types/objects/private-person) A resource representing a private person. Response Fields [#response-fields] id PrivatePersonId! non-null scalar [#idprivatepersonid-non-null-scalar] [`PrivatePersonId!`](/types/scalars/private-person-id) The internal ID of this private person. name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) Person name. gender Gender enum [#gendergender-enum] [`Gender`](/types/enums/gender) The gender of the person. birthDate Date scalar [#birthdatedate-scalar] [`Date`](/types/scalars/date) The birth date of the person. birthYear Year scalar [#birthyearyear-scalar] [`Year`](/types/scalars/year) The birth year of the person. address [Address!]! non-null object [#addressaddress-non-null-object] [`[Address!]!`](/types/objects/address) countries [CountryContext!]! non-null object [#countriescountrycontext-non-null-object] [`[CountryContext!]!`](/types/objects/country-context) identifiers [EntityIdentifier!]! non-null object [#identifiersentityidentifier-non-null-object] [`[EntityIdentifier!]!`](/types/objects/entity-identifier) pepInfo PepInfo! non-null object [#pepinfopepinfo-non-null-object] [`PepInfo!`](/types/objects/pep-info) PEP information. tags [Tag!]! non-null object [#tagstag-non-null-object] [`[Tag!]!`](/types/objects/tag) Tags added to the person. entityPortfolioStatusInfo EntityPortfolioStatusInfo object [#entityportfoliostatusinfoentityportfoliostatusinfo-object] [`EntityPortfolioStatusInfo`](/types/objects/entity-portfolio-status-info) The team-assigned entity portfolio status information for the private person. sanctionInfo SanctionInfo! non-null object [#sanctioninfosanctioninfo-non-null-object] [`SanctionInfo!`](/types/objects/sanction-info) Sanction information. relationships EntityConnection! non-null object [#relationshipsentityconnection-non-null-object] [`EntityConnection!`](/types/objects/entity-connection) kind [EntityRelationshipKind!]! non-null enum [#kindentityrelationshipkind-non-null-enum] [`[EntityRelationshipKind!]!`](/types/enums/entity-relationship-kind) amsCount Int! non-null scalar [#amscountint-non-null-scalar] [`Int!`](/types/scalars/int) The number of adverse media event found on this private person. This is an approximation and the actual number may be lower, but never higher. isMonitored Boolean! non-null scalar [#ismonitoredboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether this private person is monitored or not. flags [FlagKind!]! non-null enum [#flagsflagkind-non-null-enum] [`[FlagKind!]!`](/types/enums/flag-kind) Flagged events for related business persons. riskSignals RiskSignals! non-null object [#risksignalsrisksignals-non-null-object] [`RiskSignals!`](/types/objects/risk-signals) Risk signals. Currently there is only one possible risk signal, 'flags', which is created if we find flags of negative severity. userAssessedRiskLevel RiskLevelKind enum [#userassessedrisklevelrisklevelkind-enum] [`RiskLevelKind`](/types/enums/risk-level-kind) User-assessed risk level for the private person. Determined by the user during the review process. reviews [PrivatePersonReview!]! non-null object [#reviewsprivatepersonreview-non-null-object] [`[PrivatePersonReview!]!`](/types/objects/private-person-review) Reviews created on this private person. nextScheduledReviewDate DateTime scalar [#nextscheduledreviewdatedatetime-scalar] [`DateTime`](/types/scalars/date-time) The date of the next scheduled review, based on the latest review user-assessed risk. customRiskFields [EntityCustomRiskField!]! non-null object [#customriskfieldsentitycustomriskfield-non-null-object] [`[EntityCustomRiskField!]!`](/types/objects/entity-custom-risk-field) Custom risk field values assigned to this private person. ams [AmsEvent!]! non-null object [#amsamsevent-non-null-object] [`[AmsEvent!]!`](/types/objects/ams-event) Adverse media articles found for this entity. This field replaces the `amsCount` field, which will eventually be deprecated. The `amsCount` field might differ from the actual number returned here, due to different screening solutions being used. pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Used for pagination. Media articles are sorted by the highest relevance first. URL: /connect/docs/queries/review-trigger-company-search # reviewTriggerCompanySearch import { Callout } from 'fumadocs-ui/components/callout'; Find all review trigger events delivered for a specific company. ```graphql query ReviewTriggerCompanySearch($where: CompanyReviewTriggerEventWhereInput!, $pageInfo: SizePageInfoInput) { reviewTriggerCompanySearch(where: $where, pageInfo: $pageInfo) { totalCount edges { node { ... on CompanyReviewTriggerEvent { company relations { edges { kind explanation custom node { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } details { ... on OwnershipRelationDetails { share } } } } id triggeredAt statements } ... on PersonReviewTriggerEvent { person id triggeredAt statements } } } } } ``` ```graphql input CompanyReviewTriggerEventWhereInput { company: CompanyId! from: DateTime to: DateTime } input SizePageInfoInput { size: Int! offset: Int = 0 } ``` Arguments [#arguments] where CompanyReviewTriggerEventWhereInput! non-null input [#wherecompanyreviewtriggereventwhereinput-non-null-input] [`CompanyReviewTriggerEventWhereInput!`](/types/inputs/company-review-trigger-event-where-input) pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Type [#type] ReviewTriggerEventSearchConnection object [#reviewtriggereventsearchconnection-object] [`ReviewTriggerEventSearchConnection`](/types/objects/review-trigger-event-search-connection) Response Fields [#response-fields] totalCount Int! non-null scalar [#totalcountint-non-null-scalar] [`Int!`](/types/scalars/int) edges [ReviewTriggerEventSearchConnectionEdge!]! non-null object [#edgesreviewtriggereventsearchconnectionedge-non-null-object] [`[ReviewTriggerEventSearchConnectionEdge!]!`](/types/objects/review-trigger-event-search-connection-edge) URL: /connect/docs/queries/review-trigger-person-search # reviewTriggerPersonSearch import { Callout } from 'fumadocs-ui/components/callout'; Find all review trigger events delivered for a specific private person. ```graphql query ReviewTriggerPersonSearch($where: PersonReviewTriggerEventWhereInput!, $pageInfo: SizePageInfoInput) { reviewTriggerPersonSearch(where: $where, pageInfo: $pageInfo) { totalCount edges { node { ... on CompanyReviewTriggerEvent { company relations { edges { kind explanation custom node { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } details { ... on OwnershipRelationDetails { share } } } } id triggeredAt statements } ... on PersonReviewTriggerEvent { person id triggeredAt statements } } } } } ``` ```graphql input PersonReviewTriggerEventWhereInput { person: PrivatePersonId! from: DateTime to: DateTime } input SizePageInfoInput { size: Int! offset: Int = 0 } ``` Arguments [#arguments] where PersonReviewTriggerEventWhereInput! non-null input [#wherepersonreviewtriggereventwhereinput-non-null-input] [`PersonReviewTriggerEventWhereInput!`](/types/inputs/person-review-trigger-event-where-input) pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Type [#type] ReviewTriggerEventSearchConnection object [#reviewtriggereventsearchconnection-object] [`ReviewTriggerEventSearchConnection`](/types/objects/review-trigger-event-search-connection) Response Fields [#response-fields] totalCount Int! non-null scalar [#totalcountint-non-null-scalar] [`Int!`](/types/scalars/int) edges [ReviewTriggerEventSearchConnectionEdge!]! non-null object [#edgesreviewtriggereventsearchconnectionedge-non-null-object] [`[ReviewTriggerEventSearchConnectionEdge!]!`](/types/objects/review-trigger-event-search-connection-edge) URL: /connect/docs/queries/review-trigger-search # reviewTriggerSearch import { Callout } from 'fumadocs-ui/components/callout'; Find all review trigger events delivered within a given timeframe. ```graphql query ReviewTriggerSearch($where: ReviewTriggerEventWhereInput!, $pageInfo: SizePageInfoInput) { reviewTriggerSearch(where: $where, pageInfo: $pageInfo) { totalCount edges { node { ... on CompanyReviewTriggerEvent { company relations { edges { kind explanation custom node { ... on BusinessPerson { id name } ... on Company { id name } ... on CustomBusinessPerson { id name } } details { ... on OwnershipRelationDetails { share } } } } id triggeredAt statements } ... on PersonReviewTriggerEvent { person id triggeredAt statements } } } } } ``` ```graphql input ReviewTriggerEventWhereInput { from: DateTime to: DateTime } input SizePageInfoInput { size: Int! offset: Int = 0 } ``` Arguments [#arguments] where ReviewTriggerEventWhereInput! non-null input [#wherereviewtriggereventwhereinput-non-null-input] [`ReviewTriggerEventWhereInput!`](/types/inputs/review-trigger-event-where-input) pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Type [#type] ReviewTriggerEventSearchConnection object [#reviewtriggereventsearchconnection-object] [`ReviewTriggerEventSearchConnection`](/types/objects/review-trigger-event-search-connection) Response Fields [#response-fields] totalCount Int! non-null scalar [#totalcountint-non-null-scalar] [`Int!`](/types/scalars/int) edges [ReviewTriggerEventSearchConnectionEdge!]! non-null object [#edgesreviewtriggereventsearchconnectionedge-non-null-object] [`[ReviewTriggerEventSearchConnectionEdge!]!`](/types/objects/review-trigger-event-search-connection-edge) URL: /connect/docs/queries/review # review import { Callout } from 'fumadocs-ui/components/callout'; Retrieve a review by its id. ```graphql query Review($where: ReviewWhereInput!) { review(where: $where) { id pdf createdAt companyId calculatedRiskLevel userAssessedRiskLevel selfAssessment validUntilDate entityStatus } } ``` ```graphql input ReviewWhereInput { id: ID! } ``` Arguments [#arguments] where ReviewWhereInput! non-null input [#wherereviewwhereinput-non-null-input] [`ReviewWhereInput!`](/types/inputs/review-where-input) Type [#type] Review object [#review-object] [`Review`](/types/objects/review) Response Fields [#response-fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) The id of the review. pdf Base64EncodedFile scalar [#pdfbase64encodedfile-scalar] [`Base64EncodedFile`](/types/scalars/base-64-encoded-file) The review as a base64 encoded PDF. The PDF is generated asynchronously, if it has not been created yet this field will be 'null'. createdAt DateTime! non-null scalar [#createdatdatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) The review's creation timestamp companyId CompanyId! non-null scalar [#companyidcompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) The ID of the company on which the review was created. calculatedRiskLevel RiskLevelKind enum [#calculatedrisklevelrisklevelkind-enum] [`RiskLevelKind`](/types/enums/risk-level-kind) Calculated risk level at the time of the review. Based on team settings. userAssessedRiskLevel RiskLevelKind enum [#userassessedrisklevelrisklevelkind-enum] [`RiskLevelKind`](/types/enums/risk-level-kind) User-assessed risk level set during the review process. selfAssessment String scalar [#selfassessmentstring-scalar] [`String`](/types/scalars/string) Self assessment set during the review process. validUntilDate DateTime scalar [#validuntildatedatetime-scalar] [`DateTime`](/types/scalars/date-time) Date until which the review is valid entityStatus EntityPortfolioStatus enum [#entitystatusentityportfoliostatus-enum] [`EntityPortfolioStatus`](/types/enums/entity-portfolio-status) The entity status at the time of the review. URL: /connect/docs/queries/reviews # reviews import { Callout } from 'fumadocs-ui/components/callout'; List reviews completed on all entities between the given dates. ```graphql query Reviews($from: DateTime!, $to: DateTime!, $pageSize: Int = 100, $offset: Int = 0) { reviews(from: $from, to: $to, pageSize: $pageSize, offset: $offset) { id pdf createdAt companyId calculatedRiskLevel userAssessedRiskLevel selfAssessment validUntilDate entityStatus } } ``` Arguments [#arguments] from DateTime! non-null scalar [#fromdatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) The start date of the review period. to DateTime! non-null scalar [#todatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) The end date of the review period. pageSize Int scalar [#pagesizeint-scalar] [`Int`](/types/scalars/int) The number of items to return per page. Must be in the range \[1, 100]. offset Int scalar [#offsetint-scalar] [`Int`](/types/scalars/int) The offset of the first item to return. Use with pageSize to page through results. Type [#type] Review object [#review-object] [`Review`](/types/objects/review) Response Fields [#response-fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) The id of the review. pdf Base64EncodedFile scalar [#pdfbase64encodedfile-scalar] [`Base64EncodedFile`](/types/scalars/base-64-encoded-file) The review as a base64 encoded PDF. The PDF is generated asynchronously, if it has not been created yet this field will be 'null'. createdAt DateTime! non-null scalar [#createdatdatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) The review's creation timestamp companyId CompanyId! non-null scalar [#companyidcompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) The ID of the company on which the review was created. calculatedRiskLevel RiskLevelKind enum [#calculatedrisklevelrisklevelkind-enum] [`RiskLevelKind`](/types/enums/risk-level-kind) Calculated risk level at the time of the review. Based on team settings. userAssessedRiskLevel RiskLevelKind enum [#userassessedrisklevelrisklevelkind-enum] [`RiskLevelKind`](/types/enums/risk-level-kind) User-assessed risk level set during the review process. selfAssessment String scalar [#selfassessmentstring-scalar] [`String`](/types/scalars/string) Self assessment set during the review process. validUntilDate DateTime scalar [#validuntildatedatetime-scalar] [`DateTime`](/types/scalars/date-time) Date until which the review is valid entityStatus EntityPortfolioStatus enum [#entitystatusentityportfoliostatus-enum] [`EntityPortfolioStatus`](/types/enums/entity-portfolio-status) The entity status at the time of the review. URL: /connect/docs/queries/strise # strise import { Callout } from 'fumadocs-ui/components/callout'; Welcome to the Strise Connect API! Need help? Contact us at [tech@strise.ai](mailto:tech@strise.ai) ```graphql strise: String! ``` Type [#type] String scalar [#string-scalar] [`String`](/types/scalars/string) The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text. URL: /connect/docs/types/enums/address-kind # AddressKind import { Callout } from 'fumadocs-ui/components/callout'; The kind of address. ```graphql enum AddressKind { POSTAL REGISTERED TRADING VISITING } ``` Values [#values] POSTAL [#postal] A postal address. REGISTERED [#registered] A registered address. TRADING [#trading] A trading address. VISITING [#visiting] A visiting address. Member Of [#member-of] [`Address`](/types/objects/address) `object` URL: /connect/docs/types/enums/alert-state # AlertState import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql enum AlertState { RESOLVED UNRESOLVED } ``` Values [#values] RESOLVED [#resolved] UNRESOLVED [#unresolved] Member Of [#member-of] [`Alert`](/types/objects/alert) `object` [`AlertsWhereInput`](/types/inputs/alerts-where-input) `input` [`AlertUpdateInput`](/types/inputs/alert-update-input) `input` URL: /connect/docs/types/enums/ams-classification-kind # AmsClassificationKind import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql enum AmsClassificationKind { AFFECTED NEGATIVE NEUTRAL } ``` Values [#values] AFFECTED [#affected] NEGATIVE [#negative] NEUTRAL [#neutral] Member Of [#member-of] [`AmsEntityMention`](/types/objects/ams-entity-mention) `object` [`AmsPrediction`](/types/objects/ams-prediction) `object` URL: /connect/docs/types/enums/ams-event-kind # AmsEventKind import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql enum AmsEventKind { DOW_JONES GEMINI OPOINT USER_CREATED } ``` Values [#values] DOW_JONES [#dow_jones] GEMINI [#gemini] OPOINT [#opoint] USER_CREATED [#user_created] Member Of [#member-of] [`AmsEvent`](/types/objects/ams-event) `object` URL: /connect/docs/types/enums/beneficial-owner-reason-kind # BeneficialOwnerReasonKind import { Callout } from 'fumadocs-ui/components/callout'; Represents the reason for an entity being considered a beneficial owner. ```graphql enum BeneficialOwnerReasonKind { OWNERSHIP OWNERSHIP_FAMILY PATH PATH_FAMILY REGISTER ROLE ULTIMATE_PERSON_WITH_SIGNIFICANT_CONTROL VOTING_POWER VOTING_POWER_FAMILY } ``` Values [#values] OWNERSHIP [#ownership] The entity is considered a beneficial owner due to owning a significant amount of shares in the company, either directly or indirectly. OWNERSHIP_FAMILY [#ownership_family] The same as `OWNERSHIP`, but also including the assumed family's shares. PATH [#path] The entity is considered a beneficial owner due to owning a significant amount of shares in a path of ownerships. The indirect share percentage is ignored. For instance, if a person owns 30% of a company that owns 30% of another company, the person will be considered a beneficial owner of the last company, even though it the person only owns 9% indirectly. PATH_FAMILY [#path_family] The same as `PATH`, but also including the assumed family's shares. REGISTER [#register] The entity is considered a beneficial owner due to being part of an official beneficial owner register. ROLE [#role] The entity is considered a beneficial owner due to a role it holds in the company, or in a company with siginficant control. ULTIMATE_PERSON_WITH_SIGNIFICANT_CONTROL [#ultimate_person_with_significant_control] UK only. The ultimate person with significant control. This is computed by traversing PSCs until an entity with no PSCs is reached. VOTING_POWER [#voting_power] The entity is considered a beneficial owner due to having significant voting power in the company. Voting power is computed by simulating a series of voting scenarios and computing the share of these that the entity is able to change by changing its vote. VOTING_POWER_FAMILY [#voting_power_family] The same as `VOTING_POWER`, but also including the assumed family's voting power. Member Of [#member-of] [`BeneficialOwner`](/types/objects/beneficial-owner) `object` URL: /connect/docs/types/enums/company-reset-field-kind-input # CompanyResetFieldKindInput import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql enum CompanyResetFieldKindInput { BENEFICIAL_OWNERS ROLES SHAREHOLDERS } ``` Values [#values] BENEFICIAL_OWNERS [#beneficial_owners] ROLES [#roles] SHAREHOLDERS [#shareholders] Member Of [#member-of] [`CompanyResetFieldsInput`](/types/inputs/company-reset-fields-input) `input` URL: /connect/docs/types/enums/company-search-source # CompanySearchSource import { Callout } from 'fumadocs-ui/components/callout'; Data source to search companies from. ```graphql enum CompanySearchSource { CUSTOM_ENTITIES LOCAL_REGISTRIES ORBIS SAYARI } ``` Values [#values] CUSTOM_ENTITIES [#custom_entities] Search in custom entities. LOCAL_REGISTRIES [#local_registries] Search in local registries. ORBIS [#orbis] Search in Orbis database. SAYARI [#sayari] Search in Sayari global database. Member Of [#member-of] [`CompanyNameSearchInput`](/types/inputs/company-name-search-input) `input` URL: /connect/docs/types/enums/country-relationship # CountryRelationship import { Callout } from 'fumadocs-ui/components/callout'; The relationship between a country and a context, such as a person's country of residence ```graphql enum CountryRelationship { ADDRESS CITIZENSHIP NATIONALITY REGISTER UNKNOWN } ``` Values [#values] ADDRESS [#address] CITIZENSHIP [#citizenship] NATIONALITY [#nationality] REGISTER [#register] UNKNOWN [#unknown] Member Of [#member-of] [`CountryContext`](/types/objects/country-context) `object` [`CountryContextInput`](/types/inputs/country-context-input) `input` URL: /connect/docs/types/enums/credit-rating # CreditRating import { Callout } from 'fumadocs-ui/components/callout'; The international credit rating scale (A-E). ```graphql enum CreditRating { A B C D E } ``` Values [#values] A [#a] Very Low Risk (score 71-100) B [#b] Low Risk (score 51-70) C [#c] Moderate Risk (score 30-50) D [#d] High Risk (score 1-29) E [#e] No Rating Member Of [#member-of] [`CreditScore`](/types/objects/credit-score) `object` URL: /connect/docs/types/enums/custom-risk-field-kind # CustomRiskFieldKind import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql enum CustomRiskFieldKind { MULTI_SELECT SINGLE_SELECT } ``` Values [#values] MULTI_SELECT [#multi_select] SINGLE_SELECT [#single_select] Member Of [#member-of] [`CustomRiskField`](/types/objects/custom-risk-field) `object` URL: /connect/docs/types/enums/dataset-kind # DatasetKind import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql enum DatasetKind { COMPANY_INFORMATION PEP RELATIONS SANCTIONS } ``` Values [#values] COMPANY_INFORMATION [#company_information] Under development — not yet active. Alerts with this kind will not contain change data. PEP [#pep] RELATIONS [#relations] SANCTIONS [#sanctions] Member Of [#member-of] [`Alert`](/types/objects/alert) `object` [`AlertsWhereInput`](/types/inputs/alerts-where-input) `input` [`ChangeLike`](/types/interfaces/change-like) `interface` [`CompanyPepChange`](/types/objects/company-pep-change) `object` [`CompanyRelationsChange`](/types/objects/company-relations-change) `object` [`CompanySanctionChange`](/types/objects/company-sanction-change) `object` [`MonitoringChange`](/types/objects/monitoring-change) `object` URL: /connect/docs/types/enums/document-source # DocumentSource import { Callout } from 'fumadocs-ui/components/callout'; An enum representing the source of a document. ```graphql enum DocumentSource { COMPANIES_HOUSE KYCKR MANUAL SIGNICAT } ``` Values [#values] COMPANIES_HOUSE [#companies_house] KYCKR [#kyckr] MANUAL [#manual] SIGNICAT [#signicat] Member Of [#member-of] [`Document`](/types/objects/document) `object` URL: /connect/docs/types/enums/document-status # DocumentStatus import { Callout } from 'fumadocs-ui/components/callout'; The status of a document upload. ```graphql enum DocumentStatus { CANCELLED FAILED IN_PROGRESS PENDING SUCCESS } ``` Values [#values] CANCELLED [#cancelled] FAILED [#failed] IN_PROGRESS [#in_progress] PENDING [#pending] SUCCESS [#success] Member Of [#member-of] [`Document`](/types/objects/document) `object` URL: /connect/docs/types/enums/edit-kind # EditKind import { Callout } from 'fumadocs-ui/components/callout'; Represents the type of edit being made on a data point. ```graphql enum EditKind { ADD COMMENT REMOVE REPLACE UPDATE } ``` Values [#values] ADD [#add] COMMENT [#comment] REMOVE [#remove] REPLACE [#replace] UPDATE [#update] Member Of [#member-of] [`EditMetadata`](/types/objects/edit-metadata) `object` URL: /connect/docs/types/enums/entity-identifier-kind # EntityIdentifierKind import { Callout } from 'fumadocs-ui/components/callout'; The kind of an identifier. ```graphql enum EntityIdentifierKind { PRIMARY SECONDARY UNKNOWN } ``` Values [#values] PRIMARY [#primary] A primary identifier for the entity. SECONDARY [#secondary] A secondary identifier for the entity. UNKNOWN [#unknown] An unknown identifier kind. Member Of [#member-of] [`EntityIdentifier`](/types/objects/entity-identifier) `object` URL: /connect/docs/types/enums/entity-kind # EntityKind import { Callout } from 'fumadocs-ui/components/callout'; The type of entity. ```graphql enum EntityKind { COMPANY PRIVATE_PERSON } ``` Values [#values] COMPANY [#company] PRIVATE_PERSON [#private_person] Member Of [#member-of] [`AlertsWhereInput`](/types/inputs/alerts-where-input) `input` URL: /connect/docs/types/enums/entity-portfolio-status # EntityPortfolioStatus import { Callout } from 'fumadocs-ui/components/callout'; An enum representing an entity's portfolio status ```graphql enum EntityPortfolioStatus { ACCOUNT DISQUALIFIED FOLLOWING IGNORED IN_QUALIFICATION PROSPECT QUALIFIED } ``` Values [#values] ACCOUNT [#account] DISQUALIFIED [#disqualified] FOLLOWING [#following] IGNORED [#ignored] IN_QUALIFICATION [#in_qualification] PROSPECT [#prospect] QUALIFIED [#qualified] Member Of [#member-of] [`ConnectPortfolioCompaniesInput`](/types/inputs/connect-portfolio-companies-input) `input` [`EntityPortfolioStatusInfo`](/types/objects/entity-portfolio-status-info) `object` [`Review`](/types/objects/review) `object` URL: /connect/docs/types/enums/entity-relationship-kind # EntityRelationshipKind import { Callout } from 'fumadocs-ui/components/callout'; The kind of relationship between the two entities. ```graphql enum EntityRelationshipKind { BENEFICIAL_OWNERSHIP OTHER OWNERSHIP ROLE } ``` Values [#values] BENEFICIAL_OWNERSHIP [#beneficial_ownership] Some other relationship between the entities. OTHER [#other] Some other relationship between the entities. OWNERSHIP [#ownership] One owns shares in the other. ROLE [#role] One entity holds a role in the other. Member Of [#member-of] [`BusinessPerson`](/types/objects/business-person) `object` [`Company`](/types/objects/company) `object` [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` [`EntityConnectionEdge`](/types/objects/entity-connection-edge) `object` [`EntityLike`](/types/interfaces/entity-like) `interface` [`PathConnectionEdge`](/types/objects/path-connection-edge) `object` [`PrivatePerson`](/types/objects/private-person) `object` URL: /connect/docs/types/enums/flag-kind # FlagKind import { Callout } from 'fumadocs-ui/components/callout'; Flags are notable events for an entity. They can have several different triggers and levels of severity. Examples of triggers for flags are bankruptcy, dissolution, and merger. ```graphql enum FlagKind { AUDITOR_NOTES AUDITOR_RESIGNED BANKRUPTCY BANKRUPTCY_PETITION CAPITAL_INCREASE CEO_RESIGNED CERTIFICATION CHANGE_IN_NACE COMPULSORY_DISSOLUTION COMPULSORY_DISSOLUTION_WARNING COMPULSORY_LIQUIDATION COMPULSORY_LIQUIDATION_WARNING DEBT_RESTRUCTURE DISSOLUTION EMPLOYEE_CHANGE GRANT HIGH_RISK_OWNER LAWSUIT_DEFENDANT LAWSUIT_PLAINTIFF MERGER MULTIPLE_BRANCHES MVA_REGISTER NARINGS_FORBUD NEW_CEO NEW_SUBSIDIARY RISKY_INDUSTRY SIGNIFICANT_CHANGE_IN_INCOME SIGNIFICANT_CHANGE_IN_REVENUE WARNING } ``` Values [#values] AUDITOR_NOTES [#auditor_notes] The company has received notes from the auditor on the annual accounts. AUDITOR_RESIGNED [#auditor_resigned] The auditor of the company has resigned. BANKRUPTCY [#bankruptcy] This company has been declared bankrupt. BANKRUPTCY_PETITION [#bankruptcy_petition] Possible bankruptcy. This company is the defendant in a court case concerning a bankruptcy. CAPITAL_INCREASE [#capital_increase] This company has signalled a capital increase. CEO_RESIGNED [#ceo_resigned] This company's CEO has resigned without a successor. CERTIFICATION [#certification] This company is missing the necessary certifications associated with their industrial code. CHANGE_IN_NACE [#change_in_nace] The company changed its industry code. COMPULSORY_DISSOLUTION [#compulsory_dissolution] The company has been dissolved by the local authorities. COMPULSORY_DISSOLUTION_WARNING [#compulsory_dissolution_warning] A flag signaling that the local authorities have issued a warning about compulsory dissolution to this company. COMPULSORY_LIQUIDATION [#compulsory_liquidation] The company has been liquidated by the local authorities. COMPULSORY_LIQUIDATION_WARNING [#compulsory_liquidation_warning] A flag signaling that the local authorities have issued a warning about compulsory liquidation to this company. DEBT_RESTRUCTURE [#debt_restructure] This company has petitioned for debt restructure negotiations. DISSOLUTION [#dissolution] This company is dissolved. EMPLOYEE_CHANGE [#employee_change] Big change in number of employees GRANT [#grant] This company has received a government grant. HIGH_RISK_OWNER [#high_risk_owner] The company has an owner or a beneficial owner from a high risk country. LAWSUIT_DEFENDANT [#lawsuit_defendant] This company is the defendant in an ongoing trial. LAWSUIT_PLAINTIFF [#lawsuit_plaintiff] This company is the plaintiff in an ongoing trial. MERGER [#merger] This company has completed a merger. MULTIPLE_BRANCHES [#multiple_branches] The company has more than one branches. MVA_REGISTER [#mva_register] The annual accounts indicate earning exceeding the local threshold without being VAT registered. NARINGS_FORBUD [#narings_forbud] The company has a related person that is not allowed to participate in business activities. NEW_CEO [#new_ceo] This company's has a new CEO. NEW_SUBSIDIARY [#new_subsidiary] The company has a new subsidiary. RISKY_INDUSTRY [#risky_industry] A flag signaling a company is in a risky industry. SIGNIFICANT_CHANGE_IN_INCOME [#significant_change_in_income] The company has had significant changes in its income. SIGNIFICANT_CHANGE_IN_REVENUE [#significant_change_in_revenue] The company has had significant changes in its revenue. WARNING [#warning] This company is placed on a warning list. Member Of [#member-of] [`BusinessPerson`](/types/objects/business-person) `object` [`Company`](/types/objects/company) `object` [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` [`EntityLike`](/types/interfaces/entity-like) `interface` [`MonitoredEntityLike`](/types/interfaces/monitored-entity-like) `interface` [`PrivatePerson`](/types/objects/private-person) `object` URL: /connect/docs/types/enums/gender # Gender import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql enum Gender { FEMALE MALE OTHER } ``` Values [#values] FEMALE [#female] Female MALE [#male] Male OTHER [#other] Other Member Of [#member-of] [`BusinessPerson`](/types/objects/business-person) `object` [`ConnectBusinessPersonSearchInput`](/types/inputs/connect-business-person-search-input) `input` [`ConnectPrivatePersonRegistrySearchResource`](/types/objects/connect-private-person-registry-search-resource) `object` [`CustomPersonCreateInput`](/types/inputs/custom-person-create-input) `input` [`CustomPersonEditInput`](/types/inputs/custom-person-edit-input) `input` [`PersonSearchInput`](/types/inputs/person-search-input) `input` [`PrivatePerson`](/types/objects/private-person) `object` [`PrivatePersonCreateInput`](/types/inputs/private-person-create-input) `input` [`PrivatePersonUpdateInput`](/types/inputs/private-person-update-input) `input` URL: /connect/docs/types/enums/global-data-source # GlobalDataSource import { Callout } from 'fumadocs-ui/components/callout'; The external global data source for entity data. ```graphql enum GlobalDataSource { ORBIS SAYARI } ``` Values [#values] ORBIS [#orbis] Orbis global entity source. SAYARI [#sayari] Sayari global entity source. Member Of [#member-of] [`Company`](/types/objects/company) `object` [`CreateCompanyFromGlobalEntityInput`](/types/inputs/create-company-from-global-entity-input) `input` URL: /connect/docs/types/enums/industry-code-type # IndustryCodeType import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql enum IndustryCodeType { DB_25 ISIC_REV_4 SIC_2007 SNI_2007 SNI_2025 SN_2007 SN_202509 TOL_2025 WZ_2008 } ``` Values [#values] DB_25 [#db_25] ISIC_REV_4 [#isic_rev_4] SIC_2007 [#sic_2007] SNI_2007 [#sni_2007] SNI_2025 [#sni_2025] SN_2007 [#sn_2007] SN_202509 [#sn_202509] TOL_2025 [#tol_2025] WZ_2008 [#wz_2008] Member Of [#member-of] [`ConnectIndustryCode`](/types/objects/connect-industry-code) `object` URL: /connect/docs/types/enums/legal-form-kind # LegalFormKind import { Callout } from 'fumadocs-ui/components/callout'; The type of LegalForm ```graphql enum LegalFormKind { BE_AGRI BE_AMA BE_CH_FOU BE_CH_ORG BE_COOP BE_COOP_FORM BE_EIG BE_FOREIGN BE_FOREIGN_ENT BE_GP BE_INS BE_INT_NON_PROFIT BE_JOINT BE_LLC_COOP BE_LLC_COOP_SOCIAL BE_LLC_SOCIAL BE_LP BE_NON_PROFIT BE_NON_PROFIT_INS BE_PARTNER BE_PARTNER_LTD BE_PC BE_PC_LAW BE_PF BE_PFB BE_PLC BE_PLLC BE_PP BE_SCIENCE BE_SOCIAL BE_UC BE_UNLIM BE_VAT BE_WRA DA_ABA DA_AMT DA_ANS DA_APS DA_AS DA_DOD DA_EFO DA_ENK DA_EOF DA_ES DA_EUO DA_FAP DA_FAS DA_FBA1 DA_FBA2 DA_FEO DA_FES DA_FFO DA_FIV DA_FKI DA_FMA DA_FON DA_FOR DA_GUS DA_IS DA_IVS DA_KAS DA_KOM DA_KS DA_MSS DA_OVR DA_PAR DA_PMV DA_REG DA_SCE DA_SMA DA_SOV DA_STA DA_TRU DA_UDL DA_UOP DE_AG DE_AG_CO DE_AG_CO_KG DE_AG_CO_KGAA DE_AG_CO_OHG DE_ANSTALT_OEFFENTLICHEN_RECHTS DE_AS DE_AS_CO_KG DE_AS_LV DE_BESLOTEN_VENNOOTSCHAP DE_BGB_GESELLSCHAFT DE_BV_CO_KG DE_COM_UND DE_DOO DE_EG DE_EGBR DE_EGBR_AG_PARTNER DE_EGBR_GMBH_PARTNER DE_EGBR_UG_PARTNER DE_EGBR_UK_LTD_PARTNER DE_EGMBH_HAFT_PFLICHT DE_EGMBH_UNHAFT_PFLICHT DE_EIGENBETRIEB DE_EK DE_EWIV DE_FOREIGN_PARTNERSHIP DE_FREIER_BERUF DE_GEMEINNUETZIGE_AG DE_GEMEINSAM_KOMMUNALUNTERNEHMEN DE_GMBH DE_GMBH_CO DE_GMBH_CO_KG DE_GMBH_CO_KGAA DE_GMBH_CO_OHG DE_INCORPORATED DE_INC_CO_KG DE_KG DE_KGAA DE_KGAA_CO DE_KOERPERSCHAFT_OEFFENTLICHEN_RECHTS DE_LLC DE_LTD_CO_KG DE_LTD_CO_OHG DE_NP_GMBH DE_NV DE_NV_CO_KG DE_ODD DE_OHG DE_Other DE_PARTG DE_PUBLIC_LTD DE_RECHTLICH_SELSTAE_NIEDERLASSUNG DE_RV DE_SA DE_SARL DE_SARL_CO_KG DE_SCE DE_SE DE_SE_CO_KGAA DE_SOLE_PROPRIETORSHIP DE_SONSTIGE_AUSLAENDISCHE_RECHTSFORM DE_SPA DE_SP_Z_O_O DE_SP_Z_O_O_CO_KG DE_SRL DE_SRO DE_STIFTUNG DE_STIFTUNG_CO_KG DE_STIFTUNG_OEFFENTLICHEN_RECHTS DE_STIFTUNG_PRIVATEN_GMBH DE_STIFTUNG_PRIVATEN_RECHTS DE_STIFTUNG_VEREIN DE_UG DE_UG_CO_KG DE_UK_LTD DE_VE DE_VVAG FI_01 FI_02 FI_03 FI_04 FI_05 FI_06 FI_07 FI_08 FI_09 FI_10 FI_100 FI_101 FI_102 FI_103 FI_104 FI_105 FI_106 FI_107 FI_108 FI_109 FI_11 FI_110 FI_111 FI_112 FI_113 FI_114 FI_115 FI_12 FI_120 FI_13 FI_130 FI_140 FI_141 FI_142 FI_143 FI_144 FI_145 FI_146 FI_147 FI_148 FI_149 FI_150 FI_20 FI_99 FI_ASH FI_ASY FI_AYH FI_ETS FI_HY FI_KOY FI_KVJ FI_OP FI_OSK FI_OT FI_OYJ FI_SCE FI_SCP FI_SE FI_SL FI_SP FI_TYH FI_UNKNOWN FI_VALTLL FI_VOJ FI_VOY FI_VY FR_AGRICOLLECT FR_AGRI_COOP FR_AGRI_PLC_MB FR_CHP_BD FR_CHP_COOP FR_CPLC_BD FR_CUMA FR_LIBERAL_LLC FR_LLC FR_LP_POLICY FR_MARITIME_PLC_BD FR_MIXED_AGRI_PLC_BD FR_MIXED_PLC_BD FR_NATIONAL_PLC_BD FR_NON_TRADING FR_PARTNERSHIP FR_PLC_BD FR_PLC_MB FR_PLC_WORKER FR_SAFER_BD FR_SASU FR_SJSC FR_SPLC FR_UNION_AGRI_COOP FR_WPCS_BD GLOBAL_COOPERATIVE GLOBAL_FOUNDATION GLOBAL_GOVERNMENT_ENTITY GLOBAL_LIMITED_COMPANY GLOBAL_LIMITED_PARTNERSHIP GLOBAL_NON_PROFIT GLOBAL_OTHER GLOBAL_PARTNERSHIP GLOBAL_PUBLIC_LIMITED_COMPANY GLOBAL_SOLE_PROPRIETORSHIP GLOBAL_TRUST LU_AGRI LU_ANO LU_ANO_SIMPLE LU_CIVIL LU_CLS LU_COOP LU_EIG LU_FOUND LU_FWM LU_GP LU_HOLDING LU_INDEPENDENT LU_INV_CV LU_INV_OPEN LU_LP LU_LP_SIMPLE LU_LTD LU_LTD_SIMPLE LU_LTD_SINGLE LU_MIF LU_NON_PROFIT LU_PARTNER LU_PLS LU_PUBLIC LU_RE LU_SIF_SICAV LU_SLP LU_SOPARFI NL_ASS_COMPL NL_ASS_LTD NL_ASS_OWN NL_BV NL_BV_ORD NL_COOP NL_CORP NL_CV NL_FOREGIN_EC_RESE NL_FOREIGN_EC NL_FOUND NL_JESUS NL_MQA NL_NV NL_NV_ORD NL_PART NL_RIO NL_ST_ONE NL_ST_SEV NL_VOF NO_AAFY NO_ADOS NO_ANNA NO_ANS NO_AS NO_ASA NO_BA NO_BBL NO_BEDR NO_BO NO_BRL NO_DA NO_ENK NO_EOFG NO_ESEK NO_FKF NO_FLI NO_FYLK NO_GFS NO_IKJP NO_IKS NO_KBO NO_KF NO_KIRK NO_KOMM NO_KS NO_KTRF NO_NUF NO_OPMV NO_ORGL NO_PERS NO_PK NO_PRE NO_SA NO_SAER NO_SAM NO_SE NO_SF NO_SPA NO_STAT NO_STI NO_TVAM NO_VPFO SV_AB SV_AFOR SV_AKTI SV_BAAB SV_BF SV_BOST SV_EARB SV_EB SV_EF SV_EKF SV_EUKO SV_EURO SV_FAMS SV_FOAB SV_FOBO SV_FTU SV_HB SV_HYPO SV_IF SV_KB SV_KOHY SV_KOMF SV_KOMM SV_LAND SV_LIVF SV_MEBA SV_OD SV_OKJF SV_OKOA SV_OMFO SV_OSJP SV_PA SV_PART SV_PBAB SV_PBAN SV_PRFO SV_PSKA SV_PULI SV_PUSK SV_RSMY SV_RT SV_SAMB SV_SF SV_SKAD SV_SPAR SV_STAT SV_STI SV_STIF SV_TJAN SV_UBAF SV_UJP SV_USFO SV_VPPF UK_CHARITY_CHARITABLE_COMPANY UK_CHARITY_CIO UK_CHARITY_OTHER UK_CHARITY_TRUST UK_CHARITY_UNKNOWN UK_UK0 UK_UK1 UK_UK2 UK_UK3 UK_UK4 UK_UK5 UK_UK6 UK_UK7 UK_UK8 UK_UK9 UK_UKA UK_UKB UK_UKC UK_UKE UK_UKR UK_UKS } ``` Values [#values] BE_AGRI [#be_agri] Agricultural society BE_AMA [#be_ama] Autonomous municipal authority BE_CH_FOU [#be_ch_fou] Charitable foundation BE_CH_ORG [#be_ch_org] Charitable organisation BE_COOP [#be_coop] Cooperative company BE_COOP_FORM [#be_coop_form] Cooperative company former status BE_EIG [#be_eig] Economic Interest Grouping BE_FOREIGN [#be_foreign] Foreign company not established in Belgium with VAT representative BE_FOREIGN_ENT [#be_foreign_ent] Foreign enterprise BE_GP [#be_gp] General partnership BE_INS [#be_ins] Mutual insurance association/Private law insurance common fund BE_INT_NON_PROFIT [#be_int_non_profit] International non-profit organisation BE_JOINT [#be_joint] Joint ownership association BE_LLC_COOP [#be_llc_coop] Limited liability cooperative company BE_LLC_COOP_SOCIAL [#be_llc_coop_social] Limited liability cooperative company with a social purpose BE_LLC_SOCIAL [#be_llc_social] Limited liability company with a social purpose BE_LP [#be_lp] Limited partnership BE_NON_PROFIT [#be_non_profit] Non-profit association BE_NON_PROFIT_INS [#be_non_profit_ins] Non-profit institution BE_PARTNER [#be_partner] Partnership BE_PARTNER_LTD [#be_partner_ltd] Partnership limited by shares BE_PC [#be_pc] Private company BE_PC_LAW [#be_pc_law] Private company by public law BE_PF [#be_pf] Private foundation BE_PFB [#be_pfb] Pension funding body BE_PLC [#be_plc] Public limited company BE_PLLC [#be_pllc] Private limited liability company BE_PP [#be_pp] Physical person BE_SCIENCE [#be_science] International scientific organisation under Belgian law BE_SOCIAL [#be_social] Public Centre for Social Welfare BE_UC [#be_uc] Unincorporated company or association BE_UNLIM [#be_unlim] Unlimited liability cooperative company BE_VAT [#be_vat] VAT unit BE_WRA [#be_wra] Walloon Regional Authority DA_ABA [#da_aba] Andelsselskab (-forening) med begrænset ansvar DA_AMT [#da_amt] Amtskommune DA_ANS [#da_ans] Andelsselskab (-forening) DA_APS [#da_aps] Anpartsselskab DA_AS [#da_as] Aktieselskab DA_DOD [#da_dod] Dødsbo DA_EFO [#da_efo] Erhvervsdrivende fond DA_ENK [#da_enk] Enkeltmandsvirksomhed DA_EOF [#da_eof] Europæisk Økonomisk Firmagruppe DA_ES [#da_es] SE-selskab DA_EUO [#da_euo] Enhed under oprettelse i Erhvervsstyrelsen DA_FAP [#da_fap] Filial af udenlandsk anpartsselskab eller selskab DA_FAS [#da_fas] Filial af udenlandsk aktieselskab, kommanditakties DA_FBA1 [#da_fba1] Forening eller selskab med begrænset ansvar DA_FBA2 [#da_fba2] Filial af udenlandsk virksomhed med begrænset ansv DA_FEO [#da_feo] Fast forretningssted af Europæisk økonomisk Firmag DA_FES [#da_fes] Filial af SE-selskab DA_FFO [#da_ffo] Frivillig forening DA_FIV [#da_fiv] Særlig finansiel virksomhed DA_FKI [#da_fki] Folkekirkelige Institutioner DA_FMA [#da_fma] Forening med begrænset ansvar DA_FON [#da_fon] Fonde og andre selvejende institutioner DA_FOR [#da_for] Forening DA_GUS [#da_gus] Grønlandsk afdeling af udenlandsk selskab eller virksomhed DA_IS [#da_is] Interessentskab DA_IVS [#da_ivs] Iværksætterselskab DA_KAS [#da_kas] Kommanditaktieselskab/Partnerselskab DA_KOM [#da_kom] Primærkommune DA_KS [#da_ks] Kommanditselskab DA_MSS [#da_mss] Medarbejderinvesteringsselskab DA_OVR [#da_ovr] Øvrige virksomhedsformer DA_PAR [#da_par] Partrederi DA_PMV [#da_pmv] Personligt ejet Mindre Virksomhed DA_REG [#da_reg] Region DA_SCE [#da_sce] SCE-selskab DA_SMA [#da_sma] Selskab med begrænset ansvar DA_SOV [#da_sov] Selvstændig offentlig virksomhed DA_STA [#da_sta] Statslig administrativ enhed DA_TRU [#da_tru] Trust DA_UDL [#da_udl] Anden udenlandsk virksomhed DA_UOP [#da_uop] Uoplyst virksomhedsform DE_AG [#de_ag] Public Limited Company (Aktiengesellschaft) DE_AG_CO [#de_ag_co] Public Limited Company & Co. DE_AG_CO_KG [#de_ag_co_kg] Public Limited Company & Co. Limited Partnership (Aktiengesellschaft & Co. KG) DE_AG_CO_KGAA [#de_ag_co_kgaa] Public Limited Company & Co. Partnership Limited by Shares DE_AG_CO_OHG [#de_ag_co_ohg] Public Limited Company & Co. General Partnership (Aktiengesellschaft & Co. OHG) DE_ANSTALT_OEFFENTLICHEN_RECHTS [#de_anstalt_oeffentlichen_rechts] Public Law Institution (Anstalt des öffentlichen Rechts) DE_AS [#de_as] Norwegian/Danish Public Limited Company DE_AS_CO_KG [#de_as_co_kg] Norwegian/Danish Public Limited Company & Co. Limited Partnership DE_AS_LV [#de_as_lv] Latvian Public Limited Company DE_BESLOTEN_VENNOOTSCHAP [#de_besloten_vennootschap] Private Company Limited by Shares (Dutch GmbH equivalent) DE_BGB_GESELLSCHAFT [#de_bgb_gesellschaft] Civil Law Partnership (Gesellschaft bürgerlichen Rechts OR BGB-Gesellschaft) DE_BV_CO_KG [#de_bv_co_kg] Dutch GmbH & Co. Limited Partnership DE_COM_UND [#de_com_und] Commercial Undertaking DE_DOO [#de_doo] Slovenian GmbH DE_EG [#de_eg] Registered Cooperative (eG) DE_EGBR [#de_egbr] Registered Civil-Law Partnership (eGbR) DE_EGBR_AG_PARTNER [#de_egbr_ag_partner] Registered Civil Law Partnership with a Public Limited Company Partner DE_EGBR_GMBH_PARTNER [#de_egbr_gmbh_partner] Registered Civil Law Partnership with an LLC Partner DE_EGBR_UG_PARTNER [#de_egbr_ug_partner] Registered Civil Law Partnership with an UG (Small GmbH) Partner DE_EGBR_UK_LTD_PARTNER [#de_egbr_uk_ltd_partner] Civil law partnership with a Private Limited Company as shareholder DE_EGMBH_HAFT_PFLICHT [#de_egmbh_haft_pflicht] Registered Cooperative with Limited Liability DE_EGMBH_UNHAFT_PFLICHT [#de_egmbh_unhaft_pflicht] Registered Cooperative with Unlimited Liability DE_EIGENBETRIEB [#de_eigenbetrieb] Municipal Enterprise (Eigenbetrieb) DE_EK [#de_ek] Registered Merchant DE_EWIV [#de_ewiv] European Economic Interest Grouping (Europäische wirtschaftliche Interessenvereinigung) DE_FOREIGN_PARTNERSHIP [#de_foreign_partnership] Foreign Partnership (Foreign GsR) DE_FREIER_BERUF [#de_freier_beruf] Liberal Profession (Freier Beruf) DE_GEMEINNUETZIGE_AG [#de_gemeinnuetzige_ag] Non-Profit Public Limited Company DE_GEMEINSAM_KOMMUNALUNTERNEHMEN [#de_gemeinsam_kommunalunternehmen] Joint Municipal Enterprise DE_GMBH [#de_gmbh] Limited Liability Company (GmbH) DE_GMBH_CO [#de_gmbh_co] Limited Liability Company & Co. (Gesellschaft mit beschränkter Haftung & Co.) DE_GMBH_CO_KG [#de_gmbh_co_kg] GmbH & Co. KG DE_GMBH_CO_KGAA [#de_gmbh_co_kgaa] Limited Liability Company & Co. Partnership Limited by Shares DE_GMBH_CO_OHG [#de_gmbh_co_ohg] Limited Liability Company & Co. General Partnership DE_INCORPORATED [#de_incorporated] Incorporated - Public Limited Company in USA DE_INC_CO_KG [#de_inc_co_kg] Incorporated (American Corporation) & Co. Limited Partnership DE_KG [#de_kg] Limited Partnership DE_KGAA [#de_kgaa] Partnership Limited by Shares (Kommanditgesellschaft auf Aktien) DE_KGAA_CO [#de_kgaa_co] Limited Partnership KGaA & Co. DE_KOERPERSCHAFT_OEFFENTLICHEN_RECHTS [#de_koerperschaft_oeffentlichen_rechts] Corporation under Public Law DE_LLC [#de_llc] Limited Liability Company (LLC) - American GmbH DE_LTD_CO_KG [#de_ltd_co_kg] Limited Company & Co. Limited Partnership (Limited & Co.KG) DE_LTD_CO_OHG [#de_ltd_co_ohg] Ltd. & Co. General Partnership DE_NP_GMBH [#de_np_gmbh] Non-Profit Limited Liability Company (gGmbH) DE_NV [#de_nv] Dutch Public Limited Company DE_NV_CO_KG [#de_nv_co_kg] Dutch Public Limited Company & Co. Limited Partnership DE_ODD [#de_odd] Bulgarian GmbH DE_OHG [#de_ohg] General Partnership DE_Other [#de_other] Other DE_PARTG [#de_partg] Partnership Company (PartG) DE_PUBLIC_LTD [#de_public_ltd] English Public Limited Company (Public Company Limited by Shares) DE_RECHTLICH_SELSTAE_NIEDERLASSUNG [#de_rechtlich_selstae_niederlassung] Legally Independent DE_RV [#de_rv] State-conferred Association (Rechtsfähiger Verein) DE_SA [#de_sa] Société Anonyme (SA) - Belgian, French, Luxembourgish, Polish, Romanian, Swiss, Spanish Public Limited Company DE_SARL [#de_sarl] French or Luxembourgish Single-Member GmbH (SARL) DE_SARL_CO_KG [#de_sarl_co_kg] French GmbH & Co. Limited Partnership DE_SCE [#de_sce] European Cooperative Society DE_SE [#de_se] Societas Europaea - European Public Limited Liability Company (Europäische Aktiengesellschaft) DE_SE_CO_KGAA [#de_se_co_kgaa] SE & Co. Partnership Limited by Shares DE_SOLE_PROPRIETORSHIP [#de_sole_proprietorship] Sole Proprietorship (Gewerbebetrieb) DE_SONSTIGE_AUSLAENDISCHE_RECHTSFORM [#de_sonstige_auslaendische_rechtsform] Other Foreign Legal Form DE_SPA [#de_spa] Italian Public Limited Company DE_SP_Z_O_O [#de_sp_z_o_o] Polish GmbH DE_SP_Z_O_O_CO_KG [#de_sp_z_o_o_co_kg] Polish GmbH & Co. Limited Partnership DE_SRL [#de_srl] Romanian GmbH DE_SRO [#de_sro] Czech GmbH DE_STIFTUNG [#de_stiftung] Foundation DE_STIFTUNG_CO_KG [#de_stiftung_co_kg] Foundation & Co. Limited Partnership DE_STIFTUNG_OEFFENTLICHEN_RECHTS [#de_stiftung_oeffentlichen_rechts] Foundation under Public Law DE_STIFTUNG_PRIVATEN_GMBH [#de_stiftung_privaten_gmbh] Foundation in form of Private Limited Company DE_STIFTUNG_PRIVATEN_RECHTS [#de_stiftung_privaten_rechts] Foundation under Private Law DE_STIFTUNG_VEREIN [#de_stiftung_verein] Foundation Association DE_UG [#de_ug] Small Limited Liability Company (UG) DE_UG_CO_KG [#de_ug_co_kg] UG & Co. KG DE_UK_LTD [#de_uk_ltd] Private Company Limited by Shares (English GmbH equivalent) DE_VE [#de_ve] Registered Association (Eingetragener Verein) DE_VVAG [#de_vvag] Mutual Insurance Association (Versicherungsverein auf Gegenseitigkeit) FI_01 [#fi_01] LimitedCompany FI_02 [#fi_02] PrivateBusinessGovCtrl FI_03 [#fi_03] ForeignCompany FI_04 [#fi_04] Bank FI_05 [#fi_05] SoleProprietorship FI_06 [#fi_06] GeneralPartnership FI_07 [#fi_07] Society FI_08 [#fi_08] Foundation FI_09 [#fi_09] HousingCompany FI_10 [#fi_10] StateCountyCompany FI_100 [#fi_100] DeathNest FI_101 [#fi_101] Limited Partnership FI_102 [#fi_102] Shipping Partnership FI_103 [#fi_103] Corporation FI_104 [#fi_104] Business Foundation FI_105 [#fi_105] Association FI_106 [#fi_106] Cooperative FI_107 [#fi_107] Volunteer Association FI_108 [#fi_108] Association or Limited Liability Company FI_109 [#fi_109] Limited Liability Company FI_11 [#fi_11] ReligiousOrganisation FI_110 [#fi_110] Limited Association Company FI_111 [#fi_111] State Administration FI_112 [#fi_112] European Financial Company Group FI_113 [#fi_113] SCE Company FI_114 [#fi_114] Special Financial Business FI_115 [#fi_115] Partnership FI_12 [#fi_12] InsuranceCompany FI_120 [#fi_120] Sub Division FI_13 [#fi_13] Collaborations FI_130 [#fi_130] European Economic Interest Group FI_140 [#fi_140] Limited Liability Stock Company FI_141 [#fi_141] Open Trading Company FI_142 [#fi_142] Statutory Corporation FI_143 [#fi_143] Professional Partnership FI_144 [#fi_144] Independent Subsidiary FI_145 [#fi_145] Dependant Subsidiary FI_146 [#fi_146] Societas Cooperativa Europaea FI_147 [#fi_147] Societas Europaea FI_148 [#fi_148] Freier Beruf FI_149 [#fi_149] Non Profit Stock Company FI_150 [#fi_150] Entrepreneurial Limited Company FI_20 [#fi_20] Other2 FI_99 [#fi_99] Unknown FI_ASH [#fi_ash] Resident-administered area FI_ASY [#fi_asy] Right-of-occupancy associationy FI_AYH [#fi_ayh] Non-profit association FI_ETS [#fi_ets] Finnish branch of a European economic interest grouping FI_HY [#fi_hy] Mortgage Society FI_KOY [#fi_koy] Limited liability joint-stock property company FI_KVJ [#fi_kvj] Public mutual insurance company FI_OP [#fi_op] Co-operative bank FI_OSK [#fi_osk] Housing co-perative FI_OT [#fi_ot] Other FI_OYJ [#fi_oyj] Public Limited Company FI_SCE [#fi_sce] European co-operative society FI_SCP [#fi_scp] European co-operative bank FI_SE [#fi_se] European Company FI_SL [#fi_sl] Branch of a foreign trader FI_SP [#fi_sp] Savings bank FI_TYH [#fi_tyh] Association for carrying on economic activity FI_UNKNOWN [#fi_unknown] Unknown FI_VALTLL [#fi_valtll] State-owned company FI_VOJ [#fi_voj] Public limited insurance company FI_VOY [#fi_voy] Limited insurance company FI_VY [#fi_vy] Insurance association FR_AGRICOLLECT [#fr_agricollect] Agricultural Collective Interest Company FR_AGRI_COOP [#fr_agri_coop] Agricultural cooperative company FR_AGRI_PLC_MB [#fr_agri_plc_mb] Agricultural collective interest company in the form of a Plc with management board FR_CHP_BD [#fr_chp_bd] Council housing public limited company with board of directors FR_CHP_COOP [#fr_chp_coop] Council housing production cooperative society FR_CPLC_BD [#fr_cplc_bd] cooperative public limited company with board of directors FR_CUMA [#fr_cuma] CUMA- Common agricultural material usage cooperative FR_LIBERAL_LLC [#fr_liberal_llc] Liberal Operated Limited Liability Company FR_LLC [#fr_llc] Limited Liability Company FR_LP_POLICY [#fr_lp_policy] Limited Partnership by policy FR_MARITIME_PLC_BD [#fr_maritime_plc_bd] Maritime interest cooperative public limited company with board of directors FR_MIXED_AGRI_PLC_BD [#fr_mixed_agri_plc_bd] Mixed interest collective agricultural public limited company with board of directors FR_MIXED_PLC_BD [#fr_mixed_plc_bd] Mixed Economy Plc with board of directors FR_NATIONAL_PLC_BD [#fr_national_plc_bd] National Public Limited Company with Board of Directors FR_NON_TRADING [#fr_non_trading] Non Trading Company FR_PARTNERSHIP [#fr_partnership] Partnership FR_PLC_BD [#fr_plc_bd] Public limited company with board of directors FR_PLC_MB [#fr_plc_mb] Plc with management board FR_PLC_WORKER [#fr_plc_worker] Public Limited Company with Worker Participation in the Board of Directors FR_SAFER_BD [#fr_safer_bd] SAFER with Board of Directors FR_SASU [#fr_sasu] SASU (school and university administration secretary) company by simplified actions FR_SJSC [#fr_sjsc] Simplified joint stock company FR_SPLC [#fr_splc] Sole proprietorship Ltd FR_UNION_AGRI_COOP [#fr_union_agri_coop] Union of agricultural cooperative companies FR_WPCS_BD [#fr_wpcs_bd] Worker production cooperative society with board of directors GLOBAL_COOPERATIVE [#global_cooperative] Cooperative GLOBAL_FOUNDATION [#global_foundation] Foundation GLOBAL_GOVERNMENT_ENTITY [#global_government_entity] Government Entity GLOBAL_LIMITED_COMPANY [#global_limited_company] Limited Company GLOBAL_LIMITED_PARTNERSHIP [#global_limited_partnership] Limited Partnership GLOBAL_NON_PROFIT [#global_non_profit] Non-Profit Organisation GLOBAL_OTHER [#global_other] Other GLOBAL_PARTNERSHIP [#global_partnership] Partnership GLOBAL_PUBLIC_LIMITED_COMPANY [#global_public_limited_company] Public Limited Company GLOBAL_SOLE_PROPRIETORSHIP [#global_sole_proprietorship] Sole Proprietorship GLOBAL_TRUST [#global_trust] Trust LU_AGRI [#lu_agri] Agricultural Association LU_ANO [#lu_ano] Public Limited Company LU_ANO_SIMPLE [#lu_ano_simple] Simplified Public Limited Company LU_CIVIL [#lu_civil] Civil Society LU_CLS [#lu_cls] Company Limited by Shares LU_COOP [#lu_coop] Cooperative Company LU_EIG [#lu_eig] Economic Interest Grouping LU_FOUND [#lu_found] Foundation LU_FWM [#lu_fwm] Limited Company - Company of Family Wealth Management LU_GP [#lu_gp] General Partnership LU_HOLDING [#lu_holding] Limited Company Holding LU_INDEPENDENT [#lu_independent] Indépendant LU_INV_CV [#lu_inv_cv] Investment Company With Variable Capital LU_INV_OPEN [#lu_inv_open] Open-End Investment Company LU_LP [#lu_lp] Limited Partnership LU_LP_SIMPLE [#lu_lp_simple] Limited Partnership Simple LU_LTD [#lu_ltd] Private Limited Company LU_LTD_SIMPLE [#lu_ltd_simple] Simplified Private Limited Company LU_LTD_SINGLE [#lu_ltd_single] Single Member Limited Liability Company LU_MIF [#lu_mif] Mutual Investment Fund LU_NON_PROFIT [#lu_non_profit] Non-Profit Association LU_PARTNER [#lu_partner] Partnership LU_PLS [#lu_pls] Partnership Limited by Shares LU_PUBLIC [#lu_public] Public Institution LU_RE [#lu_re] Real Estate Company LU_SIF_SICAV [#lu_sif_sicav] Limited Company in the form of a SICAV - Specialised Investment Fund LU_SLP [#lu_slp] Special Limited Partnership LU_SOPARFI [#lu_soparfi] Limited Company SOPARFI NL_ASS_COMPL [#nl_ass_compl] Association (Vereniging) with complete jurisdiction NL_ASS_LTD [#nl_ass_ltd] Association (Vereniging) with limited jurisdiction NL_ASS_OWN [#nl_ass_own] Association of owners NL_BV [#nl_bv] Private limited liability company (BV) according regulations of the structural company NL_BV_ORD [#nl_bv_ord] Private limited liability company (BV) with ordinary structure NL_COOP [#nl_coop] Co-operative society excluded liability (Coöperatie U.A.) with ordinary structure NL_CORP [#nl_corp] Public corporation NL_CV [#nl_cv] Limited partnership (CV) with one managing partner NL_FOREGIN_EC_RESE [#nl_foregin_ec_rese] Foreign company resembling at a company of the European Community with establishment in the Netherlands NL_FOREIGN_EC [#nl_foreign_ec] Foreign company of the European Community with establishment in the Netherlands NL_FOUND [#nl_found] Foundation (Stichting) NL_JESUS [#nl_jesus] Religious community (Kerkgenootschap) NL_MQA [#nl_mqa] Mutual quarantee association excluded liability (Onderlinge Waarborgmaatschappij U.A.) with ordinary structure NL_NV [#nl_nv] Limited company (NV) according regulations of the structural company NL_NV_ORD [#nl_nv_ord] Limited company (NV) with ordinary structure NL_PART [#nl_part] Partnership NL_RIO [#nl_rio] Limited company being set up (Rechtspersoon in oprichting) NL_ST_ONE [#nl_st_one] Sole trader with one owner NL_ST_SEV [#nl_st_sev] Sole trafer with several owners NL_VOF [#nl_vof] General partnership (VOF) NO_AAFY [#no_aafy] Ikke næringsdrivende virksomhet NO_ADOS [#no_ados] Administrativ enhet -offentlig sektor NO_ANNA [#no_anna] Annen juridisk person NO_ANS [#no_ans] Ansvarlig selskap med solidarisk ansvar NO_AS [#no_as] Aksjeselskap NO_ASA [#no_asa] Allmennaksjeselskap NO_BA [#no_ba] Selskap med begrenset ansvar NO_BBL [#no_bbl] Boligbyggelag NO_BEDR [#no_bedr] Bedrift NO_BO [#no_bo] Andre bo NO_BRL [#no_brl] Borettslag NO_DA [#no_da] Ansvarlig selskap med delt ansvar NO_ENK [#no_enk] Enkeltpersonforetak NO_EOFG [#no_eofg] Europeisk økonomisk foretaksgruppe NO_ESEK [#no_esek] Eierseksjonssameie NO_FKF [#no_fkf] Fylkeskommunalt foretak NO_FLI [#no_fli] Forening/lag/innretning NO_FYLK [#no_fylk] Fylkeskommune NO_GFS [#no_gfs] Gjensidig forsikringsselskap NO_IKJP [#no_ikjp] Andre ikke-juridiske personer NO_IKS [#no_iks] Interkommunalt selskap NO_KBO [#no_kbo] Konkursbo NO_KF [#no_kf] Kommunalt foretak NO_KIRK [#no_kirk] Den norske kirke NO_KOMM [#no_komm] Kommune NO_KS [#no_ks] Kommandittselskap NO_KTRF [#no_ktrf] Kontorfellesskap NO_NUF [#no_nuf] Norskregistrert utenlandsk foretak NO_OPMV [#no_opmv] Særskilt oppdelt enhet NO_ORGL [#no_orgl] Organisasjonsledd NO_PERS [#no_pers] Andre enkeltpersoner som registreres i tilknyttet register NO_PK [#no_pk] Pensjonskasse NO_PRE [#no_pre] Partrederi NO_SA [#no_sa] Samvirkeforetak NO_SAER [#no_saer] Annet foretak ifølge særskilt lov NO_SAM [#no_sam] Tingsrettslig sameie NO_SE [#no_se] Europeisk selskap NO_SF [#no_sf] Statsforetak NO_SPA [#no_spa] Sparebank NO_STAT [#no_stat] Staten NO_STI [#no_sti] Stiftelse NO_TVAM [#no_tvam] Tvangsregistrert for MVA NO_VPFO [#no_vpfo] Verdipapirfond SV_AB [#sv_ab] Privat aktiebolag SV_AFOR [#sv_afor] Allmän försäkringskassa SV_AKTI [#sv_akti] Aktiebolag SV_BAAB [#sv_baab] Bankaktiebolag SV_BF [#sv_bf] Bostadsrättsförening SV_BOST [#sv_bost] Bostadsförening SV_EARB [#sv_earb] Erkänd arbetslöshetskassa SV_EB [#sv_eb] Enkelt bolag SV_EF [#sv_ef] Enskild firma SV_EKF [#sv_ekf] Ekonomisk förening SV_EUKO [#sv_euko] Europakooperativ SV_EURO [#sv_euro] Europabolag SV_FAMS [#sv_fams] Familjestiftelse SV_FOAB [#sv_foab] Försäkringsaktiebolag SV_FOBO [#sv_fobo] Försäkringsbolag SV_FTU [#sv_ftu] Filial till utländskt bolag SV_HB [#sv_hb] Handelsbolag SV_HYPO [#sv_hypo] Hypoteksförening SV_IF [#sv_if] Ideell förening SV_KB [#sv_kb] Kommanditbolag SV_KOHY [#sv_kohy] Kooperativ Hyresgästförening SV_KOMF [#sv_komf] Kommunförbund SV_KOMM [#sv_komm] Kommun SV_LAND [#sv_land] Landsting SV_LIVF [#sv_livf] Livförsäkringsbolag SV_MEBA [#sv_meba] Medlemsbank SV_OD [#sv_od] Oskiftat dödsbo SV_OKJF [#sv_okjf] Okänd juridisk form SV_OKOA [#sv_okoa] Offentlig korporation och anstalt SV_OMFO [#sv_omfo] Ömsesidigt försäkringsbolag SV_OSJP [#sv_osjp] Övrig svensk juridisk person SV_PA [#sv_pa] Publikt aktiebolag SV_PART [#sv_part] Partrederi SV_PBAB [#sv_pbab] Privat bankaktiebolag SV_PBAN [#sv_pban] Publikt bankaktiebolag SV_PRFO [#sv_prfo] Privat livförsäkringsbolag SV_PSKA [#sv_pska] Privat skadeförsäkringsbolag SV_PULI [#sv_puli] Publikt livförsäkringsbolag SV_PUSK [#sv_pusk] Publikt skadeförsäkringsbolag SV_RSMY [#sv_rsmy] Regional statlig myndighet SV_RT [#sv_rt] Registrerat trossamfund SV_SAMB [#sv_samb] Sambruksförening SV_SF [#sv_sf] Samfällighet SV_SKAD [#sv_skad] Skadeförsäkringsbolag SV_SPAR [#sv_spar] Sparbank SV_STAT [#sv_stat] Statlig enhet SV_STI [#sv_sti] Stiftelse/Fond SV_STIF [#sv_stif] Stiftelse SV_TJAN [#sv_tjan] Tjänstepensionsförening SV_UBAF [#sv_ubaf] Utländsk Banks Filial SV_UJP [#sv_ujp] Utländsk juridisk person SV_USFO [#sv_usfo] Understödsförening SV_VPPF [#sv_vppf] Värdepapperfond UK_CHARITY_CHARITABLE_COMPANY [#uk_charity_charitable_company] Charitable Company UK_CHARITY_CIO [#uk_charity_cio] Charitable Incorporated Organisation (CIO) UK_CHARITY_OTHER [#uk_charity_other] Other Charity UK_CHARITY_TRUST [#uk_charity_trust] Charity Trust UK_CHARITY_UNKNOWN [#uk_charity_unknown] Unknown Charity type UK_UK0 [#uk_uk0] Other UK_UK1 [#uk_uk1] Private unlimited with Share Capital UK_UK2 [#uk_uk2] Private limited with Share Capital UK_UK3 [#uk_uk3] Public limited with Share Capital UK_UK4 [#uk_uk4] Old Public Limited Company UK_UK5 [#uk_uk5] Private Limited by guarantee without Share Capital Exempt from using Limited UK_UK6 [#uk_uk6] Limited Partnership UK_UK7 [#uk_uk7] Private Ltd By Guarantee w/o Share Cap UK_UK8 [#uk_uk8] Company Converted/Closed UK_UK9 [#uk_uk9] Unlimited/No Share Capital UK_UKA [#uk_uka] Limited UK_UKB [#uk_ukb] Societas Europaea (SE) UK_UKC [#uk_ukc] Scottish Partnership UK_UKE [#uk_uke] Further education or sixth form college corporation UK_UKR [#uk_ukr] Overseas Entity UK_UKS [#uk_uks] Sole Trader Member Of [#member-of] [`CustomCompanyCreateInput`](/types/inputs/custom-company-create-input) `input` [`CustomCompanyUpdateInput`](/types/inputs/custom-company-update-input) `input` URL: /connect/docs/types/enums/named-entity-kind # NamedEntityKind import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql enum NamedEntityKind { COMPANY LOCATION PERSON } ``` Values [#values] COMPANY [#company] LOCATION [#location] PERSON [#person] Member Of [#member-of] [`AmsEntityMention`](/types/objects/ams-entity-mention) `object` URL: /connect/docs/types/enums/relation-kind # RelationKind import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql enum RelationKind { BENEFICIAL_OWNER BENEFICIAL_OWNERSHIP OWNER OWNERSHIP ROLE } ``` Values [#values] BENEFICIAL_OWNER [#beneficial_owner] BENEFICIAL_OWNERSHIP [#beneficial_ownership] OWNER [#owner] OWNERSHIP [#ownership] ROLE [#role] Member Of [#member-of] [`PepChange`](/types/objects/pep-change) `object` [`SanctionChange`](/types/objects/sanction-change) `object` URL: /connect/docs/types/enums/review-trigger-statement-kind # ReviewTriggerStatementKind import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql enum ReviewTriggerStatementKind { BENEFICIAL_OWNERS_CHANGE CREDIT_CHANGE FINANCIALS_PUBLISHED FLAG_PUBLISHED PEP_CHANGE RISK_ASSESSMENT_VALUE RISK_LEVEL_VALUE ROLE_CHANGE SANCTIONS_CHANGE TIME_SINCE_LAST_REVIEW } ``` Values [#values] BENEFICIAL_OWNERS_CHANGE [#beneficial_owners_change] CREDIT_CHANGE [#credit_change] FINANCIALS_PUBLISHED [#financials_published] FLAG_PUBLISHED [#flag_published] PEP_CHANGE [#pep_change] RISK_ASSESSMENT_VALUE [#risk_assessment_value] RISK_LEVEL_VALUE [#risk_level_value] ROLE_CHANGE [#role_change] SANCTIONS_CHANGE [#sanctions_change] TIME_SINCE_LAST_REVIEW [#time_since_last_review] Member Of [#member-of] [`CompanyReviewTriggerEvent`](/types/objects/company-review-trigger-event) `object` [`PersonReviewTriggerEvent`](/types/objects/person-review-trigger-event) `object` [`ReviewTriggerEvent`](/types/interfaces/review-trigger-event) `interface` URL: /connect/docs/types/enums/risk-class # RiskClass import { Callout } from 'fumadocs-ui/components/callout'; Risk class for an entity. Risk class is set automatically through review automation, or by an AML officer through the application. ```graphql enum RiskClass { HIGH LOW MEDIUM } ``` Values [#values] HIGH [#high] LOW [#low] MEDIUM [#medium] Member Of [#member-of] [`PrivatePersonReviewPayload`](/types/objects/private-person-review-payload) `object` [`ReviewPayload`](/types/objects/review-payload) `object` URL: /connect/docs/types/enums/risk-level-kind # RiskLevelKind import { Callout } from 'fumadocs-ui/components/callout'; An enum representing supported risk levels ```graphql enum RiskLevelKind { CRITICAL HIGH INCONCLUSIVE LOW MEDIUM NONE SEVERE } ``` Values [#values] CRITICAL [#critical] Critical risk level HIGH [#high] High risk level INCONCLUSIVE [#inconclusive] Inconclusive risk level - critical data is missing for risk calculation LOW [#low] Low risk level MEDIUM [#medium] Medium risk level NONE [#none] No risk level SEVERE [#severe] Severe risk level Member Of [#member-of] [`Company`](/types/objects/company) `object` [`PrivatePerson`](/types/objects/private-person) `object` [`PrivatePersonReview`](/types/objects/private-person-review) `object` [`Review`](/types/objects/review) `object` [`RiskLevelSetting`](/types/objects/risk-level-setting) `object` URL: /connect/docs/types/enums/risk-score-status # RiskScoreStatus import { Callout } from 'fumadocs-ui/components/callout'; Indicates whether data was present for a risk score calculation ```graphql enum RiskScoreStatus { CALCULATED MISSING_DATA } ``` Values [#values] CALCULATED [#calculated] Data was present and the score was calculated normally MISSING_DATA [#missing_data] No data was available for this risk category Member Of [#member-of] [`RiskScoreResult`](/types/objects/risk-score-result) `object` URL: /connect/docs/types/enums/sanction-source # SanctionSource import { Callout } from 'fumadocs-ui/components/callout'; The entity that issued the sanction. ```graphql enum SanctionSource { CUSTOM DOW_JONES EU OFAC UK UN } ``` Values [#values] CUSTOM [#custom] DOW_JONES [#dow_jones] EU [#eu] OFAC [#ofac] UK [#uk] UN [#un] Member Of [#member-of] [`Sanction`](/types/objects/sanction) `object` URL: /connect/docs/types/enums/sandbox-alert-action # SandboxAlertAction import { Callout } from 'fumadocs-ui/components/callout'; Action to perform on sandbox alert ```graphql enum SandboxAlertAction { ADD REMOVE } ``` Values [#values] ADD [#add] Add a new hit to the entity REMOVE [#remove] Remove an existing hit from the entity Member Of [#member-of] [`SandboxAlertInput`](/types/inputs/sandbox-alert-input) `input` URL: /connect/docs/types/enums/sandbox-alert-type # SandboxAlertType import { Callout } from 'fumadocs-ui/components/callout'; Type of alert to generate in sandbox ```graphql enum SandboxAlertType { PEP SANCTION } ``` Values [#values] PEP [#pep] PEP (Politically Exposed Person) alert SANCTION [#sanction] Sanction alert Member Of [#member-of] [`SandboxAlertInput`](/types/inputs/sandbox-alert-input) `input` URL: /connect/docs/types/enums/search-match-confidence # SearchMatchConfidence import { Callout } from 'fumadocs-ui/components/callout'; Confidence level of a search match. ```graphql enum SearchMatchConfidence { HIGH LOW MEDIUM } ``` Values [#values] HIGH [#high] High confidence match. LOW [#low] Low confidence match. MEDIUM [#medium] Medium confidence match. Member Of [#member-of] [`SearchMatchMetadata`](/types/objects/search-match-metadata) `object` URL: /connect/docs/types/enums/user-account-kind # UserAccountKind import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql enum UserAccountKind { AUTH0 AZURE_AD CLIENT GOOGLE OIDC OKTA } ``` Values [#values] AUTH0 [#auth0] AZURE_AD [#azure_ad] CLIENT [#client] GOOGLE [#google] OIDC [#oidc] OKTA [#okta] Member Of [#member-of] [`SimpleUser`](/types/objects/simple-user) `object` URL: /connect/docs/types/inputs/address-input # AddressInput import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql input AddressInput { addressLine: String zipCode: String city: String country: CountryCode } ``` Fields [#fields] addressLine String scalar [#addresslinestring-scalar] [`String`](/types/scalars/string) zipCode String scalar [#zipcodestring-scalar] [`String`](/types/scalars/string) city String scalar [#citystring-scalar] [`String`](/types/scalars/string) country CountryCode scalar [#countrycountrycode-scalar] [`CountryCode`](/types/scalars/country-code) Member Of [#member-of] [`CustomCompanyCreateInput`](/types/inputs/custom-company-create-input) `input` [`CustomCompanyUpdateInput`](/types/inputs/custom-company-update-input) `input` [`CustomPersonCreateInput`](/types/inputs/custom-person-create-input) `input` [`CustomPersonEditInput`](/types/inputs/custom-person-edit-input) `input` [`PrivatePersonCreateInput`](/types/inputs/private-person-create-input) `input` [`PrivatePersonUpdateInput`](/types/inputs/private-person-update-input) `input` URL: /connect/docs/types/inputs/alert-page-info-input # AlertPageInfoInput import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql input AlertPageInfoInput { size: Int = 50 offset: Int = 0 } ``` Fields [#fields] size Int scalar [#sizeint-scalar] [`Int`](/types/scalars/int) Page size. Max 500, defaults to 50. offset Int scalar [#offsetint-scalar] [`Int`](/types/scalars/int) Member Of [#member-of] [`AlertsWhereInput`](/types/inputs/alerts-where-input) `input` URL: /connect/docs/types/inputs/alert-update-input # AlertUpdateInput import { Callout } from 'fumadocs-ui/components/callout'; Input for updating one or more monitoring alerts. ```graphql input AlertUpdateInput { ids: [AlertId!]! state: AlertState } ``` Fields [#fields] ids [AlertId!]! non-null scalar [#idsalertid-non-null-scalar] [`[AlertId!]!`](/types/scalars/alert-id) The IDs of the alerts to update. state AlertState enum [#statealertstate-enum] [`AlertState`](/types/enums/alert-state) The new state to set on the alerts. Member Of [#member-of] [`alertUpdate`](/mutations/alert-update) `mutation` URL: /connect/docs/types/inputs/alerts-where-input # AlertsWhereInput import { Callout } from 'fumadocs-ui/components/callout'; Specify filters and pagination when querying alerts. ```graphql input AlertsWhereInput { entity: ID kinds: [DatasetKind!] states: [AlertState!] page: AlertPageInfoInput period: TimespanInput entityKind: EntityKind } ``` Fields [#fields] entity ID scalar [#entityid-scalar] [`ID`](/types/scalars/id) Specify which entity to get alerts for, defaults to all. kinds [DatasetKind!] list enum [#kindsdatasetkind-list-enum] [`[DatasetKind!]`](/types/enums/dataset-kind) Specify which change kinds to get alerts for, defaults to all. states [AlertState!] list enum [#statesalertstate-list-enum] [`[AlertState!]`](/types/enums/alert-state) Specify which alert states to get alerts for, defaults to all. page AlertPageInfoInput input [#pagealertpageinfoinput-input] [`AlertPageInfoInput`](/types/inputs/alert-page-info-input) period TimespanInput input [#periodtimespaninput-input] [`TimespanInput`](/types/inputs/timespan-input) Specify the time window to get alerts for. Uses the computedAt field on the alerts. entityKind EntityKind enum [#entitykindentitykind-enum] [`EntityKind`](/types/enums/entity-kind) Specify the entity kind to get alerts for. Defaults to COMPANY. Member Of [#member-of] [`alerts`](/queries/alerts) `query` URL: /connect/docs/types/inputs/attach-form-instance-input # AttachFormInstanceInput import { Callout } from 'fumadocs-ui/components/callout'; The data input for attaching an externally initiated form instance to a company. ```graphql input AttachFormInstanceInput { companyId: CompanyId! formInstanceId: FormInstanceId! } ``` Fields [#fields] companyId CompanyId! non-null scalar [#companyidcompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) Id of the company to attach the form instance to formInstanceId FormInstanceId! non-null scalar [#forminstanceidforminstanceid-non-null-scalar] [`FormInstanceId!`](/types/scalars/form-instance-id) Id of the form instance to attach Member Of [#member-of] [`attachFormInstance`](/mutations/attach-form-instance) `mutation` URL: /connect/docs/types/inputs/business-person-ownership-input # BusinessPersonOwnershipInput import { Callout } from 'fumadocs-ui/components/callout'; The data input for updating company ownership. ```graphql input BusinessPersonOwnershipInput { id: BusinessPersonId! ownership: Float comment: String beneficialOwner: Boolean = false } ``` Fields [#fields] id BusinessPersonId! non-null scalar [#idbusinesspersonid-non-null-scalar] [`BusinessPersonId!`](/types/scalars/business-person-id) ownership Float scalar [#ownershipfloat-scalar] [`Float`](/types/scalars/float) The ownership percentage (0-100) comment String scalar [#commentstring-scalar] [`String`](/types/scalars/string) beneficialOwner Boolean scalar [#beneficialownerboolean-scalar] [`Boolean`](/types/scalars/boolean) Member Of [#member-of] [`CustomCompanyCreateInput`](/types/inputs/custom-company-create-input) `input` [`CustomCompanyUpdateInput`](/types/inputs/custom-company-update-input) `input` [`CustomOwnersInput`](/types/inputs/custom-owners-input) `input` URL: /connect/docs/types/inputs/business-person-where-input # BusinessPersonWhereInput import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql input BusinessPersonWhereInput { id: BusinessPersonId! } ``` Fields [#fields] id BusinessPersonId! non-null scalar [#idbusinesspersonid-non-null-scalar] [`BusinessPersonId!`](/types/scalars/business-person-id) Member Of [#member-of] [`businessPerson`](/queries/business-person) `query` [`customPersonDelete`](/mutations/custom-person-delete) `mutation` URL: /connect/docs/types/inputs/cancel-form-input # CancelFormInput import { Callout } from 'fumadocs-ui/components/callout'; The data input for cancelling a customer facing form. ```graphql input CancelFormInput { companyId: CompanyId! documentId: ID! } ``` Fields [#fields] companyId CompanyId! non-null scalar [#companyidcompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) Id of the company associated with the form documentId ID! non-null scalar [#documentidid-non-null-scalar] [`ID!`](/types/scalars/id) Id of the document associated with the form. Retrieved from the `id` field of a `Document` on the `Company.documents` query. Member Of [#member-of] [`cancelForm`](/mutations/cancel-form) `mutation` URL: /connect/docs/types/inputs/companies-where-input # CompaniesWhereInput import { Callout } from 'fumadocs-ui/components/callout'; Input to lookup companies by their internal Strise ID. ```graphql input CompaniesWhereInput { ids: [CompanyId!]! } ``` Fields [#fields] ids [CompanyId!]! non-null scalar [#idscompanyid-non-null-scalar] [`[CompanyId!]!`](/types/scalars/company-id) Member Of [#member-of] [`companiesAddToMonitoring`](/mutations/companies-add-to-monitoring) `mutation` URL: /connect/docs/types/inputs/company-custom-beneficial-owner-input # CompanyCustomBeneficialOwnerInput import { Callout } from 'fumadocs-ui/components/callout'; The data input for an edited company beneficial owner. ```graphql input CompanyCustomBeneficialOwnerInput { ownerId: BusinessEntityIdInput! isBeneficialOwner: Boolean! comment: String } ``` Fields [#fields] ownerId BusinessEntityIdInput! non-null scalar [#owneridbusinessentityidinput-non-null-scalar] [`BusinessEntityIdInput!`](/types/scalars/business-entity-id-input) isBeneficialOwner Boolean! non-null scalar [#isbeneficialownerboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) comment String scalar [#commentstring-scalar] [`String`](/types/scalars/string) Member Of [#member-of] [`CompanyUpdateBeneficialOwnersInput`](/types/inputs/company-update-beneficial-owners-input) `input` URL: /connect/docs/types/inputs/company-custom-shareholder-input # CompanyCustomShareholderInput import { Callout } from 'fumadocs-ui/components/callout'; The data input for an edited company shareholder. ```graphql input CompanyCustomShareholderInput { ownerId: BusinessEntityIdInput! ownership: Float comment: String } ``` Fields [#fields] ownerId BusinessEntityIdInput! non-null scalar [#owneridbusinessentityidinput-non-null-scalar] [`BusinessEntityIdInput!`](/types/scalars/business-entity-id-input) ownership Float scalar [#ownershipfloat-scalar] [`Float`](/types/scalars/float) The ownership percentage \[0, 100]. Set to null to remove the shareholder. comment String scalar [#commentstring-scalar] [`String`](/types/scalars/string) Member Of [#member-of] [`CompanyUpdateShareholdersInput`](/types/inputs/company-update-shareholders-input) `input` URL: /connect/docs/types/inputs/company-identifier-search-input # CompanyIdentifierSearchInput import { Callout } from 'fumadocs-ui/components/callout'; Input to lookup companies by registration number. ```graphql input CompanyIdentifierSearchInput { identifiers: [String!]! country: CountryCode! } ``` Fields [#fields] identifiers [String!]! non-null scalar [#identifiersstring-non-null-scalar] [`[String!]!`](/types/scalars/string) country CountryCode! non-null scalar [#countrycountrycode-non-null-scalar] [`CountryCode!`](/types/scalars/country-code) Member Of [#member-of] [`companyIdentifierSearch`](/queries/company-identifier-search) `query` URL: /connect/docs/types/inputs/company-name-search-input # CompanyNameSearchInput import { Callout } from 'fumadocs-ui/components/callout'; A filter for looking up a company by name. ```graphql input CompanyNameSearchInput { query: String! country: CountryCode source: CompanySearchSource } ``` Fields [#fields] query String! non-null scalar [#querystring-non-null-scalar] [`String!`](/types/scalars/string) The query string to search for. country CountryCode scalar [#countrycountrycode-scalar] [`CountryCode`](/types/scalars/country-code) source CompanySearchSource enum [#sourcecompanysearchsource-enum] [`CompanySearchSource`](/types/enums/company-search-source) The data source to search. When not specified, searches local registries and Sayari (if enabled). Member Of [#member-of] [`companySearch`](/queries/company-search) `query` URL: /connect/docs/types/inputs/company-ownership-input # CompanyOwnershipInput import { Callout } from 'fumadocs-ui/components/callout'; The data input for updating company ownership. ```graphql input CompanyOwnershipInput { id: CompanyId! ownership: Float comment: String beneficialOwner: Boolean = false } ``` Fields [#fields] id CompanyId! non-null scalar [#idcompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) ownership Float scalar [#ownershipfloat-scalar] [`Float`](/types/scalars/float) comment String scalar [#commentstring-scalar] [`String`](/types/scalars/string) beneficialOwner Boolean scalar [#beneficialownerboolean-scalar] [`Boolean`](/types/scalars/boolean) Member Of [#member-of] [`CustomCompanyCreateInput`](/types/inputs/custom-company-create-input) `input` [`CustomCompanyUpdateInput`](/types/inputs/custom-company-update-input) `input` [`CustomOwnersInput`](/types/inputs/custom-owners-input) `input` URL: /connect/docs/types/inputs/company-reset-fields-input # CompanyResetFieldsInput import { Callout } from 'fumadocs-ui/components/callout'; The data input for resetting edits for a company on the given fields. ```graphql input CompanyResetFieldsInput { company: CompanyId! fields: [CompanyResetFieldKindInput!]! } ``` Fields [#fields] company CompanyId! non-null scalar [#companycompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) fields [CompanyResetFieldKindInput!]! non-null enum [#fieldscompanyresetfieldkindinput-non-null-enum] [`[CompanyResetFieldKindInput!]!`](/types/enums/company-reset-field-kind-input) The fields to reset edits for. Member Of [#member-of] [`companyResetFields`](/mutations/company-reset-fields) `mutation` URL: /connect/docs/types/inputs/company-review-trigger-event-where-input # CompanyReviewTriggerEventWhereInput import { Callout } from 'fumadocs-ui/components/callout'; Input to lookup company review trigger events by entity ID and time interval. ```graphql input CompanyReviewTriggerEventWhereInput { company: CompanyId! from: DateTime to: DateTime } ``` Fields [#fields] company CompanyId! non-null scalar [#companycompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) from DateTime scalar [#fromdatetime-scalar] [`DateTime`](/types/scalars/date-time) to DateTime scalar [#todatetime-scalar] [`DateTime`](/types/scalars/date-time) Member Of [#member-of] [`reviewTriggerCompanySearch`](/queries/review-trigger-company-search) `query` URL: /connect/docs/types/inputs/company-update-beneficial-owners-input # CompanyUpdateBeneficialOwnersInput import { Callout } from 'fumadocs-ui/components/callout'; The data input for updating company beneficial owners. ```graphql input CompanyUpdateBeneficialOwnersInput { company: CompanyId! beneficialOwners: [CompanyCustomBeneficialOwnerInput!]! } ``` Fields [#fields] company CompanyId! non-null scalar [#companycompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) beneficialOwners [CompanyCustomBeneficialOwnerInput!]! non-null input [#beneficialownerscompanycustombeneficialownerinput-non-null-input] [`[CompanyCustomBeneficialOwnerInput!]!`](/types/inputs/company-custom-beneficial-owner-input) The list of beneficial owners to be updated. Member Of [#member-of] [`companyUpdateBeneficialOwners`](/mutations/company-update-beneficial-owners) `mutation` URL: /connect/docs/types/inputs/company-update-shareholders-input # CompanyUpdateShareholdersInput import { Callout } from 'fumadocs-ui/components/callout'; The data input for updating company shareholders. ```graphql input CompanyUpdateShareholdersInput { company: CompanyId! shareholders: [CompanyCustomShareholderInput!]! } ``` Fields [#fields] company CompanyId! non-null scalar [#companycompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) shareholders [CompanyCustomShareholderInput!]! non-null input [#shareholderscompanycustomshareholderinput-non-null-input] [`[CompanyCustomShareholderInput!]!`](/types/inputs/company-custom-shareholder-input) The list of shareholders to be updated. Member Of [#member-of] [`companyUpdateShareholders`](/mutations/company-update-shareholders) `mutation` URL: /connect/docs/types/inputs/company-where-input # CompanyWhereInput import { Callout } from 'fumadocs-ui/components/callout'; The data input for adding a company. ```graphql input CompanyWhereInput { id: CompanyId! } ``` Fields [#fields] id CompanyId! non-null scalar [#idcompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) Member Of [#member-of] [`company`](/queries/company) `query` [`companyAddToMonitoring`](/mutations/company-add-to-monitoring) `mutation` [`companyCreditReportOrder`](/mutations/company-credit-report-order) `mutation` [`companyRemoveFromMonitoring`](/mutations/company-remove-from-monitoring) `mutation` [`reviewCompanyCreate`](/mutations/review-company-create) `mutation` [`reviewTriggerEventGenerate`](/mutations/review-trigger-event-generate) `mutation` URL: /connect/docs/types/inputs/connect-business-person-search-input # ConnectBusinessPersonSearchInput import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql input ConnectBusinessPersonSearchInput { query: String! country: CountryCode gender: Gender birthDate: Date birthYear: Year } ``` Fields [#fields] query String! non-null scalar [#querystring-non-null-scalar] [`String!`](/types/scalars/string) The query string to search for. Should be at least 3 characters long. country CountryCode scalar [#countrycountrycode-scalar] [`CountryCode`](/types/scalars/country-code) The country where the person is registered. E.g. if you are looking for a Swedish person operating in Norway this should be set to Norway. gender Gender enum [#gendergender-enum] [`Gender`](/types/enums/gender) birthDate Date scalar [#birthdatedate-scalar] [`Date`](/types/scalars/date) birthYear Year scalar [#birthyearyear-scalar] [`Year`](/types/scalars/year) Member Of [#member-of] [`businessPersonSearch`](/queries/business-person-search) `query` URL: /connect/docs/types/inputs/connect-partial-date-input # ConnectPartialDateInput import { Callout } from 'fumadocs-ui/components/callout'; Input for partial date ```graphql input ConnectPartialDateInput { dayOfMonth: Int month: Int year: Int } ``` Fields [#fields] dayOfMonth Int scalar [#dayofmonthint-scalar] [`Int`](/types/scalars/int) month Int scalar [#monthint-scalar] [`Int`](/types/scalars/int) year Int scalar [#yearint-scalar] [`Int`](/types/scalars/int) Member Of [#member-of] [`CustomCompanyCreateInput`](/types/inputs/custom-company-create-input) `input` [`CustomCompanyUpdateInput`](/types/inputs/custom-company-update-input) `input` [`CustomPersonCreateInput`](/types/inputs/custom-person-create-input) `input` [`CustomPersonEditInput`](/types/inputs/custom-person-edit-input) `input` URL: /connect/docs/types/inputs/connect-portfolio-companies-input # ConnectPortfolioCompaniesInput import { Callout } from 'fumadocs-ui/components/callout'; A filter for listing out companies in a portfolio. ```graphql input ConnectPortfolioCompaniesInput { countries: [CountryCode!] statuses: [EntityPortfolioStatus!] } ``` Fields [#fields] countries [CountryCode!] list scalar [#countriescountrycode-list-scalar] [`[CountryCode!]`](/types/scalars/country-code) statuses [EntityPortfolioStatus!] list enum [#statusesentityportfoliostatus-list-enum] [`[EntityPortfolioStatus!]`](/types/enums/entity-portfolio-status) Member Of [#member-of] [`portfolioCompanies`](/queries/portfolio-companies) `query` URL: /connect/docs/types/inputs/country-context-input # CountryContextInput import { Callout } from 'fumadocs-ui/components/callout'; Used to define an entity's relationship to a country. Such as a Company's country of residence, a PrivatePerson's citizenship, or a CustomBusinessPerson's nationality. ```graphql input CountryContextInput { country: CountryCode! relationship: CountryRelationship! } ``` Fields [#fields] country CountryCode! non-null scalar [#countrycountrycode-non-null-scalar] [`CountryCode!`](/types/scalars/country-code) relationship CountryRelationship! non-null enum [#relationshipcountryrelationship-non-null-enum] [`CountryRelationship!`](/types/enums/country-relationship) Member Of [#member-of] [`CustomPersonOwnershipInput`](/types/inputs/custom-person-ownership-input) `input` URL: /connect/docs/types/inputs/create-company-from-global-entity-input # CreateCompanyFromGlobalEntityInput import { Callout } from 'fumadocs-ui/components/callout'; Input for creating a company from a global entity source (e.g., Orbis). ```graphql input CreateCompanyFromGlobalEntityInput { globalDataSource: GlobalDataSource! sourceIdentifier: String! } ``` Fields [#fields] globalDataSource GlobalDataSource! non-null enum [#globaldatasourceglobaldatasource-non-null-enum] [`GlobalDataSource!`](/types/enums/global-data-source) The global data source to fetch entity data from. sourceIdentifier String! non-null scalar [#sourceidentifierstring-non-null-scalar] [`String!`](/types/scalars/string) The identifier of the entity in the global data source (e.g., BvD ID for Orbis). Member Of [#member-of] [`companyEnrichGlobalEntity`](/mutations/company-enrich-global-entity) `mutation` URL: /connect/docs/types/inputs/create-form-url-input # CreateFormUrlInput import { Callout } from 'fumadocs-ui/components/callout'; The data input for creating a new URL for a customer facing form. ```graphql input CreateFormUrlInput { companyId: CompanyId! documentId: ID! timeToLive: Int } ``` Fields [#fields] companyId CompanyId! non-null scalar [#companyidcompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) Id of the company associated with the form documentId ID! non-null scalar [#documentidid-non-null-scalar] [`ID!`](/types/scalars/id) Id of the document associated with the form. Retrieved from the `id` field of a `Document` on the `Company.documents` query. timeToLive Int scalar [#timetoliveint-scalar] [`Int`](/types/scalars/int) Time to live for the URL in seconds. Defaults to 30 days. Member Of [#member-of] [`createFormUrl`](/mutations/create-form-url) `mutation` URL: /connect/docs/types/inputs/custom-business-person-where-input # CustomBusinessPersonWhereInput import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql input CustomBusinessPersonWhereInput { id: CustomBusinessPersonId! } ``` Fields [#fields] id CustomBusinessPersonId! non-null scalar [#idcustombusinesspersonid-non-null-scalar] [`CustomBusinessPersonId!`](/types/scalars/custom-business-person-id) Member Of [#member-of] [`customBusinessPerson`](/queries/custom-business-person) `query` URL: /connect/docs/types/inputs/custom-company-create-input # CustomCompanyCreateInput import { Callout } from 'fumadocs-ui/components/callout'; Input to create a custom company. ```graphql input CustomCompanyCreateInput { name: String! country: CountryCode legalForm: LegalFormKind orgNumber: String inceptionDate: ConnectPartialDateInput address: AddressInput shareholders: [CompanyOwnershipInput!] companyShareholders: [CompanyOwnershipInput!]! personShareholders: [BusinessPersonOwnershipInput!]! } ``` Fields [#fields] name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) country CountryCode scalar [#countrycountrycode-scalar] [`CountryCode`](/types/scalars/country-code) legalForm LegalFormKind enum [#legalformlegalformkind-enum] [`LegalFormKind`](/types/enums/legal-form-kind) orgNumber String scalar [#orgnumberstring-scalar] [`String`](/types/scalars/string) inceptionDate ConnectPartialDateInput input [#inceptiondateconnectpartialdateinput-input] [`ConnectPartialDateInput`](/types/inputs/connect-partial-date-input) address AddressInput input [#addressaddressinput-input] [`AddressInput`](/types/inputs/address-input) shareholders [CompanyOwnershipInput!] list input [#shareholderscompanyownershipinput-list-input] [`[CompanyOwnershipInput!]`](/types/inputs/company-ownership-input) companyShareholders [CompanyOwnershipInput!]! non-null input [#companyshareholderscompanyownershipinput-non-null-input] [`[CompanyOwnershipInput!]!`](/types/inputs/company-ownership-input) personShareholders [BusinessPersonOwnershipInput!]! non-null input [#personshareholdersbusinesspersonownershipinput-non-null-input] [`[BusinessPersonOwnershipInput!]!`](/types/inputs/business-person-ownership-input) Member Of [#member-of] [`customCompanyCreate`](/mutations/custom-company-create) `mutation` URL: /connect/docs/types/inputs/custom-company-update-input # CustomCompanyUpdateInput import { Callout } from 'fumadocs-ui/components/callout'; Input to update a custom company. ```graphql input CustomCompanyUpdateInput { id: CompanyId! name: String! country: CountryCode legalForm: LegalFormKind orgNumber: String inceptionDate: ConnectPartialDateInput address: AddressInput shareholders: [CompanyOwnershipInput!] companyShareholders: [CompanyOwnershipInput!]! personShareholders: [BusinessPersonOwnershipInput!]! } ``` Fields [#fields] id CompanyId! non-null scalar [#idcompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) country CountryCode scalar [#countrycountrycode-scalar] [`CountryCode`](/types/scalars/country-code) legalForm LegalFormKind enum [#legalformlegalformkind-enum] [`LegalFormKind`](/types/enums/legal-form-kind) orgNumber String scalar [#orgnumberstring-scalar] [`String`](/types/scalars/string) inceptionDate ConnectPartialDateInput input [#inceptiondateconnectpartialdateinput-input] [`ConnectPartialDateInput`](/types/inputs/connect-partial-date-input) address AddressInput input [#addressaddressinput-input] [`AddressInput`](/types/inputs/address-input) shareholders [CompanyOwnershipInput!] list input [#shareholderscompanyownershipinput-list-input] [`[CompanyOwnershipInput!]`](/types/inputs/company-ownership-input) companyShareholders [CompanyOwnershipInput!]! non-null input [#companyshareholderscompanyownershipinput-non-null-input] [`[CompanyOwnershipInput!]!`](/types/inputs/company-ownership-input) personShareholders [BusinessPersonOwnershipInput!]! non-null input [#personshareholdersbusinesspersonownershipinput-non-null-input] [`[BusinessPersonOwnershipInput!]!`](/types/inputs/business-person-ownership-input) Member Of [#member-of] [`customCompanyUpdate`](/mutations/custom-company-update) `mutation` URL: /connect/docs/types/inputs/custom-company-where-input # CustomCompanyWhereInput import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql input CustomCompanyWhereInput { id: CompanyId! } ``` Fields [#fields] id CompanyId! non-null scalar [#idcompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) Member Of [#member-of] [`customCompanyDelete`](/mutations/custom-company-delete) `mutation` URL: /connect/docs/types/inputs/custom-owners-input # CustomOwnersInput import { Callout } from 'fumadocs-ui/components/callout'; The data input for updating company ownership. If companies and businessPersons are both empty lists, custom ownerships will be reset ```graphql input CustomOwnersInput { company: CompanyId! companies: [CompanyOwnershipInput!]! businessPersons: [BusinessPersonOwnershipInput!]! customPersons: [CustomPersonOwnershipInput!]! } ``` Fields [#fields] company CompanyId! non-null scalar [#companycompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) companies [CompanyOwnershipInput!]! non-null input [#companiescompanyownershipinput-non-null-input] [`[CompanyOwnershipInput!]!`](/types/inputs/company-ownership-input) businessPersons [BusinessPersonOwnershipInput!]! non-null input [#businesspersonsbusinesspersonownershipinput-non-null-input] [`[BusinessPersonOwnershipInput!]!`](/types/inputs/business-person-ownership-input) customPersons [CustomPersonOwnershipInput!]! non-null input [#custompersonscustompersonownershipinput-non-null-input] [`[CustomPersonOwnershipInput!]!`](/types/inputs/custom-person-ownership-input) Member Of [#member-of] [`companyOwnersUpdate`](/mutations/company-owners-update) `mutation` URL: /connect/docs/types/inputs/custom-person-create-input # CustomPersonCreateInput import { Callout } from 'fumadocs-ui/components/callout'; The data for creating a custom person. ```graphql input CustomPersonCreateInput { name: String! citizenship: CountryCode birthDate: ConnectPartialDateInput nin: String sex: Gender address: [AddressInput!]! } ``` Fields [#fields] name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) citizenship CountryCode scalar [#citizenshipcountrycode-scalar] [`CountryCode`](/types/scalars/country-code) birthDate ConnectPartialDateInput input [#birthdateconnectpartialdateinput-input] [`ConnectPartialDateInput`](/types/inputs/connect-partial-date-input) nin String scalar [#ninstring-scalar] [`String`](/types/scalars/string) sex Gender enum [#sexgender-enum] [`Gender`](/types/enums/gender) address [AddressInput!]! non-null input [#addressaddressinput-non-null-input] [`[AddressInput!]!`](/types/inputs/address-input) Member Of [#member-of] [`customPersonCreate`](/mutations/custom-person-create) `mutation` URL: /connect/docs/types/inputs/custom-person-edit-input # CustomPersonEditInput import { Callout } from 'fumadocs-ui/components/callout'; The data for editing a custom person. ```graphql input CustomPersonEditInput { id: BusinessPersonId! name: String! citizenship: CountryCode birthDate: ConnectPartialDateInput nin: String sex: Gender address: [AddressInput!]! } ``` Fields [#fields] id BusinessPersonId! non-null scalar [#idbusinesspersonid-non-null-scalar] [`BusinessPersonId!`](/types/scalars/business-person-id) name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) citizenship CountryCode scalar [#citizenshipcountrycode-scalar] [`CountryCode`](/types/scalars/country-code) birthDate ConnectPartialDateInput input [#birthdateconnectpartialdateinput-input] [`ConnectPartialDateInput`](/types/inputs/connect-partial-date-input) nin String scalar [#ninstring-scalar] [`String`](/types/scalars/string) sex Gender enum [#sexgender-enum] [`Gender`](/types/enums/gender) address [AddressInput!]! non-null input [#addressaddressinput-non-null-input] [`[AddressInput!]!`](/types/inputs/address-input) Member Of [#member-of] [`customPersonEdit`](/mutations/custom-person-edit) `mutation` URL: /connect/docs/types/inputs/custom-person-ownership-input # CustomPersonOwnershipInput import { Callout } from 'fumadocs-ui/components/callout'; The data input for updating company ownership. ```graphql input CustomPersonOwnershipInput { name: String! birthDate: Date ownership: Float countries: [CountryContextInput!]! comment: String beneficialOwner: Boolean = false } ``` Fields [#fields] name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) birthDate Date scalar [#birthdatedate-scalar] [`Date`](/types/scalars/date) ownership Float scalar [#ownershipfloat-scalar] [`Float`](/types/scalars/float) countries [CountryContextInput!]! non-null input [#countriescountrycontextinput-non-null-input] [`[CountryContextInput!]!`](/types/inputs/country-context-input) comment String scalar [#commentstring-scalar] [`String`](/types/scalars/string) beneficialOwner Boolean scalar [#beneficialownerboolean-scalar] [`Boolean`](/types/scalars/boolean) Member Of [#member-of] [`CustomOwnersInput`](/types/inputs/custom-owners-input) `input` URL: /connect/docs/types/inputs/document-where-input # DocumentWhereInput import { Callout } from 'fumadocs-ui/components/callout'; The data input for fetching a document. ```graphql input DocumentWhereInput { companyId: CompanyId! documentId: ID! } ``` Fields [#fields] companyId CompanyId! non-null scalar [#companyidcompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) The ID of the company to which the document belongs. documentId ID! non-null scalar [#documentidid-non-null-scalar] [`ID!`](/types/scalars/id) The ID of the document. Member Of [#member-of] [`document`](/queries/document) `query` URL: /connect/docs/types/inputs/entity-custom-risk-field-update-input # EntityCustomRiskFieldUpdateInput import { Callout } from 'fumadocs-ui/components/callout'; Input to update the selected options for a custom risk field on an entity. ```graphql input EntityCustomRiskFieldUpdateInput { id: ID! riskFieldId: ID! selectedOptionIds: [ID!]! } ``` Fields [#fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) riskFieldId ID! non-null scalar [#riskfieldidid-non-null-scalar] [`ID!`](/types/scalars/id) selectedOptionIds [ID!]! non-null scalar [#selectedoptionidsid-non-null-scalar] [`[ID!]!`](/types/scalars/id) Member Of [#member-of] [`entityUpdateCustomRiskField`](/mutations/entity-update-custom-risk-field) `mutation` URL: /connect/docs/types/inputs/person-registry-search-input # PersonRegistrySearchInput import { Callout } from 'fumadocs-ui/components/callout'; Input for looking up a private person in official registries. ```graphql input PersonRegistrySearchInput { name: String! nin: String birthDate: Date zipCode: String streetName: String houseNumber: String country: CountryCode! } ``` Fields [#fields] name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) The name to search for. At least one first name and one last name is required. nin String scalar [#ninstring-scalar] [`String`](/types/scalars/string) National identifier number. birthDate Date scalar [#birthdatedate-scalar] [`Date`](/types/scalars/date) zipCode String scalar [#zipcodestring-scalar] [`String`](/types/scalars/string) streetName String scalar [#streetnamestring-scalar] [`String`](/types/scalars/string) houseNumber String scalar [#housenumberstring-scalar] [`String`](/types/scalars/string) country CountryCode! non-null scalar [#countrycountrycode-non-null-scalar] [`CountryCode!`](/types/scalars/country-code) Determines which country's registry to search in. Member Of [#member-of] [`privatePersonRegistrySearch`](/queries/private-person-registry-search) `query` URL: /connect/docs/types/inputs/person-review-trigger-event-where-input # PersonReviewTriggerEventWhereInput import { Callout } from 'fumadocs-ui/components/callout'; Input to lookup person review trigger events by person ID and time interval. ```graphql input PersonReviewTriggerEventWhereInput { person: PrivatePersonId! from: DateTime to: DateTime } ``` Fields [#fields] person PrivatePersonId! non-null scalar [#personprivatepersonid-non-null-scalar] [`PrivatePersonId!`](/types/scalars/private-person-id) from DateTime scalar [#fromdatetime-scalar] [`DateTime`](/types/scalars/date-time) to DateTime scalar [#todatetime-scalar] [`DateTime`](/types/scalars/date-time) Member Of [#member-of] [`reviewTriggerPersonSearch`](/queries/review-trigger-person-search) `query` URL: /connect/docs/types/inputs/person-search-input # PersonSearchInput import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql input PersonSearchInput { query: String! country: CountryCode gender: Gender birthDate: Date birthYear: Year hasNin: Boolean } ``` Fields [#fields] query String! non-null scalar [#querystring-non-null-scalar] [`String!`](/types/scalars/string) The name to search for. Setting it as an empty string will return persons ordered alphabetically by name country CountryCode scalar [#countrycountrycode-scalar] [`CountryCode`](/types/scalars/country-code) The registry country of the person. Will be ignored if not one of the supported registry countries. gender Gender enum [#gendergender-enum] [`Gender`](/types/enums/gender) The gender to search for. birthDate Date scalar [#birthdatedate-scalar] [`Date`](/types/scalars/date) birthYear Year scalar [#birthyearyear-scalar] [`Year`](/types/scalars/year) hasNin Boolean scalar [#hasninboolean-scalar] [`Boolean`](/types/scalars/boolean) Member Of [#member-of] [`privatePersonSearch`](/queries/private-person-search) `query` URL: /connect/docs/types/inputs/private-person-create-input # PrivatePersonCreateInput import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql input PrivatePersonCreateInput { name: String! nin: String! country: CountryCode! birthDate: Date birthYear: Year gender: Gender address: [AddressInput!]! citizenship: CountryCode } ``` Fields [#fields] name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) nin String! non-null scalar [#ninstring-non-null-scalar] [`String!`](/types/scalars/string) country CountryCode! non-null scalar [#countrycountrycode-non-null-scalar] [`CountryCode!`](/types/scalars/country-code) birthDate Date scalar [#birthdatedate-scalar] [`Date`](/types/scalars/date) birthYear Year scalar [#birthyearyear-scalar] [`Year`](/types/scalars/year) gender Gender enum [#gendergender-enum] [`Gender`](/types/enums/gender) address [AddressInput!]! non-null input [#addressaddressinput-non-null-input] [`[AddressInput!]!`](/types/inputs/address-input) citizenship CountryCode scalar [#citizenshipcountrycode-scalar] [`CountryCode`](/types/scalars/country-code) Member Of [#member-of] [`privatePersonCreate`](/mutations/private-person-create) `mutation` [`privatePersonCreateNoEnrich`](/mutations/private-person-create-no-enrich) `mutation` URL: /connect/docs/types/inputs/private-person-identifier-search-input # PrivatePersonIdentifierSearchInput import { Callout } from 'fumadocs-ui/components/callout'; Input to lookup private persons by their identifiers, such as their personal number. ```graphql input PrivatePersonIdentifierSearchInput { identifiers: [String!]! country: CountryCode } ``` Fields [#fields] identifiers [String!]! non-null scalar [#identifiersstring-non-null-scalar] [`[String!]!`](/types/scalars/string) The identifiers to search for. country CountryCode scalar [#countrycountrycode-scalar] [`CountryCode`](/types/scalars/country-code) Member Of [#member-of] [`privatePersonIdentifierSearch`](/queries/private-person-identifier-search) `query` URL: /connect/docs/types/inputs/private-person-update-input # PrivatePersonUpdateInput import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql input PrivatePersonUpdateInput { id: PrivatePersonId! name: String nin: String country: CountryCode birthDate: Date birthYear: Year gender: Gender address: [AddressInput!] citizenship: CountryCode } ``` Fields [#fields] id PrivatePersonId! non-null scalar [#idprivatepersonid-non-null-scalar] [`PrivatePersonId!`](/types/scalars/private-person-id) name String scalar [#namestring-scalar] [`String`](/types/scalars/string) nin String scalar [#ninstring-scalar] [`String`](/types/scalars/string) country CountryCode scalar [#countrycountrycode-scalar] [`CountryCode`](/types/scalars/country-code) birthDate Date scalar [#birthdatedate-scalar] [`Date`](/types/scalars/date) birthYear Year scalar [#birthyearyear-scalar] [`Year`](/types/scalars/year) gender Gender enum [#gendergender-enum] [`Gender`](/types/enums/gender) address [AddressInput!] list input [#addressaddressinput-list-input] [`[AddressInput!]`](/types/inputs/address-input) citizenship CountryCode scalar [#citizenshipcountrycode-scalar] [`CountryCode`](/types/scalars/country-code) Member Of [#member-of] [`privatePersonUpdate`](/mutations/private-person-update) `mutation` URL: /connect/docs/types/inputs/private-person-where-input # PrivatePersonWhereInput import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql input PrivatePersonWhereInput { id: PrivatePersonId! } ``` Fields [#fields] id PrivatePersonId! non-null scalar [#idprivatepersonid-non-null-scalar] [`PrivatePersonId!`](/types/scalars/private-person-id) Member Of [#member-of] [`privatePerson`](/queries/private-person) `query` [`privatePersonAddToMonitoring`](/mutations/private-person-add-to-monitoring) `mutation` [`privatePersonDelete`](/mutations/private-person-delete) `mutation` [`privatePersonRemoveFromMonitoring`](/mutations/private-person-remove-from-monitoring) `mutation` [`reviewPrivatePersonCreate`](/mutations/review-private-person-create) `mutation` URL: /connect/docs/types/inputs/private-persons-where-input # PrivatePersonsWhereInput import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql input PrivatePersonsWhereInput { ids: [PrivatePersonId!]! } ``` Fields [#fields] ids [PrivatePersonId!]! non-null scalar [#idsprivatepersonid-non-null-scalar] [`[PrivatePersonId!]!`](/types/scalars/private-person-id) Member Of [#member-of] [`privatePersonsAddToMonitoring`](/mutations/private-persons-add-to-monitoring) `mutation` URL: /connect/docs/types/inputs/review-trigger-event-where-input # ReviewTriggerEventWhereInput import { Callout } from 'fumadocs-ui/components/callout'; Input to lookup review trigger events time interval. ```graphql input ReviewTriggerEventWhereInput { from: DateTime to: DateTime } ``` Fields [#fields] from DateTime scalar [#fromdatetime-scalar] [`DateTime`](/types/scalars/date-time) to DateTime scalar [#todatetime-scalar] [`DateTime`](/types/scalars/date-time) Member Of [#member-of] [`reviewTriggerSearch`](/queries/review-trigger-search) `query` URL: /connect/docs/types/inputs/review-where-input # ReviewWhereInput import { Callout } from 'fumadocs-ui/components/callout'; Input for querying a review. ```graphql input ReviewWhereInput { id: ID! } ``` Fields [#fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) Member Of [#member-of] [`privatePersonReview`](/queries/private-person-review) `query` [`review`](/queries/review) `query` URL: /connect/docs/types/inputs/sandbox-alert-input # SandboxAlertInput import { Callout } from 'fumadocs-ui/components/callout'; Input for generating or removing a sandbox alert ```graphql input SandboxAlertInput { monitoredEntity: ID! alertType: SandboxAlertType! relatedEntity: ID action: SandboxAlertAction = ADD } ``` Fields [#fields] monitoredEntity ID! non-null scalar [#monitoredentityid-non-null-scalar] [`ID!`](/types/scalars/id) The monitored entity (company) to generate/remove alert for alertType SandboxAlertType! non-null enum [#alerttypesandboxalerttype-non-null-enum] [`SandboxAlertType!`](/types/enums/sandbox-alert-type) Type of alert (PEP or SANCTION) relatedEntity ID scalar [#relatedentityid-scalar] [`ID`](/types/scalars/id) Optional specific related entity for the hit. For PEP: must be a person related to the monitored entity. For SANCTION: can be any related entity. If not provided for ADD: a random related entity will be selected. If not provided for REMOVE: a random existing hit will be removed. action SandboxAlertAction enum [#actionsandboxalertaction-enum] [`SandboxAlertAction`](/types/enums/sandbox-alert-action) Action to perform: ADD (default) creates a new hit, REMOVE deletes an existing hit Member Of [#member-of] [`sandboxAlertGenerate`](/mutations/sandbox-alert-generate) `mutation` URL: /connect/docs/types/inputs/send-form-input # SendFormInput import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql input SendFormInput { companyId: CompanyId! formId: CustomerFacingFormId! recipientEmail: String! recipientName: String! } ``` Fields [#fields] companyId CompanyId! non-null scalar [#companyidcompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) Id of the company to be associated with the form formId CustomerFacingFormId! non-null scalar [#formidcustomerfacingformid-non-null-scalar] [`CustomerFacingFormId!`](/types/scalars/customer-facing-form-id) Id of the form you want to send recipientEmail String! non-null scalar [#recipientemailstring-non-null-scalar] [`String!`](/types/scalars/string) Email address of the recipient recipientName String! non-null scalar [#recipientnamestring-non-null-scalar] [`String!`](/types/scalars/string) Name of the recipient Member Of [#member-of] [`sendForm`](/mutations/send-form) `mutation` URL: /connect/docs/types/inputs/size-page-info-input # SizePageInfoInput import { Callout } from 'fumadocs-ui/components/callout'; Used for pagination. ```graphql input SizePageInfoInput { size: Int! offset: Int = 0 } ``` Fields [#fields] size Int! non-null scalar [#sizeint-non-null-scalar] [`Int!`](/types/scalars/int) The number of items to return. offset Int scalar [#offsetint-scalar] [`Int`](/types/scalars/int) The offset to start from. Member Of [#member-of] [`BusinessPerson`](/types/objects/business-person) `object` [`Company`](/types/objects/company) `object` [`companyIdentifierSearch`](/queries/company-identifier-search) `query` [`companySearch`](/queries/company-search) `query` [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` [`EntityLike`](/types/interfaces/entity-like) `interface` [`MonitoredEntityLike`](/types/interfaces/monitored-entity-like) `interface` [`portfolioCompanies`](/queries/portfolio-companies) `query` [`PrivatePerson`](/types/objects/private-person) `object` [`privatePersonIdentifierSearch`](/queries/private-person-identifier-search) `query` [`privatePersonSearch`](/queries/private-person-search) `query` [`reviewTriggerCompanySearch`](/queries/review-trigger-company-search) `query` [`reviewTriggerPersonSearch`](/queries/review-trigger-person-search) `query` [`reviewTriggerSearch`](/queries/review-trigger-search) `query` URL: /connect/docs/types/inputs/timespan-input # TimespanInput import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql input TimespanInput { from: ISODateTime to: ISODateTime } ``` Fields [#fields] from ISODateTime scalar [#fromisodatetime-scalar] [`ISODateTime`](/types/scalars/isodate-time) to ISODateTime scalar [#toisodatetime-scalar] [`ISODateTime`](/types/scalars/isodate-time) Member Of [#member-of] [`AlertsWhereInput`](/types/inputs/alerts-where-input) `input` URL: /connect/docs/types/interfaces/change-like # ChangeLike import { Callout } from 'fumadocs-ui/components/callout'; An interface type of monitoring change kinds. ```graphql interface ChangeLike { kind: DatasetKind! } ``` Fields [#fields] kind DatasetKind! non-null enum [#kinddatasetkind-non-null-enum] [`DatasetKind!`](/types/enums/dataset-kind) Change kind, determines the data structure of the change. Member Of [#member-of] [`MonitoringChange`](/types/objects/monitoring-change) `object` Implemented By [#implemented-by] [`CompanyPepChange`](/types/objects/company-pep-change) `object` [`CompanyRelationsChange`](/types/objects/company-relations-change) `object` [`CompanySanctionChange`](/types/objects/company-sanction-change) `object` URL: /connect/docs/types/interfaces/entity-like # EntityLike import { Callout } from 'fumadocs-ui/components/callout'; An interface type of external business entities. Either a company or a business person. ```graphql interface EntityLike { name: String! address: [Address!]! @deprecated addresses: [Address!]! countries: [CountryContext!]! identifiers: [EntityIdentifier!]! relationships( kind: [EntityRelationshipKind!]! preferCustomRelations: Boolean! = false ): EntityConnection! sanctioned: Boolean! @deprecated sanctionInfo: SanctionInfo! amsCount: Int! @deprecated ams( pageInfo: SizePageInfoInput = { size: 20, offset: 0 } ): [AmsEvent!]! flags: [FlagKind!]! riskSignals: RiskSignals! } ``` Fields [#fields] name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) Entity name. address [Address!]! deprecated non-null object [#addressaddress-deprecated-non-null-object] [`[Address!]!`](/types/objects/address) Use the `addresses` field instead for a complete list of available addresses. The postal address of the Entity. addresses [Address!]! non-null object [#addressesaddress-non-null-object] [`[Address!]!`](/types/objects/address) The available addresses of the entity. countries [CountryContext!]! non-null object [#countriescountrycontext-non-null-object] [`[CountryContext!]!`](/types/objects/country-context) The countries for the Entity. identifiers [EntityIdentifier!]! non-null object [#identifiersentityidentifier-non-null-object] [`[EntityIdentifier!]!`](/types/objects/entity-identifier) The official identifiers for this Entity. Since an Entity can have several ids (even within the same country), this is a list. relationships EntityConnection! non-null object [#relationshipsentityconnection-non-null-object] [`EntityConnection!`](/types/objects/entity-connection) Related entities (e.g. persons, companies) for this entity. Can be UBOs, board members, etc. kind [EntityRelationshipKind!]! non-null enum [#kindentityrelationshipkind-non-null-enum] [`[EntityRelationshipKind!]!`](/types/enums/entity-relationship-kind) The type of relationships to fetch. If not specified, all relationships will be fetched. Providing an empty list will return all relationship preferCustomRelations Boolean! non-null scalar [#prefercustomrelationsboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether or not to prefer custom relations. If true, only custom relations are returned if any exists. Otherwise, officially registered relations are returned sanctioned Boolean! deprecated non-null scalar [#sanctionedboolean-deprecated-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Use the `sanctionInfo` field instead Whether this entity is sanctioned. sanctionInfo SanctionInfo! non-null object [#sanctioninfosanctioninfo-non-null-object] [`SanctionInfo!`](/types/objects/sanction-info) Sanction information related to this entity. amsCount Int! deprecated non-null scalar [#amscountint-deprecated-non-null-scalar] [`Int!`](/types/scalars/int) Use the `ams` field instead Number of adverse media articles found for this entity. This is an approximation and the actual number may be differ due to clustering of events not performed here. ams [AmsEvent!]! non-null object [#amsamsevent-non-null-object] [`[AmsEvent!]!`](/types/objects/ams-event) Adverse media articles found for this entity. This field replaces the `amsCount` field, which will eventually be deprecated. The `amsCount` field might differ from the actual number returned here, due to different screening solutions being used. pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Used for pagination. Media articles are sorted by the highest relevance first. flags [FlagKind!]! non-null enum [#flagsflagkind-non-null-enum] [`[FlagKind!]!`](/types/enums/flag-kind) Flagged events found for this entity. riskSignals RiskSignals! non-null object [#risksignalsrisksignals-non-null-object] [`RiskSignals!`](/types/objects/risk-signals) Risk signals. Currently there is only one possible risk signal, 'flags', which is created if we find flags of negative severity. Member Of [#member-of] [`BeneficialOwner`](/types/objects/beneficial-owner) `object` [`EntityConnectionEdge`](/types/objects/entity-connection-edge) `object` [`Ownership`](/types/objects/ownership) `object` [`PathConnectionEdge`](/types/objects/path-connection-edge) `object` [`PepChange`](/types/objects/pep-change) `object` [`Role`](/types/objects/role) `object` [`SanctionChange`](/types/objects/sanction-change) `object` [`ShareholderGraphNode`](/types/objects/shareholder-graph-node) `object` Implemented By [#implemented-by] [`BusinessPerson`](/types/objects/business-person) `object` [`Company`](/types/objects/company) `object` [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` URL: /connect/docs/types/interfaces/monitored-entity-like # MonitoredEntityLike import { Callout } from 'fumadocs-ui/components/callout'; An interface type of external business entities that can be monitored. ```graphql interface MonitoredEntityLike { name: String! address: [Address!]! countries: [CountryContext!]! identifiers: [EntityIdentifier!]! sanctioned: Boolean! @deprecated sanctionInfo: SanctionInfo! amsCount: Int! @deprecated ams( pageInfo: SizePageInfoInput = { size: 20, offset: 0 } ): [AmsEvent!]! flags: [FlagKind!]! riskSignals: RiskSignals! } ``` Fields [#fields] name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) Entity name. address [Address!]! non-null object [#addressaddress-non-null-object] [`[Address!]!`](/types/objects/address) The postal address of the Entity. countries [CountryContext!]! non-null object [#countriescountrycontext-non-null-object] [`[CountryContext!]!`](/types/objects/country-context) The countries for the Entity. identifiers [EntityIdentifier!]! non-null object [#identifiersentityidentifier-non-null-object] [`[EntityIdentifier!]!`](/types/objects/entity-identifier) The official identifiers for this Entity. Since an Entity can have several ids (even within the same country), this is a list. sanctioned Boolean! deprecated non-null scalar [#sanctionedboolean-deprecated-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Use the `sanctionInfo` field instead Whether this entity is sanctioned. sanctionInfo SanctionInfo! non-null object [#sanctioninfosanctioninfo-non-null-object] [`SanctionInfo!`](/types/objects/sanction-info) Sanction information related to this entity. amsCount Int! deprecated non-null scalar [#amscountint-deprecated-non-null-scalar] [`Int!`](/types/scalars/int) Use the `ams` field instead Number of adverse media articles found for this entity. This is an approximation and the actual number may be differ due to clustering of events not performed here. ams [AmsEvent!]! non-null object [#amsamsevent-non-null-object] [`[AmsEvent!]!`](/types/objects/ams-event) Adverse media articles found for this entity. This field replaces the `amsCount` field, which will eventually be deprecated. The `amsCount` field might differ from the actual number returned here, due to different screening solutions being used. pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Used for pagination. Media articles are sorted by the highest relevance first. flags [FlagKind!]! non-null enum [#flagsflagkind-non-null-enum] [`[FlagKind!]!`](/types/enums/flag-kind) Flagged events found for this entity. riskSignals RiskSignals! non-null object [#risksignalsrisksignals-non-null-object] [`RiskSignals!`](/types/objects/risk-signals) Risk signals. Currently there is only one possible risk signal, 'flags', which is created if we find flags of negative severity. Member Of [#member-of] [`AlertConnectionEdge`](/types/objects/alert-connection-edge) `object` [`MonitoringChange`](/types/objects/monitoring-change) `object` Implemented By [#implemented-by] [`Company`](/types/objects/company) `object` [`PrivatePerson`](/types/objects/private-person) `object` URL: /connect/docs/types/interfaces/review-trigger-event # ReviewTriggerEvent import { Callout } from 'fumadocs-ui/components/callout'; Interace for review trigger events. ```graphql interface ReviewTriggerEvent { id: ID! triggeredAt: DateTime! statements: [ReviewTriggerStatementKind!]! } ``` Fields [#fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) The ID of the review trigger event. triggeredAt DateTime! non-null scalar [#triggeredatdatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) A timestamp of when the review was triggered. statements [ReviewTriggerStatementKind!]! non-null enum [#statementsreviewtriggerstatementkind-non-null-enum] [`[ReviewTriggerStatementKind!]!`](/types/enums/review-trigger-statement-kind) The statements that make up the trigger. These are the things that have changed since the last review was performed. Member Of [#member-of] [`ReviewTriggerEventSearchConnectionEdge`](/types/objects/review-trigger-event-search-connection-edge) `object` Implemented By [#implemented-by] [`CompanyReviewTriggerEvent`](/types/objects/company-review-trigger-event) `object` [`PersonReviewTriggerEvent`](/types/objects/person-review-trigger-event) `object` URL: /connect/docs/types/objects/access-token # AccessToken import { Callout } from 'fumadocs-ui/components/callout'; An access token used to communicate with the Strise.ai APIs. ```graphql type AccessToken { expires: Int! token: String! } ``` Fields [#fields] expires Int! non-null scalar [#expiresint-non-null-scalar] [`Int!`](/types/scalars/int) The timestamp representing when the token is expiring. This is seconds since epoch. token String! non-null scalar [#tokenstring-non-null-scalar] [`String!`](/types/scalars/string) The access token as a JWT. Returned By [#returned-by] [`clientAccessTokenGenerate`](/mutations/client-access-token-generate) `mutation` URL: /connect/docs/types/objects/address # Address import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type Address { country: Country addressLine: String city: String zipCode: String addressKind: AddressKind } ``` Fields [#fields] country Country object [#countrycountry-object] [`Country`](/types/objects/country) addressLine String scalar [#addresslinestring-scalar] [`String`](/types/scalars/string) city String scalar [#citystring-scalar] [`String`](/types/scalars/string) zipCode String scalar [#zipcodestring-scalar] [`String`](/types/scalars/string) addressKind AddressKind enum [#addresskindaddresskind-enum] [`AddressKind`](/types/enums/address-kind) Member Of [#member-of] [`BusinessPerson`](/types/objects/business-person) `object` [`Company`](/types/objects/company) `object` [`ConnectPrivatePersonRegistrySearchResource`](/types/objects/connect-private-person-registry-search-resource) `object` [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` [`EntityLike`](/types/interfaces/entity-like) `interface` [`MonitoredEntityLike`](/types/interfaces/monitored-entity-like) `interface` [`PrivatePerson`](/types/objects/private-person) `object` URL: /connect/docs/types/objects/alert-connection-edge # AlertConnectionEdge import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type AlertConnectionEdge { node: Alert! monitoredEntityId: ID! monitoredEntity: MonitoredEntityLike } ``` Fields [#fields] node Alert! non-null object [#nodealert-non-null-object] [`Alert!`](/types/objects/alert) monitoredEntityId ID! non-null scalar [#monitoredentityidid-non-null-scalar] [`ID!`](/types/scalars/id) The ID of the monitored entity. Always present even if the entity itself has been deleted. monitoredEntity MonitoredEntityLike interface [#monitoredentitymonitoredentitylike-interface] [`MonitoredEntityLike`](/types/interfaces/monitored-entity-like) Member Of [#member-of] [`AlertConnection`](/types/objects/alert-connection) `object` URL: /connect/docs/types/objects/alert-connection # AlertConnection import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type AlertConnection { pageInfo: PageInfo! edges: [AlertConnectionEdge!]! } ``` Fields [#fields] pageInfo PageInfo! non-null object [#pageinfopageinfo-non-null-object] [`PageInfo!`](/types/objects/page-info) edges [AlertConnectionEdge!]! non-null object [#edgesalertconnectionedge-non-null-object] [`[AlertConnectionEdge!]!`](/types/objects/alert-connection-edge) Returned By [#returned-by] [`alerts`](/queries/alerts) `query` URL: /connect/docs/types/objects/alert-update-payload # AlertUpdatePayload import { Callout } from 'fumadocs-ui/components/callout'; Payload returned after updating alerts. ```graphql type AlertUpdatePayload { success: Boolean! } ``` Fields [#fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether the update was successful. Returned By [#returned-by] [`alertUpdate`](/mutations/alert-update) `mutation` URL: /connect/docs/types/objects/alert # Alert import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type Alert { id: ID! kind: DatasetKind! insertedAt: DateTime! computedAt: DateTime! state: AlertState! resolvedBy: SimpleUser resolvedAt: DateTime } ``` Fields [#fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) kind DatasetKind! non-null enum [#kinddatasetkind-non-null-enum] [`DatasetKind!`](/types/enums/dataset-kind) insertedAt DateTime! non-null scalar [#insertedatdatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) When the alert was made available for APP/API computedAt DateTime! non-null scalar [#computedatdatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) When the alert was computed. There can be a delay from when the alert is computed to when it is made available for APP/API (insertedAt) state AlertState! non-null enum [#statealertstate-non-null-enum] [`AlertState!`](/types/enums/alert-state) resolvedBy SimpleUser object [#resolvedbysimpleuser-object] [`SimpleUser`](/types/objects/simple-user) If the alert state is RESOLVED, who resolved it resolvedAt DateTime scalar [#resolvedatdatetime-scalar] [`DateTime`](/types/scalars/date-time) If the alert state is RESOLVED, when it was resolved Member Of [#member-of] [`AlertConnectionEdge`](/types/objects/alert-connection-edge) `object` URL: /connect/docs/types/objects/ams-entity-mention # AmsEntityMention import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type AmsEntityMention { text: String! span: TextSpan! entityType: NamedEntityKind! containingPhrase: String! containingPhraseSpan: TextSpan! amsPredictions: [AmsPrediction!]! field: String! amsClassification: AmsClassificationKind } ``` Fields [#fields] text String! non-null scalar [#textstring-non-null-scalar] [`String!`](/types/scalars/string) span TextSpan! non-null object [#spantextspan-non-null-object] [`TextSpan!`](/types/objects/text-span) entityType NamedEntityKind! non-null enum [#entitytypenamedentitykind-non-null-enum] [`NamedEntityKind!`](/types/enums/named-entity-kind) containingPhrase String! non-null scalar [#containingphrasestring-non-null-scalar] [`String!`](/types/scalars/string) containingPhraseSpan TextSpan! non-null object [#containingphrasespantextspan-non-null-object] [`TextSpan!`](/types/objects/text-span) amsPredictions [AmsPrediction!]! non-null object [#amspredictionsamsprediction-non-null-object] [`[AmsPrediction!]!`](/types/objects/ams-prediction) field String! non-null scalar [#fieldstring-non-null-scalar] [`String!`](/types/scalars/string) amsClassification AmsClassificationKind enum [#amsclassificationamsclassificationkind-enum] [`AmsClassificationKind`](/types/enums/ams-classification-kind) Member Of [#member-of] [`AmsEvent`](/types/objects/ams-event) `object` URL: /connect/docs/types/objects/ams-event # AmsEvent import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type AmsEvent { id: ID! entityId: ID published: ISODateTime! publisher: String! title: String! summary: String bodyText: String url: String! clusteredEvents: [ClusteredEvent!]! authors: [String!]! images: [String!]! entityMentions: [AmsEntityMention!]! topicMentions: [AmsTopicMentions!]! eventKind: AmsEventKind! createdBy: SimpleUser behindPaywall: Boolean! } ``` Fields [#fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) entityId ID scalar [#entityidid-scalar] [`ID`](/types/scalars/id) published ISODateTime! non-null scalar [#publishedisodatetime-non-null-scalar] [`ISODateTime!`](/types/scalars/isodate-time) publisher String! non-null scalar [#publisherstring-non-null-scalar] [`String!`](/types/scalars/string) title String! non-null scalar [#titlestring-non-null-scalar] [`String!`](/types/scalars/string) summary String scalar [#summarystring-scalar] [`String`](/types/scalars/string) bodyText String scalar [#bodytextstring-scalar] [`String`](/types/scalars/string) url String! non-null scalar [#urlstring-non-null-scalar] [`String!`](/types/scalars/string) clusteredEvents [ClusteredEvent!]! non-null object [#clusteredeventsclusteredevent-non-null-object] [`[ClusteredEvent!]!`](/types/objects/clustered-event) authors [String!]! non-null scalar [#authorsstring-non-null-scalar] [`[String!]!`](/types/scalars/string) images [String!]! non-null scalar [#imagesstring-non-null-scalar] [`[String!]!`](/types/scalars/string) entityMentions [AmsEntityMention!]! non-null object [#entitymentionsamsentitymention-non-null-object] [`[AmsEntityMention!]!`](/types/objects/ams-entity-mention) topicMentions [AmsTopicMentions!]! non-null object [#topicmentionsamstopicmentions-non-null-object] [`[AmsTopicMentions!]!`](/types/objects/ams-topic-mentions) eventKind AmsEventKind! non-null enum [#eventkindamseventkind-non-null-enum] [`AmsEventKind!`](/types/enums/ams-event-kind) createdBy SimpleUser object [#createdbysimpleuser-object] [`SimpleUser`](/types/objects/simple-user) behindPaywall Boolean! non-null scalar [#behindpaywallboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Member Of [#member-of] [`BusinessPerson`](/types/objects/business-person) `object` [`Company`](/types/objects/company) `object` [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` [`EntityLike`](/types/interfaces/entity-like) `interface` [`MonitoredEntityLike`](/types/interfaces/monitored-entity-like) `interface` [`PrivatePerson`](/types/objects/private-person) `object` URL: /connect/docs/types/objects/ams-prediction # AmsPrediction import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type AmsPrediction { context: TextSpan! classification: AmsClassificationKind! score: Float! } ``` Fields [#fields] context TextSpan! non-null object [#contexttextspan-non-null-object] [`TextSpan!`](/types/objects/text-span) classification AmsClassificationKind! non-null enum [#classificationamsclassificationkind-non-null-enum] [`AmsClassificationKind!`](/types/enums/ams-classification-kind) score Float! non-null scalar [#scorefloat-non-null-scalar] [`Float!`](/types/scalars/float) Member Of [#member-of] [`AmsEntityMention`](/types/objects/ams-entity-mention) `object` URL: /connect/docs/types/objects/ams-topic-mentions # AmsTopicMentions import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type AmsTopicMentions { topic: String! mentions: [String!]! } ``` Fields [#fields] topic String! non-null scalar [#topicstring-non-null-scalar] [`String!`](/types/scalars/string) mentions [String!]! non-null scalar [#mentionsstring-non-null-scalar] [`[String!]!`](/types/scalars/string) Member Of [#member-of] [`AmsEvent`](/types/objects/ams-event) `object` URL: /connect/docs/types/objects/attach-form-instance-payload # AttachFormInstancePayload import { Callout } from 'fumadocs-ui/components/callout'; The payload for attaching an externally initiated form instance to a company. ```graphql type AttachFormInstancePayload { success: Boolean! } ``` Fields [#fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Returned By [#returned-by] [`attachFormInstance`](/mutations/attach-form-instance) `mutation` URL: /connect/docs/types/objects/beneficial-owner-change # BeneficialOwnerChange import { Callout } from 'fumadocs-ui/components/callout'; Change in beneficial ownership. ```graphql type BeneficialOwnerChange { toValue: [BeneficialOwner!]! fromValue: [BeneficialOwner!]! } ``` Fields [#fields] toValue [BeneficialOwner!]! non-null object [#tovaluebeneficialowner-non-null-object] [`[BeneficialOwner!]!`](/types/objects/beneficial-owner) fromValue [BeneficialOwner!]! non-null object [#fromvaluebeneficialowner-non-null-object] [`[BeneficialOwner!]!`](/types/objects/beneficial-owner) Member Of [#member-of] [`CompanyRelationsChange`](/types/objects/company-relations-change) `object` URL: /connect/docs/types/objects/beneficial-owner # BeneficialOwner import { Callout } from 'fumadocs-ui/components/callout'; An object representing a beneficial owner of a company. ```graphql type BeneficialOwner { reasons: [BeneficialOwnerReasonKind!]! editMetadata: EditMetadata entity: EntityLike! } ``` Fields [#fields] reasons [BeneficialOwnerReasonKind!]! non-null enum [#reasonsbeneficialownerreasonkind-non-null-enum] [`[BeneficialOwnerReasonKind!]!`](/types/enums/beneficial-owner-reason-kind) The reasons for the entity being considered a beneficial owner. editMetadata EditMetadata object [#editmetadataeditmetadata-object] [`EditMetadata`](/types/objects/edit-metadata) Metadata about edits made to this beneficial ownership relationship. entity EntityLike! non-null interface [#entityentitylike-non-null-interface] [`EntityLike!`](/types/interfaces/entity-like) The entity on the opposite side of the beneficial ownership relationship. If the beneficial owner object is fetched from a `Company`, this entity represents the beneficial owner (e.g. a person or another company). If the beneficial owner is fetched from a `BusinessPerson`, this is the company where the person holds beneficial ownership. Member Of [#member-of] [`BeneficialOwnerChange`](/types/objects/beneficial-owner-change) `object` [`BusinessPerson`](/types/objects/business-person) `object` [`Company`](/types/objects/company) `object` URL: /connect/docs/types/objects/business-person-search-connection-edge # BusinessPersonSearchConnectionEdge import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type BusinessPersonSearchConnectionEdge { node: BusinessPerson! } ``` Fields [#fields] node BusinessPerson! non-null object [#nodebusinessperson-non-null-object] [`BusinessPerson!`](/types/objects/business-person) Member Of [#member-of] [`BusinessPersonSearchConnection`](/types/objects/business-person-search-connection) `object` URL: /connect/docs/types/objects/business-person-search-connection # BusinessPersonSearchConnection import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type BusinessPersonSearchConnection { edges: [BusinessPersonSearchConnectionEdge!]! } ``` Fields [#fields] edges [BusinessPersonSearchConnectionEdge!]! non-null object [#edgesbusinesspersonsearchconnectionedge-non-null-object] [`[BusinessPersonSearchConnectionEdge!]!`](/types/objects/business-person-search-connection-edge) Returned By [#returned-by] [`businessPersonSearch`](/queries/business-person-search) `query` URL: /connect/docs/types/objects/business-person # BusinessPerson import { Callout } from 'fumadocs-ui/components/callout'; A resource representing a business person. ```graphql type BusinessPerson implements EntityLike { id: BusinessPersonId! gender: Gender birthDate: Date birthYear: Year pep: Boolean! @deprecated pepInfo: PepInfo! beneficialOwnerships( ignoreEdits: Boolean = false ): [BeneficialOwner!]! roles( includePrevious: Boolean = false ignoreEdits: Boolean = false ): [Role!]! holdings( minimumSharePercentage: Float = 0 ignoreEdits: Boolean = false ): [Ownership!]! name: String! address: [Address!]! @deprecated addresses: [Address!]! countries: [CountryContext!]! identifiers: [EntityIdentifier!]! relationships( kind: [EntityRelationshipKind!]! preferCustomRelations: Boolean! = false ): EntityConnection! sanctioned: Boolean! @deprecated sanctionInfo: SanctionInfo! amsCount: Int! @deprecated ams( pageInfo: SizePageInfoInput = { size: 20, offset: 0 } ): [AmsEvent!]! flags: [FlagKind!]! riskSignals: RiskSignals! } ``` Fields [#fields] id BusinessPersonId! non-null scalar [#idbusinesspersonid-non-null-scalar] [`BusinessPersonId!`](/types/scalars/business-person-id) gender Gender enum [#gendergender-enum] [`Gender`](/types/enums/gender) The gender of the person. birthDate Date scalar [#birthdatedate-scalar] [`Date`](/types/scalars/date) The birth date of the person. birthYear Year scalar [#birthyearyear-scalar] [`Year`](/types/scalars/year) The birth year of the person. pep Boolean! deprecated non-null scalar [#pepboolean-deprecated-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Use the `pepInfo` field instead. Whether the person is a PEP or not. pepInfo PepInfo! non-null object [#pepinfopepinfo-non-null-object] [`PepInfo!`](/types/objects/pep-info) PEP information. beneficialOwnerships [BeneficialOwner!]! non-null object [#beneficialownershipsbeneficialowner-non-null-object] [`[BeneficialOwner!]!`](/types/objects/beneficial-owner) The beneficial ownerships that the person holds in companies. ignoreEdits Boolean scalar [#ignoreeditsboolean-scalar] [`Boolean`](/types/scalars/boolean) Whether to ignore edits made by users. If set to true, the returned beneficial ownerships will only be based on official registry data, disregarding any edits made by users. roles [Role!]! non-null object [#rolesrole-non-null-object] [`[Role!]!`](/types/objects/role) The roles that the person holds in companies. includePrevious Boolean scalar [#includepreviousboolean-scalar] [`Boolean`](/types/scalars/boolean) Whether to include previous roles, i.e., roles which have been terminated. ignoreEdits Boolean scalar [#ignoreeditsboolean-scalar-1] [`Boolean`](/types/scalars/boolean) Whether to ignore edits made by users. If set to true, the returned roles will only be based on official registry data, disregarding any edits made by users. holdings [Ownership!]! non-null object [#holdingsownership-non-null-object] [`[Ownership!]!`](/types/objects/ownership) The person's direct holdings, i.e., companies owned by this person. minimumSharePercentage Float scalar [#minimumsharepercentagefloat-scalar] [`Float`](/types/scalars/float) The lower bound of the share percentage range to include in the result. Must be greater than or equal to 0, and at most 100. ignoreEdits Boolean scalar [#ignoreeditsboolean-scalar-2] [`Boolean`](/types/scalars/boolean) Whether to ignore edits made by users. If set to true, the returned holdings will only be based on official registry data, disregarding any edits made by users. name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) Entity name. address [Address!]! deprecated non-null object [#addressaddress-deprecated-non-null-object] [`[Address!]!`](/types/objects/address) Use the `addresses` field instead for a complete list of available addresses. The postal address of the Entity. addresses [Address!]! non-null object [#addressesaddress-non-null-object] [`[Address!]!`](/types/objects/address) The available addresses of the entity. countries [CountryContext!]! non-null object [#countriescountrycontext-non-null-object] [`[CountryContext!]!`](/types/objects/country-context) The countries for the Entity. identifiers [EntityIdentifier!]! non-null object [#identifiersentityidentifier-non-null-object] [`[EntityIdentifier!]!`](/types/objects/entity-identifier) The official identifiers for this Entity. Since an Entity can have several ids (even within the same country), this is a list. relationships EntityConnection! non-null object [#relationshipsentityconnection-non-null-object] [`EntityConnection!`](/types/objects/entity-connection) Related entities (e.g. persons, companies) for this entity. Can be UBOs, board members, etc. kind [EntityRelationshipKind!]! non-null enum [#kindentityrelationshipkind-non-null-enum] [`[EntityRelationshipKind!]!`](/types/enums/entity-relationship-kind) The type of relationships to fetch. If not specified, all relationships will be fetched. Providing an empty list will return all relationship preferCustomRelations Boolean! non-null scalar [#prefercustomrelationsboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether or not to prefer custom relations. If true, only custom relations are returned if any exists. Otherwise, officially registered relations are returned sanctioned Boolean! deprecated non-null scalar [#sanctionedboolean-deprecated-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Use the `sanctionInfo` field instead Whether this entity is sanctioned. sanctionInfo SanctionInfo! non-null object [#sanctioninfosanctioninfo-non-null-object] [`SanctionInfo!`](/types/objects/sanction-info) Sanction information related to this entity. amsCount Int! deprecated non-null scalar [#amscountint-deprecated-non-null-scalar] [`Int!`](/types/scalars/int) Use the `ams` field instead Number of adverse media articles found for this entity. This is an approximation and the actual number may be differ due to clustering of events not performed here. ams [AmsEvent!]! non-null object [#amsamsevent-non-null-object] [`[AmsEvent!]!`](/types/objects/ams-event) Adverse media articles found for this entity. This field replaces the `amsCount` field, which will eventually be deprecated. The `amsCount` field might differ from the actual number returned here, due to different screening solutions being used. pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Used for pagination. Media articles are sorted by the highest relevance first. flags [FlagKind!]! non-null enum [#flagsflagkind-non-null-enum] [`[FlagKind!]!`](/types/enums/flag-kind) Flagged events found for this entity. riskSignals RiskSignals! non-null object [#risksignalsrisksignals-non-null-object] [`RiskSignals!`](/types/objects/risk-signals) Risk signals. Currently there is only one possible risk signal, 'flags', which is created if we find flags of negative severity. Interfaces [#interfaces] EntityLike interface [#entitylike-interface] [`EntityLike`](/types/interfaces/entity-like) An interface type of external business entities. Either a company or a business person. Returned By [#returned-by] [`businessPerson`](/queries/business-person) `query` Member Of [#member-of] [`BusinessPersonSearchConnectionEdge`](/types/objects/business-person-search-connection-edge) `object` [`CustomPersonPayload`](/types/objects/custom-person-payload) `object` Implemented By [#implemented-by] [`ReviewEntity`](/types/unions/review-entity) `union` URL: /connect/docs/types/objects/cancel-form-payload # CancelFormPayload import { Callout } from 'fumadocs-ui/components/callout'; The payload for cancelling a customer facing form. ```graphql type CancelFormPayload { success: Boolean! } ``` Fields [#fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Returned By [#returned-by] [`cancelForm`](/mutations/cancel-form) `mutation` URL: /connect/docs/types/objects/clustered-event # ClusteredEvent import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type ClusteredEvent { id: ID! url: String! } ``` Fields [#fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) url String! non-null scalar [#urlstring-non-null-scalar] [`String!`](/types/scalars/string) Member Of [#member-of] [`AmsEvent`](/types/objects/ams-event) `object` URL: /connect/docs/types/objects/collateral-summary # CollateralSummary import { Callout } from 'fumadocs-ui/components/callout'; A summary of collateral without individual details. ```graphql type CollateralSummary { count: Int! totalAmount: Float! } ``` Fields [#fields] count Int! non-null scalar [#countint-non-null-scalar] [`Int!`](/types/scalars/int) The number of collateral items. totalAmount Float! non-null scalar [#totalamountfloat-non-null-scalar] [`Float!`](/types/scalars/float) The total amount of all collateral. Member Of [#member-of] [`CreditScore`](/types/objects/credit-score) `object` URL: /connect/docs/types/objects/company-bulk-payload-resource # CompanyBulkPayloadResource import { Callout } from 'fumadocs-ui/components/callout'; Response for bulk adding companies to monitoring. ```graphql type CompanyBulkPayloadResource { failed: [CompanyId!]! allSuccessful: Boolean! } ``` Fields [#fields] failed [CompanyId!]! non-null scalar [#failedcompanyid-non-null-scalar] [`[CompanyId!]!`](/types/scalars/company-id) allSuccessful Boolean! non-null scalar [#allsuccessfulboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Returned By [#returned-by] [`companiesAddToMonitoring`](/mutations/companies-add-to-monitoring) `mutation` URL: /connect/docs/types/objects/company-payload # CompanyPayload import { Callout } from 'fumadocs-ui/components/callout'; The payload for a company mutation. ```graphql type CompanyPayload { success: Boolean! company: Company } ``` Fields [#fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) company Company object [#companycompany-object] [`Company`](/types/objects/company) A company resource. Returned By [#returned-by] [`companyAddToMonitoring`](/mutations/company-add-to-monitoring) `mutation` [`companyOwnersUpdate`](/mutations/company-owners-update) `mutation` [`companyRemoveFromMonitoring`](/mutations/company-remove-from-monitoring) `mutation` [`reviewTriggerEventGenerate`](/mutations/review-trigger-event-generate) `mutation` URL: /connect/docs/types/objects/company-pep-change # CompanyPepChange import { Callout } from 'fumadocs-ui/components/callout'; Change in pep screening of a company (i.e. for persons related to the company). ```graphql type CompanyPepChange implements ChangeLike { pepChanges: [PepChange!]! kind: DatasetKind! } ``` Fields [#fields] pepChanges [PepChange!]! non-null object [#pepchangespepchange-non-null-object] [`[PepChange!]!`](/types/objects/pep-change) kind DatasetKind! non-null enum [#kinddatasetkind-non-null-enum] [`DatasetKind!`](/types/enums/dataset-kind) Change kind, determines the data structure of the change. Interfaces [#interfaces] ChangeLike interface [#changelike-interface] [`ChangeLike`](/types/interfaces/change-like) An interface type of monitoring change kinds. URL: /connect/docs/types/objects/company-relations-change # CompanyRelationsChange import { Callout } from 'fumadocs-ui/components/callout'; Change in relations. ```graphql type CompanyRelationsChange implements ChangeLike { roleChange: RoleChange! beneficialOwnerChange: BeneficialOwnerChange! ownershipChange: OwnershipChange! kind: DatasetKind! } ``` Fields [#fields] roleChange RoleChange! non-null object [#rolechangerolechange-non-null-object] [`RoleChange!`](/types/objects/role-change) beneficialOwnerChange BeneficialOwnerChange! non-null object [#beneficialownerchangebeneficialownerchange-non-null-object] [`BeneficialOwnerChange!`](/types/objects/beneficial-owner-change) ownershipChange OwnershipChange! non-null object [#ownershipchangeownershipchange-non-null-object] [`OwnershipChange!`](/types/objects/ownership-change) kind DatasetKind! non-null enum [#kinddatasetkind-non-null-enum] [`DatasetKind!`](/types/enums/dataset-kind) Change kind, determines the data structure of the change. Interfaces [#interfaces] ChangeLike interface [#changelike-interface] [`ChangeLike`](/types/interfaces/change-like) An interface type of monitoring change kinds. URL: /connect/docs/types/objects/company-review-trigger-event # CompanyReviewTriggerEvent import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type CompanyReviewTriggerEvent implements ReviewTriggerEvent { company: CompanyId! relations: EntityConnection! id: ID! triggeredAt: DateTime! statements: [ReviewTriggerStatementKind!]! } ``` Fields [#fields] company CompanyId! non-null scalar [#companycompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) The company for which the review was triggered. relations EntityConnection! non-null object [#relationsentityconnection-non-null-object] [`EntityConnection!`](/types/objects/entity-connection) Related entities relevant for this event. id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) The ID of the review trigger event. triggeredAt DateTime! non-null scalar [#triggeredatdatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) A timestamp of when the review was triggered. statements [ReviewTriggerStatementKind!]! non-null enum [#statementsreviewtriggerstatementkind-non-null-enum] [`[ReviewTriggerStatementKind!]!`](/types/enums/review-trigger-statement-kind) The statements that make up the trigger. These are the things that have changed since the last review was performed. Interfaces [#interfaces] ReviewTriggerEvent interface [#reviewtriggerevent-interface] [`ReviewTriggerEvent`](/types/interfaces/review-trigger-event) Interace for review trigger events. URL: /connect/docs/types/objects/company-sanction-change # CompanySanctionChange import { Callout } from 'fumadocs-ui/components/callout'; Change in sanction screening of a company (i.e. for the company itself and companies and persons related to the company). ```graphql type CompanySanctionChange implements ChangeLike { sanctionChanges: [SanctionChange!]! kind: DatasetKind! } ``` Fields [#fields] sanctionChanges [SanctionChange!]! non-null object [#sanctionchangessanctionchange-non-null-object] [`[SanctionChange!]!`](/types/objects/sanction-change) kind DatasetKind! non-null enum [#kinddatasetkind-non-null-enum] [`DatasetKind!`](/types/enums/dataset-kind) Change kind, determines the data structure of the change. Interfaces [#interfaces] ChangeLike interface [#changelike-interface] [`ChangeLike`](/types/interfaces/change-like) An interface type of monitoring change kinds. URL: /connect/docs/types/objects/company-search-connection-edge # CompanySearchConnectionEdge import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type CompanySearchConnectionEdge { node: Company! searchMatchMetadata: SearchMatchMetadata } ``` Fields [#fields] node Company! non-null object [#nodecompany-non-null-object] [`Company!`](/types/objects/company) searchMatchMetadata SearchMatchMetadata object [#searchmatchmetadatasearchmatchmetadata-object] [`SearchMatchMetadata`](/types/objects/search-match-metadata) Member Of [#member-of] [`CompanySearchConnection`](/types/objects/company-search-connection) `object` URL: /connect/docs/types/objects/company-search-connection # CompanySearchConnection import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type CompanySearchConnection { edges: [CompanySearchConnectionEdge!]! } ``` Fields [#fields] edges [CompanySearchConnectionEdge!]! non-null object [#edgescompanysearchconnectionedge-non-null-object] [`[CompanySearchConnectionEdge!]!`](/types/objects/company-search-connection-edge) Returned By [#returned-by] [`companyIdentifierSearch`](/queries/company-identifier-search) `query` [`companySearch`](/queries/company-search) `query` URL: /connect/docs/types/objects/company # Company import { Callout } from 'fumadocs-ui/components/callout'; A resource representing a registered company. ```graphql type Company implements EntityLike, MonitoredEntityLike { id: CompanyId! industries: [String!]! @deprecated industriesV2: [ConnectIndustryCode!]! inception: DateTime organisationFormCodes: [String!]! businessPurposes: [String!]! signatoryRights: String numberOfEmployees: EmployeeCountInterval status: ConnectCompanyStatus isMonitored: Boolean! isReferenceOnly: Boolean! globalDataSource: GlobalDataSource sourceIdentifier: String tags: [Tag!]! entityPortfolioStatusInfo: EntityPortfolioStatusInfo calculatedRiskLevel: RiskCalculationResult userAssessedRiskLevel: RiskLevelKind automatedRiskLevel: RiskCalculationResult @deprecated shareholderGraph( minimumSharePercentage: Float = 5 ): ShareholderGraph beneficialOwners( ignoreEdits: Boolean = false ): [BeneficialOwner!]! roles( includePrevious: Boolean = false ignoreEdits: Boolean = false ): [Role!]! shareholders( minimumSharePercentage: Float = 0 ignoreEdits: Boolean = false ): [Ownership!]! holdings( minimumSharePercentage: Float = 0 ignoreEdits: Boolean = false ): [Ownership!]! reviews: [Review!]! nextScheduledReviewDate: DateTime documents: [Document!]! creditScore: CreditScore customRiskFields: [EntityCustomRiskField!]! name: String! address: [Address!]! @deprecated addresses: [Address!]! countries: [CountryContext!]! identifiers: [EntityIdentifier!]! relationships( kind: [EntityRelationshipKind!]! preferCustomRelations: Boolean! = false ): EntityConnection! sanctioned: Boolean! @deprecated sanctionInfo: SanctionInfo! amsCount: Int! @deprecated ams( pageInfo: SizePageInfoInput = { size: 20, offset: 0 } ): [AmsEvent!]! flags: [FlagKind!]! riskSignals: RiskSignals! } ``` Fields [#fields] id CompanyId! non-null scalar [#idcompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) industries [String!]! deprecated non-null scalar [#industriesstring-deprecated-non-null-scalar] [`[String!]!`](/types/scalars/string) Use industriesV2 instead industriesV2 [ConnectIndustryCode!]! non-null object [#industriesv2connectindustrycode-non-null-object] [`[ConnectIndustryCode!]!`](/types/objects/connect-industry-code) inception DateTime scalar [#inceptiondatetime-scalar] [`DateTime`](/types/scalars/date-time) organisationFormCodes [String!]! non-null scalar [#organisationformcodesstring-non-null-scalar] [`[String!]!`](/types/scalars/string) businessPurposes [String!]! non-null scalar [#businesspurposesstring-non-null-scalar] [`[String!]!`](/types/scalars/string) signatoryRights String scalar [#signatoryrightsstring-scalar] [`String`](/types/scalars/string) numberOfEmployees EmployeeCountInterval object [#numberofemployeesemployeecountinterval-object] [`EmployeeCountInterval`](/types/objects/employee-count-interval) status ConnectCompanyStatus object [#statusconnectcompanystatus-object] [`ConnectCompanyStatus`](/types/objects/connect-company-status) isMonitored Boolean! non-null scalar [#ismonitoredboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether this company is monitored or not. isReferenceOnly Boolean! non-null scalar [#isreferenceonlyboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Indicates that this company is a reference-only record derived from relationship data. These references are created when a company in a supported market lists a related entity (i.e shareholder, role) from an unsupported jurisdiction. Consequently, the available data is limited to the basic fields provided by the originating market's registry. globalDataSource GlobalDataSource enum [#globaldatasourceglobaldatasource-enum] [`GlobalDataSource`](/types/enums/global-data-source) The global data source for this company (e.g. ORBIS, SAYARI). Null for companies from local registries. sourceIdentifier String scalar [#sourceidentifierstring-scalar] [`String`](/types/scalars/string) The source identifier in the global data source (e.g. BvD ID for Orbis). Null for local registry companies. tags [Tag!]! non-null object [#tagstag-non-null-object] [`[Tag!]!`](/types/objects/tag) Tags added to the company. entityPortfolioStatusInfo EntityPortfolioStatusInfo object [#entityportfoliostatusinfoentityportfoliostatusinfo-object] [`EntityPortfolioStatusInfo`](/types/objects/entity-portfolio-status-info) The entity portfolio status information for the company. calculatedRiskLevel RiskCalculationResult object [#calculatedrisklevelriskcalculationresult-object] [`RiskCalculationResult`](/types/objects/risk-calculation-result) Calculated risk level for the company. Based on team settings. userAssessedRiskLevel RiskLevelKind enum [#userassessedrisklevelrisklevelkind-enum] [`RiskLevelKind`](/types/enums/risk-level-kind) User-assessed risk level for the company. Determined by the user during the review process. automatedRiskLevel RiskCalculationResult deprecated object [#automatedrisklevelriskcalculationresult-deprecated-object] [`RiskCalculationResult`](/types/objects/risk-calculation-result) Use 'calculatedRiskLevel' instead. Calculated risk level for the company. Based on team settings shareholderGraph ShareholderGraph object [#shareholdergraphshareholdergraph-object] [`ShareholderGraph`](/types/objects/shareholder-graph) The company's shareholder graph minimumSharePercentage Float scalar [#minimumsharepercentagefloat-scalar] [`Float`](/types/scalars/float) The minimum amount of shares a shareholder must own to be included in the graph. Beneficial owner nodes are included regardless of their share. In addition, nodes that are part of the path between an included node and the root node are included. Must be greater than or equal to 5, and at most 100. beneficialOwners [BeneficialOwner!]! non-null object [#beneficialownersbeneficialowner-non-null-object] [`[BeneficialOwner!]!`](/types/objects/beneficial-owner) The company's beneficial owners ignoreEdits Boolean scalar [#ignoreeditsboolean-scalar] [`Boolean`](/types/scalars/boolean) Whether to ignore edits made by users. If set to true, the returned beneficial owners will only be based on official registry data, disregarding any edits made by users. roles [Role!]! non-null object [#rolesrole-non-null-object] [`[Role!]!`](/types/objects/role) The company's roles includePrevious Boolean scalar [#includepreviousboolean-scalar] [`Boolean`](/types/scalars/boolean) Whether to include previous roles, i.e., roles which have been terminated. ignoreEdits Boolean scalar [#ignoreeditsboolean-scalar-1] [`Boolean`](/types/scalars/boolean) Whether to ignore edits made by users. If set to true, the returned roles will only be based on official registry data, disregarding any edits made by users. shareholders [Ownership!]! non-null object [#shareholdersownership-non-null-object] [`[Ownership!]!`](/types/objects/ownership) The company's direct shareholders. minimumSharePercentage Float scalar [#minimumsharepercentagefloat-scalar-1] [`Float`](/types/scalars/float) The lower bound of the share percentage range to include in the result. Must be greater than or equal to 0, and at most 100. ignoreEdits Boolean scalar [#ignoreeditsboolean-scalar-2] [`Boolean`](/types/scalars/boolean) Whether to ignore edits made by users. If set to true, the returned shareholders will only be based on official registry data, disregarding any edits made by users. holdings [Ownership!]! non-null object [#holdingsownership-non-null-object] [`[Ownership!]!`](/types/objects/ownership) The company's direct holdings, i.e., companies owned by this company. minimumSharePercentage Float scalar [#minimumsharepercentagefloat-scalar-2] [`Float`](/types/scalars/float) The lower bound of the share percentage range to include in the result. Must be greater than or equal to 0, and at most 100. ignoreEdits Boolean scalar [#ignoreeditsboolean-scalar-3] [`Boolean`](/types/scalars/boolean) Whether to ignore edits made by users. If set to true, the returned holdings will only be based on official registry data, disregarding any edits made by users. reviews [Review!]! non-null object [#reviewsreview-non-null-object] [`[Review!]!`](/types/objects/review) Reviews created on this company. nextScheduledReviewDate DateTime scalar [#nextscheduledreviewdatedatetime-scalar] [`DateTime`](/types/scalars/date-time) The date of the next scheduled review, based on the latest review user-assessed risk. documents [Document!]! non-null object [#documentsdocument-non-null-object] [`[Document!]!`](/types/objects/document) List documents and document orders in progress related to the company. creditScore CreditScore object [#creditscorecreditscore-object] [`CreditScore`](/types/objects/credit-score) The company's credit score data from the most recent credit report. Returns null if no credit report has been ordered for this company. customRiskFields [EntityCustomRiskField!]! non-null object [#customriskfieldsentitycustomriskfield-non-null-object] [`[EntityCustomRiskField!]!`](/types/objects/entity-custom-risk-field) Custom risk field values assigned to this company. name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) Entity name. address [Address!]! deprecated non-null object [#addressaddress-deprecated-non-null-object] [`[Address!]!`](/types/objects/address) Use the `addresses` field instead for a complete list of available addresses. The postal address of the Entity. addresses [Address!]! non-null object [#addressesaddress-non-null-object] [`[Address!]!`](/types/objects/address) The available addresses of the entity. countries [CountryContext!]! non-null object [#countriescountrycontext-non-null-object] [`[CountryContext!]!`](/types/objects/country-context) The countries for the Entity. identifiers [EntityIdentifier!]! non-null object [#identifiersentityidentifier-non-null-object] [`[EntityIdentifier!]!`](/types/objects/entity-identifier) The official identifiers for this Entity. Since an Entity can have several ids (even within the same country), this is a list. relationships EntityConnection! non-null object [#relationshipsentityconnection-non-null-object] [`EntityConnection!`](/types/objects/entity-connection) Related entities (e.g. persons, companies) for this entity. Can be UBOs, board members, etc. kind [EntityRelationshipKind!]! non-null enum [#kindentityrelationshipkind-non-null-enum] [`[EntityRelationshipKind!]!`](/types/enums/entity-relationship-kind) The type of relationships to fetch. If not specified, all relationships will be fetched. Providing an empty list will return all relationship preferCustomRelations Boolean! non-null scalar [#prefercustomrelationsboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether or not to prefer custom relations. If true, only custom relations are returned if any exists. Otherwise, officially registered relations are returned sanctioned Boolean! deprecated non-null scalar [#sanctionedboolean-deprecated-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Use the `sanctionInfo` field instead Whether this entity is sanctioned. sanctionInfo SanctionInfo! non-null object [#sanctioninfosanctioninfo-non-null-object] [`SanctionInfo!`](/types/objects/sanction-info) Sanction information related to this entity. amsCount Int! deprecated non-null scalar [#amscountint-deprecated-non-null-scalar] [`Int!`](/types/scalars/int) Use the `ams` field instead Number of adverse media articles found for this entity. This is an approximation and the actual number may be differ due to clustering of events not performed here. ams [AmsEvent!]! non-null object [#amsamsevent-non-null-object] [`[AmsEvent!]!`](/types/objects/ams-event) Adverse media articles found for this entity. This field replaces the `amsCount` field, which will eventually be deprecated. The `amsCount` field might differ from the actual number returned here, due to different screening solutions being used. pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Used for pagination. Media articles are sorted by the highest relevance first. flags [FlagKind!]! non-null enum [#flagsflagkind-non-null-enum] [`[FlagKind!]!`](/types/enums/flag-kind) Flagged events found for this entity. riskSignals RiskSignals! non-null object [#risksignalsrisksignals-non-null-object] [`RiskSignals!`](/types/objects/risk-signals) Risk signals. Currently there is only one possible risk signal, 'flags', which is created if we find flags of negative severity. Interfaces [#interfaces] EntityLike interface [#entitylike-interface] [`EntityLike`](/types/interfaces/entity-like) An interface type of external business entities. Either a company or a business person. MonitoredEntityLike interface [#monitoredentitylike-interface] [`MonitoredEntityLike`](/types/interfaces/monitored-entity-like) An interface type of external business entities that can be monitored. Returned By [#returned-by] [`company`](/queries/company) `query` Member Of [#member-of] [`CompanyPayload`](/types/objects/company-payload) `object` [`CompanySearchConnectionEdge`](/types/objects/company-search-connection-edge) `object` [`ConnectPortfolioCompanyEdge`](/types/objects/connect-portfolio-company-edge) `object` [`CreditReportPayload`](/types/objects/credit-report-payload) `object` [`CustomCompanyPayload`](/types/objects/custom-company-payload) `object` [`GlobalCompanyPayload`](/types/objects/global-company-payload) `object` Implemented By [#implemented-by] [`ReviewEntity`](/types/unions/review-entity) `union` URL: /connect/docs/types/objects/connect-company-status # ConnectCompanyStatus import { Callout } from 'fumadocs-ui/components/callout'; Describes the status of a company, i.e., whether the company is active, dissolved, etc. ```graphql type ConnectCompanyStatus { name: String! date: DateTime isActive: Boolean! } ``` Fields [#fields] name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) The name of the status. date DateTime scalar [#datedatetime-scalar] [`DateTime`](/types/scalars/date-time) The date on which the status was set. isActive Boolean! non-null scalar [#isactiveboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Indicates whether the company status represents an active/operating company. Member Of [#member-of] [`Company`](/types/objects/company) `object` URL: /connect/docs/types/objects/connect-industry-code # ConnectIndustryCode import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type ConnectIndustryCode { code: String! description: String codeType: IndustryCodeType! } ``` Fields [#fields] code String! non-null scalar [#codestring-non-null-scalar] [`String!`](/types/scalars/string) description String scalar [#descriptionstring-scalar] [`String`](/types/scalars/string) codeType IndustryCodeType! non-null enum [#codetypeindustrycodetype-non-null-enum] [`IndustryCodeType!`](/types/enums/industry-code-type) Member Of [#member-of] [`Company`](/types/objects/company) `object` URL: /connect/docs/types/objects/connect-portfolio-companies-connection # ConnectPortfolioCompaniesConnection import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type ConnectPortfolioCompaniesConnection { edges: [ConnectPortfolioCompanyEdge!]! pageInfo: PageInfo } ``` Fields [#fields] edges [ConnectPortfolioCompanyEdge!]! non-null object [#edgesconnectportfoliocompanyedge-non-null-object] [`[ConnectPortfolioCompanyEdge!]!`](/types/objects/connect-portfolio-company-edge) pageInfo PageInfo object [#pageinfopageinfo-object] [`PageInfo`](/types/objects/page-info) Will contain a value for paginated searches Returned By [#returned-by] [`portfolioCompanies`](/queries/portfolio-companies) `query` URL: /connect/docs/types/objects/connect-portfolio-company-edge # ConnectPortfolioCompanyEdge import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type ConnectPortfolioCompanyEdge { node: Company! } ``` Fields [#fields] node Company! non-null object [#nodecompany-non-null-object] [`Company!`](/types/objects/company) Member Of [#member-of] [`ConnectPortfolioCompaniesConnection`](/types/objects/connect-portfolio-companies-connection) `object` URL: /connect/docs/types/objects/connect-private-person-registry-search-resource # ConnectPrivatePersonRegistrySearchResource import { Callout } from 'fumadocs-ui/components/callout'; A private person search result from a registry. ```graphql type ConnectPrivatePersonRegistrySearchResource { identifier: EntityIdentifier name: String! gender: Gender birthDate: Date birthYear: Year address: [Address!]! citizenship: [Country!]! } ``` Fields [#fields] identifier EntityIdentifier object [#identifierentityidentifier-object] [`EntityIdentifier`](/types/objects/entity-identifier) name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) Person name. gender Gender enum [#gendergender-enum] [`Gender`](/types/enums/gender) The gender of the person. birthDate Date scalar [#birthdatedate-scalar] [`Date`](/types/scalars/date) The birth date of the person. birthYear Year scalar [#birthyearyear-scalar] [`Year`](/types/scalars/year) The birth year of the person. address [Address!]! non-null object [#addressaddress-non-null-object] [`[Address!]!`](/types/objects/address) citizenship [Country!]! non-null object [#citizenshipcountry-non-null-object] [`[Country!]!`](/types/objects/country) Returned By [#returned-by] [`privatePersonRegistrySearch`](/queries/private-person-registry-search) `query` URL: /connect/docs/types/objects/country-context # CountryContext import { Callout } from 'fumadocs-ui/components/callout'; Used to define an entity's relationship to a country. Such as a Company's country of residence, a PrivatePerson's citizenship, or a CustomBusinessPerson's nationality. ```graphql type CountryContext { relationship: CountryRelationship! country: Country! } ``` Fields [#fields] relationship CountryRelationship! non-null enum [#relationshipcountryrelationship-non-null-enum] [`CountryRelationship!`](/types/enums/country-relationship) country Country! non-null object [#countrycountry-non-null-object] [`Country!`](/types/objects/country) Member Of [#member-of] [`BusinessPerson`](/types/objects/business-person) `object` [`Company`](/types/objects/company) `object` [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` [`EntityLike`](/types/interfaces/entity-like) `interface` [`MonitoredEntityLike`](/types/interfaces/monitored-entity-like) `interface` [`PrivatePerson`](/types/objects/private-person) `object` URL: /connect/docs/types/objects/country # Country import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type Country { code: CountryCode! name: String! } ``` Fields [#fields] code CountryCode! non-null scalar [#codecountrycode-non-null-scalar] [`CountryCode!`](/types/scalars/country-code) name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) Member Of [#member-of] [`Address`](/types/objects/address) `object` [`ConnectPrivatePersonRegistrySearchResource`](/types/objects/connect-private-person-registry-search-resource) `object` [`CountryContext`](/types/objects/country-context) `object` [`PepHit`](/types/objects/pep-hit) `object` URL: /connect/docs/types/objects/create-form-url-payload # CreateFormUrlPayload import { Callout } from 'fumadocs-ui/components/callout'; The payload for creating a new URL for a customer facing form. ```graphql type CreateFormUrlPayload { success: Boolean! url: String } ``` Fields [#fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) url String scalar [#urlstring-scalar] [`String`](/types/scalars/string) The newly created URL for the form. Returned By [#returned-by] [`createFormUrl`](/mutations/create-form-url) `mutation` URL: /connect/docs/types/objects/credit-report-payload # CreditReportPayload import { Callout } from 'fumadocs-ui/components/callout'; The payload for ordering a credit report. ```graphql type CreditReportPayload { success: Boolean! company: Company creditScore: CreditScore } ``` Fields [#fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether the credit report was successfully ordered. company Company object [#companycompany-object] [`Company`](/types/objects/company) The company for which the credit report was ordered. creditScore CreditScore object [#creditscorecreditscore-object] [`CreditScore`](/types/objects/credit-score) The credit score data. Returned By [#returned-by] [`companyCreditReportOrder`](/mutations/company-credit-report-order) `mutation` URL: /connect/docs/types/objects/credit-score # CreditScore import { Callout } from 'fumadocs-ui/components/callout'; Credit score data for a company. ```graphql type CreditScore { reportDate: DateTime! creditLimit: Float creditRating: Int rating: CreditRating! ratingDescription: String! hasPaymentRemarks: Boolean! remarks: PaymentRemarksSummary! partiallySettledRemarks: PaymentRemarksSummary! voluntaryCollateral: CollateralSummary! currencyCode: String scoreUnavailableReason: String } ``` Fields [#fields] reportDate DateTime! non-null scalar [#reportdatedatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) The date when the credit report was ordered. creditLimit Float scalar [#creditlimitfloat-scalar] [`Float`](/types/scalars/float) The company's credit limit. creditRating Int scalar [#creditratingint-scalar] [`Int`](/types/scalars/int) The numerical credit score/rating value. rating CreditRating! non-null enum [#ratingcreditrating-non-null-enum] [`CreditRating!`](/types/enums/credit-rating) The international credit rating (A-E). ratingDescription String! non-null scalar [#ratingdescriptionstring-non-null-scalar] [`String!`](/types/scalars/string) Description of the rating. hasPaymentRemarks Boolean! non-null scalar [#haspaymentremarksboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether the company has any payment remarks. remarks PaymentRemarksSummary! non-null object [#remarkspaymentremarkssummary-non-null-object] [`PaymentRemarksSummary!`](/types/objects/payment-remarks-summary) Summary of unsettled payment remarks. partiallySettledRemarks PaymentRemarksSummary! non-null object [#partiallysettledremarkspaymentremarkssummary-non-null-object] [`PaymentRemarksSummary!`](/types/objects/payment-remarks-summary) Summary of partially settled payment remarks. voluntaryCollateral CollateralSummary! non-null object [#voluntarycollateralcollateralsummary-non-null-object] [`CollateralSummary!`](/types/objects/collateral-summary) Summary of voluntary collateral. currencyCode String scalar [#currencycodestring-scalar] [`String`](/types/scalars/string) Currency code for monetary values in this report. scoreUnavailableReason String scalar [#scoreunavailablereasonstring-scalar] [`String`](/types/scalars/string) Reason why the credit score is unavailable, if applicable. Only present when the company could not be scored. Member Of [#member-of] [`Company`](/types/objects/company) `object` [`CreditReportPayload`](/types/objects/credit-report-payload) `object` URL: /connect/docs/types/objects/custom-business-person # CustomBusinessPerson import { Callout } from 'fumadocs-ui/components/callout'; A resource representing a user generated custom business person. ```graphql type CustomBusinessPerson implements EntityLike { id: CustomBusinessPersonId! birthDate: Date birthYear: Year pep: Boolean! @deprecated pepInfo: PepInfo! name: String! address: [Address!]! @deprecated addresses: [Address!]! countries: [CountryContext!]! identifiers: [EntityIdentifier!]! relationships( kind: [EntityRelationshipKind!]! preferCustomRelations: Boolean! = false ): EntityConnection! sanctioned: Boolean! @deprecated sanctionInfo: SanctionInfo! amsCount: Int! @deprecated ams( pageInfo: SizePageInfoInput = { size: 20, offset: 0 } ): [AmsEvent!]! flags: [FlagKind!]! riskSignals: RiskSignals! } ``` Fields [#fields] id CustomBusinessPersonId! non-null scalar [#idcustombusinesspersonid-non-null-scalar] [`CustomBusinessPersonId!`](/types/scalars/custom-business-person-id) birthDate Date scalar [#birthdatedate-scalar] [`Date`](/types/scalars/date) birthYear Year scalar [#birthyearyear-scalar] [`Year`](/types/scalars/year) pep Boolean! deprecated non-null scalar [#pepboolean-deprecated-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Use the `pepInfo` field instead. pepInfo PepInfo! non-null object [#pepinfopepinfo-non-null-object] [`PepInfo!`](/types/objects/pep-info) PEP information. name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) Entity name. address [Address!]! deprecated non-null object [#addressaddress-deprecated-non-null-object] [`[Address!]!`](/types/objects/address) Use the `addresses` field instead for a complete list of available addresses. The postal address of the Entity. addresses [Address!]! non-null object [#addressesaddress-non-null-object] [`[Address!]!`](/types/objects/address) The available addresses of the entity. countries [CountryContext!]! non-null object [#countriescountrycontext-non-null-object] [`[CountryContext!]!`](/types/objects/country-context) The countries for the Entity. identifiers [EntityIdentifier!]! non-null object [#identifiersentityidentifier-non-null-object] [`[EntityIdentifier!]!`](/types/objects/entity-identifier) The official identifiers for this Entity. Since an Entity can have several ids (even within the same country), this is a list. relationships EntityConnection! non-null object [#relationshipsentityconnection-non-null-object] [`EntityConnection!`](/types/objects/entity-connection) Related entities (e.g. persons, companies) for this entity. Can be UBOs, board members, etc. kind [EntityRelationshipKind!]! non-null enum [#kindentityrelationshipkind-non-null-enum] [`[EntityRelationshipKind!]!`](/types/enums/entity-relationship-kind) The type of relationships to fetch. If not specified, all relationships will be fetched. Providing an empty list will return all relationship preferCustomRelations Boolean! non-null scalar [#prefercustomrelationsboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether or not to prefer custom relations. If true, only custom relations are returned if any exists. Otherwise, officially registered relations are returned sanctioned Boolean! deprecated non-null scalar [#sanctionedboolean-deprecated-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Use the `sanctionInfo` field instead Whether this entity is sanctioned. sanctionInfo SanctionInfo! non-null object [#sanctioninfosanctioninfo-non-null-object] [`SanctionInfo!`](/types/objects/sanction-info) Sanction information related to this entity. amsCount Int! deprecated non-null scalar [#amscountint-deprecated-non-null-scalar] [`Int!`](/types/scalars/int) Use the `ams` field instead Number of adverse media articles found for this entity. This is an approximation and the actual number may be differ due to clustering of events not performed here. ams [AmsEvent!]! non-null object [#amsamsevent-non-null-object] [`[AmsEvent!]!`](/types/objects/ams-event) Adverse media articles found for this entity. This field replaces the `amsCount` field, which will eventually be deprecated. The `amsCount` field might differ from the actual number returned here, due to different screening solutions being used. pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Used for pagination. Media articles are sorted by the highest relevance first. flags [FlagKind!]! non-null enum [#flagsflagkind-non-null-enum] [`[FlagKind!]!`](/types/enums/flag-kind) Flagged events found for this entity. riskSignals RiskSignals! non-null object [#risksignalsrisksignals-non-null-object] [`RiskSignals!`](/types/objects/risk-signals) Risk signals. Currently there is only one possible risk signal, 'flags', which is created if we find flags of negative severity. Interfaces [#interfaces] EntityLike interface [#entitylike-interface] [`EntityLike`](/types/interfaces/entity-like) An interface type of external business entities. Either a company or a business person. Returned By [#returned-by] [`customBusinessPerson`](/queries/custom-business-person) `query` Implemented By [#implemented-by] [`ReviewEntity`](/types/unions/review-entity) `union` URL: /connect/docs/types/objects/custom-company-payload # CustomCompanyPayload import { Callout } from 'fumadocs-ui/components/callout'; The payload for a custom company mutation. ```graphql type CustomCompanyPayload { success: Boolean! company: Company } ``` Fields [#fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) company Company object [#companycompany-object] [`Company`](/types/objects/company) A company resource. Returned By [#returned-by] [`customCompanyCreate`](/mutations/custom-company-create) `mutation` [`customCompanyDelete`](/mutations/custom-company-delete) `mutation` [`customCompanyUpdate`](/mutations/custom-company-update) `mutation` URL: /connect/docs/types/objects/custom-person-payload # CustomPersonPayload import { Callout } from 'fumadocs-ui/components/callout'; The payload for a custom person mutation. ```graphql type CustomPersonPayload { success: Boolean! person: BusinessPerson } ``` Fields [#fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) person BusinessPerson object [#personbusinessperson-object] [`BusinessPerson`](/types/objects/business-person) A person resource. Returned By [#returned-by] [`customPersonCreate`](/mutations/custom-person-create) `mutation` [`customPersonDelete`](/mutations/custom-person-delete) `mutation` [`customPersonEdit`](/mutations/custom-person-edit) `mutation` URL: /connect/docs/types/objects/custom-risk-field-option # CustomRiskFieldOption import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type CustomRiskFieldOption { id: ID! name: String! } ``` Fields [#fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) Member Of [#member-of] [`CustomRiskField`](/types/objects/custom-risk-field) `object` [`EntityCustomRiskField`](/types/objects/entity-custom-risk-field) `object` URL: /connect/docs/types/objects/custom-risk-field-score # CustomRiskFieldScore import { Callout } from 'fumadocs-ui/components/callout'; Risk score result for a specific custom risk field ```graphql type CustomRiskFieldScore { customRiskFieldId: ID! scoreResult: RiskScoreResult! } ``` Fields [#fields] customRiskFieldId ID! non-null scalar [#customriskfieldidid-non-null-scalar] [`ID!`](/types/scalars/id) scoreResult RiskScoreResult! non-null object [#scoreresultriskscoreresult-non-null-object] [`RiskScoreResult!`](/types/objects/risk-score-result) Member Of [#member-of] [`RiskCalculationResult`](/types/objects/risk-calculation-result) `object` URL: /connect/docs/types/objects/custom-risk-field # CustomRiskField import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type CustomRiskField { id: ID! name: String! kind: CustomRiskFieldKind! options: [CustomRiskFieldOption!]! } ``` Fields [#fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) kind CustomRiskFieldKind! non-null enum [#kindcustomriskfieldkind-non-null-enum] [`CustomRiskFieldKind!`](/types/enums/custom-risk-field-kind) options [CustomRiskFieldOption!]! non-null object [#optionscustomriskfieldoption-non-null-object] [`[CustomRiskFieldOption!]!`](/types/objects/custom-risk-field-option) Returned By [#returned-by] [`customRiskFields`](/queries/custom-risk-fields) `query` Member Of [#member-of] [`EntityCustomRiskField`](/types/objects/entity-custom-risk-field) `object` URL: /connect/docs/types/objects/document # Document import { Callout } from 'fumadocs-ui/components/callout'; An object representing a document related to a company. ```graphql type Document { id: ID! fileName: String! contentType: String size: Long lastModifiedAt: ISODateTime downloadUrl: String source: DocumentSource! status: DocumentStatus! } ``` Fields [#fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) Unique identifier for the document. fileName String! non-null scalar [#filenamestring-non-null-scalar] [`String!`](/types/scalars/string) The file name of the document. contentType String scalar [#contenttypestring-scalar] [`String`](/types/scalars/string) The file's content type. size Long scalar [#sizelong-scalar] [`Long`](/types/scalars/long) The file size, given in bytes. lastModifiedAt ISODateTime scalar [#lastmodifiedatisodatetime-scalar] [`ISODateTime`](/types/scalars/isodate-time) The date and time the document was last modified. downloadUrl String scalar [#downloadurlstring-scalar] [`String`](/types/scalars/string) The URL where the document can be downloaded. source DocumentSource! non-null enum [#sourcedocumentsource-non-null-enum] [`DocumentSource!`](/types/enums/document-source) The source of the document. status DocumentStatus! non-null enum [#statusdocumentstatus-non-null-enum] [`DocumentStatus!`](/types/enums/document-status) The status of the document upload. Returned By [#returned-by] [`document`](/queries/document) `query` Member Of [#member-of] [`Company`](/types/objects/company) `object` URL: /connect/docs/types/objects/edit-metadata # EditMetadata import { Callout } from 'fumadocs-ui/components/callout'; Metadata about an edit on a data field. ```graphql type EditMetadata { editKind: EditKind! updatedAt: DateTime! editedBy: SimpleUser comment: String } ``` Fields [#fields] editKind EditKind! non-null enum [#editkindeditkind-non-null-enum] [`EditKind!`](/types/enums/edit-kind) The type of the edit. updatedAt DateTime! non-null scalar [#updatedatdatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) The timestamp of when the edit was last updated. editedBy SimpleUser object [#editedbysimpleuser-object] [`SimpleUser`](/types/objects/simple-user) The user which made the edit. comment String scalar [#commentstring-scalar] [`String`](/types/scalars/string) The comment associated with the edit, if it exists. Member Of [#member-of] [`BeneficialOwner`](/types/objects/beneficial-owner) `object` [`Ownership`](/types/objects/ownership) `object` URL: /connect/docs/types/objects/employee-count-interval # EmployeeCountInterval import { Callout } from 'fumadocs-ui/components/callout'; An interval representing the number of employees a company has. ```graphql type EmployeeCountInterval { from: Int! to: Int! } ``` Fields [#fields] from Int! non-null scalar [#fromint-non-null-scalar] [`Int!`](/types/scalars/int) The lower bound of the interval. to Int! non-null scalar [#toint-non-null-scalar] [`Int!`](/types/scalars/int) The upper bound of the interval. Member Of [#member-of] [`Company`](/types/objects/company) `object` URL: /connect/docs/types/objects/entity-connection-edge # EntityConnectionEdge import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type EntityConnectionEdge { kind: EntityRelationshipKind! explanation: String! custom: Boolean! node: EntityLike! details: RelationshipDetails } ``` Fields [#fields] kind EntityRelationshipKind! non-null enum [#kindentityrelationshipkind-non-null-enum] [`EntityRelationshipKind!`](/types/enums/entity-relationship-kind) The kind of relationship between the entities. explanation String! non-null scalar [#explanationstring-non-null-scalar] [`String!`](/types/scalars/string) Details for the relationship. custom Boolean! non-null scalar [#customboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether this is a custom relation node EntityLike! non-null interface [#nodeentitylike-non-null-interface] [`EntityLike!`](/types/interfaces/entity-like) Related entity details RelationshipDetails union [#detailsrelationshipdetails-union] [`RelationshipDetails`](/types/unions/relationship-details) Member Of [#member-of] [`EntityConnection`](/types/objects/entity-connection) `object` URL: /connect/docs/types/objects/entity-connection # EntityConnection import { Callout } from 'fumadocs-ui/components/callout'; Represents connections to other entities: (queriedEntity)-\[edges\[0]]->(someEntity), (queriedEntity)-\[edges\[1]]->(someOtherEntity), etc. ```graphql type EntityConnection { edges: [EntityConnectionEdge!]! } ``` Fields [#fields] edges [EntityConnectionEdge!]! non-null object [#edgesentityconnectionedge-non-null-object] [`[EntityConnectionEdge!]!`](/types/objects/entity-connection-edge) Member Of [#member-of] [`BusinessPerson`](/types/objects/business-person) `object` [`Company`](/types/objects/company) `object` [`CompanyReviewTriggerEvent`](/types/objects/company-review-trigger-event) `object` [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` [`EntityLike`](/types/interfaces/entity-like) `interface` [`PrivatePerson`](/types/objects/private-person) `object` [`ReviewContext`](/types/objects/review-context) `object` URL: /connect/docs/types/objects/entity-custom-risk-field # EntityCustomRiskField import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type EntityCustomRiskField { riskField: CustomRiskField! selectedOptions: [CustomRiskFieldOption!]! } ``` Fields [#fields] riskField CustomRiskField! non-null object [#riskfieldcustomriskfield-non-null-object] [`CustomRiskField!`](/types/objects/custom-risk-field) selectedOptions [CustomRiskFieldOption!]! non-null object [#selectedoptionscustomriskfieldoption-non-null-object] [`[CustomRiskFieldOption!]!`](/types/objects/custom-risk-field-option) Returned By [#returned-by] [`entityUpdateCustomRiskField`](/mutations/entity-update-custom-risk-field) `mutation` Member Of [#member-of] [`Company`](/types/objects/company) `object` [`PrivatePerson`](/types/objects/private-person) `object` URL: /connect/docs/types/objects/entity-identifier # EntityIdentifier import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type EntityIdentifier { value: String! country: CountryCode kind: EntityIdentifierKind! description: String } ``` Fields [#fields] value String! non-null scalar [#valuestring-non-null-scalar] [`String!`](/types/scalars/string) country CountryCode scalar [#countrycountrycode-scalar] [`CountryCode`](/types/scalars/country-code) The country of the register from which this identifier was issued. kind EntityIdentifierKind! non-null enum [#kindentityidentifierkind-non-null-enum] [`EntityIdentifierKind!`](/types/enums/entity-identifier-kind) The identifiers kind. description String scalar [#descriptionstring-scalar] [`String`](/types/scalars/string) The identifiers description. Member Of [#member-of] [`BusinessPerson`](/types/objects/business-person) `object` [`Company`](/types/objects/company) `object` [`ConnectPrivatePersonRegistrySearchResource`](/types/objects/connect-private-person-registry-search-resource) `object` [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` [`EntityLike`](/types/interfaces/entity-like) `interface` [`MonitoredEntityLike`](/types/interfaces/monitored-entity-like) `interface` [`PrivatePerson`](/types/objects/private-person) `object` URL: /connect/docs/types/objects/entity-portfolio-status-info # EntityPortfolioStatusInfo import { Callout } from 'fumadocs-ui/components/callout'; Describes an entity's portfolio status ```graphql type EntityPortfolioStatusInfo { status: EntityPortfolioStatus! previousStatus: EntityPortfolioStatus modifiedAt: DateTime! } ``` Fields [#fields] status EntityPortfolioStatus! non-null enum [#statusentityportfoliostatus-non-null-enum] [`EntityPortfolioStatus!`](/types/enums/entity-portfolio-status) The current status of the entity. previousStatus EntityPortfolioStatus enum [#previousstatusentityportfoliostatus-enum] [`EntityPortfolioStatus`](/types/enums/entity-portfolio-status) The previous status of the entity, if any. modifiedAt DateTime! non-null scalar [#modifiedatdatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) The date and time when the status was last modified. Member Of [#member-of] [`Company`](/types/objects/company) `object` [`PrivatePerson`](/types/objects/private-person) `object` URL: /connect/docs/types/objects/form # Form import { Callout } from 'fumadocs-ui/components/callout'; A form which can be sent out for a person to fill out. ```graphql type Form { id: ID! title: String! description: String } ``` Fields [#fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) title String! non-null scalar [#titlestring-non-null-scalar] [`String!`](/types/scalars/string) description String scalar [#descriptionstring-scalar] [`String`](/types/scalars/string) Returned By [#returned-by] [`listForms`](/queries/list-forms) `query` URL: /connect/docs/types/objects/global-company-payload # GlobalCompanyPayload import { Callout } from 'fumadocs-ui/components/callout'; The payload for creating a company from a global entity source. ```graphql type GlobalCompanyPayload { success: Boolean! company: Company } ``` Fields [#fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) company Company object [#companycompany-object] [`Company`](/types/objects/company) The created company resource. Returned By [#returned-by] [`companyEnrichGlobalEntity`](/mutations/company-enrich-global-entity) `mutation` URL: /connect/docs/types/objects/monitoring-change # MonitoringChange import { Callout } from 'fumadocs-ui/components/callout'; The data change that triggered an alert. ```graphql type MonitoringChange { monitoredEntityId: ID! monitoredEntity: MonitoredEntityLike kind: DatasetKind! computedAt: DateTime! change: ChangeLike! } ``` Fields [#fields] monitoredEntityId ID! non-null scalar [#monitoredentityidid-non-null-scalar] [`ID!`](/types/scalars/id) The ID of the monitored entity. Always present even if the entity itself has been deleted. monitoredEntity MonitoredEntityLike interface [#monitoredentitymonitoredentitylike-interface] [`MonitoredEntityLike`](/types/interfaces/monitored-entity-like) kind DatasetKind! non-null enum [#kinddatasetkind-non-null-enum] [`DatasetKind!`](/types/enums/dataset-kind) The type of change. Determines which 'xChanges' fields are populated with data. computedAt DateTime! non-null scalar [#computedatdatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) The time at which the change was seen (when the difference was computed). change ChangeLike! non-null interface [#changechangelike-non-null-interface] [`ChangeLike!`](/types/interfaces/change-like) The change data, whose structure is defined by 'kind'. Returned By [#returned-by] [`alertData`](/queries/alert-data) `query` URL: /connect/docs/types/objects/ownership-change # OwnershipChange import { Callout } from 'fumadocs-ui/components/callout'; Change in ownership. ```graphql type OwnershipChange { toValue: [Ownership!]! fromValue: [Ownership!]! } ``` Fields [#fields] toValue [Ownership!]! non-null object [#tovalueownership-non-null-object] [`[Ownership!]!`](/types/objects/ownership) fromValue [Ownership!]! non-null object [#fromvalueownership-non-null-object] [`[Ownership!]!`](/types/objects/ownership) Member Of [#member-of] [`CompanyRelationsChange`](/types/objects/company-relations-change) `object` URL: /connect/docs/types/objects/ownership-relation-details # OwnershipRelationDetails import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type OwnershipRelationDetails { share: Float } ``` Fields [#fields] share Float scalar [#sharefloat-scalar] [`Float`](/types/scalars/float) Implemented By [#implemented-by] [`RelationshipDetails`](/types/unions/relationship-details) `union` URL: /connect/docs/types/objects/ownership # Ownership import { Callout } from 'fumadocs-ui/components/callout'; An object representing an ownership relationship. ```graphql type Ownership { shareClasses: [ShareClass!]! totalSharePercentage: SharePercentageInterval! editMetadata: EditMetadata entity: EntityLike! } ``` Fields [#fields] shareClasses [ShareClass!]! non-null object [#shareclassesshareclass-non-null-object] [`[ShareClass!]!`](/types/objects/share-class) The list of share classes with their associated share percentages. totalSharePercentage SharePercentageInterval! non-null object [#totalsharepercentagesharepercentageinterval-non-null-object] [`SharePercentageInterval!`](/types/objects/share-percentage-interval) The total direct share percentage, i.e., the sum of all shares in `shareClasses`. editMetadata EditMetadata object [#editmetadataeditmetadata-object] [`EditMetadata`](/types/objects/edit-metadata) Metadata about edits made to this ownership relationship. entity EntityLike! non-null interface [#entityentitylike-non-null-interface] [`EntityLike!`](/types/interfaces/entity-like) The entity involved in the ownership relationship. This can be either a shareholder (company or person) or an asset company, depending on the context in which the field is accessed. Member Of [#member-of] [`BusinessPerson`](/types/objects/business-person) `object` [`Company`](/types/objects/company) `object` [`OwnershipChange`](/types/objects/ownership-change) `object` URL: /connect/docs/types/objects/page-info # PageInfo import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type PageInfo { size: Int! offset: Int! totalSize: Int! nextPageOffset: Int! } ``` Fields [#fields] size Int! non-null scalar [#sizeint-non-null-scalar] [`Int!`](/types/scalars/int) The page size offset Int! non-null scalar [#offsetint-non-null-scalar] [`Int!`](/types/scalars/int) The page offset totalSize Int! non-null scalar [#totalsizeint-non-null-scalar] [`Int!`](/types/scalars/int) The total number of elements nextPageOffset Int! non-null scalar [#nextpageoffsetint-non-null-scalar] [`Int!`](/types/scalars/int) The offset pointing to the next page. 0 if there are no more pages. Member Of [#member-of] [`AlertConnection`](/types/objects/alert-connection) `object` [`ConnectPortfolioCompaniesConnection`](/types/objects/connect-portfolio-companies-connection) `object` [`PrivatePersonSearchConnection`](/types/objects/private-person-search-connection) `object` URL: /connect/docs/types/objects/partial-date # PartialDate import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type PartialDate { dayOfMonth: Int month: Int year: Int } ``` Fields [#fields] dayOfMonth Int scalar [#dayofmonthint-scalar] [`Int`](/types/scalars/int) From 1 to 31 month Int scalar [#monthint-scalar] [`Int`](/types/scalars/int) From 1 to 12 year Int scalar [#yearint-scalar] [`Int`](/types/scalars/int) Member Of [#member-of] [`PepHit`](/types/objects/pep-hit) `object` URL: /connect/docs/types/objects/path-connection-edge # PathConnectionEdge import { Callout } from 'fumadocs-ui/components/callout'; Represents one or more relations to an entity. ```graphql type PathConnectionEdge { kinds: [EntityRelationshipKind!]! node: EntityLike! } ``` Fields [#fields] kinds [EntityRelationshipKind!]! non-null enum [#kindsentityrelationshipkind-non-null-enum] [`[EntityRelationshipKind!]!`](/types/enums/entity-relationship-kind) The kinds of relationships to the entity. node EntityLike! non-null interface [#nodeentitylike-non-null-interface] [`EntityLike!`](/types/interfaces/entity-like) Related entity Member Of [#member-of] [`PathConnection`](/types/objects/path-connection) `object` URL: /connect/docs/types/objects/path-connection # PathConnection import { Callout } from 'fumadocs-ui/components/callout'; Represents a connection between N entities, a path, where N = the number of edges + 1. Example: If `edges` contains two entries, each entry will represent the relationship(s) between each subsequent entity (node) in the traversed path: (queriedEntity)-\[edges\[0]]->(secondEntity)-\[edges\[1]]->(thirdEntity). ```graphql type PathConnection { edges: [PathConnectionEdge!]! } ``` Fields [#fields] edges [PathConnectionEdge!]! non-null object [#edgespathconnectionedge-non-null-object] [`[PathConnectionEdge!]!`](/types/objects/path-connection-edge) Edges representing the path. Member Of [#member-of] [`RiskFactor`](/types/objects/risk-factor) `object` URL: /connect/docs/types/objects/payment-remarks-summary # PaymentRemarksSummary import { Callout } from 'fumadocs-ui/components/callout'; A summary of payment remarks without individual details. ```graphql type PaymentRemarksSummary { count: Int! totalAmount: Float! } ``` Fields [#fields] count Int! non-null scalar [#countint-non-null-scalar] [`Int!`](/types/scalars/int) The number of remarks. totalAmount Float! non-null scalar [#totalamountfloat-non-null-scalar] [`Float!`](/types/scalars/float) The total amount of all remarks. Member Of [#member-of] [`CreditScore`](/types/objects/credit-score) `object` URL: /connect/docs/types/objects/pep-change # PepChange import { Callout } from 'fumadocs-ui/components/callout'; Change in pep screening. ```graphql type PepChange { person: EntityLike! relationsToMonitoredEntity: [RelationKind!]! toValue: PepInfo! fromValue: PepInfo } ``` Fields [#fields] person EntityLike! non-null interface [#personentitylike-non-null-interface] [`EntityLike!`](/types/interfaces/entity-like) The person for which the screening has changed. relationsToMonitoredEntity [RelationKind!]! non-null enum [#relationstomonitoredentityrelationkind-non-null-enum] [`[RelationKind!]!`](/types/enums/relation-kind) How the person is related to the monitored entity. toValue PepInfo! non-null object [#tovaluepepinfo-non-null-object] [`PepInfo!`](/types/objects/pep-info) The changed screening result. fromValue PepInfo object [#fromvaluepepinfo-object] [`PepInfo`](/types/objects/pep-info) The previous screening result. Member Of [#member-of] [`CompanyPepChange`](/types/objects/company-pep-change) `object` URL: /connect/docs/types/objects/pep-hit # PepHit import { Callout } from 'fumadocs-ui/components/callout'; PEP and RCA records. ```graphql type PepHit { name: String aliases: [String!]! dateOfBirth: PartialDate! countries: [Country!]! pep: Boolean! roles: [PepRole!]! rca: Boolean! relations: [PepRelation!]! custom: Boolean! externalUrls: [String!]! confirmedMatch: Boolean } ``` Fields [#fields] name String scalar [#namestring-scalar] [`String`](/types/scalars/string) The name of the pep hit aliases [String!]! non-null scalar [#aliasesstring-non-null-scalar] [`[String!]!`](/types/scalars/string) dateOfBirth PartialDate! non-null object [#dateofbirthpartialdate-non-null-object] [`PartialDate!`](/types/objects/partial-date) The date of birth of the pep hit countries [Country!]! non-null object [#countriescountry-non-null-object] [`[Country!]!`](/types/objects/country) The countries of the pep hit pep Boolean! non-null scalar [#pepboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether this person is a PEP (Politically Exposed Person). roles [PepRole!]! non-null object [#rolespeprole-non-null-object] [`[PepRole!]!`](/types/objects/pep-role) Roles that make this person a PEP. rca Boolean! non-null scalar [#rcaboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether this person is an RCA (Relatives and Close Associates). relations [PepRelation!]! non-null object [#relationspeprelation-non-null-object] [`[PepRelation!]!`](/types/objects/pep-relation) Relations this person has to PEPs (making this person an RCA). custom Boolean! non-null scalar [#customboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) If this hit is a user-supplied PEP hit. If true, the information in this PEP hit represents user-provided data about a PEP or RCA that is not known to Strise. This field will always return false for users who do not have access to the PEP/RCA verification feature. externalUrls [String!]! non-null scalar [#externalurlsstring-non-null-scalar] [`[String!]!`](/types/scalars/string) External source urls confirmedMatch Boolean scalar [#confirmedmatchboolean-scalar] [`Boolean`](/types/scalars/boolean) The user’s verification status of this PEP/RCA match. If the match has not yet been verified by a user, this field will return null. This field will only return data for users who have access to the PEP/RCA verification feature. Member Of [#member-of] [`PepInfo`](/types/objects/pep-info) `object` URL: /connect/docs/types/objects/pep-info # PepInfo import { Callout } from 'fumadocs-ui/components/callout'; PEP information. ```graphql type PepInfo { pep: Boolean! roles: [PepRole!]! @deprecated rca: Boolean! relations: [PepRelation!]! @deprecated confirmedPepStatus: Boolean confirmedRcaStatus: Boolean hits( includeSuggestedFalse: Boolean = false ): [PepHit!]! } ``` Fields [#fields] pep Boolean! non-null scalar [#pepboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) If this individual qualifies as a PEP (Politically Exposed Person). roles [PepRole!]! deprecated non-null object [#rolespeprole-deprecated-non-null-object] [`[PepRole!]!`](/types/objects/pep-role) Use the `roles` field in hits instead. Roles that make this person a PEP. rca Boolean! non-null scalar [#rcaboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) If this individual qualifies as an RCA (Relatives and Close Associates). relations [PepRelation!]! deprecated non-null object [#relationspeprelation-deprecated-non-null-object] [`[PepRelation!]!`](/types/objects/pep-relation) Use the `relations` field in hits instead. Relations this person has to PEPs (making this person an RCA). confirmedPepStatus Boolean scalar [#confirmedpepstatusboolean-scalar] [`Boolean`](/types/scalars/boolean) The user verified PEP status of this person. Returns true if at least one matching PEP hit has been confirmed true, returns false if all matching PEP hits has been confirmed false, returns null in all other cases. This field will only return data for users who have access to the PEP/RCA verification feature. confirmedRcaStatus Boolean scalar [#confirmedrcastatusboolean-scalar] [`Boolean`](/types/scalars/boolean) The user verified RCA status of this person. Returns true if at least one matching RCA hit has been confirmed true, returns false if all matching RCA hits has been confirmed false, returns null in all other cases. This field will only return data for users who have access to the PEP/RCA verification feature. hits [PepHit!]! non-null object [#hitspephit-non-null-object] [`[PepHit!]!`](/types/objects/pep-hit) PEP and RCA records that match this person. includeSuggestedFalse Boolean scalar [#includesuggestedfalseboolean-scalar] [`Boolean`](/types/scalars/boolean) Whether to include PEP and RCA hits that have been suggested false and are not confirmed true. Defaults to false. Only relevant to set for users who have access to the PEP/RCA verification feature. Member Of [#member-of] [`BusinessPerson`](/types/objects/business-person) `object` [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` [`PepChange`](/types/objects/pep-change) `object` [`PrivatePerson`](/types/objects/private-person) `object` URL: /connect/docs/types/objects/pep-relation # PepRelation import { Callout } from 'fumadocs-ui/components/callout'; Relation to a PEP. ```graphql type PepRelation { description: String name: String birthDate: Date roles: [PepRole!]! externalUrls: [String!]! } ``` Fields [#fields] description String scalar [#descriptionstring-scalar] [`String`](/types/scalars/string) Description of the relation to the PEP. name String scalar [#namestring-scalar] [`String`](/types/scalars/string) Name of related PEP. birthDate Date scalar [#birthdatedate-scalar] [`Date`](/types/scalars/date) Birth date of related PEP. roles [PepRole!]! non-null object [#rolespeprole-non-null-object] [`[PepRole!]!`](/types/objects/pep-role) Roles of related PEP. externalUrls [String!]! non-null scalar [#externalurlsstring-non-null-scalar] [`[String!]!`](/types/scalars/string) External source urls Member Of [#member-of] [`PepHit`](/types/objects/pep-hit) `object` [`PepInfo`](/types/objects/pep-info) `object` URL: /connect/docs/types/objects/pep-role # PepRole import { Callout } from 'fumadocs-ui/components/callout'; A role that makes a person a PEP, e.g. member of parliament. ```graphql type PepRole { description: String details: String startDate: Date endDate: Date since: Date @deprecated } ``` Fields [#fields] description String scalar [#descriptionstring-scalar] [`String`](/types/scalars/string) Description of the role that makes this person a PEP. details String scalar [#detailsstring-scalar] [`String`](/types/scalars/string) Further details about the role. startDate Date scalar [#startdatedate-scalar] [`Date`](/types/scalars/date) The date the person started the role. NB! changes to this field will not be notified. endDate Date scalar [#enddatedate-scalar] [`Date`](/types/scalars/date) The date the person ended the role. NB! changes to this field will not be notified. since Date deprecated scalar [#sincedate-deprecated-scalar] [`Date`](/types/scalars/date) Use startDate instead The date the person assumed the role. NB! changes to this field will not be notified. Member Of [#member-of] [`PepHit`](/types/objects/pep-hit) `object` [`PepInfo`](/types/objects/pep-info) `object` [`PepRelation`](/types/objects/pep-relation) `object` URL: /connect/docs/types/objects/person-bulk-payload-resource # PersonBulkPayloadResource import { Callout } from 'fumadocs-ui/components/callout'; Response for bulk adding persons to monitoring. ```graphql type PersonBulkPayloadResource { failed: [PrivatePersonId!]! allSuccessful: Boolean! } ``` Fields [#fields] failed [PrivatePersonId!]! non-null scalar [#failedprivatepersonid-non-null-scalar] [`[PrivatePersonId!]!`](/types/scalars/private-person-id) allSuccessful Boolean! non-null scalar [#allsuccessfulboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Returned By [#returned-by] [`privatePersonsAddToMonitoring`](/mutations/private-persons-add-to-monitoring) `mutation` URL: /connect/docs/types/objects/person-review-trigger-event # PersonReviewTriggerEvent import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type PersonReviewTriggerEvent implements ReviewTriggerEvent { person: PrivatePersonId! id: ID! triggeredAt: DateTime! statements: [ReviewTriggerStatementKind!]! } ``` Fields [#fields] person PrivatePersonId! non-null scalar [#personprivatepersonid-non-null-scalar] [`PrivatePersonId!`](/types/scalars/private-person-id) The person for which the review was triggered. id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) The ID of the review trigger event. triggeredAt DateTime! non-null scalar [#triggeredatdatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) A timestamp of when the review was triggered. statements [ReviewTriggerStatementKind!]! non-null enum [#statementsreviewtriggerstatementkind-non-null-enum] [`[ReviewTriggerStatementKind!]!`](/types/enums/review-trigger-statement-kind) The statements that make up the trigger. These are the things that have changed since the last review was performed. Interfaces [#interfaces] ReviewTriggerEvent interface [#reviewtriggerevent-interface] [`ReviewTriggerEvent`](/types/interfaces/review-trigger-event) Interace for review trigger events. URL: /connect/docs/types/objects/person-search-connection-edge # PersonSearchConnectionEdge import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type PersonSearchConnectionEdge { node: PrivatePerson! } ``` Fields [#fields] node PrivatePerson! non-null object [#nodeprivateperson-non-null-object] [`PrivatePerson!`](/types/objects/private-person) Member Of [#member-of] [`PrivatePersonSearchConnection`](/types/objects/private-person-search-connection) `object` URL: /connect/docs/types/objects/private-person-payload # PrivatePersonPayload import { Callout } from 'fumadocs-ui/components/callout'; The payload for a PrivatePerson mutation. ```graphql type PrivatePersonPayload { success: Boolean! person: PrivatePerson } ``` Fields [#fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) person PrivatePerson object [#personprivateperson-object] [`PrivatePerson`](/types/objects/private-person) Returned By [#returned-by] [`privatePersonAddToMonitoring`](/mutations/private-person-add-to-monitoring) `mutation` [`privatePersonCreate`](/mutations/private-person-create) `mutation` [`privatePersonCreateNoEnrich`](/mutations/private-person-create-no-enrich) `mutation` [`privatePersonDelete`](/mutations/private-person-delete) `mutation` [`privatePersonRemoveFromMonitoring`](/mutations/private-person-remove-from-monitoring) `mutation` [`privatePersonUpdate`](/mutations/private-person-update) `mutation` URL: /connect/docs/types/objects/private-person-review-payload # PrivatePersonReviewPayload import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type PrivatePersonReviewPayload { success: Boolean! risk: RiskClass! id: ID context: ReviewContext } ``` Fields [#fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) risk RiskClass! non-null enum [#riskriskclass-non-null-enum] [`RiskClass!`](/types/enums/risk-class) id ID scalar [#idid-scalar] [`ID`](/types/scalars/id) Has a value only when the review is automatically completed, which is dependent on configured risk class settings. context ReviewContext object [#contextreviewcontext-object] [`ReviewContext`](/types/objects/review-context) Returned By [#returned-by] [`reviewPrivatePersonCreate`](/mutations/review-private-person-create) `mutation` URL: /connect/docs/types/objects/private-person-review # PrivatePersonReview import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type PrivatePersonReview { id: ID! pdf: Base64EncodedFile createdAt: DateTime! privatePersonId: PrivatePersonId! userAssessedRiskLevel: RiskLevelKind validUntilDate: DateTime } ``` Fields [#fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) The id of the review. pdf Base64EncodedFile scalar [#pdfbase64encodedfile-scalar] [`Base64EncodedFile`](/types/scalars/base-64-encoded-file) The review as a base64 encoded PDF. The PDF is generated asynchronously, if it has not been created yet this field will be 'null'. createdAt DateTime! non-null scalar [#createdatdatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) The review's creation timestamp privatePersonId PrivatePersonId! non-null scalar [#privatepersonidprivatepersonid-non-null-scalar] [`PrivatePersonId!`](/types/scalars/private-person-id) The ID of the private person on which the review was created. userAssessedRiskLevel RiskLevelKind enum [#userassessedrisklevelrisklevelkind-enum] [`RiskLevelKind`](/types/enums/risk-level-kind) User-assessed risk level set during the review process. validUntilDate DateTime scalar [#validuntildatedatetime-scalar] [`DateTime`](/types/scalars/date-time) Date until which the review is valid Returned By [#returned-by] [`privatePersonReview`](/queries/private-person-review) `query` [`privatePersonReviews`](/queries/private-person-reviews) `query` Member Of [#member-of] [`PrivatePerson`](/types/objects/private-person) `object` URL: /connect/docs/types/objects/private-person-search-connection # PrivatePersonSearchConnection import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type PrivatePersonSearchConnection { edges: [PersonSearchConnectionEdge!]! pageInfo: PageInfo } ``` Fields [#fields] edges [PersonSearchConnectionEdge!]! non-null object [#edgespersonsearchconnectionedge-non-null-object] [`[PersonSearchConnectionEdge!]!`](/types/objects/person-search-connection-edge) pageInfo PageInfo object [#pageinfopageinfo-object] [`PageInfo`](/types/objects/page-info) Will contain a value for paginated searches Returned By [#returned-by] [`privatePersonIdentifierSearch`](/queries/private-person-identifier-search) `query` [`privatePersonSearch`](/queries/private-person-search) `query` URL: /connect/docs/types/objects/private-person # PrivatePerson import { Callout } from 'fumadocs-ui/components/callout'; A resource representing a private person. ```graphql type PrivatePerson implements MonitoredEntityLike { id: PrivatePersonId! name: String! gender: Gender birthDate: Date birthYear: Year address: [Address!]! countries: [CountryContext!]! identifiers: [EntityIdentifier!]! pep: Boolean! @deprecated pepInfo: PepInfo! tags: [Tag!]! entityPortfolioStatusInfo: EntityPortfolioStatusInfo sanctioned: Boolean! @deprecated sanctionInfo: SanctionInfo! relationships( kind: [EntityRelationshipKind!]! ): EntityConnection! amsCount: Int! isMonitored: Boolean! flags: [FlagKind!]! riskSignals: RiskSignals! userAssessedRiskLevel: RiskLevelKind reviews: [PrivatePersonReview!]! nextScheduledReviewDate: DateTime customRiskFields: [EntityCustomRiskField!]! ams( pageInfo: SizePageInfoInput = { size: 20, offset: 0 } ): [AmsEvent!]! } ``` Fields [#fields] id PrivatePersonId! non-null scalar [#idprivatepersonid-non-null-scalar] [`PrivatePersonId!`](/types/scalars/private-person-id) The internal ID of this private person. name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) Person name. gender Gender enum [#gendergender-enum] [`Gender`](/types/enums/gender) The gender of the person. birthDate Date scalar [#birthdatedate-scalar] [`Date`](/types/scalars/date) The birth date of the person. birthYear Year scalar [#birthyearyear-scalar] [`Year`](/types/scalars/year) The birth year of the person. address [Address!]! non-null object [#addressaddress-non-null-object] [`[Address!]!`](/types/objects/address) countries [CountryContext!]! non-null object [#countriescountrycontext-non-null-object] [`[CountryContext!]!`](/types/objects/country-context) identifiers [EntityIdentifier!]! non-null object [#identifiersentityidentifier-non-null-object] [`[EntityIdentifier!]!`](/types/objects/entity-identifier) pep Boolean! deprecated non-null scalar [#pepboolean-deprecated-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Use the `pepInfo` field instead. Whether the person is a PEP or not. pepInfo PepInfo! non-null object [#pepinfopepinfo-non-null-object] [`PepInfo!`](/types/objects/pep-info) PEP information. tags [Tag!]! non-null object [#tagstag-non-null-object] [`[Tag!]!`](/types/objects/tag) Tags added to the person. entityPortfolioStatusInfo EntityPortfolioStatusInfo object [#entityportfoliostatusinfoentityportfoliostatusinfo-object] [`EntityPortfolioStatusInfo`](/types/objects/entity-portfolio-status-info) The team-assigned entity portfolio status information for the private person. sanctioned Boolean! deprecated non-null scalar [#sanctionedboolean-deprecated-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Use the `sanctionInfo` field instead. Whether the person is sanctioned or not. sanctionInfo SanctionInfo! non-null object [#sanctioninfosanctioninfo-non-null-object] [`SanctionInfo!`](/types/objects/sanction-info) Sanction information. relationships EntityConnection! non-null object [#relationshipsentityconnection-non-null-object] [`EntityConnection!`](/types/objects/entity-connection) kind [EntityRelationshipKind!]! non-null enum [#kindentityrelationshipkind-non-null-enum] [`[EntityRelationshipKind!]!`](/types/enums/entity-relationship-kind) amsCount Int! non-null scalar [#amscountint-non-null-scalar] [`Int!`](/types/scalars/int) The number of adverse media event found on this private person. This is an approximation and the actual number may be lower, but never higher. isMonitored Boolean! non-null scalar [#ismonitoredboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether this private person is monitored or not. flags [FlagKind!]! non-null enum [#flagsflagkind-non-null-enum] [`[FlagKind!]!`](/types/enums/flag-kind) Flagged events for related business persons. riskSignals RiskSignals! non-null object [#risksignalsrisksignals-non-null-object] [`RiskSignals!`](/types/objects/risk-signals) Risk signals. Currently there is only one possible risk signal, 'flags', which is created if we find flags of negative severity. userAssessedRiskLevel RiskLevelKind enum [#userassessedrisklevelrisklevelkind-enum] [`RiskLevelKind`](/types/enums/risk-level-kind) User-assessed risk level for the private person. Determined by the user during the review process. reviews [PrivatePersonReview!]! non-null object [#reviewsprivatepersonreview-non-null-object] [`[PrivatePersonReview!]!`](/types/objects/private-person-review) Reviews created on this private person. nextScheduledReviewDate DateTime scalar [#nextscheduledreviewdatedatetime-scalar] [`DateTime`](/types/scalars/date-time) The date of the next scheduled review, based on the latest review user-assessed risk. customRiskFields [EntityCustomRiskField!]! non-null object [#customriskfieldsentitycustomriskfield-non-null-object] [`[EntityCustomRiskField!]!`](/types/objects/entity-custom-risk-field) Custom risk field values assigned to this private person. ams [AmsEvent!]! non-null object [#amsamsevent-non-null-object] [`[AmsEvent!]!`](/types/objects/ams-event) Adverse media articles found for this entity. This field replaces the `amsCount` field, which will eventually be deprecated. The `amsCount` field might differ from the actual number returned here, due to different screening solutions being used. pageInfo SizePageInfoInput input [#pageinfosizepageinfoinput-input] [`SizePageInfoInput`](/types/inputs/size-page-info-input) Used for pagination. Media articles are sorted by the highest relevance first. Interfaces [#interfaces] MonitoredEntityLike interface [#monitoredentitylike-interface] [`MonitoredEntityLike`](/types/interfaces/monitored-entity-like) An interface type of external business entities that can be monitored. Returned By [#returned-by] [`privatePerson`](/queries/private-person) `query` Member Of [#member-of] [`PersonSearchConnectionEdge`](/types/objects/person-search-connection-edge) `object` [`PrivatePersonPayload`](/types/objects/private-person-payload) `object` Implemented By [#implemented-by] [`ReviewEntity`](/types/unions/review-entity) `union` URL: /connect/docs/types/objects/review-context # ReviewContext import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type ReviewContext { triggerId: ReviewTriggerId! relation: EntityConnection explanations: [String!]! entity: ReviewEntity! } ``` Fields [#fields] triggerId ReviewTriggerId! non-null scalar [#triggeridreviewtriggerid-non-null-scalar] [`ReviewTriggerId!`](/types/scalars/review-trigger-id) Unique identifier for the firing review trigger. relation EntityConnection object [#relationentityconnection-object] [`EntityConnection`](/types/objects/entity-connection) The related entity that satisfied the trigger. If this is null then the trigger was satisfied by the entity itself. explanations [String!]! non-null scalar [#explanationsstring-non-null-scalar] [`[String!]!`](/types/scalars/string) Text describing all of the fulfilled conditions. entity ReviewEntity! non-null union [#entityreviewentity-non-null-union] [`ReviewEntity!`](/types/unions/review-entity) The reviewed entity. Member Of [#member-of] [`PrivatePersonReviewPayload`](/types/objects/private-person-review-payload) `object` [`ReviewPayload`](/types/objects/review-payload) `object` URL: /connect/docs/types/objects/review-payload # ReviewPayload import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type ReviewPayload { success: Boolean! risk: RiskClass! id: ID context: ReviewContext } ``` Fields [#fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) risk RiskClass! non-null enum [#riskriskclass-non-null-enum] [`RiskClass!`](/types/enums/risk-class) id ID scalar [#idid-scalar] [`ID`](/types/scalars/id) Has a value only when the review is automatically completed, which is dependent on configured risk class settings. context ReviewContext object [#contextreviewcontext-object] [`ReviewContext`](/types/objects/review-context) Returned By [#returned-by] [`reviewCompanyCreate`](/mutations/review-company-create) `mutation` URL: /connect/docs/types/objects/review-trigger-event-search-connection-edge # ReviewTriggerEventSearchConnectionEdge import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type ReviewTriggerEventSearchConnectionEdge { node: ReviewTriggerEvent! } ``` Fields [#fields] node ReviewTriggerEvent! non-null interface [#nodereviewtriggerevent-non-null-interface] [`ReviewTriggerEvent!`](/types/interfaces/review-trigger-event) Member Of [#member-of] [`ReviewTriggerEventSearchConnection`](/types/objects/review-trigger-event-search-connection) `object` URL: /connect/docs/types/objects/review-trigger-event-search-connection # ReviewTriggerEventSearchConnection import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type ReviewTriggerEventSearchConnection { totalCount: Int! edges: [ReviewTriggerEventSearchConnectionEdge!]! } ``` Fields [#fields] totalCount Int! non-null scalar [#totalcountint-non-null-scalar] [`Int!`](/types/scalars/int) edges [ReviewTriggerEventSearchConnectionEdge!]! non-null object [#edgesreviewtriggereventsearchconnectionedge-non-null-object] [`[ReviewTriggerEventSearchConnectionEdge!]!`](/types/objects/review-trigger-event-search-connection-edge) Returned By [#returned-by] [`reviewTriggerCompanySearch`](/queries/review-trigger-company-search) `query` [`reviewTriggerPersonSearch`](/queries/review-trigger-person-search) `query` [`reviewTriggerSearch`](/queries/review-trigger-search) `query` URL: /connect/docs/types/objects/review # Review import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type Review { id: ID! pdf: Base64EncodedFile createdAt: DateTime! companyId: CompanyId! calculatedRiskLevel: RiskLevelKind userAssessedRiskLevel: RiskLevelKind selfAssessment: String validUntilDate: DateTime entityStatus: EntityPortfolioStatus } ``` Fields [#fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) The id of the review. pdf Base64EncodedFile scalar [#pdfbase64encodedfile-scalar] [`Base64EncodedFile`](/types/scalars/base-64-encoded-file) The review as a base64 encoded PDF. The PDF is generated asynchronously, if it has not been created yet this field will be 'null'. createdAt DateTime! non-null scalar [#createdatdatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) The review's creation timestamp companyId CompanyId! non-null scalar [#companyidcompanyid-non-null-scalar] [`CompanyId!`](/types/scalars/company-id) The ID of the company on which the review was created. calculatedRiskLevel RiskLevelKind enum [#calculatedrisklevelrisklevelkind-enum] [`RiskLevelKind`](/types/enums/risk-level-kind) Calculated risk level at the time of the review. Based on team settings. userAssessedRiskLevel RiskLevelKind enum [#userassessedrisklevelrisklevelkind-enum] [`RiskLevelKind`](/types/enums/risk-level-kind) User-assessed risk level set during the review process. selfAssessment String scalar [#selfassessmentstring-scalar] [`String`](/types/scalars/string) Self assessment set during the review process. validUntilDate DateTime scalar [#validuntildatedatetime-scalar] [`DateTime`](/types/scalars/date-time) Date until which the review is valid entityStatus EntityPortfolioStatus enum [#entitystatusentityportfoliostatus-enum] [`EntityPortfolioStatus`](/types/enums/entity-portfolio-status) The entity status at the time of the review. Returned By [#returned-by] [`review`](/queries/review) `query` [`reviews`](/queries/reviews) `query` Member Of [#member-of] [`Company`](/types/objects/company) `object` URL: /connect/docs/types/objects/risk-calculation-result # RiskCalculationResult import { Callout } from 'fumadocs-ui/components/callout'; Result of an automated risk level calculation including scores and final risk level. ```graphql type RiskCalculationResult { riskLevel: RiskLevelSetting totalScore: Int! countryScore: RiskScoreResult! legalFormScore: RiskScoreResult! industryScore: RiskScoreResult! pepCountScore: RiskScoreResult! rcaCountScore: RiskScoreResult! sanctionCountScore: RiskScoreResult! customRiskFieldsScore: [CustomRiskFieldScore!]! timestamp: ISODateTime! } ``` Fields [#fields] riskLevel RiskLevelSetting object [#risklevelrisklevelsetting-object] [`RiskLevelSetting`](/types/objects/risk-level-setting) The final risk level determined from the total score totalScore Int! non-null scalar [#totalscoreint-non-null-scalar] [`Int!`](/types/scalars/int) The total risk score (sum of all component scores) countryScore RiskScoreResult! non-null object [#countryscoreriskscoreresult-non-null-object] [`RiskScoreResult!`](/types/objects/risk-score-result) Risk score from country evaluation legalFormScore RiskScoreResult! non-null object [#legalformscoreriskscoreresult-non-null-object] [`RiskScoreResult!`](/types/objects/risk-score-result) Risk score from legal form evaluation industryScore RiskScoreResult! non-null object [#industryscoreriskscoreresult-non-null-object] [`RiskScoreResult!`](/types/objects/risk-score-result) Risk score from industry evaluation pepCountScore RiskScoreResult! non-null object [#pepcountscoreriskscoreresult-non-null-object] [`RiskScoreResult!`](/types/objects/risk-score-result) Risk score from pep count evaluation rcaCountScore RiskScoreResult! non-null object [#rcacountscoreriskscoreresult-non-null-object] [`RiskScoreResult!`](/types/objects/risk-score-result) Risk score from rca count evaluation sanctionCountScore RiskScoreResult! non-null object [#sanctioncountscoreriskscoreresult-non-null-object] [`RiskScoreResult!`](/types/objects/risk-score-result) Risk score from sanction count evaluation customRiskFieldsScore [CustomRiskFieldScore!]! non-null object [#customriskfieldsscorecustomriskfieldscore-non-null-object] [`[CustomRiskFieldScore!]!`](/types/objects/custom-risk-field-score) Risk scores from custom risk field evaluations timestamp ISODateTime! non-null scalar [#timestampisodatetime-non-null-scalar] [`ISODateTime!`](/types/scalars/isodate-time) Timestamp of the risk calculation Member Of [#member-of] [`Company`](/types/objects/company) `object` URL: /connect/docs/types/objects/risk-factor # RiskFactor import { Callout } from 'fumadocs-ui/components/callout'; A risk factor is a data point that could imply risk. ```graphql type RiskFactor { name: String! dateTime: DateTime! paths: [PathConnection!]! } ``` Fields [#fields] name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) dateTime DateTime! non-null scalar [#datetimedatetime-non-null-scalar] [`DateTime!`](/types/scalars/date-time) paths [PathConnection!]! non-null object [#pathspathconnection-non-null-object] [`[PathConnection!]!`](/types/objects/path-connection) Path(s) describing the relationships traversed to find the risk signal. If empty, it means the risk signal arose from the entity itself. Member Of [#member-of] [`RiskSignal`](/types/objects/risk-signal) `object` URL: /connect/docs/types/objects/risk-level-setting # RiskLevelSetting import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type RiskLevelSetting { riskLevel: RiskLevelKind! label: String! thresholdScore: Int! } ``` Fields [#fields] riskLevel RiskLevelKind! non-null enum [#risklevelrisklevelkind-non-null-enum] [`RiskLevelKind!`](/types/enums/risk-level-kind) label String! non-null scalar [#labelstring-non-null-scalar] [`String!`](/types/scalars/string) thresholdScore Int! non-null scalar [#thresholdscoreint-non-null-scalar] [`Int!`](/types/scalars/int) Member Of [#member-of] [`RiskCalculationResult`](/types/objects/risk-calculation-result) `object` URL: /connect/docs/types/objects/risk-score-result # RiskScoreResult import { Callout } from 'fumadocs-ui/components/callout'; A risk score with its matched values that contributed to the score ```graphql type RiskScoreResult { score: Int! matchedValues: [String!]! status: RiskScoreStatus! } ``` Fields [#fields] score Int! non-null scalar [#scoreint-non-null-scalar] [`Int!`](/types/scalars/int) matchedValues [String!]! non-null scalar [#matchedvaluesstring-non-null-scalar] [`[String!]!`](/types/scalars/string) status RiskScoreStatus! non-null enum [#statusriskscorestatus-non-null-enum] [`RiskScoreStatus!`](/types/enums/risk-score-status) Indicates whether data was present for calculation or if it was missing Member Of [#member-of] [`CustomRiskFieldScore`](/types/objects/custom-risk-field-score) `object` [`RiskCalculationResult`](/types/objects/risk-calculation-result) `object` URL: /connect/docs/types/objects/risk-signal # RiskSignal import { Callout } from 'fumadocs-ui/components/callout'; A risk signal is created when there exists a set of risk factors that satisfies its conditions. ```graphql type RiskSignal { name: String! riskFactors: [RiskFactor!]! } ``` Fields [#fields] name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) riskFactors [RiskFactor!]! non-null object [#riskfactorsriskfactor-non-null-object] [`[RiskFactor!]!`](/types/objects/risk-factor) Member Of [#member-of] [`RiskSignals`](/types/objects/risk-signals) `object` URL: /connect/docs/types/objects/risk-signals # RiskSignals import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type RiskSignals { signals: [RiskSignal!]! } ``` Fields [#fields] signals [RiskSignal!]! non-null object [#signalsrisksignal-non-null-object] [`[RiskSignal!]!`](/types/objects/risk-signal) Member Of [#member-of] [`BusinessPerson`](/types/objects/business-person) `object` [`Company`](/types/objects/company) `object` [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` [`EntityLike`](/types/interfaces/entity-like) `interface` [`MonitoredEntityLike`](/types/interfaces/monitored-entity-like) `interface` [`PrivatePerson`](/types/objects/private-person) `object` URL: /connect/docs/types/objects/role-change # RoleChange import { Callout } from 'fumadocs-ui/components/callout'; Change in roles. ```graphql type RoleChange { toValue: [Role!]! fromValue: [Role!]! } ``` Fields [#fields] toValue [Role!]! non-null object [#tovaluerole-non-null-object] [`[Role!]!`](/types/objects/role) fromValue [Role!]! non-null object [#fromvaluerole-non-null-object] [`[Role!]!`](/types/objects/role) Member Of [#member-of] [`CompanyRelationsChange`](/types/objects/company-relations-change) `object` URL: /connect/docs/types/objects/role-period # RolePeriod import { Callout } from 'fumadocs-ui/components/callout'; An object representing the period in which a role is active. ```graphql type RolePeriod { from: DateTime to: DateTime } ``` Fields [#fields] from DateTime scalar [#fromdatetime-scalar] [`DateTime`](/types/scalars/date-time) The date from which the role is active. to DateTime scalar [#todatetime-scalar] [`DateTime`](/types/scalars/date-time) The date from which the role is active. Member Of [#member-of] [`Role`](/types/objects/role) `object` URL: /connect/docs/types/objects/role # Role import { Callout } from 'fumadocs-ui/components/callout'; An object representing a role in a company. ```graphql type Role { roleTitle: String! period: RolePeriod! isActive: Boolean! entity: EntityLike! } ``` Fields [#fields] roleTitle String! non-null scalar [#roletitlestring-non-null-scalar] [`String!`](/types/scalars/string) The role title. period RolePeriod! non-null object [#periodroleperiod-non-null-object] [`RolePeriod!`](/types/objects/role-period) The date from which the role is active. isActive Boolean! non-null scalar [#isactiveboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) The date from which the role is active. entity EntityLike! non-null interface [#entityentitylike-non-null-interface] [`EntityLike!`](/types/interfaces/entity-like) The entity on the opposite side of the role relationship. If the role object is fetched from a `Company`, this entity e.g. represents the CEO. If the role is fetched from a `BusinessPerson`, this is the company where the CEO person entity holds its role. Member Of [#member-of] [`BusinessPerson`](/types/objects/business-person) `object` [`Company`](/types/objects/company) `object` [`RoleChange`](/types/objects/role-change) `object` URL: /connect/docs/types/objects/sanction-change # SanctionChange import { Callout } from 'fumadocs-ui/components/callout'; Change in sanction screening. ```graphql type SanctionChange { entity: EntityLike! relationsToMonitoredEntity: [RelationKind!]! toValue: SanctionInfo! fromValue: SanctionInfo } ``` Fields [#fields] entity EntityLike! non-null interface [#entityentitylike-non-null-interface] [`EntityLike!`](/types/interfaces/entity-like) The entity for which the screening has changed. relationsToMonitoredEntity [RelationKind!]! non-null enum [#relationstomonitoredentityrelationkind-non-null-enum] [`[RelationKind!]!`](/types/enums/relation-kind) How the entity is related to the monitored entity. toValue SanctionInfo! non-null object [#tovaluesanctioninfo-non-null-object] [`SanctionInfo!`](/types/objects/sanction-info) The changed screening result. fromValue SanctionInfo object [#fromvaluesanctioninfo-object] [`SanctionInfo`](/types/objects/sanction-info) The previous screening result. Member Of [#member-of] [`CompanySanctionChange`](/types/objects/company-sanction-change) `object` URL: /connect/docs/types/objects/sanction-info # SanctionInfo import { Callout } from 'fumadocs-ui/components/callout'; Sanction information. ```graphql type SanctionInfo { sanctioned: Boolean! sanctions( includeSuggestedFalse: Boolean = false ): [Sanction!]! } ``` Fields [#fields] sanctioned Boolean! non-null scalar [#sanctionedboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) sanctions [Sanction!]! non-null object [#sanctionssanction-non-null-object] [`[Sanction!]!`](/types/objects/sanction) includeSuggestedFalse Boolean scalar [#includesuggestedfalseboolean-scalar] [`Boolean`](/types/scalars/boolean) Whether to include sanctions that have been suggested false and are not confirmed true. Only relevant for users with access to the sanction verification feature. Defaults to false. Member Of [#member-of] [`BusinessPerson`](/types/objects/business-person) `object` [`Company`](/types/objects/company) `object` [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` [`EntityLike`](/types/interfaces/entity-like) `interface` [`MonitoredEntityLike`](/types/interfaces/monitored-entity-like) `interface` [`PrivatePerson`](/types/objects/private-person) `object` [`SanctionChange`](/types/objects/sanction-change) `object` URL: /connect/docs/types/objects/sanction # Sanction import { Callout } from 'fumadocs-ui/components/callout'; Information about a single sanction. ```graphql type Sanction { sanctionedBy: SanctionSource! sourceReference: String sanctionedSince: Date program: String sourceUrl: String confirmedMatch: Boolean } ``` Fields [#fields] sanctionedBy SanctionSource! non-null enum [#sanctionedbysanctionsource-non-null-enum] [`SanctionSource!`](/types/enums/sanction-source) sourceReference String scalar [#sourcereferencestring-scalar] [`String`](/types/scalars/string) sanctionedSince Date scalar [#sanctionedsincedate-scalar] [`Date`](/types/scalars/date) The date the entity was sanctioned. NB! changes to this field will not be notified. program String scalar [#programstring-scalar] [`String`](/types/scalars/string) The program under which the entity was sanctioned. NB! changes to this field will not be notified. sourceUrl String scalar [#sourceurlstring-scalar] [`String`](/types/scalars/string) URL to view the sanction data from the source. NB! changes to this field will not be notified. confirmedMatch Boolean scalar [#confirmedmatchboolean-scalar] [`Boolean`](/types/scalars/boolean) The user’s verification status of this sanction match. If the match has not yet been verified by a user, this field will return null. This field will only return data for users who have access to the sanction verification feature. Member Of [#member-of] [`SanctionInfo`](/types/objects/sanction-info) `object` URL: /connect/docs/types/objects/sandbox-alert-payload # SandboxAlertPayload import { Callout } from 'fumadocs-ui/components/callout'; Payload returned after generating a sandbox alert ```graphql type SandboxAlertPayload { success: Boolean! } ``` Fields [#fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether the alert was successfully generated Returned By [#returned-by] [`sandboxAlertGenerate`](/mutations/sandbox-alert-generate) `mutation` URL: /connect/docs/types/objects/search-match-metadata # SearchMatchMetadata import { Callout } from 'fumadocs-ui/components/callout'; Metadata about a search match, including confidence and score. ```graphql type SearchMatchMetadata { confidence: SearchMatchConfidence! score: Float! } ``` Fields [#fields] confidence SearchMatchConfidence! non-null enum [#confidencesearchmatchconfidence-non-null-enum] [`SearchMatchConfidence!`](/types/enums/search-match-confidence) score Float! non-null scalar [#scorefloat-non-null-scalar] [`Float!`](/types/scalars/float) Member Of [#member-of] [`CompanySearchConnectionEdge`](/types/objects/company-search-connection-edge) `object` URL: /connect/docs/types/objects/send-form-payload # SendFormPayload import { Callout } from 'fumadocs-ui/components/callout'; The payload for sending a customer facing form. ```graphql type SendFormPayload { success: Boolean! formInstanceId: FormInstanceId } ``` Fields [#fields] success Boolean! non-null scalar [#successboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) formInstanceId FormInstanceId scalar [#forminstanceidforminstanceid-scalar] [`FormInstanceId`](/types/scalars/form-instance-id) The id of the created form instance Returned By [#returned-by] [`sendForm`](/mutations/send-form) `mutation` URL: /connect/docs/types/objects/share-class # ShareClass import { Callout } from 'fumadocs-ui/components/callout'; An object representing a share class and the percentage of shares held in that class by an entity. ```graphql type ShareClass { shareClass: String sharePercentage: SharePercentageInterval! } ``` Fields [#fields] shareClass String scalar [#shareclassstring-scalar] [`String`](/types/scalars/string) The name of the share class, if it is defined. sharePercentage SharePercentageInterval! non-null object [#sharepercentagesharepercentageinterval-non-null-object] [`SharePercentageInterval!`](/types/objects/share-percentage-interval) The percentage of shares held in this class by the entity. Member Of [#member-of] [`Ownership`](/types/objects/ownership) `object` [`ShareholderGraphNode`](/types/objects/shareholder-graph-node) `object` URL: /connect/docs/types/objects/share-percentage-interval # SharePercentageInterval import { Callout } from 'fumadocs-ui/components/callout'; An interval representing the amount of share an entity has in a company, as a percentage. `from` and `to` are usually equal in most countries, but in Denmark and a few other markets, intervals are commonly used to represent approximate ownership ranges (e.g. 25-50%). For example, if an entity owns exactly 30% of shares, both `from` and `to` will be 30.0. But if the ownership is reported as a range in the source, then `from` might be 25.0 and `to` might be 50.0. ```graphql type SharePercentageInterval { from: Float! to: Float! } ``` Fields [#fields] from Float! non-null scalar [#fromfloat-non-null-scalar] [`Float!`](/types/scalars/float) The lower bound of the interval, as a percentage. to Float! non-null scalar [#tofloat-non-null-scalar] [`Float!`](/types/scalars/float) The upper bound of the interval, as a percentage. Member Of [#member-of] [`Ownership`](/types/objects/ownership) `object` [`ShareClass`](/types/objects/share-class) `object` [`ShareholderGraphEdge`](/types/objects/shareholder-graph-edge) `object` [`ShareholderGraphNode`](/types/objects/shareholder-graph-node) `object` URL: /connect/docs/types/objects/shareholder-graph-edge # ShareholderGraphEdge import { Callout } from 'fumadocs-ui/components/callout'; An edge between two nodes in a shareholder graph, representing the amount of shares held by a parent entity in a child entity. ```graphql type ShareholderGraphEdge { parent: ShareholderGraphNodeId! child: ShareholderGraphNodeId! sharePercentage: SharePercentageInterval! } ``` Fields [#fields] parent ShareholderGraphNodeId! non-null scalar [#parentshareholdergraphnodeid-non-null-scalar] [`ShareholderGraphNodeId!`](/types/scalars/shareholder-graph-node-id) The ID of the parent node, i.e. the owner. child ShareholderGraphNodeId! non-null scalar [#childshareholdergraphnodeid-non-null-scalar] [`ShareholderGraphNodeId!`](/types/scalars/shareholder-graph-node-id) The ID of the child node, i.e. the company being owned. sharePercentage SharePercentageInterval! non-null object [#sharepercentagesharepercentageinterval-non-null-object] [`SharePercentageInterval!`](/types/objects/share-percentage-interval) The percentage of shares held by the parent entity in the child entity. Member Of [#member-of] [`ShareholderGraph`](/types/objects/shareholder-graph) `object` URL: /connect/docs/types/objects/shareholder-graph-node # ShareholderGraphNode import { Callout } from 'fumadocs-ui/components/callout'; A node in a shareholder graph, representing an entity and its ownership details. ```graphql type ShareholderGraphNode { id: ShareholderGraphNodeId! indirectSharePercentage: SharePercentageInterval! shareClasses: [ShareClass!]! isBeneficialOwner: Boolean! entity: EntityLike } ``` Fields [#fields] id ShareholderGraphNodeId! non-null scalar [#idshareholdergraphnodeid-non-null-scalar] [`ShareholderGraphNodeId!`](/types/scalars/shareholder-graph-node-id) The ID of the node. indirectSharePercentage SharePercentageInterval! non-null object [#indirectsharepercentagesharepercentageinterval-non-null-object] [`SharePercentageInterval!`](/types/objects/share-percentage-interval) The indirect share held in the root company by the entity. shareClasses [ShareClass!]! non-null object [#shareclassesshareclass-non-null-object] [`[ShareClass!]!`](/types/objects/share-class) Share classes held in the root company. These are propagated from the root node of the graph rather than coming from direct children of this node. isBeneficialOwner Boolean! non-null scalar [#isbeneficialownerboolean-non-null-scalar] [`Boolean!`](/types/scalars/boolean) Whether or not the entity is a beneficial owner in the root company. entity EntityLike interface [#entityentitylike-interface] [`EntityLike`](/types/interfaces/entity-like) The shareholder entity Member Of [#member-of] [`ShareholderGraph`](/types/objects/shareholder-graph) `object` URL: /connect/docs/types/objects/shareholder-graph # ShareholderGraph import { Callout } from 'fumadocs-ui/components/callout'; Represents a shareholder graph, which models the ownership structure of a company using nodes and edges. ```graphql type ShareholderGraph { rootId: ShareholderGraphNodeId! nodes: [ShareholderGraphNode!]! edges: [ShareholderGraphEdge!]! } ``` Fields [#fields] rootId ShareholderGraphNodeId! non-null scalar [#rootidshareholdergraphnodeid-non-null-scalar] [`ShareholderGraphNodeId!`](/types/scalars/shareholder-graph-node-id) The id of the root node, i.e., the bottom-most node in the shareholder graph. nodes [ShareholderGraphNode!]! non-null object [#nodesshareholdergraphnode-non-null-object] [`[ShareholderGraphNode!]!`](/types/objects/shareholder-graph-node) The nodes in the shareholder graph. The nodes represent companies or individuals involved as shareholders. edges [ShareholderGraphEdge!]! non-null object [#edgesshareholdergraphedge-non-null-object] [`[ShareholderGraphEdge!]!`](/types/objects/shareholder-graph-edge) The edges in the shareholder graph. Edges represent the ownership links between the nodes, showing the share each entity holds in other entities in the chart. Member Of [#member-of] [`Company`](/types/objects/company) `object` URL: /connect/docs/types/objects/simple-user # SimpleUser import { Callout } from 'fumadocs-ui/components/callout'; A representation of users, which are a collection of entities. ```graphql type SimpleUser { id: ID! name: String! avatar: String email: String accountKind: UserAccountKind! } ``` Fields [#fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) The ID of the user. name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) The name of the user. avatar String scalar [#avatarstring-scalar] [`String`](/types/scalars/string) The avatar of the user. email String scalar [#emailstring-scalar] [`String`](/types/scalars/string) The email of the user. accountKind UserAccountKind! non-null enum [#accountkinduseraccountkind-non-null-enum] [`UserAccountKind!`](/types/enums/user-account-kind) Member Of [#member-of] [`Alert`](/types/objects/alert) `object` [`AmsEvent`](/types/objects/ams-event) `object` [`EditMetadata`](/types/objects/edit-metadata) `object` URL: /connect/docs/types/objects/tag # Tag import { Callout } from 'fumadocs-ui/components/callout'; Tag information, which can be used to label entities. ```graphql type Tag { id: ID! name: String! created: ISODateTime! } ``` Fields [#fields] id ID! non-null scalar [#idid-non-null-scalar] [`ID!`](/types/scalars/id) The tag ID. name String! non-null scalar [#namestring-non-null-scalar] [`String!`](/types/scalars/string) The tag name. created ISODateTime! non-null scalar [#createdisodatetime-non-null-scalar] [`ISODateTime!`](/types/scalars/isodate-time) The date of creation. Member Of [#member-of] [`Company`](/types/objects/company) `object` [`PrivatePerson`](/types/objects/private-person) `object` URL: /connect/docs/types/objects/text-span # TextSpan import { Callout } from 'fumadocs-ui/components/callout'; No description ```graphql type TextSpan { start: Int! end: Int! } ``` Fields [#fields] start Int! non-null scalar [#startint-non-null-scalar] [`Int!`](/types/scalars/int) end Int! non-null scalar [#endint-non-null-scalar] [`Int!`](/types/scalars/int) Member Of [#member-of] [`AmsEntityMention`](/types/objects/ams-entity-mention) `object` [`AmsPrediction`](/types/objects/ams-prediction) `object` URL: /connect/docs/types/scalars/alert-id # AlertId import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar AlertId ``` A generic identifier for an alert Member Of [#member-of] [`AlertUpdateInput`](/types/inputs/alert-update-input) `input` URL: /connect/docs/types/scalars/base-64-encoded-file # Base64EncodedFile import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar Base64EncodedFile ``` An representation of a Base64EncodedFile. Member Of [#member-of] [`PrivatePersonReview`](/types/objects/private-person-review) `object` [`Review`](/types/objects/review) `object` URL: /connect/docs/types/scalars/boolean # Boolean import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar Boolean ``` The `Boolean` scalar type represents `true` or `false`. Returned By [#returned-by] [`companyResetFields`](/mutations/company-reset-fields) `mutation` [`companyUpdateBeneficialOwners`](/mutations/company-update-beneficial-owners) `mutation` [`companyUpdateShareholders`](/mutations/company-update-shareholders) `mutation` Member Of [#member-of] [`AlertUpdatePayload`](/types/objects/alert-update-payload) `object` [`AmsEvent`](/types/objects/ams-event) `object` [`AttachFormInstancePayload`](/types/objects/attach-form-instance-payload) `object` [`BusinessPerson`](/types/objects/business-person) `object` [`BusinessPersonOwnershipInput`](/types/inputs/business-person-ownership-input) `input` [`CancelFormPayload`](/types/objects/cancel-form-payload) `object` [`Company`](/types/objects/company) `object` [`CompanyBulkPayloadResource`](/types/objects/company-bulk-payload-resource) `object` [`CompanyCustomBeneficialOwnerInput`](/types/inputs/company-custom-beneficial-owner-input) `input` [`CompanyOwnershipInput`](/types/inputs/company-ownership-input) `input` [`CompanyPayload`](/types/objects/company-payload) `object` [`ConnectCompanyStatus`](/types/objects/connect-company-status) `object` [`CreateFormUrlPayload`](/types/objects/create-form-url-payload) `object` [`CreditReportPayload`](/types/objects/credit-report-payload) `object` [`CreditScore`](/types/objects/credit-score) `object` [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` [`CustomCompanyPayload`](/types/objects/custom-company-payload) `object` [`CustomPersonOwnershipInput`](/types/inputs/custom-person-ownership-input) `input` [`CustomPersonPayload`](/types/objects/custom-person-payload) `object` [`EntityConnectionEdge`](/types/objects/entity-connection-edge) `object` [`EntityLike`](/types/interfaces/entity-like) `interface` [`GlobalCompanyPayload`](/types/objects/global-company-payload) `object` [`MonitoredEntityLike`](/types/interfaces/monitored-entity-like) `interface` [`PepHit`](/types/objects/pep-hit) `object` [`PepInfo`](/types/objects/pep-info) `object` [`PersonBulkPayloadResource`](/types/objects/person-bulk-payload-resource) `object` [`PersonSearchInput`](/types/inputs/person-search-input) `input` [`PrivatePerson`](/types/objects/private-person) `object` [`PrivatePersonPayload`](/types/objects/private-person-payload) `object` [`PrivatePersonReviewPayload`](/types/objects/private-person-review-payload) `object` [`ReviewPayload`](/types/objects/review-payload) `object` [`Role`](/types/objects/role) `object` [`Sanction`](/types/objects/sanction) `object` [`SanctionInfo`](/types/objects/sanction-info) `object` [`SandboxAlertPayload`](/types/objects/sandbox-alert-payload) `object` [`SendFormPayload`](/types/objects/send-form-payload) `object` [`ShareholderGraphNode`](/types/objects/shareholder-graph-node) `object` URL: /connect/docs/types/scalars/business-entity-id-input # BusinessEntityIdInput import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar BusinessEntityIdInput ``` A generic identifier for a Strise entity (business person or company). To obtain this ID, you must first for search the resource BusinessPerson or Company. These IDs are issued by Strise and unique within the Strise graph. Member Of [#member-of] [`CompanyCustomBeneficialOwnerInput`](/types/inputs/company-custom-beneficial-owner-input) `input` [`CompanyCustomShareholderInput`](/types/inputs/company-custom-shareholder-input) `input` URL: /connect/docs/types/scalars/business-person-id # BusinessPersonId import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar BusinessPersonId ``` A generic identifier for a business person. To obtain this ID, you must first for search the resource BusinessPerson. These IDs are issued by Strise and unique within the Strise graph. Member Of [#member-of] [`BusinessPerson`](/types/objects/business-person) `object` [`BusinessPersonOwnershipInput`](/types/inputs/business-person-ownership-input) `input` [`BusinessPersonWhereInput`](/types/inputs/business-person-where-input) `input` [`CustomPersonEditInput`](/types/inputs/custom-person-edit-input) `input` URL: /connect/docs/types/scalars/company-id # CompanyId import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar CompanyId ``` A generic identifier for a company. To obtain this ID, you must first for search the resource Company. These IDs are issued by Strise and unique within the Strise graph. Member Of [#member-of] [`AttachFormInstanceInput`](/types/inputs/attach-form-instance-input) `input` [`CancelFormInput`](/types/inputs/cancel-form-input) `input` [`CompaniesWhereInput`](/types/inputs/companies-where-input) `input` [`Company`](/types/objects/company) `object` [`CompanyBulkPayloadResource`](/types/objects/company-bulk-payload-resource) `object` [`CompanyOwnershipInput`](/types/inputs/company-ownership-input) `input` [`CompanyResetFieldsInput`](/types/inputs/company-reset-fields-input) `input` [`CompanyReviewTriggerEvent`](/types/objects/company-review-trigger-event) `object` [`CompanyReviewTriggerEventWhereInput`](/types/inputs/company-review-trigger-event-where-input) `input` [`CompanyUpdateBeneficialOwnersInput`](/types/inputs/company-update-beneficial-owners-input) `input` [`CompanyUpdateShareholdersInput`](/types/inputs/company-update-shareholders-input) `input` [`CompanyWhereInput`](/types/inputs/company-where-input) `input` [`CreateFormUrlInput`](/types/inputs/create-form-url-input) `input` [`CustomCompanyUpdateInput`](/types/inputs/custom-company-update-input) `input` [`CustomCompanyWhereInput`](/types/inputs/custom-company-where-input) `input` [`CustomOwnersInput`](/types/inputs/custom-owners-input) `input` [`DocumentWhereInput`](/types/inputs/document-where-input) `input` [`Review`](/types/objects/review) `object` [`SendFormInput`](/types/inputs/send-form-input) `input` URL: /connect/docs/types/scalars/country-code # CountryCode import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar CountryCode ``` A [ISO 3166-1](https://no.wikipedia.org/wiki/ISO_3166-1) alpha-2 code. Empty string will be handled as null Member Of [#member-of] [`AddressInput`](/types/inputs/address-input) `input` [`CompanyIdentifierSearchInput`](/types/inputs/company-identifier-search-input) `input` [`CompanyNameSearchInput`](/types/inputs/company-name-search-input) `input` [`ConnectBusinessPersonSearchInput`](/types/inputs/connect-business-person-search-input) `input` [`ConnectPortfolioCompaniesInput`](/types/inputs/connect-portfolio-companies-input) `input` [`Country`](/types/objects/country) `object` [`CountryContextInput`](/types/inputs/country-context-input) `input` [`CustomCompanyCreateInput`](/types/inputs/custom-company-create-input) `input` [`CustomCompanyUpdateInput`](/types/inputs/custom-company-update-input) `input` [`CustomPersonCreateInput`](/types/inputs/custom-person-create-input) `input` [`CustomPersonEditInput`](/types/inputs/custom-person-edit-input) `input` [`EntityIdentifier`](/types/objects/entity-identifier) `object` [`PersonRegistrySearchInput`](/types/inputs/person-registry-search-input) `input` [`PersonSearchInput`](/types/inputs/person-search-input) `input` [`PrivatePersonCreateInput`](/types/inputs/private-person-create-input) `input` [`PrivatePersonIdentifierSearchInput`](/types/inputs/private-person-identifier-search-input) `input` [`PrivatePersonUpdateInput`](/types/inputs/private-person-update-input) `input` URL: /connect/docs/types/scalars/custom-business-person-id # CustomBusinessPersonId import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar CustomBusinessPersonId ``` A generic identifier for a custom business person. Member Of [#member-of] [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` [`CustomBusinessPersonWhereInput`](/types/inputs/custom-business-person-where-input) `input` URL: /connect/docs/types/scalars/customer-facing-form-id # CustomerFacingFormId import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar CustomerFacingFormId ``` An identifier for a customer facing form. Member Of [#member-of] [`SendFormInput`](/types/inputs/send-form-input) `input` URL: /connect/docs/types/scalars/date-time # DateTime import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar DateTime ``` A date-time in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (yyyy, yyyy-mm, yyyy-mm-dd). Member Of [#member-of] [`Alert`](/types/objects/alert) `object` [`Company`](/types/objects/company) `object` [`CompanyReviewTriggerEvent`](/types/objects/company-review-trigger-event) `object` [`CompanyReviewTriggerEventWhereInput`](/types/inputs/company-review-trigger-event-where-input) `input` [`ConnectCompanyStatus`](/types/objects/connect-company-status) `object` [`CreditScore`](/types/objects/credit-score) `object` [`EditMetadata`](/types/objects/edit-metadata) `object` [`EntityPortfolioStatusInfo`](/types/objects/entity-portfolio-status-info) `object` [`MonitoringChange`](/types/objects/monitoring-change) `object` [`PersonReviewTriggerEvent`](/types/objects/person-review-trigger-event) `object` [`PersonReviewTriggerEventWhereInput`](/types/inputs/person-review-trigger-event-where-input) `input` [`PrivatePerson`](/types/objects/private-person) `object` [`PrivatePersonReview`](/types/objects/private-person-review) `object` [`Review`](/types/objects/review) `object` [`ReviewTriggerEvent`](/types/interfaces/review-trigger-event) `interface` [`ReviewTriggerEventWhereInput`](/types/inputs/review-trigger-event-where-input) `input` [`RiskFactor`](/types/objects/risk-factor) `object` [`RolePeriod`](/types/objects/role-period) `object` URL: /connect/docs/types/scalars/date # Date import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar Date ``` A date in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (mm-dd). Member Of [#member-of] [`BusinessPerson`](/types/objects/business-person) `object` [`ConnectBusinessPersonSearchInput`](/types/inputs/connect-business-person-search-input) `input` [`ConnectPrivatePersonRegistrySearchResource`](/types/objects/connect-private-person-registry-search-resource) `object` [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` [`CustomPersonOwnershipInput`](/types/inputs/custom-person-ownership-input) `input` [`PepRelation`](/types/objects/pep-relation) `object` [`PepRole`](/types/objects/pep-role) `object` [`PersonRegistrySearchInput`](/types/inputs/person-registry-search-input) `input` [`PersonSearchInput`](/types/inputs/person-search-input) `input` [`PrivatePerson`](/types/objects/private-person) `object` [`PrivatePersonCreateInput`](/types/inputs/private-person-create-input) `input` [`PrivatePersonUpdateInput`](/types/inputs/private-person-update-input) `input` [`Sanction`](/types/objects/sanction) `object` URL: /connect/docs/types/scalars/float # Float import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar Float ``` The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). Member Of [#member-of] [`AmsPrediction`](/types/objects/ams-prediction) `object` [`BusinessPerson`](/types/objects/business-person) `object` [`BusinessPersonOwnershipInput`](/types/inputs/business-person-ownership-input) `input` [`CollateralSummary`](/types/objects/collateral-summary) `object` [`Company`](/types/objects/company) `object` [`CompanyCustomShareholderInput`](/types/inputs/company-custom-shareholder-input) `input` [`CompanyOwnershipInput`](/types/inputs/company-ownership-input) `input` [`CreditScore`](/types/objects/credit-score) `object` [`CustomPersonOwnershipInput`](/types/inputs/custom-person-ownership-input) `input` [`OwnershipRelationDetails`](/types/objects/ownership-relation-details) `object` [`PaymentRemarksSummary`](/types/objects/payment-remarks-summary) `object` [`SearchMatchMetadata`](/types/objects/search-match-metadata) `object` [`SharePercentageInterval`](/types/objects/share-percentage-interval) `object` URL: /connect/docs/types/scalars/form-instance-id # FormInstanceId import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar FormInstanceId ``` An identifier for a customer facing form instance. Member Of [#member-of] [`AttachFormInstanceInput`](/types/inputs/attach-form-instance-input) `input` [`SendFormPayload`](/types/objects/send-form-payload) `object` URL: /connect/docs/types/scalars/id # ID import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar ID ``` The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID. Member Of [#member-of] [`Alert`](/types/objects/alert) `object` [`AlertConnectionEdge`](/types/objects/alert-connection-edge) `object` [`AlertsWhereInput`](/types/inputs/alerts-where-input) `input` [`AmsEvent`](/types/objects/ams-event) `object` [`CancelFormInput`](/types/inputs/cancel-form-input) `input` [`ClusteredEvent`](/types/objects/clustered-event) `object` [`CompanyReviewTriggerEvent`](/types/objects/company-review-trigger-event) `object` [`CreateFormUrlInput`](/types/inputs/create-form-url-input) `input` [`CustomRiskField`](/types/objects/custom-risk-field) `object` [`CustomRiskFieldOption`](/types/objects/custom-risk-field-option) `object` [`CustomRiskFieldScore`](/types/objects/custom-risk-field-score) `object` [`Document`](/types/objects/document) `object` [`DocumentWhereInput`](/types/inputs/document-where-input) `input` [`EntityCustomRiskFieldUpdateInput`](/types/inputs/entity-custom-risk-field-update-input) `input` [`Form`](/types/objects/form) `object` [`MonitoringChange`](/types/objects/monitoring-change) `object` [`PersonReviewTriggerEvent`](/types/objects/person-review-trigger-event) `object` [`PrivatePersonReview`](/types/objects/private-person-review) `object` [`PrivatePersonReviewPayload`](/types/objects/private-person-review-payload) `object` [`Review`](/types/objects/review) `object` [`ReviewPayload`](/types/objects/review-payload) `object` [`ReviewTriggerEvent`](/types/interfaces/review-trigger-event) `interface` [`ReviewWhereInput`](/types/inputs/review-where-input) `input` [`SandboxAlertInput`](/types/inputs/sandbox-alert-input) `input` [`SimpleUser`](/types/objects/simple-user) `object` [`Tag`](/types/objects/tag) `object` URL: /connect/docs/types/scalars/int # Int import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar Int ``` The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. Member Of [#member-of] [`AccessToken`](/types/objects/access-token) `object` [`AlertPageInfoInput`](/types/inputs/alert-page-info-input) `input` [`BusinessPerson`](/types/objects/business-person) `object` [`CollateralSummary`](/types/objects/collateral-summary) `object` [`Company`](/types/objects/company) `object` [`ConnectPartialDateInput`](/types/inputs/connect-partial-date-input) `input` [`CreateFormUrlInput`](/types/inputs/create-form-url-input) `input` [`CreditScore`](/types/objects/credit-score) `object` [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` [`EmployeeCountInterval`](/types/objects/employee-count-interval) `object` [`EntityLike`](/types/interfaces/entity-like) `interface` [`MonitoredEntityLike`](/types/interfaces/monitored-entity-like) `interface` [`PageInfo`](/types/objects/page-info) `object` [`PartialDate`](/types/objects/partial-date) `object` [`PaymentRemarksSummary`](/types/objects/payment-remarks-summary) `object` [`PrivatePerson`](/types/objects/private-person) `object` [`ReviewTriggerEventSearchConnection`](/types/objects/review-trigger-event-search-connection) `object` [`RiskCalculationResult`](/types/objects/risk-calculation-result) `object` [`RiskLevelSetting`](/types/objects/risk-level-setting) `object` [`RiskScoreResult`](/types/objects/risk-score-result) `object` [`SizePageInfoInput`](/types/inputs/size-page-info-input) `input` [`TextSpan`](/types/objects/text-span) `object` URL: /connect/docs/types/scalars/isodate-time # ISODateTime import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar ISODateTime ``` An combined date-time representation according to the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. Member Of [#member-of] [`AmsEvent`](/types/objects/ams-event) `object` [`Document`](/types/objects/document) `object` [`RiskCalculationResult`](/types/objects/risk-calculation-result) `object` [`Tag`](/types/objects/tag) `object` [`TimespanInput`](/types/inputs/timespan-input) `input` URL: /connect/docs/types/scalars/long # Long import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar Long ``` The `Long` scalar type represents non-fractional signed whole numeric values. Long can represent values between -(2^63) and 2^63 - 1. Member Of [#member-of] [`Document`](/types/objects/document) `object` URL: /connect/docs/types/scalars/private-person-id # PrivatePersonId import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar PrivatePersonId ``` A generic identifier for private person. To obtain this ID, you must first for search PrivatePerson. These IDs are issued by Strise and unique within the Strise graph. Member Of [#member-of] [`PersonBulkPayloadResource`](/types/objects/person-bulk-payload-resource) `object` [`PersonReviewTriggerEvent`](/types/objects/person-review-trigger-event) `object` [`PersonReviewTriggerEventWhereInput`](/types/inputs/person-review-trigger-event-where-input) `input` [`PrivatePerson`](/types/objects/private-person) `object` [`PrivatePersonReview`](/types/objects/private-person-review) `object` [`PrivatePersonsWhereInput`](/types/inputs/private-persons-where-input) `input` [`PrivatePersonUpdateInput`](/types/inputs/private-person-update-input) `input` [`PrivatePersonWhereInput`](/types/inputs/private-person-where-input) `input` URL: /connect/docs/types/scalars/review-trigger-id # ReviewTriggerId import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar ReviewTriggerId ``` An identifier for a review trigger Member Of [#member-of] [`ReviewContext`](/types/objects/review-context) `object` URL: /connect/docs/types/scalars/shareholder-graph-node-id # ShareholderGraphNodeId import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar ShareholderGraphNodeId ``` An identifier for a node in a shareholder graph. Member Of [#member-of] [`ShareholderGraph`](/types/objects/shareholder-graph) `object` [`ShareholderGraphEdge`](/types/objects/shareholder-graph-edge) `object` [`ShareholderGraphNode`](/types/objects/shareholder-graph-node) `object` URL: /connect/docs/types/scalars/string # String import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar String ``` The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text. Returned By [#returned-by] [`strise`](/queries/strise) `query` Member Of [#member-of] [`AccessToken`](/types/objects/access-token) `object` [`Address`](/types/objects/address) `object` [`AddressInput`](/types/inputs/address-input) `input` [`AmsEntityMention`](/types/objects/ams-entity-mention) `object` [`AmsEvent`](/types/objects/ams-event) `object` [`AmsTopicMentions`](/types/objects/ams-topic-mentions) `object` [`BusinessPerson`](/types/objects/business-person) `object` [`BusinessPersonOwnershipInput`](/types/inputs/business-person-ownership-input) `input` [`ClusteredEvent`](/types/objects/clustered-event) `object` [`Company`](/types/objects/company) `object` [`CompanyCustomBeneficialOwnerInput`](/types/inputs/company-custom-beneficial-owner-input) `input` [`CompanyCustomShareholderInput`](/types/inputs/company-custom-shareholder-input) `input` [`CompanyIdentifierSearchInput`](/types/inputs/company-identifier-search-input) `input` [`CompanyNameSearchInput`](/types/inputs/company-name-search-input) `input` [`CompanyOwnershipInput`](/types/inputs/company-ownership-input) `input` [`ConnectBusinessPersonSearchInput`](/types/inputs/connect-business-person-search-input) `input` [`ConnectCompanyStatus`](/types/objects/connect-company-status) `object` [`ConnectIndustryCode`](/types/objects/connect-industry-code) `object` [`ConnectPrivatePersonRegistrySearchResource`](/types/objects/connect-private-person-registry-search-resource) `object` [`Country`](/types/objects/country) `object` [`CreateCompanyFromGlobalEntityInput`](/types/inputs/create-company-from-global-entity-input) `input` [`CreateFormUrlPayload`](/types/objects/create-form-url-payload) `object` [`CreditScore`](/types/objects/credit-score) `object` [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` [`CustomCompanyCreateInput`](/types/inputs/custom-company-create-input) `input` [`CustomCompanyUpdateInput`](/types/inputs/custom-company-update-input) `input` [`CustomPersonCreateInput`](/types/inputs/custom-person-create-input) `input` [`CustomPersonEditInput`](/types/inputs/custom-person-edit-input) `input` [`CustomPersonOwnershipInput`](/types/inputs/custom-person-ownership-input) `input` [`CustomRiskField`](/types/objects/custom-risk-field) `object` [`CustomRiskFieldOption`](/types/objects/custom-risk-field-option) `object` [`Document`](/types/objects/document) `object` [`EditMetadata`](/types/objects/edit-metadata) `object` [`EntityConnectionEdge`](/types/objects/entity-connection-edge) `object` [`EntityIdentifier`](/types/objects/entity-identifier) `object` [`EntityLike`](/types/interfaces/entity-like) `interface` [`Form`](/types/objects/form) `object` [`MonitoredEntityLike`](/types/interfaces/monitored-entity-like) `interface` [`PepHit`](/types/objects/pep-hit) `object` [`PepRelation`](/types/objects/pep-relation) `object` [`PepRole`](/types/objects/pep-role) `object` [`PersonRegistrySearchInput`](/types/inputs/person-registry-search-input) `input` [`PersonSearchInput`](/types/inputs/person-search-input) `input` [`PrivatePerson`](/types/objects/private-person) `object` [`PrivatePersonCreateInput`](/types/inputs/private-person-create-input) `input` [`PrivatePersonIdentifierSearchInput`](/types/inputs/private-person-identifier-search-input) `input` [`PrivatePersonUpdateInput`](/types/inputs/private-person-update-input) `input` [`Review`](/types/objects/review) `object` [`ReviewContext`](/types/objects/review-context) `object` [`RiskFactor`](/types/objects/risk-factor) `object` [`RiskLevelSetting`](/types/objects/risk-level-setting) `object` [`RiskScoreResult`](/types/objects/risk-score-result) `object` [`RiskSignal`](/types/objects/risk-signal) `object` [`Role`](/types/objects/role) `object` [`Sanction`](/types/objects/sanction) `object` [`SendFormInput`](/types/inputs/send-form-input) `input` [`ShareClass`](/types/objects/share-class) `object` [`SimpleUser`](/types/objects/simple-user) `object` [`Tag`](/types/objects/tag) `object` URL: /connect/docs/types/scalars/year # Year import { Callout } from 'fumadocs-ui/components/callout'; ```graphql scalar Year ``` A year in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (yyyy). Member Of [#member-of] [`BusinessPerson`](/types/objects/business-person) `object` [`ConnectBusinessPersonSearchInput`](/types/inputs/connect-business-person-search-input) `input` [`ConnectPrivatePersonRegistrySearchResource`](/types/objects/connect-private-person-registry-search-resource) `object` [`CustomBusinessPerson`](/types/objects/custom-business-person) `object` [`PersonSearchInput`](/types/inputs/person-search-input) `input` [`PrivatePerson`](/types/objects/private-person) `object` [`PrivatePersonCreateInput`](/types/inputs/private-person-create-input) `input` [`PrivatePersonUpdateInput`](/types/inputs/private-person-update-input) `input` URL: /connect/docs/types/unions/relationship-details # RelationshipDetails import { Callout } from 'fumadocs-ui/components/callout'; A union type of available relationship details. ```graphql union RelationshipDetails = OwnershipRelationDetails ``` Possible types [#possible-types] OwnershipRelationDetails object [#ownershiprelationdetails-object] [`OwnershipRelationDetails`](/types/objects/ownership-relation-details) Member Of [#member-of] [`EntityConnectionEdge`](/types/objects/entity-connection-edge) `object` URL: /connect/docs/types/unions/review-entity # ReviewEntity import { Callout } from 'fumadocs-ui/components/callout'; An entity that can be reviewed. ```graphql union ReviewEntity = Company | BusinessPerson | CustomBusinessPerson | PrivatePerson ``` Possible types [#possible-types] Company object [#company-object] [`Company`](/types/objects/company) A resource representing a registered company. BusinessPerson object [#businessperson-object] [`BusinessPerson`](/types/objects/business-person) A resource representing a business person. CustomBusinessPerson object [#custombusinessperson-object] [`CustomBusinessPerson`](/types/objects/custom-business-person) A resource representing a user generated custom business person. PrivatePerson object [#privateperson-object] [`PrivatePerson`](/types/objects/private-person) A resource representing a private person. Member Of [#member-of] [`ReviewContext`](/types/objects/review-context) `object`