openapi: 3.2.0 info: title: Fenergo Screening Entity API version: '1.0' description: 'Operations tagged ScreeningEntity 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: ScreeningEntity paths: /api/entity/{entityId}: get: tags: - ScreeningEntity summary: Gets an existing Screening entity by ID description: 'This method is used to get the data of an existing Screening entity by ID. Required permissions: Following permissions are required: ScreeningAccess' operationId: GetEntity parameters: - name: entityId in: path description: The Screening ID of the entity 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 data of the entity is returned content: application/json: schema: $ref: '#/components/schemas/ScreeningEntityDtoServiceResponse' '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 entity couldn't 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/entity/getentitieslist: post: tags: - ScreeningEntity summary: Get a list of all screening entities found corresponding to a list of legal… description: 'This method returns a list of all screening entity objects found corresponding to a given list of legal entity IDs. Pre-requisites: For a screening entity to be returned for a given legal entity id, it must already exist in the Screening domain. If no screening entity is found for a given legal entity id, it will simply not be included in the response. The response will contain only the screening entities found. A maximum number of 100 legal entity IDs can be submitted in a single request. To query for more, please split them into multiple requests. Required permissions: Following permissions are required: ScreeningAccess' operationId: GetEntitiesList parameters: - 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 requestBody: description: Get entities list request content: application/json: schema: allOf: - $ref: '#/components/schemas/GetEntitiesListDtoServiceRequest' responses: '200': description: Success. A list of one or more screening entities is returned content: application/json: schema: $ref: '#/components/schemas/ScreeningEntityDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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/entity/{entityId}: get: tags: - ScreeningEntity summary: Gets an existing Screening entity by ID description: 'This method is used to get the data of an existing Screening entity by ID. Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV2EntityByEntityId parameters: - name: entityId in: path description: The Screening ID of the entity 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 data of the entity is returned content: application/json: schema: $ref: '#/components/schemas/ScreeningEntityDtoServiceResponse' '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 entity couldn't 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: GetEntity servers: - url: /screeningquery /api/v2/entity/getentitieslist: post: tags: - ScreeningEntity summary: Get a list of all screening entities found corresponding to a list of legal… description: 'This method returns a list of all screening entity objects found corresponding to a given list of legal entity IDs. Pre-requisites: For a screening entity to be returned for a given legal entity id, it must already exist in the Screening domain. If no screening entity is found for a given legal entity id, it will simply not be included in the response. The response will contain only the screening entities found. A maximum number of 100 legal entity IDs can be submitted in a single request. To query for more, please split them into multiple requests. Required permissions: Following permissions are required: ScreeningAccess' operationId: postApiV2EntityGetentitieslist parameters: - 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 requestBody: description: Get entities list request content: application/json: schema: allOf: - $ref: '#/components/schemas/GetEntitiesListDtoServiceRequest' responses: '200': description: Success. A list of one or more screening entities is returned content: application/json: schema: $ref: '#/components/schemas/ScreeningEntityDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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: GetEntitiesList servers: - url: /screeningquery /api/v3/entity/{entityId}: get: tags: - ScreeningEntity summary: Gets an existing Screening entity by ID description: 'This method is used to get the data of an existing Screening entity by ID. Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV3EntityByEntityId parameters: - name: entityId in: path description: The Screening ID of the entity 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 data of the entity is returned content: application/json: schema: $ref: '#/components/schemas/ScreeningEntityDtoServiceResponse' '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 entity couldn't 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: GetEntity servers: - url: /screeningquery /api/v3/entity/getentitieslist: post: tags: - ScreeningEntity summary: Get a list of all screening entities found corresponding to a list of legal… description: 'This method returns a list of all screening entity objects found corresponding to a given list of legal entity IDs. Pre-requisites: For a screening entity to be returned for a given legal entity id, it must already exist in the Screening domain. If no screening entity is found for a given legal entity id, it will simply not be included in the response. The response will contain only the screening entities found. A maximum number of 100 legal entity IDs can be submitted in a single request. To query for more, please split them into multiple requests. Required permissions: Following permissions are required: ScreeningAccess' operationId: postApiV3EntityGetentitieslist parameters: - 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 requestBody: description: Get entities list request content: application/json: schema: allOf: - $ref: '#/components/schemas/GetEntitiesListDtoServiceRequest' responses: '200': description: Success. A list of one or more screening entities is returned content: application/json: schema: $ref: '#/components/schemas/ScreeningEntityDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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: GetEntitiesList servers: - url: /screeningquery /api/v4/entity/{entityId}: get: tags: - ScreeningEntity summary: Gets an existing Screening entity by ID description: 'This method is used to get the data of an existing Screening entity by ID. Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV4EntityByEntityId parameters: - name: entityId in: path description: The Screening ID of the entity 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 data of the entity is returned content: application/json: schema: $ref: '#/components/schemas/ScreeningEntityDtoServiceResponse' '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 entity couldn't 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: GetEntity servers: - url: /screeningquery /api/v4/entity/getentitieslist: post: tags: - ScreeningEntity summary: Get a list of all screening entities found corresponding to a list of legal… description: 'This method returns a list of all screening entity objects found corresponding to a given list of legal entity IDs. Pre-requisites: For a screening entity to be returned for a given legal entity id, it must already exist in the Screening domain. If no screening entity is found for a given legal entity id, it will simply not be included in the response. The response will contain only the screening entities found. A maximum number of 100 legal entity IDs can be submitted in a single request. To query for more, please split them into multiple requests. Required permissions: Following permissions are required: ScreeningAccess' operationId: postApiV4EntityGetentitieslist parameters: - 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 requestBody: description: Get entities list request content: application/json: schema: allOf: - $ref: '#/components/schemas/GetEntitiesListDtoServiceRequest' responses: '200': description: Success. A list of one or more screening entities is returned content: application/json: schema: $ref: '#/components/schemas/ScreeningEntityDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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: GetEntitiesList servers: - url: /screeningquery components: schemas: ScreeningEntityDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ScreeningEntityDto' description: Represent Screening Entity messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false GetEntitiesListDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/GetEntitiesListDto' description: Class to represent the request for GetEntitiesList additionalProperties: false 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 OngoingScreeningProviderDto: required: - providerId type: object properties: providerId: minLength: 1 type: string description: The provider ID. example: ProviderId ongoingScreeningEnabled: type: boolean description: If the entity is enabled for Ongoing Screening for the provider. example: true configurationSetIds: type: - array - 'null' items: type: string format: uuid description: 'The list of configuration set IDs where the entity is subscribed to for ongoing screening (applicable for the Segregation of Ongoing Screening feature).' example: - 76ce4f1a-8676-4d4f-be0f-ae57b99b7e27 - bb8cd902-1aa8-456e-a22d-a4fc470e8386 additionalProperties: false description: Represents a provider within the context of an entity ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ScreeningEntityDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ScreeningEntityDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ScreeningEntityDto: required: - searchCriteria type: object properties: id: type: string description: The unique ID for the entity. format: uuid example: e698cac9-4ecb-47a8-94fa-ad27322dcc26 legalEntityId: type: - string - 'null' description: The unique ID for a Legal Entity in Fen-X example: 4b061074-a91c-43fa-9743-906dbdfff689 searchCriteria: allOf: - $ref: '#/components/schemas/SearchCriteriaDto' description: The search criteria for the entity entityAliases: type: - array - 'null' items: $ref: '#/components/schemas/EntityAliasDto' description: The list of aliases for the entity that will be used to perform screening request providers: type: - array - 'null' items: $ref: '#/components/schemas/OngoingScreeningProviderDto' description: The providers used to screen the entity additionalProperties: false description: Represent Screening Entity SearchCriteriaDto: required: - type type: object properties: fullName: type: - string - 'null' description: The Individual's firstname and surname. Alternatively use FirstName with LastName. example: John Doe firstName: type: - string - 'null' description: The Individual's first name. Alternatively use FullName. example: John middleName: type: - string - 'null' description: The Individual's middle name example: David lastName: type: - string - 'null' description: The Individual's surname. Alternatively use FullName. example: Doe dateOfBirth: type: - string - 'null' description: The Individual's date of birth in DD/MM/YYYY format example: 31/12/1990 gender: type: - string - 'null' description: The Individual's gender example: Male legalEntityName: type: - string - 'null' description: Full Company name example: Fenergo type: minLength: 1 type: string description: Legal entity type i.e. Individual or Company example: Individual address: allOf: - $ref: '#/components/schemas/AddressDto' description: Address of the Individual or Company idNumber: type: - string - 'null' description: The Individual's or Company's ID number example: '1234' phoneNumber: type: - string - 'null' description: The Individual's or Company's phone number example: 020 7946 0000 emailAddress: type: - string - 'null' description: The Individual's or Company's email address example: john@doe.com nationality: type: - string - 'null' description: The Individual's nationality example: Irish countryOfResidence: type: - string - 'null' description: The Individual's country of residence example: Ireland placeOfBirth: type: - string - 'null' description: The Individual's place of birth example: Dublin placeOfBirthISO2: type: - string - 'null' description: The Individual's place of birth in country ISO2 code example: IE placeOfBirthISO3: type: - string - 'null' description: The Individual's place of birth in country ISO3 code example: IRL citizenship: type: - string - 'null' description: The Individual's citizenship example: Irish citizenshipISO2: type: - string - 'null' description: The Individual's citizenship in country ISO2 code example: IE citizenshipISO3: type: - string - 'null' description: The Individual's citizenship in country ISO3 code example: IRL registeredCountry: type: - string - 'null' description: The country the Company is registered in example: Ireland registeredCountryISO2: type: - string - 'null' description: The country the Company is registered in ISO2 code example: IE registeredCountryISO3: type: - string - 'null' description: The country the Company is registered in ISO3 code example: IRL subtype: type: - string - 'null' description: The subtype of an entity example: Vessel uniqueId: type: - string - 'null' description: The unique id of an entity that is part of a subtype example: VesselId otherInformation: type: - string - 'null' description: Other information about an individual or a company example: Information1|Information2|Information3 passportNumber: type: - string - 'null' description: Passport number of the individual example: '123456789' socialSecurityNumber: type: - string - 'null' description: Social Security Number (SSN) of the individual example: 555-50-1234 driversLicense: type: - string - 'null' description: Driver's License number of the individual example: SMITH580117SM9XJ employerIdentificationNumber: type: - string - 'null' description: Employer Identification Number (EIN) of the company example: 12-3456789 additionalProperties: false description: Represent the Search Criteria to perform a Screen request GetEntitiesListDto: required: - legalEntityIds type: object properties: legalEntityIds: type: array items: type: string description: The list of unique legal entity Ids for which the corresponding screening entities should be returned in the GetEntitiesListRequest additionalProperties: false description: Class to represent the request for GetEntitiesList EntityAliasDto: type: object properties: id: type: - string - 'null' description: The id of the entity alias, which in FenX is the id of the Alternate Names DataGroup item. example: 12be5a50-66c2-44bb-851e-afc4fc4a28c2 aliasType: type: - string - 'null' description: The type of the alias example: Also Known As fullName: type: - string - 'null' description: The Individual's firstname and surname. Alternatively use FirstName with LastName. example: John Doe firstName: type: - string - 'null' description: The Individual's first name. Alternatively use FullName. example: John middleName: type: - string - 'null' description: The Individual's middle name example: David lastName: type: - string - 'null' description: The Individual's surname. Alternatively use FullName. example: Doe legalEntityName: type: - string - 'null' description: Full Company name example: Fenergo additionalProperties: false description: Class to represent a Screening entity Alias 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 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