{
"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- Receive and validate the different types of requests from the Fen-X Screening service (Screen, ResolveMatches, etc)
- Transform the data sent by Fen-X to the data models expected by the provider
- Perform the operations requested by Fen-X by calling the native provider's APIs
- Get the results returned by the provider and transform them into a data model supported by the Fen-X Screening Receptor API
\n\nAll the endpoints in the API are implemented as asynchronous, therefore returning the following status codes:\n\n- 202 (Accepted): the adapter has validated the request and started the background processing of it
- 400 (Bad Request): the adapter has rejected the request because of a validation error
- 500 (Internal Server Error): an unexpected error has occurred while processing the request
\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- The authentication headers will be required if the provider has authenticationActive set to true
- 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
\n\n- For authentication, HMAC (SHA256) is used
- For encryption, AES-CBC is used
- 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
\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",
"description": "The type of address",
"nullable": true,
"example": "Main address"
}
},
"additionalProperties": false,
"description": "Class to represent the address of an entity"
},
"BatchExternalIdDto": {
"required": [
"Name",
"Source"
],
"type": "object",
"properties": {
"Source": {
"minLength": 1,
"type": "string",
"description": "The source of this externalId (LN, WCO, etc)",
"example": "MyProviderId"
},
"Name": {
"minLength": 1,
"type": "string",
"description": "The name of the ID in the provider",
"example": "FieldInProvider"
},
"Value": {
"type": "string",
"description": "The value of the ID",
"nullable": true,
"example": "1234"
}
},
"additionalProperties": false,
"description": "Class to represent the batch external IDs fetched from the providers (runId, resultId, etc)"
},
"ConfigurationSetPropertyDto": {
"required": [
"FieldId"
],
"type": "object",
"properties": {
"FieldId": {
"minLength": 1,
"type": "string",
"description": "Unique field id used to identify entry",
"example": "AcceptListID"
},
"Value": {
"type": "string",
"description": "Value of entry",
"nullable": true,
"example": "1234"
}
},
"additionalProperties": false
},
"EntityAliasDto": {
"required": [
"Id"
],
"type": "object",
"properties": {
"Id": {
"minLength": 1,
"type": "string",
"description": "The id of the entity alias, which in FenX is the id of the Alternate Names DataGroup item.",
"example": "12be5a50-66c2-44bb-851e-afc4fc4a28c2"
},
"AliasType": {
"type": "string",
"description": "The type of the alias",
"nullable": true,
"example": "Also Known As"
},
"FullName": {
"type": "string",
"description": "The Individual's firstname and surname. Alternatively use FirstName with LastName.",
"nullable": true,
"example": "John Doe"
},
"FirstName": {
"type": "string",
"description": "The Individual's first name. Alternatively use FullName.",
"nullable": true,
"example": "John"
},
"MiddleName": {
"type": "string",
"description": "The Individual's middle name",
"nullable": true,
"example": "David"
},
"LastName": {
"type": "string",
"description": "The Individual's surname. Alternatively use FullName.",
"nullable": true,
"example": "Doe"
},
"LegalEntityName": {
"type": "string",
"description": "Full Company name",
"nullable": true,
"example": "Fenergo"
}
},
"additionalProperties": false,
"description": "Class to represent a Screening entity Alias"
},
"ExternalIdDto": {
"required": [
"Name",
"Source"
],
"type": "object",
"properties": {
"Source": {
"minLength": 1,
"type": "string",
"description": "The source of this externalId (LN, WCO, etc)",
"example": "MyProviderId"
},
"EntityAliasId": {
"type": "string",
"description": "What entity Alias this externalId is associated with. Will be null or \"PrimaryName\" for the PrimaryName external ids",
"nullable": true,
"example": "e7b8f7c2-3c4a-4b2a-9e2d-1f2a3b4c5d6e"
},
"Name": {
"minLength": 1,
"type": "string",
"description": "The name of the ID in the provider",
"example": "FieldInProvider"
},
"Value": {
"type": "string",
"description": "The value of the ID",
"nullable": true,
"example": "1234"
}
},
"additionalProperties": false,
"description": "Class to represent the external IDs fetched from the providers (runId, resultId, etc)"
},
"MatchDataExternalIdDto": {
"type": "object",
"properties": {
"EntityAliasId": {
"type": "string",
"description": "What entity Alias this externalId is associated with. Will be \"PrimaryName\" for the PrimaryName external ids",
"nullable": true,
"example": "e7b8f7c2-3c4a-4b2a-9e2d-1f2a3b4c5d6e"
},
"Value": {
"type": "string",
"description": "The value of the ID",
"nullable": true,
"example": "1234"
}
},
"additionalProperties": false,
"description": "Class to represent a match external id"
},
"OngoingScreeningRequestDto": {
"required": [
"Enable",
"EntityId",
"SearchCriteria"
],
"type": "object",
"properties": {
"Enable": {
"type": "boolean",
"description": "Flag to indicate if OGS is going to be enabled or disabled for the entity",
"example": true
},
"EntityId": {
"minLength": 1,
"type": "string",
"description": "The Screening internal ID of the entity.",
"example": "76ce4f1a-8676-4d4f-be0f-ae57b99b7e27"
},
"LegalEntityId": {
"type": "string",
"description": "The unique ID of the entity in Fen-X",
"nullable": true,
"example": "bb8cd902-1aa8-456e-a22d-a4fc470e8386"
},
"SearchCriteria": {
"$ref": "#/components/schemas/SearchCriteriaDto"
},
"EntityAliasesForEnable": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityAliasDto"
},
"description": "Aliases of the entity to be subscribed. In the case of Enable flag being false, this will be empty and the provider should unsubscribe the entity from all aliases it's subscribed to.\r\nIn the case of Enable flag being true, the provider should also unsubscribe the entity from all aliases that are not present in this list and were previously subscribed to.",
"nullable": true
},
"AdditionalSettingsForEnable": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigurationSetPropertyDto"
},
"description": "The additional settings related to the Screening provider, associated to the configuration set used at the time of performing the enable ogs operation\r\nOnly sent if Enable flag is true",
"nullable": true
},
"ConfigurationSetId": {
"type": "string",
"description": "The configuration set ID used at the time of performing the enable or disable ogs operation.\r\nCan be null if no configuration set ID was associated or the provider is not set up to use the Segregation of OGS by Configuration Set feature.",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent the data required to perform an \"OngoingScreening\" operation, to enable or disable OGS for an entity"
},
"OngoingScreeningRequestDtoAdapterRequestDto": {
"required": [
"Id",
"ProviderId",
"Tenant",
"Type"
],
"type": "object",
"properties": {
"Id": {
"minLength": 1,
"type": "string",
"description": "Field used to uniquely identify the request. \n\r\nIn most cases, the Screening BatchID is used here.",
"example": "fd23f474-eff9-425f-a776-78e2176b36e4"
},
"Tenant": {
"minLength": 1,
"type": "string",
"description": "The tenant of the client",
"example": "095d6a21-b5cf-4369-9491-0de90438e26c"
},
"ProviderId": {
"minLength": 1,
"type": "string",
"description": "The Screening internal ID of the provider. Must match the ID of the provider in the configuration",
"example": "MyProviderId"
},
"Type": {
"minLength": 1,
"enum": [
"Screen",
"ResolveMatches",
"Test",
"OngoingScreening",
"OngoingScreeningUpdate",
"OngoingScreeningGetResults"
],
"type": "string",
"description": "The type of the request",
"example": "Screen"
},
"Data": {
"$ref": "#/components/schemas/OngoingScreeningRequestDto"
}
},
"additionalProperties": false,
"description": "Class to represent a request to a Screening adapter"
},
"OngoingScreeningUpdateRequestDto": {
"required": [
"EntityId",
"SearchCriteria"
],
"type": "object",
"properties": {
"EntityId": {
"minLength": 1,
"type": "string",
"description": "The Screening internal ID of the entity.",
"example": "76ce4f1a-8676-4d4f-be0f-ae57b99b7e27"
},
"LegalEntityId": {
"type": "string",
"description": "The unique ID of the entity in Fen-X",
"nullable": true,
"example": "bb8cd902-1aa8-456e-a22d-a4fc470e8386"
},
"SearchCriteria": {
"$ref": "#/components/schemas/SearchCriteriaDto"
},
"EntityAliases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityAliasDto"
},
"description": "Aliases of the entity to be updated. \r\nThe provider should also unsubscribe the entity from all aliases that are not present in this list and were previously subscribed to.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent the data required to perform an \"OngoingScreeningUpdate\" operation,\r\nto update the data of an existing entity that has OGS enabled"
},
"OngoingScreeningUpdateRequestDtoAdapterRequestDto": {
"required": [
"Id",
"ProviderId",
"Tenant",
"Type"
],
"type": "object",
"properties": {
"Id": {
"minLength": 1,
"type": "string",
"description": "Field used to uniquely identify the request. \n\r\nIn most cases, the Screening BatchID is used here.",
"example": "fd23f474-eff9-425f-a776-78e2176b36e4"
},
"Tenant": {
"minLength": 1,
"type": "string",
"description": "The tenant of the client",
"example": "095d6a21-b5cf-4369-9491-0de90438e26c"
},
"ProviderId": {
"minLength": 1,
"type": "string",
"description": "The Screening internal ID of the provider. Must match the ID of the provider in the configuration",
"example": "MyProviderId"
},
"Type": {
"minLength": 1,
"enum": [
"Screen",
"ResolveMatches",
"Test",
"OngoingScreening",
"OngoingScreeningUpdate",
"OngoingScreeningGetResults"
],
"type": "string",
"description": "The type of the request",
"example": "Screen"
},
"Data": {
"$ref": "#/components/schemas/OngoingScreeningUpdateRequestDto"
}
},
"additionalProperties": false,
"description": "Class to represent a request to a Screening adapter"
},
"OverriddenBatchDto": {
"required": [
"Entities",
"PreviousStatus"
],
"type": "object",
"properties": {
"PreviousStatus": {
"minLength": 1,
"enum": [
"Open",
"Closed",
"Overridden"
],
"type": "string",
"description": "The status before the batch was overridden",
"example": "Closed"
},
"Entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OverriddenBatchEntityDto"
},
"description": "The list of entities in the batch"
},
"AdditionalSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigurationSetPropertyDto"
},
"description": "The additional settings related to the Screening provider, associated to the configuration set used when this batch was created.\r\nIf the configuration set has since been deleted, the AdditionalSettings will not be sent.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent a batch that has been overridden"
},
"OverriddenBatchEntityAliasDto": {
"type": "object",
"properties": {
"Id": {
"type": "string",
"description": "The unique ID of the entity's alias in Fen-X",
"nullable": true,
"example": "bb8cd902-1aa8-456e-a22d-a4fc470e8386"
},
"MatchesCount": {
"type": "integer",
"description": "The number of matches returned by the provider for the entity's alias in the batch",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Class to represent an alias of an entity of an overridden batch"
},
"OverriddenBatchEntityDto": {
"type": "object",
"properties": {
"LegalEntityId": {
"type": "string",
"description": "The unique ID of the entity in Fen-X",
"nullable": true,
"example": "bb8cd902-1aa8-456e-a22d-a4fc470e8386"
},
"IsLegalEntityNewInJourney": {
"type": "boolean",
"description": "Whether the LegalEntityId is appearing for the first time within the screening of this journey as part of this batch. \n\r\nNote: Previously Overridden batches will not be taken into account when calculating this property, so if the LegalEntityId\r\nappeared in a previously Overridden batch, it will still be counted as new.",
"deprecated": true
},
"MatchesCount": {
"type": "integer",
"description": "The number of matches returned by the provider for the entity in the batch",
"format": "int32"
},
"EntityAliases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OverriddenBatchEntityAliasDto"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent an entity of an overridden batch"
},
"ResolveMatchesRequestDto": {
"required": [
"Entities"
],
"type": "object",
"properties": {
"BatchExternalIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchExternalIdDto"
},
"description": "List of Batch-level external ids (i.e. IDs that are specific to the underlying providers and are equivalent to the \"Batch\" concept in Screening)",
"nullable": true
},
"Entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResolveMatchesRequestEntityDto"
},
"description": "The list of entities whose matches are going to be resolved"
},
"AdditionalSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigurationSetPropertyDto"
},
"description": "The additional settings related to the Screening provider, associated to the configuration set used when creating a batch.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent the data required to perform a \"ResolveMatches\" operation, to resolve the matches of a batch on the provider side"
},
"ResolveMatchesRequestDtoAdapterRequestDto": {
"required": [
"Id",
"ProviderId",
"Tenant",
"Type"
],
"type": "object",
"properties": {
"Id": {
"minLength": 1,
"type": "string",
"description": "Field used to uniquely identify the request. \n\r\nIn most cases, the Screening BatchID is used here.",
"example": "fd23f474-eff9-425f-a776-78e2176b36e4"
},
"Tenant": {
"minLength": 1,
"type": "string",
"description": "The tenant of the client",
"example": "095d6a21-b5cf-4369-9491-0de90438e26c"
},
"ProviderId": {
"minLength": 1,
"type": "string",
"description": "The Screening internal ID of the provider. Must match the ID of the provider in the configuration",
"example": "MyProviderId"
},
"Type": {
"minLength": 1,
"enum": [
"Screen",
"ResolveMatches",
"Test",
"OngoingScreening",
"OngoingScreeningUpdate",
"OngoingScreeningGetResults"
],
"type": "string",
"description": "The type of the request",
"example": "Screen"
},
"Data": {
"$ref": "#/components/schemas/ResolveMatchesRequestDto"
}
},
"additionalProperties": false,
"description": "Class to represent a request to a Screening adapter"
},
"ResolveMatchesRequestEntityDto": {
"required": [
"EntityId"
],
"type": "object",
"properties": {
"EntityId": {
"minLength": 1,
"type": "string",
"description": "The Screening internal ID of the entity.",
"example": "76ce4f1a-8676-4d4f-be0f-ae57b99b7e27"
},
"LegalEntityId": {
"type": "string",
"description": "The unique ID of the entity in Fen-X",
"nullable": true,
"example": "bb8cd902-1aa8-456e-a22d-a4fc470e8386"
},
"EntityAliasIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of the FenX Entity AliasIds that this entity is associated with for Alias Screening feature.\r\nWhen it's associated with the primary name of the entity, one of them will be \"PrimaryName\".\r\nIf the array is null or empty, it means that the match only belongs to the PrimaryName of the entity.",
"nullable": true
},
"ExternalIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalIdDto"
},
"description": "List of Entity-level external ids (i.e. IDs that are specific to the underlying providers and are equivalent to the \"Entity\" concept in Screening)",
"nullable": true
},
"MatchesData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResolveMatchesRequestMatchDataDto"
},
"description": "List of matches of the entity that are going to be resolved",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent a Screening entity"
},
"ResolveMatchesRequestMatchDataDto": {
"required": [
"MatchId",
"ProviderId",
"Status"
],
"type": "object",
"properties": {
"MatchId": {
"minLength": 1,
"type": "string",
"description": "The Screening internal ID of the match",
"example": "06f6607f-79c4-4b75-b158-1d84831606f0"
},
"EntityAliasIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of the Entity AliasIds that this match is associated with. When it's associated with the primary name of the entity, one of them will be \"PrimaryName\".\r\nIf the array is null or empty, it means that the match only belongs to the PrimaryName of the entity.",
"nullable": true
},
"ExternalId": {
"type": "string",
"description": "The unique identifier of the match outside of Fen-X (i.e. in the underlying provider). \n\r\nRequired to uniquely identify the match on the provider side.",
"nullable": true,
"example": "1234",
"deprecated": true
},
"ExternalIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatchDataExternalIdDto"
},
"description": "The unique identifiers of the match outside of Fen-X (i.e. in the underlying provider). \n\r\nThey will be used later on to resolve the matches on the provider side. There will be one ExternalId\r\nfor each of the entity alias ids related to this match",
"nullable": true
},
"ProviderId": {
"minLength": 1,
"type": "string",
"description": "The ID of the Provider that returned the match.",
"example": "MyProviderId"
},
"Status": {
"minLength": 1,
"enum": [
"Match",
"No Match"
],
"type": "string",
"description": "The status of the match",
"example": "Match"
},
"Reason": {
"type": "string",
"description": "The reason why the match has the status specified in the property \"Status\"",
"nullable": true,
"example": "Matched Entity"
},
"Comments": {
"type": "string",
"description": "Additional comments about the match resolution",
"nullable": true,
"example": "The name of the entity in the match is the same as the screened entity"
},
"SubsidiaryFields": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "An optional dictionary used to add custom fields required by some adapters or providers",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent a match, with all the data that is needed to resolve it on the adapter side"
},
"ScreenRequestDto": {
"required": [
"Entities"
],
"type": "object",
"properties": {
"Entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScreenRequestEntityDto"
},
"description": "The list of entities that are going to be screened"
},
"OverriddenBatch": {
"$ref": "#/components/schemas/OverriddenBatchDto"
},
"OverriddenBatches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OverriddenBatchDto"
},
"description": "Data of the batches that have been overridden as part of this new batch's Screening request. \n\r\nThis will be empty if no batches have been overridden as part of this new batch creation",
"nullable": true
},
"JourneyId": {
"type": "string",
"description": "The ID of the journey that the Screening batch belongs to.",
"nullable": true,
"example": "8300bc67-4470-492e-a54d-9de01ef3ba6b"
},
"ProcessId": {
"type": "string",
"description": "The ID of the process (within a specific journey) where the Screening batch belongs to",
"nullable": true,
"example": "47e23fab-cc79-403c-a54a-2479e69deebb"
},
"AdditionalSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigurationSetPropertyDto"
},
"description": "The additional settings related to the Screening provider, associated to the configuration set used when creating a batch",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent the data required to perform a \"Screen\" operation, to screen a list of entities"
},
"ScreenRequestDtoAdapterRequestDto": {
"required": [
"Id",
"ProviderId",
"Tenant",
"Type"
],
"type": "object",
"properties": {
"Id": {
"minLength": 1,
"type": "string",
"description": "Field used to uniquely identify the request. \n\r\nIn most cases, the Screening BatchID is used here.",
"example": "fd23f474-eff9-425f-a776-78e2176b36e4"
},
"Tenant": {
"minLength": 1,
"type": "string",
"description": "The tenant of the client",
"example": "095d6a21-b5cf-4369-9491-0de90438e26c"
},
"ProviderId": {
"minLength": 1,
"type": "string",
"description": "The Screening internal ID of the provider. Must match the ID of the provider in the configuration",
"example": "MyProviderId"
},
"Type": {
"minLength": 1,
"enum": [
"Screen",
"ResolveMatches",
"Test",
"OngoingScreening",
"OngoingScreeningUpdate",
"OngoingScreeningGetResults"
],
"type": "string",
"description": "The type of the request",
"example": "Screen"
},
"Data": {
"$ref": "#/components/schemas/ScreenRequestDto"
}
},
"additionalProperties": false,
"description": "Class to represent a request to a Screening adapter"
},
"ScreenRequestEntityDto": {
"required": [
"EntityId",
"SearchCriteria"
],
"type": "object",
"properties": {
"EntityId": {
"minLength": 1,
"type": "string",
"description": "The Screening internal ID of the entity.",
"example": "76ce4f1a-8676-4d4f-be0f-ae57b99b7e27"
},
"LegalEntityId": {
"type": "string",
"description": "The unique ID of the entity in Fen-X",
"nullable": true,
"example": "bb8cd902-1aa8-456e-a22d-a4fc470e8386"
},
"SearchCriteria": {
"$ref": "#/components/schemas/SearchCriteriaDto"
},
"EntityAliases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityAliasDto"
},
"description": "The Alias information of the entity that is going to be screened",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent a Screening entity"
},
"SearchCriteriaDto": {
"required": [
"Type"
],
"type": "object",
"properties": {
"FullName": {
"type": "string",
"description": "The individual's full name. Alternatively use FirstName, MiddleName and LastName.",
"nullable": true,
"example": "Neil Arvel Moore"
},
"FirstName": {
"type": "string",
"description": "The individual's first name. Alternatively use FullName.",
"nullable": true,
"example": "Neil"
},
"MiddleName": {
"type": "string",
"description": "The individual's middle name. Alternatively use FullName.",
"nullable": true,
"example": "Arvel"
},
"LastName": {
"type": "string",
"description": "The individual's surname. Alternatively use FullName.",
"nullable": true,
"example": "Moore"
},
"DateOfBirth": {
"type": "string",
"description": "The individual's date of birth in DD/MM/YYYY format",
"nullable": true,
"example": "25/01/1950"
},
"Gender": {
"enum": [
"Male",
"Female"
],
"type": "string",
"description": "The individual's gender",
"nullable": true,
"example": "Male"
},
"LegalEntityName": {
"type": "string",
"description": "Full company name",
"nullable": true,
"example": "Fake Company"
},
"Type": {
"minLength": 1,
"enum": [
"Individual",
"Company",
"Other"
],
"type": "string",
"description": "Legal entity type i.e. Individual or Company",
"example": "Individual"
},
"Address": {
"$ref": "#/components/schemas/AddressDto"
},
"Addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressDto"
},
"description": "Addresses of the individual or company",
"nullable": true
},
"IDNumber": {
"type": "string",
"description": "The individual's or company's ID number",
"nullable": true,
"example": "459768575"
},
"PhoneNumber": {
"type": "string",
"description": "The individual's or company's phone number",
"nullable": true,
"example": "765864598"
},
"EmailAddress": {
"type": "string",
"description": "The individual's or company's email address",
"nullable": true,
"example": "hello@emailprovider.com"
},
"Nationality": {
"type": "string",
"description": "The individual's nationality",
"nullable": true,
"example": "Irish"
},
"CountryOfResidence": {
"type": "string",
"description": "The individual's country of residence",
"nullable": true,
"example": "Ireland"
},
"PlaceOfBirth": {
"type": "string",
"description": "The individual's place of birth",
"nullable": true,
"example": "Ireland"
},
"PlaceOfBirthISO2": {
"type": "string",
"description": "The Individual's place of birth in country ISO2 code",
"nullable": true,
"example": "IE"
},
"PlaceOfBirthISO3": {
"type": "string",
"description": "The Individual's place of birth in country ISO3 code",
"nullable": true,
"example": "IRL"
},
"Citizenship": {
"type": "string",
"description": "The individual's citizenship",
"nullable": true,
"example": "Irish"
},
"CitizenshipISO2": {
"type": "string",
"description": "The Individual's citizenship in country ISO2 code",
"nullable": true,
"example": "IE"
},
"CitizenshipISO3": {
"type": "string",
"description": "The Individual's citizenship in country ISO3 code",
"nullable": true,
"example": "IRL"
},
"RegisteredCountry": {
"type": "string",
"description": "The country the company is registered in",
"nullable": true,
"example": "Ireland"
},
"RegisteredCountryISO2": {
"type": "string",
"description": "The country the Company is registered in ISO2 code",
"nullable": true,
"example": "Ireland"
},
"RegisteredCountryISO3": {
"type": "string",
"description": "The country the Company is registered in ISO3 code",
"nullable": true,
"example": "Ireland"
},
"Subtype": {
"type": "string",
"description": "The subtype of an entity",
"nullable": true,
"example": "Vessel"
},
"UniqueId": {
"type": "string",
"description": "The unique id of an entity that is part of a subtype",
"nullable": true,
"example": "VesselId"
},
"OtherInformation": {
"type": "string",
"description": "Other information about an individual or a company",
"nullable": true,
"example": "Information1|Information2|Information3"
},
"PassportNumber": {
"type": "string",
"description": "Passport number of the individual",
"nullable": true,
"example": "123456789"
},
"SocialSecurityNumber": {
"type": "string",
"description": "Social Security Number (SSN) of the individual",
"nullable": true,
"example": "555-50-1234"
},
"DriversLicense": {
"type": "string",
"description": "Driver's License number of the individual",
"nullable": true,
"example": "SMITH580117SM9XJ"
},
"EmployerIdentificationNumber": {
"type": "string",
"description": "Employer Identification Number (EIN) of the company",
"nullable": true,
"example": "12-3456789"
}
},
"additionalProperties": false,
"description": "Class to represent the search criteria of an entity"
},
"ServiceResponse": {
"type": "object",
"properties": {
"Data": {
"type": "string",
"nullable": true
},
"Messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ServiceResponseMessage": {
"type": "object",
"properties": {
"Message": {
"type": "string",
"nullable": true
},
"Type": {
"type": "string",
"nullable": true
},
"ErrorCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TestRequestDto": {
"type": "object",
"properties": {
"AdditionalSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfigurationSetPropertyDto"
},
"description": "The additional settings related to the Screening provider, associated to the configuration set used at the time of performing the test operation",
"nullable": true
}
},
"additionalProperties": false,
"description": "Class to represent the data required to perform a \"Test\" operation, to check if the provider configuration is valid"
},
"TestRequestDtoAdapterRequestDto": {
"required": [
"Id",
"ProviderId",
"Tenant",
"Type"
],
"type": "object",
"properties": {
"Id": {
"minLength": 1,
"type": "string",
"description": "Field used to uniquely identify the request. \n\r\nIn most cases, the Screening BatchID is used here.",
"example": "fd23f474-eff9-425f-a776-78e2176b36e4"
},
"Tenant": {
"minLength": 1,
"type": "string",
"description": "The tenant of the client",
"example": "095d6a21-b5cf-4369-9491-0de90438e26c"
},
"ProviderId": {
"minLength": 1,
"type": "string",
"description": "The Screening internal ID of the provider. Must match the ID of the provider in the configuration",
"example": "MyProviderId"
},
"Type": {
"minLength": 1,
"enum": [
"Screen",
"ResolveMatches",
"Test",
"OngoingScreening",
"OngoingScreeningUpdate",
"OngoingScreeningGetResults"
],
"type": "string",
"description": "The type of the request",
"example": "Screen"
},
"Data": {
"$ref": "#/components/schemas/TestRequestDto"
}
},
"additionalProperties": false,
"description": "Class to represent a request to a Screening adapter"
}
}
}
}