Fenergo Nebula Screening Query — OpenAPI 3.0.1 contract published by Fenergo for the screeningquery service of the Fen-X SaaS platform, carrying 12 path(s) and 12 operation(s). Harvested verbatim from Fenergo's own published specification endpoint.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/screeningquery-v1-0"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
{
"openapi": "3.0.1",
"info": {
"title": "Fenergo Nebula Screening Query",
"description": "**Screening Query API**:\n\n<br> Screening Query API retrieves screening results for screened clients and their associated parties. Use Screening Command API to perform the screening action and Screening Query API to retrieve screening results.\n\n<br> **Screening Query API Provides**:\n\n<br><ul><li> The ability to retrieve screening results for all entities within a given batch of Legal Entities. batchID + tenant can be used to retrieve screening results of all entities within a given batch.<li> The ability to retrieve batch data for a batch of Legal Entities. BatchID + tenant **OR** journeyID + tenant can be used to retrieve results for a batch of screened Legal Entities.<li> The ability to retrieve screening results for a single entity within a given batch of Legal Entities. EntityID + batchID + tenant can be used to retrieve screening results for a given entity.<li> The ability to retrieve screening results for all matches of a given entity. EntityID + batchID + tenant can be used to retrieve screening results that match the given entity.<li> The ability to retrieve screening results for matches of a given match ID. EntityID + batchID + matchID + tenant can be used to retrieve screening results that match the given match ID.",
"version": "1.0"
},
"servers": [
{
"url": "/screeningquery"
}
],
"paths": {
"/api/batch/{id}": {
"get": {
"tags": [
"Batch"
],
"summary": "Get data of an existing batch with batch Id",
"description": "\nThis method gets all the batch data for a given batch Id and tenant Id.\r\n\nThe method returns the batch object.<br /><br /><b>Required permissions:</b><br />Following permissions are required: ScreeningAccess",
"operationId": "GetBatchById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the existing batch to get",
"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 batch data is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchDtoServiceResponse"
}
}
}
},
"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 batch 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"
}
]
}
}
}
}
}
}
},
"/api/batch/journey/{journeyId}": {
"get": {
"tags": [
"Batch"
],
"summary": "Get data of an existing batch with journey Id",
"description": "\nThis method gets all the batch data linked to a journey Id and tenant Id.\r\n\nThe method returns the batch object.<br /><br /><b>Required permissions:</b><br />Following permissions are required: ScreeningAccess",
"operationId": "GetBatchByJourneyId",
"parameters": [
{
"name": "journeyId",
"in": "path",
"description": "The Id of the journey",
"required": true,
"schema": {
"type": "string"
}
},
{
"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 batch data is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchDtoServiceResponse"
}
}
}
},
"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 batch 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"
}
]
}
}
}
}
}
}
},
"/api/batch/journey/{journeyId}/process/{processId}": {
"get": {
"tags": [
"Batch"
],
"summary": "Get data of an existing batch with journey Id and process Id",
"description": "\nThis method gets all the batch data linked to a journey Id, process Id and tenant Id.\r\n\nThe method returns the batch object.<br /><br /><b>Required permissions:</b><br />Following permissions are required: ScreeningAccess",
"operationId": "GetBatchByJourneyAndProcessId",
"parameters": [
{
"name": "journeyId",
"in": "path",
"description": "The Id of the journey",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "processId",
"in": "path",
"description": "The Id of the process that started the batch",
"required": true,
"schema": {
"type": "string"
}
},
{
"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 batch data is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchDtoServiceResponse"
}
}
}
},
"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 batch 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"
}
]
}
}
}
}
}
}
},
"/api/batch/legalentity/{legalEntityId}": {
"get": {
"tags": [
"Batch"
],
"summary": "Get the batches with Legal Entity Id",
"description": "\nThis method gets all the batches linked to a Legal Entity Id and Tenant Id.\r\n\nThe method returns the batch array.<br /><br /><b>Required permissions:</b><br />Following permissions are required: ScreeningAccess",
"operationId": "GetBatchesByLegalEntityId",
"parameters": [
{
"name": "legalEntityId",
"in": "path",
"description": "The Id of the Legal Entity",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "onlyWithTrueMatches",
"in": "query",
"description": "Flag to return only the batches with true matches",
"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 batches are returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LegalEntityBatchDtoIEnumerableServiceResponse"
}
}
}
},
"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 Legal 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"
}
]
}
}
}
}
}
}
},
"/api/batch/{batchId}/entity/{entityId}/match": {
"get": {
"tags": [
"Match"
],
"summary": "Get all matches for an entity",
"description": "\nThis method returns all matches for a given entity ID, batch ID and tenant ID.\r\n\nThe method will return a list of match objects.<br /><br /><b>Required permissions:</b><br />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"
}
]
}
}
}
}
}
}
},
"/api/batch/{batchId}/entity/{entityId}/match/{matchId}": {
"get": {
"tags": [
"Match"
],
"summary": "Get data of a match",
"description": "\nThis method returns the match data for a given match ID, entity ID, batch ID and tenant ID.\r\n\nThe method will return the match object.<br /><br /><b>Required permissions:</b><br />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"
}
]
}
}
}
}
}
}
},
"/api/scoped-entity/journey/{journeyId}/process/{processId}": {
"get": {
"tags": [
"ScopedEntity"
],
"summary": "Get all entities in scope for Screening for a given Journey and Process",
"description": "\nThis method returns all entities and whether or not they are in scope for Screening for a given Journey and Process.\r\n\nThe method returns a list of scoped entity objects.<br /><br /><b>Required permissions:</b><br />Following permissions are required: ScreeningAccess",
"operationId": "GetScopedEntitiesByJourneyAndProcessId",
"parameters": [
{
"name": "journeyId",
"in": "path",
"description": "The ID of the journey",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "processId",
"in": "path",
"description": "The ID of the process that started the Screening request",
"required": true,
"schema": {
"type": "string"
}
},
{
"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 entities in scope for Screening is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScopedEntityDtoIEnumerableServiceResponse"
}
}
}
},
"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": "Err
# --- truncated at 32 KB (118 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fenergo/refs/heads/main/openapi/fenergo-screeningquery-v1-0-openapi.json