Strise GraphQL API
Hi there, and welcome to the Strise Connect API reference πββοΈ
The purpose of this API is to enable customers to integrate Strise with your existing systems by synchronizing data.
Some features in this API are:
Contact
Got issues, suggestions for improvements, or questions? Send us a message! The endpoint below is for the production API. For the sandbox API use the following format: https://<customer name>.api.sandbox.strise.ai/connect/graphql
API Endpoints
https://graphql.strise.ai/connect/graphql
Headers
Authorization: Bearer <YOUR_TOKEN_HERE>
π Getting started
The following show some example queries for the Strise GraphQL API. To experiment with queries, you can use the interactive query executor in the Strise GraphQL Playground.
Generate a token
All queries require the client to be authenticated, which is done by sending your clientId and clientSecret to the generateToken mutation. If you have not yet acquired your client credentials, please request one by sending us a message.
mutation generateToken {
clientAccessTokenGenerate(
clientId: "SECRET_ID"
clientSecret: "SECRET_SECRET"
) {
expires
token
}
}
After generating the token, pass it as a Header for subsequent requests:
{
"Authorization": "Bearer <token>"
}
Search for a company
To make sure everything is configured correctly, a good place to start is to search for a company and see that you get some results.
Run the following to search for Strise AS by its Norwegian organisation number:
query search {
companyIdentifierSearch(where: {identifiers: ["918330100"], country: "NO"}){
edges {
node {
id,
name
}
}
}
}
π API Changelog
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
- Clarified behavior of
PersonSearchInput.countryThecountryfield on thePersonSearchInputobject 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
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
- Added
SNI_2025toIndustryCodeTypeA new enum value,SNI_2025, has been added to theIndustryCodeTypeenum. This represents the upcoming Swedish Standard Industrial Classification for 2025. You may encounter this value in thecodeTypefield when querying for company industry information via theCompany.industriesV2field. 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
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
-
Enhanced Address Information To provide more comprehensive and structured address data, we have introduced a new
addressesfield onCompany,BusinessPerson,CustomBusinessPerson, and theEntityLikeinterface.This new field returns a list of all available addresses for an entity. To help distinguish between them, we've also added:
- A new
addressKindfield to theAddresstype. - A new
AddressKindenum with possible values:POSTAL,REGISTERED,TRADING, andVISITING.
The existing
addressfield is now deprecated and will be removed in a future version. We recommend updating your integrations to use the newaddressesfield to access this richer data and ensure future compatibility. - A new
API Changelog: 2025-12-17
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
-
Added
UNKNOWNemum value toEntityIdentifierKind. When the identifier cannot be determined to be of typePRIMARYorSECONDARYthe identifier kind will beUNKNOWN. -
Added
descriptionfield on typeEntityIdentifier. The description field provides additional details on the type of identifier.
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
-
Argument type for
Query.alertDatahas changed. Thealertargument on theQuery.alertDatafield now accepts a value of typeAlertId!instead ofID!. The newAlertIdscalar provides a more specific identifier for alerts, improving type safety. You must update your queries to use this new type. -
Type of
monitoredEntityfields changed toMonitoredEntityLike. ThemonitoredEntityfield on theAlertConnectionEdgeandMonitoringChangetypes has been updated fromEntityLike!to the new, more specificMonitoredEntityLike!interface. This change ensures that only entities that can be monitored are returned in this context.
New Features & Enhancements
-
Introduced
MonitoredEntityLikeinterface for better type safety. We've added a new interface,MonitoredEntityLike, to specifically represent entities that can be monitored. TheCompanyandPrivatePersontypes now implement this interface, distinguishing them from other entities in monitoring-related queries. -
Filter alerts by entity kind. The
alertsquery now accepts a newentityKindargument within theAlertsWhereInputobject. You can use this to filter alerts for a specific type of entity, such asCOMPANYorPRIVATE_PERSON, using the newEntityKindenum. -
Improved pagination for
amsfields. ThepageInfoargument onPrivatePerson.ams(and other fields implementingEntityLikeorMonitoredEntityLike) 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
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
-
New
isReferenceOnlyfield on Company A new boolean field,isReferenceOnly, has been added to theCompanytype. This field will betruefor 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_PROGRESSstatus forDocumentStatusTheDocumentStatusenum now includes the valueIN_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 thePENDINGandSUCCESS/FAILEDstates.
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
privatePersonCreateNoEnrichmutation A new mutation,privatePersonCreateNoEnrich, has been added to create a private person entity. Unlike the existingprivatePersonCreatemutation, 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 thePrivatePersonCreateInput. This is useful when you have already verified the person's details, for example, by using theprivatePersonRegistrySearchquery, and want to create an entity with that exact data.
API Changelog: 2025-12-08
Improvements to the privatePersonSearch query
- Added a new
hasNinfield to thePersonSearchInputquery 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
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
privatePersonRegistrySearchqueryThe query uses the new
PersonRegistrySearchInputtype, which requiresnameandcountry, and accepts optional fields likenin(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
ConnectPrivatePersonRegistrySearchResourceobject containing the person's details from the registry, such as their name, birth date, address, and official identifier.Example Query:
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
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
- New Adverse Media Source: Dow Jones The
AmsEventKindenum, which specifies the origin of an adverse media event, now includes the valueDOW_JONES. When querying for adverse media via theamsfield on an entity, you may now receiveAmsEventobjects where theeventKindfield isDOW_JONES.
API Changelog: 2025-11-27
Listing tags is now available for companies and private persons
New Features
- Added
tagsfield toCompanyandPrivatePersontypes. This enables you to query for a list of tags added to these resources
API Changelog: 2025-11-05
New Features
-
Added
shareholdersandholdingsfields toCompany, andholdingstoBusinessPersonNew fields to retrieve shareholder and holding information for companies have been added. These fields return lists ofOwnershipobjects, providing details about the direct shareholders and holdings of a company.In each
Ownershipobject, you can find:entity: TheCompanyorBusinessPersonthat is the shareholder, orCompanythat 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
beneficialOwnersfield toCompany, andbeneficialOwnershipsfield toBusinessPersonThese fields contain information about a company's beneficial owners and a business person's beneficial ownerships, respectively. They return lists ofBeneficialOwnershipobjects, which include:entity: TheCompanyorBusinessPersonthat 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
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
-
Added
rolesfield toCompanyandBusinessPersontypes A newrolesfield is now available on theCompanyandBusinessPersontypes. 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:
RoleandRolePeriod.- The
rolesfield returns a list ofRoleobjects. EachRoleincludes theroleTitle, anisActiveflag, the associatedentity(the person or company), and aperiodobject. - The
RolePeriodobject specifies thefromandtodates for the role's tenure. - You can use the
includePrevious: trueargument to fetch historical roles in addition to current ones.
- The
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
-
Added ability to send customer-facing forms A new
sendFormmutation 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, theformIdof the form you wish to send, and the recipient's details in theSendFormInput. Upon success, the API will return aSendFormPayloadcontainingsuccess: trueand the uniqueformInstanceIdfor the form that was sent.This change introduces the following new types and fields:
- Mutation:
sendForm(where: SendFormInput!): SendFormPayload! - Input Type:
SendFormInput, which requirescompanyId,formId,recipientEmail, andrecipientName. - Payload Type:
SendFormPayload, which returns asuccessboolean and the newformInstanceId. - Scalar IDs:
CustomerFacingFormIdto identify the form template, andFormInstanceIdto identify the specific instance that was sent.
- Mutation:
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
-
Company.industriesfield deprecated in favor ofindustriesV2Theindustriesfield on theCompanytype 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
industriesV2field. This field returns a list ofConnectIndustryCodeobjects, each containing the industrycode, itsdescription, and thecodeType(e.g., NACE, SIC).We recommend updating your queries to use
industriesV2to access this more structured and informative data.
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
-
Deprecated
amsCountin favor of newamsfield TheamsCountinteger field is now deprecated on theEntityLikeinterface and its implementing types:Company,BusinessPerson, andCustomBusinessPerson. It will be removed in a future release.We have introduced a new
amsfield which returns a paginated list ofAmsEventobjects. 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
amsCountmay differ from the number of events returned by the newamsfield due to improvements in our screening and event clustering logic.Action Required: Please update your integrations to use the
amsfield to fetch detailed adverse media events.# 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
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
-
Added new legal forms for Finland We have added 21 new values to the
LegalFormKindenum 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 thecustomCompanyCreateandcustomCompanyUpdatemutations.While this is a non-breaking change, we recommend updating any client-side logic that handles
LegalFormKindto recognize these new values.The new values added are:
FI_ASH: Resident-administered areaFI_ASY: Right-of-occupancy associationyFI_AYH: Non-profit associationFI_ETS: Finnish branch of a European economic interest groupingFI_HY: Mortgage SocietyFI_KOY: Limited liability joint-stock property companyFI_KVJ: Public mutual insurance companyFI_OP: Co-operative bankFI_OSK: Housing co-perativeFI_OYJ: Public Limited CompanyFI_SCE: European co-operative societyFI_SCP: European co-operative bankFI_SE: European CompanyFI_SL: Branch of a foreign traderFI_SP: Savings bankFI_TYH: Association for carrying on economic activityFI_UNKNOWN: UnknownFI_VALTLL: State-owned companyFI_VOJ: Public limited insurance companyFI_VOY: Limited insurance companyFI_VY: Insurance association
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
- Added company status and employee count information We've enriched the
Companytype with two new fields to provide more context about a business:- The new
statusfield returns aConnectCompanyStatusobject, which describes the company's operational status (e.g., "Active", "Dissolved"), the date the status was set, and anisActiveboolean flag. - The new
numberOfEmployeesfield returns anEmployeeCountIntervalobject. This provides afromandtointeger value, representing the employee count as a range.
- The new
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
- Added new legal form for German entities We have added a new value,
DE_RV, to theLegalFormKindenum. 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
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
-
Retrieve reviews for a company A new
reviewsfield has been added to theCompanytype. This allows you to directly query all reviews that have been created for a specific company, returning a list ofReviewobjects. -
Added creation timestamp to reviews The
Reviewtype now includes acreatedAtfield. This field provides aDateTimetimestamp for when the review was generated, which is useful for auditing and sorting purposes. -
Added
kindtoEntityIdentifierto classify identifiers We've added a newkindfield to theEntityIdentifiertype. This field helps categorize an entity's identifiers, making it easier to determine their purpose. Thekindfield is non-nullable and returns a value from the newEntityIdentifierKindenum: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:
query GetCompanyIdentifiers($id: CompanyId!) { company(where: { id: $id }) { name identifiers { value country kind # New field } } }
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
-
Introduced Shareholder Graph for Company Ownership A new
shareholderGraphfield has been added to theCompanytype, allowing you to traverse and analyze complex ownership structures.The field returns a
ShareholderGraphobject, which consists ofnodes(the entities) andedges(the ownership links).- Nodes (
ShareholderGraphNode): Represent companies or individuals in the ownership chain. Each node includes the entity's details, their calculatedindirectSharePercentagein the root company, and whether they qualify as aisBeneficialOwner. - 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
SharePercentageIntervaltype, which providesfromandtovalues. - You can control the granularity of the graph by using the
minimumSharePercentageargument on theshareholderGraphfield to filter out smaller shareholders. Refer to the documentation on this parameter to learn more about how it works. Example query:
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 } } } } } - Nodes (
## 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:
query GetAmsEventTopics {
company(where: {id: "..."}) {
ams {
topics
}
}
}
β¨ New Features
-
Added Mutation to Edit Business Persons A new
editPersonmutation has been added, allowing you to modify the details of aBusinessPerson. This mutation uses the newBusinessPersonEditInputtype to specify the person's ID and the fields to be updated (e.g.,birthDate), and returns aBusinessPersonPayload. -
New Filtering Option for Sanctions The
SanctionInfo.sanctionsfield now accepts an optionalincludeSuggestedFalseargument. When set totrue, the query will also return sanctions that have been suggested as false matches but not yet confirmed. The default value isfalse, so existing integrations are not affected.
π Improvements & Fixes
-
Clarified
CountryCodeBehavior The description for theCountryCodescalar has been updated to clarify that providing an empty string will be handled as anullvalue. -
Improved Field Descriptions Documentation for the
amsfield onBusinessPerson,Company,CustomBusinessPerson, andEntityLikehas been standardized and improved for clarity.
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
-
New
amsfield for detailed media screening results A newamsfield has been added to theEntityLikeinterface, making it available onCompany,BusinessPerson, andCustomBusinessPersontypes. This field provides access to detailed adverse media articles and is intended to replace the existingamsCountfield, which will be deprecated in a future release.The
amsfield returns a paginated list ofAmsEventobjects. EachAmsEventrepresents 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 theISODateTimescalar.
PEP Screening
- Added aliases to PEP records The
PepHittype now includes a newaliasesfield. 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
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
-
Enhanced
PepHitType for Richer PEP Data To provide more detailed information on Politically Exposed Person (PEP) matches, thePepHittype 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 newPartialDatetype, which can represent incomplete dates (e.g., just a year and month).countries: [Country!]!: A list of countries associated with the person.
-
New
CUSTOMSanction Source TheSanctionSourceenum now includes theCUSTOMvalue. 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
- Improved
ReviewField Descriptions To improve clarity and provide better guidance, we've added detailed descriptions to the following fields on theReviewtype: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 benullif the PDF is not yet ready.
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
- Removal of
SubscriptionType The rootSubscriptiontype 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 ofSubscriptionfrom your client integrations.
β¨ New Features
-
Verify Sanction Matches The
Sanctiontype now includes aconfirmedMatch: Booleanfield. This field allows you to see a user's verification status for a specific sanction match. It will returntrueorfalseif verified, andnullif 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 toReviewTriggerStatementKind. This allows you to identify review triggers that were initiated due to a change in an entity's risk level.
ζΉε 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.confirmedMatchPepHit.customPepInfo.confirmedPepStatusPepInfo.confirmedRcaStatus- The
includeSuggestedFalseargument onPepInfo.hits
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
-
Richer PEP/RCA Data with
PepHitType We've refactored how PEP and RCA (Relatives and Close Associates) data is exposed to provide more detailed records. ThePepInfoobject now contains ahitsfield that returns a list of the newPepHittype. EachPepHitrepresents 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
rolesandrelationsfields onPepInfoare now deprecated. Please update your integration to use therolesandrelationsfields inside eachPepHitobject instead.Additionally,
PepInfonow includesconfirmedPepStatusandconfirmedRcaStatusfields to reflect any manual verification performed by users. -
Additional Sanction Information The
Sanctiontype 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
PepRoletype now includes asincefield, which provides the date the person assumed that specific role.
General API Improvements
-
Related Entities in Company Review Triggers The
CompanyReviewTriggerEventobject now includes arelationsfield. 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
countryfield in thePrivatePersonIdentifierSearchInputis 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
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
- Added
detailsfield toPepRoleA newdetailsfield of typeStringhas been added to thePepRoleobject. This field provides further context about a person's role, supplementing the existingdescription. For example, while thedescriptionmight be "Member of Parliament," the newdetailsfield could specify the constituency or term dates, offering more granular information for your compliance processes.
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
- Introducing Risk Signals We've added a new
riskSignalsfield to theCompany,BusinessPerson,PrivatePerson,CustomBusinessPersontypes, and theEntityLikeinterface. 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 ofRiskSignals.RiskSignal: Represents a specific risk that has been identified.RiskFactor: A specific data point that contributes to aRiskSignal, including information about when it occurred and the path to the risk.PathConnectionandPathConnectionEdge: New types used withinRiskFactorto describe the path of relationships from the queried entity to the source of the risk.
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.offsetandSizePageInfoInput.size: Descriptions added to clarify their use in pagination.
API Changelog: 2024-10
There were no changes to the GraphQL API in October 2024.
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
-
Enhanced PEP and Sanctions Information We've replaced the simple
pepandsanctionedboolean fields with new, more detailed object types:pepInfoandsanctionInfo. 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 theBusinessPerson,Company,CustomBusinessPerson, andPrivatePersontypes.The following new types have been added to support this feature:
PepInfo,PepRole,PepRelationSanctionInfo,Sanction,SanctionSource
-
New Query for Retrieving Reviews You can now fetch a completed review directly using the new
reviewroot query field. This query accepts a review ID and returns theReviewobject, which includes apdffield containing the Base64 encoded review report. A newBase64EncodedFilescalar has been added for this purpose.
Deprecations
- Deprecated
pepandsanctionedFields Thepepandsanctionedboolean fields onBusinessPerson,Company,CustomBusinessPerson,PrivatePerson, and theEntityLikeinterface are now deprecated. Please update your integrations to use the newpepInfoandsanctionInfofields to access richer data and ensure future compatibility.- Use
pepInfoinstead ofpep. - Use
sanctionInfoinstead ofsanctioned.
- Use
Improvements
-
More Flexible
privatePersonUpdateMutation TheprivatePersonUpdatemutation is now more flexible. Thename,nin,country, andaddressfields in thePrivatePersonUpdateInputare no longer required. This allows you to perform partial updates on aPrivatePersonwithout resubmitting all of their existing details. -
Clarified
amsCountDescription The description for theamsCountfield onBusinessPerson,Company,CustomBusinessPerson,PrivatePerson, andEntityLikehas 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."
π οΈ Manage an entity's status in Strise
Add a company to monitoring
To start receiving updates on a company it needs to be added to monitoring through the following mutation. You may notice that this mutation expects an entity id as input. As outlined in the description of the ID and in the previous section it can be obtained through search. Once the ID has been obtained the company can be added to monitoring by running the following mutation:
mutation monitorCompany {
companyAddToMonitoring(
where: { id: "123-abc-456-def" }
) {
success
company {
name
}
}
}
π Send out form and poll for updates
Sending out forms
In order to send out forms, you can use the sendForm mutation. The mutation takes in the following parameters:
mutation SendForm {
sendForm(
where: {
companyId: "<company_id>"
formId: "<form_id>"
recipientEmail: "<email_address>"
recipientName: "<name>"
}
) {
success
formInstanceId
}
}
You'll need to provide the Strise ID of the company and the form ID of the form you want to send.
Obtaining the company ID
In cases where you only have the company's identifier, use the companyIdentifierSearch query. If you are unable to find a matching company, you can create a new company using the customCompanyCreate mutation.
Obtaining the form ID
You can see all your team's available forms by using the listForms:
query ListForms {
listForms {
id
title
description
}
}
Monitoring the form status
The formInstanceId which is returned from the sendForm mutation can be used to monitor the form's status. Use the document query to monitor the form's status:
query GetDocument {
document(
where: {
documentId: "<formInstanceId>"
companyId: "<company_id>"
}
) {
id
fileName
size
lastModifiedAt
contentType
downloadUrl
source
status
}
}
The status field will indicate the form's status. A PENDING status means that the form is still being processed.
Once status is set to SUCCESS, the form's content can be downloaded using the downloadUrl
Listing all documents of a company
In some cases, a form submission might also include more than one document. To see all documents related to a company, use Company.documents:
query GetCompanyDocuments {
company(where: { id: "<company_id>" }) {
documents {
id
fileName
size
lastModifiedAt
contentType
downloadUrl
source
status
}
}
}
You may also use this field to track the status of a form submission.
Queries
alertData
Description
BETA FEATURE: This query is in beta and will change without warning. Retrieve the change data that triggered the alert.
Response
Returns a MonitoringChange!
Arguments
| Name | Description |
|---|---|
alert - AlertId!
|
Example
Query
query AlertData($alert: AlertId!) {
alertData(alert: $alert) {
monitoredEntity {
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
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 {
...TextSpanFragment
}
classification
score
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
...PathConnectionFragment
}
}
}
}
}
kind
computedAt
change {
kind
}
}
}
Variables
{"alert": AlertId}
Response
{
"data": {
"alertData": {
"monitoredEntity": MonitoredEntityLike,
"kind": "PEP",
"computedAt": "2007-12-03T10:15:30Z",
"change": ChangeLike
}
}
}
alerts
Description
BETA FEATURE: This query is in beta and will change without warning. Retrieve alerts.
Response
Returns an AlertConnection!
Arguments
| Name | Description |
|---|---|
where - AlertsWhereInput!
|
Example
Query
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
}
monitoredEntity {
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
id
url
}
authors
images
entityMentions {
text
span {
...TextSpanFragment
}
entityType
containingPhrase
containingPhraseSpan {
...TextSpanFragment
}
amsPredictions {
...AmsPredictionFragment
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
...RiskFactorFragment
}
}
}
}
}
}
}
Variables
{"where": AlertsWhereInput}
Response
{
"data": {
"alerts": {
"pageInfo": PageInfo,
"edges": [AlertConnectionEdge]
}
}
}
businessPerson
Description
Find a business person by their internal Strise ID.
Response
Returns a BusinessPerson
Arguments
| Name | Description |
|---|---|
where - BusinessPersonWhereInput!
|
Example
Query
query BusinessPerson($where: BusinessPersonWhereInput!) {
businessPerson(where: $where) {
id
gender
birthDate
birthYear
pep
pepInfo {
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
description
details
startDate
endDate
since
}
externalUrls
}
confirmedPepStatus
confirmedRcaStatus
hits {
name
aliases
dateOfBirth {
dayOfMonth
month
year
}
countries {
code
name
}
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
description
details
startDate
endDate
since
}
externalUrls
}
custom
externalUrls
confirmedMatch
}
}
beneficialOwnerships {
reasons
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
...EntityLikeFragment
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
id
url
}
authors
images
entityMentions {
text
span {
...TextSpanFragment
}
entityType
containingPhrase
containingPhraseSpan {
...TextSpanFragment
}
amsPredictions {
...AmsPredictionFragment
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
...RiskFactorFragment
}
}
}
}
}
roles {
roleTitle
period {
from
to
}
isActive
entity {
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
...EntityLikeFragment
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
id
url
}
authors
images
entityMentions {
text
span {
...TextSpanFragment
}
entityType
containingPhrase
containingPhraseSpan {
...TextSpanFragment
}
amsPredictions {
...AmsPredictionFragment
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
...RiskFactorFragment
}
}
}
}
}
holdings {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
...EntityLikeFragment
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
id
url
}
authors
images
entityMentions {
text
span {
...TextSpanFragment
}
entityType
containingPhrase
containingPhraseSpan {
...TextSpanFragment
}
amsPredictions {
...AmsPredictionFragment
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
...RiskFactorFragment
}
}
}
}
}
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
details {
... on OwnershipRelationDetails {
share
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
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 {
...PathConnectionEdgeFragment
}
}
}
}
}
}
}
Variables
{"where": BusinessPersonWhereInput}
Response
{
"data": {
"businessPerson": {
"id": BusinessPersonId,
"gender": "FEMALE",
"birthDate": "2007-12-03",
"birthYear": Year,
"pep": false,
"pepInfo": PepInfo,
"beneficialOwnerships": [BeneficialOwner],
"roles": [Role],
"holdings": [Ownership],
"name": "xyz789",
"address": [Address],
"addresses": [Address],
"countries": [CountryContext],
"identifiers": [EntityIdentifier],
"relationships": EntityConnection,
"sanctioned": true,
"sanctionInfo": SanctionInfo,
"amsCount": 987,
"ams": [AmsEvent],
"flags": ["AUDITOR_NOTES"],
"riskSignals": RiskSignals
}
}
}
businessPersonSearch
Description
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.
Response
Returns a BusinessPersonSearchConnection!
Arguments
| Name | Description |
|---|---|
where - ConnectBusinessPersonSearchInput!
|
Example
Query
query BusinessPersonSearch($where: ConnectBusinessPersonSearchInput!) {
businessPersonSearch(where: $where) {
edges {
node {
id
gender
birthDate
birthYear
pep
pepInfo {
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
...PepRoleFragment
}
externalUrls
}
confirmedPepStatus
confirmedRcaStatus
hits {
name
aliases
dateOfBirth {
...PartialDateFragment
}
countries {
...CountryFragment
}
pep
roles {
...PepRoleFragment
}
rca
relations {
...PepRelationFragment
}
custom
externalUrls
confirmedMatch
}
}
beneficialOwnerships {
reasons
editMetadata {
editKind
updatedAt
editedBy {
...SimpleUserFragment
}
comment
}
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
roles {
roleTitle
period {
from
to
}
isActive
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
holdings {
shareClasses {
shareClass
sharePercentage {
...SharePercentageIntervalFragment
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
...SimpleUserFragment
}
comment
}
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
...EntityLikeFragment
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
id
url
}
authors
images
entityMentions {
text
span {
...TextSpanFragment
}
entityType
containingPhrase
containingPhraseSpan {
...TextSpanFragment
}
amsPredictions {
...AmsPredictionFragment
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
...RiskFactorFragment
}
}
}
}
}
}
}
Variables
{"where": ConnectBusinessPersonSearchInput}
Response
{
"data": {
"businessPersonSearch": {
"edges": [BusinessPersonSearchConnectionEdge]
}
}
}
company
Description
Find a company by their internal Strise ID.
Response
Returns a Company
Arguments
| Name | Description |
|---|---|
where - CompanyWhereInput!
|
Example
Query
query Company($where: CompanyWhereInput!) {
company(where: $where) {
id
industries
industriesV2 {
code
description
codeType
}
inception
organisationFormCodes
businessPurposes
signatoryRights
numberOfEmployees {
from
to
}
status {
name
date
isActive
}
isMonitored
isReferenceOnly
tags {
id
name
created
}
automatedRiskLevel {
riskLevel {
riskLevel
label
thresholdScore
}
totalScore
countryScore {
score
matchedValues
}
legalFormScore {
score
matchedValues
}
industryScore {
score
matchedValues
}
pepCountScore {
score
matchedValues
}
sanctionCountScore {
score
matchedValues
}
customRiskFieldsScore {
customRiskFieldId
scoreResult {
score
matchedValues
}
}
timestamp
}
shareholderGraph {
rootId
nodes {
id
indirectSharePercentage {
from
to
}
shareClasses {
shareClass
sharePercentage {
from
to
}
}
isBeneficialOwner
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
edges {
parent
child
sharePercentage {
from
to
}
}
}
beneficialOwners {
reasons
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
...EntityLikeFragment
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
id
url
}
authors
images
entityMentions {
text
span {
...TextSpanFragment
}
entityType
containingPhrase
containingPhraseSpan {
...TextSpanFragment
}
amsPredictions {
...AmsPredictionFragment
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
...RiskFactorFragment
}
}
}
}
}
roles {
roleTitle
period {
from
to
}
isActive
entity {
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
...EntityLikeFragment
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
id
url
}
authors
images
entityMentions {
text
span {
...TextSpanFragment
}
entityType
containingPhrase
containingPhraseSpan {
...TextSpanFragment
}
amsPredictions {
...AmsPredictionFragment
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
...RiskFactorFragment
}
}
}
}
}
shareholders {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
...EntityLikeFragment
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
id
url
}
authors
images
entityMentions {
text
span {
...TextSpanFragment
}
entityType
containingPhrase
containingPhraseSpan {
...TextSpanFragment
}
amsPredictions {
...AmsPredictionFragment
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
...RiskFactorFragment
}
}
}
}
}
holdings {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
...EntityLikeFragment
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
id
url
}
authors
images
entityMentions {
text
span {
...TextSpanFragment
}
entityType
containingPhrase
containingPhraseSpan {
...TextSpanFragment
}
amsPredictions {
...AmsPredictionFragment
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
...RiskFactorFragment
}
}
}
}
}
reviews {
id
pdf
createdAt
companyId
}
documents {
id
fileName
contentType
size
lastModifiedAt
downloadUrl
source
status
}
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
details {
... on OwnershipRelationDetails {
share
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
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 {
...PathConnectionEdgeFragment
}
}
}
}
}
}
}
Variables
{"where": CompanyWhereInput}
Response
{
"data": {
"company": {
"id": CompanyId,
"industries": ["xyz789"],
"industriesV2": [ConnectIndustryCode],
"inception": "2007-12-03T10:15:30Z",
"organisationFormCodes": ["abc123"],
"businessPurposes": ["abc123"],
"signatoryRights": "xyz789",
"numberOfEmployees": EmployeeCountInterval,
"status": ConnectCompanyStatus,
"isMonitored": false,
"isReferenceOnly": false,
"tags": [Tag],
"automatedRiskLevel": RiskCalculationResult,
"shareholderGraph": ShareholderGraph,
"beneficialOwners": [BeneficialOwner],
"roles": [Role],
"shareholders": [Ownership],
"holdings": [Ownership],
"reviews": [Review],
"documents": [Document],
"name": "xyz789",
"address": [Address],
"addresses": [Address],
"countries": [CountryContext],
"identifiers": [EntityIdentifier],
"relationships": EntityConnection,
"sanctioned": false,
"sanctionInfo": SanctionInfo,
"amsCount": 123,
"ams": [AmsEvent],
"flags": ["AUDITOR_NOTES"],
"riskSignals": RiskSignals
}
}
}
companyIdentifierSearch
Description
Find companies their official identifier.
Response
Returns a CompanySearchConnection!
Arguments
| Name | Description |
|---|---|
where - CompanyIdentifierSearchInput!
|
|
pageInfo - SizePageInfoInput
|
Example
Query
query CompanyIdentifierSearch(
$where: CompanyIdentifierSearchInput!,
$pageInfo: SizePageInfoInput
) {
companyIdentifierSearch(
where: $where,
pageInfo: $pageInfo
) {
edges {
node {
id
industries
industriesV2 {
code
description
codeType
}
inception
organisationFormCodes
businessPurposes
signatoryRights
numberOfEmployees {
from
to
}
status {
name
date
isActive
}
isMonitored
isReferenceOnly
tags {
id
name
created
}
automatedRiskLevel {
riskLevel {
riskLevel
label
thresholdScore
}
totalScore
countryScore {
score
matchedValues
}
legalFormScore {
score
matchedValues
}
industryScore {
score
matchedValues
}
pepCountScore {
score
matchedValues
}
sanctionCountScore {
score
matchedValues
}
customRiskFieldsScore {
customRiskFieldId
scoreResult {
...RiskScoreResultFragment
}
}
timestamp
}
shareholderGraph {
rootId
nodes {
id
indirectSharePercentage {
...SharePercentageIntervalFragment
}
shareClasses {
...ShareClassFragment
}
isBeneficialOwner
entity {
...EntityLikeFragment
}
}
edges {
parent
child
sharePercentage {
...SharePercentageIntervalFragment
}
}
}
beneficialOwners {
reasons
editMetadata {
editKind
updatedAt
editedBy {
...SimpleUserFragment
}
comment
}
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
roles {
roleTitle
period {
from
to
}
isActive
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
shareholders {
shareClasses {
shareClass
sharePercentage {
...SharePercentageIntervalFragment
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
...SimpleUserFragment
}
comment
}
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
holdings {
shareClasses {
shareClass
sharePercentage {
...SharePercentageIntervalFragment
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
...SimpleUserFragment
}
comment
}
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
reviews {
id
pdf
createdAt
companyId
}
documents {
id
fileName
contentType
size
lastModifiedAt
downloadUrl
source
status
}
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
...EntityLikeFragment
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
id
url
}
authors
images
entityMentions {
text
span {
...TextSpanFragment
}
entityType
containingPhrase
containingPhraseSpan {
...TextSpanFragment
}
amsPredictions {
...AmsPredictionFragment
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
...RiskFactorFragment
}
}
}
}
}
}
}
Variables
{
"where": CompanyIdentifierSearchInput,
"pageInfo": SizePageInfoInput
}
Response
{
"data": {
"companyIdentifierSearch": {
"edges": [CompanySearchConnectionEdge]
}
}
}
companySearch
Description
Find companies by search.
Response
Returns a CompanySearchConnection!
Arguments
| Name | Description |
|---|---|
where - CompanyNameSearchInput!
|
|
pageInfo - SizePageInfoInput
|
Example
Query
query CompanySearch(
$where: CompanyNameSearchInput!,
$pageInfo: SizePageInfoInput
) {
companySearch(
where: $where,
pageInfo: $pageInfo
) {
edges {
node {
id
industries
industriesV2 {
code
description
codeType
}
inception
organisationFormCodes
businessPurposes
signatoryRights
numberOfEmployees {
from
to
}
status {
name
date
isActive
}
isMonitored
isReferenceOnly
tags {
id
name
created
}
automatedRiskLevel {
riskLevel {
riskLevel
label
thresholdScore
}
totalScore
countryScore {
score
matchedValues
}
legalFormScore {
score
matchedValues
}
industryScore {
score
matchedValues
}
pepCountScore {
score
matchedValues
}
sanctionCountScore {
score
matchedValues
}
customRiskFieldsScore {
customRiskFieldId
scoreResult {
...RiskScoreResultFragment
}
}
timestamp
}
shareholderGraph {
rootId
nodes {
id
indirectSharePercentage {
...SharePercentageIntervalFragment
}
shareClasses {
...ShareClassFragment
}
isBeneficialOwner
entity {
...EntityLikeFragment
}
}
edges {
parent
child
sharePercentage {
...SharePercentageIntervalFragment
}
}
}
beneficialOwners {
reasons
editMetadata {
editKind
updatedAt
editedBy {
...SimpleUserFragment
}
comment
}
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
roles {
roleTitle
period {
from
to
}
isActive
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
shareholders {
shareClasses {
shareClass
sharePercentage {
...SharePercentageIntervalFragment
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
...SimpleUserFragment
}
comment
}
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
holdings {
shareClasses {
shareClass
sharePercentage {
...SharePercentageIntervalFragment
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
...SimpleUserFragment
}
comment
}
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
reviews {
id
pdf
createdAt
companyId
}
documents {
id
fileName
contentType
size
lastModifiedAt
downloadUrl
source
status
}
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
...EntityLikeFragment
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
id
url
}
authors
images
entityMentions {
text
span {
...TextSpanFragment
}
entityType
containingPhrase
containingPhraseSpan {
...TextSpanFragment
}
amsPredictions {
...AmsPredictionFragment
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
...RiskFactorFragment
}
}
}
}
}
}
}
Variables
{
"where": CompanyNameSearchInput,
"pageInfo": SizePageInfoInput
}
Response
{
"data": {
"companySearch": {
"edges": [CompanySearchConnectionEdge]
}
}
}
customBusinessPerson
Description
Find a custom business person by their internal Strise ID.
Response
Returns a CustomBusinessPerson
Arguments
| Name | Description |
|---|---|
where - CustomBusinessPersonWhereInput!
|
Example
Query
query CustomBusinessPerson($where: CustomBusinessPersonWhereInput!) {
customBusinessPerson(where: $where) {
id
birthDate
birthYear
pep
pepInfo {
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
description
details
startDate
endDate
since
}
externalUrls
}
confirmedPepStatus
confirmedRcaStatus
hits {
name
aliases
dateOfBirth {
dayOfMonth
month
year
}
countries {
code
name
}
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
description
details
startDate
endDate
since
}
externalUrls
}
custom
externalUrls
confirmedMatch
}
}
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
details {
... on OwnershipRelationDetails {
share
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
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 {
...PathConnectionEdgeFragment
}
}
}
}
}
}
}
Variables
{"where": CustomBusinessPersonWhereInput}
Response
{
"data": {
"customBusinessPerson": {
"id": CustomBusinessPersonId,
"birthDate": "2007-12-03",
"birthYear": Year,
"pep": true,
"pepInfo": PepInfo,
"name": "abc123",
"address": [Address],
"addresses": [Address],
"countries": [CountryContext],
"identifiers": [EntityIdentifier],
"relationships": EntityConnection,
"sanctioned": true,
"sanctionInfo": SanctionInfo,
"amsCount": 987,
"ams": [AmsEvent],
"flags": ["AUDITOR_NOTES"],
"riskSignals": RiskSignals
}
}
}
document
Description
Fetch a document by document and company id.
Response
Returns a Document
Arguments
| Name | Description |
|---|---|
where - DocumentWhereInput!
|
Example
Query
query Document($where: DocumentWhereInput!) {
document(where: $where) {
id
fileName
contentType
size
lastModifiedAt
downloadUrl
source
status
}
}
Variables
{"where": DocumentWhereInput}
Response
{
"data": {
"document": {
"id": 4,
"fileName": "abc123",
"contentType": "xyz789",
"size": {},
"lastModifiedAt": ISODateTime,
"downloadUrl": "xyz789",
"source": "COMPANIES_HOUSE",
"status": "FAILED"
}
}
}
listForms
Description
List the forms available.
Response
Returns [Form!]!
Example
Query
query ListForms {
listForms {
id
title
description
}
}
Response
{
"data": {
"listForms": [
{
"id": 4,
"title": "xyz789",
"description": "abc123"
}
]
}
}
privatePerson
Description
Find a private person by their internal Strise ID.
Response
Returns a PrivatePerson
Arguments
| Name | Description |
|---|---|
where - PrivatePersonWhereInput!
|
Example
Query
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
}
pep
pepInfo {
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
description
details
startDate
endDate
since
}
externalUrls
}
confirmedPepStatus
confirmedRcaStatus
hits {
name
aliases
dateOfBirth {
dayOfMonth
month
year
}
countries {
code
name
}
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
description
details
startDate
endDate
since
}
externalUrls
}
custom
externalUrls
confirmedMatch
}
}
tags {
id
name
created
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
details {
... on OwnershipRelationDetails {
share
}
}
}
}
amsCount
isMonitored
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
edges {
...PathConnectionEdgeFragment
}
}
}
}
}
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
}
}
}
Variables
{"where": PrivatePersonWhereInput}
Response
{
"data": {
"privatePerson": {
"id": PrivatePersonId,
"name": "xyz789",
"gender": "FEMALE",
"birthDate": "2007-12-03",
"birthYear": Year,
"address": [Address],
"countries": [CountryContext],
"identifiers": [EntityIdentifier],
"pep": true,
"pepInfo": PepInfo,
"tags": [Tag],
"sanctioned": true,
"sanctionInfo": SanctionInfo,
"relationships": EntityConnection,
"amsCount": 987,
"isMonitored": true,
"flags": ["AUDITOR_NOTES"],
"riskSignals": RiskSignals,
"ams": [AmsEvent]
}
}
}
privatePersonIdentifierSearch
Description
Find private persons by their official identifier, such as SSN.
Response
Returns a PrivatePersonSearchConnection!
Arguments
| Name | Description |
|---|---|
where - PrivatePersonIdentifierSearchInput!
|
|
pageInfo - SizePageInfoInput
|
Example
Query
query PrivatePersonIdentifierSearch(
$where: PrivatePersonIdentifierSearchInput!,
$pageInfo: SizePageInfoInput
) {
privatePersonIdentifierSearch(
where: $where,
pageInfo: $pageInfo
) {
edges {
node {
id
name
gender
birthDate
birthYear
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
pep
pepInfo {
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
...PepRoleFragment
}
externalUrls
}
confirmedPepStatus
confirmedRcaStatus
hits {
name
aliases
dateOfBirth {
...PartialDateFragment
}
countries {
...CountryFragment
}
pep
roles {
...PepRoleFragment
}
rca
relations {
...PepRelationFragment
}
custom
externalUrls
confirmedMatch
}
}
tags {
id
name
created
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
relationships {
edges {
kind
explanation
custom
node {
...EntityLikeFragment
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
amsCount
isMonitored
flags
riskSignals {
signals {
name
riskFactors {
...RiskFactorFragment
}
}
}
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
id
url
}
authors
images
entityMentions {
text
span {
...TextSpanFragment
}
entityType
containingPhrase
containingPhraseSpan {
...TextSpanFragment
}
amsPredictions {
...AmsPredictionFragment
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
}
}
pageInfo {
size
offset
totalSize
nextPageOffset
}
}
}
Variables
{
"where": PrivatePersonIdentifierSearchInput,
"pageInfo": SizePageInfoInput
}
Response
{
"data": {
"privatePersonIdentifierSearch": {
"edges": [PersonSearchConnectionEdge],
"pageInfo": PageInfo
}
}
}
privatePersonRegistrySearch
Description
Find a specific private person in official registries by a combination of identifiers.
Response
Arguments
| Name | Description |
|---|---|
where - PersonRegistrySearchInput!
|
Example
Query
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
}
}
}
Variables
{"where": PersonRegistrySearchInput}
Response
{
"data": {
"privatePersonRegistrySearch": {
"identifier": EntityIdentifier,
"name": "abc123",
"gender": "FEMALE",
"birthDate": "2007-12-03",
"birthYear": Year,
"address": [Address],
"citizenship": [Country]
}
}
}
privatePersonSearch
Description
Find private persons by name.
Response
Returns a PrivatePersonSearchConnection!
Arguments
| Name | Description |
|---|---|
where - PersonSearchInput!
|
|
pageInfo - SizePageInfoInput
|
Maximum page size is 100 |
Example
Query
query PrivatePersonSearch(
$where: PersonSearchInput!,
$pageInfo: SizePageInfoInput
) {
privatePersonSearch(
where: $where,
pageInfo: $pageInfo
) {
edges {
node {
id
name
gender
birthDate
birthYear
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
pep
pepInfo {
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
...PepRoleFragment
}
externalUrls
}
confirmedPepStatus
confirmedRcaStatus
hits {
name
aliases
dateOfBirth {
...PartialDateFragment
}
countries {
...CountryFragment
}
pep
roles {
...PepRoleFragment
}
rca
relations {
...PepRelationFragment
}
custom
externalUrls
confirmedMatch
}
}
tags {
id
name
created
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
relationships {
edges {
kind
explanation
custom
node {
...EntityLikeFragment
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
amsCount
isMonitored
flags
riskSignals {
signals {
name
riskFactors {
...RiskFactorFragment
}
}
}
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
id
url
}
authors
images
entityMentions {
text
span {
...TextSpanFragment
}
entityType
containingPhrase
containingPhraseSpan {
...TextSpanFragment
}
amsPredictions {
...AmsPredictionFragment
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
}
}
pageInfo {
size
offset
totalSize
nextPageOffset
}
}
}
Variables
{
"where": PersonSearchInput,
"pageInfo": SizePageInfoInput
}
Response
{
"data": {
"privatePersonSearch": {
"edges": [PersonSearchConnectionEdge],
"pageInfo": PageInfo
}
}
}
review
Description
Retrieve a review by its id.
Response
Returns a Review!
Arguments
| Name | Description |
|---|---|
where - ReviewWhereInput!
|
Example
Query
query Review($where: ReviewWhereInput!) {
review(where: $where) {
id
pdf
createdAt
companyId
}
}
Variables
{"where": ReviewWhereInput}
Response
{
"data": {
"review": {
"id": 4,
"pdf": Base64EncodedFile,
"createdAt": "2007-12-03T10:15:30Z",
"companyId": CompanyId
}
}
}
reviewTriggerCompanySearch
Description
Find all review trigger events delivered for a specific company.
Response
Returns a ReviewTriggerEventSearchConnection!
Arguments
| Name | Description |
|---|---|
where - CompanyReviewTriggerEventWhereInput!
|
|
pageInfo - SizePageInfoInput
|
Example
Query
query ReviewTriggerCompanySearch(
$where: CompanyReviewTriggerEventWhereInput!,
$pageInfo: SizePageInfoInput
) {
reviewTriggerCompanySearch(
where: $where,
pageInfo: $pageInfo
) {
totalCount
edges {
node {
id
triggeredAt
statements
}
}
}
}
Variables
{
"where": CompanyReviewTriggerEventWhereInput,
"pageInfo": SizePageInfoInput
}
Response
{
"data": {
"reviewTriggerCompanySearch": {
"totalCount": 987,
"edges": [ReviewTriggerEventSearchConnectionEdge]
}
}
}
reviewTriggerPersonSearch
Description
Find all review trigger events delivered for a specific private person.
Response
Returns a ReviewTriggerEventSearchConnection!
Arguments
| Name | Description |
|---|---|
where - PersonReviewTriggerEventWhereInput!
|
|
pageInfo - SizePageInfoInput
|
Example
Query
query ReviewTriggerPersonSearch(
$where: PersonReviewTriggerEventWhereInput!,
$pageInfo: SizePageInfoInput
) {
reviewTriggerPersonSearch(
where: $where,
pageInfo: $pageInfo
) {
totalCount
edges {
node {
id
triggeredAt
statements
}
}
}
}
Variables
{
"where": PersonReviewTriggerEventWhereInput,
"pageInfo": SizePageInfoInput
}
Response
{
"data": {
"reviewTriggerPersonSearch": {
"totalCount": 123,
"edges": [ReviewTriggerEventSearchConnectionEdge]
}
}
}
reviewTriggerSearch
Description
Find all review trigger events delivered within a given timeframe.
Response
Returns a ReviewTriggerEventSearchConnection!
Arguments
| Name | Description |
|---|---|
where - ReviewTriggerEventWhereInput!
|
|
pageInfo - SizePageInfoInput
|
Example
Query
query ReviewTriggerSearch(
$where: ReviewTriggerEventWhereInput!,
$pageInfo: SizePageInfoInput
) {
reviewTriggerSearch(
where: $where,
pageInfo: $pageInfo
) {
totalCount
edges {
node {
id
triggeredAt
statements
}
}
}
}
Variables
{
"where": ReviewTriggerEventWhereInput,
"pageInfo": SizePageInfoInput
}
Response
{
"data": {
"reviewTriggerSearch": {
"totalCount": 123,
"edges": [ReviewTriggerEventSearchConnectionEdge]
}
}
}
reviews
Description
List reviews completed on all entities between the given dates.
Response
Returns [Review!]!
Arguments
| Name | Description |
|---|---|
from - DateTime!
|
The start date of the review period. |
to - DateTime!
|
The end date of the review period. |
pageSize - Int
|
The number of items to return per page. Must be in the range [1, 100]. Default = 100 |
offset - Int
|
The offset of the first item to return. Use with pageSize to page through results. Default = 0 |
Example
Query
query Reviews(
$from: DateTime!,
$to: DateTime!,
$pageSize: Int,
$offset: Int
) {
reviews(
from: $from,
to: $to,
pageSize: $pageSize,
offset: $offset
) {
id
pdf
createdAt
companyId
}
}
Variables
{
"from": "2007-12-03T10:15:30Z",
"to": "2007-12-03T10:15:30Z",
"pageSize": 100,
"offset": 0
}
Response
{
"data": {
"reviews": [
{
"id": "4",
"pdf": Base64EncodedFile,
"createdAt": "2007-12-03T10:15:30Z",
"companyId": CompanyId
}
]
}
}
strise
Description
Welcome to the Strise Connect API! Need help? Contact us at tech@strise.ai
Response
Returns a String!
Example
Query
query Strise {
strise
}
Response
{"data": {"strise": "abc123"}}
Mutations
clientAccessTokenGenerate
Description
Generate a new access token for a client, which can be used to authenticate with the API through a 'Authorization: Bearer
Response
Returns an AccessToken!
Example
Query
mutation ClientAccessTokenGenerate(
$clientId: String!,
$clientSecret: String!
) {
clientAccessTokenGenerate(
clientId: $clientId,
clientSecret: $clientSecret
) {
expires
token
}
}
Variables
{
"clientId": "xyz789",
"clientSecret": "xyz789"
}
Response
{
"data": {
"clientAccessTokenGenerate": {
"expires": 123,
"token": "abc123"
}
}
}
companiesAddToMonitoring
Response
Returns a CompanyBulkPayloadResource!
Arguments
| Name | Description |
|---|---|
where - CompaniesWhereInput!
|
Example
Query
mutation CompaniesAddToMonitoring($where: CompaniesWhereInput!) {
companiesAddToMonitoring(where: $where) {
failed
allSuccessful
}
}
Variables
{"where": CompaniesWhereInput}
Response
{
"data": {
"companiesAddToMonitoring": {
"failed": [CompanyId],
"allSuccessful": true
}
}
}
companyAddToMonitoring
Response
Returns a CompanyPayload!
Arguments
| Name | Description |
|---|---|
where - CompanyWhereInput!
|
Example
Query
mutation CompanyAddToMonitoring($where: CompanyWhereInput!) {
companyAddToMonitoring(where: $where) {
success
company {
id
industries
industriesV2 {
code
description
codeType
}
inception
organisationFormCodes
businessPurposes
signatoryRights
numberOfEmployees {
from
to
}
status {
name
date
isActive
}
isMonitored
isReferenceOnly
tags {
id
name
created
}
automatedRiskLevel {
riskLevel {
riskLevel
label
thresholdScore
}
totalScore
countryScore {
score
matchedValues
}
legalFormScore {
score
matchedValues
}
industryScore {
score
matchedValues
}
pepCountScore {
score
matchedValues
}
sanctionCountScore {
score
matchedValues
}
customRiskFieldsScore {
customRiskFieldId
scoreResult {
score
matchedValues
}
}
timestamp
}
shareholderGraph {
rootId
nodes {
id
indirectSharePercentage {
from
to
}
shareClasses {
shareClass
sharePercentage {
...SharePercentageIntervalFragment
}
}
isBeneficialOwner
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
edges {
parent
child
sharePercentage {
from
to
}
}
}
beneficialOwners {
reasons
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
roles {
roleTitle
period {
from
to
}
isActive
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
shareholders {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
holdings {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
reviews {
id
pdf
createdAt
companyId
}
documents {
id
fileName
contentType
size
lastModifiedAt
downloadUrl
source
status
}
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
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 {
...TextSpanFragment
}
classification
score
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
...PathConnectionFragment
}
}
}
}
}
}
}
Variables
{"where": CompanyWhereInput}
Response
{
"data": {
"companyAddToMonitoring": {
"success": false,
"company": Company
}
}
}
companyOwnersUpdate
Response
Returns a CompanyPayload!
Arguments
| Name | Description |
|---|---|
where - CustomOwnersInput!
|
Example
Query
mutation CompanyOwnersUpdate($where: CustomOwnersInput!) {
companyOwnersUpdate(where: $where) {
success
company {
id
industries
industriesV2 {
code
description
codeType
}
inception
organisationFormCodes
businessPurposes
signatoryRights
numberOfEmployees {
from
to
}
status {
name
date
isActive
}
isMonitored
isReferenceOnly
tags {
id
name
created
}
automatedRiskLevel {
riskLevel {
riskLevel
label
thresholdScore
}
totalScore
countryScore {
score
matchedValues
}
legalFormScore {
score
matchedValues
}
industryScore {
score
matchedValues
}
pepCountScore {
score
matchedValues
}
sanctionCountScore {
score
matchedValues
}
customRiskFieldsScore {
customRiskFieldId
scoreResult {
score
matchedValues
}
}
timestamp
}
shareholderGraph {
rootId
nodes {
id
indirectSharePercentage {
from
to
}
shareClasses {
shareClass
sharePercentage {
...SharePercentageIntervalFragment
}
}
isBeneficialOwner
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
edges {
parent
child
sharePercentage {
from
to
}
}
}
beneficialOwners {
reasons
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
roles {
roleTitle
period {
from
to
}
isActive
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
shareholders {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
holdings {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
reviews {
id
pdf
createdAt
companyId
}
documents {
id
fileName
contentType
size
lastModifiedAt
downloadUrl
source
status
}
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
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 {
...TextSpanFragment
}
classification
score
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
...PathConnectionFragment
}
}
}
}
}
}
}
Variables
{"where": CustomOwnersInput}
Response
{
"data": {
"companyOwnersUpdate": {
"success": false,
"company": Company
}
}
}
companyRemoveFromMonitoring
Response
Returns a CompanyPayload!
Arguments
| Name | Description |
|---|---|
where - CompanyWhereInput!
|
Example
Query
mutation CompanyRemoveFromMonitoring($where: CompanyWhereInput!) {
companyRemoveFromMonitoring(where: $where) {
success
company {
id
industries
industriesV2 {
code
description
codeType
}
inception
organisationFormCodes
businessPurposes
signatoryRights
numberOfEmployees {
from
to
}
status {
name
date
isActive
}
isMonitored
isReferenceOnly
tags {
id
name
created
}
automatedRiskLevel {
riskLevel {
riskLevel
label
thresholdScore
}
totalScore
countryScore {
score
matchedValues
}
legalFormScore {
score
matchedValues
}
industryScore {
score
matchedValues
}
pepCountScore {
score
matchedValues
}
sanctionCountScore {
score
matchedValues
}
customRiskFieldsScore {
customRiskFieldId
scoreResult {
score
matchedValues
}
}
timestamp
}
shareholderGraph {
rootId
nodes {
id
indirectSharePercentage {
from
to
}
shareClasses {
shareClass
sharePercentage {
...SharePercentageIntervalFragment
}
}
isBeneficialOwner
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
edges {
parent
child
sharePercentage {
from
to
}
}
}
beneficialOwners {
reasons
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
roles {
roleTitle
period {
from
to
}
isActive
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
shareholders {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
holdings {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
reviews {
id
pdf
createdAt
companyId
}
documents {
id
fileName
contentType
size
lastModifiedAt
downloadUrl
source
status
}
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
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 {
...TextSpanFragment
}
classification
score
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
...PathConnectionFragment
}
}
}
}
}
}
}
Variables
{"where": CompanyWhereInput}
Response
{
"data": {
"companyRemoveFromMonitoring": {
"success": false,
"company": Company
}
}
}
companyResetFields
Description
Reset all edits to the given fields for a company.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
where - CompanyResetFieldsInput!
|
Example
Query
mutation CompanyResetFields($where: CompanyResetFieldsInput!) {
companyResetFields(where: $where)
}
Variables
{"where": CompanyResetFieldsInput}
Response
{"data": {"companyResetFields": true}}
companyUpdateBeneficialOwners
Description
Update (add/remove) beneficial owners of a company.
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
where - CompanyUpdateBeneficialOwnersInput!
|
Example
Query
mutation CompanyUpdateBeneficialOwners($where: CompanyUpdateBeneficialOwnersInput!) {
companyUpdateBeneficialOwners(where: $where)
}
Variables
{"where": CompanyUpdateBeneficialOwnersInput}
Response
{"data": {"companyUpdateBeneficialOwners": true}}
customCompanyCreate
Description
Create a custom company.
Response
Returns a CustomCompanyPayload
Arguments
| Name | Description |
|---|---|
where - CustomCompanyCreateInput!
|
Example
Query
mutation CustomCompanyCreate($where: CustomCompanyCreateInput!) {
customCompanyCreate(where: $where) {
success
company {
id
industries
industriesV2 {
code
description
codeType
}
inception
organisationFormCodes
businessPurposes
signatoryRights
numberOfEmployees {
from
to
}
status {
name
date
isActive
}
isMonitored
isReferenceOnly
tags {
id
name
created
}
automatedRiskLevel {
riskLevel {
riskLevel
label
thresholdScore
}
totalScore
countryScore {
score
matchedValues
}
legalFormScore {
score
matchedValues
}
industryScore {
score
matchedValues
}
pepCountScore {
score
matchedValues
}
sanctionCountScore {
score
matchedValues
}
customRiskFieldsScore {
customRiskFieldId
scoreResult {
score
matchedValues
}
}
timestamp
}
shareholderGraph {
rootId
nodes {
id
indirectSharePercentage {
from
to
}
shareClasses {
shareClass
sharePercentage {
...SharePercentageIntervalFragment
}
}
isBeneficialOwner
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
edges {
parent
child
sharePercentage {
from
to
}
}
}
beneficialOwners {
reasons
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
roles {
roleTitle
period {
from
to
}
isActive
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
shareholders {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
holdings {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
reviews {
id
pdf
createdAt
companyId
}
documents {
id
fileName
contentType
size
lastModifiedAt
downloadUrl
source
status
}
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
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 {
...TextSpanFragment
}
classification
score
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
...PathConnectionFragment
}
}
}
}
}
}
}
Variables
{"where": CustomCompanyCreateInput}
Response
{
"data": {
"customCompanyCreate": {
"success": false,
"company": Company
}
}
}
customCompanyDelete
Description
Delete a custom company.
Response
Returns a CustomCompanyPayload!
Arguments
| Name | Description |
|---|---|
where - CustomCompanyWhereInput!
|
Example
Query
mutation CustomCompanyDelete($where: CustomCompanyWhereInput!) {
customCompanyDelete(where: $where) {
success
company {
id
industries
industriesV2 {
code
description
codeType
}
inception
organisationFormCodes
businessPurposes
signatoryRights
numberOfEmployees {
from
to
}
status {
name
date
isActive
}
isMonitored
isReferenceOnly
tags {
id
name
created
}
automatedRiskLevel {
riskLevel {
riskLevel
label
thresholdScore
}
totalScore
countryScore {
score
matchedValues
}
legalFormScore {
score
matchedValues
}
industryScore {
score
matchedValues
}
pepCountScore {
score
matchedValues
}
sanctionCountScore {
score
matchedValues
}
customRiskFieldsScore {
customRiskFieldId
scoreResult {
score
matchedValues
}
}
timestamp
}
shareholderGraph {
rootId
nodes {
id
indirectSharePercentage {
from
to
}
shareClasses {
shareClass
sharePercentage {
...SharePercentageIntervalFragment
}
}
isBeneficialOwner
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
edges {
parent
child
sharePercentage {
from
to
}
}
}
beneficialOwners {
reasons
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
roles {
roleTitle
period {
from
to
}
isActive
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
shareholders {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
holdings {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
reviews {
id
pdf
createdAt
companyId
}
documents {
id
fileName
contentType
size
lastModifiedAt
downloadUrl
source
status
}
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
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 {
...TextSpanFragment
}
classification
score
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
...PathConnectionFragment
}
}
}
}
}
}
}
Variables
{"where": CustomCompanyWhereInput}
Response
{
"data": {
"customCompanyDelete": {
"success": true,
"company": Company
}
}
}
customCompanyUpdate
Description
Update a custom company.
Response
Returns a CustomCompanyPayload
Arguments
| Name | Description |
|---|---|
where - CustomCompanyUpdateInput!
|
Example
Query
mutation CustomCompanyUpdate($where: CustomCompanyUpdateInput!) {
customCompanyUpdate(where: $where) {
success
company {
id
industries
industriesV2 {
code
description
codeType
}
inception
organisationFormCodes
businessPurposes
signatoryRights
numberOfEmployees {
from
to
}
status {
name
date
isActive
}
isMonitored
isReferenceOnly
tags {
id
name
created
}
automatedRiskLevel {
riskLevel {
riskLevel
label
thresholdScore
}
totalScore
countryScore {
score
matchedValues
}
legalFormScore {
score
matchedValues
}
industryScore {
score
matchedValues
}
pepCountScore {
score
matchedValues
}
sanctionCountScore {
score
matchedValues
}
customRiskFieldsScore {
customRiskFieldId
scoreResult {
score
matchedValues
}
}
timestamp
}
shareholderGraph {
rootId
nodes {
id
indirectSharePercentage {
from
to
}
shareClasses {
shareClass
sharePercentage {
...SharePercentageIntervalFragment
}
}
isBeneficialOwner
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
edges {
parent
child
sharePercentage {
from
to
}
}
}
beneficialOwners {
reasons
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
roles {
roleTitle
period {
from
to
}
isActive
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
shareholders {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
holdings {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
reviews {
id
pdf
createdAt
companyId
}
documents {
id
fileName
contentType
size
lastModifiedAt
downloadUrl
source
status
}
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
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 {
...TextSpanFragment
}
classification
score
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
...PathConnectionFragment
}
}
}
}
}
}
}
Variables
{"where": CustomCompanyUpdateInput}
Response
{
"data": {
"customCompanyUpdate": {
"success": false,
"company": Company
}
}
}
customPersonCreate
Description
Create a custom person.
Response
Returns a CustomPersonPayload
Arguments
| Name | Description |
|---|---|
where - CustomPersonCreateInput!
|
Example
Query
mutation CustomPersonCreate($where: CustomPersonCreateInput!) {
customPersonCreate(where: $where) {
success
person {
id
gender
birthDate
birthYear
pep
pepInfo {
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
description
details
startDate
endDate
since
}
externalUrls
}
confirmedPepStatus
confirmedRcaStatus
hits {
name
aliases
dateOfBirth {
dayOfMonth
month
year
}
countries {
code
name
}
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
...PepRoleFragment
}
externalUrls
}
custom
externalUrls
confirmedMatch
}
}
beneficialOwnerships {
reasons
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
roles {
roleTitle
period {
from
to
}
isActive
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
holdings {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
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 {
...TextSpanFragment
}
classification
score
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
...PathConnectionFragment
}
}
}
}
}
}
}
Variables
{"where": CustomPersonCreateInput}
Response
{
"data": {
"customPersonCreate": {
"success": true,
"person": BusinessPerson
}
}
}
customPersonDelete
Description
Delete a custom person.
Response
Returns a CustomPersonPayload!
Arguments
| Name | Description |
|---|---|
where - BusinessPersonWhereInput!
|
Example
Query
mutation CustomPersonDelete($where: BusinessPersonWhereInput!) {
customPersonDelete(where: $where) {
success
person {
id
gender
birthDate
birthYear
pep
pepInfo {
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
description
details
startDate
endDate
since
}
externalUrls
}
confirmedPepStatus
confirmedRcaStatus
hits {
name
aliases
dateOfBirth {
dayOfMonth
month
year
}
countries {
code
name
}
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
...PepRoleFragment
}
externalUrls
}
custom
externalUrls
confirmedMatch
}
}
beneficialOwnerships {
reasons
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
roles {
roleTitle
period {
from
to
}
isActive
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
holdings {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
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 {
...TextSpanFragment
}
classification
score
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
...PathConnectionFragment
}
}
}
}
}
}
}
Variables
{"where": BusinessPersonWhereInput}
Response
{
"data": {
"customPersonDelete": {
"success": true,
"person": BusinessPerson
}
}
}
customPersonEdit
Description
Edit the details of a custom person.
Response
Returns a CustomPersonPayload
Arguments
| Name | Description |
|---|---|
where - CustomPersonEditInput!
|
Example
Query
mutation CustomPersonEdit($where: CustomPersonEditInput!) {
customPersonEdit(where: $where) {
success
person {
id
gender
birthDate
birthYear
pep
pepInfo {
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
description
details
startDate
endDate
since
}
externalUrls
}
confirmedPepStatus
confirmedRcaStatus
hits {
name
aliases
dateOfBirth {
dayOfMonth
month
year
}
countries {
code
name
}
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
...PepRoleFragment
}
externalUrls
}
custom
externalUrls
confirmedMatch
}
}
beneficialOwnerships {
reasons
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
roles {
roleTitle
period {
from
to
}
isActive
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
holdings {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
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 {
...TextSpanFragment
}
classification
score
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
...PathConnectionFragment
}
}
}
}
}
}
}
Variables
{"where": CustomPersonEditInput}
Response
{
"data": {
"customPersonEdit": {
"success": true,
"person": BusinessPerson
}
}
}
privatePersonAddToMonitoring
Response
Returns a PrivatePersonPayload!
Arguments
| Name | Description |
|---|---|
where - PrivatePersonWhereInput!
|
Example
Query
mutation PrivatePersonAddToMonitoring($where: PrivatePersonWhereInput!) {
privatePersonAddToMonitoring(where: $where) {
success
person {
id
name
gender
birthDate
birthYear
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
pep
pepInfo {
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
description
details
startDate
endDate
since
}
externalUrls
}
confirmedPepStatus
confirmedRcaStatus
hits {
name
aliases
dateOfBirth {
dayOfMonth
month
year
}
countries {
code
name
}
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
...PepRoleFragment
}
externalUrls
}
custom
externalUrls
confirmedMatch
}
}
tags {
id
name
created
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
amsCount
isMonitored
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
...PathConnectionFragment
}
}
}
}
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 {
...TextSpanFragment
}
classification
score
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
}
}
}
Variables
{"where": PrivatePersonWhereInput}
Response
{
"data": {
"privatePersonAddToMonitoring": {
"success": false,
"person": PrivatePerson
}
}
}
privatePersonCreate
Response
Returns a PrivatePersonPayload!
Arguments
| Name | Description |
|---|---|
where - PrivatePersonCreateInput!
|
Example
Query
mutation PrivatePersonCreate($where: PrivatePersonCreateInput!) {
privatePersonCreate(where: $where) {
success
person {
id
name
gender
birthDate
birthYear
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
pep
pepInfo {
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
description
details
startDate
endDate
since
}
externalUrls
}
confirmedPepStatus
confirmedRcaStatus
hits {
name
aliases
dateOfBirth {
dayOfMonth
month
year
}
countries {
code
name
}
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
...PepRoleFragment
}
externalUrls
}
custom
externalUrls
confirmedMatch
}
}
tags {
id
name
created
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
amsCount
isMonitored
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
...PathConnectionFragment
}
}
}
}
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 {
...TextSpanFragment
}
classification
score
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
}
}
}
Variables
{"where": PrivatePersonCreateInput}
Response
{
"data": {
"privatePersonCreate": {
"success": false,
"person": PrivatePerson
}
}
}
privatePersonCreateNoEnrich
Description
Creates a private person without enriching their data with data from registries. Use together with privatePersonRegistrySearch to verify registry data before creating.
Response
Returns a PrivatePersonPayload!
Arguments
| Name | Description |
|---|---|
where - PrivatePersonCreateInput!
|
Example
Query
mutation PrivatePersonCreateNoEnrich($where: PrivatePersonCreateInput!) {
privatePersonCreateNoEnrich(where: $where) {
success
person {
id
name
gender
birthDate
birthYear
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
pep
pepInfo {
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
description
details
startDate
endDate
since
}
externalUrls
}
confirmedPepStatus
confirmedRcaStatus
hits {
name
aliases
dateOfBirth {
dayOfMonth
month
year
}
countries {
code
name
}
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
...PepRoleFragment
}
externalUrls
}
custom
externalUrls
confirmedMatch
}
}
tags {
id
name
created
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
amsCount
isMonitored
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
...PathConnectionFragment
}
}
}
}
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 {
...TextSpanFragment
}
classification
score
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
}
}
}
Variables
{"where": PrivatePersonCreateInput}
Response
{
"data": {
"privatePersonCreateNoEnrich": {
"success": false,
"person": PrivatePerson
}
}
}
privatePersonDelete
Response
Returns a PrivatePersonPayload!
Arguments
| Name | Description |
|---|---|
where - PrivatePersonWhereInput!
|
Example
Query
mutation PrivatePersonDelete($where: PrivatePersonWhereInput!) {
privatePersonDelete(where: $where) {
success
person {
id
name
gender
birthDate
birthYear
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
pep
pepInfo {
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
description
details
startDate
endDate
since
}
externalUrls
}
confirmedPepStatus
confirmedRcaStatus
hits {
name
aliases
dateOfBirth {
dayOfMonth
month
year
}
countries {
code
name
}
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
...PepRoleFragment
}
externalUrls
}
custom
externalUrls
confirmedMatch
}
}
tags {
id
name
created
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
amsCount
isMonitored
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
...PathConnectionFragment
}
}
}
}
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 {
...TextSpanFragment
}
classification
score
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
}
}
}
Variables
{"where": PrivatePersonWhereInput}
Response
{
"data": {
"privatePersonDelete": {
"success": false,
"person": PrivatePerson
}
}
}
privatePersonRemoveFromMonitoring
Response
Returns a PrivatePersonPayload!
Arguments
| Name | Description |
|---|---|
where - PrivatePersonWhereInput!
|
Example
Query
mutation PrivatePersonRemoveFromMonitoring($where: PrivatePersonWhereInput!) {
privatePersonRemoveFromMonitoring(where: $where) {
success
person {
id
name
gender
birthDate
birthYear
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
pep
pepInfo {
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
description
details
startDate
endDate
since
}
externalUrls
}
confirmedPepStatus
confirmedRcaStatus
hits {
name
aliases
dateOfBirth {
dayOfMonth
month
year
}
countries {
code
name
}
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
...PepRoleFragment
}
externalUrls
}
custom
externalUrls
confirmedMatch
}
}
tags {
id
name
created
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
amsCount
isMonitored
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
...PathConnectionFragment
}
}
}
}
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 {
...TextSpanFragment
}
classification
score
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
}
}
}
Variables
{"where": PrivatePersonWhereInput}
Response
{
"data": {
"privatePersonRemoveFromMonitoring": {
"success": false,
"person": PrivatePerson
}
}
}
privatePersonUpdate
Response
Returns a PrivatePersonPayload!
Arguments
| Name | Description |
|---|---|
where - PrivatePersonUpdateInput!
|
Example
Query
mutation PrivatePersonUpdate($where: PrivatePersonUpdateInput!) {
privatePersonUpdate(where: $where) {
success
person {
id
name
gender
birthDate
birthYear
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
pep
pepInfo {
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
description
details
startDate
endDate
since
}
externalUrls
}
confirmedPepStatus
confirmedRcaStatus
hits {
name
aliases
dateOfBirth {
dayOfMonth
month
year
}
countries {
code
name
}
pep
roles {
description
details
startDate
endDate
since
}
rca
relations {
description
name
birthDate
roles {
...PepRoleFragment
}
externalUrls
}
custom
externalUrls
confirmedMatch
}
}
tags {
id
name
created
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
amsCount
isMonitored
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
...PathConnectionFragment
}
}
}
}
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 {
...TextSpanFragment
}
classification
score
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
}
}
}
Variables
{"where": PrivatePersonUpdateInput}
Response
{
"data": {
"privatePersonUpdate": {
"success": false,
"person": PrivatePerson
}
}
}
privatePersonsAddToMonitoring
Response
Returns a PersonBulkPayloadResource!
Arguments
| Name | Description |
|---|---|
where - PrivatePersonsWhereInput!
|
Example
Query
mutation PrivatePersonsAddToMonitoring($where: PrivatePersonsWhereInput!) {
privatePersonsAddToMonitoring(where: $where) {
failed
allSuccessful
}
}
Variables
{"where": PrivatePersonsWhereInput}
Response
{
"data": {
"privatePersonsAddToMonitoring": {
"failed": [PrivatePersonId],
"allSuccessful": false
}
}
}
reviewCompanyCreate
Response
Returns a ReviewPayload!
Arguments
| Name | Description |
|---|---|
where - CompanyWhereInput!
|
Example
Query
mutation ReviewCompanyCreate($where: CompanyWhereInput!) {
reviewCompanyCreate(where: $where) {
success
risk
id
context {
triggerId
relation {
edges {
kind
explanation
custom
node {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
explanations
entity {
... on Company {
id
industries
industriesV2 {
code
description
codeType
}
inception
organisationFormCodes
businessPurposes
signatoryRights
numberOfEmployees {
from
to
}
status {
name
date
isActive
}
isMonitored
isReferenceOnly
tags {
id
name
created
}
automatedRiskLevel {
riskLevel {
...RiskLevelSettingFragment
}
totalScore
countryScore {
...RiskScoreResultFragment
}
legalFormScore {
...RiskScoreResultFragment
}
industryScore {
...RiskScoreResultFragment
}
pepCountScore {
...RiskScoreResultFragment
}
sanctionCountScore {
...RiskScoreResultFragment
}
customRiskFieldsScore {
...CustomRiskFieldScoreFragment
}
timestamp
}
shareholderGraph {
rootId
nodes {
...ShareholderGraphNodeFragment
}
edges {
...ShareholderGraphEdgeFragment
}
}
beneficialOwners {
reasons
editMetadata {
...EditMetadataFragment
}
entity {
...EntityLikeFragment
}
}
roles {
roleTitle
period {
...RolePeriodFragment
}
isActive
entity {
...EntityLikeFragment
}
}
shareholders {
shareClasses {
...ShareClassFragment
}
totalSharePercentage {
...SharePercentageIntervalFragment
}
editMetadata {
...EditMetadataFragment
}
entity {
...EntityLikeFragment
}
}
holdings {
shareClasses {
...ShareClassFragment
}
totalSharePercentage {
...SharePercentageIntervalFragment
}
editMetadata {
...EditMetadataFragment
}
entity {
...EntityLikeFragment
}
}
reviews {
id
pdf
createdAt
companyId
}
documents {
id
fileName
contentType
size
lastModifiedAt
downloadUrl
source
status
}
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
... on BusinessPerson {
id
gender
birthDate
birthYear
pep
pepInfo {
pep
roles {
...PepRoleFragment
}
rca
relations {
...PepRelationFragment
}
confirmedPepStatus
confirmedRcaStatus
hits {
...PepHitFragment
}
}
beneficialOwnerships {
reasons
editMetadata {
...EditMetadataFragment
}
entity {
...EntityLikeFragment
}
}
roles {
roleTitle
period {
...RolePeriodFragment
}
isActive
entity {
...EntityLikeFragment
}
}
holdings {
shareClasses {
...ShareClassFragment
}
totalSharePercentage {
...SharePercentageIntervalFragment
}
editMetadata {
...EditMetadataFragment
}
entity {
...EntityLikeFragment
}
}
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
... on CustomBusinessPerson {
id
birthDate
birthYear
pep
pepInfo {
pep
roles {
...PepRoleFragment
}
rca
relations {
...PepRelationFragment
}
confirmedPepStatus
confirmedRcaStatus
hits {
...PepHitFragment
}
}
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
... on PrivatePerson {
id
name
gender
birthDate
birthYear
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
pep
pepInfo {
pep
roles {
...PepRoleFragment
}
rca
relations {
...PepRelationFragment
}
confirmedPepStatus
confirmedRcaStatus
hits {
...PepHitFragment
}
}
tags {
id
name
created
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
amsCount
isMonitored
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
}
}
}
}
}
Variables
{"where": CompanyWhereInput}
Response
{
"data": {
"reviewCompanyCreate": {
"success": false,
"risk": "HIGH",
"id": 4,
"context": ReviewContext
}
}
}
reviewTriggerEventGenerate
Description
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.
Response
Returns a CompanyPayload!
Arguments
| Name | Description |
|---|---|
where - CompanyWhereInput!
|
Example
Query
mutation ReviewTriggerEventGenerate($where: CompanyWhereInput!) {
reviewTriggerEventGenerate(where: $where) {
success
company {
id
industries
industriesV2 {
code
description
codeType
}
inception
organisationFormCodes
businessPurposes
signatoryRights
numberOfEmployees {
from
to
}
status {
name
date
isActive
}
isMonitored
isReferenceOnly
tags {
id
name
created
}
automatedRiskLevel {
riskLevel {
riskLevel
label
thresholdScore
}
totalScore
countryScore {
score
matchedValues
}
legalFormScore {
score
matchedValues
}
industryScore {
score
matchedValues
}
pepCountScore {
score
matchedValues
}
sanctionCountScore {
score
matchedValues
}
customRiskFieldsScore {
customRiskFieldId
scoreResult {
score
matchedValues
}
}
timestamp
}
shareholderGraph {
rootId
nodes {
id
indirectSharePercentage {
from
to
}
shareClasses {
shareClass
sharePercentage {
...SharePercentageIntervalFragment
}
}
isBeneficialOwner
entity {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
}
edges {
parent
child
sharePercentage {
from
to
}
}
}
beneficialOwners {
reasons
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
roles {
roleTitle
period {
from
to
}
isActive
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
shareholders {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
holdings {
shareClasses {
shareClass
sharePercentage {
from
to
}
}
totalSharePercentage {
from
to
}
editMetadata {
editKind
updatedAt
editedBy {
id
name
avatar
email
accountKind
}
comment
}
entity {
name
address {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
...CountryFragment
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
...CountryFragment
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
...EntityConnectionEdgeFragment
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
...SanctionFragment
}
}
amsCount
ams {
id
entityId
published
publisher
title
summary
bodyText
url
clusteredEvents {
...ClusteredEventFragment
}
authors
images
entityMentions {
...AmsEntityMentionFragment
}
topicMentions {
...AmsTopicMentionsFragment
}
eventKind
createdBy {
...SimpleUserFragment
}
behindPaywall
}
flags
riskSignals {
signals {
...RiskSignalFragment
}
}
}
}
reviews {
id
pdf
createdAt
companyId
}
documents {
id
fileName
contentType
size
lastModifiedAt
downloadUrl
source
status
}
name
address {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
addresses {
country {
code
name
}
addressLine
city
zipCode
addressKind
}
countries {
relationship
country {
code
name
}
}
identifiers {
value
country
kind
description
}
relationships {
edges {
kind
explanation
custom
node {
name
address {
...AddressFragment
}
addresses {
...AddressFragment
}
countries {
...CountryContextFragment
}
identifiers {
...EntityIdentifierFragment
}
relationships {
...EntityConnectionFragment
}
sanctioned
sanctionInfo {
...SanctionInfoFragment
}
amsCount
ams {
...AmsEventFragment
}
flags
riskSignals {
...RiskSignalsFragment
}
}
details {
... on OwnershipRelationDetails {
...OwnershipRelationDetailsFragment
}
}
}
}
sanctioned
sanctionInfo {
sanctioned
sanctions {
sanctionedBy
sourceReference
sanctionedSince
program
sourceUrl
confirmedMatch
}
}
amsCount
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 {
...TextSpanFragment
}
classification
score
}
field
amsClassification
}
topicMentions {
topic
mentions
}
eventKind
createdBy {
id
name
avatar
email
accountKind
}
behindPaywall
}
flags
riskSignals {
signals {
name
riskFactors {
name
dateTime
paths {
...PathConnectionFragment
}
}
}
}
}
}
}
Variables
{"where": CompanyWhereInput}
Response
{
"data": {
"reviewTriggerEventGenerate": {
"success": false,
"company": Company
}
}
}
sendForm
Description
Send a customer facing form to an email.
Response
Returns a SendFormPayload!
Arguments
| Name | Description |
|---|---|
where - SendFormInput!
|
Example
Query
mutation SendForm($where: SendFormInput!) {
sendForm(where: $where) {
success
formInstanceId
}
}
Variables
{"where": SendFormInput}
Response
{
"data": {
"sendForm": {
"success": false,
"formInstanceId": FormInstanceId
}
}
}
Types
AccessToken
Address
Fields
| Field Name | Description |
|---|---|
country - Country
|
|
addressLine - String
|
|
city - String
|
|
zipCode - String
|
|
addressKind - AddressKind
|
Example
{
"country": Country,
"addressLine": "abc123",
"city": "abc123",
"zipCode": "xyz789",
"addressKind": "POSTAL"
}
AddressInput
Fields
| Input Field | Description |
|---|---|
addressLine - String
|
|
zipCode - String
|
|
city - String
|
|
country - CountryCode
|
Example
{
"addressLine": "xyz789",
"zipCode": "abc123",
"city": "xyz789",
"country": "US"
}
AddressKind
Description
The kind of address.
Values
| Enum Value | Description |
|---|---|
|
|
A postal address. |
|
|
A registered address. |
|
|
A trading address. |
|
|
A visiting address. |
Example
"POSTAL"
Alert
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
kind - DatasetKind!
|
|
insertedAt - DateTime!
|
When the alert was made available for APP/API |
computedAt - DateTime!
|
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!
|
|
resolvedBy - SimpleUser
|
If the alert state is RESOLVED, who resolved it |
resolvedAt - DateTime
|
If the alert state is RESOLVED, when it was resolved |
Example
{
"id": "4",
"kind": "PEP",
"insertedAt": "2007-12-03T10:15:30Z",
"computedAt": "2007-12-03T10:15:30Z",
"state": "RESOLVED",
"resolvedBy": SimpleUser,
"resolvedAt": "2007-12-03T10:15:30Z"
}
AlertConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
|
edges - [AlertConnectionEdge!]!
|
Example
{
"pageInfo": PageInfo,
"edges": [AlertConnectionEdge]
}
AlertConnectionEdge
Fields
| Field Name | Description |
|---|---|
node - Alert!
|
|
monitoredEntity - MonitoredEntityLike!
|
Example
{
"node": Alert,
"monitoredEntity": MonitoredEntityLike
}
AlertId
Description
A generic identifier for an alert
Example
AlertId
AlertPageInfoInput
AlertState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"RESOLVED"
AlertsWhereInput
Description
Specify filters and pagination when querying alerts.
Fields
| Input Field | Description |
|---|---|
entity - ID
|
Specify which entity to get alerts for, defaults to all. |
kinds - [DatasetKind!]
|
Specify which change kinds to get alerts for, defaults to all. |
states - [AlertState!]
|
Specify which alert states to get alerts for, defaults to all. |
page - AlertPageInfoInput
|
|
period - TimespanInput
|
Specify the time window to get alerts for. Uses the computedAt field on the alerts. |
entityKind - EntityKind
|
Specify the entity kind to get alerts for. Defaults to COMPANY. |
Example
{
"entity": "4",
"kinds": ["PEP"],
"states": ["RESOLVED"],
"page": AlertPageInfoInput,
"period": TimespanInput,
"entityKind": "COMPANY"
}
AmsClassificationKind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"AFFECTED"
AmsEntityMention
Fields
| Field Name | Description |
|---|---|
text - String!
|
|
span - TextSpan!
|
|
entityType - NamedEntityKind!
|
|
containingPhrase - String!
|
|
containingPhraseSpan - TextSpan!
|
|
amsPredictions - [AmsPrediction!]!
|
|
field - String!
|
|
amsClassification - AmsClassificationKind
|
Example
{
"text": "xyz789",
"span": TextSpan,
"entityType": "COMPANY",
"containingPhrase": "xyz789",
"containingPhraseSpan": TextSpan,
"amsPredictions": [AmsPrediction],
"field": "xyz789",
"amsClassification": "AFFECTED"
}
AmsEvent
Fields
| Field Name | Description |
|---|---|
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!
|
Example
{
"id": "4",
"entityId": "4",
"published": ISODateTime,
"publisher": "abc123",
"title": "abc123",
"summary": "abc123",
"bodyText": "xyz789",
"url": "xyz789",
"clusteredEvents": [ClusteredEvent],
"authors": ["abc123"],
"images": ["xyz789"],
"entityMentions": [AmsEntityMention],
"topicMentions": [AmsTopicMentions],
"eventKind": "DOW_JONES",
"createdBy": SimpleUser,
"behindPaywall": false
}
AmsEventKind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DOW_JONES"
AmsPrediction
Fields
| Field Name | Description |
|---|---|
context - TextSpan!
|
|
classification - AmsClassificationKind!
|
|
score - Float!
|
Example
{
"context": TextSpan,
"classification": "AFFECTED",
"score": 987.65
}
AmsTopicMentions
Fields
| Field Name | Description |
|---|---|
topic - String!
|
|
mentions - [String!]!
|
Example
{
"topic": "abc123",
"mentions": ["xyz789"]
}
Base64EncodedFile
Description
An representation of a Base64EncodedFile.
Example
Base64EncodedFile
BeneficialOwner
Description
An object representing a beneficial owner of a company.
Fields
| Field Name | Description |
|---|---|
reasons - [BeneficialOwnerReasonKind!]!
|
The reasons for the entity being considered a beneficial owner. |
editMetadata - EditMetadata
|
Metadata about edits made to this beneficial ownership relationship. |
entity - EntityLike!
|
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. |
Example
{
"reasons": ["OWNERSHIP"],
"editMetadata": EditMetadata,
"entity": EntityLike
}
BeneficialOwnerChange
Description
Change in beneficial ownership.
Fields
| Field Name | Description |
|---|---|
toValue - [BeneficialOwner!]!
|
|
fromValue - [BeneficialOwner!]!
|
Example
{
"toValue": [BeneficialOwner],
"fromValue": [BeneficialOwner]
}
BeneficialOwnerReasonKind
Description
Represents the reason for an entity being considered a beneficial owner.
Values
| Enum Value | Description |
|---|---|
|
|
The entity is considered a beneficial owner due to owning a significant amount of shares in the company, either directly or indirectly. |
|
|
The same as OWNERSHIP, but also including the assumed family's shares. |
|
|
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. |
|
|
The same as PATH, but also including the assumed family's shares. |
|
|
The entity is considered a beneficial owner due to being part of an official beneficial owner register. |
|
|
The entity is considered a beneficial owner due to a role it holds in the company, or in a company with siginficant control. |
|
|
UK only. The ultimate person with significant control. This is computed by traversing PSCs until an entity with no PSCs is reached. |
|
|
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. |
|
|
The same as VOTING_POWER, but also including the assumed family's voting power. |
Example
"OWNERSHIP"
Boolean
Description
The Boolean scalar type represents true or false.
BusinessEntityIdInput
Description
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.
Example
BusinessEntityIdInput
BusinessPerson
Description
A resource representing a business person.
Fields
| Field Name | Description |
|---|---|
id - BusinessPersonId!
|
|
gender - Gender
|
The gender of the person. |
birthDate - Date
|
The birth date of the person. |
birthYear - Year
|
The birth year of the person. |
pep - Boolean!
|
Whether the person is a PEP or not. Use the pepInfo field instead.
|
pepInfo - PepInfo!
|
PEP information. |
beneficialOwnerships - [BeneficialOwner!]!
|
The beneficial ownerships that the person holds in companies. |
Arguments
|
|
roles - [Role!]!
|
The roles that the person holds in companies. |
holdings - [Ownership!]!
|
The person's direct holdings, i.e., companies owned by this person. |
Arguments
|
|
name - String!
|
Entity name. |
address - [Address!]!
|
The postal address of the Entity. Use the addresses field instead for a complete list of available addresses.
|
addresses - [Address!]!
|
The available addresses of the entity. |
countries - [CountryContext!]!
|
The countries for the Entity. |
identifiers - [EntityIdentifier!]!
|
The official identifiers for this Entity. Since an Entity can have several ids (even within the same country), this is a list. |
relationships - EntityConnection!
|
Related entities (e.g. persons, companies) for this entity. Can be UBOs, board members, etc. |
Arguments
|
|
sanctioned - Boolean!
|
Whether this entity is sanctioned. Use the sanctionInfo field instead
|
sanctionInfo - SanctionInfo!
|
Sanction information related to this entity. |
amsCount - Int!
|
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. Use the ams field instead
|
ams - [AmsEvent!]!
|
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. |
Arguments
|
|
flags - [FlagKind!]!
|
Flagged events found for this entity. |
riskSignals - RiskSignals!
|
Risk signals. Currently there is only one possible risk signal, 'flags', which is created if we find flags of negative severity. |
Example
{
"id": BusinessPersonId,
"gender": "FEMALE",
"birthDate": "2007-12-03",
"birthYear": Year,
"pep": true,
"pepInfo": PepInfo,
"beneficialOwnerships": [BeneficialOwner],
"roles": [Role],
"holdings": [Ownership],
"name": "xyz789",
"address": [Address],
"addresses": [Address],
"countries": [CountryContext],
"identifiers": [EntityIdentifier],
"relationships": EntityConnection,
"sanctioned": true,
"sanctionInfo": SanctionInfo,
"amsCount": 123,
"ams": [AmsEvent],
"flags": ["AUDITOR_NOTES"],
"riskSignals": RiskSignals
}
BusinessPersonId
Description
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.
Example
BusinessPersonId
BusinessPersonOwnershipInput
Description
The data input for updating company ownership.
Fields
| Input Field | Description |
|---|---|
id - BusinessPersonId!
|
|
ownership - Float
|
The ownership percentage (0-100) |
comment - String
|
|
beneficialOwner - Boolean
|
Example
{
"id": BusinessPersonId,
"ownership": 123.45,
"comment": "abc123",
"beneficialOwner": true
}
BusinessPersonSearchConnection
Fields
| Field Name | Description |
|---|---|
edges - [BusinessPersonSearchConnectionEdge!]!
|
Example
{"edges": [BusinessPersonSearchConnectionEdge]}
BusinessPersonSearchConnectionEdge
Fields
| Field Name | Description |
|---|---|
node - BusinessPerson!
|
Example
{"node": BusinessPerson}
BusinessPersonWhereInput
Fields
| Input Field | Description |
|---|---|
id - BusinessPersonId!
|
Example
{"id": BusinessPersonId}
ChangeLike
Description
An interface type of monitoring change kinds.
Fields
| Field Name | Description |
|---|---|
kind - DatasetKind!
|
Change kind, determines the data structure of the change. |
Possible Types
| ChangeLike Types |
|---|
Example
{"kind": "PEP"}
ClusteredEvent
CompaniesWhereInput
Description
Input to lookup companies by their internal Strise ID.
Fields
| Input Field | Description |
|---|---|
ids - [CompanyId!]!
|
Example
{"ids": [CompanyId]}
Company
Description
A resource representing a registered company.
Fields
| Field Name | Description |
|---|---|
id - CompanyId!
|
|
industries - [String!]!
|
Use industriesV2 instead |
industriesV2 - [ConnectIndustryCode!]!
|
|
inception - DateTime
|
|
organisationFormCodes - [String!]!
|
|
businessPurposes - [String!]!
|
|
signatoryRights - String
|
|
numberOfEmployees - EmployeeCountInterval
|
|
status - ConnectCompanyStatus
|
|
isMonitored - Boolean!
|
Whether this company is monitored or not. |
isReferenceOnly - 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. |
tags - [Tag!]!
|
Tags added to the company. |
automatedRiskLevel - RiskCalculationResult
|
Calculated risk level for the company. Based on team settings |
shareholderGraph - ShareholderGraph
|
The company's shareholder graph |
Arguments
|
|
beneficialOwners - [BeneficialOwner!]!
|
The company's beneficial owners |
Arguments
|
|
roles - [Role!]!
|
The company's roles |
shareholders - [Ownership!]!
|
The company's direct shareholders. |
Arguments
|
|
holdings - [Ownership!]!
|
The company's direct holdings, i.e., companies owned by this company. |
Arguments
|
|
reviews - [Review!]!
|
Reviews created on this company. |
documents - [Document!]!
|
List documents related to the company. |
name - String!
|
Entity name. |
address - [Address!]!
|
The postal address of the Entity. Use the addresses field instead for a complete list of available addresses.
|
addresses - [Address!]!
|
The available addresses of the entity. |
countries - [CountryContext!]!
|
The countries for the Entity. |
identifiers - [EntityIdentifier!]!
|
The official identifiers for this Entity. Since an Entity can have several ids (even within the same country), this is a list. |
relationships - EntityConnection!
|
Related entities (e.g. persons, companies) for this entity. Can be UBOs, board members, etc. |
Arguments
|
|
sanctioned - Boolean!
|
Whether this entity is sanctioned. Use the sanctionInfo field instead
|
sanctionInfo - SanctionInfo!
|
Sanction information related to this entity. |
amsCount - Int!
|
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. Use the ams field instead
|
ams - [AmsEvent!]!
|
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. |
Arguments
|
|
flags - [FlagKind!]!
|
Flagged events found for this entity. |
riskSignals - RiskSignals!
|
Risk signals. Currently there is only one possible risk signal, 'flags', which is created if we find flags of negative severity. |
Example
{
"id": CompanyId,
"industries": ["xyz789"],
"industriesV2": [ConnectIndustryCode],
"inception": "2007-12-03T10:15:30Z",
"organisationFormCodes": ["abc123"],
"businessPurposes": ["xyz789"],
"signatoryRights": "xyz789",
"numberOfEmployees": EmployeeCountInterval,
"status": ConnectCompanyStatus,
"isMonitored": false,
"isReferenceOnly": false,
"tags": [Tag],
"automatedRiskLevel": RiskCalculationResult,
"shareholderGraph": ShareholderGraph,
"beneficialOwners": [BeneficialOwner],
"roles": [Role],
"shareholders": [Ownership],
"holdings": [Ownership],
"reviews": [Review],
"documents": [Document],
"name": "abc123",
"address": [Address],
"addresses": [Address],
"countries": [CountryContext],
"identifiers": [EntityIdentifier],
"relationships": EntityConnection,
"sanctioned": false,
"sanctionInfo": SanctionInfo,
"amsCount": 987,
"ams": [AmsEvent],
"flags": ["AUDITOR_NOTES"],
"riskSignals": RiskSignals
}
CompanyBulkPayloadResource
Description
Response for bulk adding companies to monitoring.
Fields
| Field Name | Description |
|---|---|
failed - [CompanyId!]!
|
|
allSuccessful - Boolean!
|
Example
{"failed": [CompanyId], "allSuccessful": true}
CompanyCustomBeneficialOwnerInput
Description
The data input for an edited company beneficial owner.
Fields
| Input Field | Description |
|---|---|
ownerId - BusinessEntityIdInput!
|
|
isBeneficialOwner - Boolean!
|
|
comment - String
|
Example
{
"ownerId": BusinessEntityIdInput,
"isBeneficialOwner": true,
"comment": "xyz789"
}
CompanyId
Description
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.
Example
CompanyId
CompanyIdentifierSearchInput
Description
Input to lookup companies by registration number.
Fields
| Input Field | Description |
|---|---|
identifiers - [String!]!
|
|
country - CountryCode!
|
Example
{
"identifiers": ["abc123"],
"country": "US"
}
CompanyNameSearchInput
Description
A filter for looking up a company by name.
Fields
| Input Field | Description |
|---|---|
query - String!
|
The query string to search for. |
country - CountryCode
|
Example
{
"query": "abc123",
"country": "US"
}
CompanyOwnershipInput
Description
The data input for updating company ownership.
Fields
| Input Field | Description |
|---|---|
id - CompanyId!
|
|
ownership - Float
|
|
comment - String
|
|
beneficialOwner - Boolean
|
Example
{
"id": CompanyId,
"ownership": 123.45,
"comment": "abc123",
"beneficialOwner": false
}
CompanyPayload
CompanyPepChange
Description
Change in pep screening of a company (i.e. for persons related to the company).
Fields
| Field Name | Description |
|---|---|
pepChanges - [PepChange!]!
|
|
kind - DatasetKind!
|
Change kind, determines the data structure of the change. |
Example
{"pepChanges": [PepChange], "kind": "PEP"}
CompanyRelationsChange
Description
Change in relations.
Fields
| Field Name | Description |
|---|---|
roleChange - RoleChange!
|
|
beneficialOwnerChange - BeneficialOwnerChange!
|
|
ownershipChange - OwnershipChange!
|
|
kind - DatasetKind!
|
Change kind, determines the data structure of the change. |
Example
{
"roleChange": RoleChange,
"beneficialOwnerChange": BeneficialOwnerChange,
"ownershipChange": OwnershipChange,
"kind": "PEP"
}
CompanyResetFieldKindInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BENEFICIAL_OWNERS"
CompanyResetFieldsInput
Description
The data input for resetting edits for a company on the given fields.
Fields
| Input Field | Description |
|---|---|
company - CompanyId!
|
|
fields - [CompanyResetFieldKindInput!]!
|
The fields to reset edits for. |
Example
{"company": CompanyId, "fields": ["BENEFICIAL_OWNERS"]}
CompanyReviewTriggerEvent
Fields
| Field Name | Description |
|---|---|
company - CompanyId!
|
The company for which the review was triggered. |
relations - EntityConnection!
|
Related entities relevant for this event. |
id - ID!
|
The ID of the review trigger event. |
triggeredAt - DateTime!
|
A timestamp of when the review was triggered. |
statements - [ReviewTriggerStatementKind!]!
|
The statements that make up the trigger. These are the things that have changed since the last review was performed. |
Example
{
"company": CompanyId,
"relations": EntityConnection,
"id": "4",
"triggeredAt": "2007-12-03T10:15:30Z",
"statements": ["BENEFICIAL_OWNERS_CHANGE"]
}
CompanyReviewTriggerEventWhereInput
Description
Input to lookup company review trigger events by entity ID and time interval.
Fields
| Input Field | Description |
|---|---|
company - CompanyId!
|
|
from - DateTime
|
|
to - DateTime
|
Example
{
"company": CompanyId,
"from": "2007-12-03T10:15:30Z",
"to": "2007-12-03T10:15:30Z"
}
CompanySanctionChange
Description
Change in sanction screening of a company (i.e. for the company itself and companies and persons related to the company).
Fields
| Field Name | Description |
|---|---|
sanctionChanges - [SanctionChange!]!
|
|
kind - DatasetKind!
|
Change kind, determines the data structure of the change. |
Example
{"sanctionChanges": [SanctionChange], "kind": "PEP"}
CompanySearchConnection
Fields
| Field Name | Description |
|---|---|
edges - [CompanySearchConnectionEdge!]!
|
Example
{"edges": [CompanySearchConnectionEdge]}
CompanySearchConnectionEdge
Fields
| Field Name | Description |
|---|---|
node - Company!
|
Example
{"node": Company}
CompanyUpdateBeneficialOwnersInput
Description
The data input for updating company beneficial owners.
Fields
| Input Field | Description |
|---|---|
company - CompanyId!
|
|
beneficialOwners - [CompanyCustomBeneficialOwnerInput!]!
|
The list of beneficial owners to be updated. |
Example
{
"company": CompanyId,
"beneficialOwners": [CompanyCustomBeneficialOwnerInput]
}
CompanyWhereInput
Description
The data input for adding a company.
Fields
| Input Field | Description |
|---|---|
id - CompanyId!
|
Example
{"id": CompanyId}
ConnectBusinessPersonSearchInput
Fields
| Input Field | Description |
|---|---|
query - String!
|
The query string to search for. Should be at least 3 characters long. |
country - CountryCode
|
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
|
|
birthDate - Date
|
|
birthYear - Year
|
Example
{
"query": "xyz789",
"country": "US",
"gender": "FEMALE",
"birthDate": "2007-12-03",
"birthYear": Year
}
ConnectCompanyStatus
Description
Describes the status of a company, i.e., whether the company is active, dissolved, etc.
Example
{
"name": "xyz789",
"date": "2007-12-03T10:15:30Z",
"isActive": true
}
ConnectIndustryCode
Fields
| Field Name | Description |
|---|---|
code - String!
|
|
description - String
|
|
codeType - IndustryCodeType!
|
Example
{
"code": "xyz789",
"description": "abc123",
"codeType": "DB_25"
}
ConnectPartialDateInput
ConnectPrivatePersonRegistrySearchResource
Description
A private person search result from a registry.
Fields
| Field Name | Description |
|---|---|
identifier - EntityIdentifier
|
|
name - String!
|
Person name. |
gender - Gender
|
The gender of the person. |
birthDate - Date
|
The birth date of the person. |
birthYear - Year
|
The birth year of the person. |
address - [Address!]!
|
|
citizenship - [Country!]!
|
Example
{
"identifier": EntityIdentifier,
"name": "abc123",
"gender": "FEMALE",
"birthDate": "2007-12-03",
"birthYear": Year,
"address": [Address],
"citizenship": [Country]
}
Country
Fields
| Field Name | Description |
|---|---|
code - CountryCode!
|
|
name - String!
|
Example
{
"code": "US",
"name": "abc123"
}
CountryCode
Description
A ISO 3166-1 alpha-2 code. Empty string will be handled as null
Example
"US"
CountryContext
Description
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.
Fields
| Field Name | Description |
|---|---|
relationship - CountryRelationship!
|
|
country - Country!
|
Example
{"relationship": "ADDRESS", "country": Country}
CountryContextInput
Description
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.
Fields
| Input Field | Description |
|---|---|
country - CountryCode!
|
|
relationship - CountryRelationship!
|
Example
{"country": "US", "relationship": "ADDRESS"}
CountryRelationship
Description
The relationship between a country and a context, such as a person's country of residence
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADDRESS"
CustomBusinessPerson
Description
A resource representing a user generated custom business person.
Fields
| Field Name | Description |
|---|---|
id - CustomBusinessPersonId!
|
|
birthDate - Date
|
|
birthYear - Year
|
|
pep - Boolean!
|
Use the pepInfo field instead.
|
pepInfo - PepInfo!
|
PEP information. |
name - String!
|
Entity name. |
address - [Address!]!
|
The postal address of the Entity. Use the addresses field instead for a complete list of available addresses.
|
addresses - [Address!]!
|
The available addresses of the entity. |
countries - [CountryContext!]!
|
The countries for the Entity. |
identifiers - [EntityIdentifier!]!
|
The official identifiers for this Entity. Since an Entity can have several ids (even within the same country), this is a list. |
relationships - EntityConnection!
|
Related entities (e.g. persons, companies) for this entity. Can be UBOs, board members, etc. |
Arguments
|
|
sanctioned - Boolean!
|
Whether this entity is sanctioned. Use the sanctionInfo field instead
|
sanctionInfo - SanctionInfo!
|
Sanction information related to this entity. |
amsCount - Int!
|
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. Use the ams field instead
|
ams - [AmsEvent!]!
|
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. |
Arguments
|
|
flags - [FlagKind!]!
|
Flagged events found for this entity. |
riskSignals - RiskSignals!
|
Risk signals. Currently there is only one possible risk signal, 'flags', which is created if we find flags of negative severity. |
Example
{
"id": CustomBusinessPersonId,
"birthDate": "2007-12-03",
"birthYear": Year,
"pep": true,
"pepInfo": PepInfo,
"name": "abc123",
"address": [Address],
"addresses": [Address],
"countries": [CountryContext],
"identifiers": [EntityIdentifier],
"relationships": EntityConnection,
"sanctioned": true,
"sanctionInfo": SanctionInfo,
"amsCount": 987,
"ams": [AmsEvent],
"flags": ["AUDITOR_NOTES"],
"riskSignals": RiskSignals
}
CustomBusinessPersonId
Description
A generic identifier for a custom business person.
Example
CustomBusinessPersonId
CustomBusinessPersonWhereInput
Fields
| Input Field | Description |
|---|---|
id - CustomBusinessPersonId!
|
Example
{"id": CustomBusinessPersonId}
CustomCompanyCreateInput
Description
Input to create a custom company.
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
country - CountryCode
|
|
legalForm - LegalFormKind
|
|
orgNumber - String
|
|
inceptionDate - ConnectPartialDateInput
|
|
address - AddressInput
|
|
shareholders - [CompanyOwnershipInput!]
|
|
companyShareholders - [CompanyOwnershipInput!]!
|
|
personShareholders - [BusinessPersonOwnershipInput!]!
|
Example
{
"name": "xyz789",
"country": "US",
"legalForm": "BE_AGRI",
"orgNumber": "xyz789",
"inceptionDate": ConnectPartialDateInput,
"address": AddressInput,
"shareholders": [CompanyOwnershipInput],
"companyShareholders": [CompanyOwnershipInput],
"personShareholders": [BusinessPersonOwnershipInput]
}
CustomCompanyPayload
CustomCompanyUpdateInput
Description
Input to update a custom company.
Fields
| Input Field | Description |
|---|---|
id - CompanyId!
|
|
name - String!
|
|
country - CountryCode
|
|
legalForm - LegalFormKind
|
|
orgNumber - String
|
|
inceptionDate - ConnectPartialDateInput
|
|
address - AddressInput
|
|
shareholders - [CompanyOwnershipInput!]
|
|
companyShareholders - [CompanyOwnershipInput!]!
|
|
personShareholders - [BusinessPersonOwnershipInput!]!
|
Example
{
"id": CompanyId,
"name": "abc123",
"country": "US",
"legalForm": "BE_AGRI",
"orgNumber": "xyz789",
"inceptionDate": ConnectPartialDateInput,
"address": AddressInput,
"shareholders": [CompanyOwnershipInput],
"companyShareholders": [CompanyOwnershipInput],
"personShareholders": [BusinessPersonOwnershipInput]
}
CustomCompanyWhereInput
Fields
| Input Field | Description |
|---|---|
id - CompanyId!
|
Example
{"id": CompanyId}
CustomOwnersInput
Description
The data input for updating company ownership. If companies and businessPersons are both empty lists, custom ownerships will be reset
Fields
| Input Field | Description |
|---|---|
company - CompanyId!
|
|
companies - [CompanyOwnershipInput!]!
|
|
businessPersons - [BusinessPersonOwnershipInput!]!
|
|
customPersons - [CustomPersonOwnershipInput!]!
|
Example
{
"company": CompanyId,
"companies": [CompanyOwnershipInput],
"businessPersons": [BusinessPersonOwnershipInput],
"customPersons": [CustomPersonOwnershipInput]
}
CustomPersonCreateInput
Description
The data for creating a custom person.
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
citizenship - CountryCode
|
|
birthDate - ConnectPartialDateInput
|
|
nin - String
|
|
sex - Gender
|
|
address - [AddressInput!]!
|
Example
{
"name": "xyz789",
"citizenship": "US",
"birthDate": ConnectPartialDateInput,
"nin": "xyz789",
"sex": "FEMALE",
"address": [AddressInput]
}
CustomPersonEditInput
Description
The data for editing a custom person.
Fields
| Input Field | Description |
|---|---|
id - BusinessPersonId!
|
|
name - String!
|
|
citizenship - CountryCode
|
|
birthDate - ConnectPartialDateInput
|
|
nin - String
|
|
sex - Gender
|
|
address - [AddressInput!]!
|
Example
{
"id": BusinessPersonId,
"name": "abc123",
"citizenship": "US",
"birthDate": ConnectPartialDateInput,
"nin": "xyz789",
"sex": "FEMALE",
"address": [AddressInput]
}
CustomPersonOwnershipInput
Description
The data input for updating company ownership.
Example
{
"name": "abc123",
"birthDate": "2007-12-03",
"ownership": 987.65,
"countries": [CountryContextInput],
"comment": "xyz789",
"beneficialOwner": false
}
CustomPersonPayload
Description
The payload for a custom person mutation.
Fields
| Field Name | Description |
|---|---|
success - Boolean!
|
|
person - BusinessPerson
|
A person resource. |
Example
{"success": true, "person": BusinessPerson}
CustomRiskFieldScore
Description
Risk score result for a specific custom risk field
Fields
| Field Name | Description |
|---|---|
customRiskFieldId - ID!
|
|
scoreResult - RiskScoreResult!
|
Example
{"customRiskFieldId": 4, "scoreResult": RiskScoreResult}
CustomerFacingFormId
Description
An identifier for a customer facing form.
Example
CustomerFacingFormId
DatasetKind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PEP"
Date
Description
A date in the ISO 8601 format (mm-dd).
Example
"2007-12-03"
DateTime
Description
A date-time in the ISO 8601 format (yyyy, yyyy-mm, yyyy-mm-dd).
Example
"2007-12-03T10:15:30Z"
Document
Description
An object representing a document related to a company.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier for the document. |
fileName - String!
|
The file name of the document. |
contentType - String
|
The file's content type. |
size - Long
|
The file size, given in bytes. |
lastModifiedAt - ISODateTime
|
The date and time the document was last modified. |
downloadUrl - String
|
The URL where the document can be downloaded. |
source - DocumentSource!
|
The source of the document. |
status - DocumentStatus!
|
The status of the document upload. |
Example
{
"id": "4",
"fileName": "xyz789",
"contentType": "xyz789",
"size": {},
"lastModifiedAt": ISODateTime,
"downloadUrl": "xyz789",
"source": "COMPANIES_HOUSE",
"status": "FAILED"
}
DocumentSource
Description
An enum representing the source of a document.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPANIES_HOUSE"
DocumentStatus
Description
The status of a document upload.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"FAILED"
DocumentWhereInput
Description
The data input for fetching a document.
Fields
| Input Field | Description |
|---|---|
companyId - CompanyId!
|
The ID of the company to which the document belongs. |
documentId - ID!
|
The ID of the document. |
Example
{
"companyId": CompanyId,
"documentId": "4"
}
EditKind
Description
Represents the type of edit being made on a data point.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADD"
EditMetadata
Description
Metadata about an edit on a data field.
Fields
| Field Name | Description |
|---|---|
editKind - EditKind!
|
The type of the edit. |
updatedAt - DateTime!
|
The timestamp of when the edit was last updated. |
editedBy - SimpleUser
|
The user which made the edit. |
comment - String
|
The comment associated with the edit, if it exists. |
Example
{
"editKind": "ADD",
"updatedAt": "2007-12-03T10:15:30Z",
"editedBy": SimpleUser,
"comment": "abc123"
}
EmployeeCountInterval
EntityConnection
Description
Represents connections to other entities: (queriedEntity)-[edges[0]]->(someEntity), (queriedEntity)-[edges[1]]->(someOtherEntity), etc.
Fields
| Field Name | Description |
|---|---|
edges - [EntityConnectionEdge!]!
|
Example
{"edges": [EntityConnectionEdge]}
EntityConnectionEdge
Fields
| Field Name | Description |
|---|---|
kind - EntityRelationshipKind!
|
The kind of relationship between the entities. |
explanation - String!
|
Details for the relationship. |
custom - Boolean!
|
Whether this is a custom relation |
node - EntityLike!
|
Related entity |
details - RelationshipDetails
|
Example
{
"kind": "BENEFICIAL_OWNERSHIP",
"explanation": "xyz789",
"custom": false,
"node": EntityLike,
"details": OwnershipRelationDetails
}
EntityIdentifier
Fields
| Field Name | Description |
|---|---|
value - String!
|
|
country - CountryCode
|
The country of the register from which this identifier was issued. |
kind - EntityIdentifierKind!
|
The identifiers kind. |
description - String
|
The identifiers description. |
Example
{
"value": "xyz789",
"country": "US",
"kind": "PRIMARY",
"description": "xyz789"
}
EntityIdentifierKind
Description
The kind of an identifier.
Values
| Enum Value | Description |
|---|---|
|
|
A primary identifier for the entity. |
|
|
A secondary identifier for the entity. |
|
|
An unknown identifier kind. |
Example
"PRIMARY"
EntityKind
Description
The type of entity.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COMPANY"
EntityLike
Description
An interface type of external business entities. Either a company or a business person.
Fields
| Field Name | Description |
|---|---|
name - String!
|
Entity name. |
address - [Address!]!
|
The postal address of the Entity. Use the addresses field instead for a complete list of available addresses.
|
addresses - [Address!]!
|
The available addresses of the entity. |
countries - [CountryContext!]!
|
The countries for the Entity. |
identifiers - [EntityIdentifier!]!
|
The official identifiers for this Entity. Since an Entity can have several ids (even within the same country), this is a list. |
relationships - EntityConnection!
|
Related entities (e.g. persons, companies) for this entity. Can be UBOs, board members, etc. |
Arguments
|
|
sanctioned - Boolean!
|
Whether this entity is sanctioned. Use the sanctionInfo field instead
|
sanctionInfo - SanctionInfo!
|
Sanction information related to this entity. |
amsCount - Int!
|
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. Use the ams field instead
|
ams - [AmsEvent!]!
|
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. |
Arguments
|
|
flags - [FlagKind!]!
|
Flagged events found for this entity. |
riskSignals - RiskSignals!
|
Risk signals. Currently there is only one possible risk signal, 'flags', which is created if we find flags of negative severity. |
Possible Types
| EntityLike Types |
|---|
Example
{
"name": "abc123",
"address": [Address],
"addresses": [Address],
"countries": [CountryContext],
"identifiers": [EntityIdentifier],
"relationships": EntityConnection,
"sanctioned": true,
"sanctionInfo": SanctionInfo,
"amsCount": 987,
"ams": [AmsEvent],
"flags": ["AUDITOR_NOTES"],
"riskSignals": RiskSignals
}
EntityRelationshipKind
Description
The kind of relationship between the two entities.
Values
| Enum Value | Description |
|---|---|
|
|
Some other relationship between the entities. |
|
|
Some other relationship between the entities. |
|
|
One owns shares in the other. |
|
|
One entity holds a role in the other. |
Example
"BENEFICIAL_OWNERSHIP"
FlagKind
Description
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.
Values
| Enum Value | Description |
|---|---|
|
|
The company has received notes from the auditor on the annual accounts. |
|
|
The auditor of the company has resigned. |
|
|
This company has been declared bankrupt. |
|
|
Possible bankruptcy. This company is the defendant in a court case concerning a bankruptcy. |
|
|
This company has signalled a capital increase. |
|
|
This company's CEO has resigned without a successor. |
|
|
This company is missing the necessary certifications associated with their industrial code. |
|
|
The company changed its industry code. |
|
|
The company has been dissolved by the local authorities. |
|
|
A flag signaling that the local authorities have issued a warning about compulsory dissolution to this company. |
|
|
The company has been liquidated by the local authorities. |
|
|
A flag signaling that the local authorities have issued a warning about compulsory liquidation to this company. |
|
|
This company has petitioned for debt restructure negotiations. |
|
|
This company is dissolved. |
|
|
Big change in number of employees |
|
|
This company has received a government grant. |
|
|
The company has an owner or a beneficial owner from a high risk country. |
|
|
This company is the defendant in an ongoing trial. |
|
|
This company is the plaintiff in an ongoing trial. |
|
|
This company has completed a merger. |
|
|
The company has more than one branches. |
|
|
The annual accounts indicate earning exceeding the local threshold without being VAT registered. |
|
|
The company has a related person that is not allowed to participate in business activities. |
|
|
This company's has a new CEO. |
|
|
The company has a new subsidiary. |
|
|
A flag signaling a company is in a risky industry. |
|
|
The company has had significant changes in its income. |
|
|
The company has had significant changes in its revenue. |
|
|
This company is placed on a warning list. |
Example
"AUDITOR_NOTES"
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
Form
FormInstanceId
Description
An identifier for a customer facing form instance.
Example
FormInstanceId
Gender
Values
| Enum Value | Description |
|---|---|
|
|
Female |
|
|
Male |
|
|
Other |
Example
"FEMALE"
ID
Description
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.
Example
"4"
ISODateTime
Description
An combined date-time representation according to the ISO 8601 standard.
Example
ISODateTime
IndustryCodeType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DB_25"
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
LegalFormKind
Description
The type of LegalForm
Values
| Enum Value | Description |
|---|---|
|
|
Agricultural society |
|
|
Autonomous municipal authority |
|
|
Charitable foundation |
|
|
Charitable organisation |
|
|
Cooperative company |
|
|
Cooperative company former status |
|
|
Economic Interest Grouping |
|
|
Foreign company not established in Belgium with VAT representative |
|
|
Foreign enterprise |
|
|
General partnership |
|
|
Mutual insurance association/Private law insurance common fund |
|
|
International non-profit organisation |
|
|
Joint ownership association |
|
|
Limited liability cooperative company |
|
|
Limited liability cooperative company with a social purpose |
|
|
Limited liability company with a social purpose |
|
|
Limited partnership |
|
|
Non-profit association |
|
|
Non-profit institution |
|
|
Partnership |
|
|
Partnership limited by shares |
|
|
Private company |
|
|
Private company by public law |
|
|
Private foundation |
|
|
Pension funding body |
|
|
Public limited company |
|
|
Private limited liability company |
|
|
Physical person |
|
|
International scientific organisation under Belgian law |
|
|
Public Centre for Social Welfare |
|
|
Unincorporated company or association |
|
|
Unlimited liability cooperative company |
|
|
VAT unit |
|
|
Walloon Regional Authority |
|
|
Andelsselskab (-forening) med begrænset ansvar |
|
|
Amtskommune |
|
|
Andelsselskab (-forening) |
|
|
Anpartsselskab |
|
|
Aktieselskab |
|
|
DΓΈdsbo |
|
|
Erhvervsdrivende fond |
|
|
Enkeltmandsvirksomhed |
|
|
EuropΓ¦isk Γkonomisk Firmagruppe |
|
|
SE-selskab |
|
|
Enhed under oprettelse i Erhvervsstyrelsen |
|
|
Filial af udenlandsk anpartsselskab eller selskab |
|
|
Filial af udenlandsk aktieselskab, kommanditakties |
|
|
Forening eller selskab med begrænset ansvar |
|
|
Filial af udenlandsk virksomhed med begrænset ansv |
|
|
Fast forretningssted af Europæisk økonomisk Firmag |
|
|
Filial af SE-selskab |
|
|
Frivillig forening |
|
|
Særlig finansiel virksomhed |
|
|
Folkekirkelige Institutioner |
|
|
Forening med begrænset ansvar |
|
|
Fonde og andre selvejende institutioner |
|
|
Forening |
|
|
GrΓΈnlandsk afdeling af udenlandsk selskab eller virksomhed |
|
|
Interessentskab |
|
|
Iværksætterselskab |
|
|
Kommanditaktieselskab/Partnerselskab |
|
|
Primærkommune |
|
|
Kommanditselskab |
|
|
Medarbejderinvesteringsselskab |
|
|
Γvrige virksomhedsformer |
|
|
Partrederi |
|
|
Personligt ejet Mindre Virksomhed |
|
|
Region |
|
|
SCE-selskab |
|
|
Selskab med begrænset ansvar |
|
|
Selvstændig offentlig virksomhed |
|
|
Statslig administrativ enhed |
|
|
Trust |
|
|
Anden udenlandsk virksomhed |
|
|
Uoplyst virksomhedsform |
|
|
Public Limited Company (Aktiengesellschaft) |
|
|
Public Limited Company & Co. |
|
|
Public Limited Company & Co. Limited Partnership (Aktiengesellschaft & Co. KG) |
|
|
Public Limited Company & Co. Partnership Limited by Shares |
|
|
Public Limited Company & Co. General Partnership (Aktiengesellschaft & Co. OHG) |
|
|
Public Law Institution (Anstalt des ΓΆffentlichen Rechts) |
|
|
Norwegian/Danish Public Limited Company |
|
|
Norwegian/Danish Public Limited Company & Co. Limited Partnership |
|
|
Latvian Public Limited Company |
|
|
Private Company Limited by Shares (Dutch GmbH equivalent) |
|
|
Civil Law Partnership (Gesellschaft bΓΌrgerlichen Rechts OR BGB-Gesellschaft) |
|
|
Dutch GmbH & Co. Limited Partnership |
|
|
Commercial Undertaking |
|
|
Slovenian GmbH |
|
|
Registered Cooperative (eG) |
|
|
Registered Civil-Law Partnership (eGbR) |
|
|
Registered Civil Law Partnership with a Public Limited Company Partner |
|
|
Registered Civil Law Partnership with an LLC Partner |
|
|
Registered Civil Law Partnership with an UG (Small GmbH) Partner |
|
|
Civil law partnership with a Private Limited Company as shareholder |
|
|
Registered Cooperative with Limited Liability |
|
|
Registered Cooperative with Unlimited Liability |
|
|
Municipal Enterprise (Eigenbetrieb) |
|
|
Registered Merchant |
|
|
European Economic Interest Grouping (EuropΓ€ische wirtschaftliche Interessenvereinigung) |
|
|
Foreign Partnership (Foreign GsR) |
|
|
Liberal Profession (Freier Beruf) |
|
|
Non-Profit Public Limited Company |
|
|
Joint Municipal Enterprise |
|
|
Limited Liability Company (GmbH) |
|
|
Limited Liability Company & Co. (Gesellschaft mit beschrΓ€nkter Haftung & Co.) |
|
|
GmbH & Co. KG |
|
|
Limited Liability Company & Co. Partnership Limited by Shares |
|
|
Limited Liability Company & Co. General Partnership |
|
|
Incorporated - Public Limited Company in USA |
|
|
Incorporated (American Corporation) & Co. Limited Partnership |
|
|
Limited Partnership |
|
|
Partnership Limited by Shares (Kommanditgesellschaft auf Aktien) |
|
|
Limited Partnership KGaA & Co. |
|
|
Corporation under Public Law |
|
|
Limited Liability Company (LLC) - American GmbH |
|
|
Limited Company & Co. Limited Partnership (Limited & Co.KG) |
|
|
Ltd. & Co. General Partnership |
|
|
Non-Profit Limited Liability Company (gGmbH) |
|
|
Dutch Public Limited Company |
|
|
Dutch Public Limited Company & Co. Limited Partnership |
|
|
Bulgarian GmbH |
|
|
General Partnership |
|
|
Other |
|
|
Partnership Company (PartG) |
|
|
English Public Limited Company (Public Company Limited by Shares) |
|
|
Legally Independent |
|
|
State-conferred Association (RechtsfΓ€higer Verein) |
|
|
SociΓ©tΓ© Anonyme (SA) - Belgian, French, Luxembourgish, Polish, Romanian, Swiss, Spanish Public Limited Company |
|
|
French or Luxembourgish Single-Member GmbH (SARL) |
|
|
French GmbH & Co. Limited Partnership |
|
|
European Cooperative Society |
|
|
Societas Europaea - European Public Limited Liability Company (EuropΓ€ische Aktiengesellschaft) |
|
|
SE & Co. Partnership Limited by Shares |
|
|
Sole Proprietorship (Gewerbebetrieb) |
|
|
Other Foreign Legal Form |
|
|
Italian Public Limited Company |
|
|
Polish GmbH |
|
|
Polish GmbH & Co. Limited Partnership |
|
|
Romanian GmbH |
|
|
Czech GmbH |
|
|
Foundation |
|
|
Foundation & Co. Limited Partnership |
|
|
Foundation under Public Law |
|
|
Foundation in form of Private Limited Company |
|
|
Foundation under Private Law |
|
|
Foundation Association |
|
|
Small Limited Liability Company (UG) |
|
|
UG & Co. KG |
|
|
Private Company Limited by Shares (English GmbH equivalent) |
|
|
Registered Association (Eingetragener Verein) |
|
|
Mutual Insurance Association (Versicherungsverein auf Gegenseitigkeit) |
|
|
LimitedCompany |
|
|
PrivateBusinessGovCtrl |
|
|
ForeignCompany |
|
|
Bank |
|
|
SoleProprietorship |
|
|
GeneralPartnership |
|
|
Society |
|
|
Foundation |
|
|
HousingCompany |
|
|
StateCountyCompany |
|
|
DeathNest |
|
|
Limited Partnership |
|
|
Shipping Partnership |
|
|
Corporation |
|
|
Business Foundation |
|
|
Association |
|
|
Cooperative |
|
|
Volunteer Association |
|
|
Association or Limited Liability Company |
|
|
Limited Liability Company |
|
|
ReligiousOrganisation |
|
|
Limited Association Company |
|
|
State Administration |
|
|
European Financial Company Group |
|
|
SCE Company |
|
|
Special Financial Business |
|
|
Partnership |
|
|
InsuranceCompany |
|
|
Sub Division |
|
|
Collaborations |
|
|
European Economic Interest Group |
|
|
Limited Liability Stock Company |
|
|
Open Trading Company |
|
|
Statutory Corporation |
|
|
Professional Partnership |
|
|
Independent Subsidiary |
|
|
Dependant Subsidiary |
|
|
Societas Cooperativa Europaea |
|
|
Societas Europaea |
|
|
Freier Beruf |
|
|
Non Profit Stock Company |
|
|
Entrepreneurial Limited Company |
|
|
Other2 |
|
|
Unknown |
|
|
Resident-administered area |
|
|
Right-of-occupancy associationy |
|
|
Non-profit association |
|
|
Finnish branch of a European economic interest grouping |
|
|
Mortgage Society |
|
|
Limited liability joint-stock property company |
|
|
Public mutual insurance company |
|
|
Co-operative bank |
|
|
Housing co-perative |
|
|
Other |
|
|
Public Limited Company |
|
|
European co-operative society |
|
|
European co-operative bank |
|
|
European Company |
|
|
Branch of a foreign trader |
|
|
Savings bank |
|
|
Association for carrying on economic activity |
|
|
Unknown |
|
|
State-owned company |
|
|
Public limited insurance company |
|
|
Limited insurance company |
|
|
Insurance association |
|
|
Agricultural Collective Interest Company |
|
|
Agricultural cooperative company |
|
|
Agricultural collective interest company in the form of a Plc with management board |
|
|
Council housing public limited company with board of directors |
|
|
Council housing production cooperative society |
|
|
cooperative public limited company with board of directors |
|
|
CUMA- Common agricultural material usage cooperative |
|
|
Liberal Operated Limited Liability Company |
|
|
Limited Liability Company |
|
|
Limited Partnership by policy |
|
|
Maritime interest cooperative public limited company with board of directors |
|
|
Mixed interest collective agricultural public limited company with board of directors |
|
|
Mixed Economy Plc with board of directors |
|
|
National Public Limited Company with Board of Directors |
|
|
Non Trading Company |
|
|
Partnership |
|
|
Public limited company with board of directors |
|
|
Plc with management board |
|
|
Public Limited Company with Worker Participation in the Board of Directors |
|
|
SAFER with Board of Directors |
|
|
SASU (school and university administration secretary) company by simplified actions |
|
|
Simplified joint stock company |
|
|
Sole proprietorship Ltd |
|
|
Union of agricultural cooperative companies |
|
|
Worker production cooperative society with board of directors |
|
|
Agricultural Association |
|
|
Public Limited Company |
|
|
Simplified Public Limited Company |
|
|
Civil Society |
|
|
Company Limited by Shares |
|
|
Cooperative Company |
|
|
Economic Interest Grouping |
|
|
Foundation |
|
|
Limited Company - Company of Family Wealth Management |
|
|
General Partnership |
|
|
Limited Company Holding |
|
|
IndΓ©pendant |
|
|
Investment Company With Variable Capital |
|
|
Open-End Investment Company |
|
|
Limited Partnership |
|
|
Limited Partnership Simple |
|
|
Private Limited Company |
|
|
Simplified Private Limited Company |
|
|
Single Member Limited Liability Company |
|
|
Mutual Investment Fund |
|
|
Non-Profit Association |
|
|
Partnership |
|
|
Partnership Limited by Shares |
|
|
Public Institution |
|
|
Real Estate Company |
|
|
Limited Company in the form of a SICAV - Specialised Investment Fund |
|
|
Special Limited Partnership |
|
|
Limited Company SOPARFI |
|
|
Association (Vereniging) with complete jurisdiction |
|
|
Association (Vereniging) with limited jurisdiction |
|
|
Association of owners |
|
|
Private limited liability company (BV) according regulations of the structural company |
|
|
Private limited liability company (BV) with ordinary structure |
|
|
Co-operative society excluded liability (CoΓΆperatie U.A.) with ordinary structure |
|
|
Public corporation |
|
|
Limited partnership (CV) with one managing partner |
|
|
Foreign company resembling at a company of the European Community with establishment in the Netherlands |
|
|
Foreign company of the European Community with establishment in the Netherlands |
|
|
Foundation (Stichting) |
|
|
Religious community (Kerkgenootschap) |
|
|
Mutual quarantee association excluded liability (Onderlinge Waarborgmaatschappij U.A.) with ordinary structure |
|
|
Limited company (NV) according regulations of the structural company |
|
|
Limited company (NV) with ordinary structure |
|
|
Partnership |
|
|
Limited company being set up (Rechtspersoon in oprichting) |
|
|
Sole trader with one owner |
|
|
Sole trafer with several owners |
|
|
General partnership (VOF) |
|
|
Ikke næringsdrivende virksomhet |
|
|
Administrativ enhet -offentlig sektor |
|
|
Annen juridisk person |
|
|
Ansvarlig selskap med solidarisk ansvar |
|
|
Aksjeselskap |
|
|
Allmennaksjeselskap |
|
|
Selskap med begrenset ansvar |
|
|
Boligbyggelag |
|
|
Bedrift |
|
|
Andre bo |
|
|
Borettslag |
|
|
Ansvarlig selskap med delt ansvar |
|
|
Enkeltpersonforetak |
|
|
Europeisk ΓΈkonomisk foretaksgruppe |
|
|
Eierseksjonssameie |
|
|
Fylkeskommunalt foretak |
|
|
Forening/lag/innretning |
|
|
Fylkeskommune |
|
|
Gjensidig forsikringsselskap |
|
|
Andre ikke-juridiske personer |
|
|
Interkommunalt selskap |
|
|
Konkursbo |
|
|
Kommunalt foretak |
|
|
Den norske kirke |
|
|
Kommune |
|
|
Kommandittselskap |
|
|
Kontorfellesskap |
|
|
Norskregistrert utenlandsk foretak |
|
|
Særskilt oppdelt enhet |
|
|
Organisasjonsledd |
|
|
Andre enkeltpersoner som registreres i tilknyttet register |
|
|
Pensjonskasse |
|
|
Partrederi |
|
|
Samvirkeforetak |
|
|
Annet foretak ifølge særskilt lov |
|
|
Tingsrettslig sameie |
|
|
Europeisk selskap |
|
|
Statsforetak |
|
|
Sparebank |
|
|
Staten |
|
|
Stiftelse |
|
|
Tvangsregistrert for MVA |
|
|
Verdipapirfond |
|
|
Privat aktiebolag |
|
|
AllmΓ€n fΓΆrsΓ€kringskassa |
|
|
Aktiebolag |
|
|
Bankaktiebolag |
|
|
BostadsrΓ€ttsfΓΆrening |
|
|
BostadsfΓΆrening |
|
|
ErkΓ€nd arbetslΓΆshetskassa |
|
|
Enkelt bolag |
|
|
Enskild firma |
|
|
Ekonomisk fΓΆrening |
|
|
Europakooperativ |
|
|
Europabolag |
|
|
Familjestiftelse |
|
|
FΓΆrsΓ€kringsaktiebolag |
|
|
FΓΆrsΓ€kringsbolag |
|
|
Filial till utlΓ€ndskt bolag |
|
|
Handelsbolag |
|
|
HypoteksfΓΆrening |
|
|
Ideell fΓΆrening |
|
|
Kommanditbolag |
|
|
Kooperativ HyresgΓ€stfΓΆrening |
|
|
KommunfΓΆrbund |
|
|
Kommun |
|
|
Landsting |
|
|
LivfΓΆrsΓ€kringsbolag |
|
|
Medlemsbank |
|
|
Oskiftat dΓΆdsbo |
|
|
OkΓ€nd juridisk form |
|
|
Offentlig korporation och anstalt |
|
|
Γmsesidigt fΓΆrsΓ€kringsbolag |
|
|
Γvrig svensk juridisk person |
|
|
Publikt aktiebolag |
|
|
Partrederi |
|
|
Privat bankaktiebolag |
|
|
Publikt bankaktiebolag |
|
|
Privat livfΓΆrsΓ€kringsbolag |
|
|
Privat skadefΓΆrsΓ€kringsbolag |
|
|
Publikt livfΓΆrsΓ€kringsbolag |
|
|
Publikt skadefΓΆrsΓ€kringsbolag |
|
|
Regional statlig myndighet |
|
|
Registrerat trossamfund |
|
|
SambruksfΓΆrening |
|
|
SamfΓ€llighet |
|
|
SkadefΓΆrsΓ€kringsbolag |
|
|
Sparbank |
|
|
Statlig enhet |
|
|
Stiftelse/Fond |
|
|
Stiftelse |
|
|
TjΓ€nstepensionsfΓΆrening |
|
|
UtlΓ€ndsk Banks Filial |
|
|
UtlΓ€ndsk juridisk person |
|
|
UnderstΓΆdsfΓΆrening |
|
|
VΓ€rdepapperfond |
|
|
Charitable Company |
|
|
Charitable Incorporated Organisation (CIO) |
|
|
Other Charity |
|
|
Charity Trust |
|
|
Unknown Charity type |
|
|
Other |
|
|
Private unlimited with Share Capital |
|
|
Private limited with Share Capital |
|
|
Public limited with Share Capital |
|
|
Old Public Limited Company |
|
|
Private Limited by guarantee without Share Capital Exempt from using Limited |
|
|
Limited Partnership |
|
|
Private Ltd By Guarantee w/o Share Cap |
|
|
Company Converted/Closed |
|
|
Unlimited/No Share Capital |
|
|
Limited |
|
|
Societas Europaea (SE) |
|
|
Scottish Partnership |
|
|
Further education or sixth form college corporation |
|
|
Overseas Entity |
|
|
Sole Trader |
Example
"BE_AGRI"
Long
Description
The Long scalar type represents non-fractional signed whole numeric values. Long can represent values between -(2^63) and 2^63 - 1.
Example
{}
MonitoredEntityLike
Description
An interface type of external business entities that can be monitored.
Fields
| Field Name | Description |
|---|---|
name - String!
|
Entity name. |
address - [Address!]!
|
The postal address of the Entity. |
countries - [CountryContext!]!
|
The countries for the Entity. |
identifiers - [EntityIdentifier!]!
|
The official identifiers for this Entity. Since an Entity can have several ids (even within the same country), this is a list. |
sanctioned - Boolean!
|
Whether this entity is sanctioned. Use the sanctionInfo field instead
|
sanctionInfo - SanctionInfo!
|
Sanction information related to this entity. |
amsCount - Int!
|
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. Use the ams field instead
|
ams - [AmsEvent!]!
|
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. |
Arguments
|
|
flags - [FlagKind!]!
|
Flagged events found for this entity. |
riskSignals - RiskSignals!
|
Risk signals. Currently there is only one possible risk signal, 'flags', which is created if we find flags of negative severity. |
Possible Types
| MonitoredEntityLike Types |
|---|
Example
{
"name": "xyz789",
"address": [Address],
"countries": [CountryContext],
"identifiers": [EntityIdentifier],
"sanctioned": true,
"sanctionInfo": SanctionInfo,
"amsCount": 987,
"ams": [AmsEvent],
"flags": ["AUDITOR_NOTES"],
"riskSignals": RiskSignals
}
MonitoringChange
Description
The data change that triggered an alert.
Fields
| Field Name | Description |
|---|---|
monitoredEntity - MonitoredEntityLike!
|
|
kind - DatasetKind!
|
The type of change. Determines which 'xChanges' fields are populated with data. |
computedAt - DateTime!
|
The time at which the change was seen (when the difference was computed). |
change - ChangeLike!
|
The change data, whose structure is defined by 'kind'. |
Example
{
"monitoredEntity": MonitoredEntityLike,
"kind": "PEP",
"computedAt": "2007-12-03T10:15:30Z",
"change": ChangeLike
}
NamedEntityKind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY"
Ownership
Description
An object representing an ownership relationship.
Fields
| Field Name | Description |
|---|---|
shareClasses - [ShareClass!]!
|
The list of share classes with their associated share percentages. |
totalSharePercentage - SharePercentageInterval!
|
The total direct share percentage, i.e., the sum of all shares in shareClasses. |
editMetadata - EditMetadata
|
Metadata about edits made to this ownership relationship. |
entity - EntityLike!
|
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. |
Example
{
"shareClasses": [ShareClass],
"totalSharePercentage": SharePercentageInterval,
"editMetadata": EditMetadata,
"entity": EntityLike
}
OwnershipChange
Description
Change in ownership.
Fields
| Field Name | Description |
|---|---|
toValue - [Ownership!]!
|
|
fromValue - [Ownership!]!
|
Example
{
"toValue": [Ownership],
"fromValue": [Ownership]
}
OwnershipRelationDetails
Fields
| Field Name | Description |
|---|---|
share - Float
|
Example
{"share": 987.65}
PageInfo
PartialDate
PathConnection
Description
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).
Fields
| Field Name | Description |
|---|---|
edges - [PathConnectionEdge!]!
|
Edges representing the path. |
Example
{"edges": [PathConnectionEdge]}
PathConnectionEdge
Description
Represents one or more relations to an entity.
Fields
| Field Name | Description |
|---|---|
kinds - [EntityRelationshipKind!]!
|
The kinds of relationships to the entity. |
node - EntityLike!
|
Related entity |
Example
{"kinds": ["BENEFICIAL_OWNERSHIP"], "node": EntityLike}
PepChange
Description
Change in pep screening.
Fields
| Field Name | Description |
|---|---|
person - EntityLike!
|
The person for which the screening has changed. |
relationsToMonitoredEntity - [RelationKind!]!
|
How the person is related to the monitored entity. |
toValue - PepInfo!
|
The changed screening result. |
fromValue - PepInfo
|
The previous screening result. |
Example
{
"person": EntityLike,
"relationsToMonitoredEntity": ["BENEFICIAL_OWNER"],
"toValue": PepInfo,
"fromValue": PepInfo
}
PepHit
Description
PEP and RCA records.
Fields
| Field Name | Description |
|---|---|
name - String
|
The name of the pep hit |
aliases - [String!]!
|
|
dateOfBirth - PartialDate!
|
The date of birth of the pep hit |
countries - [Country!]!
|
The countries of the pep hit |
pep - Boolean!
|
Whether this person is a PEP (Politically Exposed Person). |
roles - [PepRole!]!
|
Roles that make this person a PEP. |
rca - Boolean!
|
Whether this person is an RCA (Relatives and Close Associates). |
relations - [PepRelation!]!
|
Relations this person has to PEPs (making this person an RCA). |
custom - 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!]!
|
External source urls |
confirmedMatch - 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. |
Example
{
"name": "xyz789",
"aliases": ["abc123"],
"dateOfBirth": PartialDate,
"countries": [Country],
"pep": true,
"roles": [PepRole],
"rca": true,
"relations": [PepRelation],
"custom": true,
"externalUrls": ["xyz789"],
"confirmedMatch": false
}
PepInfo
Description
PEP information.
Fields
| Field Name | Description |
|---|---|
pep - Boolean!
|
If this individual qualifies as a PEP (Politically Exposed Person). |
roles - [PepRole!]!
|
Roles that make this person a PEP. Use the roles field in hits instead.
|
rca - Boolean!
|
If this individual qualifies as an RCA (Relatives and Close Associates). |
relations - [PepRelation!]!
|
Relations this person has to PEPs (making this person an RCA). Use the relations field in hits instead.
|
confirmedPepStatus - 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
|
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!]!
|
PEP and RCA records that match this person. |
Arguments
|
|
Example
{
"pep": false,
"roles": [PepRole],
"rca": true,
"relations": [PepRelation],
"confirmedPepStatus": false,
"confirmedRcaStatus": false,
"hits": [PepHit]
}
PepRelation
Description
Relation to a PEP.
Fields
| Field Name | Description |
|---|---|
description - String
|
Description of the relation to the PEP. |
name - String
|
Name of related PEP. |
birthDate - Date
|
Birth date of related PEP. |
roles - [PepRole!]!
|
Roles of related PEP. |
externalUrls - [String!]!
|
External source urls |
Example
{
"description": "xyz789",
"name": "abc123",
"birthDate": "2007-12-03",
"roles": [PepRole],
"externalUrls": ["xyz789"]
}
PepRole
Description
A role that makes a person a PEP, e.g. member of parliament.
Fields
| Field Name | Description |
|---|---|
description - String
|
Description of the role that makes this person a PEP. |
details - String
|
Further details about the role. |
startDate - Date
|
The date the person started the role. NB! changes to this field will not be notified. |
endDate - Date
|
The date the person ended the role. NB! changes to this field will not be notified. |
since - Date
|
The date the person assumed the role. NB! changes to this field will not be notified. Use startDate instead |
Example
{
"description": "xyz789",
"details": "abc123",
"startDate": "2007-12-03",
"endDate": "2007-12-03",
"since": "2007-12-03"
}
PersonBulkPayloadResource
Description
Response for bulk adding persons to monitoring.
Fields
| Field Name | Description |
|---|---|
failed - [PrivatePersonId!]!
|
|
allSuccessful - Boolean!
|
Example
{"failed": [PrivatePersonId], "allSuccessful": true}
PersonRegistrySearchInput
Description
Input for looking up a private person in official registries.
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name to search for. At least one first name and one last name is required. |
nin - String
|
National identifier number. |
birthDate - Date
|
|
zipCode - String
|
|
streetName - String
|
|
houseNumber - String
|
|
country - CountryCode!
|
Determines which country's registry to search in. |
Example
{
"name": "xyz789",
"nin": "xyz789",
"birthDate": "2007-12-03",
"zipCode": "xyz789",
"streetName": "abc123",
"houseNumber": "abc123",
"country": "US"
}
PersonReviewTriggerEvent
Fields
| Field Name | Description |
|---|---|
person - PrivatePersonId!
|
The person for which the review was triggered. |
id - ID!
|
The ID of the review trigger event. |
triggeredAt - DateTime!
|
A timestamp of when the review was triggered. |
statements - [ReviewTriggerStatementKind!]!
|
The statements that make up the trigger. These are the things that have changed since the last review was performed. |
Example
{
"person": PrivatePersonId,
"id": "4",
"triggeredAt": "2007-12-03T10:15:30Z",
"statements": ["BENEFICIAL_OWNERS_CHANGE"]
}
PersonReviewTriggerEventWhereInput
Description
Input to lookup person review trigger events by person ID and time interval.
Fields
| Input Field | Description |
|---|---|
person - PrivatePersonId!
|
|
from - DateTime
|
|
to - DateTime
|
Example
{
"person": PrivatePersonId,
"from": "2007-12-03T10:15:30Z",
"to": "2007-12-03T10:15:30Z"
}
PersonSearchConnectionEdge
Fields
| Field Name | Description |
|---|---|
node - PrivatePerson!
|
Example
{"node": PrivatePerson}
PersonSearchInput
Fields
| Input Field | Description |
|---|---|
query - String!
|
The name to search for. Setting it as an empty string will return persons ordered alphabetically by name |
country - CountryCode
|
The registry country of the person. Will be ignored if not one of the supported registry countries. |
gender - Gender
|
The gender to search for. |
birthDate - Date
|
|
birthYear - Year
|
|
hasNin - Boolean
|
Example
{
"query": "xyz789",
"country": "US",
"gender": "FEMALE",
"birthDate": "2007-12-03",
"birthYear": Year,
"hasNin": false
}
PrivatePerson
Description
A resource representing a private person.
Fields
| Field Name | Description |
|---|---|
id - PrivatePersonId!
|
The internal ID of this private person. |
name - String!
|
Person name. |
gender - Gender
|
The gender of the person. |
birthDate - Date
|
The birth date of the person. |
birthYear - Year
|
The birth year of the person. |
address - [Address!]!
|
|
countries - [CountryContext!]!
|
|
identifiers - [EntityIdentifier!]!
|
|
pep - Boolean!
|
Whether the person is a PEP or not. Use the pepInfo field instead.
|
pepInfo - PepInfo!
|
PEP information. |
tags - [Tag!]!
|
Tags added to the person. |
sanctioned - Boolean!
|
Whether the person is sanctioned or not. Use the sanctionInfo field instead.
|
sanctionInfo - SanctionInfo!
|
Sanction information. |
relationships - EntityConnection!
|
|
Arguments
|
|
amsCount - 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!
|
Whether this private person is monitored or not. |
flags - [FlagKind!]!
|
Flagged events for related business persons. |
riskSignals - RiskSignals!
|
Risk signals. Currently there is only one possible risk signal, 'flags', which is created if we find flags of negative severity. |
ams - [AmsEvent!]!
|
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. |
Arguments
|
|
Example
{
"id": PrivatePersonId,
"name": "abc123",
"gender": "FEMALE",
"birthDate": "2007-12-03",
"birthYear": Year,
"address": [Address],
"countries": [CountryContext],
"identifiers": [EntityIdentifier],
"pep": true,
"pepInfo": PepInfo,
"tags": [Tag],
"sanctioned": false,
"sanctionInfo": SanctionInfo,
"relationships": EntityConnection,
"amsCount": 987,
"isMonitored": true,
"flags": ["AUDITOR_NOTES"],
"riskSignals": RiskSignals,
"ams": [AmsEvent]
}
PrivatePersonCreateInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
nin - String!
|
|
country - CountryCode!
|
|
birthDate - Date
|
|
birthYear - Year
|
|
gender - Gender
|
|
address - [AddressInput!]!
|
|
citizenship - CountryCode
|
Example
{
"name": "xyz789",
"nin": "abc123",
"country": "US",
"birthDate": "2007-12-03",
"birthYear": Year,
"gender": "FEMALE",
"address": [AddressInput],
"citizenship": "US"
}
PrivatePersonId
Description
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.
Example
PrivatePersonId
PrivatePersonIdentifierSearchInput
Description
Input to lookup private persons by their identifiers, such as their personal number.
Fields
| Input Field | Description |
|---|---|
identifiers - [String!]!
|
The identifiers to search for. |
country - CountryCode
|
Example
{
"identifiers": ["xyz789"],
"country": "US"
}
PrivatePersonPayload
Description
The payload for a PrivatePerson mutation.
Fields
| Field Name | Description |
|---|---|
success - Boolean!
|
|
person - PrivatePerson
|
Example
{"success": true, "person": PrivatePerson}
PrivatePersonSearchConnection
Fields
| Field Name | Description |
|---|---|
edges - [PersonSearchConnectionEdge!]!
|
|
pageInfo - PageInfo
|
Will contain a value for paginated searches |
Example
{
"edges": [PersonSearchConnectionEdge],
"pageInfo": PageInfo
}
PrivatePersonUpdateInput
Fields
| Input Field | Description |
|---|---|
id - PrivatePersonId!
|
|
name - String
|
|
nin - String
|
|
country - CountryCode
|
|
birthDate - Date
|
|
birthYear - Year
|
|
gender - Gender
|
|
address - [AddressInput!]
|
|
citizenship - CountryCode
|
Example
{
"id": PrivatePersonId,
"name": "xyz789",
"nin": "xyz789",
"country": "US",
"birthDate": "2007-12-03",
"birthYear": Year,
"gender": "FEMALE",
"address": [AddressInput],
"citizenship": "US"
}
PrivatePersonWhereInput
Fields
| Input Field | Description |
|---|---|
id - PrivatePersonId!
|
Example
{"id": PrivatePersonId}
PrivatePersonsWhereInput
Fields
| Input Field | Description |
|---|---|
ids - [PrivatePersonId!]!
|
Example
{"ids": [PrivatePersonId]}
RelationKind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BENEFICIAL_OWNER"
RelationshipDetails
Description
A union type of available relationship details.
Types
| Union Types |
|---|
Example
OwnershipRelationDetails
Review
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The id of the review. |
pdf - Base64EncodedFile
|
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!
|
The review's creation timestamp |
companyId - CompanyId!
|
The ID of the company on which the review was created. |
Example
{
"id": "4",
"pdf": Base64EncodedFile,
"createdAt": "2007-12-03T10:15:30Z",
"companyId": CompanyId
}
ReviewContext
Fields
| Field Name | Description |
|---|---|
triggerId - ReviewTriggerId!
|
Unique identifier for the firing review trigger. |
relation - EntityConnection
|
The related entity that satisfied the trigger. If this is null then the trigger was satisfied by the entity itself. |
explanations - [String!]!
|
Text describing all of the fulfilled conditions. |
entity - ReviewEntity!
|
The reviewed entity. |
Example
{
"triggerId": ReviewTriggerId,
"relation": EntityConnection,
"explanations": ["xyz789"],
"entity": Company
}
ReviewEntity
Description
An entity that can be reviewed.
Types
| Union Types |
|---|
Example
Company
ReviewPayload
Fields
| Field Name | Description |
|---|---|
success - Boolean!
|
|
risk - RiskClass!
|
|
id - ID
|
Has a value only when the review is automatically completed, which is dependent on configured risk class settings. |
context - ReviewContext
|
Example
{
"success": true,
"risk": "HIGH",
"id": "4",
"context": ReviewContext
}
ReviewTriggerEvent
Description
Interace for review trigger events.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the review trigger event. |
triggeredAt - DateTime!
|
A timestamp of when the review was triggered. |
statements - [ReviewTriggerStatementKind!]!
|
The statements that make up the trigger. These are the things that have changed since the last review was performed. |
Possible Types
| ReviewTriggerEvent Types |
|---|
Example
{
"id": 4,
"triggeredAt": "2007-12-03T10:15:30Z",
"statements": ["BENEFICIAL_OWNERS_CHANGE"]
}
ReviewTriggerEventSearchConnection
Fields
| Field Name | Description |
|---|---|
totalCount - Int!
|
|
edges - [ReviewTriggerEventSearchConnectionEdge!]!
|
Example
{
"totalCount": 123,
"edges": [ReviewTriggerEventSearchConnectionEdge]
}
ReviewTriggerEventSearchConnectionEdge
Fields
| Field Name | Description |
|---|---|
node - ReviewTriggerEvent!
|
Example
{"node": ReviewTriggerEvent}
ReviewTriggerEventWhereInput
ReviewTriggerId
Description
An identifier for a review trigger
Example
ReviewTriggerId
ReviewTriggerStatementKind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BENEFICIAL_OWNERS_CHANGE"
ReviewWhereInput
Description
Input for querying a review.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
RiskCalculationResult
Description
Result of an automated risk level calculation including scores and final risk level.
Fields
| Field Name | Description |
|---|---|
riskLevel - RiskLevelSetting
|
The final risk level determined from the total score |
totalScore - Int!
|
The total risk score (sum of all component scores) |
countryScore - RiskScoreResult!
|
Risk score from country evaluation |
legalFormScore - RiskScoreResult!
|
Risk score from legal form evaluation |
industryScore - RiskScoreResult!
|
Risk score from industry evaluation |
pepCountScore - RiskScoreResult!
|
Risk score from pep count evaluation |
sanctionCountScore - RiskScoreResult!
|
Risk score from sanction count evaluation |
customRiskFieldsScore - [CustomRiskFieldScore!]!
|
Risk scores from custom risk field evaluations |
timestamp - ISODateTime!
|
Timestamp of the risk calculation |
Example
{
"riskLevel": RiskLevelSetting,
"totalScore": 123,
"countryScore": RiskScoreResult,
"legalFormScore": RiskScoreResult,
"industryScore": RiskScoreResult,
"pepCountScore": RiskScoreResult,
"sanctionCountScore": RiskScoreResult,
"customRiskFieldsScore": [CustomRiskFieldScore],
"timestamp": ISODateTime
}
RiskClass
Description
Risk class for an entity. Risk class is set automatically through review automation, or by an AML officer through the application.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"HIGH"
RiskFactor
Description
A risk factor is a data point that could imply risk.
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
dateTime - DateTime!
|
|
paths - [PathConnection!]!
|
Path(s) describing the relationships traversed to find the risk signal. If empty, it means the risk signal arose from the entity itself. |
Example
{
"name": "xyz789",
"dateTime": "2007-12-03T10:15:30Z",
"paths": [PathConnection]
}
RiskLevelKind
Description
An enum representing supported risk levels
Values
| Enum Value | Description |
|---|---|
|
|
Critical risk level |
|
|
High risk level |
|
|
Low risk level |
|
|
Medium risk level |
|
|
No risk level |
|
|
Severe risk level |
Example
"CRITICAL"
RiskLevelSetting
Fields
| Field Name | Description |
|---|---|
riskLevel - RiskLevelKind!
|
|
label - String!
|
|
thresholdScore - Int!
|
Example
{
"riskLevel": "CRITICAL",
"label": "xyz789",
"thresholdScore": 123
}
RiskScoreResult
Description
A risk score with its matched values that contributed to the score
Fields
| Field Name | Description |
|---|---|
score - Int!
|
|
matchedValues - [String!]!
|
Example
{"score": 987, "matchedValues": ["abc123"]}
RiskSignal
Description
A risk signal is created when there exists a set of risk factors that satisfies its conditions.
Fields
| Field Name | Description |
|---|---|
name - String!
|
|
riskFactors - [RiskFactor!]!
|
Example
{
"name": "abc123",
"riskFactors": [RiskFactor]
}
RiskSignals
Fields
| Field Name | Description |
|---|---|
signals - [RiskSignal!]!
|
Example
{"signals": [RiskSignal]}
Role
Description
An object representing a role in a company.
Fields
| Field Name | Description |
|---|---|
roleTitle - String!
|
The role title. |
period - RolePeriod!
|
The date from which the role is active. |
isActive - Boolean!
|
The date from which the role is active. |
entity - EntityLike!
|
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. |
Example
{
"roleTitle": "abc123",
"period": RolePeriod,
"isActive": false,
"entity": EntityLike
}
RoleChange
RolePeriod
Sanction
Description
Information about a single sanction.
Fields
| Field Name | Description |
|---|---|
sanctionedBy - SanctionSource!
|
|
sourceReference - String
|
|
sanctionedSince - Date
|
The date the entity was sanctioned. NB! changes to this field will not be notified. |
program - String
|
The program under which the entity was sanctioned. NB! changes to this field will not be notified. |
sourceUrl - String
|
URL to view the sanction data from the source. NB! changes to this field will not be notified. |
confirmedMatch - 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. |
Example
{
"sanctionedBy": "CUSTOM",
"sourceReference": "xyz789",
"sanctionedSince": "2007-12-03",
"program": "abc123",
"sourceUrl": "xyz789",
"confirmedMatch": true
}
SanctionChange
Description
Change in sanction screening.
Fields
| Field Name | Description |
|---|---|
entity - EntityLike!
|
The entity for which the screening has changed. |
relationsToMonitoredEntity - [RelationKind!]!
|
How the entity is related to the monitored entity. |
toValue - SanctionInfo!
|
The changed screening result. |
fromValue - SanctionInfo
|
The previous screening result. |
Example
{
"entity": EntityLike,
"relationsToMonitoredEntity": ["BENEFICIAL_OWNER"],
"toValue": SanctionInfo,
"fromValue": SanctionInfo
}
SanctionInfo
Description
Sanction information.
Fields
| Field Name | Description |
|---|---|
sanctioned - Boolean!
|
|
sanctions - [Sanction!]!
|
|
Arguments
|
|
Example
{"sanctioned": false, "sanctions": [Sanction]}
SanctionSource
Description
The entity that issued the sanction.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CUSTOM"
SendFormInput
Fields
| Input Field | Description |
|---|---|
companyId - CompanyId!
|
Id of the company to be associated with the form |
formId - CustomerFacingFormId!
|
Id of the form you want to send |
recipientEmail - String!
|
Email address of the recipient |
recipientName - String!
|
Name of the recipient |
Example
{
"companyId": CompanyId,
"formId": CustomerFacingFormId,
"recipientEmail": "xyz789",
"recipientName": "xyz789"
}
SendFormPayload
Description
The payload for sending a customer facing form.
Fields
| Field Name | Description |
|---|---|
success - Boolean!
|
|
formInstanceId - FormInstanceId
|
The id of the created form instance |
Example
{"success": true, "formInstanceId": FormInstanceId}
SimpleUser
Description
A representation of users, which are a collection of entities.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the user. |
name - String!
|
The name of the user. |
avatar - String
|
The avatar of the user. |
email - String
|
The email of the user. |
accountKind - UserAccountKind!
|
Example
{
"id": "4",
"name": "abc123",
"avatar": "abc123",
"email": "abc123",
"accountKind": "AUTH0"
}
SizePageInfoInput
String
Description
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.
Example
"xyz789"
Tag
Description
Tag information, which can be used to label entities.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The tag ID. |
name - String!
|
The tag name. |
created - ISODateTime!
|
The date of creation. |
Example
{
"id": 4,
"name": "xyz789",
"created": ISODateTime
}
TextSpan
TimespanInput
Fields
| Input Field | Description |
|---|---|
from - ISODateTime
|
|
to - ISODateTime
|
Example
{
"from": ISODateTime,
"to": ISODateTime
}
UserAccountKind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUTH0"
Year
Description
A year in the ISO 8601 format (yyyy).
Example
Year