Fenergo Nebula External Data Adapter Receptor — OpenAPI 3.0.4 contract published by Fenergo for the externaldatareceptor service of the Fen-X SaaS platform, carrying 2 path(s) and 2 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/externaldatareceptor-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.4",
"info": {
"title": "Fenergo Nebula External Data Adapter Receptor",
"description": "## Purpose of the API\n\nThe purpose of the External Data Adapter Receptor API is to integrate the different External Data adapters (e.g. Kompany, BvD) with the main External Data service, by receiving the results of the available External Data operations (e.g. Test, Get, Search, Request Document, Ongoing Monitoring).\n\nOnce the results are sent to the Receptor by the Adapters, they will forwarded to the main External Data service for them to be processed.\n\n## Authentication\n\nThe authentication in the Receptor is driven by the headers that are available in the endpoints (X-TENANT-ID, X-PROVIDER-ID, X-ENCRYPTION-IV, X-AUTHENTICATION-MAC).\n\nTo authenticate the requests coming to the Receptor, two keys are used to encrypt and authenticate the request. There are a few things to take into account:\n\n<ul><li>The keys have a size of 256 bit. These keys should be encoded in base64 format and added to the External Data configuration of the provider and tenant</li>\n\n<li>For authentication, HMAC (SHA256) is used</li><li>For encryption, AES-CBC is used</li><li>The order of the process is: Encrypt-then-MAC. This means that the request body must be encrypted first using the encryption key, and then authenticated using the authentication key</li></ul>\n\n",
"version": "1.0"
},
"servers": [
{
"url": "/externaldatareceptor"
}
],
"paths": {
"/receptor/callback": {
"post": {
"tags": [
"Receptor"
],
"summary": "Callback",
"description": "\nThis method will handle adapters responses.\n Processes Adapter Responses",
"operationId": "Callback",
"parameters": [
{
"name": "Compression-Algorithm",
"in": "header",
"description": "Compression Algorithm e.g. gzip",
"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"
},
{
"name": "X-PROVIDER-ID",
"in": "header",
"description": "The ID of the provider",
"schema": {
"type": "string"
},
"example": "ProviderId"
},
{
"name": "X-ENCRYPTION-IV",
"in": "header",
"description": "The encryption IV key, base64 encoded",
"schema": {
"type": "string"
},
"example": "HgyUHIO81m0FcZfPS1lnUw=="
},
{
"name": "X-AUTHENTICATION-MAC",
"in": "header",
"description": "The authentication MAC key, base64 encoded",
"schema": {
"type": "string"
},
"example": "frr2J1pP5rUC6DLe8q1WNko7FmRqUOD8zYTQN4ABgiE="
}
],
"requestBody": {
"description": "Adapter response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdapterResponseDto"
},
"examples": {
"Search operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Search","status":"Success","errorDetails":null,"response":{"results":[{"id":"76ce4f1a-8676-4d4f-be0f-ae57b99b7e27","entityType":"Company","fullName":"My Company","matchHint":"Selected","matchScore":78,"data":{"companyType":"Some Value"}}]}}
},
"Search operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Search","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"Get operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Get","status":"Success","errorDetails":null,"response":{"documents":null,"client":{"id":"1234567","entityType":"Company","fullName":"Legal Entity Name","data":{"name":"Name"}},"hierarchy":{"associatedEntities":[{"id":"12345678","entityType":"Individual","fullName":"Legal Entity Name Related","uboType":null,"isActive":null,"data":{"id":"_dummy"}}],"associations":[{"parentId":"parentId","childId":"childId","ownershipPercentage":1.34,"associationType":"CompanyOfficial","data":{"id":"_dummy"}}]}}}
},
"Get operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Get","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"Test operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Test","status":"Success","errorDetails":null,"response":{"adapterSchema":{"lookups":[{"name":"EntityType","values":["Private Company","Public Company"]}],"schema":{"searchRequest":{"searchCriteria":{"fields":[{"name":"LegalEntityName","friendlyName":"Legal Entity Name","type":"text","description":null,"lookup":null,"fields":null}]}},"searchResponse":{"searchResultsData":{"fields":[{"name":"LegalEntityName","friendlyName":"Legal Entity Name","type":"text","description":null,"lookup":null,"fields":null}]}},"getRequest":{"requestData":{"fields":[{"name":"Id","friendlyName":"Id","type":"text","description":null,"lookup":null,"fields":null}]}},"getResponse":{"clientData":{"fields":[{"name":"LegalEntityName","friendlyName":"Legal Entity Name","type":"text","description":null,"lookup":null,"fields":null}]},"associatedEntitiesCompanyData":{"fields":[{"name":"LegalEntityName","friendlyName":"Legal Entity Name","type":"text","description":null,"lookup":null,"fields":null}]},"associatedEntitiesIndividualData":{"fields":[{"name":"LegalEntityName","friendlyName":"Legal Entity Name","type":"text","description":null,"lookup":null,"fields":null}]},"associationsData":{"fields":[{"name":"ChildId","friendlyName":"Child Id","type":"text","description":null,"lookup":null,"fields":null}]}}}},"adapterSchemaIndividual":null}}
},
"Test operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Test","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"Document operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Document","status":"Success","errorDetails":null,"response":{"results":[{"documentId":"docId1","fileLocation":"sample1.pdf","status":"DocumentReceived","errorDetails":null,"data":null,"receiveDate":null}]}}
},
"Document operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Document","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"Ubo operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Ubo","status":"Success","errorDetails":null,"response":{"results":{"id":"1234567","entityId":"entityId","status":"Aborted","fileLocation":null,"purchasedDocuments":null,"hierarchy":{"associatedEntities":[{"id":"12345678","entityType":"Individual","fullName":"Legal Entity Name Related","uboType":null,"isActive":null,"data":{"id":"_dummy"}}],"associations":[{"parentId":"parentId","childId":"childId","ownershipPercentage":1.34,"associationType":"CompanyOfficial","data":{"id":"_dummy"}}]},"errorDetails":{"source":"adapter","errorCode":"code","message":"Ubo Discovery was aborted on demand of user."}}}}
},
"Ubo operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Ubo","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"OngoingMonitoringSubscription operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringSubscription","status":"Success","errorDetails":null,"response":{"subscriptionId":"subscriptionId","data":null}}
},
"OngoingMonitoringSubscription operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringSubscription","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"OngoingMonitoringUnsubscription operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringUnsubscription","status":"Success","errorDetails":null,"response":{"subscriptionId":"subscriptionId","data":null}}
},
"OngoingMonitoringUnsubscription operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringUnsubscription","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"OngoingMonitoringNotification operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringNotification","status":"Success","errorDetails":null,"response":{"entityId":"EntityId","eventType":null,"eventSubtype":null,"data":null}}
},
"OngoingMonitoringNotification operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringNotification","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
}
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AdapterResponseDto"
},
"examples": {
"Search operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Search","status":"Success","errorDetails":null,"response":{"results":[{"id":"76ce4f1a-8676-4d4f-be0f-ae57b99b7e27","entityType":"Company","fullName":"My Company","matchHint":"Selected","matchScore":78,"data":{"companyType":"Some Value"}}]}}
},
"Search operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Search","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"Get operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Get","status":"Success","errorDetails":null,"response":{"documents":null,"client":{"id":"1234567","entityType":"Company","fullName":"Legal Entity Name","data":{"name":"Name"}},"hierarchy":{"associatedEntities":[{"id":"12345678","entityType":"Individual","fullName":"Legal Entity Name Related","uboType":null,"isActive":null,"data":{"id":"_dummy"}}],"associations":[{"parentId":"parentId","childId":"childId","ownershipPercentage":1.34,"associationType":"CompanyOfficial","data":{"id":"_dummy"}}]}}}
},
"Get operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Get","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"Test operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Test","status":"Success","errorDetails":null,"response":{"adapterSchema":{"lookups":[{"name":"EntityType","values":["Private Company","Public Company"]}],"schema":{"searchRequest":{"searchCriteria":{"fields":[{"name":"LegalEntityName","friendlyName":"Legal Entity Name","type":"text","description":null,"lookup":null,"fields":null}]}},"searchResponse":{"searchResultsData":{"fields":[{"name":"LegalEntityName","friendlyName":"Legal Entity Name","type":"text","description":null,"lookup":null,"fields":null}]}},"getRequest":{"requestData":{"fields":[{"name":"Id","friendlyName":"Id","type":"text","description":null,"lookup":null,"fields":null}]}},"getResponse":{"clientData":{"fields":[{"name":"LegalEntityName","friendlyName":"Legal Entity Name","type":"text","description":null,"lookup":null,"fields":null}]},"associatedEntitiesCompanyData":{"fields":[{"name":"LegalEntityName","friendlyName":"Legal Entity Name","type":"text","description":null,"lookup":null,"fields":null}]},"associatedEntitiesIndividualData":{"fields":[{"name":"LegalEntityName","friendlyName":"Legal Entity Name","type":"text","description":null,"lookup":null,"fields":null}]},"associationsData":{"fields":[{"name":"ChildId","friendlyName":"Child Id","type":"text","description":null,"lookup":null,"fields":null}]}}}},"adapterSchemaIndividual":null}}
},
"Test operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Test","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"Document operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Document","status":"Success","errorDetails":null,"response":{"results":[{"documentId":"docId1","fileLocation":"sample1.pdf","status":"DocumentReceived","errorDetails":null,"data":null,"receiveDate":null}]}}
},
"Document operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Document","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"Ubo operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Ubo","status":"Success","errorDetails":null,"response":{"results":{"id":"1234567","entityId":"entityId","status":"Aborted","fileLocation":null,"purchasedDocuments":null,"hierarchy":{"associatedEntities":[{"id":"12345678","entityType":"Individual","fullName":"Legal Entity Name Related","uboType":null,"isActive":null,"data":{"id":"_dummy"}}],"associations":[{"parentId":"parentId","childId":"childId","ownershipPercentage":1.34,"associationType":"CompanyOfficial","data":{"id":"_dummy"}}]},"errorDetails":{"source":"adapter","errorCode":"code","message":"Ubo Discovery was aborted on demand of user."}}}}
},
"Ubo operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Ubo","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"OngoingMonitoringSubscription operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringSubscription","status":"Success","errorDetails":null,"response":{"subscriptionId":"subscriptionId","data":null}}
},
"OngoingMonitoringSubscription operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringSubscription","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"OngoingMonitoringUnsubscription operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringUnsubscription","status":"Success","errorDetails":null,"response":{"subscriptionId":"subscriptionId","data":null}}
},
"OngoingMonitoringUnsubscription operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringUnsubscription","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"OngoingMonitoringNotification operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringNotification","status":"Success","errorDetails":null,"response":{"entityId":"EntityId","eventType":null,"eventSubtype":null,"data":null}}
},
"OngoingMonitoringNotification operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringNotification","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
}
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AdapterResponseDto"
},
"examples": {
"Search operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Search","status":"Success","errorDetails":null,"response":{"results":[{"id":"76ce4f1a-8676-4d4f-be0f-ae57b99b7e27","entityType":"Company","fullName":"My Company","matchHint":"Selected","matchScore":78,"data":{"companyType":"Some Value"}}]}}
},
"Search operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Search","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"Get operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Get","status":"Success","errorDetails":null,"response":{"documents":null,"client":{"id":"1234567","entityType":"Company","fullName":"Legal Entity Name","data":{"name":"Name"}},"hierarchy":{"associatedEntities":[{"id":"12345678","entityType":"Individual","fullName":"Legal Entity Name Related","uboType":null,"isActive":null,"data":{"id":"_dummy"}}],"associations":[{"parentId":"parentId","childId":"childId","ownershipPercentage":1.34,"associationType":"CompanyOfficial","data":{"id":"_dummy"}}]}}}
},
"Get operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Get","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"Test operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Test","status":"Success","errorDetails":null,"response":{"adapterSchema":{"lookups":[{"name":"EntityType","values":["Private Company","Public Company"]}],"schema":{"searchRequest":{"searchCriteria":{"fields":[{"name":"LegalEntityName","friendlyName":"Legal Entity Name","type":"text","description":null,"lookup":null,"fields":null}]}},"searchResponse":{"searchResultsData":{"fields":[{"name":"LegalEntityName","friendlyName":"Legal Entity Name","type":"text","description":null,"lookup":null,"fields":null}]}},"getRequest":{"requestData":{"fields":[{"name":"Id","friendlyName":"Id","type":"text","description":null,"lookup":null,"fields":null}]}},"getResponse":{"clientData":{"fields":[{"name":"LegalEntityName","friendlyName":"Legal Entity Name","type":"text","description":null,"lookup":null,"fields":null}]},"associatedEntitiesCompanyData":{"fields":[{"name":"LegalEntityName","friendlyName":"Legal Entity Name","type":"text","description":null,"lookup":null,"fields":null}]},"associatedEntitiesIndividualData":{"fields":[{"name":"LegalEntityName","friendlyName":"Legal Entity Name","type":"text","description":null,"lookup":null,"fields":null}]},"associationsData":{"fields":[{"name":"ChildId","friendlyName":"Child Id","type":"text","description":null,"lookup":null,"fields":null}]}}}},"adapterSchemaIndividual":null}}
},
"Test operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Test","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"Document operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Document","status":"Success","errorDetails":null,"response":{"results":[{"documentId":"docId1","fileLocation":"sample1.pdf","status":"DocumentReceived","errorDetails":null,"data":null,"receiveDate":null}]}}
},
"Document operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Document","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"Ubo operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Ubo","status":"Success","errorDetails":null,"response":{"results":{"id":"1234567","entityId":"entityId","status":"Aborted","fileLocation":null,"purchasedDocuments":null,"hierarchy":{"associatedEntities":[{"id":"12345678","entityType":"Individual","fullName":"Legal Entity Name Related","uboType":null,"isActive":null,"data":{"id":"_dummy"}}],"associations":[{"parentId":"parentId","childId":"childId","ownershipPercentage":1.34,"associationType":"CompanyOfficial","data":{"id":"_dummy"}}]},"errorDetails":{"source":"adapter","errorCode":"code","message":"Ubo Discovery was aborted on demand of user."}}}}
},
"Ubo operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Ubo","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"OngoingMonitoringSubscription operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringSubscription","status":"Success","errorDetails":null,"response":{"subscriptionId":"subscriptionId","data":null}}
},
"OngoingMonitoringSubscription operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringSubscription","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"OngoingMonitoringUnsubscription operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringUnsubscription","status":"Success","errorDetails":null,"response":{"subscriptionId":"subscriptionId","data":null}}
},
"OngoingMonitoringUnsubscription operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringUnsubscription","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
},
"OngoingMonitoringNotification operation - Success - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringNotification","status":"Success","errorDetails":null,"response":{"entityId":"EntityId","eventType":null,"eventSubtype":null,"data":null}}
},
"OngoingMonitoringNotification operation - Error - Entity type 'Company'": {
"value": {"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingMonitoringNotification","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"response":null}
}
}
}
}
},
"responses": {
"202": {
"description": "Success. Data Accepted"
},
"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"
}
}
}
},
"/receptor/getPresignedUrl": {
"post": {
"tags": [
"Receptor"
],
"summary": "Create presigned url for S3 upload",
"operationId": "GetPresignedUrl",
"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"
},
{
"name": "X-PROVIDER-ID",
"in": "header",
"description": "The ID of the provider",
"schema": {
"type": "string"
},
"example": "ProviderId"
},
{
"name": "X-ENCRYPTION-IV",
"in": "header",
"description": "The encryption IV key, base64 encoded",
"schema": {
"type": "string"
},
"example": "HgyUHIO81m0FcZfPS1lnUw=="
},
{
"name": "X-AUTHENTICATION-MAC",
"in": "header",
"description": "The authentication MAC key, base64 encoded",
"schema": {
"type": "string"
},
"example": "frr2J1pP5rUC6DLe8q1WNko7FmRqUOD8zYTQN4ABgiE="
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSignedUrlRequestDto"
},
"example": {"documentData":[{"extension":"pdf"},{"extension":".pdf"}]}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateSignedUrlRequestDto"
},
"example": {"documentData":[{"extension":"pdf"},{"extension":".pdf"}]}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateSignedUrlRequestDto"
},
"example": {"documentData":[{"extension":"pdf"},{"extension":".pdf"}]}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CreateSignedUrlResponseDtoListServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSignedUrlResponseDtoListServiceResponse"
}
},
"text/json": {
"schema": {
# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fenergo/refs/heads/main/openapi/fenergo-externaldatareceptor-v1-0-openapi.json