Fenergo Nebula Digital IDV Query — OpenAPI 3.0.1 contract published by Fenergo for the digitalidvquery service of the Fen-X SaaS platform, carrying 21 path(s) and 21 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/digitalidvquery-v2-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 Digital IDV Query",
"description": "**Digital IDV Query API**:<br/><br/><br/> Digital IDV Query API provides endpoints in order to query all digital idv resources.<br/><br/><br/> **Digital IDV Query API provides**:<br/><ul><li> The ability to query digital idv resources.</li>",
"version": "2.0"
},
"servers": [
{
"url": "/digitalidvquery"
}
],
"paths": {
"/api/v2/configuration": {
"get": {
"tags": [
"Configuration"
],
"summary": "Get Configuration",
"description": "<br /><br /><b>Required permissions:</b><br />Following permissions are required: DigitalIdvAccess",
"operationId": "GetConfiguration",
"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"
}
],
"responses": {
"200": {
"description": "Instance of Fenergo.Nebula.DigitalIDV.Query.Application.Dto.ConfigurationDto class containing configuration information.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ConfigurationDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationDtoServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"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"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"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/v2/configuration/provider/{providerId}": {
"get": {
"tags": [
"Configuration"
],
"summary": "Get provider configuration",
"description": "\nThis method returns specific Digital IDV provider<br /><br /><b>Required permissions:</b><br />Following permissions are required: DigitalIdvConfiguration",
"operationId": "GetProviderConfiguration",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "The ID of provider",
"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": "Instance of Fenergo.Nebula.DigitalIDV.Query.Application.Dto.ProviderConfigurationDto class containing provider configuration information.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "There is no provider with given id",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"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"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"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/v2/entity-in-scope/journey/{journeyId}/ruleset/{rulesetId}": {
"get": {
"tags": [
"EntityInScopeForIdv"
],
"summary": "Gets all by journey identifier",
"description": "<br /><br /><b>Required permissions:</b><br />Following permissions are required: IdvAccess",
"operationId": "GetAllByJourneyIdRuleSetId",
"parameters": [
{
"name": "journeyId",
"in": "path",
"description": "The journey identifier.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "rulesetId",
"in": "path",
"description": "The ruleset identifier.",
"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": "A list of the Fenergo.Nebula.DigitalIDV.Query.Application.Dto.EntityInScopeForIdvDtoV2 class representing the Entity In Scope if found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EntityInScopeForIdvDtoV2IEnumerableServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityInScopeForIdvDtoV2IEnumerableServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EntityInScopeForIdvDtoV2IEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/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"
}
]
}
}
}
}
}
}
},
"/api/v2/entity-in-scope/journey/{journeyId}/entity/{entityId}/ruleset/{rulesetId}": {
"get": {
"tags": [
"EntityInScopeForIdv"
],
"summary": "Gets an Entity In Scope by Journey Id and Entity Id.",
"description": "<br /><br /><b>Required permissions:</b><br />Following permissions are required: IdvAccess",
"operationId": "GetByJourneyAndEntityIdRuleSetId",
"parameters": [
{
"name": "journeyId",
"in": "path",
"description": "The Journey identifier.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "entityId",
"in": "path",
"description": "The Entity identifier.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "rulesetId",
"in": "path",
"description": "The ruleset identifier.",
"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": "A Fenergo.Nebula.DigitalIDV.Query.Application.Dto.EntityInScopeForIdvDtoV2 class representing the Entity In Scope if found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EntityInScopeForIdvDtoV2ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityInScopeForIdvDtoV2ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EntityInScopeForIdvDtoV2ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. The Entity is not in scope for the Journey Id and Entity Id provided",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/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"
}
]
}
}
}
}
}
}
},
"/api/v2/entity-in-scope/evaluate": {
"post": {
"tags": [
"EntityInScopeForIdv"
],
"summary": "Evaluates a set of related parties against a scoping rule set on demand.",
"description": "<br /><br /><b>Required permissions:</b><br />At least one of the following permissions is required: DigitalIdvAccess, IdvAccess",
"operationId": "EvaluateEntitiesInScope",
"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": "The evaluation request: the rule set, the root client and the related parties to evaluate.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EvaluateEntitiesInScopeRequest"
}
],
"description": "HTTP request body for the on-demand related-party scoping evaluation.\nThe tenant is taken from the request security context, not the body."
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EvaluateEntitiesInScopeRequest"
}
],
"description": "HTTP request body for the on-demand related-party scoping evaluation.\nThe tenant is taken from the request security context, not the body."
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EvaluateEntitiesInScopeRequest"
}
],
"description": "HTTP request body for the on-demand related-party scoping evaluation.\nThe tenant is taken from the request security context, not the body."
}
}
}
},
"responses": {
"200": {
"description": "A Fenergo.Nebula.DigitalIDV.Query.Application.Dto.EntitiesInScope.EvaluateEntitiesInScopeDto with the ids of the related parties that are in scope.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EvaluateEntitiesInScopeDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluateEntitiesInScopeDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EvaluateEntitiesInScopeDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/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"
}
]
}
}
}
}
}
}
},
"/api/v2/idv-business-process/{businessProcessId}": {
"get": {
"tags": [
"IdvBusinessProcess"
],
"summary": "Get an Idv requirements validation business process",
"description": "\nGet the Idv requirements validation business process by id<br /><br /><b>Required permissions:</b><br />Following permissions are required: IdvAccess",
"operationId": "GetIdvRequirementsValidationBusinessProcess",
"parameters": [
{
"name": "businessProcessId",
"in": "path",
"description": "",
"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": "Idv requirements validation business process retrieved successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvRequirementsValidationBusinessProcessDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvRequirementsValidationBusinessProcessDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvRequirementsValidationBusinessProcessDtoServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Business process with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/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"
}
]
}
}
}
}
}
}
},
"/api/v2/IdvConfiguration/{id}/{configurationVersion}": {
"get": {
"tags": [
"IdvConfiguration"
],
"summary": "Get Idv Configuration",
"description": "<br /><br /><b>Required permissions:</b><br />Following permissions are required: DigitalIdvConfiguration",
"operationId": "GetIdvConfigurationByIdAndVersion",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "configurationVersion",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
# --- truncated at 32 KB (183 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fenergo/refs/heads/main/openapi/fenergo-digitalidvquery-v2-0-openapi.json