openapi: 3.2.0
info:
  title: Fenergo Nebula Screening - Mock Adapter Adapter Mock API
  description: '## Purpose of the API


    The 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).'
  version: '1.0'
servers:
- url: /mockadaptercommand
tags:
- name: AdapterMock
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
      summary: Screen
      x-summary-source: derived
  /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
      summary: Resolve matches
      x-summary-source: derived
  /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
      summary: Test
      x-summary-source: derived
  /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
      summary: Ongoing screening
      x-summary-source: derived
  /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
      summary: Ongoing screening update
      x-summary-source: derived
components:
  schemas:
    ConfigurationSetPropertyDto:
      required:
      - FieldId
      type: object
      properties:
        FieldId:
          minLength: 1
          type: string
          description: Unique field id used to identify entry
          example: AcceptListID
        Value:
          type:
          - string
          - 'null'
          description: Value of entry
          example: '1234'
      additionalProperties: false
    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
          - 'null'
          description: The unique ID of the entity in Fen-X
          example: bb8cd902-1aa8-456e-a22d-a4fc470e8386
        SearchCriteria:
          $ref: '#/components/schemas/SearchCriteriaDto'
        EntityAliases:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityAliasDto'
          description: The Alias information of the entity that is going to be screened
      additionalProperties: false
      description: Class to represent a Screening entity
    OverriddenBatchEntityAliasDto:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
          description: The unique ID of the entity's alias in Fen-X
          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
    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
          - 'null'
          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.

            If the configuration set has since been deleted, the AdditionalSettings will not be sent.'
      additionalProperties: false
      description: Class to represent a batch that has been overridden
    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
          - 'null'
          description: The type of the alias
          example: Also Known As
        FullName:
          type:
          - string
          - 'null'
          description: The Individual's firstname and surname. Alternatively use FirstName with LastName.
          example: John Doe
        FirstName:
          type:
          - string
          - 'null'
          description: The Individual's first name. Alternatively use FullName.
          example: John
        MiddleName:
          type:
          - string
          - 'null'
          description: The Individual's middle name
          example: David
        LastName:
          type:
          - string
          - 'null'
          description: The Individual's surname. Alternatively use FullName.
          example: Doe
        LegalEntityName:
          type:
          - string
          - 'null'
          description: Full Company name
          example: Fenergo
      additionalProperties: false
      description: Class to represent a Screening entity Alias
    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
          - 'null'
          description: The unique ID of the entity in Fen-X
          example: bb8cd902-1aa8-456e-a22d-a4fc470e8386
        SearchCriteria:
          $ref: '#/components/schemas/SearchCriteriaDto'
        EntityAliasesForEnable:
          type:
          - array
          - 'null'
          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.

            In 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.'
        AdditionalSettingsForEnable:
          type:
          - array
          - 'null'
          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

            Only sent if Enable flag is true'
        ConfigurationSetId:
          type:
          - string
          - 'null'
          description: 'The configuration set ID used at the time of performing the enable or disable ogs operation.

            Can 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
      additionalProperties: false
      description: Class to represent the data required to perform an "OngoingScreening" operation, to enable or disable OGS for an entity
    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
          - 'null'
          items:
            $ref: '#/components/schemas/OverriddenBatchDto'
          description: "Data of the batches that have been overridden as part of this new batch's Screening request. \n\nThis will be empty if no batches have been overridden as part of this new batch creation"
        JourneyId:
          type:
          - string
          - 'null'
          description: The ID of the journey that the Screening batch belongs to.
          example: 8300bc67-4470-492e-a54d-9de01ef3ba6b
        ProcessId:
          type:
          - string
          - 'null'
          description: The ID of the process (within a specific journey) where the Screening batch belongs to
          example: 47e23fab-cc79-403c-a54a-2479e69deebb
        AdditionalSettings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConfigurationSetPropertyDto'
          description: The additional settings related to the Screening provider, associated to the configuration set used when creating a batch
      additionalProperties: false
      description: Class to represent the data required to perform a "Screen" operation, to screen a list of entities
    ResolveMatchesRequestDto:
      required:
      - Entities
      type: object
      properties:
        BatchExternalIds:
          type:
          - array
          - 'null'
          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)
        Entities:
          type: array
          items:
            $ref: '#/components/schemas/ResolveMatchesRequestEntityDto'
          description: The list of entities whose matches are going to be resolved
        AdditionalSettings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ConfigurationSetPropertyDto'
          description: The additional settings related to the Screening provider, associated to the configuration set used when creating a batch.
      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
    TestRequestDto:
      type: object
      properties:
        AdditionalSettings:
          type:
          - array
          - 'null'
          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
      additionalProperties: false
      description: Class to represent the data required to perform a "Test" operation, to check if the provider configuration is valid
    OngoingScreeningUpdateRequestDtoAdapterRequestDto:
      required:
      - Id
      - ProviderId
      - Tenant
      - Type
      type: object
      properties:
        Id:
          minLength: 1
          type: string
          description: "Field used to uniquely identify the request. \n\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
    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
          - 'null'
          description: The unique ID of the entity in Fen-X
          example: bb8cd902-1aa8-456e-a22d-a4fc470e8386
        SearchCriteria:
          $ref: '#/components/schemas/SearchCriteriaDto'
        EntityAliases:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityAliasDto'
          description: "Aliases of the entity to be updated. \nThe provider should also unsubscribe the entity from all aliases that are not present in this list and were previously subscribed to."
      additionalProperties: false
      description: 'Class to represent the data required to perform an "OngoingScreeningUpdate" operation,

        to update the data of an existing entity that has OGS enabled'
    AddressDto:
      type: object
      properties:
        AddressLine1:
          type:
          - string
          - 'null'
          description: The first line in the address
          example: 158, Upper O'Connell Street
        AddressLine2:
          type:
          - string
          - 'null'
          description: The second line in the address
          example: Dublin 1
        City:
          type:
          - string
          - 'null'
          description: The city
          example: Dublin
        PostalCode:
          type:
          - string
          - 'null'
          description: The postal code
          example: D01YT95
        Country:
          type:
          - string
          - 'null'
          description: The country
          example: Ireland
        CountryISO2:
          type:
          - string
          - 'null'
          description: The country ISO2 code
          example: IE
        CountryISO3:
          type:
          - string
          - 'null'
          description: The country ISO3 code
          example: IRL
        StateProvince:
          type:
          - string
          - 'null'
          description: The state or province
          example: Leinster
        Type:
          type:
          - string
          - 'null'
          description: The type of address
          example: Main address
      additionalProperties: false
      description: Class to represent the address of an entity
    ResolveMatchesRequestDtoAdapterRequestDto:
      required:
      - Id
      - ProviderId
      - Tenant
      - Type
      type: object
      properties:
        Id:
          minLength: 1
          type: string
          description: "Field used to uniquely identify the request. \n\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
    OverriddenBatchEntityDto:
      type: object
      properties:
        LegalEntityId:
          type:
          - string
          - 'null'
          description: The unique ID of the entity in Fen-X
          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\nNote: Previously Overridden batches will not be taken into account when calculating this property, so if the LegalEntityId\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
          - 'null'
          items:
            $ref: '#/components/schemas/OverriddenBatchEntityAliasDto'
      additionalProperties: false
      description: Class to represent an entity of an overridden batch
    SearchCriteriaDto:
      required:
      - Type
      type: object
      properties:
        FullName:
          type:
          - string
          - 'null'
          description: The individual's full name. Alternatively use FirstName, MiddleName and LastName.
          example: Neil Arvel Moore
        FirstName:
          type:
          - string
          - 'null'
          description: The individual's first name. Alternatively use FullName.
          example: Neil
        MiddleName:
          type:
          - string
          - 'null'
          description: The individual's middle name. Alternatively use FullName.
          example: Arvel
        LastName:
          type:
          - string
          - 'null'
          description: The individual's surname. Alternatively use FullName.
          example: Moore
        DateOfBirth:
          type:
          - string
          - 'null'
          description: The individual's date of birth in DD/MM/YYYY format
          example: 25/01/1950
        Gender:
          enum:
          - Male
          - Female
          type:
          - string
          - 'null'
          description: The individual's gender
          example: Male
        LegalEntityName:
          type:
          - string
          - 'null'
          description: Full company name
          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
          - 'null'
          items:
            $ref: '#/components/schemas/AddressDto'
          description: Addresses of the individual or company
        IDNumber:
          type:
          - string
          - 'null'
          description: The individual's or company's ID number
          example: '459768575'
        PhoneNumber:
          type:
          - string
          - 'null'
          description: The individual's or company's phone number
          example: '765864598'
        EmailAddress:
          type:
          - string
          - 'null'
          description: The individual's or company's email address
          example: hello@emailprovider.com
        Nationality:
          type:
          - string
          - 'null'
          description: The individual's nationality
          example: Irish
        CountryOfResidence:
          type:
          - string
          - 'null'
          description: The individual's country of residence
          example: Ireland
        PlaceOfBirth:
          type:
          - string
          - 'null'
          description: The individual's place of birth
          example: Ireland
        PlaceOfBirthISO2:
          type:
          - string
          - 'null'
          description: The Individual's place of birth in country ISO2 code
          example: IE
        PlaceOfBirthISO3:
          type:
          - string
          - 'null'
          description: The Individual's place of birth in country ISO3 code
          example: IRL
        Citizenship:
          type:
          - string
          - 'null'
          description: The individual's citizenship
          example: Irish
        CitizenshipISO2:
          type:
          - string
          - 'null'
          description: The Individual's citizenship in country ISO2 code
          example: IE
        CitizenshipISO3:
          type:
          - string
          - 'null'
          description: The Individual's citizenship in country ISO3 code
          example: IRL
        RegisteredCountry:
          type:
          - string
          - 'null'
          description: The country the company is registered in
          example: Ireland
        RegisteredCountryISO2:
          type:
          - string
          - 'null'
          description: The country the Company is registered in ISO2 code
          example: Ireland
        RegisteredCountryISO3:
          type:
          - string
          - 'null'
          description: The country the Company is registered in ISO3 code
          example: Ireland
        Subtype:
          type:
          - string
          - 'null'
          description: The subtype of an entity
          example: Vessel
        UniqueId:
          type:
          - string
          - 'null'
          description: The unique id of an entity that is part of a subtype
          example: VesselId
        OtherInformation:
          type:
          - string
          - 'null'
          description: Other information about an individual or a company
          example: Information1|Information2|Information3
        PassportNumber:
          type:
          - string
          - 'null'
          description: Passport number of the individual
          example: '123456789'
        SocialSecurityNumber:
          type:
          - string
          - 'null'
          description: Social Security Number (SSN) of the individual
          example: 555-50-1234
        DriversLicense:
          type:
          - string
          - 'null'
          description: Driver's License number of the individual
          example: SMITH580117SM9XJ
        EmployerIdentificationNumber:
          type:
          - string
          - 'null'
          description: Employer Identification Number (EIN) of the company
          example: 12-3456789
      additionalProperties: false
      description: Class to represent the search criteria of an entity
    ServiceResponse:
      type: object
      properties:
        Data:
          type:
          - string
          - 'null'
        Messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    TestRequestDtoAdapterRequestDto:
      required:
      - Id
      - ProviderId
      - Tenant
      - Type
      type: object
      properties:
        Id:
          minLength: 1
          type: string
          description: "Field used to uniquely identify the request. \n\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
    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
          - 'null'
          description: The unique ID of the entity in Fen-X
          example: bb8cd902-1aa8-456e-a22d-a4fc470e8386
        EntityAliasIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: 'List of the FenX Entity AliasIds that this entity is associated with for Alias Screening feature.

            When it''s associated with the primary name of the entity, one of them will be "PrimaryName".

            If the array is null or empty, it means that the match only belongs to the PrimaryName of the entity.'
        ExternalIds:
          type:
          - array
          - 'null'
          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)
        MatchesData:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ResolveMatchesRequestMatchDataDto'
          description: List of matches of the entity that are going to be resolved
      additionalProperties: false
      description: Class to represent a Screening 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
          - 'null'
          description: The value of the ID
          example: '1234'
      additionalProperties: false
      description: Class to represent the batch external IDs fetched from the providers (runId, resultId, etc)
    MatchDataExternalIdDto:
      type: object
      properties:
        EntityAliasId:
          type:
          - string
          - 'null'
          description: What entity Alias this externalId is associated with. Will be "PrimaryName" for the PrimaryName external ids
          example: e7b8f7c2-3c4a-4b2a-9e2d-1f2a3b4c5d6e
        Value:
          type:
          - string
          - 'null'
          description: The value of the ID
          example: '1234'
      additionalProperties: false
      description: Class to represent a match external id
    ScreenRequestDtoAdapterRequestDto:
      required:
      - Id
      - ProviderId
      - Tenant
      - Type
      type: object
      properties:
        Id:
          minLength: 1
          type: string
          description: "Field used to uniquely identify the request. \n\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
    OngoingScreeningRequestDtoAdapterRequestDto:
      required:
      - Id
      - ProviderId
      - Tenant
      - Type
      type: object
      properties:
        Id:
          minLength: 1
          type: string
          description: "Field used to uniquely identify the request. \n\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
    ServiceResponseMessage:
      type: object
      properties:
        Message:
          type:
          - string
          - 'null'
        Type:
          type:
          - string
          - 'null'
        ErrorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    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
          - 'null'
          description: What entity Alias this externalId is associated with. Will be null or "PrimaryName" for the PrimaryName external ids
          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
          - 'null'
          description: The value of the ID
          example: '1234'
      additionalProperties: false
      description: Class to represent the external IDs fetched from the providers (runId, resultId, etc)
    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
          - 'null'
          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".

            If the array is null or empty, it means that the match only belongs to the PrimaryName of the entity.'
        ExternalId:
          type:
          - string
          - 'null'
          description: "The unique identifier of the match outside of Fen-X (i.e. in the underlying provider). \n\nRequired to uniquely identify the match on the provider side."
          example: '1234'
          deprecated: true
        ExternalIds:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MatchDataExternalIdDto'
          description: "The unique identifiers of the match outside of Fen-X (i.e. in the underlying provider). \n\nThey will be used later on to resolve the matches on the provider side. There will be one ExternalId\nfor each of the entity alias ids related to this match"
        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
          - 'null'
          description: The reason why the match has the status specified in the property "Status"
          example: Matched Entity
        Comments:
          type:
          - string
          - 'null'
          description: Additional comments about the match resolution
          example: The name of the entity in the match is the same as the screened entity
        SubsidiaryFields:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: An optional dictionary used to add custom fields required by some adapters or providers
      additionalProperties: false
      description: Class to represent a match, with all the data that is needed to resolve it on the adapter side