openapi: 3.2.0 info: title: Fenergo Match API version: '1.0' description: 'Operations tagged Match across 4 of this provider''s published API definitions: fenergo-screeningquery-v1-0-openapi.json, fenergo-screeningquery-v2-0-openapi.json, fenergo-screeningquery-v3-0-openapi.json, fenergo-screeningquery-v4-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /screeningquery security: - Bearer: [] tags: - name: Match paths: /api/batch/{batchId}/entity/{entityId}/match: get: tags: - Match summary: Get all matches for an entity description: 'This method returns all matches for a given entity ID, batch ID and tenant ID. The method will return a list of match objects. Required permissions: Following permissions are required: ScreeningAccess' operationId: GetMatchesByEntityId parameters: - name: entityId in: path description: The ID of the entity the matches belong to required: true schema: type: string format: uuid - name: batchId in: path description: The batch ID the entity belongs to required: true schema: type: string format: uuid - name: returnMaterialMatches in: query description: Return only matches with status Match schema: type: boolean default: false - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The list of matches is returned content: application/json: schema: $ref: '#/components/schemas/MatchDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningquery /api/batch/{batchId}/entity/{entityId}/match/{matchId}: get: tags: - Match summary: Get data of a match description: 'This method returns the match data for a given match ID, entity ID, batch ID and tenant ID. The method will return the match object. Required permissions: Following permissions are required: ScreeningAccess' operationId: GetMatchById parameters: - name: entityId in: path description: The entity ID the match belongs to required: true schema: type: string format: uuid - name: batchId in: path description: The batch ID the entity belongs to required: true schema: type: string format: uuid - name: matchId in: path description: The ID of the match required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The match data is returned content: application/json: schema: $ref: '#/components/schemas/MatchDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. The match could not be found type: Error errorCode: Error Code '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningquery /api/v2/batch/{batchId}/entity/{entityId}/match: get: tags: - Match summary: Get all matches for an entity description: 'This method returns all matches for a given entity ID, batch ID and tenant ID. The method will return a list of match objects. Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV2BatchByBatchIdEntityByEntityIdMatch parameters: - name: entityId in: path description: The ID of the entity the matches belong to required: true schema: type: string format: uuid - name: batchId in: path description: The batch ID the entity belongs to required: true schema: type: string format: uuid - name: returnMaterialMatches in: query description: Return only matches with status Match schema: type: boolean default: false - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The list of matches is returned content: application/json: schema: $ref: '#/components/schemas/MatchDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetMatchesByEntityId servers: - url: /screeningquery /api/v2/batch/{batchId}/entity/{entityId}/match/{matchId}: get: tags: - Match summary: Get data of a match description: 'This method returns the match data for a given match ID, entity ID, batch ID and tenant ID. The method will return the match object. Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV2BatchByBatchIdEntityByEntityIdMatchByMatchId parameters: - name: entityId in: path description: The entity ID the match belongs to required: true schema: type: string format: uuid - name: batchId in: path description: The batch ID the entity belongs to required: true schema: type: string format: uuid - name: matchId in: path description: The ID of the match required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The match data is returned content: application/json: schema: $ref: '#/components/schemas/MatchDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. The match could not be found type: Error errorCode: Error Code '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetMatchById servers: - url: /screeningquery /api/v3/batch/{batchId}/entity/{entityId}/match: get: tags: - Match summary: Get all matches for an entity description: 'This method returns all matches for a given entity ID, batch ID and tenant ID. The method will return a list of match objects. Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV3BatchByBatchIdEntityByEntityIdMatch parameters: - name: entityId in: path description: The ID of the entity the matches belong to required: true schema: type: string format: uuid - name: batchId in: path description: The batch ID the entity belongs to required: true schema: type: string format: uuid - name: returnMaterialMatches in: query description: Return only matches with status Match schema: type: boolean default: false - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The list of matches is returned content: application/json: schema: $ref: '#/components/schemas/MatchDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetMatchesByEntityId servers: - url: /screeningquery /api/v3/batch/{batchId}/entity/{entityId}/match/{matchId}: get: tags: - Match summary: Get data of a match description: 'This method returns the match data for a given match ID, entity ID, batch ID and tenant ID. The method will return the match object. Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV3BatchByBatchIdEntityByEntityIdMatchByMatchId parameters: - name: entityId in: path description: The entity ID the match belongs to required: true schema: type: string format: uuid - name: batchId in: path description: The batch ID the entity belongs to required: true schema: type: string format: uuid - name: matchId in: path description: The ID of the match required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The match data is returned content: application/json: schema: $ref: '#/components/schemas/MatchDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. The match could not be found type: Error errorCode: Error Code '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: GetMatchById servers: - url: /screeningquery /api/v4/batch/{batchId}/entity/{entityId}/match: get: tags: - Match summary: Get all matches for an entity description: 'This method returns all matches for a given entity ID, batch ID and tenant ID. The method will return a list of match objects. Required permissions: Following permissions are required: ScreeningAccess' operationId: GetMatchesByEntityIdV4 parameters: - name: entityId in: path description: The ID of the entity the matches belong to required: true schema: type: string format: uuid - name: batchId in: path description: The batch ID the entity belongs to required: true schema: type: string format: uuid - name: returnMaterialMatches in: query description: Return only matches with status Match schema: type: boolean default: false - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The list of matches is returned content: application/json: schema: $ref: '#/components/schemas/MatchDtoV4IEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningquery /api/v4/batch/{batchId}/entity/{entityId}/match/{matchId}: get: tags: - Match summary: Get data of a match description: 'This method returns the match data for a given match ID, entity ID, batch ID and tenant ID. The method will return the match object. Required permissions: Following permissions are required: ScreeningAccess' operationId: GetMatchByIdV4 parameters: - name: entityId in: path description: The entity ID the match belongs to required: true schema: type: string format: uuid - name: batchId in: path description: The batch ID the entity belongs to required: true schema: type: string format: uuid - name: matchId in: path description: The ID of the match required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Success. The match data is returned content: application/json: schema: $ref: '#/components/schemas/MatchDtoV4ServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. The match could not be found type: Error errorCode: Error Code '500': description: Internal server error '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /screeningquery components: schemas: ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false AssociationDto: type: object properties: externalId: type: - string - 'null' description: 'The unique identifier of the Associated Entity outside of Fen-X (i.e. in the underlying provider). Used to query the underlying provider for more information about the associated entity.' example: e_tr_wco_2256753 category: type: - string - 'null' description: Category of additional information example: Enforcement:Antitrust Violations fullName: type: - string - 'null' description: The name of the associated party example: Alphabet Inc. relationship: type: - string - 'null' description: How the entity and the associated party are related i.e shareholder, director example: Co-Defendant relationshipGroup: type: - string - 'null' description: The relationship group as reported by the underlying provider (e.g. Family, Associations) example: Family ownershipPercentage: type: - number - 'null' description: The ownership percentage of the associated party, as reported by the underlying provider format: double example: 19.74 additionalProperties: false description: Represents a relationship with another entity MatchDataDto: required: - providerId - providerSourceName type: object properties: externalId: type: - string - 'null' description: "The unique identifier of the match outside of Fen-X (i.e. in the underlying provider). \n\nIf using Alias Screening, this will be the ExternalId of the first entity in which this match appears.\nSo instead of using this field, ExternalIds should be used, as it contains the ExternalId for each of the aliases the match belongs to." example: 42fc9261-6343-4fb0-aea1-6023645ff84f externalIds: type: - array - 'null' items: $ref: '#/components/schemas/MatchDataExternalIdDto' description: "The unique identifiers of the match outside of Fen-X (i.e. in the underlying provider). \n\nThey will be used later on to resolve the matches on the provider side. There will be one (or more) ExternalId\nfor each of the entity alias ids related to this match" providerId: minLength: 1 type: string description: The ID of the Provider that returned the match example: ProviderId name: type: - string - 'null' description: The name of the matching entity example: Name aliases: type: - array - 'null' items: type: string description: Any aliases associated with the matching entity, formatted as a list of strings deprecated: true aliasesList: type: - array - 'null' items: $ref: '#/components/schemas/MatchDataAliasDto' description: Any aliases associated with the matching entity, formatted as a list of AliasDto gender: type: - string - 'null' description: The Individual's gender example: Male dateOfBirth: type: - string - 'null' description: The Individual's date of birth in DD/MM/YYYY format example: 31/12/1989 country: type: - string - 'null' description: The country example: Ireland entityType: type: - string - 'null' description: The type of entity i.e. Individual or Company example: Individual matchScore: type: number description: A confidence score generated by the screening provider to indicate how closely the result record matched the searched entity data. format: double example: 90 providerSourceName: minLength: 1 type: string description: The name of the screening provider example: SourceName providerSourceUrl: type: - string - 'null' description: URL of the match on the provider side example: www.sourceurl.com addresses: type: - array - 'null' items: $ref: '#/components/schemas/AddressDto' description: List of addresses of the Individual or Company citizenship: type: - string - 'null' description: The Individual's citizenship example: Irish nationality: type: - string - 'null' description: The Individual's nationality example: Irish placeOfBirth: type: - string - 'null' description: The Individual's place of birth example: Dublin countryOfResidence: type: - string - 'null' description: The Individual's country of residence example: Ireland additionalInfo: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalInfoDto' description: Additional information about the matching entity sourcesInfo: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalInfoDto' description: Contains links related to the result categories: type: - array - 'null' items: type: string description: The screening category that the result relates to (e.g. PEP, Sanctions, Enforcement, Adverse Media, etc.) sources: type: - array - 'null' items: type: string description: Contains links to sources of information related to the result registeredCountry: type: - string - 'null' description: The country the Company is registered in example: Ireland ids: type: - object - 'null' additionalProperties: type: - string - 'null' description: List of Ids returned by the underlying provider associations: type: - array - 'null' items: $ref: '#/components/schemas/AssociationDto' description: List of entities associated to the entity being screened richTextAdditionalDetails: type: - string - 'null' description: An optional property to store additional details about the match in rich text format additionalProperties: false description: Represents the details of a screening match MatchDataAliasDto: type: object properties: value: type: - string - 'null' description: The value example: TE type: type: - string - 'null' description: The type example: Acronym additionalProperties: false description: Represent the alias of an entity AddressDto: type: object properties: addressLine1: type: - string - 'null' description: The first line in the address example: 7107 Andell Rd addressLine2: type: - string - 'null' description: The second line in the address example: Portobello city: type: - string - 'null' description: The city example: Dublin postalCode: type: - string - 'null' description: The postal code example: D08 YY66 country: type: - string - 'null' description: The country example: Ireland countryISO2: type: - string - 'null' description: The country ISO2 code example: IE countryISO3: type: - string - 'null' description: The country ISO3 code example: IRL stateProvince: type: - string - 'null' description: The state or province example: Leinster type: type: - string - 'null' description: The type example: Personal category: type: - string - 'null' description: The category of the address example: Residential additionalProperties: false description: Represents the address of an entity MatchDto: type: object properties: id: type: string description: The unique ID for the match on a Legal Entity. A single entity can have no matches or more than one match. format: uuid example: 6fbfa5f9-124f-4159-b947-d9294ad48370 entityAliasIds: type: - array - 'null' items: type: string description: 'List of the Entity AliasIds that this match is associated with. When it''s associated with the primary name of the entity, one of them will be "PrimaryName". If the array is null or empty, it means that the match only belongs to the PrimaryName of the entity.' status: type: - string - 'null' description: The match status. This will be match/no match/unresolved example: No Match reason: type: - string - 'null' description: Connected to the match status example: No Name Match comments: type: - string - 'null' description: Any additional comments example: Additional comments matchData: allOf: - $ref: '#/components/schemas/MatchDataDto' description: Data related to the match lastActionedBy: allOf: - $ref: '#/components/schemas/LastActionedByDto' description: User/System who actioned the match additionalProperties: false description: Represents a Screening Match LastActionedByDto: type: object properties: id: type: - string - 'null' description: The id of the user taht actioned the resolution of the match example: 42fc9261-6343-4fb0-aea1-6023645ff84f type: type: - string - 'null' description: The type of the user that actioned the resolution of the match example: User reusedFromPreviousBatch: type: boolean description: Used to identify if the user that actioned the resolution of the match is reused from a previous batch actionedOn: type: - string - 'null' description: 'The date and time when the match was last actioned (server-generated, UTC). Null for matches actioned before this field was introduced (March 2026).' format: date-time additionalProperties: false description: Represents the details of a screening match AdditionalInfoDto: type: object properties: title: type: - string - 'null' description: Title of additional information example: Title content: type: - array - 'null' items: type: string description: Content of additional information additionalProperties: false description: Represents the additional info about the matching entity ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false MatchDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/MatchDto' description: Represents a Screening Match messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false MatchDataExternalIdDto: type: object properties: entityAliasId: type: - string - 'null' description: What entity Alias this externalId is associated with. Will be "PrimaryName" for the PrimaryName external ids example: e7b8f7c2-3c4a-4b2a-9e2d-1f2a3b4c5d6e value: type: - string - 'null' description: The value of the ID example: '1234' additionalProperties: false description: Class to represent a match external id MatchDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/MatchDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ClassificationDataDto: type: object properties: singleProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/ClassificationDataSinglePropertyDto' additionalProperties: false IdDetails: type: object properties: type: type: - string - 'null' description: The Type of Id of the entity example: Passport, Driving License value: type: - string - 'null' description: This is the Value of the ID of the entity example: D0999971, 000012ABCD country: type: - string - 'null' description: ID Issuing Country example: Ireland, USA label: type: - string - 'null' description: The human-readable name of the ID scheme, as reported by the underlying provider (e.g. the name of a registry or identifier scheme) example: National Registry of Legal Entities (CNPJ) issueDate: type: - string - 'null' description: Date on which Id is Issued. example: 31/12/1989 expiryDate: type: - string - 'null' description: Date on which ID expires example: 31/12/1989 additionalProperties: false ClassificationDataSinglePropertyDto: type: object properties: value: type: - string - 'null' label: type: - string - 'null' additionalProperties: false CategoryDetailRowDto: type: object properties: fields: type: - array - 'null' items: $ref: '#/components/schemas/CategoryDetailFieldDto' description: The fields of this row subRows: type: - array - 'null' items: type: array items: $ref: '#/components/schemas/CategoryDetailFieldDto' description: An optional per-row nested table (e.g. SOE's per-country ownership breakdown) additionalProperties: false description: One row of a structured category detail table MatchDtoV4ServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/MatchDtoV4' description: Represents a Screening Match messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ProviderSourceLinkDto: type: object properties: url: type: - string - 'null' description: URL of the match on the provider side. example: https://myprovider.com/match/1 label: type: - string - 'null' description: Label for the URL link. example: View in MyProvider entityAliasId: type: - string - 'null' description: What entity Alias this ProviderSourceLink is associated with. example: e7b8f7c2-3c4a-4b2a-9e2d-1f2a3b4c5d6e additionalProperties: false description: Represents a URL link to the match on the provider's side, with an optional label. CategoryDetailFieldDto: type: object properties: label: type: - string - 'null' description: The label of the field example: Status value: type: - string - 'null' description: The value of the field example: Active additionalProperties: false description: One labelled field within a structured category detail row MatchDataDtoV4: required: - providerId - providerSourceName type: object properties: externalIds: type: - array - 'null' items: $ref: '#/components/schemas/MatchDataExternalIdDto' description: "The unique identifiers of the match outside of Fen-X (i.e. in the underlying provider). \n\nThey will be used later on to resolve the matches on the provider side. There will be one (or more) ExternalId\nfor each of the entity alias ids related to this match" providerId: minLength: 1 type: string description: The ID of the Provider that returned the match example: ProviderId name: type: - string - 'null' description: The name of the matching entity example: Name aliasesList: type: - array - 'null' items: $ref: '#/components/schemas/MatchDataAliasDto' description: Any aliases associated with the matching entity, formatted as a list of AliasDto gender: type: - string - 'null' description: The Individual's gender example: Male dateOfBirthList: type: - array - 'null' items: type: string description: List of Individual's date of birth in DD/MM/YYYY format from different Providers country: type: - string - 'null' description: The country example: Ireland entityType: type: - string - 'null' description: The type of entity i.e. Individual or Company example: Individual matchScore: type: number description: A confidence score generated by the screening provider to indicate how closely the result record matched the searched entity data. format: double example: 90 providerSourceName: minLength: 1 type: string description: The name of the screening provider example: SourceName providerSourceUrl: type: - string - 'null' description: URL of the match on the provider side example: www.sourceurl.com providerSourceUrls: type: - array - 'null' items: $ref: '#/components/schemas/ProviderSourceLinkDto' description: List of URL links of the match on the provider side, each with an optional label. addresses: type: - array - 'null' items: $ref: '#/components/schemas/AddressDto' description: List of addresses of the Individual or Company citizenshipList: type: - array - 'null' items: type: string description: List of Individual's citizenships nationalityList: type: - array - 'null' items: type: string description: List of Individual's nationalities placeOfBirthList: type: - array - 'null' items: type: string description: List of Individual's place of birth from different Providers countryOfResidence: type: - string - 'null' description: The Individual's country of residence example: Ireland additionalInfo: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalInfoDto' description: Additional information about the matching entity sourcesInfo: type: - array - 'null' items: $ref: '#/components/schemas/AdditionalInfoDto' description: Contains links related to the result categories: type: - array - 'null' items: type: string description: The screening category that the result relates to (e.g. PEP, Sanctions, Enforcement, Adverse Media, etc.) sources: type: - array - 'null' items: type: string description: Contains links to sources of information related to the result registeredCountry: type: - string - 'null' description: The country the Company is registered in example: Ireland idsList: type: - array - 'null' items: $ref: '#/components/schemas/IdDetails' description: List of Ids returned by the underlying provider associations: type: - array - 'null' items: $ref: '#/components/schemas/AssociationDto' description: List of entities associated to the entity being screened richTextAdditionalDetails: type: - string - 'null' description: An optional property to store additional details about the match in rich text format categoryDetails: type: - array - 'null' items: $ref: '#/components/schemas/CategoryDetailDto' description: 'WC Data Plus structured category data (PEP, Sanction, Enforcement, Adverse Media, SOE, Registration, Other), one entry per populated category kind that has at least one row.' additionalProperties: false description: Represents the details of a screening match CategoryDetailDto: type: object properties: kind: type: - string - 'null' description: The category this table's rows belong to example: Pep rows: type: - array - 'null' items: $ref: '#/components/schemas/CategoryDetailRowDto' description: The rows of this category's table additionalProperties: false description: One category's worth of structured detail rows (e.g. every PEP hit for this match) MatchDtoV4: type: object properties: id: type: string description: The unique ID for the match on a Legal Entity. A single entity can have no matches or more than one match. format: uuid example: 6fbfa5f9-124f-4159-b947-d9294ad48370 entityAliasIds: type: - array - 'null' items: type: string description: 'List of the Entity AliasIds that this match is associated with. When it''s associated with the primary name of the entity, one of them will be "PrimaryName". If the array is null or empty, it means that the match only belongs to the PrimaryName of the entity.' status: type: - string - 'null' description: The match status. This will be match/no match/unresolved example: No Match reason: type: - string - 'null' description: Connected to the match status example: No Name Match comments: type: - string - 'null' description: Any additional comments example: Additional comments matchData: allOf: - $ref: '#/components/schemas/MatchDataDtoV4' description: Data related to the match lastActionedBy: allOf: - $ref: '#/components/schemas/LastActionedByDto' description: User/System who actioned the match classificationData: allOf: - $ref: '#/components/schemas/ClassificationDataDto' description: Classification data for matched result. classificationDataReviewed: type: - boolean - 'null' description: 'Indicates whether the classification data for this match has been reviewed/confirmed. Null or false means not yet reviewed.' entityUniqueId: type: - string - 'null' description: 'The unique ID of the match returned by the Screening provider. This will be null for any matches that were created before April 2024. For matches created before April 2024, fallback to MatchData.IdsList to get the unique entity ID, which is stored under the type "EntityUniqueId" (or "EntityUniqueID" for WCO).' additionalProperties: false description: Represents a Screening Match MatchDtoV4IEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/MatchDtoV4' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-screeningquery-v1-0-openapi.json - fenergo-screeningquery-v2-0-openapi.json - fenergo-screeningquery-v3-0-openapi.json - fenergo-screeningquery-v4-0-openapi.json