Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.0.1",
"info": {
"title": "Fenergo Nebula Screening - Mock Adapter",
"description": "## Purpose of the API\n\nThe purpose of the Screening Mock Adapter is to act as a middleware between the main Fen-X Screening service and the different screening providers (in this case, a mock).\n\nThe main responsibilities of the adapter are:\n\n<ul><li>Receive and validate the different types of requests from the Fen-X Screening service (Screen, ResolveMatches, etc)</li><li>Transform the data sent by Fen-X to the data models expected by the provider</li><li>Perform the operations requested by Fen-X by calling the native provider's APIs</li><li>Get the results returned by the provider and transform them into a data model supported by the Fen-X Screening Receptor API</li></ul>\n\nAll the endpoints in the API are implemented as asynchronous, therefore returning the following status codes:\n\n<ul><li>202 (Accepted): the adapter has validated the request and started the background processing of it</li><li>400 (Bad Request): the adapter has rejected the request because of a validation error</li><li>500 (Internal Server Error): an unexpected error has occurred while processing the request</li></ul>\n\nOnce the request has been accepted and the background processing has finished (for example, when the adapter has called the provider to screen an entity and the results from the provider are ready), the results should be sent to the Screening Receptor API. The documentation of this API is available here (replace 'fenxenvironment' with the corresponding value, e.g. 'fenergox'): [https://api.{fenxenvironment}.com/screeningreceptor/swagger/index.html](https://api.fenxenvironment.com/screeningreceptor/swagger/index.html)\n\nOnce the results are sent to the Receptor by the adapter, they will forwarded to the main Screening service for them to be processed.\n\n## Authentication\n\nThe authentication in the Screening Mock Adapter 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 API, two keys are used to encrypt and authenticate the request. There are a few things to take into account:\n\n<ul><li>The authentication headers will be required if the provider has authenticationActive set to true</li><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## Handling errors in the adapter\n\nThe Screening Mock Adapter 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 API will return a 202 Accepted response.\n\nEven though the Screening Mock Adapter may return a successful response, errors could happen while processing the request in the background. In that scenario, the Adapter API will call the Screening Receptor API with an 'Error' status, providing the error details. This will be processed later on by the main Screening service in Fen-X, and the error details can be fetched by using the Screening Query API. The documentation of this API is available here (replace 'fenxenvironment' with the corresponding value, e.g. 'fenergox'): [https://api.{fenxenvironment}.com/screeningquery/swagger/index.html](https://api.fenxenvironment.com/screeningquery/swagger/index.html)",
"version": "1.0"
},
"servers": [
{
"url": "/mockadaptercommand"
}
],
"paths": {
"/api/screen": {
"post": {
"tags": [
"AdapterMock"
],
"operationId": "Screen",
"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="
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScreenRequestDtoAdapterRequestDto"
},
"examples": {
"Screen operation - Entity type 'Individual'": {
"value": {"Data":{"Entities":[{"EntityId":"76ce4f1a-8676-4d4f-be0f-ae57b99b7e27","LegalEntityId":"bb8cd902-1aa8-456e-a22d-a4fc470e8386","SearchCriteria":{"FullName":null,"FirstName":"Neil","MiddleName":"Arvel","LastName":"Moore","DateOfBirth":"25/05/1950","Gender":"Male","LegalEntityName":null,"Type":"Individual","Address":{"AddressLine1":"158, Upper O'Connell Street","AddressLine2":"Dublin 1","City":"Dublin","PostalCode":"D01YT95","Country":"Ireland","CountryISO2":null,"CountryISO3":null,"StateProvince":"Leinster","Type":"Main address"},"Addresses":null,"IDNumber":"459768575","PhoneNumber":"765864598","EmailAddress":"hello@emailprovider.com","Nationality":"Irish","CountryOfResidence":"Ireland","PlaceOfBirth":"Ireland","PlaceOfBirthISO2":null,"PlaceOfBirthISO3":null,"Citizenship":"Irish","CitizenshipISO2":null,"CitizenshipISO3":null,"RegisteredCountry":null,"RegisteredCountryISO2":null,"RegisteredCountryISO3":null,"Subtype":null,"UniqueId":null,"OtherInformation":null,"PassportNumber":null,"SocialSecurityNumber":null,"DriversLicense":null,"EmployerIdentificationNumber":null},"EntityAliases":[{"Id":"111111","AliasType":"FKA","FullName":null,"FirstName":"John","MiddleName":null,"LastName":"Smith","LegalEntityName":null}]}],"OverriddenBatch":null,"OverriddenBatches":null,"JourneyId":null,"ProcessId":null,"AdditionalSettings":[{"FieldId":"AcceptListID","Value":"1234"}]},"Id":"fd23f474-eff9-425f-a776-78e2176b36e4","Tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","ProviderId":"MyProviderId","Type":"Screen"}
},
"Screen operation - Entity type 'Company'": {
"value": {"Data":{"Entities":[{"EntityId":"76ce4f1a-8676-4d4f-be0f-ae57b99b7e27","LegalEntityId":"bb8cd902-1aa8-456e-a22d-a4fc470e8386","SearchCriteria":{"FullName":null,"FirstName":null,"MiddleName":null,"LastName":null,"DateOfBirth":null,"Gender":null,"LegalEntityName":"Fake Company","Type":"Company","Address":{"AddressLine1":"158, Upper O'Connell Street","AddressLine2":"Dublin 1","City":"Dublin","PostalCode":"D01YT95","Country":"Ireland","CountryISO2":null,"CountryISO3":null,"StateProvince":"Leinster","Type":"Main address"},"Addresses":null,"IDNumber":"459768575","PhoneNumber":"765864598","EmailAddress":"hello@emailprovider.com","Nationality":null,"CountryOfResidence":null,"PlaceOfBirth":null,"PlaceOfBirthISO2":null,"PlaceOfBirthISO3":null,"Citizenship":null,"CitizenshipISO2":null,"CitizenshipISO3":null,"RegisteredCountry":"Ireland","RegisteredCountryISO2":null,"RegisteredCountryISO3":null,"Subtype":null,"UniqueId":null,"OtherInformation":null,"PassportNumber":null,"SocialSecurityNumber":null,"DriversLicense":null,"EmployerIdentificationNumber":null},"EntityAliases":[{"Id":"111111","AliasType":"FKA","FullName":null,"FirstName":null,"MiddleName":null,"LastName":null,"LegalEntityName":"Alias Company"}]}],"OverriddenBatch":null,"OverriddenBatches":null,"JourneyId":null,"ProcessId":null,"AdditionalSettings":[{"FieldId":"AcceptListID","Value":"1234"}]},"Id":"fd23f474-eff9-425f-a776-78e2176b36e4","Tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","ProviderId":"MyProviderId","Type":"Screen"}
}
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ScreenRequestDtoAdapterRequestDto"
},
"examples": {
"Screen operation - Entity type 'Individual'": {
"value": {"Data":{"Entities":[{"EntityId":"76ce4f1a-8676-4d4f-be0f-ae57b99b7e27","LegalEntityId":"bb8cd902-1aa8-456e-a22d-a4fc470e8386","SearchCriteria":{"FullName":null,"FirstName":"Neil","MiddleName":"Arvel","LastName":"Moore","DateOfBirth":"25/05/1950","Gender":"Male","LegalEntityName":null,"Type":"Individual","Address":{"AddressLine1":"158, Upper O'Connell Street","AddressLine2":"Dublin 1","City":"Dublin","PostalCode":"D01YT95","Country":"Ireland","CountryISO2":null,"CountryISO3":null,"StateProvince":"Leinster","Type":"Main address"},"Addresses":null,"IDNumber":"459768575","PhoneNumber":"765864598","EmailAddress":"hello@emailprovider.com","Nationality":"Irish","CountryOfResidence":"Ireland","PlaceOfBirth":"Ireland","PlaceOfBirthISO2":null,"PlaceOfBirthISO3":null,"Citizenship":"Irish","CitizenshipISO2":null,"CitizenshipISO3":null,"RegisteredCountry":null,"RegisteredCountryISO2":null,"RegisteredCountryISO3":null,"Subtype":null,"UniqueId":null,"OtherInformation":null,"PassportNumber":null,"SocialSecurityNumber":null,"DriversLicense":null,"EmployerIdentificationNumber":null},"EntityAliases":[{"Id":"111111","AliasType":"FKA","FullName":null,"FirstName":"John","MiddleName":null,"LastName":"Smith","LegalEntityName":null}]}],"OverriddenBatch":null,"OverriddenBatches":null,"JourneyId":null,"ProcessId":null,"AdditionalSettings":[{"FieldId":"AcceptListID","Value":"1234"}]},"Id":"fd23f474-eff9-425f-a776-78e2176b36e4","Tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","ProviderId":"MyProviderId","Type":"Screen"}
},
"Screen operation - Entity type 'Company'": {
"value": {"Data":{"Entities":[{"EntityId":"76ce4f1a-8676-4d4f-be0f-ae57b99b7e27","LegalEntityId":"bb8cd902-1aa8-456e-a22d-a4fc470e8386","SearchCriteria":{"FullName":null,"FirstName":null,"MiddleName":null,"LastName":null,"DateOfBirth":null,"Gender":null,"LegalEntityName":"Fake Company","Type":"Company","Address":{"AddressLine1":"158, Upper O'Connell Street","AddressLine2":"Dublin 1","City":"Dublin","PostalCode":"D01YT95","Country":"Ireland","CountryISO2":null,"CountryISO3":null,"StateProvince":"Leinster","Type":"Main address"},"Addresses":null,"IDNumber":"459768575","PhoneNumber":"765864598","EmailAddress":"hello@emailprovider.com","Nationality":null,"CountryOfResidence":null,"PlaceOfBirth":null,"PlaceOfBirthISO2":null,"PlaceOfBirthISO3":null,"Citizenship":null,"CitizenshipISO2":null,"CitizenshipISO3":null,"RegisteredCountry":"Ireland","RegisteredCountryISO2":null,"RegisteredCountryISO3":null,"Subtype":null,"UniqueId":null,"OtherInformation":null,"PassportNumber":null,"SocialSecurityNumber":null,"DriversLicense":null,"EmployerIdentificationNumber":null},"EntityAliases":[{"Id":"111111","AliasType":"FKA","FullName":null,"FirstName":null,"MiddleName":null,"LastName":null,"LegalEntityName":"Alias Company"}]}],"OverriddenBatch":null,"OverriddenBatches":null,"JourneyId":null,"ProcessId":null,"AdditionalSettings":[{"FieldId":"AcceptListID","Value":"1234"}]},"Id":"fd23f474-eff9-425f-a776-78e2176b36e4","Tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","ProviderId":"MyProviderId","Type":"Screen"}
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/api/resolvematches": {
"post": {
"tags": [
"AdapterMock"
],
"operationId": "ResolveMatches",
"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="
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResolveMatchesRequestDtoAdapterRequestDto"
},
"examples": {
"ResolveMatches operation": {
"value": {"Data":{"BatchExternalIds":[{"Source":"MyProviderId","Name":"FieldInProvider","Value":"1234"}],"Entities":[{"EntityId":"76ce4f1a-8676-4d4f-be0f-ae57b99b7e27","LegalEntityId":"bb8cd902-1aa8-456e-a22d-a4fc470e8386","EntityAliasIds":null,"ExternalIds":[{"Source":"MyProviderId","EntityAliasId":"PrimaryName","Name":"FieldInProvider","Value":"1234"}],"MatchesData":[{"MatchId":"06f6607f-79c4-4b75-b158-1d84831606f0","EntityAliasIds":null,"ExternalId":"12345678","ExternalIds":[{"EntityAliasId":"PrimaryName","Value":"12345678"}],"ProviderId":"MyProviderId","Status":"Match","Reason":"Matched Entity","Comments":"The name of the entity in the match is the same as the screened entity","SubsidiaryFields":null},{"MatchId":"76f802b3-936e-4ec4-8f0a-a5fc2112239b","EntityAliasIds":null,"ExternalId":"87654321","ExternalIds":[{"EntityAliasId":"PrimaryName","Value":"87654321"}],"ProviderId":"MyProviderId","Status":"No Match","Reason":"No Name Match","Comments":"The name of the entity doesn't match","SubsidiaryFields":null}]}],"AdditionalSettings":[{"FieldId":"AcceptListID","Value":"1234"}]},"Id":"fd23f474-eff9-425f-a776-78e2176b36e4","Tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","ProviderId":"MyProviderId","Type":"ResolveMatches"}
}
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ResolveMatchesRequestDtoAdapterRequestDto"
},
"examples": {
"ResolveMatches operation": {
"value": {"Data":{"BatchExternalIds":[{"Source":"MyProviderId","Name":"FieldInProvider","Value":"1234"}],"Entities":[{"EntityId":"76ce4f1a-8676-4d4f-be0f-ae57b99b7e27","LegalEntityId":"bb8cd902-1aa8-456e-a22d-a4fc470e8386","EntityAliasIds":null,"ExternalIds":[{"Source":"MyProviderId","EntityAliasId":"PrimaryName","Name":"FieldInProvider","Value":"1234"}],"MatchesData":[{"MatchId":"06f6607f-79c4-4b75-b158-1d84831606f0","EntityAliasIds":null,"ExternalId":"12345678","ExternalIds":[{"EntityAliasId":"PrimaryName","Value":"12345678"}],"ProviderId":"MyProviderId","Status":"Match","Reason":"Matched Entity","Comments":"The name of the entity in the match is the same as the screened entity","SubsidiaryFields":null},{"MatchId":"76f802b3-936e-4ec4-8f0a-a5fc2112239b","EntityAliasIds":null,"ExternalId":"87654321","ExternalIds":[{"EntityAliasId":"PrimaryName","Value":"87654321"}],"ProviderId":"MyProviderId","Status":"No Match","Reason":"No Name Match","Comments":"The name of the entity doesn't match","SubsidiaryFields":null}]}],"AdditionalSettings":[{"FieldId":"AcceptListID","Value":"1234"}]},"Id":"fd23f474-eff9-425f-a776-78e2176b36e4","Tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","ProviderId":"MyProviderId","Type":"ResolveMatches"}
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/api/test": {
"post": {
"tags": [
"AdapterMock"
],
"operationId": "Test",
"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="
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestRequestDtoAdapterRequestDto"
},
"examples": {
"Test operation": {
"value": {"Data":{"AdditionalSettings":[{"FieldId":"AcceptListID","Value":"1234"}]},"Id":"fd23f474-eff9-425f-a776-78e2176b36e4","Tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","ProviderId":"MyProviderId","Type":"Test"}
}
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TestRequestDtoAdapterRequestDto"
},
"examples": {
"Test operation": {
"value": {"Data":{"AdditionalSettings":[{"FieldId":"AcceptListID","Value":"1234"}]},"Id":"fd23f474-eff9-425f-a776-78e2176b36e4","Tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","ProviderId":"MyProviderId","Type":"Test"}
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/api/ongoingscreening": {
"post": {
"tags": [
"AdapterMock"
],
"operationId": "OngoingScreening",
"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="
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OngoingScreeningRequestDtoAdapterRequestDto"
},
"examples": {
"OngoingScreening operation": {
"value": {"Data":{"Enable":true,"EntityId":"76ce4f1a-8676-4d4f-be0f-ae57b99b7e27","LegalEntityId":"bb8cd902-1aa8-456e-a22d-a4fc470e8386","SearchCriteria":{"FullName":null,"FirstName":null,"MiddleName":null,"LastName":null,"DateOfBirth":null,"Gender":null,"LegalEntityName":"Fake Company","Type":"Company","Address":{"AddressLine1":"158, Upper O'Connell Street","AddressLine2":"Dublin 1","City":"Dublin","PostalCode":"D01YT95","Country":"Ireland","CountryISO2":null,"CountryISO3":null,"StateProvince":"Leinster","Type":"Main address"},"Addresses":null,"IDNumber":"459768575","PhoneNumber":"765864598","EmailAddress":"hello@emailprovider.com","Nationality":null,"CountryOfResidence":null,"PlaceOfBirth":null,"PlaceOfBirthISO2":null,"PlaceOfBirthISO3":null,"Citizenship":null,"CitizenshipISO2":null,"CitizenshipISO3":null,"RegisteredCountry":"Ireland","RegisteredCountryISO2":null,"RegisteredCountryISO3":null,"Subtype":null,"UniqueId":null,"OtherInformation":null,"PassportNumber":null,"SocialSecurityNumber":null,"DriversLicense":null,"EmployerIdentificationNumber":null},"EntityAliasesForEnable":[{"Id":"111111","AliasType":"AKA","FullName":null,"FirstName":null,"MiddleName":null,"LastName":null,"LegalEntityName":"Alias Company"}],"AdditionalSettingsForEnable":[{"FieldId":"AcceptListId","Value":"9999"}],"ConfigurationSetId":null},"Id":"fd23f474-eff9-425f-a776-78e2176b36e4","Tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","ProviderId":"MyProviderId","Type":"OngoingScreening"}
}
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OngoingScreeningRequestDtoAdapterRequestDto"
},
"examples": {
"OngoingScreening operation": {
"value": {"Data":{"Enable":true,"EntityId":"76ce4f1a-8676-4d4f-be0f-ae57b99b7e27","LegalEntityId":"bb8cd902-1aa8-456e-a22d-a4fc470e8386","SearchCriteria":{"FullName":null,"FirstName":null,"MiddleName":null,"LastName":null,"DateOfBirth":null,"Gender":null,"LegalEntityName":"Fake Company","Type":"Company","Address":{"AddressLine1":"158, Upper O'Connell Street","AddressLine2":"Dublin 1","City":"Dublin","PostalCode":"D01YT95","Country":"Ireland","CountryISO2":null,"CountryISO3":null,"StateProvince":"Leinster","Type":"Main address"},"Addresses":null,"IDNumber":"459768575","PhoneNumber":"765864598","EmailAddress":"hello@emailprovider.com","Nationality":null,"CountryOfResidence":null,"PlaceOfBirth":null,"PlaceOfBirthISO2":null,"PlaceOfBirthISO3":null,"Citizenship":null,"CitizenshipISO2":null,"CitizenshipISO3":null,"RegisteredCountry":"Ireland","RegisteredCountryISO2":null,"RegisteredCountryISO3":null,"Subtype":null,"UniqueId":null,"OtherInformation":null,"PassportNumber":null,"SocialSecurityNumber":null,"DriversLicense":null,"EmployerIdentificationNumber":null},"EntityAliasesForEnable":[{"Id":"111111","AliasType":"AKA","FullName":null,"FirstName":null,"MiddleName":null,"LastName":null,"LegalEntityName":"Alias Company"}],"AdditionalSettingsForEnable":[{"FieldId":"AcceptListId","Value":"9999"}],"ConfigurationSetId":null},"Id":"fd23f474-eff9-425f-a776-78e2176b36e4","Tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","ProviderId":"MyProviderId","Type":"OngoingScreening"}
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/api/ongoingscreeningupdate": {
"post": {
"tags": [
"AdapterMock"
],
"operationId": "OngoingScreeningUpdate",
"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="
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OngoingScreeningUpdateRequestDtoAdapterRequestDto"
},
"examples": {
"OngoingScreeningUpdate operation": {
"value": {"Data":{"EntityId":null,"LegalEntityId":"bb8cd902-1aa8-456e-a22d-a4fc470e8386","SearchCriteria":{"FullName":null,"FirstName":null,"MiddleName":null,"LastName":null,"DateOfBirth":null,"Gender":null,"LegalEntityName":"Fake Company","Type":"Company","Address":{"AddressLine1":"158, Upper O'Connell Street","AddressLine2":"Dublin 1","City":"Dublin","PostalCode":"D01YT95","Country":"Ireland","CountryISO2":null,"CountryISO3":null,"StateProvince":"Leinster","Type":"Main address"},"Addresses":null,"IDNumber":"459768575","PhoneNumber":"765864598","EmailAddress":"hello@emailprovider.com","Nationality":null,"CountryOfResidence":null,"PlaceOfBirth":null,"PlaceOfBirthISO2":null,"PlaceOfBirthISO3":null,"Citizenship":null,"CitizenshipISO2":null,"CitizenshipISO3":null,"RegisteredCountry":"Ireland","RegisteredCountryISO2":null,"RegisteredCountryISO3":null,"Subtype":null,"UniqueId":null,"OtherInformation":null,"PassportNumber":null,"SocialSecurityNumber":null,"DriversLicense":null,"EmployerIdentificationNumber":null},"EntityAliases":[{"Id":"111111","AliasType":"AKA","FullName":null,"FirstName":null,"MiddleName":null,"LastName":null,"LegalEntityName":"Alias Company"}]},"Id":"fd23f474-eff9-425f-a776-78e2176b36e4","Tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","ProviderId":"MyProviderId","Type":"OngoingScreeningUpdate"}
}
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OngoingScreeningUpdateRequestDtoAdapterRequestDto"
},
"examples": {
"OngoingScreeningUpdate operation": {
"value": {"Data":{"EntityId":null,"LegalEntityId":"bb8cd902-1aa8-456e-a22d-a4fc470e8386","SearchCriteria":{"FullName":null,"FirstName":null,"MiddleName":null,"LastName":null,"DateOfBirth":null,"Gender":null,"LegalEntityName":"Fake Company","Type":"Company","Address":{"AddressLine1":"158, Upper O'Connell Street","AddressLine2":"Dublin 1","City":"Dublin","PostalCode":"D01YT95","Country":"Ireland","CountryISO2":null,"CountryISO3":null,"StateProvince":"Leinster","Type":"Main address"},"Addresses":null,"IDNumber":"459768575","PhoneNumber":"765864598","EmailAddress":"hello@emailprovider.com","Nationality":null,"CountryOfResidence":null,"PlaceOfBirth":null,"PlaceOfBirthISO2":null,"PlaceOfBirthISO3":null,"Citizenship":null,"CitizenshipISO2":null,"CitizenshipISO3":null,"RegisteredCountry":"Ireland","RegisteredCountryISO2":null,"RegisteredCountryISO3":null,"Subtype":null,"UniqueId":null,"OtherInformation":null,"PassportNumber":null,"SocialSecurityNumber":null,"DriversLicense":null,"EmployerIdentificationNumber":null},"EntityAliases":[{"Id":"111111","AliasType":"AKA","FullName":null,"FirstName":null,"MiddleName":null,"LastName":null,"LegalEntityName":"Alias Company"}]},"Id":"fd23f474-eff9-425f-a776-78e2176b36e4","Tenant":"095d6a21-b5cf-4369-9491-0de90438e26c","ProviderId":"MyProviderId","Type":"OngoingScreeningUpdate"}
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal Server Error"
}
}
}
}
},
"components": {
"schemas": {
"AddressDto": {
"type": "object",
"properties": {
"AddressLine1": {
"type": "string",
"description": "The first line in the address",
"nullable": true,
"example": "158, Upper O'Connell Street"
},
"AddressLine2": {
"type": "string",
"description": "The second line in the address",
"nullable": true,
"example": "Dublin 1"
},
"City": {
"type": "string",
"description": "The city",
"nullable": true,
"example": "Dublin"
},
"PostalCode": {
"type": "string",
"description": "The postal code",
"nullable": true,
"example": "D01YT95"
},
"Country": {
"type": "string",
"description": "The country",
"nullable": true,
"example": "Ireland"
},
"CountryISO2": {
"type": "string",
"description": "The country ISO2 code",
"nullable": true,
"example": "IE"
},
"CountryISO3": {
"type": "string",
"description": "The country ISO3 code",
"nullable": true,
"example": "IRL"
},
"StateProvince": {
"type": "string",
"description": "The state or province",
"nullable": true,
"example": "Leinster"
},
"Type": {
"type": "string",
# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fenergo/refs/heads/main/openapi/fenergo-mockadaptercommand-v1-0-openapi.json