Fenergo Nebula Screening Adapter Receptor — OpenAPI 3.0.1 contract published by Fenergo for the screeningreceptor service of the Fen-X SaaS platform, carrying 1 path(s) and 1 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/screeningreceptor-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 Adapter Receptor",
"description": "## Purpose of the API\n\nThe purpose of the Screening Receptor API is to integrate the different Screening adapters (LN, WCO, etc) with the main Screening service, by receiving the results of the available Screening operations (Screen, Resolve Matches, Test, etc).\n\nOnce the results are sent to the Receptor by the Adapters, they will forwarded to the main Screening service for them to be processed.\n\n## Authentication\n\nThe authentication in the Receptor is driven by the optional 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 Screening configuration of the provider and tenant, using the Screening Command API</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## Compression and Content-Type\n\nThe Receptor API supports compressed and uncompressed request bodies. Users will need to provide appropriate values for the 'Compression-Algorithm' and 'Content-Type' headers depending on whether the request body is compressed or not:\n\n<ul><li>If the header 'Compression-Algorithm' is not specified in the request or its value is an empty string, the API won't try to decompress the request body. In this case, the value 'application/json' should be specified in the 'Content-Type' header</li><li>If the header 'Compression-Algorithm' is not empty, the API will decompress the request body with the algorithm specified in the header. So far, the only supported algorithm is 'gzip'. In this case, the value 'text/plain' should be specified in the 'Content-Type' header.\n\nThis online compression tool could be handy to get the compressed text from the JSON body: <a href='https://facia.dev/tools/compress-decompress/gzip-compress/' target='_blank'>Gzip compression tool</a></li></ul>\n\nThe correct order to compress the request body is:\n\n<ol><li>Set the 'gzip' value in the 'Compression-Algorithm' header</li><li>Set the 'text/plain' value in the ''Content-Type' header</li><li>Get the strongly typed response object</li><li>Serialize the strongly typed object to a JSON string</li><li>Compress the JSON string using the gzip algorithm</li><li>Convert the compressed stream to Base64 a string</li><li>If authentication is enabled, encrypt the Base64 string and set the authentication headers accordingly. Otherwise, send the Base64 string directly</li></ol>\n\n## Request payload limit\n\nThe Receptor API has a maximum request payload limit of 6MB. If the payload size is greater than that (either compressed or uncompressed), the API will throw an error.\n\n## Using Authentication and Compression together\n\nWhen both authentication and compression are used together, the order of the process is: Compress-Encrypt-MAC. This means that the request body must be compressed first, then encrypted using the encryption key, and finally authenticated using the authentication key.\n\n## Troubleshooting errors\n\nThe Receptor API performs some basic validations on the request that would give immediate feedback to the consumer of the API. For example, the consumer may get a 400 Bad Request error if some mandatory properties in the request body are missing. If the request is valid, the Receptor will return a 202 Accepted response.\n\nEven though the Receptor may return a successful response, errors could happen while processing the request in the Screening main service. In that scenario, it is possible to get the details of the errors that have occurred by using the Screening Query API. For example, the response of the 'api/batch/{id}' endpoint would include the error details if the 'Screen' results were not processed successfully.",
"version": "1.0"
},
"servers": [
{
"url": "/screeningreceptor"
}
],
"paths": {
"/api/receptor": {
"post": {
"tags": [
"Receptor"
],
"summary": "This method handles the results from the different screening adapters",
"operationId": "ReceiveResults",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"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="
},
{
"name": "Compression-Algorithm",
"in": "header",
"description": "<p>The compression algorithm (if any) that has been used to compress the body of the request.</p><p>Possible values: empty string (if body is not compressed), gzip</p>",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The response from the adapter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectAdapterResponseDto"
},
"examples": {
"Screen operation - Success - Entity type 'Individual'": {
"value": {"response":{"batchExternalIds":[{"source":"MyProviderId","name":"FieldInProvider","value":"1234"}],"entities":[{"entityId":"76ce4f1a-8676-4d4f-be0f-ae57b99b7e27","externalIds":[{"source":"MyProviderId","entityAliasId":"PrimaryName","name":"FieldInProvider","value":"1234"}],"matchesData":[{"externalId":"1234","externalIds":[{"entityAliasId":"PrimaryName","value":"1234"}],"providerId":"MyProviderId","entityAliasIds":["PrimaryName"],"name":"Test Entity","aliases":null,"aliasesList":[{"value":"TE","type":"Acronym"}],"gender":"Male","dateOfBirth":"25/01/1950","dateOfBirthList":null,"country":null,"entityType":"Individual","matchScore":100,"providerSourceName":"MyProviderName","providerSourceUrl":"https://myprovider.com/match/{matchId}","providerSourceUrls":null,"addresses":[{"addressLine1":"Address Line 1","addressLine2":"Address Line 2","city":"City","postalCode":"28793","country":"Country","countryISO2":null,"countryISO3":null,"stateProvince":"State or Province","type":"Main address","category":null}],"citizenship":"Irish","nationality":"Irish","placeOfBirth":"Dublin","citizenshipList":null,"nationalityList":null,"placeOfBirthList":null,"countryOfResidence":"Ireland","additionalInfo":[{"title":"Last Updated","content":["7/5/2022 12:00:00 AM +01:00"]}],"sourcesInfo":[{"title":"Entity URL","content":["URL1","URL2"]}],"categories":["Pep","Sanctions"],"sources":["URL1","URL2"],"registeredCountry":null,"ids":{"Id1":"158192327","Id2":"1465465"},"idsList":null,"associations":[{"externalId":"e_tr_wco_1231231","category":"Enforcements,AdverseMedia:CORPORATE","fullName":"Test Entity","relationship":"Affiliated entity","relationshipGroup":null,"ownershipPercentage":null}],"status":null,"reason":null,"comments":null,"subsidiaryFields":null,"richTextAdditionalDetails":"<html><body><p>Some rich text details</p></body></html>","categoryDetails":null}]}]},"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Screen","status":"Success","errorDetails":null,"uploadId":null}
},
"Screen operation - Success - Entity type 'Company'": {
"value": {"response":{"batchExternalIds":[{"source":"MyProviderId","name":"FieldInProvider","value":"1234"}],"entities":[{"entityId":"76ce4f1a-8676-4d4f-be0f-ae57b99b7e27","externalIds":[{"source":"MyProviderId","entityAliasId":"PrimaryName","name":"FieldInProvider","value":"1234"}],"matchesData":[{"externalId":"1234","externalIds":[{"entityAliasId":"PrimaryName","value":"1234"}],"providerId":"MyProviderId","entityAliasIds":["PrimaryName"],"name":"Test Entity","aliases":null,"aliasesList":[{"value":"TE","type":"Acronym"}],"gender":null,"dateOfBirth":null,"dateOfBirthList":null,"country":"Ireland","entityType":"Company","matchScore":100,"providerSourceName":"MyProviderName","providerSourceUrl":"https://myprovider.com/match/{matchId}","providerSourceUrls":null,"addresses":[{"addressLine1":"Address Line 1","addressLine2":"Address Line 2","city":"City","postalCode":"28793","country":"Country","countryISO2":null,"countryISO3":null,"stateProvince":"State or Province","type":"Main address","category":null}],"citizenship":null,"nationality":null,"placeOfBirth":null,"citizenshipList":null,"nationalityList":null,"placeOfBirthList":null,"countryOfResidence":null,"additionalInfo":[{"title":"Last Updated","content":["7/5/2022 12:00:00 AM +01:00"]}],"sourcesInfo":[{"title":"Entity URL","content":["URL1","URL2"]}],"categories":["Pep","Sanctions"],"sources":["URL1","URL2"],"registeredCountry":"Ireland","ids":{"Id1":"158192327","Id2":"1465465"},"idsList":null,"associations":[{"externalId":"e_tr_wco_1231231","category":"Enforcements,AdverseMedia:CORPORATE","fullName":"Test Entity","relationship":"Affiliated entity","relationshipGroup":null,"ownershipPercentage":null}],"status":null,"reason":null,"comments":null,"subsidiaryFields":null,"richTextAdditionalDetails":"<html><body><p>Some rich text details</p></body></html>","categoryDetails":null}]}]},"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Screen","status":"Success","errorDetails":null,"uploadId":null}
},
"Screen operation - Error": {
"value": {"response":null,"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Screen","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"uploadId":null}
},
"ResolveMatches operation - Success": {
"value": {"response":{},"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"ResolveMatches","status":"Success","errorDetails":null,"uploadId":null}
},
"ResolveMatches operation - Error": {
"value": {"response":null,"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"ResolveMatches","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"uploadId":null}
},
"Test operation - Success": {
"value": {"response":{},"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Test","status":"Success","errorDetails":null,"uploadId":null}
},
"Test operation - Error": {
"value": {"response":null,"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"},"uploadId":null}
},
"OngoingScreening operation - Success": {
"value": {"response":{},"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingScreening","status":"Success","errorDetails":null,"uploadId":null}
},
"OngoingScreening operation - Error": {
"value": {"response":null,"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingScreening","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"uploadId":null}
},
"OngoingScreeningUpdate operation - Success": {
"value": {"response":{},"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingScreeningUpdate","status":"Success","errorDetails":null,"uploadId":null}
},
"OngoingScreeningUpdate operation - Error": {
"value": {"response":null,"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingScreeningUpdate","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"uploadId":null}
},
"OngoingScreeningGetResults operation - Success - Entity type 'Individual'": {
"value": {"response":{"batchExternalIds":[{"source":"MyProviderId","name":"FieldInProvider","value":"1234"}],"entities":[{"entityId":null,"legalEntityId":"bb8cd902-1aa8-456e-a22d-a4fc470e8386","externalIds":[{"source":"MyProviderId","entityAliasId":"PrimaryName","name":"FieldInProvider","value":"1234"}],"matchesData":[{"externalId":"1234","externalIds":[{"entityAliasId":"PrimaryName","value":"1234"}],"providerId":"MyProviderId","entityAliasIds":["PrimaryName"],"name":"Test Entity","aliases":null,"aliasesList":[{"value":"TE","type":"Acronym"}],"gender":"Male","dateOfBirth":"25/01/1950","dateOfBirthList":null,"country":null,"entityType":"Individual","matchScore":100,"providerSourceName":"MyProviderName","providerSourceUrl":"https://myprovider.com/match/{matchId}","providerSourceUrls":null,"addresses":[{"addressLine1":"Address Line 1","addressLine2":"Address Line 2","city":"City","postalCode":"28793","country":"Country","countryISO2":null,"countryISO3":null,"stateProvince":"State or Province","type":"Main address","category":null}],"citizenship":"Irish","nationality":"Irish","placeOfBirth":"Dublin","citizenshipList":null,"nationalityList":null,"placeOfBirthList":null,"countryOfResidence":"Ireland","additionalInfo":[{"title":"Last Updated","content":["7/5/2022 12:00:00 AM +01:00"]}],"sourcesInfo":[{"title":"Entity URL","content":["URL1","URL2"]}],"categories":["Pep","Sanctions"],"sources":["URL1","URL2"],"registeredCountry":null,"ids":{"Id1":"158192327","Id2":"1465465"},"idsList":null,"associations":[{"externalId":"e_tr_wco_1231231","category":"Enforcements,AdverseMedia:CORPORATE","fullName":"Test Entity","relationship":"Affiliated entity","relationshipGroup":null,"ownershipPercentage":null}],"status":null,"reason":null,"comments":null,"subsidiaryFields":null,"richTextAdditionalDetails":"<html><body><p>Some rich text details</p></body></html>","categoryDetails":null}],"configurationSetId":null}]},"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingScreeningGetResults","status":"Success","errorDetails":null,"uploadId":null}
},
"OngoingScreeningGetResults operation - Success - Entity type 'Company'": {
"value": {"response":{"batchExternalIds":[{"source":"MyProviderId","name":"FieldInProvider","value":"1234"}],"entities":[{"entityId":null,"legalEntityId":"bb8cd902-1aa8-456e-a22d-a4fc470e8386","externalIds":[{"source":"MyProviderId","entityAliasId":"PrimaryName","name":"FieldInProvider","value":"1234"}],"matchesData":[{"externalId":"1234","externalIds":[{"entityAliasId":"PrimaryName","value":"1234"}],"providerId":"MyProviderId","entityAliasIds":["PrimaryName"],"name":"Test Entity","aliases":null,"aliasesList":[{"value":"TE","type":"Acronym"}],"gender":null,"dateOfBirth":null,"dateOfBirthList":null,"country":"Ireland","entityType":"Company","matchScore":100,"providerSourceName":"MyProviderName","providerSourceUrl":"https://myprovider.com/match/{matchId}","providerSourceUrls":null,"addresses":[{"addressLine1":"Address Line 1","addressLine2":"Address Line 2","city":"City","postalCode":"28793","country":"Country","countryISO2":null,"countryISO3":null,"stateProvince":"State or Province","type":"Main address","category":null}],"citizenship":null,"nationality":null,"placeOfBirth":null,"citizenshipList":null,"nationalityList":null,"placeOfBirthList":null,"countryOfResidence":null,"additionalInfo":[{"title":"Last Updated","content":["7/5/2022 12:00:00 AM +01:00"]}],"sourcesInfo":[{"title":"Entity URL","content":["URL1","URL2"]}],"categories":["Pep","Sanctions"],"sources":["URL1","URL2"],"registeredCountry":"Ireland","ids":{"Id1":"158192327","Id2":"1465465"},"idsList":null,"associations":[{"externalId":"e_tr_wco_1231231","category":"Enforcements,AdverseMedia:CORPORATE","fullName":"Test Entity","relationship":"Affiliated entity","relationshipGroup":null,"ownershipPercentage":null}],"status":null,"reason":null,"comments":null,"subsidiaryFields":null,"richTextAdditionalDetails":"<html><body><p>Some rich text details</p></body></html>","categoryDetails":null}],"configurationSetId":null}]},"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingScreeningGetResults","status":"Success","errorDetails":null,"uploadId":null}
}
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ObjectAdapterResponseDto"
},
"examples": {
"Screen operation - Success - Entity type 'Individual'": {
"value": {"response":{"batchExternalIds":[{"source":"MyProviderId","name":"FieldInProvider","value":"1234"}],"entities":[{"entityId":"76ce4f1a-8676-4d4f-be0f-ae57b99b7e27","externalIds":[{"source":"MyProviderId","entityAliasId":"PrimaryName","name":"FieldInProvider","value":"1234"}],"matchesData":[{"externalId":"1234","externalIds":[{"entityAliasId":"PrimaryName","value":"1234"}],"providerId":"MyProviderId","entityAliasIds":["PrimaryName"],"name":"Test Entity","aliases":null,"aliasesList":[{"value":"TE","type":"Acronym"}],"gender":"Male","dateOfBirth":"25/01/1950","dateOfBirthList":null,"country":null,"entityType":"Individual","matchScore":100,"providerSourceName":"MyProviderName","providerSourceUrl":"https://myprovider.com/match/{matchId}","providerSourceUrls":null,"addresses":[{"addressLine1":"Address Line 1","addressLine2":"Address Line 2","city":"City","postalCode":"28793","country":"Country","countryISO2":null,"countryISO3":null,"stateProvince":"State or Province","type":"Main address","category":null}],"citizenship":"Irish","nationality":"Irish","placeOfBirth":"Dublin","citizenshipList":null,"nationalityList":null,"placeOfBirthList":null,"countryOfResidence":"Ireland","additionalInfo":[{"title":"Last Updated","content":["7/5/2022 12:00:00 AM +01:00"]}],"sourcesInfo":[{"title":"Entity URL","content":["URL1","URL2"]}],"categories":["Pep","Sanctions"],"sources":["URL1","URL2"],"registeredCountry":null,"ids":{"Id1":"158192327","Id2":"1465465"},"idsList":null,"associations":[{"externalId":"e_tr_wco_1231231","category":"Enforcements,AdverseMedia:CORPORATE","fullName":"Test Entity","relationship":"Affiliated entity","relationshipGroup":null,"ownershipPercentage":null}],"status":null,"reason":null,"comments":null,"subsidiaryFields":null,"richTextAdditionalDetails":"<html><body><p>Some rich text details</p></body></html>","categoryDetails":null}]}]},"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Screen","status":"Success","errorDetails":null,"uploadId":null}
},
"Screen operation - Success - Entity type 'Company'": {
"value": {"response":{"batchExternalIds":[{"source":"MyProviderId","name":"FieldInProvider","value":"1234"}],"entities":[{"entityId":"76ce4f1a-8676-4d4f-be0f-ae57b99b7e27","externalIds":[{"source":"MyProviderId","entityAliasId":"PrimaryName","name":"FieldInProvider","value":"1234"}],"matchesData":[{"externalId":"1234","externalIds":[{"entityAliasId":"PrimaryName","value":"1234"}],"providerId":"MyProviderId","entityAliasIds":["PrimaryName"],"name":"Test Entity","aliases":null,"aliasesList":[{"value":"TE","type":"Acronym"}],"gender":null,"dateOfBirth":null,"dateOfBirthList":null,"country":"Ireland","entityType":"Company","matchScore":100,"providerSourceName":"MyProviderName","providerSourceUrl":"https://myprovider.com/match/{matchId}","providerSourceUrls":null,"addresses":[{"addressLine1":"Address Line 1","addressLine2":"Address Line 2","city":"City","postalCode":"28793","country":"Country","countryISO2":null,"countryISO3":null,"stateProvince":"State or Province","type":"Main address","category":null}],"citizenship":null,"nationality":null,"placeOfBirth":null,"citizenshipList":null,"nationalityList":null,"placeOfBirthList":null,"countryOfResidence":null,"additionalInfo":[{"title":"Last Updated","content":["7/5/2022 12:00:00 AM +01:00"]}],"sourcesInfo":[{"title":"Entity URL","content":["URL1","URL2"]}],"categories":["Pep","Sanctions"],"sources":["URL1","URL2"],"registeredCountry":"Ireland","ids":{"Id1":"158192327","Id2":"1465465"},"idsList":null,"associations":[{"externalId":"e_tr_wco_1231231","category":"Enforcements,AdverseMedia:CORPORATE","fullName":"Test Entity","relationship":"Affiliated entity","relationshipGroup":null,"ownershipPercentage":null}],"status":null,"reason":null,"comments":null,"subsidiaryFields":null,"richTextAdditionalDetails":"<html><body><p>Some rich text details</p></body></html>","categoryDetails":null}]}]},"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Screen","status":"Success","errorDetails":null,"uploadId":null}
},
"Screen operation - Error": {
"value": {"response":null,"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Screen","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"uploadId":null}
},
"ResolveMatches operation - Success": {
"value": {"response":{},"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"ResolveMatches","status":"Success","errorDetails":null,"uploadId":null}
},
"ResolveMatches operation - Error": {
"value": {"response":null,"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"ResolveMatches","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"uploadId":null}
},
"Test operation - Success": {
"value": {"response":{},"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"Test","status":"Success","errorDetails":null,"uploadId":null}
},
"Test operation - Error": {
"value": {"response":null,"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"},"uploadId":null}
},
"OngoingScreening operation - Success": {
"value": {"response":{},"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingScreening","status":"Success","errorDetails":null,"uploadId":null}
},
"OngoingScreening operation - Error": {
"value": {"response":null,"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingScreening","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"uploadId":null}
},
"OngoingScreeningUpdate operation - Success": {
"value": {"response":{},"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingScreeningUpdate","status":"Success","errorDetails":null,"uploadId":null}
},
"OngoingScreeningUpdate operation - Error": {
"value": {"response":null,"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingScreeningUpdate","status":"Error","errorDetails":{"source":"Adapter","errorCode":"","message":"The error details"},"uploadId":null}
},
"OngoingScreeningGetResults operation - Success - Entity type 'Individual'": {
"value": {"response":{"batchExternalIds":[{"source":"MyProviderId","name":"FieldInProvider","value":"1234"}],"entities":[{"entityId":null,"legalEntityId":"bb8cd902-1aa8-456e-a22d-a4fc470e8386","externalIds":[{"source":"MyProviderId","entityAliasId":"PrimaryName","name":"FieldInProvider","value":"1234"}],"matchesData":[{"externalId":"1234","externalIds":[{"entityAliasId":"PrimaryName","value":"1234"}],"providerId":"MyProviderId","entityAliasIds":["PrimaryName"],"name":"Test Entity","aliases":null,"aliasesList":[{"value":"TE","type":"Acronym"}],"gender":"Male","dateOfBirth":"25/01/1950","dateOfBirthList":null,"country":null,"entityType":"Individual","matchScore":100,"providerSourceName":"MyProviderName","providerSourceUrl":"https://myprovider.com/match/{matchId}","providerSourceUrls":null,"addresses":[{"addressLine1":"Address Line 1","addressLine2":"Address Line 2","city":"City","postalCode":"28793","country":"Country","countryISO2":null,"countryISO3":null,"stateProvince":"State or Province","type":"Main address","category":null}],"citizenship":"Irish","nationality":"Irish","placeOfBirth":"Dublin","citizenshipList":null,"nationalityList":null,"placeOfBirthList":null,"countryOfResidence":"Ireland","additionalInfo":[{"title":"Last Updated","content":["7/5/2022 12:00:00 AM +01:00"]}],"sourcesInfo":[{"title":"Entity URL","content":["URL1","URL2"]}],"categories":["Pep","Sanctions"],"sources":["URL1","URL2"],"registeredCountry":null,"ids":{"Id1":"158192327","Id2":"1465465"},"idsList":null,"associations":[{"externalId":"e_tr_wco_1231231","category":"Enforcements,AdverseMedia:CORPORATE","fullName":"Test Entity","relationship":"Affiliated entity","relationshipGroup":null,"ownershipPercentage":null}],"status":null,"reason":null,"comments":null,"subsidiaryFields":null,"richTextAdditionalDetails":"<html><body><p>Some rich text details</p></body></html>","categoryDetails":null}],"configurationSetId":null}]},"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingScreeningGetResults","status":"Success","errorDetails":null,"uploadId":null}
},
"OngoingScreeningGetResults operation - Success - Entity type 'Company'": {
"value": {"response":{"batchExternalIds":[{"source":"MyProviderId","name":"FieldInProvider","value":"1234"}],"entities":[{"entityId":null,"legalEntityId":"bb8cd902-1aa8-456e-a22d-a4fc470e8386","externalIds":[{"source":"MyProviderId","entityAliasId":"PrimaryName","name":"FieldInProvider","value":"1234"}],"matchesData":[{"externalId":"1234","externalIds":[{"entityAliasId":"PrimaryName","value":"1234"}],"providerId":"MyProviderId","entityAliasIds":["PrimaryName"],"name":"Test Entity","aliases":null,"aliasesList":[{"value":"TE","type":"Acronym"}],"gender":null,"dateOfBirth":null,"dateOfBirthList":null,"country":"Ireland","entityType":"Company","matchScore":100,"providerSourceName":"MyProviderName","providerSourceUrl":"https://myprovider.com/match/{matchId}","providerSourceUrls":null,"addresses":[{"addressLine1":"Address Line 1","addressLine2":"Address Line 2","city":"City","postalCode":"28793","country":"Country","countryISO2":null,"countryISO3":null,"stateProvince":"State or Province","type":"Main address","category":null}],"citizenship":null,"nationality":null,"placeOfBirth":null,"citizenshipList":null,"nationalityList":null,"placeOfBirthList":null,"countryOfResidence":null,"additionalInfo":[{"title":"Last Updated","content":["7/5/2022 12:00:00 AM +01:00"]}],"sourcesInfo":[{"title":"Entity URL","content":["URL1","URL2"]}],"categories":["Pep","Sanctions"],"sources":["URL1","URL2"],"registeredCountry":"Ireland","ids":{"Id1":"158192327","Id2":"1465465"},"idsList":null,"associations":[{"externalId":"e_tr_wco_1231231","category":"Enforcements,AdverseMedia:CORPORATE","fullName":"Test Entity","relationship":"Affiliated entity","relationshipGroup":null,"ownershipPercentage":null}],"status":null,"reason":null,"comments":null,"subsidiaryFields":null,"richTextAdditionalDetails":"<html><body><p>Some rich text details</p></body></html>","categoryDetails":null}],"configurationSetId":null}]},"id":"fd23f474-eff9-425f-a776-78e2176b36e4","tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","providerId":"MyProviderId","type":"OngoingScreeningGetResults","status":"Success","errorDetails":null,"uploadId":null}
}
}
}
}
},
"responses": {
"202": {
"description": "Success. Results processed successfully"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
}
}
}
}
},
"components": {
"schemas": {
"AdapterResponseErrorDetails": {
"required": [
"source"
],
"type": "object",
"properties": {
"source": {
"minLength": 1,
"type": "string",
"description": "Property to specify where the error is coming from",
"example": "Adapter"
},
"errorCode": {
"type": "string",
"description": "If available, the error code",
"nullable": true,
"example": "E001"
},
"message": {
"type": "string",
"description": "The error message to understand what has failed",
"nullable": true,
"example": "The provider returned an invalid status code (500)"
}
},
"additionalProperties": false,
"description": "Class to represent the error details of a request to a Screening adapter"
},
"AdditionalInfoDto": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Type of information",
"nullable": true,
"example": "Last Updated"
},
"content": {
"type": "array",
"items": {
"type": "string"
},
"description": "Content of the additional information",
"nullable": true,
"example": [
"7/5/2022 12:00:00 AM +01:00"
]
}
},
"addition
# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fenergo/refs/heads/main/openapi/fenergo-screeningreceptor-v1-0-openapi.json