openapi: 3.1.0
info:
  x-metadata:
    tags:
      - Featured
  version: 1.0.0
  title: KYC Compliance
  description: |
    KYC (Know Your Customer) enables you to make better-informed risk
    management decisions by utilizing our comprehensive business information.
    This service is designed for both Know Your Business operations and AML
    (Anti-Money Laundering) screening features. <br><br> The application
    ensures that you can conduct due diligence on customers and suppliers
    alike, identify key parties, verify individual  identity details globally,
    and screen against international sanctions, regulatory enforcements, PEP
    (Politically Exposed Persons) lists,  and potential adverse media.
x-tagGroups:
  - name: Authentication
    tags:
      - Authentication
  - name: Administration
    tags:
      - Administrator Resources
      - Audit
  - name: Profiles
    tags:
      - Profile Management
      - Profile Updates
      - Profile Key Parties
      - Profile Business / Individual Details
  - name: Screening
    tags:
      - AML Screening - Profile Management
      - AML Screening - Businesses
      - AML Screening - Individuals
      - AML Bulk Screening
  - name: Monitoring
    tags:
      - AML Monitoring Management
      - Async AML
      - Batch Uploads
      - Global Monitoring
  - name: Reporting
    tags:
      - Reporting
tags:
  - name: Authentication
    description: >-
      Endpoints to authenticate and generate an authentication token for secure
      access to the API.
  - name: Administrator Resources
    description: >-
      Endpoints for managing administrative tasks, such as user roles, currency
      codes, country codes and profile document types.
  - name: Audit
    description: >-
      Endpoints to retrieve audit logs and track activity related to profiles,
      searches, and monitoring actions.
  - name: Profile Management
    description: Endpoints to create, retrieve, and manage profiles.
  - name: Profile Updates
    description: >-
      Endpoints to update existing profiles with new information, such as
      addresses, notes, or attachments.
  - name: Profile Key Parties
    description: >-
      Endpoints to manage key parties associated with a profile, such as
      directors, shareholders, or UBOs.
  - name: Batch Uploads
    description: >-
      Endpoints to upload and process batch files for profiles or searches,
      including retrying failed uploads and downloading error reports.
  - name: Profile Business / Individual Details
    description: >-
      Endpoints to retrieve detailed information about businesses or individuals
      associated with a profile.
  - name: AML Screening - Profile Management
    description: >-
      Endpoints to manage AML screening profiles, including creating, updating,
      and retrieving screening results.
  - name: AML Screening - Businesses
    description: >-
      Endpoints to perform AML screening for businesses, including risk
      assessments and compliance checks.
  - name: AML Screening - Individuals
    description: >-
      Endpoints to perform AML screening for individuals, including identity
      verification and risk assessments.
  - name: AML Bulk Screening
    description: >-
      Endpoints to perform bulk AML screenings for multiple businesses or
      individuals in a single request.
  - name: AML Monitoring Management
    description: >-
      Endpoints to set up and manage ongoing AML monitoring for profiles,
      including receiving alerts for changes or risks.
  - name: Async AML
    description: >-
      Endpoints to return asynchronous AML jobs, such as bulk screenings or
      monitoring tasks.
  - name: Global Monitoring
    description: >-
      Endpoints to monitor changes to company information globally, including
      event rules and notifications.
  - name: Reporting
    description: >-
      Endpoints to generate and retrieve reports, including compliance reports
      and risk assessments.
servers:
  - url: https://connect.sandbox.creditsafe.com/v1
    description: Sandbox server
  - url: https://connect.creditsafe.com/v1
    description: Production server
paths:
  /authenticate:
    post:
      operationId: authenticate
      summary: Authenticate
      security: []
      tags:
        - Authentication
      description: |
        Supply username and password to generate Authentication Token.
          
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectAuthenticationAuthRequest'
        required: false
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectAuthenticationAuthResponse'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
  /compliance/kyc-protect/profiles/businesses/import:
    post:
      tags:
        - Profile Management
      description: >
        Imports a company business report into the system as a profile for
        compliance purposes. <br><br> While this endpoint allows for significant
        customization during the import process, the endpoint 
        `/compliance/kyc-protect/profiles/import/companies/{companyId}` is the
        **preferred method**  as it automates much of the processing and
        configuration. Use this endpoint only when the preferred  endpoint
        cannot meet your requirements.
      summary: Create Profile From Company Report
      operationId: compliancepostkycprofilebusinessesimports
      parameters:
        - name: language
          in: query
          description: >-
            Report Language - The JSON structure of the Report is language
            invariant, but field content will return as the given language,
            where available.
          schema:
            pattern: ^[a-zA-Z]{2}$
            type: string
            default: en
        - name: template
          in: query
          description: >-
            Parameter to request a Templated Company Report. A Template
            adds/reduces sections of the Credit Report depending on your
            subscription. Do not include this parameter if you have not been
            given a template to use.
          schema:
            type: string
            default: full
        - name: includeIndicators
          in: query
          description: Optional parameter flag to include indicators or not.
          schema:
            type: boolean
            default: true
        - name: customData
          in: query
          description: >-
            Additional Report Parameters e.g.  German Report Reason Code value
            is `de_reason_code::1` . Use /reportcustomdata/{country} endpoint to
            see all values.
          schema:
            type: string
            nullable: true
        - name: reportSections
          in: query
          description: >-
            Optional parameter to get specific sections of report instead  of
            entire report.
          schema:
            type: string
        - name: languageFallback
          in: query
          description: Optional parameter flag to request a report with default language.
          schema:
            type: boolean
            default: false
        - name: callRef
          in: query
          description: Call Reference
          schema:
            type: string
            default: None
            nullable: true
          required: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostKYCProfileImportBusinessesRequest'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    format: UUID
                  kycResponse:
                    type: object
                    properties:
                      id:
                        type: string
                        format: UUID
                        description: A Unique Id that will be known as the `Profile Id`
                      profileUrl:
                        type: string
                  report:
                    $ref: >-
                      #/components/schemas/CreditsafeGlobalDataReportsCompanyReportResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
  /compliance/kyc-protect/profiles:
    post:
      tags:
        - Profile Management
      description: Uses the name and type provided by the user to create a profile.
      summary: Create Profile
      operationId: KYCProtectCreateProfile
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KycProtectPostProfilesRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycProtectProfileCreatedResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
    get:
      tags:
        - KYC Profile Management
      description: Returns a list of profiles ordered by modified date.
      summary: Return Created Profiles
      operationId: ComplianceProtectGetKYCProfiles
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: searchTerm
          in: query
          description: >-
            A search term to filter by. The search term will be matched against
            names, and internal ids containing the search term.
          schema:
            type: string
        - name: assignees
          in: query
          description: The ids of assigned users to filter by.
          schema:
            type: integer
            format: int32
        - name: kycReviewAfter
          in: query
          description: >-
            Filters results based on profiles with a kyc review date after this
            date.
          schema:
            type: string
            format: date
        - name: kycReviewBefore
          in: query
          description: >-
            Filters results based on profiles with a kyc review date after this
            date.
          schema:
            type: string
            format: date
        - name: riskRatings
          in: query
          description: >-
            The risk ratings to filter by. Available values: notApplicable,
            veryLow, low, medium, high, veryHigh
          schema:
            type: array
            items:
              type: string
        - name: sortOrder
          in: query
          description: >-
            The order in which the items should be sorted. Available values:
            asc, desc
          schema:
            type: string
        - name: sortBy
          in: query
          description: >-
            The field by which the items should be sorted. Available values:
            modifiedAt, name
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKYCProfiles'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
    delete:
      tags:
        - KYC Profile Management
      description: >-
        Deletes list of profiles. <br>This will delete all its
        dependencies/child items associated to that profileId.
      summary: Delete All Profiles
      operationId: complianceProtectDeleteKYCProfiles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteKYCProfiles'
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: boolean
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: Invalid Token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: Access Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/profiles/{profileId}:
    get:
      tags:
        - Profile Management
      description: Returns a single profile by id.
      summary: Return Profile By Profile Id
      operationId: ProtectGetKYCProfilesByProfileId
      parameters:
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKYCProfileByProfileId'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    delete:
      tags:
        - Profile Management
      description: Deletes a single profile by id.
      summary: Delete Profile By Profile Id
      operationId: ProtectDeleteKYCProfilesById
      parameters:
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    put:
      tags:
        - Profile Updates
      description: Updates a single profile by profile Id.
      operationId: ProtectUpdatesKYCProfileById
      summary: Update Profile By Profile Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateKYCProfileByProfileIdRequest'
      parameters:
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateKYCProfileByProfileId'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
  /compliance/kyc-protect/profiles/types:
    get:
      tags:
        - Administrator Resources
      description: Returns all the profile Types
      operationId: ProtectGetKYCProfileTypes
      summary: Return Profile Types
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKYCProfileTypes'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/profiles/assign:
    put:
      tags:
        - Profile Management
      description: Assign a profile to a user
      operationId: ProtectAssignProfiles
      summary: Assign Profile To User
      parameters:
        - name: profileId
          in: query
          description: Id of the profile being assigned to a user
          required: true
          schema:
            type: string
        - name: userId
          in: query
          description: User Id to assign the Profile to
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutKYCProfileAssign'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/profiles/{profileId}/notes:
    post:
      tags:
        - Profile Updates
      description: Adds a note to a profile then Returns the details of the added note.
      operationId: ProtectPOSTKYCProfileNotes
      summary: Create Profile Note
      parameters:
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostKYCProfileNotesRequest'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostKYCProfileNotes'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
    get:
      tags:
        - Profile Updates
      description: Returns a list of profile notes for the given profile id.
      operationId: ProtectGETKYCProfileNotes
      summary: Return Profile Notes
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
        - name: searchTerm
          in: query
          description: >-
            Filters the note list by notes with body containing the provided
            string
          schema:
            type: string
        - name: isArchived
          in: query
          description: >-
            Get archived notes based on this flag. Allowed values are true,
            false or null
          schema:
            type: boolean
            nullable: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKYCProtectProfileIdNotesResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/profiles/{profileId}/notes/{noteId}:
    get:
      tags:
        - Profile Updates
      description: Returns a profile note based on profile id and note id.
      operationId: ProtectGETKYCProfileNotesByNoteId
      summary: Return Profile Notes By Note Id
      parameters:
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
        - name: noteId
          in: path
          description: Id of a note.
          required: true
          example: 047ae398-7639-40af-911e-cc214cf3045c
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKYCProtectProfileIdNoteIdResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    put:
      tags:
        - Profile Updates
      description: Updates a profile note based on profile id and note id.
      operationId: ProtectUpdateKYCProfileNotesByNoteId
      summary: Update Profile Note By Note Id
      parameters:
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
        - name: noteId
          in: path
          description: Id of a note.
          required: true
          example: 047ae398-7639-40af-911e-cc214cf3045c
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutKYCProfileNotesByNoteIdRequest'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutKYCProfileNotesByNoteId'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
    delete:
      tags:
        - Profile Updates
      description: Deletes a profile note based on profile id and note id.
      operationId: ProtectDELETEKYCProfileIdByNoteId
      summary: Deletes Profile Note By Note Id
      parameters:
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
        - name: noteId
          in: path
          description: Id of a note.
          required: true
          example: 047ae398-7639-40af-911e-cc214cf3045c
          schema:
            type: string
      responses:
        '204':
          description: No Content
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/profiles/{profileId}/details:
    get:
      tags:
        - Profile Business / Individual Details
      description: Fetches details of a profile by profile Id.
      operationId: ProtectGETKYCProfileDetails
      summary: Return Profile Details
      parameters:
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKYCProfileDetailsByProfileId'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    put:
      tags:
        - Profile Business / Individual Details
      description: Updates the details of profile by the profileId.
      operationId: ProtectPUTKYCProfileDetails
      summary: Update Profile Details
      parameters:
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutKYCProfileDetailsByProfileIdRequest'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutKYCProfileDetailsByProfileId'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/profiles/{profileId}/details/addresses:
    post:
      tags:
        - Profile Business / Individual Details
      description: >-
        Creates an address for the given profileId. Returns the created address
        information.
      operationId: KYCProtectCreatesAnAddressForTheUser
      summary: Creates An Address For Profile
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - type
                - description
              properties:
                type:
                  type: string
                  description: The type of the address.
                  enum:
                    - registered
                    - trading
                    - other
                  nullable: true
                buildingDetails:
                  type: string
                  description: >-
                    The building details of the address being created. Must have
                    a maximum length of 250 characters.
                  nullable: true
                street:
                  type: string
                  description: >-
                    The street of the address being created. Must have a maximum
                    length of 250 characters.
                  nullable: true
                city:
                  type: string
                  description: >-
                    The city of the address being created. Must have a maximum
                    length of 250 characters.
                  nullable: true
                region:
                  type: string
                  description: >-
                    The region of the address being created. Must have a maximum
                    length of 250 characters.
                  nullable: true
                postalCode:
                  type: string
                  description: >-
                    The postal code of the address being created. Must have a
                    maximum length of 50 characters.
                  nullable: true
                countryCode:
                  type: string
                  description: Two-letter ISO-3166-2 country code
                  nullable: true
                description:
                  type: string
                  description: >-
                    The description of the address being created. Must have a
                    maximum length of 250 characters
                  nullable: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycProtectProfileAddressResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
    get:
      tags:
        - Profile Business / Individual Details
      description: >-
        Returns list of addresses for the current logged in user based on
        profileId.
      operationId: KYCProtectGetsListOfAddresses
      summary: Return Lists Of Addresses
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/KycProtectProfileGetDetailsAddressResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId}:
    get:
      tags:
        - Profile Business / Individual Details
      description: Returns the address by profile Id and address Id.
      operationId: ProtectGETKYCProfileAddressDetailsByProfileIdAndAddressId
      summary: Return Profile Address Details By Profile And Address Id
      parameters:
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
            format: uuid
        - name: addressId
          in: path
          description: Id of a user address.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUser
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    put:
      tags:
        - Profile Business / Individual Details
      description: Update Profile Address Details By Profile Id And Address Id
      operationId: ProtectPUTKYCProfileAddressDetailsByProfileIdAndAddressId
      summary: Update Profile Address Details By Profile Id And Address Id
      parameters:
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
            format: uuid
        - name: addressId
          in: path
          description: Id of a user address.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/UpdateKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUserRequest
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PutKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUser
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
    delete:
      tags:
        - Profile Business / Individual Details
      description: Deletes the address by profile Id and address id.
      operationId: ProtectDELETEKYCProfileAddressDetailsByProfileIdAndAddressId
      summary: Delete Profile Address Details By Profile Id And Address Id
      parameters:
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
            format: uuid
        - name: addressId
          in: path
          description: Id of a addressId.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No Content
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/profiles/{profileId}/keyparties:
    post:
      tags:
        - Profile Key Parties
      summary: Creates A Key Party Folder Linked To The Profile Id
      description: >-
        Uses the details provided by the user to create key parties. Returns the
        created key parties information.
      operationId: compliancepostkyckeypartiesbyprofileid
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostKYCKeypartiesByProfileIdRequest'
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  failed:
                    type: array
                    items:
                      $ref: >-
                        #/components/schemas/PostKYCKeypartiesByProfileIdFailedResponse
                  successful:
                    type: array
                    items:
                      $ref: >-
                        #/components/schemas/PostKYCKeypartiesByProfileIdResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
    get:
      tags:
        - Profile Key Parties
      summary: Return All Key Party Records Linked To A Profile
      description: >-
        This endpoint will return all created Key Party folders linked to the
        profile id.
      operationId: compliancegetkyckeypartiesbyprofileid
      parameters:
        - name: profileId
          in: path
          description: Id of the profile
          required: true
          schema:
            type: string
            format: uuid
        - name: entityType
          in: query
          description: >-
            Entity type of the key party. Available values are individual,
            business.
          schema:
            type: string
        - name: keyPartyTypes
          in: query
          description: >-
            Type of the key party. Available values are director, shareholder
            and ubo.
          schema:
            type: string
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKeyPartiesResponseByProfileId'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    put:
      tags:
        - Profile Key Parties
      summary: Update A Batch Of Key Parties
      description: Updates a batch of key parties
      operationId: complianceputkyckeypartiesbyprofileid
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutKYCKeypartiesByProfileIdRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  failed:
                    type: array
                    items:
                      $ref: >-
                        #/components/schemas/PutKYCKeypartiesByProfileIdFailedResponse
                  successful:
                    type: array
                    items:
                      $ref: >-
                        #/components/schemas/PostKYCKeypartiesByProfileIdResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    delete:
      tags:
        - Profile Key Parties
      summary: Delete a batch of key parties
      description: Delete a selection of key parties from a specific profile.
      operationId: compliancedeletekyckeypartiesbyprofileid
      parameters:
        - name: profileId
          in: path
          description: Id of the profile
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
              properties:
                keyPartyIds:
                  type: array
                  items:
                    type: string
                    format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteKeyPartiesResponseByProfileId'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/profiles/{profileId}/keyparties/searches:
    get:
      tags:
        - Profile Key Parties
      summary: Return All Key Party Searches
      description: Get profile key party searches for the user.
      operationId: compliancegetkyckeypartiessearches
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
        - name: type
          in: query
          description: 'type of searches. Available values: individual, business'
          schema:
            type: string
        - name: keyPartyTypes
          in: query
          description: 'keyparty types. Available values: director, shareHolder, ubo'
          schema:
            type: string
        - name: isScheduled
          in: query
          description: schedule check.
          schema:
            type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKeyPartySearchResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
    delete:
      tags:
        - Profile Key Parties
      summary: Deletes A Batch Of Key Party Searches
      description: Delete a batch of key parties searches
      operationId: compliancedeletekyckeypartiessearches
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteKeyPartySearchContractRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteKeyPartySearchContractResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
  /compliance/kyc-protect/profiles/{profileId}/keyparties/searches/bulk:
    post:
      tags:
        - Profile Key Parties
      summary: Request Multiple Searches Linked To A Key Party Asynchronously
      description: >-
        Request multiple searches to be performed and linked to a key party
        asynchronously
      operationId: compliancepostkyckeypartiessearchesbulkbyprofileid
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                items:
                  type: array
                  items:
                    $ref: '#/components/schemas/AddKeyPartySearchContract'
                  description: The Request Items collection
                  nullable: true
      responses:
        '202':
          description: Accepted
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/profiles/{profileId}/keyparties/searches/link:
    post:
      tags:
        - Profile Key Parties
      summary: Links Searches To Key Parties
      description: Add searches link to key parties for the current logged in user.
      operationId: compliancepostkyckeypartiessearcheslinkbyprofileid
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                items:
                  type: array
                  items:
                    type: object
                    properties:
                      keyPartyId:
                        type: string
                        description: Id of the key party to link to the search
                        nullable: true
                      searchId:
                        type: string
                        description: Id of the search to link to the key party
                        nullable: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostKYCKeypartiesSearchesLinkByProfileIdResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
  /compliance/kyc-protect/profiles/{profileId}/keyparties/{keyPartyId}:
    put:
      tags:
        - Profile Key Parties
      summary: Updates The Key Party By Profile Id and Key Party Id
      description: >-
        Updates a key party on a profile by Id. Returns the updated key party
        data.
      operationId: complianceprotectputkycprofileskeypartiesbyprofileidandkeypartyid
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
        - name: keyPartyId
          in: path
          description: id of the keyParty
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: Modified key party
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateKeyPartyById'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyPartyByIdReturn'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    delete:
      tags:
        - Profile Key Parties
      summary: Deletes a Key PArty By Key Party Id
      description: Delete a key party by Id.
      operationId: complianceprotectdeletekycprofileskeypartiesbyprofileidandkeypartyid
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
        - name: keyPartyId
          in: path
          description: id of the keyParty
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteKeyPartyByIdNoContent'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/lookup/currencyCodes:
    get:
      tags:
        - Administrator Resources
      description: Returns the list of accepted currency codes.
      operationId: ProtectGETLookupCurrencyCodes
      summary: Returns Accepted Currency Codes
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                  example: eur
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/lookup/countryCodes:
    get:
      tags:
        - Administrator Resources
      description: Returns the list of accepted country-codes.
      operationId: ProtectGETLookupCountryCodes
      summary: Return Accepted Country Codes
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                  example: GB
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/lookup/kycMonitoring/countryCodes:
    get:
      tags:
        - Global Monitoring
      description: Gets the list of acceptable country codes for kyc monitoring.
      operationId: complianceProtectGetLookupMonitoringCountryCodes
      summary: Returns Available Country Codes
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/profiles/document-types:
    get:
      tags:
        - Administrator Resources
      description: Returns a list of document types valid for the provided profile type.
      operationId: KYCProtectGetProfileDocumentTypes
      summary: Return Profile Document Types
      parameters:
        - name: type
          in: query
          description: The type of the profile the user wants to return.
          required: true
          schema:
            type: string
            enum:
              - trust
              - individual
              - soleTrader
              - company
              - plc
              - partnership
              - otherEntity
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
  /compliance/kyc-protect/profiles/assign/bulk:
    put:
      tags:
        - Profile Management
      description: Assigns list of profiles to a user.
      operationId: KYCProtectAssignsListOfProfilesToUser
      summary: Assigns A List Of Profiles To User
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MODEL4df4ca'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/KycProtectProfileAssignBulkResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/profiles/{profileId}/attachments:
    post:
      tags:
        - Profile Updates
      description: >-
        Adds an attachment to a profile. Returns the details of the added
        attachment.
      operationId: KYCProtectAddAnAttachmentToTheGivenProfile
      summary: Add An Attachment To The Given Profile
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                File:
                  type: string
                  description: The attachment to be added. Size Limited to 50MB.
                  format: binary
                DocumentType:
                  type: string
                  description: The document type of the attachment
                Description:
                  type: string
                  description: >-
                    The description of the attachment. Limited to 250
                    characters.
            encoding:
              File:
                style: form
              DocumentType:
                style: form
              Description:
                style: form
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycProtectProfileAttachmentResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
    get:
      tags:
        - Profile Updates
      description: >-
        Gets a list of attachments on the given profile ordered by modified
        date.
      operationId: KYCProtectGetListOfAttachmentsOnTheGivenProfile
      summary: Return List Of Attachments On The Given Profile
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
        - name: page
          in: query
          description: The page number to fetch. Should be a positive integer.
          schema:
            type: integer
            format: int32
        - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalSize:
                    type: integer
                    format: int32
                  items:
                    type: array
                    items:
                      $ref: >-
                        #/components/schemas/KycProtectProfileGetAttachmentResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}:
    get:
      tags:
        - Profile Updates
      description: Returns an attachment by the provided attachment Id and profile Id.
      operationId: ProtectGETKYCProfileAttachmentByProfileIdAndAttachmentId
      summary: Return A Profile Attachment By Profile And Attachment Id
      parameters:
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
            format: uuid
        - name: attachmentId
          in: path
          description: Id of an attachment.
          required: true
          example: 24faad02-7e20-4912-bdd9-51e4797380c5
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetKYCProfileAttachmentDetailsByAttachmentId
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    put:
      tags:
        - Profile Updates
      description: Updates A Profile Attachment By Profile And Attachment Id
      operationId: ProtectPutKYCProfileAttachmentByProfileIdAndAttachmentId
      summary: Update Profile Attachment By Profile And Attachment Id
      parameters:
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
            format: uuid
        - name: attachmentId
          in: path
          description: Id of a attachmentId.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UpdateKYCAttachmentsByAttachmentIdRequest'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateKYCAttachmentsByAttachmentId'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
    delete:
      tags:
        - Profile Updates
      description: Deletes A Profile Attachment By Profile And Attachment Id
      operationId: ProtectDeleteKYCProfileAttachmentByProfileIdAndAttachmentId
      summary: Delete Attachment By Profile And Attachment Id
      parameters:
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
            format: uuid
        - name: attachmentId
          in: path
          description: Id of a attachmentId.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No Content
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
  /compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}/download:
    get:
      tags:
        - Profile Updates
      description: Gets profile attachment's download link.
      operationId: ProtectDownloadKYCProfileAttachmentByProfileIdAndAttachmentId
      summary: Download Profile Attachment By Profile And Attachment Id
      parameters:
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
            format: uuid
        - name: attachmentId
          in: path
          description: Id of a note.
          required: true
          example: 24faad02-7e20-4912-bdd9-51e4797380c5
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadAttachmentResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/profiles/{profileId}/searches:
    get:
      tags:
        - AML Screening - Profile Management
      description: >-
        Returns a list of searches both business and individual associated to
        the profile for the profile Id.
      operationId: KYCProtectGetSListOfSearchesOnTheGivenProfile
      summary: Return List Of AML Searches On The Given Profile
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: isScheduled
          in: query
          schema:
            type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalSize:
                    type: integer
                    format: int32
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/KycProtectGetSearchResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    delete:
      tags:
        - AML Screening - Profile Management
      description: Deletes AML searches from a profile by profile Id and Search Id.
      operationId: DeleteKYCProfileSearchesByProfileId
      summary: Deletes AML searches linked to a profile
      parameters:
        - name: profileId
          in: path
          description: Id of a profile.
          required: true
          example: 9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/DeleteKYCProfileSearchesByProfileIdRequestBody
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/DeleteKYCProfileSearchesByProfileIdResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
  /compliance/kyc-protect/profiles/{profileId}/searches/link:
    post:
      tags:
        - AML Screening - Profile Management
      description: Adds a list of searches to a profile.
      operationId: KYCProtectAddsASearchToTheGivenProfile
      summary: Adds AML Searches To The Given Profile
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                searchIds:
                  type: array
                  items:
                    type: string
                    format: uuid
                  description: List of searches to link to a profile
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  successful:
                    type: array
                    items:
                      type: string
                      format: uuid
                    nullable: true
                  failed:
                    type: array
                    items:
                      type: object
                      properties:
                        failedItem:
                          type: string
                          format: uuid
                        error:
                          $ref: '#/components/schemas/KycProtectProblemDetails'
                    nullable: true
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
  /compliance/kyc-protect/profiles/{profileId}/searches/bulk:
    post:
      tags:
        - AML Bulk Screening
      summary: Perform Bulk AML Screening
      description: >-
        Request multiple searches to be performed and linked to a profile
        asynchronously
      operationId: compliancepostkycsearchesbulkbyprofileid
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                items:
                  type: array
                  items:
                    $ref: '#/components/schemas/AddSearchContract'
                  description: The Request Items collection
                  nullable: true
      responses:
        '202':
          description: Accepted
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
  /compliance/kyc-protect/searches/businesses:
    post:
      tags:
        - AML Screening - Businesses
      summary: >-
        Performs An AML Search For A Business And Saves The Results To The
        Database
      description: >-
        A request requires a name, at least one valid dataset, and a threshold.
        User will be deducted 1 credit for each AML search.
      operationId: KYCSearchBusiness
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - threshold
                - name
                - dataset
              properties:
                countryCodes:
                  type: array
                  description: List of Two-letter country code ISO-3166-2.
                  items:
                    type: string
                threshold:
                  type: integer
                  description: >-
                    Hits with scores below the chosen value will not be
                    shown.<br> Must be one of 75, 80, 85, 90, 95, or 100
                  format: int32
                name:
                  type: string
                  description: >-
                    Name of the business to be searched.<br> Example - Google
                    Inc<br> Max 200 characters allowed.
                datasets:
                  type: array
                  description: >-
                    Specifies which datasets will be searched<br><br> `PEP` -
                    Politically Exposed Persons (All)<br> `PEP-LINKED` - Only
                    linked PEPs (PEP by Association)<br> `SAN` - Sanctioned
                    (All)<br> `SAN-CURRENT` - Only current Sanctions<br>
                    `SAN-FORMER` - Only former Sanctions<br> `INS` -
                    Insolvency<br> `AM` - Adverse Media<br> `POI` - Profile of
                    Interest<br> `ENF` - Enforcement<br> `SOE` - State Owned
                    Enterprises (All)<br> `SOE-CURRENT` - Only current SOE<br>
                    `SOE-FORMER` - Only former SOE<br>
                  items:
                    type: string
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MODEL931a1b'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
    get:
      tags:
        - AML Screening - Businesses
      description: Returns a list of business AML searches ordered by modified date.
      summary: Returns Business AML Searches
      operationId: KYCSearchBusinessGet
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: isScheduled
          in: query
          schema:
            type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MODELf73bb1'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
    put:
      tags:
        - AML Screening - Businesses
      description: Updates a batch of business AML searches.
      summary: Update Business AML Searches
      operationId: KYCSearchBusinessPut
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                items:
                  type: array
                  items:
                    type: object
                    required:
                      - searchId
                      - riskRating
                    properties:
                      assignedToUserId:
                        type: integer
                        nullable: true
                        description: Id of the User to assign to the Search
                        format: int32
                      status:
                        type: string
                        nullable: true
                        description: >-
                          Status of the Search. Available values are new,
                          approved, declined, pending, cancelled, referred and
                          closed.
                      riskRating:
                        type: string
                        nullable: true
                        description: >-
                          Risk rating of the Search. Available values are
                          notApplicable, veryLow, low, medium, high AND
                          veryHigh.
                      note:
                        type: string
                        nullable: true
                        description: Note associated with the search
                      searchId:
                        type: string
                        description: The Id of the search to be updated
                        format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KYCPUTSearchBusinessesResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
  /compliance/kyc-protect/searches/businesses/{searchId}:
    get:
      tags:
        - AML Screening - Businesses
      summary: Return Business AML Search By Search Id
      description: Returns a single AML search based on Search id.
      operationId: GetKYCSearchBusinessBySearchId
      parameters:
        - name: searchId
          in: path
          required: true
          description: Id of the search
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KYCGetSearchBusinessesBySearchIdResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
    put:
      tags:
        - AML Screening - Businesses
      summary: Update A Business AML Search By Search Id
      description: Updates a business AML search.
      operationId: PutKYCSearchBusinessBySearchId
      parameters:
        - name: searchId
          in: path
          required: true
          description: Id of the search
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                assignedToUserId:
                  type: integer
                  description: Id of the User to assign to the Search
                  format: int32
                status:
                  type: string
                  description: >-
                    Status of the Search. Available values are new, approved,
                    declined, pending, cancelled, referred and closed.
                riskRating:
                  type: string
                  description: >-
                    Risk rating of the Search. Available values are
                    notApplicable, veryLow, low, medium, high AND veryHigh.
                note:
                  type: string
                  description: Note associated with the search
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KYCPutSearchBusinessesBySearchIdResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
  /compliance/kyc-protect/searches/businesses/{searchId}/hits:
    get:
      tags:
        - AML Screening - Businesses
      description: Returns the business AML search hits from the AML search results.
      operationId: GetKYCSearchBusinessHitsBySearchId
      summary: Return Business AML Search Hits
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: searchId
          in: path
          required: true
          description: Id of the search
          schema:
            type: string
        - name: hitDecisions
          description: >-
            The hit decisions. <br> Available Values - [undecided, truematch,
            falsepositive, discarded]
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/KYCGetSearchBusinessesBySearchIdHitsResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    put:
      tags:
        - AML Screening - Businesses
      description: Updates a batch of business AML search hits.
      operationId: PutKYCSearchBusinessHitsBySearchId
      summary: Update Batch Of Business AML Search Hits
      parameters:
        - name: searchId
          in: path
          description: Id of the search
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MODEL7b2457'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/KYCPutSearchBusinessesBySearchIdHitsResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}:
    get:
      tags:
        - AML Screening - Businesses
      description: >-
        This endpoint will return the full hit information by search Id and
        hitId. <br> Once this information is requested the information returned
        is stored to the database as a snap shot of that point in time.
      operationId: GetKYCSearchBusinessHitsBySearchIdAndHitId
      summary: Return Full AML Search Hit Information By SearchId And HitId
      parameters:
        - name: searchId
          in: path
          description: Id of the search
          required: true
          schema:
            type: string
        - name: hitId
          in: path
          description: Id of the hit
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/WebApiModelsSearchesSearchResultHitsBusinessSearchResultHitResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    put:
      tags:
        - AML Screening - Businesses
      description: >-
        This endpoint will update a single business AML search hit by searchId
        and hitId.
      operationId: PutKYCSearchBusinessBySearchIdAndHitId
      summary: Update A Single Business Hit
      parameters:
        - name: searchId
          in: path
          required: true
          description: Id of the search
          schema:
            type: string
        - name: hitId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                decision:
                  type: string
                  description: >-
                    The Decision of the Hit to be updated. The Decision can only
                    be made once.<br> Allowed values are undecided,trueMatch and
                    falsePositive
                note:
                  type: string
                  description: Note associated with the Hit
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KYCBusinessSearchResultHitSummaryResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}/download:
    get:
      tags:
        - AML Screening - Businesses
      summary: Download AML Details for a Hit
      description: >
        Retrieves the download URL and metadata for the AML details PDF
        associated with a specific hit  within a business search. <br><br> Use
        this endpoint to obtain the PDF file containing detailed AML information
        for a flagged  result (`hitId`) from a previously performed search
        (`searchId`). The response includes the  download URL, file name,
        expiration timestamp, and identifiers for the search and hit.
      operationId: complianceGetKycSearchBusinessHitsBySearchIdAndHitIdDownload
      parameters:
        - name: searchId
          in: path
          description: >
            The unique identifier of the search that generated the hit. This ID
            links the request  to the specific search performed in the KYC
            Protect system.
          required: true
          schema:
            type: string
            format: uuid
        - name: hitId
          in: path
          description: >
            The unique identifier of the hit associated with the search. This ID
            is used to retrieve  the specific details of a flagged result from
            the search.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/WebApiModelsSearchesSearchResultHitsBusinessSearchHitAttachmentLinkResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/searches/individuals:
    post:
      tags:
        - AML Screening - Individuals
      summary: >-
        Performs An AML Search For An Individual And Saves The Results To The
        Database
      description: >-
        A request requires a name, or first name and last name, at least one
        valid dataset and a threshold.<br><br> Length of name or combination of
        first name, middle name and last name must not exceed 200 characters. If
        user is providing first name, middle name and last name combination, the
        max characters limit includes the formatted name in this format
        {lastName} {firstName} {middleName}.<br><br> User will be deducted 1
        credit for each search.
      operationId: complianceKYCProtectCreateIndividualsSearch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KYCPostIndividualSearchContract'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/KycProtectPostPostIndividualSearchResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
    get:
      tags:
        - AML Screening - Individuals
      description: Returns a list of individual AML searches ordered by modified date.
      operationId: ComplianceKYCProtectGetIndividualsSearch
      summary: Returns Individual AML Searches
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: isScheduled
          in: query
          required: false
          schema:
            type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycProtectIndividualSearchResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
    put:
      tags:
        - AML Screening - Individuals
      description: Updates a batch of individual AML searches.
      summary: Update Individual AML Searches
      operationId: ComplianceKYCProtectUpdateIndividualsSearch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutKYCIndividualSearchRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KYCPUTSearchIndividualResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
  /compliance/kyc-protect/searches/individuals/{searchId}:
    get:
      tags:
        - AML Screening - Individuals
      summary: Return Individual AML Search By Search Id
      description: Returns a single AML Search based on searchId.
      operationId: GetsAnIndividualSearchForTheCurrentLoggedInUsersCustomerBasedOnSearchId
      parameters:
        - name: searchId
          in: path
          description: search id to fetch
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KYCGetSearchIndividualBySearchIdResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
    put:
      tags:
        - AML Screening - Individuals
      summary: Updates An Individual AML Search By SearchID
      operationId: updatesAnIndividualSearch
      description: Updates an Individual AML Search by Search Id.
      parameters:
        - name: searchId
          in: path
          description: search id to update
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutKYCIndividualSearchBySearchIdRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KYCPutSearchIndividualBySearchIdResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/searches/individuals/{searchId}/hits:
    get:
      tags:
        - AML Screening - Individuals
      summary: Returns Individual AML Search Hits
      operationId: getsTheIndividualSearchHits
      description: Returns the individual AML search hits from the AML search results.
      parameters:
        - name: searchId
          in: path
          description: The search identifier.
          required: true
          schema:
            type: string
            format: uuid
        - name: hitDecisions
          in: query
          description: >-
            The hit decisions. It can be the collection of undecided, trueMatch,
            falsePositive, discarded
          schema:
            type: string
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIndividualSearchIdHitsResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    put:
      tags:
        - AML Screening - Individuals
      summary: Updates A Batch Of individual AML search Hits
      operationId: updatesABatchOfIndividualHits
      description: Update a batch of Individual AML Search Hits.
      parameters:
        - name: searchId
          in: path
          description: Id of the search
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MODEL20274f'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutIndividualSearchIdHitsResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}:
    get:
      tags:
        - AML Screening - Individuals
      summary: Return Full AML Search Hit Information By SearchId And HitId
      operationId: returnsFullProfileInformationOfAIndividualHitByHitId
      description: >-
        This endpoint will return the full hit information by search Id and
        hitId. <br> Once this information is requested the information returned
        is stored to the database as a snap shot of that point in time.
      parameters:
        - name: searchId
          in: path
          description: Id of the search
          required: true
          schema:
            type: string
            format: uuid
        - name: hitId
          in: path
          description: Id of the hit
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndividualSearchResultHitResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    put:
      tags:
        - AML Screening - Individuals
      summary: Update A Single Individual Hit
      operationId: updateSingleIndividualHit
      description: >-
        This endpoint will update a single individual AML search hit by searchId
        and hitId.
      parameters:
        - name: searchId
          in: path
          description: Id of the search
          required: true
          schema:
            type: string
            format: uuid
        - name: hitId
          in: path
          description: Id of the hit
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndividualsSearchResultUpdateHits'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutIndividualSearchIdHitsByHitIdResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
  /compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/download:
    get:
      tags:
        - AML Screening - Individuals
      description: >
        Retrieves the download URL and metadata for the AML details PDF
        associated with a specific hit  within a business search. <br><br> Use
        this endpoint to obtain the PDF file containing detailed AML information
        for a flagged  result (`hitId`) from a previously performed search
        (`searchId`). The response includes the  download URL, file name,
        expiration timestamp, and identifiers for the search and hit.
      summary: Download AML Details for a Hit
      operationId: compliancegetkycsearchindividualshitsbysearchidandhitiddownload
      parameters:
        - name: searchId
          in: path
          description: >
            The unique identifier of the search that generated the hit. This ID
            links the request  to the specific search performed in the KYC
            Protect system.
          required: true
          schema:
            type: string
            format: uuid
        - name: hitId
          in: path
          description: >
            The unique identifier of the hit associated with the search. This ID
            is used to retrieve  the specific details of a flagged result from
            the search.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/WebApiModelsSearchesSearchResultHitsBusinessSearchHitAttachmentLinkResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/schedules:
    post:
      tags:
        - AML Monitoring Management
      description: >-
        Adds the specified searches to AML monitoring, i.e. schedules them for
        screening. If thresholds and datasets are amended from the original
        search, new results will generated. Any existing hits will be overridden
        and any previous match decisions will be reset. <br><br> **Important** A
        pre-requisite for monitoring work is that any searches MUST be linked to
        a profile before Monitoring can be Active.
      operationId: KYCProtectCreateSchedule
      summary: Add Search To AML Monitoring
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                items:
                  type: array
                  items:
                    $ref: '#/components/schemas/PostKYCProtectSchedulesRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostKYCProtectSchedulesResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
    get:
      tags:
        - AML Monitoring Management
      description: Returns all schedules ordered by modified date.
      summary: Return All Ordered Schedules
      operationId: KYCProtectGetSchedules
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleResponse'
        '400':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    delete:
      tags:
        - AML Monitoring Management
      description: Removes the specified searches from AML monitoring.
      operationId: KYCProtectDeleteSchedules
      summary: Delete Searches From AML Monitoring
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                items:
                  type: array
                  items:
                    type: string
                    format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteKYCProtectSchedulesResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
    put:
      tags:
        - AML Monitoring Management
      description: Updates schedules in AML monitoring.
      operationId: KYCProtectPutSchedules
      summary: Update Schedules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MODEL1e2683'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutKYCProtectSchedulesResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
  /compliance/kyc-protect/schedules/{scheduleId}:
    get:
      tags:
        - AML Monitoring Management
      description: Returns a schedule in AML monitoring.
      summary: Returns A Schedule
      operationId: kycprotectgetschedulesbyscheduleid
      parameters:
        - name: scheduleId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: The id of the schedule
                    format: uuid
                  searchId:
                    type: string
                    description: The id of the search that was being scheduled
                    format: uuid
                  isEmailRequired:
                    type: boolean
                    description: >-
                      Indicates whether the schedule requires an email to be
                      sent when the search is run
                  emailRecipients:
                    type: array
                    items:
                      type: string
                    description: >-
                      The email recipients that the email should be sent to when
                      the search is run
                    nullable: true
                  createdById:
                    type: integer
                    description: The id of the user who created the schedule
                    format: int32
                  createdAt:
                    type: string
                    description: The time the schedule was created
                    format: date-time
                  createdBy:
                    type: string
                    description: The name of the user who created the schedule
                  modifiedById:
                    type: integer
                    description: The id of the user who last modified the schedule
                    format: int32
                  modifiedAt:
                    type: string
                    description: The time the schedule was last modified
                    format: date-time
                  modifiedBy:
                    type: string
                    description: The name of the user who last modified the schedule
                  type:
                    type: string
                    description: The type of the schedule, i.e. business or individual
                  name:
                    type: string
                    description: The name used in the search criteria
                    nullable: true
                  firstName:
                    type: string
                    description: The first name used in the search criteria
                    nullable: true
                  middleName:
                    type: string
                    description: The middle name used in the search criteria
                    nullable: true
                  lastName:
                    type: string
                    description: The last name used in the search criteria
                    nullable: true
                  gender:
                    type: string
                    description: >-
                      The gender used in the search criteria, i.e. male or
                      female
                    nullable: true
                  dateOfBirth:
                    type: string
                    description: The date of birth used in the search criteria
                    format: date
                    nullable: true
                  countries:
                    type: array
                    items:
                      type: string
                    description: The list of country codes used in the search criteria
                    nullable: true
                  threshold:
                    type: integer
                    description: The threshold used in the search criteria
                    format: int32
                  datasets:
                    type: array
                    items:
                      type: string
                    description: The datasets used in the search criteria
                  pepTiers:
                    type: array
                    items:
                      type: string
                    description: >-
                      The pep tiers used in the search criteria, i.e. pepTier1,
                      pepTier2, pepTier3
                    nullable: true
                  isDobRequired:
                    type:
                      - boolean
                      - 'null'
                    description: >-
                      Indicates whether date of birth is required for the
                      individual search.
                    default: true
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    delete:
      tags:
        - AML Monitoring Management
      description: Removes a search from AML monitoring.
      operationId: KYCProtectDeleteSchedulesByScheduleId
      summary: Delete A Search From AML Monitoring
      parameters:
        - name: scheduleId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No Content
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
    put:
      tags:
        - AML Monitoring Management
      description: >-
        Updates a schedule in AML monitoring. <br><br> When there is a change in
        threshold or datasets, the system will deduct one credit for screening.
      operationId: KYCProtectPutSchedulesByScheduleId
      summary: Update A Schedule In Monitoring
      parameters:
        - name: scheduleId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MODEL6bcc20'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: The id of the schedule
                    format: uuid
                  searchId:
                    type: string
                    description: The id of the search that was being scheduled
                    format: uuid
                  isEmailRequired:
                    type: boolean
                    description: >-
                      Indicates whether the schedule requires an email to be
                      sent when the search is run
                  emailRecipients:
                    type:
                      - array
                      - 'null'
                    items:
                      type: string
                    description: >-
                      The email recipients that the email should be sent to when
                      the search is run
                  createdById:
                    type: integer
                    description: The id of the user who created the schedule
                    format: int32
                  createdAt:
                    type: string
                    description: The time the schedule was created
                    format: date-time
                  createdBy:
                    type: string
                    description: The name of the user who created the schedule
                  modifiedById:
                    type: integer
                    description: The id of the user who last modified the schedule
                    format: int32
                  modifiedAt:
                    type: string
                    description: The time the schedule was last modified
                    format: date-time
                  modifiedBy:
                    type: string
                    description: The name of the user who last modified the schedule
                  type:
                    type: string
                    description: The type of the schedule, i.e. business or individual
                  name:
                    type:
                      - string
                      - 'null'
                    description: The name used in the search criteria
                  firstName:
                    type:
                      - string
                      - 'null'
                    description: The first name used in the search criteria
                  middleName:
                    type:
                      - string
                      - 'null'
                    description: The middle name used in the search criteria
                  lastName:
                    type:
                      - string
                      - 'null'
                    description: The last name used in the search criteria
                  gender:
                    type:
                      - string
                      - 'null'
                    description: >-
                      The gender used in the search criteria, i.e. male or
                      female
                  dateOfBirth:
                    type:
                      - string
                      - 'null'
                    description: The date of birth used in the search criteria
                    format: date
                  countries:
                    type:
                      - array
                      - 'null'
                    items:
                      type: string
                    description: The list of country codes used in the search criteria
                  threshold:
                    type: integer
                    description: The threshold used in the search criteria
                    format: int32
                  datasets:
                    type: array
                    items:
                      type: string
                    description: The datasets used in the search criteria
                  pepTiers:
                    type:
                      - array
                      - 'null'
                    items:
                      type: string
                    description: >-
                      The pep tiers used in the search criteria, i.e. pepTier1,
                      pepTier2, pepTier3, byAssociation
                  isDobRequired:
                    type:
                      - boolean
                      - 'null'
                    description: >-
                      Indicates whether date of birth is required for the
                      individual search.
                    default: true
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
  /compliance/kyc-protect/profiles/{profileId}/schedules:
    get:
      tags:
        - AML Screening - Profile Management
      description: Returns all schedules based on profileId ordered by modified date.
      operationId: KYCProtectGetProfileSchedules
      summary: Return All Schedules By ProfileId And Modified Date
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KYCProfileScheduleResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/profiles/{profileId}/schedules/{scheduleId}:
    get:
      tags:
        - AML Screening - Profile Management
      description: Returns a schedule by profileId and scheduleId.
      operationId: KYCProtectGetProfileSchedulesByScheduleId
      summary: Return Schedule By ProfileId And ScheduleId
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
        - name: scheduleId
          in: path
          description: id of the schedule
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalSize:
                    type: integer
                    format: int32
                  items:
                    type: array
                    items:
                      $ref: >-
                        #/components/schemas/KYCProfileIdSchedulesScheduleIdResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
  /compliance/kyc-protect/schedules/amlAlerts:
    get:
      tags:
        - AML Monitoring Management
      description: Get all hits for an AML monitoring schedule ordered by hit created date.
      operationId: KYCProtectGetSchedulesAMLAlerts
      summary: Return All Hits For A Schedule By Created Date
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: hitDecisions
          in: query
          description: >-
            The hit decisions to filter by. It can be the collection of
            undecided, truematch, falsepositive, discarded
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  correlationId:
                    type: string
                    format: guid
                  totalSize:
                    type: integer
                    format: int32
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/KYCProtectScheduleAmlResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
  /compliance/kyc-protect/profiles/{profileId}/amlAlerts:
    get:
      tags:
        - AML Screening - Profile Management
      description: Returns hits of all searches linked to the profile and key parties.
      operationId: KYCProtectGetAmlAlertsByProfileId
      summary: Return All Hits Linked To The Profile
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: hitDecisions
          in: query
          description: >-
            The hit decisions to filter by. It can be the collection of
            undecided, truematch, falsepositive, discarded
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalSize:
                    type: integer
                    format: int32
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/KYCProtectScheduleHitResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
  /compliance/kyc-protect/profiles/{profileId}/hits:
    get:
      tags:
        - AML Screening - Profile Management
      summary: Return All Hits Of Searches Linked To A Profile
      description: Return hits of the searches linked to a profile.
      operationId: getkychitsofthesearcheslinkedtoprofile
      parameters:
        - name: profileId
          in: path
          description: Id of the profile
          required: true
          schema:
            type: string
        - name: hitDecisions
          in: query
          description: >-
            The hit decisions. It can be the collection of undecided, truematch,
            falsepositive, discarded
          required: false
          schema:
            type: array
            items:
              type: string
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProfileHitsByProfileIdResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/asyncAmlJobs:
    get:
      tags:
        - Async AML
      summary: Return All Async AML Jobs
      description: Gets a list of async aml jobs for user.
      operationId: compliancegetkycasyncamljobs
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: statuses
          in: query
          description: >-
            The async job statuses. It can be the collection of created,
            processing, completed
          schema:
            type: array
            items:
              type: string
        - name: targetType
          in: query
          description: The async job's target type. It can be either Profile or KeyParty
          schema:
            type: string
            enum:
              - profile
              - keyParty
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKycProtectAsyncAmlJobResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
  /compliance/kyc-protect/asyncAmlJobs/{jobId}:
    get:
      tags:
        - Async AML
      summary: Return Async AML Jobs By Id
      description: Returns a list of async aml jobs for user.
      operationId: compliancegetkycasyncamljobsjobid
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: jobId
          in: path
          description: id of the async aml job
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKycProtectAsyncAmlJobItemResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
  /compliance/kyc-protect/asyncAmlJobs/{jobId}/criteria:
    get:
      tags:
        - Async AML
      summary: Return Async Job Criteria By Id
      description: Gets a list of job criteria by async job id for user.
      operationId: compliancegetkycasyncamljobsjobidcriteria
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: jobId
          in: path
          description: id of the async aml job
          required: true
          schema:
            type: string
            format: uuid
        - name: statuses
          in: query
          description: >-
            The async job criteria statuses. It can be the collection of
            submitted, processing, completed, failed.
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKycProtectAsyncAmlJobCriteriaResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
  /compliance/kyc-protect/audits:
    get:
      tags:
        - Audit
      summary: Return Audit Trail
      description: Returns a list of audits which can be filtered by various categories.
      operationId: complianceGetKycAudits
      parameters:
        - name: profileIds
          description: Select the profileId's for the filter.
          in: query
          schema:
            type: array
            items:
              type: string
        - name: categories
          description: Available categories for the filter.
          in: query
          schema:
            type: array
            items:
              type: string
              enum:
                - profile
                - amlSearch
        - name: subcategories
          description: Available subcategories for the filter.
          in: query
          schema:
            type: array
            items:
              type: string
              enum:
                - profileDetails
                - keyParty
                - amlMonitoring
        - name: actions
          description: Available actions for the filter.
          in: query
          schema:
            type: array
            items:
              type: string
              enum:
                - created
                - updated
                - deleted
                - searchRemoved
                - searchLinked
                - attachmentCreated
                - attachmentUpdated
                - attachmentDeleted
                - noteCreated
                - noteUpdated
                - noteDeleted
                - noteArchived
                - noteUnarchived
                - addressCreated
                - addressUpdated
                - addressDeleted
                - kycStatusUpdated
                - addedToAmlMonitoring
                - updatedInAmlMonitoring
                - removedFromAmlMonitoring
        - name: userIds
          description: User Ids for the filter.
          in: query
          schema:
            type: array
            items:
              type: integer
        - name: startDate
          in: query
          description: Start date for the filter.
          schema:
            type: string
            format: date
        - name: endDate
          in: query
          description: End date for the filter.
          schema:
            type: string
            format: date
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuditsResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/batchUploads/template:
    get:
      tags:
        - Batch Uploads
      summary: Return Template For Batch Upload
      description: >-
        <h3>This endpoint the HTTP Request is planned to be altered in the next
        release</h3><br> Returns the template to complete a batch upload.
      operationId: complianceGetKycBatchUploadsTemplate
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBatchUploadsTemplateResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '502':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
  /compliance/kyc-protect/batchUploads:
    post:
      tags:
        - Batch Uploads
      summary: Request Batch Upload
      description: >-
        Submits the batch file process request. Returns the details of the
        accepted request.
      operationId: compliancePostKycBatchUploads
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PostKycProtectBatchUploadsRequest'
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetKycProtectBatchUploadsByUploadIdItemResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
        '502':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
    get:
      tags:
        - Batch Uploads
      summary: Return A List Of Requested Uploads
      description: Returns a list of uploads that have been requested.
      operationId: complianceGetKycBatchUploads
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: statuses
          in: query
          description: >-
            The statuses list to filter by. It can be the collection of
            submitted, validating, rejected, validated, insufficientCredits,
            queued, inProgress, processed, completed, partiallyCompleted,
            failed.
          schema:
            type: array
            items:
              type: string
        - name: uploadedById
          in: query
          description: The id of the uploaded user to filter by.
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetKycProtectBatchUploadsByUploadsResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
        '502':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
  /compliance/kyc-protect/batchUploads/{uploadId}:
    get:
      tags:
        - Batch Uploads
      summary: Return Batch Upload File Details
      description: Returns a batch Upload response as specified by the provided id.
      operationId: complianceGetKycBatchUploadByUploadId
      parameters:
        - name: uploadId
          in: path
          description: id of the upload.
          required: true
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetKycProtectBatchUploadsByUploadIdItemResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
        '502':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
  /compliance/kyc-protect/batchUploads/{uploadId}/errors/download:
    get:
      tags:
        - Batch Uploads
      summary: Download Batch Upload Error File
      description: >-
        Returns a link to download the error file if it has does fail during the
        upload this is acquired using the upload Id..
      operationId: complianceGetKycBatchUploadsDownloadErrorsByUploadId
      parameters:
        - name: uploadId
          in: path
          description: id of the upload
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Created
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetBatchUploadsDownloadErrorsByUploadIdResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '502':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
  /compliance/kyc-protect/batchUploads/{uploadId}/retry:
    put:
      tags:
        - Batch Uploads
      summary: Retry Previous Upload
      description: >-
        Re-uploads the file if it was previously failed due to
        'insufficientCredits' status.
      operationId: complianceGetKycBatchUploadsRetryByUploadId
      parameters:
        - name: uploadId
          in: path
          description: id of the upload
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutBatchUploadsRetryByIdResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
        '502':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
  /compliance/kyc-protect/kycMonitoring/profiles/bulk:
    post:
      tags:
        - Global Monitoring
      summary: Add Profiles To Monitoring
      description: Adds a list of profile/s to monitoring.
      operationId: compliancePostKycMonitoringProfilesBulk
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostKYCMonitoringProfilesBulkResquest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostKYCMonitoringProfilesBulkResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
        '502':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
  /compliance/kyc-protect/kycMonitoring/profiles:
    delete:
      tags:
        - Global Monitoring
      summary: Delete Profiles From Monitoring
      description: Removes list of profiles from kyc monitoring
      operationId: complianceDeleteKycMonitoringProfiles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteKYCMonitoringProfilesResquest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteKYCMonitoringProfilesResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
        '502':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
  /compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts:
    get:
      tags:
        - Global Monitoring
      summary: Return List Of Alerts By Profile
      description: Gets a list of kyc alerts by profile.
      operationId: compliancegetkycmonitoringprofilealertsbyprofileid
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: statuses
          in: query
          description: >-
            Statuses of kyc alert to filter. Allowed values are Open,
            ClosedProcessed and ClosedUnprocessed
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/KycMonitoringKycAlertResponse'
                  totalSize:
                    type: integer
                    format: int64
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
  /compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts/{alertId}:
    get:
      tags:
        - Global Monitoring
      summary: Return Alert By Alert Id And ProfileId
      description: Gets a kyc alert associated with a given profile.
      operationId: compliancegetkycmonitoringindividualprofilealertsbyalertid
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
        - name: alertId
          in: path
          description: id of the kyc alert
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycMonitoringKycAlertResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
    put:
      tags:
        - Global Monitoring
      summary: Update Status of Alert By Profile Id And Alert Id
      description: Updates a kyc alert associated with a given profile
      operationId: complianceputkycmonitoringindividualprofilealertsbyalertid
      parameters:
        - name: profileId
          in: path
          description: id of the profile
          required: true
          schema:
            type: string
            format: uuid
        - name: alertId
          in: path
          description: id of the kyc alert
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateKycAlertContract'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycMonitoringKycAlertResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
  /compliance/kyc-protect/profiles/alerts/metrics:
    get:
      tags:
        - AML Screening - Profile Management
      description: Returns a list of KYC and AML alert metrics on profiles.
      summary: Alert Metrics
      operationId: complianceprotectgetkycprofilealertsmetrics
      parameters:
        - $ref: '#/components/parameters/page'
        - $ref: '#/components/parameters/pageSize'
        - name: searchTerm
          in: query
          description: >-
            A search term to search by. The search term will be matched against
            profile names, and internal ids
          required: false
          schema:
            type: string
        - name: sortOrder
          in: query
          description: >-
            The order in which the items should be sorted. Available values:
            asc, desc
          schema:
            type: string
        - name: sortBy
          in: query
          description: >-
            The field by which the items should be sorted. Available values:
            alertLastModifiedDate, addedToMonitoringDate, latestAlertDate
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  totalSize:
                    type: integer
                    format: int32
                  items:
                    type: array
                    items:
                      $ref: >-
                        #/components/schemas/KYCProtectProfileAlertsMetricsResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
  /compliance/kyc-protect/searches/businesses/download:
    post:
      tags:
        - AML Screening - Businesses
      summary: Download A PDF File For A Business AML Screening
      description: >-
        A request requires a name, at least one valid dataset, at least one
        valid countrycode and a threshold. Length of name must not exceed 200
        characters. User will be deducted 1 credit for each search.
      operationId: compliancekycsearchbusinessdownload
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                countryCodes:
                  type: array
                  items:
                    type: string
                  description: List of Two-letter country code ISO-3166-2.
                  nullable: true
                threshold:
                  type: integer
                  description: Must be one of 75, 80, 85, 90, 95, or 100
                  format: int32
                name:
                  type: string
                  description: >-
                    Required if FirstName and LastName are not provided example:
                    Google Inc Max 200 characters allowed.
                  nullable: true
                datasets:
                  type: array
                  items:
                    type: string
                  description: >-
                    Specifies which datasets will be searched <br> `PEP` -
                    Politically Exposed Persons (All)  <br> `PEP-LINKED` - Only
                    linked PEPs (PEP by Association)  <br> `SAN` - Sanctioned
                    (All) SAN-CURRENT - Only current Sanctions SAN-FORMER - Only
                    former Sanctions  <br> `INS` - Insolvency  <br> `AM` -
                    Averse Media POI - Profile of Interest  <br> `ENF` -
                    Enforcement  <br> `SOE` - State Owned Enterprises (All) 
                    <br> `SOE-CURRENT` - Only current  <br> `SOE SOE-FORMER` -
                    Only former SOE  <br>
                  nullable: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  downloadUrl:
                    type: string
                    description: Url of the file to download
                  fileName:
                    type: string
                    description: Name of the file
                  expiresAt:
                    type: string
                    description: Date and time when the url will expire
                    format: date-time
                  searchId:
                    type: string
                    description: Id of the search
                    format: uuid
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
  /compliance/kyc-protect/searches/businesses/{searchId}/download:
    post:
      tags:
        - AML Screening - Businesses
      description: >-
        Returns a business search report for the user's customer based on search
        id retrieves data using the POST method to allow inclusion of request
        payload.
      operationId: compliancegetkycsearchbusinessdownloadbysearchid
      summary: Download PDF Business Search Report
      parameters:
        - name: searchId
          in: path
          required: true
          description: Id of the search
          schema:
            type: string
      requestBody:
        description: >-
          Supply a list of hit Id's from the searchId supplied for the PDF to be
          created.
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
                example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/KYCGetSearchBusinessesDownloadBySearchIdResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/searches/individuals/download:
    post:
      tags:
        - AML Screening - Individuals
      summary: Download A PDF File For An Individual AML Screening
      description: >-
        A request requires a name, or first name and last name, at least one
        valid dataset, at least one valid countrycode and a threshold. Length of
        name or combination of first name, middle name and last name must not
        exceed 200 characters. If user is providing first name, middle name and
        last name combination, the max characters limit includes the formatted
        name in this format lastname, firstname middlename. User will be
        deducted 1 credit for each search.
      operationId: compliancekycsearchindividualdownload
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                countryCodes:
                  type: array
                  items:
                    type: string
                  description: List of Two-letter country code ISO-3166-2.
                  nullable: true
                threshold:
                  type: integer
                  description: Must be one of 75, 80, 85, 90, 95, or 100
                  format: int32
                name:
                  type: string
                  description: >-
                    Required if FirstName and LastName are not provided example:
                    Google Inc Max 200 characters allowed.
                  nullable: true
                firstName:
                  description: If FirstName is provided then LastName must also be provided
                  type: string
                  nullable: true
                middleName:
                  description: >-
                    Middle name is optional, valid along with Firstname and
                    LastName only
                  type: string
                  nullable: true
                lastName:
                  description: If LastName is provided then FirstName must also be provided
                  type: string
                  nullable: true
                dateOfBirth:
                  description: >-
                    Date YYYY-MM-DD or YYYY format. Must be after 1900 and not
                    in the future.
                  format: date
                  type: string
                  nullable: true
                gender:
                  type: string
                  description: Define the gender of the individual you are searching for.
                  nullable: true
                pepTiers:
                  type: array
                  items:
                    type: string
                  description: >-
                    When searching the PEP dataset, define what tiers of the PEP
                    profiles should be included in the results.<br><br> PEP Tier
                    1 - Indicates senior Roles<br> PEP Tier 2 -
                    Middle-Ranking<br> PEP Tier 3 - Junior Officials<br><br> If
                    the PEP Dataset is NOT included on the list of searched
                    datasets, then this value is ignored. The PEP Tier filter
                    does not apply to PEP-LINKED Profiles.
                  nullable: true
                datasets:
                  type: array
                  items:
                    type: string
                  description: >-
                    Specifies which datasets will be searched<br><br> `PEP` -
                    Politically Exposed Persons (All) <br> `PEP-CURRENT` - Only
                    current PEPs <br> `PEP-FORMER` Only former PEPs <br>
                    `PEP-LINKED` - Only linked PEPs (PEP by Association)<br>
                    `SAN` - Sanctioned (All) <br> `SAN-CURRENT` - Only current
                    Sanctions <br> `SAN-FORMER` - Only former Sanctions <br>
                    `INS` - Insolvency <br> `AM` - Averse Media <br> `POI` -
                    Profile of Interest <br> `ENF` - Enforcement <br> `DD` -
                    Disqualified Director <br>
                  nullable: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  downloadUrl:
                    type: string
                    description: Url of the file to download
                  fileName:
                    type: string
                    description: Name of the file
                  expiresAt:
                    type: string
                    description: Date and time when the url will expire
                    format: date-time
                  searchId:
                    type: string
                    description: Id of the search
                    format: uuid
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
  /compliance/kyc-protect/searches/individuals/{searchId}/download:
    post:
      tags:
        - AML Screening - Individuals
      description: >-
        Gets an individual search report for the current logged in user's
        customer based on search id Retrieves data using the POST method to
        allow inclusion of request payload
      operationId: compliancegetkycsearchindividualdownloadbysearchid
      summary: Download PDF Business Search Report
      parameters:
        - name: searchId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        description: >-
          Supply a list of hit Id's from the searchId supplied for the PDF to be
          created.
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
                example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/KYCGetSearchIndividualsDownloadBySearchIdResponse
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceNotFoundRequest
  /compliance/kyc-protect/reports/criteria/{type}:
    get:
      tags:
        - Reporting
      description: >-
        Fetches the available criteria for a specified report type.<br> This
        endpoint is a prerequisite for creating a report and provides the valid
        fields that can populate the `criteria` property in the `POST /reports`
        request.<br><br> Use this to retrieve a list of valid fields for the
        report type before proceeding with report creation.
      summary: Retrieve Report Criteria
      operationId: complianceGetKycCriteriabyType
      parameters:
        - name: type
          in: path
          required: true
          description: >
            The type of report for which criteria are requested.  Supported
            values:<br><br> - `amlAlert`: Criteria for Anti-Money Laundering
            alerts.<br> - `audit`: Criteria for audit-related reports.<br><br>
          schema:
            type: string
            enum:
              - amlAlert
              - audit
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  additionalProperties:
                    description: >
                      Additional fields applicable to the specific report type.
                      These may vary depending on whether the report  type is
                      `amlAlert` or `audit`. Nested arrays and objects are
                      supported for complex criteria.
                    type: object
                  correlationId:
                    type: string
                    description: >-
                      Unique identifier for tracking the request, useful for
                      debugging and tracing.
              example:
                fromDate:
                  isRequired: true
                  type: string
                  format: yyyy-mm-dd
                  description: Cannot be a future date
                  acceptableValues: null
                toDate:
                  isRequired: true
                  type: string
                  format: yyyy-mm-dd
                  description: >-
                    Should fall after fromDate, results will be fetched
                    excluding the provided to date
                  acceptableValues: null
                hitDecisions:
                  isRequired: false
                  type: array[string]
                  format: null
                  description: Decisions made on hits. Multiple values are acceptable
                  acceptableValues:
                    - Undecided
                    - TrueMatch
                    - FalsePositive
                    - Discarded
                hasHits:
                  isRequired: false
                  type: boolean
                  format: null
                  description: Indicates if there are any hits.
                  acceptableValues:
                    - 'true'
                    - 'false'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
        '502':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
  /compliance/kyc-protect/reports:
    post:
      tags:
        - Reporting
      description: >
        Uses the user-provided information to create a compliance report.
        <br><br> The `criteria` property in the request body must be populated
        using the fields returned by  the `GET /criteria/{type}`
        endpoint.<br><br> Ensure you first retrieve the criteria for the desired
        report type using the `GET /criteria/{type}`  endpoint before making
        this request.
      summary: Create AML / Audit Report
      operationId: compliancepostkycreports
      requestBody:
        description: >-
          Request body containing the report type, file name, and criteria
          details for creating a compliance report.<br> The `criteria` field
          must adhere to the schema provided by the `GET /criteria/{type}`
          endpoint.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostKycProtectReportsRequest'
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostKycProtectReportResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
        '502':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
    get:
      tags:
        - KYC Reporting
      description: >
        Retrieves a list of compliance reports previously created, including
        their current status.<br><br> Each report includes details such as the
        report type, creation date, status, and the criteria used to generate
        it.  The `criteria` field reflects the filters and parameters applied
        during report creation, which depend on the report type  (e.g.,
        `amlAlert` or `audit`).<br><br> Use this endpoint to monitor the status
        of your reports, view historical reports, and manage expiration
        timelines.  For generating new reports, refer to the `POST
        /compliance/kyc-protect/reports` endpoint.
      summary: Returns Report By Type
      operationId: compliancegetkycreports
      parameters:
        - name: page
          in: query
          required: true
          description: Starting page number.
          schema:
            type: integer
        - name: pageSize
          in: query
          required: true
          description: >-
            Specifies the number of items to be displayed per page. Allowed
            values are between 1 and 100.
          schema:
            type: integer
            format: int32
        - name: reportType
          in: query
          required: true
          description: >-
            Acceptable value is either AmlAlert or Audit. Available values :
            amlAlert, audit, profile
          schema:
            type: string
        - name: searchTerm
          in: query
          description: Filters the monitor reports by search_term.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKycProtectReportsResponse'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
        '502':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
  /compliance/kyc-protect/reports/{reportId}:
    get:
      tags:
        - Reporting
      summary: Retrieve a Single Report by ID
      description: >
        Fetches the details of a single compliance report identified by its
        unique `reportId`. <br><br> This endpoint allows users to retrieve the
        full metadata and status of a specific report,  including its creation
        details, criteria, and expiration timeline. <br><br> Use this endpoint
        to inspect or verify the information of an existing report,  or to
        confirm its current status (e.g., `inProgress`, `completed`, `failed`).
        <br><br> Ensure that the `reportId` provided corresponds to an existing
        report in the system.
      operationId: complianceGetKycReportsByReportId
      parameters:
        - name: reportId
          in: path
          required: true
          description: >
            The unique identifier of the report to be retrieved. Must be a valid
            UUID that corresponds  to an existing report in the system.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKycProtectReportsResponseByReportId'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
        '502':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
  /compliance/kyc-protect/reports/{reportId}/download:
    get:
      tags:
        - Reporting
      summary: Download a Report by ID
      description: >
        Retrieves the download information for a specific compliance report
        identified by its unique `reportId`. <br><br> This endpoint provides the
        URL to download the report file, along with metadata such as the file
        name and  the expiration time for the download link. <br><br> Use this
        endpoint after generating a report to access the final output. Ensure
        the `reportId` corresponds to  a valid and completed report in the
        system.
      operationId: complianceGetDownloadKycReportsByReportId
      parameters:
        - name: reportId
          in: path
          required: true
          description: >
            The unique identifier of the report to be downloaded. Must be a
            valid UUID that corresponds  to an existing and completed report in
            the system.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: >
            Success. Returns the download URL, file name, and expiration
            timestamp for the specified report.
          content:
            application/json:
              schema:
                type: object
                properties:
                  downloadUrl:
                    type: string
                    description: >
                      The direct URL to download the report file. This URL is
                      valid only until the expiration time  specified in the
                      `expiresAt` field.
                  fileName:
                    type: string
                    description: |
                      The name of the report file as specified during creation.
                  expiresAt:
                    type: string
                    format: date-time
                    description: >
                      The date and time when the download URL will expire. After
                      this time, the URL will no longer  be valid, and the
                      report must be regenerated if needed.
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesInvalidToken'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesAccessForbidden'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConnectErrorResponsesResourceConflictResponse
        '502':
          description: Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectErrorResponsesBadRequest'
components:
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        This API requires authentication for access to protected endpoints.
        Authentication is performed by providing a valid JWT token in the
        `Authorization` header of each request.
  schemas:
    ConnectAuthenticationAuthRequest:
      type: object
      properties:
        username:
          type: string
          description: Credentials assigned upon sign up
          example: username@domain.com
        password:
          type: string
          example: ^1gHySRA56aj>tf421o
    ConnectAuthenticationAuthResponse:
      type: object
      properties:
        token:
          type: string
          description: Authentication Token
          example: >-
            eyJhbGciOiJSUzI1NiIsImtpZCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyIsInR5cCI6IkpXVCIsIng1dCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyJ9.eyJuYmYiOjE1OTU0MTYyMDksImV4cCI6MTU5NTQxOTgwOSwiaXNzIjoiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20iLCJhdWQiOlsiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20vcmVzb3VyY2VzIiwiY29ubmVjdF9hcGkiLCJ1Ym9fYXBpX2dhdGV3YXkiXSwiY2xpZW50X2lkIjoiY29ubmVjdC5hcGkuY2xpZW50Iiwic3ViIjoiMTAxNTIwMjg1IiwiYXV0aF90aW1lIjoxNTk1NDE2MjA5LCJpZHAiOiJsb2NhbCIsInVzZXJuYW1lIjoiQ29ubmVjdHUxIiwiZW1haWwiOiJDb25uZWN0MUBnbWFpbC5jb20iLCJjdXN0b21lcklkIjoiMTAxNzY0NDA1IiwiY291bnRyeSI6IkMwIiwidXNlclJvbGUiOiJDcm1BZG1pblBsdXMiLCJzYl9jb3VudHJ5IjoiVVMiLCJzY29wZSI6WyJjb25uZWN0X2FwaSIsInVib19hcGlfZ2F0ZXdheSJdLCJhbXIiOlsicHdkIl19.p8kPAlKNB9iWEKiQbfbRXBoLQuBG7NuEDN__A8AQ55CL-gcIwkS1717Af1f9W0uifwIQ6HAZQR_x191LVkvuWD94Zw8zLzzr1ioUIhQny_zYuAS3G6EFNaTHh_mvOQ9XVi1FyuIy6YYcYcNLNZurFuITF2w5LuX4YQBjQy3rhEAdRoKcUKbtCClMFaH2dV35jiX2d7BqyhtJ8GeZyJ6yfMfdzznqxlJ4Osf5aasKUy8RYKEpjU2pkCURojoy5_oviGs8X4U9mJWcuajmPF3i5DHkqbhq1Mp0UZrDyoq_0BDStV5xqRgq6aOY8mc45kX7cwY3O2hPeGE7Ak8YtKFbA
    ConnectErrorResponsesInvalidToken:
      type: object
      properties:
        error:
          type: string
      description: >-
        401 - Authorization Token has either expired or is not a valid Connect
        Token
    PostKYCProfileImportBusinessesRequest:
      type: object
      additionalProperties: false
      properties:
        profileName:
          type: string
          description: Name of the profile.
        companyId:
          type: string
          description: >-
            The primary Company identifier that is used to uniquely identify all
            companies across Creditsafes Universe and Partner Network.
        internalId:
          type: string
          nullable: true
          description: Internal Id of the profile
      required:
        - profileName
        - companyId
    CreditsafeGlobalDataReportsReportSection:
      enum:
        - CompanySummary
        - CompanySummaryExtra
        - AlternateSummary
        - CompanyIdentification
        - CompanyIdentificationExtra
        - CreditScore
        - CreditScoreExtra
        - ContactInformation
        - ContactInformationExtra
        - ShareCapitalStructure
        - ShareCapitalStructureExtra
        - Directors
        - DirectorsExtra
        - Directorships
        - DirectorshipsExtra
        - OtherInformation
        - OtherInformationExtra
        - GroupStructure
        - GroupStructureExtra
        - ExtendedGroupStructure
        - ExtendedGroupStructureExtra
        - GlobalFinancialStatements
        - GlobalFinancialStatementsExtra
        - LocalFinancialStatements
        - LocalFinancialStatementsExtra
        - PaymentData
        - PaymentDataExtra
        - NegativeInformation
        - NegativeInformationExtra
        - AdditionalInformation
        - AdditionalInformationExtra
        - UPPData
        - Unused
      type: string
    CreditsafeGlobalDataLanguage:
      enum:
        - OM
        - AB
        - AA
        - AF
        - SQ
        - AM
        - AR
        - HY
        - AS
        - AY
        - AZ
        - BA
        - EU
        - BN
        - DZ
        - BH
        - BI
        - BR
        - BG
        - MY
        - BE
        - KM
        - CA
        - ZH
        - CO
        - HR
        - CS
        - DA
        - NL
        - EN
        - EO
        - ET
        - FO
        - FJ
        - FI
        - FR
        - FY
        - GL
        - KA
        - DE
        - EL
        - KL
        - GN
        - GU
        - HA
        - HE
        - HI
        - HU
        - IS
        - ID
        - IA
        - IE
        - IK
        - IU
        - GA
        - IT
        - JA
        - JW
        - KN
        - KS
        - KK
        - RW
        - KY
        - RN
        - KO
        - KU
        - LO
        - LA
        - LV
        - LN
        - LT
        - MK
        - MG
        - MS
        - ML
        - MT
        - MI
        - MR
        - MO
        - MN
        - NA
        - NE
        - 'NO'
        - OC
        - OR
        - PS
        - FA
        - PL
        - PT
        - PA
        - QU
        - RM
        - RO
        - RU
        - SM
        - SG
        - SA
        - GD
        - SR
        - SH
        - ST
        - TN
        - SN
        - SD
        - SI
        - SS
        - SK
        - SL
        - SO
        - ES
        - SU
        - SW
        - SV
        - TL
        - TG
        - TA
        - TT
        - TE
        - TH
        - BO
        - TI
        - TO
        - TS
        - TR
        - TK
        - TW
        - UG
        - UK
        - UR
        - UZ
        - VI
        - VO
        - CY
        - WO
        - XH
        - YI
        - YO
        - ZA
        - ZU
      type: string
    CreditsafeGlobalDataCountryCode:
      description: Country where the company is registered.
      enum:
        - AF
        - AX
        - AL
        - DZ
        - AS
        - AD
        - AO
        - AI
        - AQ
        - AG
        - AR
        - AM
        - AW
        - AU
        - AT
        - AZ
        - BS
        - BH
        - BD
        - BB
        - BY
        - BE
        - BZ
        - BJ
        - BM
        - BT
        - BO
        - BA
        - BW
        - BV
        - BR
        - IO
        - BN
        - BG
        - BF
        - BI
        - KH
        - CM
        - CA
        - CV
        - KY
        - CF
        - TD
        - CL
        - CN
        - CX
        - CC
        - CO
        - KM
        - CG
        - CD
        - CK
        - CR
        - CI
        - HR
        - CU
        - CY
        - CZ
        - DK
        - DJ
        - DM
        - DO
        - EC
        - EG
        - SV
        - GQ
        - ER
        - EE
        - ET
        - FK
        - FO
        - FJ
        - FI
        - FR
        - GF
        - PF
        - TF
        - GA
        - GM
        - GE
        - DE
        - GH
        - GI
        - GR
        - GL
        - GD
        - GP
        - GU
        - GT
        - GG
        - GN
        - GW
        - GY
        - HT
        - HM
        - HN
        - HK
        - HU
        - IS
        - IN
        - ID
        - IR
        - IQ
        - IE
        - IM
        - IT
        - JM
        - JP
        - JE
        - JO
        - KZ
        - KE
        - KI
        - KP
        - KR
        - KW
        - KG
        - LA
        - LV
        - LB
        - LS
        - LR
        - LY
        - LI
        - LT
        - LU
        - MO
        - MK
        - MG
        - MW
        - MY
        - MV
        - ML
        - MT
        - MH
        - MQ
        - MR
        - MU
        - YT
        - MX
        - FM
        - MD
        - ME
        - MS
        - MA
        - MZ
        - MM
        - NA
        - NR
        - NP
        - NL
        - AN
        - NC
        - NZ
        - NI
        - NE
        - NG
        - NU
        - NF
        - MP
        - 'NO'
        - OM
        - PK
        - PW
        - PS
        - PA
        - PG
        - PY
        - PE
        - PH
        - PN
        - PL
        - PT
        - PR
        - QA
        - RE
        - RO
        - RU
        - RW
        - BL
        - SH
        - KN
        - LC
        - MF
        - PM
        - VC
        - WS
        - ST
        - SA
        - SN
        - RS
        - SC
        - SL
        - SG
        - SK
        - SI
        - SB
        - SO
        - ZA
        - GS
        - ES
        - LK
        - SD
        - SR
        - SJ
        - SZ
        - SE
        - CH
        - SY
        - TW
        - TJ
        - TZ
        - TH
        - TL
        - TG
        - TK
        - TO
        - TT
        - TN
        - TR
        - TM
        - TC
        - TV
        - UG
        - UA
        - AE
        - GB
        - US
        - UM
        - UY
        - UZ
        - VU
        - VA
        - VE
        - VN
        - VG
        - VI
        - WF
        - EH
        - YE
        - ZM
        - ZW
        - XK
        - SS
        - SX
        - CW
        - BQ
        - WW
        - PLC
      type: string
    CreditsafeGlobalDataCompanyActivityClassification:
      type: object
      description: >-
        Main activity classification being used for the company’s main activity,
        including the code, industry sector, and description.
      properties:
        code:
          type: string
          description: Main activity code used in that country e.g. SIC / NACE.
        industrySector:
          type: string
          description: >-
            (Optionally populated) A high-level description, describing the
            industry sector/division in which the company operates.
        description:
          type: string
          description: Description of main activity.
        classification:
          type: string
          description: >-
            The type of activity classification being used for the main
            activity. E.g SIC07, NACE Rev2 etc. Where possible includes the
            version/revision date.
    CreditsafeGlobalDataCompanyStatus:
      description: >-
        High-level status. Values include "Active", "NonActive", "Pending" and
        "Other". Note - “Pending” indicates that the entity has entered into a
        legal process such as insolvency or liquidation, and “Other” indicates
        an unknown status.
      enum:
        - Active
        - NonActive
        - Pending
        - Other
      type: string
    CreditsafeGlobalDataReportsCompanyStatusDescription:
      type: object
      description: >-
        High-level status of the company, such as 'Active', 'NonActive',
        'Pending', or 'Other'.
      properties:
        status:
          $ref: '#/components/schemas/CreditsafeGlobalDataCompanyStatus'
        providerStatus:
          type: string
          description: >-
            (Optionally populated) high-level local status. E.g. may contain a
            registry status, such as "Active" for a "Non-Trading" company,
            whereas the common "status" will say “NonActive".
        providerCode:
          type: string
          description: >-
            (Optionally populated) if available, this code pairs with the
            companyStatus.description
        isActive:
          type: boolean
          description: >-
            Boolean [true/false] when set to true indicates that the company is
            economically active.
        description:
          type: string
          description: A more in-depth status value, based on local descriptions.
    CreditsafeGlobalDataCurrency:
      description: >-
        The Currency in which the financial value is displayed, as a
        three-character ISO code.
      enum:
        - AFA
        - ALL
        - DZD
        - ADF
        - ADP
        - AOA
        - ARA
        - ARS
        - AMD
        - AWG
        - AUD
        - AZM
        - BSD
        - BHD
        - BDT
        - BBD
        - BYR
        - BZD
        - BMD
        - BTN
        - BOB
        - BAM
        - BWP
        - BRC
        - BRL
        - GBP
        - BND
        - BGN
        - BIF
        - XOF
        - XAF
        - KHR
        - CAD
        - CVE
        - KYD
        - CLP
        - CNY
        - COP
        - KMF
        - CDF
        - CRC
        - HRK
        - CUP
        - CZK
        - DKK
        - DJF
        - DOP
        - NLG
        - EUR
        - ECS
        - EGP
        - SVC
        - EEK
        - ETB
        - FKP
        - FJD
        - FRF
        - GMD
        - GEL
        - GHC
        - GIP
        - XAU
        - GTQ
        - GNF
        - GWP
        - GYD
        - HTG
        - HNL
        - HKD
        - HUF
        - ISK
        - INR
        - IDR
        - IRR
        - IQD
        - ILS
        - JMD
        - JPY
        - JOD
        - KZT
        - KES
        - KRW
        - KWD
        - KGS
        - LAK
        - LVL
        - LBP
        - LSL
        - LRD
        - LYD
        - LTL
        - MOP
        - MKD
        - MGF
        - MWK
        - MYR
        - MVR
        - MTL
        - MRO
        - MUR
        - MXN
        - MDL
        - MNT
        - MAD
        - MZM
        - MMK
        - ANG
        - NAD
        - NPR
        - NZD
        - NIO
        - NGN
        - KPW
        - NOK
        - OMR
        - PKR
        - XPD
        - PAB
        - PGK
        - PYG
        - PEN
        - PHP
        - XPT
        - PLN
        - QAR
        - RON
        - RUB
        - RWF
        - WST
        - STD
        - SAR
        - RSD
        - SCR
        - SLL
        - XAG
        - SGD
        - SKK
        - SIT
        - SBD
        - SOS
        - ZAR
        - LKR
        - SHP
        - SDD
        - SDG
        - SDP
        - SRD
        - SRG
        - SZL
        - SEK
        - CHF
        - SYP
        - TWD
        - TJS
        - TZS
        - THB
        - TOP
        - TTD
        - TND
        - TRY
        - TMM
        - USD
        - UGX
        - UAG
        - UAK
        - AED
        - UYU
        - UZS
        - VUV
        - VEF
        - VND
        - YUN
        - ZMK
        - ZWD
        - AFN
        - ATS
        - AZN
        - BYN
        - BEF
        - BOV
        - GRD
        - FIM
        - DEM
        - GHS
        - IEP
        - ITL
        - LUF
        - PTE
        - ESP
        - XDR
        - TMT
        - UAH
        - ERN
        - MGA
        - MRU
        - MZN
        - SSP
        - STN
        - YER
        - XPF
        - XCD
        - ZMW
        - ZWL
      type: string
    CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal:
      type: object
      properties:
        currency:
          $ref: '#/components/schemas/CreditsafeGlobalDataCurrency'
        value:
          type: number
          format: double
          description: >-
            The maximum amount of share capital the company is authorised by its
            constitutional documents to issue to shareholders.
    CreditsafeGlobalDataReportsCommonRatingValue:
      description: Standardised credit score – will be A, B, C, D or E.
      enum:
        - A
        - B
        - C
        - D
        - E
      type: string
    CreditsafeGlobalDataReportsFinancialValue_1_SystemString:
      type: object
      properties:
        currency:
          $ref: '#/components/schemas/CreditsafeGlobalDataCurrency'
        value:
          type: string
          description: Amount of credit advisable at any one time.
    CreditsafeGlobalDataReportsRangeDescribedValue_1_SystemString:
      type: object
      properties:
        maxValue:
          type: string
          description: The maximum value of the score that is provided for the Country.
        minValue:
          type: string
          description: The minimum value of the score that is provided for the Country.
        value:
          type: string
          description: >-
            Local credit score, as used by the supplier in that particular
            country
    CreditsafeGlobalDataReportsCreditRating:
      type: object
      properties:
        commonValue:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsCommonRatingValue'
        commonDescription:
          type: string
          description: A text description of the common credit score.
        creditLimit:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemString
        providerValue:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsRangeDescribedValue_1_SystemString
        providerDescription:
          type: string
          description: Local credit score description.
        pod:
          type: number
          format: double
          nullable: true
          description: >-
            Probability of Default (POD) is the anticipated likelihood of
            company default within the next 12 months in a percentage format.
        assessment:
          type: string
          description: An additional score assessment commentary.
    CreditsafeGlobalDataReportsLtdCompanySummary:
      type: object
      properties:
        businessName:
          type: string
          description: Registered company name/trading name of the business.
        country:
          $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
        companyNumber:
          type: string
          description: Creditsafe global identifier, called the Safe Number.
        companyRegistrationNumber:
          type: string
          description: Official registration number.
        ggsID:
          type: string
          description: The Connect API ID as used in v1.3 (GGS).
        leiNumber:
          type: string
          description: >-
            Global Legal Entity Identifier (LEI), often used in financial
            transactions identifier of an organisation
        mainActivity:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataCompanyActivityClassification
        companyStatus:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCompanyStatusDescription
        latestTurnoverFigure:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal
        latestShareholdersEquityFigure:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal
        creditRating:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsCreditRating'
    CreditsafeGlobalDataReportsLegalForm:
      type: object
      properties:
        commonCode:
          type: string
          description: >-
            A common global code that aims to categorise legal forms across
            Countries. Currently only available for Non Ltd reports as “Sole
            Trader” or “Other”.
        providerCode:
          type: string
          description: The local provider legal form codes specific to each Country
        description:
          type: string
          description: The legal type of the company e.g. S.A., GmbH, Ltd, N.V. etc.
    CreditsafeGlobalDataAddressData:
      type: object
      properties:
        type:
          type: string
          description: >-
            Address type description. Examples - "Registered Office", "Trading
            Address", "Postal Address", "Service Address" etc.
        simpleValue:
          type: string
          description: >-
            (Optionally populated) Registered address of the company. Whole
            string address if Creditsafe is unable to accurately assign values
            to specific address fields, or when specific local address formats
            need to be observed.
        street:
          type: string
          description: >-
            Street portion of the address line. Can also, optionally contain,
            the house number alongside the street.
        houseNumber:
          type: string
          description: House number portion of the address line.
        additionToAddress:
          type: string
          description: >-
            Additional details for a specified address, such as a PO Box number,
            or a unit number at the specified address location.
        city:
          type: string
          description: City portion of the address line.
        postalCode:
          type: string
          description: Postal code portion of the address line.
        province:
          type: string
          description: Province portion of the address line.
        region:
          type: string
          description: >-
            May contain the geographical region, for example "South-East" or a
            territorial division.
        telephone:
          type: string
          description: Registered telephone number.
        directMarketingOptOut:
          type: boolean
          nullable: true
          description: >-
            Boolean [true/false]. Where set to true, the subject has "opted out"
            via a central register, and they must not be contacted for
            commercial marketing purposes.
        directMarketingOptIn:
          type: boolean
          nullable: true
        country:
          $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
    CreditsafeGlobalDataReportsLtdCompanyBasicInformation:
      type: object
      properties:
        businessName:
          type: string
          nullable: true
          description: The trading name of business, or “-“ if unknown
        registeredCompanyName:
          type: string
          description: >-
            Registered company name, the legal name of the company. For NonLtd
            companies this would include the Owner name (i.e. the legal name),
            or “-“ if unknown.
        companyRegistrationNumber:
          type: string
          description: Official registration number.
        ggsId:
          type: string
          description: The Connect API ID as used in v1.3 (GGS).
        leiNumber:
          type: string
          description: >-
            Global Legal Entity Identifier (LEI), often used in financial
            transactions identifier of an organisation.
        country:
          $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
        vatRegistrationNumber:
          type: string
          description: Local VAT Number.
        vatRegistrationDate:
          description: Registration date of the local VAT number.
          type: string
          format: date-time
          nullable: true
        companyRegistrationDate:
          description: The date the company was registered.
          type: string
          format: date-time
          nullable: true
        operationsStartDate:
          description: The date the company began trading.
          type: string
          format: date-time
          nullable: true
        commercialCourt:
          description: The local commercial court at which the company was registered.
          type: string
        legalForm:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsLegalForm'
        officeType:
          description: Describes the office establishment type
          enum:
            - Registered
            - Trading
            - HeadOffice
            - Branch
            - Subsidiary
            - Franchise
            - Franchisor
            - SingleOffice
        ownershipType:
          description: Whether the company is wholly, part owned etc.
          type: string
        companyStatus:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCompanyStatusDescription
        principalActivity:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataCompanyActivityClassification
        contactAddress:
          $ref: '#/components/schemas/CreditsafeGlobalDataAddressData'
    CreditsafeGlobalDataReportsCompanyActivity:
      type: object
      properties:
        code:
          type: string
          description: Industry code used in that country e.g. SIC / NACE
        description:
          type: string
          description: Description of company’s main activity.
    CreditsafeGlobalDataReportsCompanyActivityList:
      type: object
      properties:
        classification:
          type: string
          description: >-
            The type of activity classification being used in the activities
            array. E.g. SIC07, NACE etc. Where possible includes the
            version/revision date.
        activities:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsCompanyActivity'
    CreditsafeGlobalDataReportsPreviousValue:
      type: object
      properties:
        dateChanged:
          description: Date when this name was officially changed (i.e. end date).
          type: string
          format: date-time
          nullable: true
    CreditsafeGlobalDataReportsPreviousName:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsPreviousValue'
        - type: object
          properties:
            name:
              type: string
              description: Any previous name under which the company was registered.
    CreditsafeGlobalDataReportsPreviousLegalForm:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsPreviousValue'
        - type: object
          properties:
            legalForm:
              $ref: '#/components/schemas/CreditsafeGlobalDataReportsLegalForm'
    CreditsafeGlobalDataReportsLtdCompanyIdentification:
      type: object
      properties:
        basicInformation:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsLtdCompanyBasicInformation
        activityClassifications:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsCompanyActivityList
        previousNames:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsPreviousName'
        previousLegalForms:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsPreviousLegalForm'
    CreditsafeGlobalDataReportsLtdCreditScore:
      type: object
      properties:
        currentCreditRating:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsCreditRating'
        currentContractLimit:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal
        previousCreditRating:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsCreditRating'
        latestRatingChangeDate:
          description: Last date that the credit score changed.
          type: string
          format: date-time
          nullable: true
    CreditsafeGlobalDataAddressDataReport:
      type: object
      properties:
        type:
          type: string
          description: >-
            Address type description. Examples - "Registered Office", "Trading
            Address", "Postal Address", "Service Address" etc.
        simpleValue:
          type: string
          description: >-
            (Optionally populated) Registered address of the company. Whole
            string address if Creditsafe is unable to accurately assign values
            to specific address fields, or when specific local address formats
            need to be observed.
        street:
          type: string
          description: >-
            Street portion of the address line. Can also, optionally contain,
            the house number alongside the street.
        houseNumber:
          type: string
          description: House number portion of the address line.
        additionToAddress:
          type: string
          description: >-
            Additional details for a specified address, such as a PO Box number,
            or a unit number at the specified address location.
        city:
          type: string
          description: City portion of the address line.
        postalCode:
          type: string
          description: Postal code portion of the address line
        province:
          type: string
          description: Province portion of the address line.
        region:
          type: string
          description: >-
            May contain the geographical region, for example "South-East" or a
            territorial division.
        telephone:
          type: string
          description: Telephone number of the main address.
        directMarketingOptOut:
          type: boolean
          nullable: true
          description: >-
            Boolean [true/false]. Where set to true, the subject has "opted out"
            via a central register, and they must not be contacted for
            commercial marketing purposes.
        directMarketingOptIn:
          type: boolean
          nullable: true
        country:
          $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
    CreditsafeGlobalDataReportsLtdContactInformation:
      type: object
      properties:
        mainAddress:
          $ref: '#/components/schemas/CreditsafeGlobalDataAddressDataReport'
        otherAddresses:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataAddressDataReport'
        previousAddresses:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataAddressDataReport'
        emailAddresses:
          type: array
          description: Email address for the company.
          items:
            type: string
        websites:
          type: array
          description: Website address of the company.
          items:
            type: string
    CreditsafeGlobalDataReportsIndicatorIndustryComparison:
      type: object
      properties:
        sectorCode:
          type: string
        sectorAverage:
          type: string
          description: >-
            The average indicator value for the industry sector in which the
            subject company operates.
        sectorCount:
          type: integer
          format: int32
          description: The count of all companies in this industry sector.
          nullable: true
        totalAverage:
          type: string
          description: >-
            The average indicator value for all companies (irrespective of
            industry sector).
        totalCount:
          type: integer
          format: int32
          description: The count of all companies (irrespective of industry sector).
          nullable: true
    CreditsafeGlobalDataReportsIndicators:
      type: array
      description: >-
        Indicators provides additional information when assessing a company's
        performance. This is a premium service, not available for all customers.
      items:
        type: object
        properties:
          type:
            type: string
            description: >-
              A lowercase char(3) code indicating the type of indicator. For
              example - Financial Strength Indicator (“fsi”), Payment Behaviour
              Indicator (“pbi”), Payment Expectation Indicator (“pei”).
            enum:
              - eti
              - pei
              - fsi
              - pbi
          value:
            type: string
            description: The value of the indicator.
            example: X
          changeDate:
            type: string
            format: date-time
            description: The date associated with the current indicator.
          industryComparison:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsIndicatorIndustryComparison
    CreditsafeGlobalDataReportsIdType:
      description: >-
        Description for the ID, to describe the type of ID presented e.g. Person
        number, Tax ID (if a company), Company Registration Number etc.
      enum:
        - Other
        - SafeNumber
        - RegistrationNumber
        - VATNumber
        - TaxID
        - PersonNumber
        - ExternalID
        - InternalID
      type: string
    CreditsafeGlobalDataReportsEntityFullName:
      type: object
      properties:
        id:
          type: string
          description: Unique ID.
        idType:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsIdType'
        name:
          type: string
          description: >-
            Name of the Shareholder, or Company Name if a corporate shareholder
            exists.
        title:
          type: string
          description: Title, if known.
        firstNames:
          type: string
          description: >-
            First name(s) of the shareholder. May optionally include middle
            names, or initials if these cannot be distinguished.
        firstName:
          type: string
          description: >-
            First name of the shareholder. This field should be used if a
            middleName also exists.
        middleName:
          type: string
          description: Middle name of the shareholder.
        surname:
          type: string
          description: Last name of the shareholder.
        address:
          $ref: '#/components/schemas/CreditsafeGlobalDataAddressData'
    CreditsafeGlobalDataReportsEntityType:
      description: >-
        Indicates if the shareholders record relates to a "Person", "Company" or
        "Other".
      enum:
        - Other
        - Person
        - Company
      type: string
    CreditsafeGlobalDataReportsAdditionalData:
      type: object
      description: A free-flowing section, containing country specific elements.
    CreditsafeGlobalDataReportsShareClassAdditionalData:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsAdditionalData'
        - type: object
    CreditsafeGlobalDataReportsShareClass:
      type: object
      properties:
        shareType:
          description: (Optionally populated) The share class description.
          type: string
        currency:
          $ref: '#/components/schemas/CreditsafeGlobalDataCurrency'
        valuePerShare:
          type: number
          format: double
          nullable: true
          description: >-
            (Optionally populated) The value per share, also known as the par
            value. Expressed as an integer, or to two decimal places.
        jointlyOwned:
          type: boolean
          nullable: true
          description: >-
            (Optionally populated) Boolean. Set to true where the shares are
            jointly owned.
        numberOfSharesOwned:
          type: integer
          format: int64
          nullable: true
          description: >-
            (Optionally populated) The number of shares owned. If more than one
            share class exists, this is the number per share class.
        valueOfSharesOwned:
          type: number
          format: double
          nullable: true
          description: >-
            (Optionally populated) The total nominal value of Shares owned. If
            more than one share class exists, this is the total nominal value
            per share class.
        additionalData:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsShareClassAdditionalData
    CreditsafeGlobalDataReportsShareHolder:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsEntityFullName'
        - type: object
          properties:
            shareholderType:
              $ref: '#/components/schemas/CreditsafeGlobalDataReportsEntityType'
            shareType:
              type: string
              description: The share class, for example "Ordinary".
            currency:
              $ref: '#/components/schemas/CreditsafeGlobalDataCurrency'
            totalValueOfSharesOwned:
              type: number
              format: double
              nullable: true
              description: >-
                The total nominal value of all shares owned. Expressed as an
                integer, or to two decimal places.
            totalNumberOfSharesOwned:
              type: integer
              format: int64
              nullable: true
              description: The total number of all shares owned.
            percentSharesHeld:
              type: number
              format: double
              nullable: true
              description: >-
                The total percentage of all shares held. Expressed as an
                integer, or to two decimal places.
            startDate:
              type: string
              format: date-time
              nullable: true
              description: Date when the shareholding started.
            endDate:
              type: string
              format: date-time
              nullable: true
              description: >-
                Date when the shareholding ended. Where populated, this
                indicates that the party has ceased to be a shareholder.
            hasNegativeInfo:
              type: boolean
              nullable: true
              description: >-
                Boolean [true/false] when set to true, this indicates that the
                shareholder has negative information such as Protesti, Court
                Judgements etc. linked to their unique shareholders ID.
            shareClasses:
              type: array
              items:
                $ref: '#/components/schemas/CreditsafeGlobalDataReportsShareClass'
    CreditsafeGlobalDataReportsLtdShareCapitalStructure:
      type: object
      properties:
        nominalShareCapital:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal
        issuedShareCapital:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsFinancialValue_1_SystemDecimal
        shareCapitalCurrency:
          type: string
          description: >-
            The Currency in which the share values are displayed, as a
            three-character ISO code.
        numberOfSharesIssued:
          type: integer
          format: int64
          nullable: true
          description: The total number of issued shares.
        shareHolders:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsShareHolder'
    CreditsafeGlobalDataReportsGender:
      enum:
        - Unknown
        - Male
        - Female
        - NotApplicable
      type: string
    CreditsafeGlobalDataReportsCorporatePositionAdditionalData:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsAdditionalData'
        - type: object
    CreditsafeGlobalDataReportsCorporatePosition:
      type: object
      properties:
        dateAppointed:
          type: string
          format: date-time
          nullable: true
          description: The date the director was appointed.
        commonCode:
          type: string
          description: >-
            A common global code that aims to categorise director positions
            across Countries – currently no data available.
        providerCode:
          type: string
          description: >-
            The local provider director code (if exists) specific to each
            Country.
        positionName:
          type: string
          description: The director’s role/position in a company.
        authority:
          type: string
          description: >-
            If available, any available details pertaining to the score, power,
            limitations, signing authority or ability to bind the company.
        apptDurationType:
          type: string
          description: >-
            The appointment duration should be used in conjunction with the
            appointment term field.
        additionalData:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCorporatePositionAdditionalData
    CreditsafeGlobalDataReportsDirectorAdditionalData:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsAdditionalData'
        - type: object
    CreditsafeGlobalDataReportsDirector:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsEntityFullName'
        - type: object
          properties:
            gender:
              $ref: '#/components/schemas/CreditsafeGlobalDataReportsGender'
            birthName:
              type: string
              description: The birth name or previous legal name of the officer.
            dateOfBirth:
              type: string
              format: date-time
              nullable: true
              description: The director’s date of birth.
            placeOfBirth:
              type: string
              description: The director’s place or region of birth.
            nationality:
              type: string
              description: The director’s nationality or country of birth.
            countryOfResidence:
              type: string
              description: The country of residence, if known.
            country:
              $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
            directorType:
              $ref: '#/components/schemas/CreditsafeGlobalDataReportsEntityType'
            hasNegativeInfo:
              type: boolean
              nullable: true
              description: >-
                Linked with DE searches, may return with other countries if data
                is available. Boolean [true/false] if the director has negative
                information, such as Protesti, Court Judgements etc linked to
                their unique directors ID. Boolean [true/false] set to true
                where the director is known to be an authorised signatory.
                Further details, if known, may be present in "authority" or
                "additionalData".
            signingAuthority:
              description: >-
                Linked with DE searches, may return with other countries if data
                is available.
              type: boolean
              nullable: true
            positions:
              type: array
              items:
                $ref: >-
                  #/components/schemas/CreditsafeGlobalDataReportsCorporatePosition
            additionalData:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataReportsDirectorAdditionalData
    CreditsafeGlobalDataReportsPreviousDirector:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsDirector'
        - type: object
          properties:
            resignationDate:
              type: string
              format: date-time
              nullable: true
              description: The date the director resigned.
    CreditsafeGlobalDataReportsLtdDirectors:
      type: object
      properties:
        currentDirectors:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsDirector'
        previousDirectors:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsPreviousDirector'
    CreditsafeGlobalDataReportsCorporatePositionResigned:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsCorporatePosition'
        - type: object
          properties:
            resignationDate:
              type: string
              format: date-time
              nullable: true
    CreditsafeGlobalDataReportsDirectorship:
      type: object
      properties:
        id:
          type: string
        title:
          type: string
        initials:
          type: string
        name:
          type: string
        position:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCorporatePositionResigned
        registrationNumber:
          type: string
        companyName:
          type: string
        status:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCompanyStatusDescription
    CreditsafeGlobalDataReportsDirectorships:
      type: object
      properties:
        currentDirectorships:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsDirectorship'
        previousDirectorships:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsDirectorship'
    CreditsafeGlobalDataReportsEntity:
      type: object
      properties:
        name:
          description: Name of bank that the company holds an account with.
          type: string
        address:
          $ref: '#/components/schemas/CreditsafeGlobalDataAddressData'
    CreditsafeGlobalDataReportsBanker:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsEntity'
        - type: object
          properties:
            bankCode:
              type: string
              description: Bank code associated with the bank.
            bic:
              type: string
              description: >-
                Bank Identifier Code (BIC) or SWIFT code, used for international
                transfers.
    CreditsafeGlobalDataReportsAdvisor:
      type: object
      properties:
        auditorName:
          type: string
          description: Full name of the company who is responsible for auditing.
        solicitorName:
          type: string
          description: Name of solicitors.
        accountantName:
          type: string
          description: >-
            Full name of the accountancy firm who responsible for preparing the
            accounts.
    CreditsafeGlobalDataReportsEmployeeInformation:
      type: object
      properties:
        year:
          type: integer
          format: int32
          nullable: true
          description: Year that the figures were reordered.
        numberOfEmployees:
          type: string
          description: Number of staff that the company employ directly.
    CreditsafeGlobalDataReportsLtdOtherInformation:
      type: object
      properties:
        bankers:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsBanker'
        advisors:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsAdvisor'
        employeesInformation:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsEmployeeInformation
    CreditsafeGlobalDataCompanyType:
      description: '`NonLtdNonReg` is only available for countries in Norway.'
      enum:
        - NotSet
        - Ltd
        - NonLtd
        - NonLtdNonReg
      type: string
    CreditsafeGlobalDataOfficeType:
      enum:
        - registered
        - trading
        - headOffice
        - branch
        - subsidiary
        - franchise
        - franchisor
        - singleOffice
        - other
      type: string
    CreditsafeGlobalDataAdditionalInformation:
      type: object
      properties:
        isPLC:
          type: string
        coefficientLinear:
          type: number
    CreditsafeGlobalDataCompanyDataAdditionalData:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsAdditionalData'
        - type: object
    CreditsafeGlobalDataGroupStructureCompanyData:
      type: object
      properties:
        id:
          type: string
          description: Connect Id.
        country:
          $ref: '#/components/schemas/CreditsafeGlobalDataCountryCode'
        registrationNumber:
          type: string
          description: Official registration number.
        safeNo:
          type: string
          description: Creditsafe global identifier, called the Safe Number.
        idType:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsIdType'
        name:
          type: string
          description: Full company name of Ultimate Holding Company.
        type:
          $ref: '#/components/schemas/CreditsafeGlobalDataCompanyType'
        officeType:
          $ref: '#/components/schemas/CreditsafeGlobalDataOfficeType'
        status:
          $ref: '#/components/schemas/CreditsafeGlobalDataCompanyStatus'
        vatNo:
          description: Local VAT Number.
          oneOf:
            - type: string
              nullable: true
            - type: array
              items:
                type: string
                nullable: true
        additionalInformation:
          $ref: '#/components/schemas/CreditsafeGlobalDataAdditionalInformation'
        address:
          $ref: '#/components/schemas/CreditsafeGlobalDataAddressData'
        activity:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataCompanyActivityClassification
        legalForm:
          type: string
        additionalData:
          $ref: '#/components/schemas/CreditsafeGlobalDataCompanyDataAdditionalData'
    CreditsafeGlobalDataReportsLtdGroupStructure:
      type: object
      properties:
        ultimateParent:
          $ref: '#/components/schemas/CreditsafeGlobalDataGroupStructureCompanyData'
        immediateParent:
          $ref: '#/components/schemas/CreditsafeGlobalDataGroupStructureCompanyData'
        subsidiaryCompanies:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataGroupStructureCompanyData'
        affiliatedCompanies:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataGroupStructureCompanyData'
    CreditsafeGlobalDataReportsCompanyInGroupAdditionalData:
      allOf:
        - $ref: '#/components/schemas/CreditsafeGlobalDataReportsAdditionalData'
        - type: object
    CreditsafeGlobalDataReportsCompanyInGroup:
      type: object
      properties:
        id:
          type: string
          description: Connect Id.
        country:
          type: string
          description: Country where the company is established.
        safeNumber:
          type: string
          description: Creditsafe global identifier, called the Safe Number.
        idType:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsIdType'
        companyName:
          type: string
          description: Full company name.
        registeredNumber:
          type: string
          description: Official registration number.
        latestAnnualAccounts:
          type: string
          format: date-time
          nullable: true
          description: The last filed financial statements Year End Date of the company.
        level:
          type: integer
          format: int32
          description: The hierarchical level of the company within the group structure.
        percentOfOwnership:
          type: number
          format: double
          nullable: true
          description: The percentage of shares owned.
        status:
          type: string
          description: >-
            High-level status. Values include "Active", "NonActive", "Pending"
            and "Other".
        commonRatingBand:
          type: string
          description: Standardised credit score.
        additionalData:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCompanyInGroupAdditionalData
    CreditsafeGlobalDataReportsLtdFinancialStatement:
      type: object
      properties:
        type:
          type: string
          description: >-
            A code element set as "GlobalFinancialsGGS", which represents that
            the financial statements are in a common/standardised international
            format.
        yearEndDate:
          type: string
          format: date-time
          description: Financial Year End date for the annual accounts.
        numberOfWeeks:
          type: integer
          format: int32
          nullable: true
          description: Number of weeks in the year.
        currency:
          $ref: '#/components/schemas/CreditsafeGlobalDataCurrency'
        consolidatedAccounts:
          type: boolean
          nullable: true
          description: Boolean [true/false]. Are the accounts consolidated?
    CreditsafeGlobalDataReportsProfitAndLossFigures:
      type: object
      properties:
        revenue:
          type: number
          format: double
          nullable: true
          description: >-
            Income earned from normal business activities, including the sale of
            goods and services.
        operatingCosts:
          type: number
          format: double
          nullable: true
          description: Costs incurred in the general running of the business.
        operatingProfit:
          type: number
          format: double
          nullable: true
          description: >-
            The results of the company after deducting Operating Costs from its
            Revenue.
        wagesAndSalaries:
          type: number
          format: double
          nullable: true
          description: >-
            Wages and salaries paid to employees of the company. Where possible
            this excludes Pensions.
        pensionCosts:
          type: number
          format: double
          nullable: true
          description: The cost of pension benefits for employees of the company.
        depreciation:
          type: number
          format: double
          nullable: true
          description: The amount written off Tangible Fixed Assets during the year.
        amortisation:
          type: number
          format: double
          nullable: true
          description: The amount written off Intangible Fixed Assets during the year.
        financialIncome:
          type: number
          format: double
          nullable: true
          description: Interest income earned during the year.
        financialExpenses:
          type: number
          format: double
          nullable: true
          description: Interest expenses incurred during the year.
        extraordinaryIncome:
          type: number
          format: double
          nullable: true
          description: Income arising due to events of a non-recurring nature.
        extraordinaryCosts:
          type: number
          format: double
          nullable: true
          description: Costs incurred due to events of a non-recurring nature.
        profitBeforeTax:
          type: number
          format: double
          nullable: true
          description: The results of the company before deducting any charge for taxation.
        tax:
          type: number
          format: double
          nullable: true
          description: Taxation payable on the profits of the company.
        profitAfterTax:
          type: number
          format: double
          nullable: true
          description: The results of the company after deducting any charge for taxation.
        dividends:
          type: number
          format: double
          nullable: true
          description: The total amount of profits distributed to shareholders.
        minorityInterests:
          type: number
          format: double
          nullable: true
          description: >-
            Profits attributable to shareholders holding a minority interest in
            the company.
        otherAppropriations:
          type: number
          format: double
          nullable: true
          description: >-
            Other miscellaneous items that are deducted / added to affect the
            Retained Profit / Loss of a company.
        retainedProfit:
          type: number
          format: double
          nullable: true
          description: >-
            The results of the company after all income and expenses have been
            credited/debited.
    CreditsafeGlobalDataReportsBalanceSheet:
      type: object
      properties:
        landAndBuildings:
          type: number
          format: double
          nullable: true
          description: Land and buildings owned by the company for long-term use.
        plantAndMachinery:
          type: number
          format: double
          nullable: true
          description: Plant and machinery owned by the company for long-term use.
        otherTangibleAssets:
          type: number
          format: double
          nullable: true
          description: >-
            Tangible fixed assets other than Land & Buildings or Plant &
            Machinery.
        totalTangibleAssets:
          type: number
          format: double
          nullable: true
          description: Physical assets owned by the company for long-term use.
        goodwill:
          type: number
          format: double
          nullable: true
          description: The premium paid or accumulated on the purchase of an asset.
        otherIntangibleAssets:
          type: number
          format: double
          nullable: true
          description: >-
            Intangible fixed assets other than goodwill such as Trademarks,
            Patents, Research & Development, etc.
        totalIntangibleAssets:
          type: number
          format: double
          nullable: true
          description: Assets that have a value but no physical existence.
        investments:
          type: number
          format: double
          nullable: true
          description: Long-term investments including shares and securities.
        loansToGroup:
          type: number
          format: double
          nullable: true
          description: Long-term loans made by the company to related businesses.
        otherLoans:
          type: number
          format: double
          nullable: true
          description: Other long-term loans made by the company.
        miscellaneousFixedAssets:
          type: number
          format: double
          nullable: true
          description: >-
            Long-term assets other than Tangible Assets, Intangible Assets,
            Investments, or Loans.
        totalOtherFixedAssets:
          type: number
          format: double
          nullable: true
          description: >-
            Total long-term assets other than Tangible Assets or Intangible
            Assets.
        totalFixedAssets:
          type: number
          format: double
          nullable: true
          description: The total of Tangible, Intangible, and Other Fixed Assets.
        rawMaterials:
          type: number
          format: double
          nullable: true
          description: Materials held by the company that have not yet been processed.
        workInProgress:
          type: number
          format: double
          nullable: true
          description: >-
            Goods or contracts that are in the process of manufacture or
            completion.
        finishedGoods:
          type: number
          format: double
          nullable: true
          description: Goods held that are ready for sale or use.
        otherInventories:
          type: number
          format: double
          nullable: true
          description: Other amounts classed as Inventory but not included above.
        totalInventories:
          type: number
          format: double
          nullable: true
          description: The total of stocks held by the company and work in progress.
        tradeReceivables:
          type: number
          format: double
          nullable: true
          description: >-
            Amounts due within one year from customers for goods and services
            supplied on credit.
        groupReceivables:
          type: number
          format: double
          nullable: true
          description: Amounts due within one year from related businesses.
        receivablesDueAfter1Year:
          type: number
          format: double
          nullable: true
          description: >-
            Amounts due after one year owing to the company (including trade and
            group receivables due after one year).
        miscellaneousReceivables:
          type: number
          format: double
          nullable: true
          description: >-
            Amounts due within one year owing to the company other than trade
            and group receivables.
        totalReceivables:
          type: number
          format: double
          nullable: true
          description: Total amounts receivable by the company.
        cash:
          type: number
          format: double
          nullable: true
          description: Cash at bank, cash in hand, and cash equivalents.
        otherCurrentAssets:
          type: number
          format: double
          nullable: true
          description: >-
            Any short-term assets that have not already been included as
            Inventory, Receivables, or Cash.
        totalCurrentAssets:
          type: number
          format: double
          nullable: true
          description: >-
            The total of Stocks, Debtors, Cash, and other assets due within one
            year.
        totalAssets:
          type: number
          format: double
          nullable: true
          description: The total of Current and Fixed Assets.
        tradePayables:
          type: number
          format: double
          nullable: true
          description: >-
            Amounts due within one year owing to suppliers for goods and
            services provided on credit.
        bankLiabilities:
          type: number
          format: double
          nullable: true
          description: Amounts due within one year owing to banks for overdrafts and loans.
        otherLoansOrFinance:
          type: number
          format: double
          nullable: true
          description: >-
            Loans or finance due within one year owing to parties other than
            banks or related businesses.
        groupPayables:
          type: number
          format: double
          nullable: true
          description: Amounts due within one year to related businesses.
        miscellaneousLiabilities:
          type: number
          format: double
          nullable: true
          description: Other amounts due within one year owing by the company.
        totalCurrentLiabilities:
          type: number
          format: double
          nullable: true
          description: Total short-term liabilities of the company.
        tradePayablesDueAfter1Year:
          type: number
          format: double
          nullable: true
          description: >-
            Amounts due after one year owing to suppliers for goods and services
            provided on credit.
        bankLiabilitiesDueAfter1Year:
          type: number
          format: double
          nullable: true
          description: Amounts due after one year owing to banks for overdrafts and loans.
        otherLoansOrFinanceDueAfter1Year:
          type: number
          format: double
          nullable: true
          description: >-
            Loans or finance due after one year owing to parties other than
            banks or related businesses.
        groupPayablesDueAfter1Year:
          type: number
          format: double
          nullable: true
          description: Amounts due after one year to related businesses.
        miscellaneousLiabilitiesDueAfter1Year:
          type: number
          format: double
          nullable: true
          description: Other amounts due after one year owing by the company.
        totalLongTermLiabilities:
          type: number
          format: double
          nullable: true
          description: Total long-term liabilities of the company.
        totalLiabilities:
          type: number
          format: double
          nullable: true
          description: >-
            The total of Total Long-term Liabilities and Total Current
            Liabilities.
        calledUpShareCapital:
          type: number
          format: double
          nullable: true
          description: The issued and paid share capital from shareholders.
        sharePremium:
          type: number
          format: double
          nullable: true
          description: >-
            The excess of the amount received on the issue of shares over their
            value.
        revenueReserves:
          type: number
          format: double
          nullable: true
          description: The accumulation of profits/losses from previous trading periods.
        otherReserves:
          type: number
          format: double
          nullable: true
          description: Other capital and reserves that form part of shareholders' equity.
        totalShareholdersEquity:
          type: number
          format: double
          nullable: true
          description: The total capital and reserves of the company.
    CreditsafeGlobalDataReportsOtherFinancials:
      type: object
      properties:
        contingentLiabilities:
          type: string
          description: >-
            Potential liabilities that are not recognised in the balance sheet,
            output as a string. Usually contains integers, but can also be
            output as a string value (such as “YES” or “NO”).
        workingCapital:
          type: number
          format: double
          nullable: true
          description: >-
            Total Current Assets – Receivables Due after 1 year – Total Current
            Liabilities. This measures if the company has sufficient short-term
            assets to cover its current debts.
        netWorth:
          type: number
          format: double
          nullable: true
          description: >-
            Often referred to as the 'book value' of the business this equals
            Total Shareholders’ Equity less Total Intangible Assets
    CreditsafeGlobalDataReportsFinancialRatios:
      type: object
      properties:
        preTaxProfitMargin:
          type: number
          format: double
          nullable: true
          description: >-
            Pre-tax profits / Turnover x 100. This shows the percentage of
            Profit in each pound of sales or the equivalent of retailers
            'mark-up'.
        returnOnCapitalEmployed:
          type: number
          format: double
          nullable: true
          description: >-
            Pre-Tax Profit / Capital Employed x 100. This ratio measures the
            profits a business yields in return for the money (Capital)
            invested.
        returnOnTotalAssetsEmployed:
          type: number
          format: double
          nullable: true
          description: >-
            Pre-Tax Profits / Total Assets x 100. This shows the ‘return’ or
            'profit' on each pound of Assets used as a percentage.
        returnOnNetAssetsEmployed:
          type: number
          format: double
          nullable: true
          description: >-
            Pre-Tax Profits / Net Assets x 100. This shows the ‘return’ in
            percent on the net assets of the company. The higher the percentage
            the more profitable the company.
        salesOrNetWorkingCapital:
          type: number
          format: double
          nullable: true
          description: >-
            Turnover / (Total Current Assets - Receivables Due after 1 year -
            Total Current Liabilities). The higher the ratio the higher the
            volume of Sales made per the companies working capital.
        stockTurnoverRatio:
          type: number
          format: double
          nullable: true
          description: >-
            Stocks / Turnover x 100. This shows the number of times the trading
            stock of a company is ‘turned over’ in a trading period. If the
            ratio is low this indicates that relatively little money is tied up
            in Stocks.
        debtorDays:
          type: number
          format: double
          nullable: true
          description: >-
            Trade Debtors / Turnover x 365 days. This is a calculation that
            predicts the average time taken for the company to collect its
            invoices for goods and services provided to its customers.
        creditorDays:
          type: number
          format: double
          nullable: true
          description: >-
            Trade Creditors / Turnover x 365 days. This is a calculation that
            predicts the average time taken for the company to settle its
            invoices for goods and services provided by its suppliers.
        currentRatio:
          type: number
          format: double
          nullable: true
          description: >-
            Total Current Assets - Receivables Due after 1 year / Total Current
            Liabilities. This is an indication of a company's ability to meet
            short-term debt obligations; the higher the ratio, the more liquid
            the company is.
        liquidityRatioOrAcidTest:
          type: number
          format: double
          nullable: true
          description: >-
            Total Current Assets - Total Inventories - Receivables Due after 1
            year / Total Current Liabilities. This, like the current ratio,
            measures how quickly a company can meet its short-term debts.
            However, this ratio excludes stock, as there is no guarantee the
            value of Stocks can be realised quickly.
        currentDebtRatio:
          type: number
          format: double
          nullable: true
          description: >-
            Total Current Liabilities / Total Shareholders’ Equity. This
            measures the amount of short-term debt in relation to the value of
            shareholders’ funds.
        gearing:
          type: number
          format: double
          nullable: true
          description: >-
            Bank Overdraft & Loans + Total Long-term Liabilities/Total
            Shareholders’ Equity x 100. This is the relationship between the
            size of the company’s debt in proportion to Equity (Shareholders
            Funds).
        equityInPercentage:
          type: number
          format: double
          nullable: true
          description: >-
            Total Shareholders’ Equity / (Total Current Assets + Tangible Fixed
            Assets – Total Intangible Assets) x 100. This ratio shows the worth
            of the company (shareholders’ funds) as a percentage of total
            current and tangible assets.
        totalDebtRatio:
          type: number
          format: double
          nullable: true
          description: >-
            Total Current Liabilities + Total Long-term liabilities / Total
            Shareholders’ Equity x 100. This shows the relative indebtedness of
            a company in relation to the worth of the company.
    CreditsafeGlobalDataReportsGlobalFinancialsGGS:
      allOf:
        - $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsLtdFinancialStatement
        - type: object
          properties:
            profitAndLoss:
              $ref: >-
                #/components/schemas/CreditsafeGlobalDataReportsProfitAndLossFigures
            balanceSheet:
              $ref: '#/components/schemas/CreditsafeGlobalDataReportsBalanceSheet'
            otherFinancials:
              $ref: '#/components/schemas/CreditsafeGlobalDataReportsOtherFinancials'
            ratios:
              $ref: '#/components/schemas/CreditsafeGlobalDataReportsFinancialRatios'
    CreditsafeGlobalDataReportsLocalFinancialStatement:
      allOf:
        - $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsLtdFinancialStatement
        - type: object
          properties:
            profitAndLoss:
              type: object
              additionalProperties: true
              description: >-
                Please refer to the relevant country data dictionary for the
                properties expected in this object <a
                href="https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries"
                target="_blank"> HERE </a>
            balanceSheet:
              type: object
              additionalProperties: true
              description: >-
                Please refer to the relevant country data dictionary for the
                properties expected in this object <a
                href="https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries"
                target="_blank"> HERE </a>
            otherFinancials:
              type: object
              additionalProperties: true
              description: >-
                Please refer to the relevant country data dictionary for the
                properties expected in this object <a
                href="https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries"
                target="_blank"> HERE </a>
            ratios:
              type: object
              additionalProperties: true
              description: >-
                Please refer to the relevant country data dictionary for the
                properties expected in this object <a
                href="https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries"
                target="_blank"> HERE </a>
    CreditsafeGlobalDataReportsReportNegativeInformation:
      type: object
      description: >-
        Please refer to the relevant country data dictionary for the properties
        expected in this object <a
        href="https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries"
        target="_blank"> HERE </a>
    CreditsafeGlobalDataReportsReportAdditionalInformation:
      type: object
      description: >-
        Please refer to the relevant country data dictionary for the properties
        expected in this object <a
        href="https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries"
        target="_blank"> HERE </a>
    CreditsafeGlobalDataReportsCompanyReportExtraSection:
      type: object
    CreditsafeGlobalDataReportsLtdDirectorsExtra:
      allOf:
        - $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection
        - type: object
    CreditsafeGlobalDataReportsLtdExtendedGroupStructureExtra:
      allOf:
        - $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection
        - type: object
    CreditsafeGlobalDataReportsReportPaymentData:
      type: object
      description: >-
        Please refer to the relevant country data dictionary for the properties
        expected in this object <a
        href="https://help.creditsafeuk.com/en/support/solutions/articles/7000053487-connect-api-data-dictionaries"
        target="_blank"> HERE </a>
    CreditsafeGlobalDataReportsReportPaymentDataExtra:
      allOf:
        - $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection
        - type: object
    CreditsafeGlobalDataReportsReportAlternateSummary:
      type: object
    CreditsafeGlobalDataReportsReportNegativeInformationExtra:
      allOf:
        - $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsCompanyReportExtraSection
        - type: object
    CreditsafeGlobalDataReportsExceptions:
      type: object
      properties:
        eventType:
          type: object
          description: Describes the exception alert
          properties:
            code:
              type: string
              description: A code associated with the exception event, for example GA_8
            description:
              type: string
              description: >-
                A description associated with the event, for example "Multiple
                companies has this exact address".
        eventLevel:
          type: object
          description: Level of risk for the exception alert
          properties:
            code:
              type: string
              description: >-
                A numeric code which indicates if the event level is General [0]
                OR "High" [1].
            description:
              type: string
              description: >-
                A text description which indicates if the event level is General
                [0] OR "High" [1].
        eventDate:
          type: string
          description: >-
            The date associated with the exception event - this might be the
            date when the unusual behaviour was detected, not necessarily the
            date of the original event.
          format: date-time
    CreditsafeGlobalDataReportsCompanyReport:
      type: object
      properties:
        companyId:
          type: string
        language:
          $ref: '#/components/schemas/CreditsafeGlobalDataLanguage'
        companySummary:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsLtdCompanySummary'
        companyIdentification:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsLtdCompanyIdentification
        creditScore:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsLtdCreditScore'
        contactInformation:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsLtdContactInformation
        indicators:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsIndicators'
        shareCapitalStructure:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsLtdShareCapitalStructure
        directors:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsLtdDirectors'
        directorships:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsDirectorships'
        otherInformation:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsLtdOtherInformation'
        groupStructure:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsLtdGroupStructure'
        extendedGroupStructure:
          type: array
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsCompanyInGroup'
        financialStatements:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsGlobalFinancialsGGS
        localFinancialStatements:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreditsafeGlobalDataReportsLocalFinancialStatement
        negativeInformation:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsReportNegativeInformation
        additionalInformation:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsReportAdditionalInformation
        directorsExtra:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsLtdDirectorsExtra'
        extendedGroupStructureExtra:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsLtdExtendedGroupStructureExtra
        paymentData:
          $ref: '#/components/schemas/CreditsafeGlobalDataReportsReportPaymentData'
        paymentDataExtra:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsReportPaymentDataExtra
        alternateSummary:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsReportAlternateSummary
        negativeInformationExtra:
          $ref: >-
            #/components/schemas/CreditsafeGlobalDataReportsReportNegativeInformationExtra
        exceptions:
          type: array
          description: >-
            Identifies unusual behaviours, for example multiple changes in
            address in a short period of time. This is a premium service, not
            available for all customers and is only availble for specific report
            templates [gycs, custom, full].
          items:
            $ref: '#/components/schemas/CreditsafeGlobalDataReportsExceptions'
    CreditsafeGlobalDataReportsCompanyReportResponse:
      allOf:
        - type: object
          properties:
            correlationId:
              type: string
              description: A unique ID assigned to this request.
            failedSections:
              type: array
              items:
                $ref: '#/components/schemas/CreditsafeGlobalDataReportsReportSection'
            report:
              $ref: '#/components/schemas/CreditsafeGlobalDataReportsCompanyReport'
            companyId:
              type: string
            dateOfOrder:
              type: string
              format: date-time
            language:
              type: string
            userId:
              type: integer
    ConnectErrorResponsesBadRequest:
      type: object
      description: Bad Request
      properties:
        correlationId:
          type: string
          description: A unique ID assigned to this request.
        message:
          type: string
        details:
          type: string
          description: Provides further information on why the request was rejected
    ConnectErrorResponsesAccessForbidden:
      type: object
      description: 403 - Access Forbidden
      properties:
        message:
          type: string
          example: Access forbidden
    ConnectErrorResponsesResourceNotFoundRequest:
      type: object
      description: 404 - Not Found
      properties:
        correlationId:
          type: string
          description: A unique ID assigned to this request.
          format: uuid
        message:
          type: string
        details:
          type: string
          description: Provides further information on why the request was rejected
    ConnectErrorResponsesResourceConflictResponse:
      type: object
      description: 409 - Conflict
      properties:
        correlationId:
          description: The unique identifier. (A UUID specified by RFC4122).
          type: string
          format: uuid
        message:
          type: string
        details:
          type: string
          description: Provides further information on why the request was rejected
    GetKYCProfiles:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Id of the Profile
              name:
                type: string
                description: Name of the Profile
              riskRating:
                type: string
                description: >-
                  Risk rating given to profile Available values [notApplicable,
                  veryLow, low, medium, high, veryHigh]
              status:
                type: string
                description: >-
                  Status of the profile - Available value [new, approved,
                  declined, pending, cancelled, referred, closed,
                  approvedReviewDue]
              type:
                type: string
                description: >-
                  Type of the profile Available values [trust, individual,
                  soleTrader, company, plc, partnership, otherEntity]
              internalId:
                type: string
                description: Internal Id given to profile by customer
              assignedToId:
                type: integer
                description: Id of the user assigned to the profile
              assignedTo:
                type: string
                description: Name of the user assigned to the profile
              safeNumber:
                type: string
                description: safe number of the business linked to the profile
              companyId:
                type: string
                description: company id of the business linked to the profile
              formationDate:
                type: string
                description: Formation date of the business linked to the profile
                format: date
              createdAt:
                type: string
                description: Profile created time
                format: date-time
              createdById:
                type: integer
                description: Id of the user who created the profile
                format: int32
              createdBy:
                type: string
                description: Name of the user who created the profile
              modifiedAt:
                type: string
                description: Profile last updated time
                format: date-time
              modifiedById:
                type: integer
                description: Id of the user who last modified the profile
                format: int32
              modifiedBy:
                type: string
                description: Name of the user who last modified the profile
              kycApprovedAt:
                type: string
                description: Date when the profile got approved
                format: date-time
              kycReviewOn:
                type: string
                description: Date when profile is to be reviewed
                format: date
              kycStatusUpdatedOn:
                type: string
                description: Date when the profile status was last updated
                format: date-time
              kycComments:
                type: string
                description: Profile comments
              noteCount:
                type: integer
                description: Count of notes associated with profile
                format: int32
              attachmentCount:
                type: integer
                description: Count of attachments associated with profile
                format: int32
              keyPartyCount:
                type: integer
                description: Count of key parties associated with profile
                format: int32
              uboCount:
                type: integer
                description: Count of UBOs associated with profile
                format: int32
              openAlertCount:
                type: integer
                description: Count of Open Alerts
                format: int32
              modeOfCreation:
                type: string
                description: Mode of profile creation (manual, import)
              importStatus:
                type: string
                description: >-
                  Status of profile creation (submitted, preprocessed,\ \
                  validated, queued, inProgress, processed, completed,
                  partiallyCompleted,\ \ failed)
              isLocked:
                type: boolean
                description: Value indicating whether the profile is locked
        totalSize:
          type: number
        correlationId:
          type: string
          description: A unique ID assigned to this request.
    KycProtectPostProfilesRequest:
      type: object
      required:
        - name
        - type
      properties:
        name:
          description: >-
            The name of the profile being created.<br> This MUST be unique
            across your profiles.
          type: string
        type:
          description: >-
            The profile type to be created. This will effect searches later for
            validations.<br> i.e. Not being able to apply certain datasets
            (Example - State Owned Enterprises) to an Individual profile. Ensure
            the correct type is applied for intended search.
          type: string
          enum:
            - trust
            - individual
            - soleTrader
            - company
            - plc
            - partnership
            - otherEntity
          example: trust
        internalId:
          description: >-
            Internal ID of the profile, this MUST be unique across your
            profiles.
          type: string
        assignedToId:
          description: Creditsafe Id of the user to assign the profile to.
          type: integer
        kycReviewOn:
          description: >-
            The date to which the profile should be reviewed. <br> Format
            YYYY-MM-DD <br> Validates when the date changes and is either
            current or in the future.
          type: string
        status:
          description: Status of the profile.
          type: string
          enum:
            - new
            - approved
            - declined
            - pending
            - cancelled
            - referred
            - closed
            - approvedReviewDue
        riskRating:
          description: Risk rating of the profile.
          type: string
          enum:
            - notApplicable
            - veryLow
            - low
            - medium
            - high
            - veryHigh
        kycComments:
          description: >-
            Free text field for users to highlight key information to other
            users. <br> Maximum characters allowed is 250
          type: string
        details:
          type: object
          description: Please note the required property in this object.
          required:
            - legalName
          properties:
            legalName:
              type: string
              description: >-
                Name of the Business or Individual<br> Maximum length is 150
                characters
              example: Creditsafe Ltd
            tradingName:
              type: string
              example: null
              description: >-
                Valid for profile type - SoleTrader<br> Maximum length is 150
                characters
            aliases:
              type: string
              description: >-
                Name of any Aliases<br> Maximum length of each alias is 150
                characters
              example: null
            activity:
              type: string
              description: >-
                Activity of the Business e.g. NAIC S/SIC Codes<br> Valid for
                profile types - Trust, Company, Partnership, OtherEntity and
                PLC<br> Maximum length of activity is 150 characters
              example: '62409'
            description:
              type: string
              example: Example Free Text
              description: >-
                Description of the business/individual entity<br> Valid for the
                profile types Trust, Company, Partnership, OtherEntity and PLC
            contactName:
              type: string
              description: Contact person at the organisation.
              example: null
            email:
              type: string
              description: Contact email address of the entity
              example: example@creditsafe.com
            website:
              type: string
              example: www.creditsafe.com
              description: >-
                Website address of the entity<br> Valid for the profile types
                Trust, Company, Partnership, OtherEntity and PLC
            telephone:
              type: string
              example: null
              description: >-
                Telephone number of the entity.<br> Valid for the profile types
                Trust, Company, Partnership, OtherEntity and PLC
            turnover:
              type: object
              properties:
                currencyCode:
                  type: string
                  description: The currency the amount is in
                  enum:
                    - eur
                    - gbp
                    - usd
                    - cny
                    - cad
                    - aud
                    - nzd
                    - inr
                    - jpy
                    - chf
                    - zar
                    - dkk
                    - sek
                    - nok
                amount:
                  description: Total Turnover Figure
                  type: integer
            assetsUnderManagement:
              type: object
              properties:
                currencyCode:
                  type: string
                  description: The currency the amount is in
                  enum:
                    - eur
                    - gbp
                    - usd
                    - cny
                    - cad
                    - aud
                    - nzd
                    - inr
                    - jpy
                    - chf
                    - zar
                    - dkk
                    - sek
                    - nok
                amount:
                  type: integer
                  description: The total value of the assets under management
            organizationNumber:
              type: string
              description: >-
                Property valid for profile type - Trust, Company, Partnership,
                OtherEntity and PLC
              example: '12345678'
            internalContact:
              type: string
              description: >-
                Internal contact name to contact regarding this profile,<br>
                Property valid for profile type - Trust, Company, Partnership,
                OtherEntity and PLC.
              example: null
            internalEmail:
              type: string
              description: >-
                Internal email address to contact regarding this profile.<br>
                Property valid for profile type - Trust, Company, Partnership,
                OtherEntity and PLC
              example: null
            dateOfBirth:
              type: string
              format: date
              example: '2024-03-25'
              description: >-
                Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in
                the future<br> Valid for the profile types Individual and
                SoleTrader
            countryCode:
              type: string
              example: GB
              description: >-
                Two-letter country code ISO-3166-2.<br> Valid for the profile
                types Individual and SoleTrader
            vatNo:
              type: string
              example: GB12345678
              description: >-
                Tax Identification Number of the business<br> Valid for the
                profile types Company, Partnership, OtherEntity and PLC
            isListedOnExchange:
              type: boolean
              description: Property valid for profile type PLC
              example: null
            exchangeName:
              type: string
              description: Property valid for profile type PLC
              example: null
    KycProtectProfileCreatedResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the Profile
          format: uuid
        name:
          type: string
          description: Name of the Profile
        riskRating:
          type: string
          description: >-
            Risk rating given to profile (notApplicable, veryLow, low, medium,
            high, veryHigh)
        status:
          type: string
          description: >-
            Status of the profile (new, approved, declined, pending, cancelled,
            referred, closed, approvedReviewDue)
        type:
          type: string
          description: >-
            Type of the profile (trust, individual, soleTrader, company, plc,
            partnership, otherEntity)
        internalId:
          type: string
          nullable: true
          description: Internal Id given to profile by customer
        assignedToId:
          type: integer
          nullable: true
          description: Id of the user assigned to the profile
        assignedTo:
          type: string
          nullable: true
          description: Name of the user assigned to the profile
        safeNumber:
          type: string
          nullable: true
          description: safe number of the business linked to the profile
        companyId:
          type: string
          nullable: true
          description: company id of the business linked to the profile
        formationDate:
          type: string
          nullable: true
          description: Formation date of the business linked to the profile
          format: date
        createdAt:
          type: string
          description: Profile created time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created the profile
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the profile
        modifiedAt:
          type: string
          nullable: true
          description: Profile last updated time
          format: date-time
        modifiedById:
          type: integer
          nullable: true
          description: Id of the user who last modified the profile
          format: int32
        modifiedBy:
          type: string
          nullable: true
          description: Name of the user who last modified the profile
        kycApprovedAt:
          type: string
          nullable: true
          description: Date when the profile got approved
          format: date-time
        kycReviewOn:
          type: string
          nullable: true
          description: Date when profile is to be reviewed
          format: date
        kycStatusUpdatedOn:
          type: string
          nullable: true
          description: Date when the profile status was last updated
          format: date-time
        kycComments:
          type: string
          nullable: true
          description: Profile comments
        noteCount:
          type: integer
          description: Count of notes associated with profile
          format: int32
        attachmentCount:
          type: integer
          description: Count of attachments associated with profile
          format: int32
        keyPartyCount:
          type: integer
          description: Count of key parties associated with profile
          format: int32
        uboCount:
          type: integer
          description: Count of UBOs associated with profile
          format: int32
        openAlertCount:
          type: integer
          description: Count of Open Alerts
          format: int32
        modeOfCreation:
          type: string
          description: Mode of profile creation (manual, import)
        importStatus:
          type: string
          nullable: true
          description: >-
            Status of profile creation (submitted, preprocessed, validated,
            queued, inProgress, processed, completed, partiallyCompleted,
            failed)
        isLocked:
          type: boolean
          description: Value indicating whether the profile is locked
        details:
          type: object
          properties:
            profileId:
              type: string
              description: Id of the profile
              format: uuid
            legalName:
              type: string
              description: Name of the business/individual
            tradingName:
              type: string
              nullable: true
              description: Trading name of the entity
            aliases:
              type: array
              items:
                type: string
                nullable: true
              description: Alias names given for the entity
            activity:
              type: string
              nullable: true
              description: Activity of the business e.g., NAICS/SIC codes
            description:
              type: string
              description: Description of the entity
              nullable: true
            contactName:
              type: string
              description: Contact person name
              nullable: true
            email:
              type: string
              description: Contact email address
              nullable: true
            website:
              type: string
              description: Entity website address
              nullable: true
            telephone:
              type: string
              description: Contact telephone number
              nullable: true
            turnover:
              description: Turnover
              type: object
              properties:
                currencyCode:
                  description: >-
                    Currency Code(eur, gbp, usd, cny, cad, aud, nzd, inr, jpy,
                    chf, zar, dkk, sek, nok).
                  type: string
                  nullable: true
                amount:
                  description: Turnover Amount.
                  type: number
                  nullable: true
            assetsUnderManagement:
              description: Assets Under Management
              type: object
              properties:
                currencyCode:
                  description: >-
                    Currency Code(eur, gbp, usd, cny, cad, aud, nzd, inr, jpy,
                    chf, zar, dkk, sek, nok).
                  type: string
                  nullable: true
                amount:
                  description: Assets Under Management Amount.
                  type: number
                  nullable: true
            dateOfBirth:
              type: string
              nullable: true
              description: Date of birth of the individual
              format: date
            countryCode:
              type: string
              nullable: true
              description: Two-letter country code ISO-3166-2
            vatNo:
              type: string
              nullable: true
              description: Tax Identification Number of the business
            isListedOnExchange:
              type: boolean
              nullable: true
              description: Details of company listed on exchange
            exchangeName:
              type: string
              nullable: true
              description: Gets the name of the exchange.
            organizationNumber:
              type: string
              nullable: true
              description: Gets the organisation number.
            internalContact:
              type: string
              nullable: true
              description: Gets the internal contact.
            internalEmail:
              type: string
              nullable: true
              description: Gets the internal email.
            internationalScore:
              type: string
              nullable: true
              description: Gets the international score.
            createdAt:
              type: string
              description: Profile details created time
              format: date-time
            createdById:
              type: integer
              description: Id of the user who created profile
              format: int32
            createdBy:
              type: string
              description: Name of the user who created profile
            modifiedAt:
              type: string
              nullable: true
              description: Profile details last updated time
              format: date-time
            modifiedById:
              type: integer
              nullable: true
              description: Id of the user who last modified the profile
              format: int32
            modifiedBy:
              type: string
              nullable: true
              description: Name of the user who last modified the profile
            noteCount:
              type: integer
              description: Count of notes associated with profile details
              format: int32
            attachmentCount:
              type: integer
              description: Count of attachment associated with profile details
              format: int32
    DeleteKYCProfiles:
      type: array
      items:
        type: string
        example: fd91185f-c10e-4a42-b0b4-cc367371ebdb
    GetKYCProfileByProfileId:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Id of the profile assigned
        name:
          type: string
          description: The name of the profile
        riskRating:
          type: string
          description: The risk rating being assigned to the profile
          enum:
            - notApplicable
            - veryLow
            - low
            - medium
            - high
            - veryHigh
        status:
          type: string
          description: The current status of the profile
          enum:
            - new
            - approved
            - declined
            - pending
            - cancelled
            - referred
            - closed
            - approvedReviewDue
        type:
          type: string
          description: The type of the profile
          enum:
            - trust
            - individual
            - soleTrader
            - company
            - plc
            - partnership
            - otherEntity
        internalId:
          type: string
          description: The internal Id given to the profile by the customer
        assignedToId:
          type: integer
          description: Id of the user assigned to the profile
        assignedTo:
          type: string
          description: Name of the user assigned to the profile
        safeNumber:
          type: string
          description: The safe number linked to the profile
        companyId:
          type: string
          description: The companyID linked to the profile
        formationDate:
          type: string
          format: date
          description: Formation date of the business linked to the profile
        createdAt:
          type: string
          format: date-time
          description: The profile creating time
        createdById:
          type: integer
          description: Id of the user who created the profile
        createdBy:
          type: string
          description: Name of the user who created the profile
        modifiedAt:
          type: string
          format: date-time
          description: The time the profile was last updated
        modifiedById:
          type: integer
          description: Id of the user who last modified the profile
        modifiedBy:
          type: string
          description: Name of the user who last modified the profile
        kycApprovedAt:
          type: string
          format: date-time
          description: The date when the profile got approved at
        kycReviewOn:
          type: string
          format: date
          description: The date to which the profile is to be reviewed
        kycStatusUpdatedOn:
          type: string
          format: date-time
          description: Date when the profile status was last updated
        kycComments:
          type: string
          description: Profile comments
        noteCount:
          type: integer
          description: Count of the number of notes associated to the profile
        attachmentCount:
          type: integer
          description: Count of the number of attachments associated to the profile
        keyPartyCount:
          type: integer
          description: Count of the number of key parties associated to the profile
        uboCount:
          type: integer
          description: Count of the number of UBO's associated to the profile
        openAlertCount:
          type: integer
          description: Count of the number of open alerts associated to the profile
        modeOfCreation:
          type: string
          description: How the record was created [manual, batch]
        importStatus:
          type: string
          description: The current status of the import
        isLocked:
          type: boolean
        correlationId:
          type: string
          description: A unique ID assigned to this request.
      example:
        id: fd91185f-c10e-4a42-b0b4-cc367371ebdb
        name: tej
        riskRating: notApplicable
        status: new
        type: trust
        internalId: null
        customerId: 103077765
        assignedToId: 101562008
        assignedTo: Amol
        safeNumber: null
        formationDate: null
        createdAt: '2023-07-25T09:32:40.428637Z'
        createdById: 101562008
        createdBy: Amol
        modifiedAt: '2023-07-25T14:50:50.170613Z'
        modifiedById: 101562008
        modifiedBy: Amol
        kycApprovedAt: null
        kycReviewOn: null
        kycStatusUpdatedOn: '2023-07-25T09:32:40.428637Z'
        kycComments: null
        noteCount: 0
        attachmentCount: 0
        keyPartyCount: 0
        uboCount: 0
        openAlertCount: 0
    UpdateKYCProfileByProfileIdRequest:
      type: object
      required:
        - name
        - riskRating
        - status
      properties:
        name:
          type: string
          description: The name of the profile to be updated.
        riskRating:
          type: string
          enum:
            - notApplicable
            - veryLow
            - low
            - medium
            - high
            - veryHigh
          description: Risk rating of the profile.
          example: notApplicable
        status:
          description: Status of the profile.
          type: string
          enum:
            - new
            - approved
            - declined
            - pending
            - cancelled
            - referred
            - closed
            - approvedReviewDue
          example: new
        internalId:
          type: string
          description: >-
            Internal ID of the profile, this MUST be unique across your
            profiles.
        assignedToId:
          type: object
          format: int32
          description: >-
            Creditsafe Id of the user to assign the profile to. <br> Passing
            null will unassign the profile.
        kycReviewOn:
          type: object
          format: date
          example: '2021-04-20'
          description: >-
            The date to which the profile should be reviewed. <br> Format
            YYYY-MM-DD <br> Validates when the date changes and is either
            current or in the future.
        kycComments:
          type: string
          description: >-
            Free text field for users to highlight key information to other
            users. <br> Maximum characters allowed is 250
    UpdateKYCProfileByProfileId:
      type: object
      properties:
        id:
          type: string
          description: Id of the Profile
          format: uuid
        name:
          type: string
          description: Name of the Profile
        riskRating:
          type: string
          description: The risk rating being assigned to the profile
          enum:
            - notApplicable
            - veryLow
            - low
            - medium
            - high
            - veryHigh
        status:
          type: string
          description: >-
            Status of the profile (new, approved, declined, pending, cancelled,
            referred, closed, approvedReviewDue)
        type:
          type: string
          description: >-
            Type of the profile (trust, individual, soleTrader, company, plc,
            partnership, otherEntity)
        internalId:
          type: string
          description: Internal Id of the profile.
        assignedToId:
          type: integer
          description: Id of the user assigned to the profile
        assignedTo:
          type: string
          description: Name of the user assigned to the profile
        safeNumber:
          type: string
          description: safe number of the business linked to the profile
        companyId:
          type: string
          description: company id of the business linked to the profile
        formationDate:
          type: string
          description: Formation date of the business linked to the profile
          format: date
        createdAt:
          type: string
          description: Profile created time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created the profile
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the profile
        modifiedAt:
          type: string
          description: Profile last updated time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who last modified the profile
          format: int32
        modifiedBy:
          type: string
          description: Name of the user who last modified the profile
        kycApprovedAt:
          type: string
          description: Date when the profile got approved
          format: date-time
        kycReviewOn:
          type: string
          description: Date when profile is to be reviewed
          format: date
        kycStatusUpdatedOn:
          type: string
          description: Date when the profile status was last updated
          format: date-time
        kycComments:
          type: string
          description: Profile comments
        noteCount:
          type: integer
          description: Count of notes associated with profile
          format: int32
        attachmentCount:
          type: integer
          description: Count of attachments associated with profile
          format: int32
        keyPartyCount:
          type: integer
          description: Count of key parties associated with profile
          format: int32
        uboCount:
          type: integer
          description: Count of UBOs associated with profile
          format: int32
        openAlertCount:
          type: integer
          description: Count of Open Alerts
          format: int32
        modeOfCreation:
          type: string
          description: Mode of profile creation (manual, import)
        importStatus:
          type: string
          description: >-
            Status of profile creation (submitted, preprocessed, validated,
            queued, inProgress, processed, completed, partiallyCompleted,
            failed)
        isLocked:
          type: boolean
          description: Value indicating whether the profile is locked
    GetKYCProfileTypes:
      type: array
      items:
        type: string
        example: trust
    PutKYCProfileAssign:
      type: object
      properties:
        id:
          type: string
          description: Id of the Profile
          format: uuid
        name:
          type: string
          description: Name of the Profile
        riskRating:
          type: string
          description: The risk rating being assigned to the profile
          enum:
            - notApplicable
            - veryLow
            - low
            - medium
            - high
            - veryHigh
        status:
          type: string
          description: >-
            Status of the profile (new, approved, declined, pending, cancelled,
            referred, closed, approvedReviewDue)
        type:
          type: string
          description: >-
            Type of the profile (trust, individual, soleTrader, company, plc,
            partnership, otherEntity)
        internalId:
          type: string
          description: Internal Id given to profile by customer
        assignedToId:
          type: integer
          description: Id of the user assigned to the profile
        assignedTo:
          type: string
          description: Name of the user assigned to the profile
        safeNumber:
          type: string
          description: safe number of the business linked to the profile
        companyId:
          type: string
          description: company id of the business linked to the profile
        formationDate:
          type: string
          description: Formation date of the business linked to the profile
          format: date
        createdAt:
          type: string
          description: Profile created time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created the profile
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the profile
        modifiedAt:
          type: string
          nullable: true
          description: Profile last updated time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who last modified the profile
          format: int32
        modifiedBy:
          type: string
          description: Name of the user who last modified the profile
        kycApprovedAt:
          type: string
          description: Date when the profile got approved
          format: date-time
        kycReviewOn:
          type: string
          description: Date when profile is to be reviewed
          format: date
        kycStatusUpdatedOn:
          type: string
          description: Date when the profile status was last updated
          format: date-time
        kycComments:
          type: string
          description: Profile comments
        noteCount:
          type: integer
          description: Count of notes associated with profile
          format: int32
        attachmentCount:
          type: integer
          description: Count of attachments associated with profile
          format: int32
        keyPartyCount:
          type: integer
          description: Count of key parties associated with profile
          format: int32
        uboCount:
          type: integer
          description: Count of UBOs associated with profile
          format: int32
        openAlertCount:
          type: integer
          description: Count of Open Alerts
          format: int32
        modeOfCreation:
          type: string
          description: Mode of profile creation (manual, import)
        importStatus:
          type: string
          description: >-
            Status of profile creation (submitted, preprocessed, validated,
            queued, inProgress, processed, completed, partiallyCompleted,
            failed)
        isLocked:
          type: boolean
          description: Value indicating whether the profile is locked
    GetKYCProtectProfileIdNotesResponse:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Id of the note.
              body:
                type: string
                description: Body of the note.
              isArchived:
                type: boolean
                description: Value indicating whether the note is archived.
              createdAt:
                type: string
                description: Note created time.
              createdById:
                type: number
                description: Id of the user who created note.
              createdBy:
                type: string
                description: Name of the user who created note.
              modifiedAt:
                type: string
                description: Note last updated time.
              modifiedById:
                type: number
                description: Id of the user who last modified the note.
              modifiedBy:
                type: string
                description: Name of the user who last modified the note.
              linkedTo:
                type: string
                nullable: true
                description: The profile component to which current not is linked to.
        totalSize:
          type: number
          description: The total number of notes returned for the given profileId.
        correlationId:
          type: string
          description: A unique ID assigned to this request.
    PostKYCProfileNotesRequest:
      type: object
      properties:
        body:
          type: string
          description: The body of the note to be added. Limited to 1000 characters
          nullable: true
      example:
        body: The body of the note to be added. Limited to 1000 characters
    PostKYCProfileNotes:
      type: object
      properties:
        id:
          type: string
          description: Id of the note
          format: uuid
        body:
          type: string
          nullable: true
          description: Body of the note
        isArchived:
          type: boolean
          description: Value indicating whether the note is archived
        createdAt:
          type: string
          description: Note created time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created note
          format: int32
        createdBy:
          type: string
          description: Name of the user who created note
        modifiedAt:
          type: string
          description: Note last updated time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who last modified the note
          format: int32
        modifiedBy:
          type: string
          nullable: true
          description: Name of the user who last modified the note
      example:
        id: c3966c5f-576e-4770-902b-eaab894b83d7
        body: testing
        isArchived: false
        createdAt: '2023-08-08T07:32:06.4989594Z'
        createdById: 101562008
        createdBy: Amol
        modifiedAt: '2023-08-08T07:32:06.4989594Z'
        modifiedById: 101562008
        modifiedBy: Amol
        correlationId: f447fa87-d538-4ccb-9bac-43084d840a12
    GetKYCProtectProfileIdNoteIdResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the note.
        body:
          type: string
          description: Body of the note.
        isArchived:
          type: boolean
          description: Value indicating whether the note is archived.
        createdAt:
          type: string
          description: Note created time.
        createdById:
          type: number
          description: Id of the user who created note.
        createdBy:
          type: string
          description: Name of the user who created note.
        modifiedAt:
          type: string
          description: Note last updated time.
        modifiedById:
          type: number
          description: Id of the user who last modified the note.
        modifiedBy:
          type: string
          description: Name of the user who last modified the note.
        linkedTo:
          type: string
          description: The profile component to which current not is linked to.
        correlationId:
          type: string
          description: A unique ID assigned to this request.
    PutKYCProfileNotesByNoteIdRequest:
      type: object
      properties:
        body:
          type: string
          description: The body of the note to be added. Limited to 1000 characters
          nullable: true
        isArchived:
          type: boolean
      example:
        body: testing
        isArchived: true
    PutKYCProfileNotesByNoteId:
      type: object
      properties:
        id:
          type: string
          description: Id of the note
          format: uuid
        body:
          type: string
          description: Body of the note
        isArchived:
          type: boolean
          description: Value indicating whether the note is archived
        createdAt:
          type: string
          description: Note created time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created note
          format: int32
        createdBy:
          type: string
          description: Name of the user who created note
        modifiedAt:
          type: string
          description: Note last updated time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who last modified the note
          format: int32
        modifiedBy:
          type: string
          description: Name of the user who last modified the note
    GetKYCProfileDetailsByProfileId:
      type: object
      properties:
        profileId:
          type: string
          description: Id of the profile
          format: uuid
        legalName:
          type: string
          description: Name of the business/individual
        tradingName:
          type: string
          description: Trading name of the entity
        aliases:
          type: array
          description: Alias names given for the entity
          items:
            type: string
        activity:
          type: string
          description: Activity of the business e.g., NAICS/SIC codes
        description:
          type: string
          description: Description of the entity
        contactName:
          type: string
          description: Contact person name
        email:
          type: string
          description: Contact email address
        website:
          type: string
          description: Entity website address
        telephone:
          type: string
          description: Contact telephone number
        turnover:
          type: object
          properties:
            currencyCode:
              type: string
              description: The Currency code the amount is in
            amount:
              type: number
              description: The currency code associated with this amount should be provided
              format: double
        assetsUnderManagement:
          type: object
          properties:
            currencyCode:
              type: string
              description: The Currency code the amount is in
            amount:
              type: number
              description: The currency code associated with this amount should be provided
              format: double
        dateOfBirth:
          type: string
          description: Date of birth of the individual
          format: date
        countryCode:
          type: string
          description: Two-letter country code ISO-3166-2
        vatNo:
          type: string
          description: Tax Identification Number of the business
        isListedOnExchange:
          type: boolean
          description: Details of company listed on exchange
        exchangeName:
          type: string
          description: Gets the name of the exchange.
        organizationNumber:
          type: string
          description: Gets the organisation number.
        internalContact:
          type: string
          description: Gets the internal contact.
        internalEmail:
          type: string
          description: Gets the internal email.
        internationalScore:
          type: string
          description: Gets the international score.
        createdAt:
          type: string
          description: Profile details created time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created profile
          format: int32
        createdBy:
          type: string
          description: Name of the user who created profile
        modifiedAt:
          type: string
          description: Profile details last updated time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who last modified the profile
          format: int32
        modifiedBy:
          type: string
          description: Name of the user who last modified the profile
        noteCount:
          type: integer
          description: Count of notes associated with profile details
          format: int32
        attachmentCount:
          type: integer
          description: Count of attachment associated with profile details
          format: int32
      example:
        profileId: 2770ac31-8d12-4f69-8f93-326e93cd8c34
        legalName: string
        tradingName: string
        aliases:
          - string
        activity: string
        description: string
        contactName: string
        email: string
        website: string
        telephone: string
        turnover:
          currencyCode: eur
          amount: 0
        assetsUnderManagement:
          currencyCode: eur
          amount: 0
        dateOfBirth: '2024-02-27'
        countryCode: string
        vatNo: string
        isListedOnExchange: true
        exchangeName: string
        organizationNumber: string
        internalContact: string
        internalEmail: string
        createdAt: '2023-08-07T07:12:43.331308Z'
        createdById: 101562008
        createdBy: Amol
        modifiedAt: '2023-08-08T07:16:27.734212Z'
        modifiedById: 101562008
        modifiedBy: Amol
        noteCount: 0
        attachmentCount: 2
        correlationId: 70fd7603-1f75-4de6-8e38-a3c79ac24947
    PutKYCProfileDetailsByProfileIdRequest:
      type: object
      required:
        - legalName
      properties:
        legalName:
          type: string
          description: >-
            Name of the Business or Individual<br> Maximum length is 150
            characters
          example: Creditsafe Ltd
        tradingName:
          type: string
          example: null
          description: >-
            Valid for profile type - SoleTrader<br> Maximum length is 150
            characters
        aliases:
          type: array
          description: >-
            Name of any Aliases<br> Maximum length of each alias is 150
            characters
          items:
            type: string
          example: null
        activity:
          type: string
          description: >-
            Activity of the Business e.g. NAIC S/SIC Codes<br> Valid for profile
            types - Trust, Company, Partnership, OtherEntity and PLC<br> Maximum
            length of activity is 150 characters
          example: '62409'
        description:
          type: string
          example: Example Free Text
          description: >-
            Description of the business/individual entity<br> Valid for the
            profile types Trust, Company, Partnership, OtherEntity and PLC
        contactName:
          type: string
          description: Contact person at the organisation.
          example: null
        email:
          type: string
          description: Contact email address of the entity
          example: example@creditsafe.com
        website:
          type: string
          example: www.creditsafe.com
          description: >-
            Website address of the entity<br> Valid for the profile types Trust,
            Company, Partnership, OtherEntity and PLC
        telephone:
          type: string
          example: null
          description: >-
            Telephone number of the entity.<br> Valid for the profile types
            Trust, Company, Partnership, OtherEntity and PLC
        turnover:
          type: object
          properties:
            currencyCode:
              type: string
              description: The currency code the amount is in
              enum:
                - eur
                - gbp
                - usd
                - cny
                - cad
                - aud
                - nzd
                - inr
                - jpy
                - chf
                - zar
                - dkk
                - sek
                - nok
            amount:
              description: Total Turnover Figure
              type: integer
        assetsUnderManagement:
          type: object
          properties:
            currencyCode:
              type: string
              description: The currency code the amount is in
              enum:
                - eur
                - gbp
                - usd
                - cny
                - cad
                - aud
                - nzd
                - inr
                - jpy
                - chf
                - zar
                - dkk
                - sek
                - nok
            amount:
              type: integer
              description: The total value of the assets under management
        organizationNumber:
          type: string
          description: >-
            Property valid for profile type - Trust, Company, Partnership,
            OtherEntity and PLC
          example: '12345678'
        internalContact:
          type: string
          description: >-
            Internal contact name to contact regarding this profile,<br>
            Property valid for profile type - Trust, Company, Partnership,
            OtherEntity and PLC.
          example: null
        internalEmail:
          type: string
          description: >-
            Internal email address to contact regarding this profile.<br>
            Property valid for profile type - Trust, Company, Partnership,
            OtherEntity and PLC
          example: null
        dateOfBirth:
          type: string
          format: date
          example: '2024-03-25'
          description: >-
            Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the
            future<br> Valid for the profile types Individual and SoleTrader
        countryCode:
          type: string
          example: GB
          description: >-
            Two-letter country code ISO-3166-2.<br> Valid for the profile types
            Individual and SoleTrader
        vatNo:
          type: string
          example: GB12345678
          description: >-
            Tax Identification Number of the business<br> Valid for the profile
            types Company, Partnership, OtherEntity and PLC
        isListedOnExchange:
          type: boolean
          description: Property valid for profile type PLC
          example: null
        exchangeName:
          type: string
          description: Property valid for profile type PLC
          example: null
    PutKYCProfileDetailsByProfileId:
      type: object
      properties:
        profileId:
          type: string
          description: Id of the profile
          format: uuid
        legalName:
          type: string
          description: Name of the business/individual
        tradingName:
          type: string
          description: Trading name of the entity
        aliases:
          type: array
          description: Alias names given for the entity
          items:
            type: string
        activity:
          type: string
          description: Activity of the business e.g., NAICS/SIC codes
        description:
          type: string
          description: Description of the entity
        contactName:
          type: string
          description: Contact person name
        email:
          type: string
          description: Contact email address
        website:
          type: string
          description: Entity website address
        telephone:
          type: string
          description: Contact telephone number
        turnover:
          type: object
          properties:
            currencyCode:
              type: string
              description: The Currency code the amount is in
            amount:
              type: number
              description: The currency code associated with this amount should be provided
              format: double
        assetsUnderManagement:
          type: object
          properties:
            currencyCode:
              type: string
              description: The Currency code the amount is in
            amount:
              type: number
              description: The currency code associated with this amount should be provided
              format: double
        dateOfBirth:
          type: string
          description: Date of birth of the individual
          format: date
        countryCode:
          type: string
          description: Two-letter country code ISO-3166-2
        vatNo:
          type: string
          description: Tax Identification Number of the business
        isListedOnExchange:
          type: boolean
          description: Details of company listed on exchange
        exchangeName:
          type: string
          description: Gets the name of the exchange.
        organizationNumber:
          type: string
          description: Gets the organisation number.
        internalContact:
          type: string
          description: Gets the internal contact.
        internalEmail:
          type: string
          description: Gets the internal email.
        internationalScore:
          type: string
          description: Gets the international score.
        createdAt:
          type: string
          description: Profile details created time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created profile
          format: int32
        createdBy:
          type: string
          description: Name of the user who created profile
        modifiedAt:
          type: string
          description: Profile details last updated time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who last modified the profile
          format: int32
        modifiedBy:
          type: string
          description: Name of the user who last modified the profile
        noteCount:
          type: integer
          description: Count of notes associated with profile details
          format: int32
        attachmentCount:
          type: integer
          description: Count of attachment associated with profile details
          format: int32
    KycProtectProfileGetDetailsAddressResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the address
          format: uuid
        buildingDetails:
          type: string
          description: Building details of the address
        street:
          type: string
          description: Street of the address
        city:
          type: string
          description: City of the address
        region:
          type: string
          description: Region of the address
        postalCode:
          type: string
          description: Postalcode of the address
        countryCode:
          type: string
          description: Two-letter country code ISO-3166-2
        type:
          type: string
          description: Type of the address (registered, trading, other)
        description:
          type: string
          description: Description of the address
        createdAt:
          type: string
          description: Address created date time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created the Address
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the Address
        modifiedAt:
          type: string
          description: Address last updated date time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who last modified the Address
          format: int32
        modifiedBy:
          type: string
          description: Name of the user who last modified the Address
    KycProtectProfileAddressResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the address
          format: uuid
        buildingDetails:
          type: string
          description: Building details of the address
          nullable: true
        street:
          type: string
          description: Street of the address
          nullable: true
        city:
          type: string
          description: City of the address
          nullable: true
        region:
          type: string
          description: Region of the address
          nullable: true
        postalCode:
          type: string
          description: Postalcode of the address
          nullable: true
        countryCode:
          type: string
          description: Two-letter country code ISO-3166-2
          nullable: true
        type:
          type: string
          description: Type of the address (registered, trading, other)
        description:
          type: string
          description: Description of the address
          nullable: true
        createdAt:
          type: string
          description: Address created date time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created the Address
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the Address
        modifiedAt:
          type: string
          description: Address last updated date time
          format: date-time
          nullable: true
        modifiedById:
          type: integer
          description: Id of the user who last modified the Address
          format: int32
          nullable: true
        modifiedBy:
          type: string
          description: Name of the user who last modified the Address
          nullable: true
    GetKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUser:
      type: object
      properties:
        id:
          type: string
          description: The id of the address.
          format: uuid
        buildingDetails:
          type: string
          description: >-
            The building details of the address being created. Must have a
            maximum length of 250 characters.
        street:
          type: string
          description: >-
            The street of the address being created. Must have a maximum length
            of 250 characters.
        city:
          type: string
          description: >-
            The city of the address being created. Must have a maximum length of
            250 characters.
        region:
          type: string
          description: >-
            The region of the address being created. Must have a maximum length
            of 250 characters.
        postalCode:
          type: string
          description: >-
            The postal code of the address being created. Must have a maximum
            length of 50 characters.
        countryCode:
          type: string
          description: The country code of the address being created.
        type:
          type: string
          description: The type of the address.
          enum:
            - registered
            - trading
            - other
        description:
          type: string
          description: >-
            The description of the address being created. Must have a maximum
            length of 250 characters.
        createdAt:
          type: string
          description: Address created date time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created the Address
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the Address
        modifiedAt:
          type: string
          description: Address last updated date time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who last modified the Address
          format: int32
        modifiedBy:
          type: string
          description: Name of the user who last modified the Address
    UpdateKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUserRequest:
      type: object
      properties:
        buildingDetails:
          type: string
          description: >-
            The building details of the address being created. Must have a
            maximum length of 250 characters.
        street:
          type: string
          description: >-
            The street of the address being created. Must have a maximum length
            of 250 characters.
        city:
          type: string
          description: >-
            The city of the address being created. Must have a maximum length of
            250 characters.
        region:
          type: string
          description: >-
            The region of the address being created. Must have a maximum length
            of 250 characters.
        postalCode:
          type: string
          description: >-
            The postal code of the address being created. Must have a maximum
            length of 50 characters.
        countryCode:
          type: string
          description: The country code of the address being created.
        type:
          type: string
          description: The type of the address.
          enum:
            - registered
            - trading
            - other
        description:
          type: string
          description: >-
            The description of the address being created. Must have a maximum
            length of 250 characters.
    PutKYCAddressDetailsByTheGivenAddressIdForTheSuppliedProfileIdUser:
      type: object
      properties:
        id:
          type: string
          description: Id of the address
          format: uuid
        buildingDetails:
          type: string
          description: Building details of the address
        street:
          type: string
          description: Street of the address
        city:
          type: string
          description: City of the address
        region:
          type: string
          description: Region of the address
        postalCode:
          type: string
          description: Postalcode of the address
        countryCode:
          type: string
          description: Two-letter country code ISO-3166-2
        type:
          type: string
          description: Type of the address (registered, trading, other)
        description:
          type: string
          description: Description of the address
        createdAt:
          type: string
          description: Address created date time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created the Address
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the Address
        modifiedAt:
          type: string
          description: Address last updated date time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who last modified the Address
          format: int32
        modifiedBy:
          type: string
          description: Name of the user who last modified the Address
    GetKeyPartiesResponseByProfileIdItemsAddressResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the address
          format: uuid
        buildingDetails:
          type: string
          description: Building details of the address
          nullable: true
        street:
          type: string
          description: Street of the address
          nullable: true
        city:
          type: string
          description: City of the address
          nullable: true
        region:
          type: string
          description: Region of the address
          nullable: true
        postalCode:
          type: string
          description: Postalcode of the address
          nullable: true
        countryCode:
          type: string
          description: Two-letter country code ISO-3166-2
          nullable: true
        type:
          type: string
          description: >-
            Type of the address. Available values are registered, trading and
            other.
        description:
          type: string
          description: Description of the address
          nullable: true
        createdAt:
          type: string
          description: Address created date time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created the Address
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the Address
        modifiedAt:
          type: string
          description: Address last updated date time
          format: date-time
          nullable: true
        modifiedById:
          type: integer
          description: Id of the user who last modified the Address
          format: int32
          nullable: true
        modifiedBy:
          type: string
          description: Name of the user who last modified the Address
          nullable: true
    GetKeyPartiesResponseByProfileIdItems:
      type: object
      properties:
        id:
          type: string
          description: Id of the key party
          format: uuid
        name:
          type: string
          description: Name of the key party
        firstName:
          type: string
          description: First name of the key party
        middleName:
          type: string
          description: Middle name of the key party
          nullable: true
        lastName:
          type: string
          description: Last name of the key party
        entityType:
          type: string
          description: >-
            Entity type of the key party. Avaialable values are individual and
            business.
        keyPartyType:
          type: string
          description: >-
            Type of the key party. Available values are director, shareHolder
            and ubo.
        gender:
          type: string
          description: Gender of the key party. Available values are male and female.
          nullable: true
        dateOfBirth:
          type: string
          description: Date of birth of the key party
          format: date
          nullable: true
        organisationNumber:
          type: string
          description: Key party organization number
          nullable: true
        activityCode:
          type: string
          description: Activity code of the key party
          nullable: true
        percentageOfShares:
          type: number
          description: Share percentage of the key party
          format: double
          nullable: true
        role:
          type: string
          description: Role of the key party
          nullable: true
        countryCode:
          type: string
          description: Country code of the key party
          nullable: true
        address:
          $ref: >-
            #/components/schemas/GetKeyPartiesResponseByProfileIdItemsAddressResponse
        searchId:
          type: string
          description: Search Id of the key party
          format: uuid
          nullable: true
        createdAt:
          type: string
          description: Key party created time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created the key party
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the key party
        modifiedAt:
          type: string
          description: key party last updated time
          format: date-time
          nullable: true
        modifiedById:
          type: integer
          description: Id of the user who last modified the key party
          format: int32
          nullable: true
        modifiedBy:
          type: string
          description: Name of the user who last modified the key party
          nullable: true
    GetKeyPartiesResponseByProfileId:
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/GetKeyPartiesResponseByProfileIdItems'
        totalSize:
          type: integer
          format: int64
    PutKYCKeypartiesByProfileIdRequest:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            required:
              - keyPartyId
            properties:
              name:
                type: string
                description: Name of the key party Maximum length is 200 characters
                nullable: true
              firstName:
                type: string
                description: >-
                  First name of the key party <br> Valid for only entity type
                  Individual <br> Maximum length is 200 characters combining
                  First name, Middle name and Last name
                nullable: true
              middleName:
                type: string
                description: >-
                  Middle name of the key party <br> Valid for only entity type
                  Individual <br> Maximum length is 200 characters combining
                  First name, Middle name and Last name
                nullable: true
              lastName:
                type: string
                description: >-
                  Last name of the key party <br> Valid for only entity type
                  Individual <br> Maximum length is 200 characters combining
                  First name, Middle name and Last name
                nullable: true
              gender:
                type: string
                description: >-
                  Gender of the key party Valid for entity type Individual, male
                  , female.
                nullable: true
              dateOfBirth:
                type: string
                description: >-
                  Date of birth of the key party Date YYYY-MM-DD or YYYY format.
                  Must be after 1900 and not in the future Valid for the entity
                  type Individual
                nullable: true
              organisationNumber:
                type: string
                description: >-
                  Key party organisation number <br> Valid for entity type
                  Business
                nullable: true
              activityCode:
                type: string
                description: >-
                  Activity code of the key party <br> Valid for entity type
                  Business
                nullable: true
              percentageOfShares:
                type: number
                description: >-
                  Share percentage of the key party <br> Valid for key party
                  type ShareHolder
                nullable: true
              role:
                type: string
                description: Role of the key party <br> Valid for key party type Director
                nullable: true
              countryCode:
                type: string
                description: Country code of the key party
                nullable: true
              keyPartyId:
                type: string
                description: The Id of the key party to be updated
                nullable: true
              address:
                type: object
                required:
                  - type
                properties:
                  buildingDetails:
                    type: string
                    description: >-
                      The building details of the address being created. Must
                      have a maximum length of 250 characters
                    nullable: true
                  street:
                    type: string
                    description: >-
                      The street of the address being created. Must have a
                      maximum length of 250 characters
                    nullable: true
                  city:
                    type: string
                    description: >-
                      The city of the address being created. Must have a maximum
                      length of 250 characters
                    nullable: true
                  region:
                    type: string
                    description: >-
                      The region of the address being created. Must have a
                      maximum length of 250 characters
                    nullable: true
                  postalCode:
                    type: string
                    description: >-
                      The postal code of the address being created Must have a
                      maximum length of 50 characters
                    nullable: true
                  countryCode:
                    type: string
                    description: Two-letter ISO-3166-2 country code
                    nullable: true
                  type:
                    type: string
                    description: Type of the address, registered, trading, other
                    nullable: true
                  description:
                    type: string
                    description: >-
                      The description of the address being created Must have a
                      maximum length of 250 characters
                    nullable: true
    PutKYCKeypartiesByProfileIdAddressContract:
      required:
        - type
      type: object
      properties:
        buildingDetails:
          type: string
          description: "The building details of the address being created.\r\nMust have a maximum length of 250 characters"
          nullable: true
        street:
          type: string
          description: "The street of the address being created.\r\nMust have a maximum length of 250 characters"
          nullable: true
        city:
          type: string
          description: "The city of the address being created.\r\nMust have a maximum length of 250 characters"
          nullable: true
        region:
          type: string
          description: "The region of the address being created.\r\nMust have a maximum length of 250 characters"
          nullable: true
        postalCode:
          type: string
          description: "The postal code of the address being created.\r\nMust have a maximum length of 50 characters"
          nullable: true
        countryCode:
          type: string
          description: The country code of the address being created.
          nullable: true
        type:
          type: string
          description: >-
            The country code of the address being created.registered,
            trading,other
        description:
          type: string
          description: "The description of the address being created.\r\nMust have a maximum length of 250 characters"
          nullable: true
    PutKYCKeypartiesByProfileIdFailedContractResponse:
      type: object
      properties:
        name:
          type: string
          description: "Name of the key party\r\nMaximum length is 200 characters"
          nullable: true
        firstName:
          type: string
          description: "First name of the key party\r\n<br> Valid for only entity type Individual <br> Maximum length is 200 characters combining First name, Middle name and Last name"
          nullable: true
        middleName:
          type: string
          description: "Middle name of the key party\r\n<br> Valid for only entity type Individual <br> Maximum length is 200 characters combining First name, Middle name and Last name"
          nullable: true
        lastName:
          type: string
          description: "Last name of the key party\r\n<br> Valid for only entity type Individual <br> Maximum length is 200 characters combining First name, Middle name and Last name"
          nullable: true
        gender:
          type: string
          description: "Gender of the key party\r\nValid for entity type Individual, male, female"
          nullable: true
        dateOfBirth:
          type: string
          description: "Date of birth of the key party\r\nDate YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future\r\n<br> Valid for the entity type Individual "
          format: date
          nullable: true
        organisationNumber:
          type: string
          description: "<br> Key party organisation number \r\n<br> Valid for entity type Business "
          nullable: true
        activityCode:
          type: string
          description: "Activity code of the key party\r\n<br> Valid for entity type Business "
          nullable: true
        percentageOfShares:
          type: number
          description: "Share percentage of the key party\r\n<br> Valid for key party type ShareHolder "
          format: double
          nullable: true
        role:
          type: string
          description: "Role of the key party\r\n<br> Valid for key party type Director "
          nullable: true
        countryCode:
          type: string
          description: Country code of the key party
          nullable: true
        address:
          $ref: '#/components/schemas/PutKYCKeypartiesByProfileIdAddressContract'
        keyPartyId:
          type: string
          description: The Id of the key party to be updated
          format: uuid
    KycProtectErrorObject:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: number
        detail:
          type: string
        instance:
          type: string
        additionalProp1:
          type: string
        additionalProp2:
          type: string
        additionalProp3:
          type: string
    PutKYCKeypartiesByProfileIdFailedResponse:
      type: object
      properties:
        failedItem:
          $ref: >-
            #/components/schemas/PutKYCKeypartiesByProfileIdFailedContractResponse
        error:
          $ref: '#/components/schemas/KycProtectErrorObject'
    PostKYCKeypartiesByProfileIdAddressContractResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the address
          format: uuid
        buildingDetails:
          type: string
          description: Building details of the address
          nullable: true
        street:
          type: string
          description: Street of the address
          nullable: true
        city:
          type: string
          description: City of the address
          nullable: true
        region:
          type: string
          description: Region of the address
          nullable: true
        postalCode:
          type: string
          description: Postalcode of the address
          nullable: true
        countryCode:
          type: string
          description: Two-letter country code ISO-3166-2
          nullable: true
        type:
          type: string
          description: Type of the address,registered,trading, other
        description:
          type: string
          description: Description of the address
          nullable: true
        createdAt:
          type: string
          description: Address created date time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created the Address
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the Address
        modifiedAt:
          type: string
          description: Address last updated date time
          format: date-time
          nullable: true
        modifiedById:
          type: integer
          description: Id of the user who last modified the Address
          format: int32
          nullable: true
        modifiedBy:
          type: string
          description: Name of the user who last modified the Address
          nullable: true
    PostKYCKeypartiesByProfileIdResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the key party
          format: uuid
        name:
          type: string
          description: Name of the key party
        firstName:
          type: string
          description: First name of the key party
        middleName:
          type: string
          description: Middle name of the key party
          nullable: true
        lastName:
          type: string
          description: Last name of the key party
        entityType:
          type: string
          description: Entity type of the key party, individual, business
        keyPartyType:
          type: string
          description: Type of the key party, director,shareHolder,ubo
        gender:
          type: string
          description: Gender of the key party, male, female
          nullable: true
        dateOfBirth:
          type: string
          description: Date of birth of the key party
          format: date
          nullable: true
        organisationNumber:
          type: string
          description: Key party organization number
          nullable: true
        activityCode:
          type: string
          description: Activity code of the key party
          nullable: true
        percentageOfShares:
          type: number
          description: Share percentage of the key party
          format: double
          nullable: true
        role:
          type: string
          description: Role of the key party
          nullable: true
        countryCode:
          type: string
          description: Country code of the key party
          nullable: true
        address:
          $ref: >-
            #/components/schemas/PostKYCKeypartiesByProfileIdAddressContractResponse
        searchId:
          type: string
          description: Search Id of the key party
          format: uuid
          nullable: true
        createdAt:
          type: string
          description: Key party created time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created the key party
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the key party
        modifiedAt:
          type: string
          description: key party last updated time
          format: date-time
          nullable: true
        modifiedById:
          type: string
          description: Id of the user who last modified the key party
          format: int32
          nullable: true
        modifiedBy:
          type: string
          description: Name of the user who last modified the key party
          nullable: true
    PostKYCKeypartiesByProfileIdRequest:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: Name of the key party<br> Maximum length is 200 characters
                nullable: true
              firstName:
                type: string
                description: >-
                  First name of the key party <br> Valid for entity type
                  Individual <br> Maximum length is 200 characters combining
                  First name, Middle name and Last name
                nullable: true
              middleName:
                type: string
                description: >-
                  Middle name of the key party <br> Valid for entity type
                  Individual <br> Maximum length is 200 characters combining
                  First name, Middle name and Last name
                nullable: true
              lastName:
                type: string
                description: >-
                  Last name of the key party <br> Valid for entity type
                  Individual <br> Maximum length is 200 characters combining
                  First name, Middle name and Last name
                nullable: true
              entityType:
                type: string
                description: Entity type of the key party <br> Types - individual, business
                nullable: true
              keyPartyType:
                type: string
                description: >-
                  Entity type of the key party<br> Types - director,
                  shareHolder, ubo
                nullable: true
              gender:
                type: string
                description: Gender of the key party<br> Valid for entity type Individual
                enum:
                  - male
                  - female
                nullable: true
              dateOfBirth:
                type: string
                description: >-
                  Date of birth of the key party Date YYYY-MM-DD or YYYY format.
                  Must be after 1900 and not in the future Valid for the entity
                  type Individual
                nullable: true
              organisationNumber:
                type: string
                description: >-
                  Key party organisation number <br> Valid for entity type
                  Business
                nullable: true
              activityCode:
                type: string
                description: >-
                  Activity code of the key party <br> Valid for entity type
                  Business
                nullable: true
              percentageOfShares:
                type: number
                description: >-
                  Share percentage of the key party <br> Valid for key party
                  type ShareHolder
                nullable: true
              role:
                type: string
                description: Role of the key party <br> Valid for key party type Director
                nullable: true
              countryCode:
                type: string
                description: Country code of the key party
                nullable: true
              address:
                type: object
                required:
                  - type
                properties:
                  buildingDetails:
                    type: string
                    description: >-
                      The building details of the address being created. Must
                      have a maximum length of 250 characters
                    nullable: true
                  street:
                    type: string
                    description: >-
                      The street of the address being created. Must have a
                      maximum length of 250 characters
                    nullable: true
                  city:
                    type: string
                    description: >-
                      The city of the address being created. Must have a maximum
                      length of 250 characters
                    nullable: true
                  region:
                    type: string
                    description: >-
                      The region of the address being created. Must have a
                      maximum length of 250 characters
                    nullable: true
                  postalCode:
                    type: string
                    description: >-
                      The postal code of the address being created Must have a
                      maximum length of 50 characters
                    nullable: true
                  countryCode:
                    type: string
                    description: Two-letter ISO-3166-2 country code
                    nullable: true
                  type:
                    type: string
                    description: Type of the address, registered, trading, other
                    nullable: true
                  description:
                    type: string
                    description: >-
                      The description of the address being created Must have a
                      maximum length of 250 characters
                    nullable: true
    PostKYCKeypartiesByProfileIdAddressRequestContractResponse:
      type: object
      properties:
        buildingDetails:
          type: string
          description: "The building details of the address being created.\r\nMust have a maximum length of 250 characters"
          nullable: true
        street:
          type: string
          description: "The street of the address being created.\r\nMust have a maximum length of 250 characters"
          nullable: true
        city:
          type: string
          description: "The city of the address being created.\r\nMust have a maximum length of 250 characters"
          nullable: true
        region:
          type: string
          description: "The region of the address being created.\r\nMust have a maximum length of 250 characters"
          nullable: true
        postalCode:
          type: string
          description: "The postal code of the address being created\r\nMust have a maximum length of 50 characters"
          nullable: true
        countryCode:
          type: string
          description: Two-letter ISO-3166-2 country code
          nullable: true
        type:
          type: string
          description: Type of address, registered,trading, other
          nullable: true
        description:
          type: string
          description: "The description of the address being created\r\nMust have a maximum length of 250 characters"
          nullable: true
    PostKYCKeypartiesByProfileIdFailedAddKeyPartyContractResponse:
      type: object
      properties:
        name:
          type: string
          description: "Name of the key party\r\nMaximum length is 200 characters"
          nullable: true
        firstName:
          type: string
          description: "First name of the key party\r\n<br> Valid for only entity type Individual <br> Maximum length is 200 characters combining First name, Middle name and Last name"
          nullable: true
        middleName:
          type: string
          description: "Middle name of the key party\r\n<br> Valid for only entity type Individual <br> Maximum length is 200 characters combining First name, Middle name and Last name"
          nullable: true
        lastName:
          type: string
          description: "Last name of the key party\r\n<br> Valid for only entity type Individual <br> Maximum length is 200 characters combining First name, Middle name and Last name"
          nullable: true
        entityType:
          type: string
          description: Entity type of the key party, individual, business
          nullable: true
        keyPartyType:
          type: string
          description: "Type of the key party\r\n<br> Valid Key Party types for entity type Individual are Director, Ubo and ShareHolder <br> Valid Key Party types for entity type Business are Ubo and ShareHolder , director, shareHolder, ubo"
          nullable: true
        gender:
          type: string
          description: "Gender of the key party\r\nValid for entity type Individual, male, female"
          nullable: true
        dateOfBirth:
          type: string
          description: "Date of birth of the key party\r\nDate YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future\r\n<br> Valid for the entity type Individual "
          format: date
          nullable: true
        organisationNumber:
          type: string
          description: "<br> Key party organisation number \r\n<br> Valid for entity type Business "
          nullable: true
        activityCode:
          type: string
          description: "Activity code of the key party\r\n<br> Valid for entity type Business "
          nullable: true
        percentageOfShares:
          type: number
          description: "Share percentage of the key party\r\n<br> Valid for key party type ShareHolder "
          format: double
          nullable: true
        role:
          type: string
          description: "Role of the key party\r\n<br> Valid for key party type Director "
          nullable: true
        countryCode:
          type: string
          description: Country code of the key party
          nullable: true
        address:
          $ref: >-
            #/components/schemas/PostKYCKeypartiesByProfileIdAddressRequestContractResponse
    PostKYCKeypartiesByProfileIdFailedResponse:
      type: object
      properties:
        failedItem:
          $ref: >-
            #/components/schemas/PostKYCKeypartiesByProfileIdFailedAddKeyPartyContractResponse
        error:
          $ref: '#/components/schemas/KycProtectErrorObject'
    DeleteKeyPartiesResponseByProfileIdFailedObjectResponse:
      type: object
      properties:
        failedItem:
          type: string
          format: uuid
    DeleteKeyPartiesResponseByProfileId:
      type: object
      properties:
        failed:
          type: array
          items:
            $ref: >-
              #/components/schemas/DeleteKeyPartiesResponseByProfileIdFailedObjectResponse
        successful:
          type: array
          items:
            type: string
            format: uuid
    GetKeyPartySearchResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the search
          format: uuid
        name:
          type: string
          description: Name provided for the search. Length must not exceed 200 characters
          nullable: true
        countryCodes:
          type: array
          items:
            type: string
          description: Countries provided to the search
          nullable: true
        threshold:
          type: integer
          description: Hits with scores below this value will not be shown.
          format: int32
        type:
          type: string
          description: Indicates whether search type is individual or business
        datasets:
          type: array
          items:
            type: string
          description: Provided datasets for the search
        status:
          type: string
          description: >-
            Status of the search, i.e. new, approved, declined, pending,
            cancelled, referred, closed
        riskRating:
          type: string
          description: >-
            Risk associated with the search, i.e. notApplicable, veryLow, low,
            medium, high, veryHigh
        assignedToUserId:
          type: integer
          description: Id of the user assigned to the search
          format: int32
          nullable: true
        assignedUser:
          type: string
          description: Name of the user assigned to the search
          nullable: true
        createdById:
          type: integer
          description: Id of the user who created the search
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the search
        createdAt:
          type: string
          description: Search created date time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who modified the search
          format: int32
        modifiedBy:
          type: string
          description: Name of the user who modified the search
        modifiedAt:
          type: string
          description: Search modified date time
          format: date-time
        note:
          type: string
          description: Note associated with the search
          nullable: true
        scheduleId:
          type: string
          description: Schedule Id linked to the search
          format: uuid
          nullable: true
        totalHitCount:
          type: integer
          description: Total number of hits in the search
          format: int32
        truePositiveHitsCount:
          type: integer
          description: The number of true-positive hits in the search
          format: int32
        falsePositiveHitsCount:
          type: integer
          description: The number of false-positive hits in the search
          format: int32
        undecidedHitsCount:
          type: integer
          description: The number of undecided hits in the search
          format: int32
        firstName:
          type: string
          description: >-
            First name of individual provided in the search. The combination of
            first name, middle name, and last name must not exceed 200
            characters
          nullable: true
        middleName:
          type: string
          description: >-
            Middle name of individual provided in the search. The combination of
            first name, middle name, and last name must not exceed 200
            characters
          nullable: true
        lastName:
          type: string
          description: >-
            Last name of individual provided in the search. The combination of
            first name, middle name, and last name must not exceed 200
            characters
          nullable: true
        gender:
          type: string
          description: Gender of individual provided in the search. i.e. male. female
          nullable: true
        dateOfBirth:
          type: string
          description: DOB of individual provided in the search
          format: date
          nullable: true
        pepTiers:
          type: array
          items:
            type: string
          description: >-
            Pep Tiers provided in the search of individual, i.e. pepTier1.
            pepTier2, pepTier3
          nullable: true
        keyPartyId:
          type: string
          description: Id of the key party
          format: uuid
        keyPartyType:
          type: string
          description: Type of key party, i.e. director, shareHolder, ubo
        isDobRequired:
          type:
            - boolean
            - 'null'
          description: >-
            Indicates whether date of birth is required for the individual
            search.
          default: true
    DeleteKeyPartySearchContractRequest:
      type: object
      properties:
        items:
          type: array
          description: Array of objects containing key party and search IDs.
          items:
            type: object
            properties:
              keyPartyId:
                type: string
                description: Key party Id of the linked search.
                format: uuid
              searchId:
                type: string
                description: Search Id of the linked key party.
                format: uuid
    DeleteKeyPartiesResponseByProfileIdFailedObjectResponseError:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
    DeleteKeyPartySearchContractResponse:
      type: object
      properties:
        failed:
          type: array
          items:
            type: object
            properties:
              failedItem:
                type: object
                properties:
                  keyPartyId:
                    type: string
                    description: key party Id of the linked search
                    format: uuid
                  searchId:
                    type: string
                    description: search Id of the linked key party
                    format: uuid
              error:
                type: object
                properties:
                  type:
                    type: string
                    nullable: true
                  title:
                    type: string
                    nullable: true
                  status:
                    type: integer
                    format: int32
                    nullable: true
                  detail:
                    type: string
                    nullable: true
                  instance:
                    type: string
                    nullable: true
          nullable: true
        successful:
          type: array
          nullable: true
          items:
            type: object
            properties:
              keyPartyId:
                type: string
                description: key party Id of the linked search
                format: uuid
              searchId:
                type: string
                description: search Id of the linked key party
                format: uuid
        error:
          $ref: >-
            #/components/schemas/DeleteKeyPartiesResponseByProfileIdFailedObjectResponseError
    AddKeyPartySearchContract:
      type: object
      properties:
        type:
          type: string
          description: >-
            The entity type of the search. Available values are individual and
            business.
        name:
          type: string
          description: Required if FirstName and LastName are not provided
          nullable: true
        firstName:
          type: string
          description: If FirstName is provided then LastName must also be provided
          nullable: true
        middleName:
          type: string
          description: >-
            Middle name is optional, valid along with Firstname and LastName
            only
          nullable: true
        lastName:
          type: string
          description: If LastName is provided then FirstName must also be provided
          nullable: true
        dateOfBirth:
          type: string
          description: >-
            Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the
            future.
          format: date
          nullable: true
        gender:
          type: string
          description: Define the gender of the individual you are searching for.
          nullable: true
        pepTiers:
          type: array
          items:
            type: string
          description: >-
            When searching the PEP dataset, define what tiers of the PEP
            profiles should be included in the results. Where PEP Tier 1
            indicates senior roles, PEP Tier 2 - middle-ranking, and PEP Tier 3
            - junior officials. If the PEP Dataset is NOT included on the list
            of searched datasets, then this value is ignored. The PEP Tier
            filter does not apply to PEP-LINKED Profiles.
          nullable: true
        datasets:
          type: array
          items:
            type: string
          description: >-
            UPDATE THIS SO IT DETAILS BOT INDIVIDUALS AND BUSINESSES Specifies
            which datasets will be searched PEP - Politically Exposed Persons
            (All) PEP-CURRENT - Only current PEPs PEP-FORMER - Only former PEPs
            PEP-LINKED - Only linked PEPs (PEP by Association) SAN - Sanctioned
            (All) SAN-CURRENT - Only current Sanctions SAN-FORMER - Only former
            Sanctions INS - Insolvency AM - Averse Media POI - Profile of
            Interest ENF - Enforcement DD - Disqualified Director
          nullable: true
        countryCodes:
          type: array
          items:
            type: string
          nullable: true
        threshold:
          type: integer
          description: Must be one of 75, 80, 85, 90, 95, or 100
          format: int32
        keyPartyId:
          type: string
          format: uuid
    PostKYCKeypartiesSearchesLinkByProfileIdResponse:
      type: object
      properties:
        failed:
          type: array
          items:
            type: object
            properties:
              failedItem:
                type: object
                properties:
                  keyPartyId:
                    type: string
                    description: Id of the key party to link to the search
                  searchId:
                    type: string
                    description: Id of the search to link to the key party
              error:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: number
                  detail:
                    type: string
                  instance:
                    type: string
                  additionalProp1:
                    type: string
                  additionalProp2:
                    type: string
                  additionalProp3:
                    type: string
        successful:
          type: array
          items:
            type: object
            properties:
              keyPartyId:
                type: string
                description: Id of the key party to link to the search
              searchId:
                type: string
                description: Id of the search to link to the key party
    UpdateKeyPartyById:
      type: object
      properties:
        name:
          type: string
          description: "Name of the key party\r\nMaximum length is 200 characters"
          nullable: true
        firstName:
          type: string
          description: "First name of the key party\r\n<br> Valid for only entity type Individual <br> Maximum length is 200 characters combining First name, Middle name and Last name"
          nullable: true
        middleName:
          type: string
          description: "Middle name of the key party\r\n<br> Valid for only entity type Individual <br> Maximum length is 200 characters combining First name, Middle name and Last name"
          nullable: true
        lastName:
          type: string
          description: "Last name of the key party\r\n<br> Valid for only entity type Individual <br> Maximum length is 200 characters combining First name, Middle name and Last name"
          nullable: true
        gender:
          type: string
          description: "Gender of the key party\r\nValid for entity type Individual (male, female)"
          nullable: true
        dateOfBirth:
          type: string
          description: "Date of birth of the key party\r\nDate YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future\r\n<br> Valid for the entity type Individual "
          format: date
          nullable: true
        organisationNumber:
          type: string
          description: "<br> Key party organisation number \r\n<br> Valid for entity type Business "
          nullable: true
        activityCode:
          type: string
          description: "Activity code of the key party\r\n<br> Valid for entity type Business "
          nullable: true
        percentageOfShares:
          type: number
          description: "Share percentage of the key party\r\n<br> Valid for key party type ShareHolder "
          format: double
          nullable: true
        role:
          type: string
          description: "Role of the key party\r\n<br> Valid for key party type Director "
          nullable: true
        countryCode:
          type: string
          description: Country code of the key party
          nullable: true
        address:
          type: object
          properties:
            buildingDetails:
              type: string
              description: "The building details of the address being created.\r\nMust have a maximum length of 250 characters"
              nullable: true
            street:
              type: string
              description: "The street of the address being created.\r\nMust have a maximum length of 250 characters"
              nullable: true
            city:
              type: string
              description: "The city of the address being created.\r\nMust have a maximum length of 250 characters"
              nullable: true
            region:
              type: string
              description: "The region of the address being created.\r\nMust have a maximum length of 250 characters"
              nullable: true
            postalCode:
              type: string
              description: "The postal code of the address being created.\r\nMust have a maximum length of 50 characters"
              nullable: true
            countryCode:
              type: string
              description: The country code of the address being created.
              nullable: true
            type:
              type: string
              description: 'Allowed values: registered, trading, other'
              nullable: true
            description:
              type: string
              description: "The description of the address being created.\r\nMust have a maximum length of 250 characters"
              nullable: true
    KeyPartyByIdReturn:
      type: object
      properties:
        id:
          type: string
          description: Id of the key party
          format: uuid
        name:
          type: string
          description: Name of the key party
        firstName:
          type: string
          description: First name of the key party
        middleName:
          type: string
          description: Middle name of the key party
          nullable: true
        lastName:
          type: string
          description: Last name of the key party
        entityType:
          type: string
          description: Entity type of the key party, i.e. individual, business
        keyPartyType:
          type: string
          description: Type of the key party, i.e. director, shareHolder, ubo
        gender:
          type: string
          description: Gender of the key party, i.e. male, female
          nullable: true
        dateOfBirth:
          type: string
          description: Date of birth of the key party
          format: date
          nullable: true
        organisationNumber:
          type: string
          description: Key party organization number
          nullable: true
        activityCode:
          type: string
          description: Activity code of the key party
          nullable: true
        percentageOfShares:
          type: number
          description: Share percentage of the key party
          format: double
          nullable: true
        role:
          type: string
          description: Role of the key party
          nullable: true
        countryCode:
          type: string
          description: Country code of the key party
          nullable: true
        address:
          properties:
            id:
              type: string
              description: Id of the address
              format: uuid
            buildingDetails:
              type: string
              description: Building details of the address
              nullable: true
            street:
              type: string
              description: Street of the address
              nullable: true
            city:
              type: string
              description: City of the address
              nullable: true
            region:
              type: string
              description: Region of the address
              nullable: true
            postalCode:
              type: string
              description: Postalcode of the address
              nullable: true
            countryCode:
              type: string
              description: Two-letter country code ISO-3166-2
              nullable: true
            type:
              type: string
              description: Type of the address, i.e. registered, trading, other
            description:
              type: string
              description: Description of the address
              nullable: true
            createdAt:
              type: string
              description: Address created date time
              format: date-time
            createdById:
              type: integer
              description: Id of the user who created the Address
              format: int32
            createdBy:
              type: string
              description: Name of the user who created the Address
            modifiedAt:
              type: string
              description: Address last updated date time
              format: date-time
              nullable: true
            modifiedById:
              type: integer
              description: Id of the user who last modified the Address
              format: int32
              nullable: true
            modifiedBy:
              type: string
              description: Name of the user who last modified the Address
              nullable: true
        searchId:
          type: string
          description: Search Id of the key party
          format: uuid
          nullable: true
        createdAt:
          type: string
          description: Key party created time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created the key party
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the key party
        modifiedAt:
          type: string
          description: key party last updated time
          format: date-time
          nullable: true
        modifiedById:
          type: integer
          description: Id of the user who last modified the key party
          format: int32
          nullable: true
        modifiedBy:
          type: string
          description: Name of the user who last modified the key party
          nullable: true
    DeleteKeyPartyByIdNoContent:
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
          example: 0
    MODEL4df4ca:
      type: object
      required:
        - profileIds
      properties:
        userId:
          type: integer
          description: >-
            Id of the User to assign the Profiles. Passing null will unassign
            the profile
          format: int32
        profileIds:
          type: array
          description: List of profiles to assign a user
          items:
            type: string
            format: uuid
    KycProtectProfileAssignBulkResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the Profile
          format: uuid
        name:
          type: string
          description: Name of the Profile
        riskRating:
          type: string
          description: >-
            Risk rating given to profile. Available values are notApplicable,
            veryLow, low, medium, high and veryHigh.
        status:
          type: string
          description: >-
            Status of the profile. Available values are new, approved, declined,
            pending, cancelled, referred, closed and approvedReviewDue.
        type:
          type: string
          description: >-
            Type of the profile. Available values are trust, individual,
            soleTrader, company, plc, partnership and otherEntity.
        internalId:
          type: object
          description: Internal Id given to profile by customer
        assignedToId:
          type: object
          description: Id of the user assigned to the profile
          format: int32
        assignedTo:
          type: object
          description: Name of the user assigned to the profile
        safeNumber:
          type: object
          description: safe number of the business linked to the profile
        companyId:
          type: object
          description: company id of the business linked to the profile
        formationDate:
          type: object
          description: Formation date of the business linked to the profile
          format: date
        createdAt:
          type: string
          description: Profile created time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created the profile
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the profile
        modifiedAt:
          type: object
          description: Profile last updated time
          format: date-time
        modifiedById:
          type: object
          description: Id of the user who last modified the profile
          format: int32
        modifiedBy:
          type: object
          description: Name of the user who last modified the profile
        kycApprovedAt:
          type: string
          description: Date when the profile got approved
          format: date-time
        kycReviewOn:
          type: object
          description: Date when profile is to be reviewed
          format: date
        kycStatusUpdatedOn:
          type: object
          description: Date when the profile status was last updated
          format: date-time
        kycComments:
          type: object
          description: Profile comments
        noteCount:
          type: integer
          description: Count of notes associated with profile
          format: int32
        attachmentCount:
          type: integer
          description: Count of attachments associated with profile
          format: int32
        keyPartyCount:
          type: integer
          description: Count of key parties associated with profile
          format: int32
        uboCount:
          type: integer
          description: Count of UBOs associated with profile
          format: int32
        openAlertCount:
          type: integer
          description: Count of Open Alerts
          format: int32
        modeOfCreation:
          type: string
          description: >-
            Mode of profile creation. Available values are manual, import and
            batchUpload.
        importStatus:
          type: object
          description: >-
            Status of profile creation. Available values are submitted,
            preprocessed, validated, queued, inProgress, processed, completed,
            partiallyCompleted and failed.
        isLocked:
          type: boolean
          description: Value indicating whether the profile is locked
    KycProtectProfileGetAttachmentResponse:
      type: object
      properties:
        id:
          type: string
          description: Attachment Id.
          format: uuid
        fileName:
          type: string
          description: Example:passport.pdf (Attachment Name).
        fileSizeInBytes:
          type: integer
          description: Size of the attachment in bytes.
          format: int64
        documentType:
          type: string
          description: Document type of the attachment.
        description:
          type: string
          description: Description of the attachment.
        createdAt:
          type: string
          description: Attachment uploaded time.
          format: date-time
        createdById:
          type: integer
          description: Attachment uploaded by user id
          format: int32
        createdBy:
          type: string
          description: Attachment uploaded by user
        modifiedAt:
          type: string
          description: Attachment modified time
          format: date-time
        modifiedById:
          type: integer
          description: Attachment modified by user id
          format: int32
        modifiedBy:
          type: string
          description: Attachment modified by user
        linkedTo:
          type: string
          description: >-
            The profile component to which current attachment is linked to.
            Available values are profile and profileDetails.
    KycProtectProfileAttachmentResponse:
      type: object
      properties:
        id:
          type: string
          description: Attachment Id.
          format: uuid
        fileName:
          type: string
          description: Example:passport.pdf (Attachment Name).
        fileSizeInBytes:
          type: integer
          description: Size of the attachment in bytes.
          format: int64
        documentType:
          type: string
          description: Document type of the attachment.
        description:
          type: string
          description: Description of the attachment.
        createdAt:
          type: string
          description: Attachment uploaded time.
          format: date-time
        createdById:
          type: integer
          description: Attachment uploaded by user id
          format: int32
        createdBy:
          type: string
          description: Attachment uploaded by user
        modifiedAt:
          type: string
          description: Attachment modified time
          format: date-time
        modifiedById:
          type: integer
          description: Attachment modified by user id
          format: int32
        modifiedBy:
          type: string
          description: Attachment modified by user
    GetKYCProfileAttachmentDetailsByAttachmentId:
      type: object
      properties:
        id:
          type: string
          description: Attachment Id.
          format: uuid
        fileName:
          type: string
          description: "Example : passport.pdf\r\nAttachment Name."
        fileSizeInBytes:
          type: integer
          description: Size of the attachment in bytes.
          format: int64
        documentType:
          type: string
          description: Document type of the attachment.
        description:
          type: string
          nullable: true
          description: Description of the attachment.
        createdAt:
          type: string
          description: Attachment uploaded time.
          format: date-time
        createdById:
          type: integer
          description: Attachment uploaded by user id
          format: int32
        createdBy:
          type: string
          description: Attachment uploaded by user
        modifiedAt:
          type: string
          description: Attachment modified time
          format: date-time
        modifiedById:
          type: integer
          description: Attachment modified by user id
          format: int32
        modifiedBy:
          type: string
          description: Attachment modified by user
        linkedTo:
          type: string
          description: The profile component to which current attachment is linked to.
      example:
        id: 24faad02-7e20-4912-bdd9-51e4797380c5
        fileName: NL-X-170661060000.pdf
        fileSizeInBytes: 424860
        documentType: financials
        description: test1
        createdAt: '2023-08-07T07:30:03.186352Z'
        createdById: 101562008
        createdBy: Amol
        modifiedAt: '2023-08-07T07:30:25.630464Z'
        modifiedById: 101562008
        modifiedBy: Amol
        correlationId: 23b5a4a7-148f-4b82-8631-eab69bbe0a67
    UpdateKYCAttachmentsByAttachmentIdRequest:
      type: object
      properties:
        documentType:
          type: string
          description: The document type of the attachment
        description:
          type: string
          description: The description of the attachment. Limited to 250 characters.
    UpdateKYCAttachmentsByAttachmentId:
      type: object
      properties:
        id:
          type: string
          description: Attachment Id.
          format: uuid
        fileName:
          type: string
          description: "Example : passport.pdf\r\nAttachment Name."
        fileSizeInBytes:
          type: integer
          description: Size of the attachment in bytes.
          format: int64
        documentType:
          type: string
          description: Document type of the attachment.
        description:
          type: string
          description: Description of the attachment.
        createdAt:
          type: string
          description: Attachment uploaded time.
          format: date-time
        createdById:
          type: integer
          description: Attachment uploaded by user id
          format: int32
        createdBy:
          type: string
          description: Attachment uploaded by user
        modifiedAt:
          type: string
          description: Attachment modified time
          format: date-time
        modifiedById:
          type: integer
          description: Attachment modified by user id
          format: int32
        modifiedBy:
          type: string
          description: Attachment modified by user
    DownloadAttachmentResponse:
      type: object
      properties:
        downloadUrl:
          type: string
          description: Url of the file to download
        fileName:
          type: string
          description: Name of the file
        expiresAt:
          type: string
          description: Date and time when the url will expire
          format: date-time
      example:
        downloadUrl: >-
          https://kyc-protect-api-test.s3.eu-west-1.amazonaws.com/customers/103077765/profiles/2770ac31-8d12-4f69-8f93-326e93cd8c34/attachments/103077765.101562008.passport.a9747b86-20f6-4abe-b846-66c5fac81d1f?X-Amz-Expires=3600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCWV1LXdlc3QtMSJHMEUCIQC0YiHwxSeo7ae6bLIhgQD0QKPkZeAnQMM%2BZWVRAhiFYgIgeQZ4yyr8DYxSX%2FNwHw5uxyqmNl3v3%2BZSL5MjHPlpfNYqlAQIm%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAEGgw3MTIzOTA1ODYzNzEiDA4bvxjS1wkV2ibkFSroAzem6chzKCy1MWXBX8yOrpNUXC%2BSpEamSfxyzv0bqdbFNkt%2BBJsYdBeFLy2aiDLqLQbURhbIwBEFgVfbXyyBQJPH%2BSnL46Sg%2FK7HwdgFm90P4tuXm4VQse5Oq5%2FcP7XN4z39TXAVUlqK3LRhKI6qJxAP9TdbBI1FSb1A0DW3AXboLPWd4th2hGeivyjnwkBt221%2B7dNZ0ts8%2FHALLyCpDBZ7gADsMSUSoQDK0b04v2ORz7bkx3O4huRel3IKi9SBCYzARlwJbNTnko25hPD0%2B%2FZB%2F2c%2BArEv6XOzzyny5%2BjVIxpa19pikdDiyppMQ5f6%2BJw2qk%2FQtcIuZlqugvB35s4A3I6GQr0kWX%2B%2Bh134krwwJUTZ1SiL0jQNEtHSd7%2BZ7wvUi0%2FKHXFdGmnkdQEUDTUbWNrndiyIDBFqQ0uSdFX1MHMWw%2FoQnoutX0qe%2Farvhm3VbOfE%2FKa0y0p2APeHylERt%2FslZXBTNPrEsuypO0hDQ1vbZMmnDekekk0hS0SzH8JGo3Fkgs5TkESppcZHm6QIFCkI9uTGsz0J2YH08MbHFCjDePCzhXH6wW1uggnw%2BM42lrOEK4UrVE5dv4HegVV%2B50QbrtYdReQX0qkJEozBCLEAxWrtNFjoGELqWznRI4soacjUcG%2FBMKLky6YGOqUB77yUlvzEKMUsOZOIkqx9GNo2Y1ch%2FXAWxxpx0D67LaQy6QC4kkoqakLtN2%2F80HnIkPBcbHS2C5KcGdq5%2FuMWl7qHUgltt5cFXRaOs8fYx%2BgKJ0p2vWZ53CqFh2MfYVV%2F1aw%2BDyeyF9rr4VEgR4hP2Ap3gZJOCKvIeF4oelgyo%2FGkmM%2FOLH%2FoBtfqC%2F8XWfCYR16i1eWyV7DTbwQ%2FicZp5%2Bx5%2BJjV&response-content-disposition=attachment%3B%20filename%3DNL-X-170661060000.pdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA2LXOJWABRHEIT4WD/20230809/eu-west-1/s3/aws4_request&X-Amz-Date=20230809T070634Z&X-Amz-SignedHeaders=host&X-Amz-Signature=0fada68386fbe02d811a8fa4dd3825b06319be0ebf1cc9c11d427aa8e9530f95
        fileName: NL-X-170661060000.pdf
        expiresAt: '2023-08-09T08:06:34.3212061Z'
        correlationId: ee4228cc-68ed-413a-a547-79c5703017eb
    KycProtectGetSearchResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the search
          format: uuid
        name:
          type: object
          description: Name provided for the search. Length must not exceed 200 characters
        countryCodes:
          type: array
          description: Countries provided to the search
          items:
            type: string
        threshold:
          type: integer
          description: Hits with scores below this value will not be shown.
          format: int32
        type:
          type: string
          description: Indicates whether search type is individual or business
        datasets:
          type: array
          description: Provided datasets for the search
          items:
            type: string
        status:
          type: string
          description: Status of the search
        riskRating:
          type: string
          description: Risk associated with the search
        assignedToUserId:
          type: object
          description: Id of the user assigned to the search
          format: int32
        assignedUser:
          type: object
          description: Name of the user assigned to the search
        createdById:
          type: integer
          description: Id of the user who created the search
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the search
        createdAt:
          type: string
          description: Search created date time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who modified the search
          format: int32
        modifiedBy:
          type: string
          description: Name of the user who modified the search
        modifiedAt:
          type: string
          description: Search modified date time
          format: date-time
        note:
          type: object
          description: Note associated with the search
        totalHitCount:
          type: integer
          description: Total number of hits in the search
          format: int32
        truePositiveHitsCount:
          type: integer
          description: The number of true-positive hits in the search
          format: int32
        falsePositiveHitsCount:
          type: integer
          description: The number of false-positive hits in the search
          format: int32
        undecidedHitsCount:
          type: integer
          description: The number of undecided hits in the search
          format: int32
        firstName:
          type: object
          description: "First name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
        middleName:
          type: object
          description: "Middle name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
        lastName:
          type: object
          description: "Last name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
        gender:
          type: object
          description: Gender provided in the search. Available values are male, female.
        dateOfBirth:
          type: object
          description: DOB provided in the search
          format: date
        pepTiers:
          type: array
          description: >-
            Pep Tiers provided in the search.  Avaialable values are pepTier1,
            pepTier2, pepTier3.
          items:
            type: string
        scheduleId:
          type: object
          description: Schedule Id linked to the search
          format: uuid
    DeleteKYCProfileSearchesByProfileIdRequestBody:
      type: object
      properties:
        searchIds:
          type: array
          description: List of searches to de-link from a profile
          items:
            type: string
          example:
            - 1255eebd-7f75-4163-a8b4-ab95e8f7be74
    DeleteKYCProfileSearchesByProfileIdResponse:
      type: object
      properties:
        failed:
          type: array
          items:
            type: object
            properties:
              failedItem:
                type: string
              error:
                type: object
                properties:
                  type:
                    type: string
                    nullable: true
                  title:
                    type: string
                    nullable: true
                  status:
                    type: number
                    nullable: true
                  detail:
                    type: string
                    nullable: true
                  instance:
                    type: string
                    nullable: true
                  additionalProp1:
                    type: string
                  additionalProp2:
                    type: string
                  additionalProp3:
                    type: string
        successful:
          type: array
          items:
            type: string
            format: uuid
    KycProtectProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
    AddSearchContract:
      type: object
      properties:
        type:
          type: string
          description: >-
            The entity type of the search. Available values are individual and
            business.
        name:
          type: string
          description: Required if FirstName and LastName are not provided
          nullable: true
        firstName:
          type: string
          description: If FirstName is provided then LastName must also be provided
          nullable: true
        middleName:
          type: string
          description: >-
            Middle name is optional, valid along with Firstname and LastName
            only
          nullable: true
        lastName:
          type: string
          description: If LastName is provided then FirstName must also be provided
          nullable: true
        dateOfBirth:
          type: string
          description: >-
            Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the
            future.
          format: date
          nullable: true
        gender:
          type: string
          description: Define the gender of the individual you are searching for.
          nullable: true
        pepTiers:
          type: array
          items:
            type: string
          description: >-
            When searching the PEP dataset, define what tiers of the PEP
            profiles should be included in the results.<br><br> PEP Tier 1
            indicates senior roles<br> PEP Tier 2 - middle-ranking<br> PEP Tier
            3 - junior officials<br><br> If the PEP Dataset is NOT included on
            the list of searched datasets, then this value is ignored. The PEP
            Tier filter does not apply to PEP-LINKED Profiles.
          nullable: true
        datasets:
          type: array
          items:
            type: string
          description: >-
            Specifies which datasets will be searched<br><br> PEP - Politically
            Exposed Persons (All)<br> PEP-CURRENT - Only current PEPs<br>
            PEP-FORMER - Only former PEPs PEP-LINKED - Only linked PEPs (PEP by
            Association)<br> SAN - Sanctioned (All)<br> SAN-CURRENT - Only
            current Sanctions<br> SAN-FORMER - Only former Sanctions<br> INS -
            Insolvency <br> AM - Averse Media<br> POI - Profile of Interest<br>
            ENF - Enforcement <br> DD - Disqualified Director
          nullable: true
        countryCodes:
          type: array
          items:
            type: string
          nullable: true
        threshold:
          type: integer
          description: Must be one of 75, 80, 85, 90, 95, or 100
          format: int32
    MODELf73bb1:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Id of the search
                format: uuid
              name:
                type: string
                description: >-
                  Name provided for the search. Length must not exceed 200
                  characters
                nullable: true
              countryCodes:
                type: array
                description: Countries provided to the search
                nullable: true
                items:
                  type: string
              threshold:
                type: integer
                description: Hits with scores below this value will not be shown.
                format: int32
              type:
                type: string
                description: Indicates whether search type is individual or business
              datasets:
                type: array
                description: Provided datasets for the search
                items:
                  type: string
              status:
                type: string
                description: >-
                  Status of the search. Available values are new, approved,
                  declined, pending, cancelled, referred and closed.
              riskRating:
                type: string
                description: >-
                  Risk associated with the search. Available values are
                  notApplicable, veryLow, low, medium, high AND veryHigh.
              assignedToUserId:
                type: integer
                description: Id of the user assigned to the search
                nullable: true
                format: int32
              assignedUser:
                type: string
                description: Name of the user assigned to the search
                nullable: true
              createdById:
                type: integer
                description: Id of the user who created the search
                format: int32
              createdBy:
                type: string
                description: Name of the user who created the search
              createdAt:
                type: string
                description: Search created date time
                format: date-time
              modifiedById:
                type: integer
                description: Id of the user who modified the search
                format: int32
              modifiedBy:
                type: string
                description: Name of the user who modified the search
              modifiedAt:
                type: string
                description: Search modified date time
                format: date-time
              note:
                type: string
                description: Note associated with the search
                nullable: true
              scheduleId:
                type: string
                description: Schedule Id linked to the search
                format: uuid
                nullable: true
              totalHitCount:
                type: integer
                description: Total number of hits in the search
                format: int32
              truePositiveHitsCount:
                type: integer
                description: The number of true-positive hits in the search
                format: int32
              falsePositiveHitsCount:
                type: integer
                description: The number of false-positive hits in the search
                format: int32
              undecidedHitsCount:
                type: integer
                description: The number of undecided hits in the search
                format: int32
        totalSize:
          type: number
    KYCPUTSearchBusinessesResponse:
      type: object
      properties:
        failed:
          type: array
          items:
            type: object
            properties:
              failedItem:
                type: object
                properties:
                  assignedToUserId:
                    type: integer
                    description: Id of the User to assign to the Search
                    format: int32
                    nullable: true
                  status:
                    type: string
                    description: >-
                      Status of the Search. Available values are new, approved,
                      declined, pending, cancelled, referred and closed.
                    nullable: true
                  riskRating:
                    type: string
                    description: >-
                      Risk rating of the Search. Available values are
                      notApplicable, veryLow, low, medium, high AND veryHigh.
                    nullable: true
                  note:
                    type: string
                    description: Note associated with the search
                    nullable: true
                  searchId:
                    type: string
                    description: The Id of the search to be updated
                    format: uuid
              error:
                type: object
                properties:
                  type:
                    type: string
                    nullable: true
                  title:
                    type: string
                    nullable: true
                  status:
                    type: integer
                    nullable: true
                  detail:
                    type: string
                    nullable: true
                  instance:
                    type: string
                    nullable: true
        successful:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Id of the search
                format: uuid
              name:
                type: string
                description: >-
                  Name provided for the search. Length must not exceed 200
                  characters
                nullable: true
              countryCodes:
                type: array
                description: Countries provided to the search
                nullable: true
                items:
                  type: string
              threshold:
                type: integer
                description: Hits with scores below this value will not be shown.
                format: int32
              type:
                type: string
                description: Indicates whether search type is individual or business
              datasets:
                type: array
                description: Provided datasets for the search
                items:
                  type: string
              status:
                type: string
                description: >-
                  Status of the search. Available values are new, approved,
                  declined, pending, cancelled, referred and closed.
              riskRating:
                type: string
                description: >-
                  Risk associated with the search. Available values are
                  notApplicable, veryLow, low, medium, high AND veryHigh.
              assignedToUserId:
                type: integer
                description: Id of the user assigned to the search
                format: int32
                nullable: true
              assignedUser:
                type: string
                description: Name of the user assigned to the search
                nullable: true
              createdById:
                type: integer
                description: Id of the user who created the search
                format: int32
              createdBy:
                type: string
                description: Name of the user who created the search
              createdAt:
                type: string
                description: Search created date time
                format: date-time
              modifiedById:
                type: integer
                description: Id of the user who modified the search
                format: int32
              modifiedBy:
                type: string
                description: Name of the user who modified the search
              modifiedAt:
                type: string
                description: Search modified date time
                format: date-time
              note:
                type: string
                description: Note associated with the search
                nullable: true
              scheduleId:
                type: string
                description: Schedule Id linked to the search
                format: uuid
                nullable: true
              totalHitCount:
                type: integer
                description: Total number of hits in the search
                format: int32
              truePositiveHitsCount:
                type: integer
                description: The number of true-positive hits in the search
                format: int32
              falsePositiveHitsCount:
                type: integer
                description: The number of false-positive hits in the search
                format: int32
              undecidedHitsCount:
                type: integer
                description: The number of undecided hits in the search
                format: int32
    MODEL931a1b:
      type: object
      properties:
        id:
          type: string
          description: Id of the search
          format: uuid
        name:
          type: string
          description: Name provided for the search. Length must not exceed 200 characters
        countryCodes:
          type: array
          description: Countries provided to the search
          items:
            type: string
        threshold:
          type: integer
          description: Hits with scores below this value will not be shown.
          format: int32
        type:
          type: string
          description: Indicates whether search type is individual or business
        datasets:
          type: array
          description: Provided datasets for the search
          items:
            type: string
        status:
          type: string
          description: >-
            Status of the search. Available values are new, approved, declined,
            pending, cancelled, referred and closed.
        riskRating:
          type: string
          description: >-
            Risk associated with the search. Available values are notApplicable,
            veryLow, low, medium, high AND veryHigh.
        assignedToUserId:
          type: integer
          description: Id of the user assigned to the search
          format: int32
        assignedUser:
          type: string
          description: Name of the user assigned to the search
        createdById:
          type: integer
          description: Id of the user who created the search
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the search
        createdAt:
          type: string
          description: Search created date time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who modified the search
          format: int32
        modifiedBy:
          type: string
          description: Name of the user who modified the search
        modifiedAt:
          type: string
          description: Search modified date time
          format: date-time
        note:
          type: string
          description: Note associated with the search
        scheduleId:
          type: string
          description: Schedule Id linked to the search
          format: uuid
        totalHitCount:
          type: integer
          description: Total number of hits in the search
          format: int32
        truePositiveHitsCount:
          type: integer
          description: The number of true-positive hits in the search
          format: int32
        falsePositiveHitsCount:
          type: integer
          description: The number of false-positive hits in the search
          format: int32
        undecidedHitsCount:
          type: integer
          description: The number of undecided hits in the search
          format: int32
        correlationId:
          type: string
          description: A unique ID assigned to this request.
    KYCGetSearchBusinessesBySearchIdResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the search
          format: uuid
        name:
          type: string
          description: Name provided for the search. Length must not exceed 200 characters
        countryCodes:
          type: array
          items:
            type: string
          description: Countries provided to the search
        threshold:
          type: integer
          description: Hits with scores below this value will not be shown.
          format: int32
        type:
          type: string
          description: Indicates whether search type is individual or business
        datasets:
          type: array
          items:
            type: string
          description: Provided datasets for the search
        status:
          type: string
          description: >-
            Status of the search. Available values are new, approved, declined,
            pending, cancelled, referred and closed.
        riskRating:
          type: string
          description: The risk rating being assigned to the profile
          enum:
            - notApplicable
            - veryLow
            - low
            - medium
            - high
            - veryHigh
        assignedToUserId:
          type: integer
          description: Id of the user assigned to the search
          format: int32
        assignedUser:
          type: string
          description: Name of the user assigned to the search
        createdById:
          type: integer
          description: Id of the user who created the search
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the search
        createdAt:
          type: string
          description: Search created date time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who modified the search
          format: int32
        modifiedBy:
          type: string
          description: Name of the user who modified the search
        modifiedAt:
          type: string
          description: Search modified date time
          format: date-time
        note:
          type: string
          description: Note associated with the search
        scheduleId:
          type: string
          description: Schedule Id linked to the search
          format: uuid
        totalHitCount:
          type: integer
          description: Total number of hits in the search
          format: int32
        truePositiveHitsCount:
          type: integer
          description: The number of true-positive hits in the search
          format: int32
        falsePositiveHitsCount:
          type: integer
          description: The number of false-positive hits in the search
          format: int32
        undecidedHitsCount:
          type: integer
          description: The number of undecided hits in the search
          format: int32
    KYCPutSearchBusinessesBySearchIdResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the search
          format: uuid
        name:
          type: string
          description: Name provided for the search. Length must not exceed 200 characters
        countryCodes:
          type: array
          items:
            type: string
          description: Countries provided to the search
        threshold:
          type: integer
          description: Hits with scores below this value will not be shown.
          format: int32
        type:
          type: string
          description: Indicates whether search type is individual or business
        datasets:
          type: array
          items:
            type: string
          description: Provided datasets for the search
        status:
          type: string
          description: >-
            Status of the search. Available values are new, approved, declined,
            pending, cancelled, referred and closed.
        riskRating:
          type: string
          description: The risk rating being assigned to the profile
          enum:
            - notApplicable
            - veryLow
            - low
            - medium
            - high
            - veryHigh
        assignedToUserId:
          type: integer
          description: Id of the user assigned to the search
          format: int32
        assignedUser:
          type: string
          description: Name of the user assigned to the search
        createdById:
          type: integer
          description: Id of the user who created the search
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the search
        createdAt:
          type: string
          description: Search created date time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who modified the search
          format: int32
        modifiedBy:
          type: string
          description: Name of the user who modified the search
        modifiedAt:
          type: string
          description: Search modified date time
          format: date-time
        note:
          type: string
          description: Note associated with the search
        scheduleId:
          type: string
          description: Schedule Id linked to the search
          format: uuid
        totalHitCount:
          type: integer
          description: Total number of hits in the search
          format: int32
        truePositiveHitsCount:
          type: integer
          description: The number of true-positive hits in the search
          format: int32
        falsePositiveHitsCount:
          type: integer
          description: The number of false-positive hits in the search
          format: int32
        undecidedHitsCount:
          type: integer
          description: The number of undecided hits in the search
          format: int32
    KYCGetSearchBusinessesBySearchIdHitsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The Id of the search hit.
                format: uuid
              hitScore:
                type: integer
                description: The hit score associated to the search hit.
                format: int32
              name:
                type: string
                description: The name associated to the search hit.
                nullable: true
              match:
                type: string
                description: The match string associated to the search hit.
              countries:
                type: array
                items:
                  type: string
                description: The countries associated to the search hit.
              datasets:
                type: array
                items:
                  type: string
                description: The datasets associated to the search hit.
              decision:
                type: string
                description: >-
                  The decision made on the search hit. Available values are
                  undecided, trueMatch, falsePositive and discarded.
              note:
                type: string
                description: The note added to the search hit.
              modifiedById:
                type: integer
                description: The search hit last modified by user id.
                format: int32
              modifiedBy:
                type: string
                description: The search hit last modified by user name.
              modifiedAt:
                type: string
                description: The search hit last modified date and time.
                format: date-time
              createdAt:
                type: string
                description: The search hit created date and time.
                format: date-time
              supersededHit:
                type: object
                properties:
                  id:
                    type: string
                    description: The Id of the search hit.
                    format: uuid
                  hitScore:
                    type: integer
                    description: The hit score associated to the search hit.
                    format: int32
                  name:
                    type: string
                    description: The name associated to the search hit.
                  match:
                    type: string
                    description: The match string associated to the search hit.
                  countries:
                    type: array
                    items:
                      type: string
                    description: The countries associated to the search hit.
                  datasets:
                    type: array
                    items:
                      type: string
                    description: The datasets associated to the search hit.
                  decision:
                    type: string
                    description: >-
                      The decision made on the search hit. Available values are
                      undecided, trueMatch, falsePositive anddiscarded.
                  note:
                    type: string
                    description: The note added to the search hit.
                  modifiedById:
                    type: integer
                    description: The search hit last modified by user id.
                    format: int32
                  modifiedBy:
                    type: string
                    description: The search hit last modified by user name.
                  modifiedAt:
                    type: string
                    description: The search hit last modified date and time.
                    format: date-time
                  createdAt:
                    type: string
                    description: The search hit created date and time.
                    format: date-time
        totalSize:
          type: number
    MODEL7b2457:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            required:
              - hitId
            properties:
              decision:
                type: string
                description: >-
                  The Decision of the Hit to be updated Decision can only be
                  made once. Available values are undecided, truematch,
                  falsepositive, discarded
              note:
                type: string
                description: Note associated with the Hit
              hitId:
                type: string
                description: The Id of the Hit to be updated
    KYCPutSearchBusinessesBySearchIdHitsResponse:
      type: object
      properties:
        failed:
          type: array
          items:
            type: object
            properties:
              failedItem:
                type: object
                properties:
                  decision:
                    type: string
                    description: >-
                      The Decision of the Hit to be updated Decision can only be
                      made once. Available values are undecided, truematch,
                      falsepositive, discarded
                  note:
                    type: string
                    description: Note associated with the Hit
                  hitId:
                    type: string
                    description: The Id of the Hit to be updated
              error:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: integer
                  detail:
                    type: string
                  instance:
                    type: string
        successful:
          type: array
          items:
            type: object
            properties:
              items:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The Id of the search hit.
                      format: uuid
                    hitScore:
                      type: integer
                      description: The hit score associated to the search hit.
                      format: int32
                    name:
                      type: string
                      description: The name associated to the search hit.
                    match:
                      type: string
                      description: The match string associated to the search hit.
                    countries:
                      type: array
                      description: The countries associated to the search hit.
                      items:
                        type: string
                    datasets:
                      type: array
                      description: The datasets associated to the search hit.
                      items:
                        type: string
                    decision:
                      type: string
                      description: >-
                        The decision made on the search hit. Available values
                        are undecided, trueMatch, falsePositive anddiscarded.
                    note:
                      type: string
                      description: The note added to the search hit.
                    modifiedById:
                      type: integer
                      description: The search hit last modified by user id.
                      format: int32
                    modifiedBy:
                      type: string
                      description: The search hit last modified by user name.
                    modifiedAt:
                      type: string
                      description: The search hit last modified date and time.
                      format: date-time
                    createdAt:
                      type: string
                      description: The search hit created date and time.
                      format: date-time
                    supersededHit:
                      type: object
                      properties:
                        id:
                          type: string
                          description: The Id of the search hit.
                          format: uuid
                        hitScore:
                          type: integer
                          description: The hit score associated to the search hit.
                          format: int32
                        name:
                          type: string
                          description: The name associated to the search hit.
                        match:
                          type: string
                          description: The match string associated to the search hit.
                        countries:
                          type: array
                          description: The countries associated to the search hit.
                          items:
                            type: string
                        datasets:
                          type: array
                          description: The datasets associated to the search hit.
                          items:
                            type: string
                        decision:
                          type: string
                          description: >-
                            The decision made on the search hit. Available
                            values are undecided, trueMatch, falsePositive and
                            discarded.
                        note:
                          type: string
                          description: The note added to the search hit.
                        modifiedById:
                          type: integer
                          description: The search hit last modified by user id.
                          format: int32
                        modifiedBy:
                          type: string
                          description: The search hit last modified by user name.
                        modifiedAt:
                          type: string
                          description: The search hit last modified date and time.
                          format: date-time
                        createdAt:
                          type: string
                          description: The search hit created date and time.
                          format: date-time
    WebApiModelsSearchesSearchResultHitsHitIdentifierResponse:
      type: object
      properties:
        type:
          type: string
          description: The type of the hit identifier
        value:
          type: string
          description: The value of the hit identifier
    WebApiModelsSearchesSearchResultHitsHitAddressResponse:
      type: object
      properties:
        postalCode:
          type: string
          nullable: true
          description: The postal code of the address
        line1:
          type: string
          nullable: true
          description: The line1 of the address
        line2:
          type: string
          nullable: true
          description: The line2 of the address
        type:
          type: string
          nullable: true
          description: The type of the address
        county:
          type: string
          nullable: true
          description: The county of the address
        countryCode:
          type: string
          nullable: true
          description: The country code of the address
        city:
          type: string
          nullable: true
          description: The city of the address
    WebApiModelsSearchesSearchResultHitsHitContactResponse:
      type: object
      properties:
        type:
          type: string
          description: Avaialable values are telephone, fax, mobile, email, website
        value:
          type: string
    WebApiModelsSearchesSearchResultHitsHitIndividualLinkResponse:
      type: object
      properties:
        relationship:
          type: string
          description: The relationship of the associated link
        ownershipPercentage:
          type: integer
          nullable: true
          description: The ownership percentage of the associated link
          format: int32
        datasets:
          type: array
          items:
            type: string
          description: The datasets associated with the link
        firstName:
          type: string
          nullable: true
          description: The first name of the individual link
        middleName:
          type: string
          nullable: true
          description: The middle name of the individual link
        lastName:
          type: string
          nullable: true
          description: The last name of the individual link
    WebApiModelsSearchesSearchResultHitsHitBusinessLinkResponse:
      type: object
      properties:
        relationship:
          type: string
          description: The relationship of the associated link
        ownershipPercentage:
          type: integer
          nullable: true
          description: The ownership percentage of the associated link
          format: int32
        datasets:
          type: array
          items:
            type: string
          description: The datasets associated with the link
        name:
          type: string
          description: The name of the link
        individualLinks:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitIndividualLinkResponse
          description: The individual links associated to the business link
    WebApiModelsSearchesSearchResultHitsHitSourceResponse:
      type: object
      properties:
        title:
          type: string
          nullable: true
          description: The title of the hit source
        description:
          type: string
          nullable: true
          description: The description of the hit source
        link:
          type: string
          description: The URL associated to the hit source
        dateAdded:
          type: string
          nullable: true
          description: The date when the hit source is added
          format: date
        isCopyrighted:
          type: boolean
          nullable: true
          description: Represents whether hit source is copyrighted
        datePublished:
          type: string
          nullable: true
          description: The date when hit source is published
          format: date
        documentLink:
          type: string
          nullable: true
          description: The document link associated to the hit source
        datasets:
          type: array
          nullable: true
          items:
            type: string
          description: The datasets associated with the hit source
    WebApiModelsSearchesSearchResultHitsHitBusinessAliasResponse:
      type: object
      properties:
        type:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
    WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
        date:
          type: string
          nullable: true
          description: Can be in the format YYYY or YYYY-MM-DD
          format: date
        amount:
          type: integer
          nullable: true
          format: int32
        currencyCode:
          type: string
          nullable: true
        duration:
          type: string
          nullable: true
        sources:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse
    WebApiModelsSearchesSearchResultHitsEntriesAdverseMediaEntryValueResponse:
      type: object
      properties:
        category:
          type: string
        subCategory:
          type: string
    WebApiModelsSearchesSearchResultHitsEntriesAdverseMediaEntryResponse:
      type: object
      properties:
        events:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse
        sources:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse
        type:
          type: string
          description: >-
            Avaialable values are adverseMedia, disqualifiedDirector,
            insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement,
            sanction, stateOwnedEnterprise
        value:
          $ref: >-
            #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesAdverseMediaEntryValueResponse
    WebApiModelsSearchesSearchResultHitsEntriesEnforcementEntryValueResponse:
      type: object
      properties:
        category:
          type: string
        subCategory:
          type: string
    WebApiModelsSearchesSearchResultHitsEntriesEnforcementEntryResponse:
      type: object
      properties:
        events:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse
        sources:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse
        type:
          type: string
          description: >-
            Avaialable values are adverseMedia, disqualifiedDirector,
            insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement,
            sanction, stateOwnedEnterprise
        value:
          $ref: >-
            #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEnforcementEntryValueResponse
    WebApiModelsSearchesSearchResultHitsEntriesCourtResponse:
      type: object
      properties:
        name:
          type: string
        petitioner:
          type: string
        hearingDate:
          type: string
          nullable: true
          format: date-time
        petitionPresentedDate:
          type: string
          nullable: true
          format: date-time
    WebApiModelsSearchesSearchResultHitsEntriesInsolvencyEntryValueResponse:
      type: object
      properties:
        insolvencyIdNumber:
          type: string
        type:
          type: string
        debtAmount:
          type: string
        startDate:
          type: string
          nullable: true
          format: date-time
        endDate:
          type: string
          nullable: true
          format: date-time
        caseReferenceNumbers:
          type: array
          items:
            type: string
        solicitor:
          type: string
        court:
          $ref: >-
            #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesCourtResponse
        orderDate:
          type: string
          nullable: true
          format: date-time
        gazetteIssuedDate:
          type: string
          nullable: true
          format: date-time
        awardDate:
          type: string
          nullable: true
          format: date-time
    WebApiModelsSearchesSearchResultHitsEntriesInsolvencyEntryResponse:
      type: object
      properties:
        events:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse
        sources:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse
        type:
          type: string
          description: >-
            Avaialable values are adverseMedia, disqualifiedDirector,
            insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement,
            sanction, stateOwnedEnterprise
        value:
          $ref: >-
            #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesInsolvencyEntryValueResponse
    WebApiModelsSearchesSearchResultHitsEntriesPositionResponse:
      type: object
      properties:
        name:
          type: string
        segment:
          type: string
        country:
          type: string
        fromDate:
          type: string
          nullable: true
          description: Can be in the format YYYY or YYYY-MM-DD
          format: date
        toDate:
          type: string
          nullable: true
          description: Can be in the format YYYY or YYYY-MM-DD
          format: date
    WebApiModelsSearchesSearchResultHitsEntriesProfileOfInterestEntryValueResponse:
      type: object
      properties:
        category:
          type: string
        positions:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPositionResponse
      additionalProperties: false
    WebApiModelsSearchesSearchResultHitsEntriesProfileOfInterestEntryResponse:
      type: object
      properties:
        events:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse
        sources:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse
        type:
          type: string
          description: >-
            Avaialable values are adverseMedia, disqualifiedDirector,
            insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement,
            sanction, stateOwnedEnterprise
        value:
          $ref: >-
            #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesProfileOfInterestEntryValueResponse
    WebApiModelsSearchesSearchResultHitsEntriesSanctionEntryValueResponse:
      type: object
      properties:
        sanctionId:
          type: string
          nullable: true
        issuingBody:
          type: string
          nullable: true
        origin:
          type: string
          nullable: true
        sanctionTypes:
          type: string
          nullable: true
          items:
            type: string
        measures:
          type: array
          nullable: true
          items:
            type: string
        regime:
          type: string
          nullable: true
    WebApiModelsSearchesSearchResultHitsEntriesSanctionEntryResponse:
      type: object
      properties:
        events:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse
        sources:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse
        type:
          type: string
          description: >-
            Avaialable values are adverseMedia, disqualifiedDirector,
            insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement,
            sanction, stateOwnedEnterprise
        value:
          $ref: >-
            #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesSanctionEntryValueResponse
    WebApiModelsSearchesSearchResultHitsHitAmlResultsSanctionsResponse:
      type: object
      properties:
        CURRENT:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesSanctionEntryResponse
        FORMER:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesSanctionEntryResponse
    WebApiModelsSearchesSearchResultHitsEntriesStateOwnedEnterpriseEntryValueResponse:
      type: object
      properties:
        type:
          type: string
          description: Avaialable values are current, former
        level:
          type: string
    WebApiModelsSearchesSearchResultHitsEntriesStateOwnedEnterpriseEntryResponse:
      type: object
      properties:
        events:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse
        sources:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse
        type:
          type: string
          description: >-
            Avaialable values are adverseMedia, disqualifiedDirector,
            insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement,
            sanction, stateOwnedEnterprise
        value:
          $ref: >-
            #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesStateOwnedEnterpriseEntryValueResponse
    WebApiModelsSearchesSearchResultHitsBusinessHitAmlResultsResponse:
      type: object
      properties:
        AM:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesAdverseMediaEntryResponse
        ENF:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEnforcementEntryResponse
        INS:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesInsolvencyEntryResponse
        POI:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesProfileOfInterestEntryResponse
        SAN:
          $ref: >-
            #/components/schemas/WebApiModelsSearchesSearchResultHitsHitAmlResultsSanctionsResponse
        SOE:
          $ref: >-
            #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesStateOwnedEnterpriseEntryResponse
    WebApiModelsSearchesSearchResultHitsBusinessSearchResultHitResponse:
      type: object
      properties:
        id:
          type: string
          description: The Id of the search hit
          format: uuid
        hitScore:
          type: integer
          description: The hit score associated to the search hit
          format: int32
        name:
          type: string
          nullable: true
          description: The name associated to the search hit
        match:
          type: string
          nullable: true
          description: The match string associated to the search hit
        note:
          type: string
          nullable: true
          description: The note added to the search hit
        countries:
          type: array
          nullable: true
          items:
            type: string
          description: The countries associated to the search hit
        datasets:
          type: array
          items:
            type: string
          description: The datasets associated to the search hit
        profileImages:
          type: array
          nullable: true
          items:
            type: string
          description: The profile images associated to the search hit
        screeningNotes:
          type: array
          nullable: true
          items:
            type: string
          description: The screening notes associated to the search hit
        modifiedAt:
          type: string
          description: The search hit modified date and time
          format: date-time
        modifiedById:
          type: integer
          description: The search hit modified by user id
          format: int32
        modifiedBy:
          type: string
          description: The search hit modified by user name
        createdAt:
          type: string
          description: The search hit created date and time
          format: date-time
        decision:
          type: string
          description: >-
            The decision made on the search hit Avaialable values are undecided,
            trueMatch, falsePositive, discarded
        identifiers:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitIdentifierResponse
          description: The identifiers associated to the search hit
        addresses:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitAddressResponse
          description: The addresses associated to the search hit
        contacts:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitContactResponse
          description: The contact details associated to the search hit
        businessLinks:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitBusinessLinkResponse
          description: The business links associated to the search hit
        individualLinks:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitIndividualLinkResponse
          description: The individual links associated to the search hit
        sources:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse
          description: The sources associated to the search hit
        activities:
          type: array
          nullable: true
          items:
            type: string
          description: The activities associated to the search hit
        aliases:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitBusinessAliasResponse
          description: The aliases associated to the search hit
        amlResults:
          $ref: >-
            #/components/schemas/WebApiModelsSearchesSearchResultHitsBusinessHitAmlResultsResponse
        description:
          type: string
          nullable: true
          description: The description associated to the search hit
        businessTypes:
          type: array
          nullable: true
          items:
            type: string
          description: The business types associated to the search hit
    KYCBaseBusinessSearchResultHitSummaryResponse:
      type: object
      properties:
        id:
          type: string
          description: The Id of the search hit.
          format: uuid
        hitScore:
          type: integer
          description: The hit score associated to the search hit.
          format: int32
        name:
          type: object
          description: The name associated to the search hit.
        match:
          type: object
          description: The match string associated to the search hit.
        countries:
          type: array
          description: The countries associated to the search hit.
          items:
            type: string
        datasets:
          type: array
          description: The datasets associated to the search hit.
          items:
            type: string
        decision:
          type: string
          description: >-
            The decision made on the search hit. Available values are undecided,
            trueMatch, falsePositive, discarded.
        note:
          type: object
          description: The note added to the search hit.
        modifiedById:
          type: integer
          description: The search hit last modified by user id.
          format: int32
        modifiedBy:
          type: object
          description: The search hit last modified by user name.
        modifiedAt:
          type: string
          description: The search hit last modified date and time.
          format: date-time
        createdAt:
          type: string
          description: The search hit created date and time.
          format: date-time
    KYCBusinessSearchResultHitSummaryResponse:
      type: object
      properties:
        id:
          type: string
          description: The Id of the search hit.
          format: uuid
        hitScore:
          type: integer
          description: The hit score associated to the search hit.
          format: int32
        name:
          type: string
          description: The name associated to the search hit.
        match:
          type: string
          description: The match string associated to the search hit.
        countries:
          type: array
          description: The countries associated to the search hit.
          items:
            type: string
        datasets:
          type: array
          description: The datasets associated to the search hit.
          items:
            type: string
        decision:
          type: string
          description: >-
            The decision made on the search hit. Available values are undecided,
            trueMatch, falsePositive, discarded.
        note:
          type: string
          description: The note added to the search hit.
        modifiedById:
          type: integer
          description: The search hit last modified by user id.
          format: int32
        modifiedBy:
          type: string
          description: The search hit last modified by user name.
        modifiedAt:
          type: string
          description: The search hit last modified date and time.
          format: date-time
        createdAt:
          type: string
          description: The search hit created date and time.
          format: date-time
        supersededHit:
          $ref: '#/components/schemas/KYCBaseBusinessSearchResultHitSummaryResponse'
    WebApiModelsSearchesSearchResultHitsBusinessSearchHitAttachmentLinkResponse:
      type: object
      properties:
        downloadUrl:
          type: string
          description: >
            The direct URL to download the PDF file containing AML details for
            the specified hit. <br> This URL is valid only until the expiration
            time specified in the `expiresAt` field.
        fileName:
          type: string
          description: >
            The name of the downloaded PDF file, generated automatically based
            on the search  and hit details.
        expiresAt:
          type: string
          format: date-time
          description: >
            The expiration date and time for the download URL. After this time,
            the link will  no longer be valid.
        searchId:
          type: string
          format: uuid
          description: >
            The unique identifier of the search that generated the hit, provided
            as a reference  for the requested file.
        hitId:
          type: string
          format: uuid
          description: >
            The unique identifier of the hit associated with the search. This ID
            corresponds  to the flagged result being downloaded.
    KycProtectGetIndividualSearchItems:
      type: object
      properties:
        id:
          type: string
          description: Id of the search
          format: uuid
        name:
          type: string
          nullable: true
          description: Name provided for the search. Length must not exceed 200 characters
        countryCodes:
          type: array
          nullable: true
          items:
            type: string
          description: Countries provided to the search
        threshold:
          type: integer
          description: Hits with scores below this value will not be shown.
          format: int32
        type:
          type: string
          description: >-
            Indicates whether search type is individual or business. Available
            values are individual, business.
        datasets:
          type: array
          items:
            type: string
          description: Provided datasets for the search
        status:
          type: string
          description: >-
            Status of the search. Available values are new, approved, declined,
            pending, cancelled, referred, closed.
        riskRating:
          type: string
          description: >-
            Risk associated with the search. Available values are notApplicable,
            veryLow, low, medium, high, veryHigh.
        assignedToUserId:
          type: integer
          nullable: true
          description: Id of the user assigned to the search
          format: int32
        assignedUser:
          type: string
          nullable: true
          description: Name of the user assigned to the search
        createdById:
          type: integer
          description: Id of the user who created the search
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the search
        createdAt:
          type: string
          description: Search created date time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who modified the search
          format: int32
        modifiedBy:
          type: string
          description: Name of the user who modified the search
        modifiedAt:
          type: string
          description: Search modified date time
          format: date-time
        note:
          type: string
          nullable: true
          description: Note associated with the search
        scheduleId:
          type: string
          nullable: true
          description: Schedule Id linked to the search
          format: uuid
        totalHitCount:
          type: integer
          description: Total number of hits in the search
          format: int32
        truePositiveHitsCount:
          type: integer
          description: The number of true-positive hits in the search
          format: int32
        falsePositiveHitsCount:
          type: integer
          description: The number of false-positive hits in the search
          format: int32
        undecidedHitsCount:
          type: integer
          description: The number of undecided hits in the search
          format: int32
        firstName:
          type: string
          nullable: true
          description: "First name of individual provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
        middleName:
          type: string
          nullable: true
          description: "Middle name of individual provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
        lastName:
          type: string
          nullable: true
          description: "Last name of individual provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
        gender:
          type: string
          nullable: true
          description: >-
            Gender of individual provided in the search. Available values are
            male, female.
        dateOfBirth:
          type: string
          nullable: true
          description: DOB of individual provided in the search
          format: date
        pepTiers:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Pep Tiers provided in the search of individual. Available values are
            pepTier1, pepTier2, pepTier3
        isDobRequired:
          type: boolean
          description: >-
            Indicates whether date of birth is required for the individual
            search.
          default: true
          nullable: true
    KycProtectIndividualSearchResponse:
      type: object
      properties:
        totalSize:
          type: integer
          format: int32
        items:
          type: array
          items:
            $ref: '#/components/schemas/KycProtectGetIndividualSearchItems'
    PutKYCIndividualSearchRequest:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            required:
              - searchId
              - riskRating
            properties:
              assignedToUserId:
                type: object
                description: Id of the User to assign to the Search
                format: int32
              status:
                type: object
                description: >-
                  Status of the Search and allowed values are
                  new,approved,declined,pending,cancelled,referred and closed
              riskRating:
                type: object
                description: >-
                  Risk rating of the Search and allowed values
                  notApplicable,veryLow,low,medium,high and veryHigh
              note:
                type: object
                description: Note associated with the search
              searchId:
                type: string
                description: The Id of the search to be updated
                format: uuid
    KYCPUTSearchIndividualResponse:
      type: object
      properties:
        failed:
          type: array
          items:
            type: object
            properties:
              failedItem:
                type: object
                properties:
                  assignedToUserId:
                    type: integer
                    description: Id of the User to assign to the Search
                    format: int32
                  status:
                    type: string
                    description: >-
                      Status of the Search. Available values are new, approved,
                      declined, pending, cancelled, referred and closed.
                  riskRating:
                    type: string
                    description: >-
                      Risk rating of the Search. Available values are
                      notApplicable, veryLow, low, medium, high AND veryHigh.
                  note:
                    type: string
                    description: Note associated with the search
                  searchId:
                    type: string
                    description: The Id of the search to be updated
                    format: uuid
              error:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: integer
                  detail:
                    type: string
                  instance:
                    type: string
        successful:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Id of the search
                format: uuid
              name:
                type: string
                description: >-
                  Name provided for the search. Length must not exceed 200
                  characters
              countryCodes:
                type: array
                description: Countries provided to the search
                items:
                  type: string
              threshold:
                type: integer
                description: Hits with scores below this value will not be shown.
                format: int32
              type:
                type: string
                description: Indicates whether search type is individual or business
              datasets:
                type: array
                description: Provided datasets for the search
                items:
                  type: string
              status:
                type: string
                description: Status of the search
              riskRating:
                type: string
                description: Risk associated with the search
              assignedToUserId:
                type: integer
                description: Id of the user assigned to the search
                format: int32
              assignedUser:
                type: string
                description: Name of the user assigned to the search
              createdById:
                type: integer
                description: Id of the user who created the search
                format: int32
              createdBy:
                type: string
                description: Name of the user who created the search
              createdAt:
                type: string
                description: Search created date time
                format: date-time
              modifiedById:
                type: integer
                description: Id of the user who modified the search
                format: int32
              modifiedBy:
                type: string
                description: Name of the user who modified the search
              modifiedAt:
                type: string
                description: Search modified date time
                format: date-time
              note:
                type: string
                description: Note associated with the search
              totalHitCount:
                type: integer
                description: Total number of hits in the search
                format: int32
              truePositiveHitsCount:
                type: integer
                description: The number of true-positive hits in the search
                format: int32
              falsePositiveHitsCount:
                type: integer
                description: The number of false-positive hits in the search
                format: int32
              undecidedHitsCount:
                type: integer
                description: The number of undecided hits in the search
                format: int32
              firstName:
                type: string
                description: "First name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
              middleName:
                type: string
                description: "Middle name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
              lastName:
                type: string
                description: "Last name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
              gender:
                type: string
                description: Gender provided in the search
              dateOfBirth:
                type: string
                description: DOB provided in the search
                format: date
              pepTiers:
                type: array
                description: Pep Tiers provided in the search
                items:
                  type: string
              isDobRequired:
                type:
                  - boolean
                  - 'null'
                description: >-
                  Indicates whether date of birth is required for the individual
                  search.
                default: true
        correlationId:
          type: string
          description: A unique ID assigned to this request.
    KYCPostIndividualSearchContract:
      type: object
      required:
        - threshold
        - datasets
      properties:
        countryCodes:
          type: array
          nullable: true
          items:
            type: string
          description: List of Two-letter country code ISO-3166-2.
        threshold:
          type: integer
          description: >-
            Hits with scores below the chosen value will not be shown. <br> Must
            be one of 75, 80, 85, 90, 95, or 100
          format: int32
        name:
          type: string
          nullable: true
          description: Required if FirstName and LastName are not provided
        firstName:
          type: string
          nullable: true
          description: If firstName is provided then lastName must also be provided
        middleName:
          type: string
          nullable: true
          description: middleName is optional, valid along with firstName and lastName only
        lastName:
          type: string
          nullable: true
          description: If LastName is provided then FirstName must also be provided
        dateOfBirth:
          type: string
          nullable: true
          description: >-
            Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the
            future.
          format: date
        gender:
          enum:
            - male
            - female
          type: string
          nullable: true
          description: >-
            Define the gender of the individual you are searching for. Available
            values are male and female.
        pepTiers:
          type: array
          nullable: true
          items:
            enum:
              - pepTier1
              - pepTier2
              - pepTier3
            type: string
          description: >-
            When searching the PEP dataset, define what tiers of the PEP
            profiles should be included in the results.<br> PEP Tier 1 - senior
            roles<br>  PEP Tier 2 - middle-ranking<br>  PEP Tier 3 - junior
            officials <br><br> If the PEP Dataset is NOT included on the list of
            searched datasets, then this value is ignored. <br><br>The PEP Tier
            filter does not apply to PEP-LINKED Profiles.<br>
        datasets:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Specifies which datasets will be searched <br> PEP - Politically
            Exposed Persons (All)<br> PEP-CURRENT - Only current PEPs<br>
            PEP-FORMER - Only former PEPs<br> PEP-LINKED - Only linked PEPs (PEP
            by Association)<br> SAN - Sanctioned (All)<br> SAN-CURRENT - Only
            current Sanctions <br> SAN-FORMER - Only former Sanctions<br> INS -
            Insolvency <br> AM - Averse Media <br> POI - Profile of Interest
            <br> ENF - Enforcement DD - Disqualified Director
    KycProtectPostPostIndividualSearchResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the search
          format: uuid
        name:
          type: string
          nullable: true
          description: Name provided for the search. Length must not exceed 200 characters
        countryCodes:
          type: array
          items:
            type: string
            nullable: true
          description: Countries provided to the search
        threshold:
          type: integer
          description: Hits with scores below this value will not be shown.
          format: int32
        type:
          type: string
          description: Indicates whether search type is individual or business
        datasets:
          type: array
          items:
            type: string
          description: Provided datasets for the search
        status:
          type: string
          description: Status of the search
        riskRating:
          type: string
          description: Risk associated with the search
        assignedToUserId:
          type: integer
          nullable: true
          description: Id of the user assigned to the search
          format: int32
        assignedUser:
          type: string
          nullable: true
          description: Name of the user assigned to the search
        createdById:
          type: integer
          description: Id of the user who created the search
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the search
        createdAt:
          type: string
          description: Search created date time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who modified the search
          format: int32
        modifiedBy:
          type: string
          description: Name of the user who modified the search
        modifiedAt:
          type: string
          description: Search modified date time
          format: date-time
        note:
          type: string
          nullable: true
          description: Note associated with the search
        totalHitCount:
          type: integer
          description: Total number of hits in the search
          format: int32
        truePositiveHitsCount:
          type: integer
          description: The number of true-positive hits in the search
          format: int32
        falsePositiveHitsCount:
          type: integer
          description: The number of false-positive hits in the search
          format: int32
        undecidedHitsCount:
          type: integer
          description: The number of undecided hits in the search
          format: int32
        firstName:
          type: string
          nullable: true
          description: "First name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
        middleName:
          type: string
          nullable: true
          description: "Middle name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
        lastName:
          type: string
          nullable: true
          description: "Last name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
        gender:
          type: string
          nullable: true
          description: Gender provided in the search
        dateOfBirth:
          type: string
          nullable: true
          description: DOB provided in the search
          format: date
        pepTiers:
          type: array
          items:
            type: string
            nullable: true
          description: Pep Tiers provided in the search
        scheduleId:
          type: string
          nullable: true
          description: Schedule Id linked to the search
        isDobRequired:
          type:
            - boolean
            - 'null'
          description: >-
            Indicates whether date of birth is required for the individual
            search.
          default: true
    KYCGetSearchIndividualBySearchIdResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the search
          format: uuid
        name:
          type: string
          nullable: true
          description: Name provided for the search. Length must not exceed 200 characters
        countryCodes:
          type: array
          items:
            type: string
          nullable: true
          description: Countries provided to the search
        threshold:
          type: integer
          description: Hits with scores below this value will not be shown.
          format: int32
        type:
          type: string
          description: Indicates whether search type is individual or business
        datasets:
          type: array
          items:
            type: string
          description: Provided datasets for the search
        status:
          type: string
          description: Status of the search
        riskRating:
          type: string
          description: The risk rating being assigned to the profile
          enum:
            - notApplicable
            - veryLow
            - low
            - medium
            - high
            - veryHigh
        assignedToUserId:
          type: integer
          nullable: true
          description: Id of the user assigned to the search
          format: int32
        assignedUser:
          type: string
          nullable: true
          description: Name of the user assigned to the search
        createdById:
          type: integer
          description: Id of the user who created the search
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the search
        createdAt:
          type: string
          description: Search created date time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who modified the search
          format: int32
        modifiedBy:
          type: string
          description: Name of the user who modified the search
        modifiedAt:
          type: string
          description: Search modified date time
          format: date-time
        note:
          type: string
          nullable: true
          description: Note associated with the search
        totalHitCount:
          type: integer
          description: Total number of hits in the search
          format: int32
        truePositiveHitsCount:
          type: integer
          description: The number of true-positive hits in the search
          format: int32
        falsePositiveHitsCount:
          type: integer
          description: The number of false-positive hits in the search
          format: int32
        undecidedHitsCount:
          type: integer
          description: The number of undecided hits in the search
          format: int32
        firstName:
          type: string
          nullable: true
          description: "First name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
        middleName:
          type: string
          nullable: true
          description: "Middle name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
        lastName:
          type: string
          nullable: true
          description: "Last name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
        gender:
          type: string
          nullable: true
          description: Gender provided in the search
        dateOfBirth:
          type: string
          nullable: true
          description: DOB provided in the search
          format: date
        pepTiers:
          type: array
          items:
            type: string
          nullable: true
          description: Pep Tiers provided in the search
        scheduleId:
          type: string
          nullable: true
          description: Schedule Id linked to the search
        isDobRequired:
          type:
            - boolean
            - 'null'
          description: >-
            Indicates whether date of birth is required for the individual
            search.
          default: true
    PutKYCIndividualSearchBySearchIdRequest:
      type: object
      required:
        - riskRating
        - status
      properties:
        assignedToUserId:
          type: integer
          description: Id of the User to assign to the Search
          format: int32
        status:
          type: string
          description: >-
            Status of the Search. Available values are new, approved, declined,
            pending, cancelled, referred and closed.
        riskRating:
          type: string
          description: >-
            Risk rating of the Search and allowed values
            notApplicable,veryLow,low,medium,high and veryHigh
        note:
          type: string
          description: Note associated with the search
    KYCPutSearchIndividualBySearchIdResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the search
          format: uuid
        name:
          type: string
          description: Name provided for the search. Length must not exceed 200 characters
        countryCodes:
          type: array
          description: Countries provided to the search
          items:
            type: string
        threshold:
          type: integer
          description: Hits with scores below this value will not be shown.
          format: int32
        type:
          type: string
          description: Indicates whether search type is individual or business
        datasets:
          type: array
          description: Provided datasets for the search
          items:
            type: string
        status:
          type: string
          description: Status of the search
        riskRating:
          type: string
          description: The risk rating being assigned to the profile
          enum:
            - notApplicable
            - veryLow
            - low
            - medium
            - high
            - veryHigh
        assignedToUserId:
          type: integer
          description: Id of the user assigned to the search
          format: int32
        assignedUser:
          type: string
          description: Name of the user assigned to the search
        createdById:
          type: integer
          description: Id of the user who created the search
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the search
        createdAt:
          type: string
          description: Search created date time
          format: date-time
        modifiedById:
          type: integer
          description: Id of the user who modified the search
          format: int32
        modifiedBy:
          type: string
          description: Name of the user who modified the search
        modifiedAt:
          type: string
          description: Search modified date time
          format: date-time
        note:
          type: string
          description: Note associated with the search
        totalHitCount:
          type: integer
          description: Total number of hits in the search
          format: int32
        truePositiveHitsCount:
          type: integer
          description: The number of true-positive hits in the search
          format: int32
        falsePositiveHitsCount:
          type: integer
          description: The number of false-positive hits in the search
          format: int32
        undecidedHitsCount:
          type: integer
          description: The number of undecided hits in the search
          format: int32
        firstName:
          type: string
          description: "First name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
        middleName:
          type: string
          description: "Middle name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
        lastName:
          type: string
          description: "Last name provided in the search.\r\nThe combination of first name, middle name, and last name must not exceed 200 characters"
        gender:
          type: string
          description: Gender provided in the search
        dateOfBirth:
          type: string
          description: DOB provided in the search
          format: date
        pepTiers:
          type: array
          description: Pep Tiers provided in the search
          items:
            type: string
        scheduleId:
          type: string
          nullable: true
          description: Schedule Id linked to the search
        isDobRequired:
          type:
            - boolean
            - 'null'
          description: >-
            Indicates whether date of birth is required for the individual
            search.
          default: true
        correlationId:
          type: string
          description: A unique ID assigned to this request.
    GetIndividualSearchIdHitsResponse:
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The Id of the search hit.
                format: uuid
              hitScore:
                type: integer
                description: The hit score associated to the search hit.
                format: int32
              name:
                type: string
                nullable: true
                description: The name associated to the search hit.
              match:
                type: string
                nullable: true
                description: The match string associated to the search hit.
              countries:
                type: array
                nullable: true
                items:
                  type: string
                description: The countries associated to the search hit.
              datasets:
                type: array
                items:
                  type: string
                description: The datasets associated to the search hit.
              decision:
                type: string
                description: >-
                  The decision made on the search hit. Available values are
                  undecided, trueMatch, falsePositive and discarded.
              note:
                type: string
                nullable: true
                description: The note added to the search hit.
              modifiedById:
                type: integer
                description: The search hit last modified by user id.
                format: int32
              modifiedBy:
                type: string
                nullable: true
                description: The search hit last modified by user name.
              modifiedAt:
                type: string
                description: The search hit last modified date and time.
                format: date-time
              createdAt:
                type: string
                description: The search hit created date and time.
                format: date-time
              firstName:
                type: string
                nullable: true
                description: The first name of the search hit.
              middleName:
                type: string
                nullable: true
                description: The middle name of the search hit.
              lastName:
                type: string
                nullable: true
                description: The last name of the search hit.
              gender:
                type: string
                nullable: true
                description: The gender associated to the search hit. (male, female)
              datesOfBirth:
                type: array
                nullable: true
                items:
                  type: string
                  description: Can be in the format YYYY or YYYY-MM-DD
                  format: date
                description: The dates of birth associated to the search hit.
              pepTier:
                type: string
                nullable: true
                description: >-
                  The pep tier associated to the search hit. (pepTier1,
                  pepTier2, pepTier3)
              profileImages:
                type: string
                nullable: true
                items:
                  type: string
                description: The profile images associated to the search hit.
              supersededHit:
                type: object
                properties:
                  id:
                    type: string
                    description: The Id of the search hit.
                    format: uuid
                  hitScore:
                    type: integer
                    description: The hit score associated to the search hit.
                    format: int32
                  name:
                    type: string
                    nullable: true
                    description: The name associated to the search hit.
                  match:
                    type: string
                    nullable: true
                    description: The match string associated to the search hit.
                  countries:
                    type: array
                    nullable: true
                    items:
                      type: string
                    description: The countries associated to the search hit.
                  datasets:
                    type: array
                    items:
                      type: string
                    description: The datasets associated to the search hit.
                  decision:
                    type: string
                    description: >-
                      The decision made on the search hit. Available values are
                      undecided, trueMatch, falsePositive and discarded.
                  note:
                    type: string
                    nullable: true
                    description: The note added to the search hit.
                  modifiedById:
                    type: integer
                    description: The search hit last modified by user id.
                    format: int32
                  modifiedBy:
                    type: string
                    nullable: true
                    description: The search hit last modified by user name.
                  modifiedAt:
                    type: string
                    description: The search hit last modified date and time.
                    format: date-time
                  createdAt:
                    type: string
                    description: The search hit created date and time.
                    format: date-time
                  firstName:
                    type: string
                    nullable: true
                    description: The first name of the search hit.
                  middleName:
                    type: string
                    nullable: true
                    description: The middle name of the search hit.
                  lastName:
                    type: string
                    nullable: true
                    description: The last name of the search hit.
                  gender:
                    type: string
                    nullable: true
                    description: The gender associated to the search hit. (male, female)
                  datesOfBirth:
                    type: array
                    nullable: true
                    items:
                      type: string
                      description: Can be in the format YYYY or YYYY-MM-DD
                      format: date
                    description: The dates of birth associated to the search hit.
                  pepTier:
                    type: string
                    nullable: true
                    description: >-
                      The pep tier associated to the search hit. (pepTier1,
                      pepTier2, pepTier3)
                  profileImages:
                    type: array
                    nullable: true
                    items:
                      type: string
                    description: The profile images associated to the search hit.
        totalSize:
          type: number
    IndividualSearchUpdateHitRequest:
      type: object
      required:
        - hitId
      properties:
        decision:
          type: string
          nullable: true
          description: "The Decision of the Hit to be updated\r\nDecision can only be made once and allowed values are undecided,trueMatch and falsePositive"
        note:
          type: string
          nullable: true
          description: Note associated with the Hit
        hitId:
          type: string
          nullable: true
          description: The Id of the Hit to be updated
          format: uuid
      additionalProperties: false
    MODEL20274f:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/IndividualSearchUpdateHitRequest'
    PutIndividualSearchIdHitsResponse:
      type: object
      properties:
        failed:
          type: array
          items:
            type: object
            properties:
              failedItem:
                type: object
                properties:
                  decision:
                    description: >-
                      The Decision of the Hit to be updated Decision can only be
                      made once. Available values are undecided, truematch,
                      falsepositive, discarded
                    type: string
                    nullable: true
                  note:
                    type: string
                    nullable: true
                    description: Note associated with the Hit
                  hitId:
                    type: string
                    nullable: true
                    description: The Id of the Hit to be updated
              error:
                type: object
                properties:
                  type:
                    type: string
                    nullable: true
                  title:
                    type: string
                    nullable: true
                  status:
                    type: integer
                    nullable: true
                  detail:
                    type: string
                    nullable: true
                  instance:
                    type: string
                    nullable: true
        successful:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The Id of the search hit.
                format: uuid
              hitScore:
                type: integer
                description: The hit score associated to the search hit.
                format: int32
              name:
                type: string
                description: The name associated to the search hit.
                nullable: true
              match:
                type: string
                nullable: true
                description: The match string associated to the search hit.
              countries:
                type: array
                nullable: true
                items:
                  type: string
                description: The countries associated to the search hit.
              datasets:
                type: array
                items:
                  type: string
                description: The datasets associated to the search hit.
              decision:
                type: string
                description: >-
                  The decision made on the search hit. Available values are
                  undecided, trueMatch, falsePositive anddiscarded.
              note:
                type: string
                nullable: true
                description: The note added to the search hit.
              modifiedById:
                type: integer
                description: The search hit last modified by user id.
                format: int32
              modifiedBy:
                type: string
                nullable: true
                description: The search hit last modified by user name.
              modifiedAt:
                type: string
                description: The search hit last modified date and time.
                format: date-time
              createdAt:
                type: string
                description: The search hit created date and time.
                format: date-time
              firstName:
                type: string
                nullable: true
                description: The first name of the search hit.
              middleName:
                type: string
                nullable: true
                description: The middle name of the search hit.
              lastName:
                type: string
                nullable: true
                description: The last name of the search hit.
              gender:
                type: string
                nullable: true
                description: The gender associated to the search hit. (male, female)
              datesOfBirth:
                type: array
                nullable: true
                items:
                  type: string
                  description: Can be in the format YYYY or YYYY-MM-DD
                  format: date
                description: The dates of birth associated to the search hit.
              pepTier:
                type: string
                nullable: true
                description: >-
                  The pep tier associated to the search hit. (pepTier1,
                  pepTier2, pepTier3)
              profileImages:
                type: array
                nullable: true
                items:
                  type: string
                description: The profile images associated to the search hit.
              supersededHit:
                type: object
                properties:
                  id:
                    type: string
                    description: The Id of the search hit.
                    format: uuid
                  hitScore:
                    type: integer
                    description: The hit score associated to the search hit.
                    format: int32
                  name:
                    type: string
                    nullable: true
                    description: The name associated to the search hit.
                  match:
                    type: string
                    nullable: true
                    description: The match string associated to the search hit.
                  countries:
                    type: array
                    nullable: true
                    items:
                      type: string
                    description: The countries associated to the search hit.
                  datasets:
                    type: array
                    items:
                      type: string
                    description: The datasets associated to the search hit.
                  decision:
                    type: string
                    description: >-
                      The decision made on the search hit. Available values are
                      undecided, trueMatch, falsePositive and discarded.
                  note:
                    type: string
                    nullable: true
                    description: The note added to the search hit.
                  modifiedById:
                    type: integer
                    description: The search hit last modified by user id.
                    format: int32
                  modifiedBy:
                    type: string
                    nullable: true
                    description: The search hit last modified by user name.
                  modifiedAt:
                    type: string
                    description: The search hit last modified date and time.
                    format: date-time
                  createdAt:
                    type: string
                    description: The search hit created date and time.
                  firstName:
                    type: string
                    nullable: true
                    description: The first name of the search hit.
                  middleName:
                    type: string
                    nullable: true
                    description: The middle name of the search hit.
                  lastName:
                    type: string
                    nullable: true
                    description: The last name of the search hit.
                  gender:
                    type: string
                    nullable: true
                    description: The gender associated to the search hit. (male, female)
                  datesOfBirth:
                    type: array
                    nullable: true
                    items:
                      type: string
                      description: Can be in the format YYYY or YYYY-MM-DD
                      format: date
                    description: The dates of birth associated to the search hit.
                  pepTier:
                    type: string
                    nullable: true
                    description: >-
                      The pep tier associated to the search hit. (pepTier1,
                      pepTier2, pepTier3)
                  profileImages:
                    type: array
                    nullable: true
                    items:
                      type: string
                    description: The profile images associated to the search hit.
        correlationId:
          type: string
          description: A unique ID assigned to this request.
    SearchResultHitsIdentifierResponse:
      type: object
      properties:
        type:
          type: string
          description: The type of the hit identifier.
        value:
          type: string
          description: The value of the hit identifier.
    SearchResultHitsAddressResponse:
      type: object
      properties:
        postalCode:
          type: string
          nullable: true
          description: The postal code of the address.
        line1:
          type: string
          nullable: true
          description: The line1 of the address.
        line2:
          type: string
          nullable: true
          description: The line2 of the address.
        type:
          type: string
          nullable: true
          description: The type of the address.
        county:
          type: string
          nullable: true
          description: The county of the address.
        countryCode:
          type: string
          nullable: true
          description: The country code of the address.
        city:
          type: string
          nullable: true
          description: The city of the address.
      additionalProperties: false
    SearchResultHitsContactResponse:
      type: object
      properties:
        type:
          enum:
            - telephone
            - fax
            - mobile
            - email
            - website
          type: string
        value:
          type: string
      additionalProperties: false
    SearchResultHitsIndividualLinkResponse:
      type: object
      properties:
        relationship:
          type: string
          description: The relationship of the associated link.
        ownershipPercentage:
          type: integer
          nullable: true
          description: The ownership percentage of the associated link.
          format: int32
        datasets:
          type: array
          items:
            type: string
          description: The datasets associated with the link.
        firstName:
          type: string
          nullable: true
          description: The first name of the individual link.
        middleName:
          type: string
          nullable: true
          description: The middle name of the individual link.
        lastName:
          type: string
          nullable: true
          description: The last name of the individual link.
      additionalProperties: false
    SearchResultHitsBusinessLinkResponse:
      type: object
      properties:
        relationship:
          type: string
          description: The relationship of the associated link.
        ownershipPercentage:
          type: integer
          description: The ownership percentage of the associated link.
          format: int32
          nullable: true
        datasets:
          type: array
          items:
            type: string
          description: The datasets associated with the link.
        name:
          type: string
          description: The name of the link.
        individualLinks:
          type: array
          items:
            $ref: '#/components/schemas/SearchResultHitsIndividualLinkResponse'
          description: The individual links associated to the business link.
      additionalProperties: false
    SearchResultHitsSourceResponse:
      type: object
      properties:
        title:
          type: string
          nullable: true
          description: The title of the hit source.
        description:
          type: string
          nullable: true
          description: The description of the hit source.
        link:
          type: string
          description: The URL associated to the hit source.
        dateAdded:
          type: string
          nullable: true
          description: The date when the hit source is added.
          format: date
        isCopyrighted:
          type: string
          nullable: true
          description: Represents whether hit source is copyrighted.
        datePublished:
          type: string
          nullable: true
          description: The date when hit source is published.
          format: date
        documentLink:
          type: string
          nullable: true
          description: The document link associated to the hit source.
        datasets:
          type: string
          nullable: true
          items:
            type: string
          description: The datasets associated with the hit source.
      additionalProperties: false
    SearchResultHitsIndividualAliasResponse:
      type: object
      properties:
        type:
          type: string
          nullable: true
        firstName:
          type: string
          nullable: true
        middleName:
          type: string
          nullable: true
        lastName:
          type: string
          nullable: true
      additionalProperties: false
    ApplicationSearchesModelsHitsEntriesDisqualifiedDirectorEntryValue:
      type: object
      properties:
        referenceNumber:
          type: string
          nullable: true
        fromDate:
          type: string
          nullable: true
          format: date-time
        toDate:
          type: string
          nullable: true
          format: date-time
        organisations:
          type: array
          nullable: true
          items:
            type: string
        reason:
          type: string
    WebApiModelsSearchesSearchResultHitsEntriesDisqualifiedDirectorEntryResponse:
      type: object
      properties:
        events:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse
        sources:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse
        type:
          type: string
          description: >-
            Available values are adverseMedia, disqualifiedDirector,
            insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement,
            sanction, stateOwnedEnterprise
        value:
          $ref: >-
            #/components/schemas/ApplicationSearchesModelsHitsEntriesDisqualifiedDirectorEntryValue
    WebApiModelsSearchesSearchResultHitsEntriesPepEntryValueResponse:
      type: object
      properties:
        country:
          type: string
        position:
          type: string
        fromDate:
          type: string
          nullable: true
          description: Can be in the format YYYY or YYYY-MM-DD
          format: date
        toDate:
          type: string
          nullable: true
          description: Can be in the format YYYY or YYYY-MM-DD
          format: date
        segment:
          type: string
    WebApiModelsSearchesSearchResultHitsEntriesPepEntryResponse:
      type: object
      properties:
        events:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse
        sources:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse
        type:
          type: string
          description: >-
            Available values are adverseMedia, disqualifiedDirector,
            insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement,
            sanction, stateOwnedEnterprise
        value:
          $ref: >-
            #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepEntryValueResponse
    WebApiModelsSearchesSearchResultHitsEntriesPepByAssociationEntryValueResponse:
      type: object
      properties:
        firstName:
          type: string
          nullable: true
        middleName:
          type: string
          nullable: true
        lastName:
          type: string
        relationship:
          type: string
        ownershipPercentage:
          type: integer
          nullable: true
          format: int32
        datasets:
          type: array
          items:
            type: string
    WebApiModelsSearchesSearchResultHitsEntriesPepByAssociationEntryResponse:
      type: object
      properties:
        events:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEventsHitEventResponse
        sources:
          type: array
          nullable: true
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsHitSourceResponse
        type:
          type: string
          description: >-
            Available values are adverseMedia, disqualifiedDirector,
            insolvencyRegister, pep, pepLinked, profileOfInterest, enforcement,
            sanction, stateOwnedEnterprise
        value:
          $ref: >-
            #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepByAssociationEntryValueResponse
    WebApiModelsSearchesSearchResultHitsHitAmlResultsPepsResponse:
      type: object
      properties:
        CURRENT:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepEntryResponse
        FORMER:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepEntryResponse
        LINKED:
          type: array
          items:
            $ref: >-
              #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesPepByAssociationEntryResponse
    IndividualSearchResultHitResponse:
      type: object
      properties:
        id:
          type: string
          description: The Id of the search hit
          format: uuid
        hitScore:
          type: integer
          description: The hit score associated to the search hit.
          format: int32
        name:
          type: string
          description: The name associated to the search hit.
        match:
          type: string
          description: The match string associated to the search hit.
        note:
          type: string
          description: The note added to the search hit.
        countries:
          type: array
          items:
            type: string
          description: The countries associated to the search hit.
        datasets:
          type: array
          items:
            type: string
          description: The datasets associated to the search hit.
        profileImages:
          type: array
          items:
            type: string
          description: The profile images associated to the search hit.
        screeningNotes:
          type: array
          items:
            type: string
          description: The screening notes associated to the search hit.
        modifiedAt:
          type: string
          description: The search hit modified date and time.
          format: date-time
        modifiedById:
          type: integer
          description: The search hit modified by user id.
          format: int32
        modifiedBy:
          type: string
          description: The search hit modified by user name.
        createdAt:
          type: string
          description: The search hit created date and time.
          format: date-time
        decision:
          enum:
            - undecided
            - trueMatch
            - falsePositive
          type: string
          description: The decision made on the search hit.
        identifiers:
          type: array
          items:
            $ref: '#/components/schemas/SearchResultHitsIdentifierResponse'
          description: The identifiers associated to the search hit.
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/SearchResultHitsAddressResponse'
          description: The addresses associated to the search hit.
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/SearchResultHitsContactResponse'
          description: The contact details associated to the search hit.
        businessLinks:
          type: array
          items:
            $ref: '#/components/schemas/SearchResultHitsBusinessLinkResponse'
          description: The business links associated to the search hit.
        individualLinks:
          type: array
          items:
            $ref: '#/components/schemas/SearchResultHitsIndividualLinkResponse'
          description: The individual links associated to the search hit.
        sources:
          type: array
          items:
            $ref: '#/components/schemas/SearchResultHitsSourceResponse'
          description: The sources associated to the search hit.
        firstName:
          type: string
          description: The first name of the individual search hit.
        middleName:
          type: string
          description: The middle name of the individual search hit.
        lastName:
          type: string
          description: The last name of the individual search hit.
        gender:
          enum:
            - male
            - female
          type: string
          nullable: true
          description: The gender associated with the search hit.
        datesOfBirth:
          type: array
          items:
            type: string
            description: Can be in the format YYYY or YYYY-MM-DD
            format: date
          description: The dates of birth associated to the search hit.
        isDeceased:
          type: boolean
          description: The deceased status of the individual associated to the search hit
        datesOfDeath:
          type: array
          items:
            type: string
            description: Can be in the format YYYY or YYYY-MM-DD
            format: date
          description: The dates of death associated to the search hit.
        pepTier:
          enum:
            - tier1
            - tier2
            - tier3
          type: string
          description: The pep tier associated to the search hit.
        aliases:
          type: array
          items:
            $ref: '#/components/schemas/SearchResultHitsIndividualAliasResponse'
          description: The aliases associated to the search hit.
        amlResults:
          type: object
          properties:
            AM:
              type: array
              items:
                $ref: >-
                  #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesAdverseMediaEntryResponse
            ENF:
              type: array
              items:
                $ref: >-
                  #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesEnforcementEntryResponse
            INS:
              type: array
              items:
                $ref: >-
                  #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesInsolvencyEntryResponse
            POI:
              type: array
              items:
                $ref: >-
                  #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesProfileOfInterestEntryResponse
            SAN:
              $ref: >-
                #/components/schemas/WebApiModelsSearchesSearchResultHitsHitAmlResultsSanctionsResponse
            DD:
              type: array
              items:
                $ref: >-
                  #/components/schemas/WebApiModelsSearchesSearchResultHitsEntriesDisqualifiedDirectorEntryResponse
            PEP:
              $ref: >-
                #/components/schemas/WebApiModelsSearchesSearchResultHitsHitAmlResultsPepsResponse
    IndividualsSearchResultUpdateHits:
      type: object
      properties:
        decision:
          type: string
          description: >-
            The Decision of the Hit to be updated. The Decision can only be made
            once. <br>Allowed values are undecided,trueMatch and falsePositive
        note:
          type: string
          description: Note associated with the Hit
    PutIndividualSearchIdHitsByHitIdResponse:
      type: object
      properties:
        id:
          type: string
          description: The Id of the search hit.
          format: uuid
        hitScore:
          type: integer
          description: The hit score associated to the search hit.
          format: int32
        name:
          type: string
          description: The name associated to the search hit.
        match:
          type: string
          description: The match string associated to the search hit.
        countries:
          type: array
          description: The countries associated to the search hit.
          items:
            type: string
        datasets:
          type: array
          description: The datasets associated to the search hit.
          items:
            type: string
        decision:
          type: string
          description: >-
            The decision made on the search hit. Available values are undecided,
            trueMatch, falsePositive and discarded.
        note:
          type: string
          description: The note added to the search hit.
        modifiedById:
          type: integer
          description: The search hit last modified by user id.
          format: int32
        modifiedBy:
          type: string
          description: The search hit last modified by user name.
        modifiedAt:
          type: string
          description: The search hit last modified date and time.
          format: date-time
        createdAt:
          type: string
          description: The search hit created date and time.
          format: date-time
        firstName:
          type: string
          description: The first name of the search hit.
        middleName:
          type: string
          description: The middle name of the search hit.
        lastName:
          type: string
          description: The last name of the search hit.
        gender:
          type: string
          description: The gender associated to the search hit. (male, female)
        datesOfBirth:
          type: array
          description: The dates of birth associated to the search hit.
          items:
            type: string
            description: Can be in the format YYYY or YYYY-MM-DD
            format: date
        pepTier:
          type: string
          description: >-
            The pep tier associated to the search hit. (pepTier1, pepTier2,
            pepTier3)
        profileImages:
          type: array
          description: The profile images associated to the search hit.
          items:
            type: string
        supersededHit:
          type: object
          properties:
            id:
              type: string
              description: The Id of the search hit.
              format: uuid
            hitScore:
              type: integer
              description: The hit score associated to the search hit.
              format: int32
            name:
              type: string
              description: The name associated to the search hit.
            match:
              type: string
              description: The match string associated to the search hit.
            countries:
              type: array
              description: The countries associated to the search hit.
              items:
                type: string
            datasets:
              type: array
              description: The datasets associated to the search hit.
              items:
                type: string
            decision:
              type: string
              description: >-
                The decision made on the search hit. Available values are
                undecided, trueMatch, falsePositive and discarded.
            note:
              type: string
              description: The note added to the search hit.
            modifiedById:
              type: integer
              description: The search hit last modified by user id.
              format: int32
            modifiedBy:
              type: string
              description: The search hit last modified by user name.
            modifiedAt:
              type: string
              description: The search hit last modified date and time.
              format: date-time
            createdAt:
              type: string
              description: The search hit created date and time.
              format: date-time
            firstName:
              type: string
              description: The first name of the search hit.
            middleName:
              type: string
              description: The middle name of the search hit.
            lastName:
              type: string
              description: The last name of the search hit.
            gender:
              type: string
              description: The gender associated to the search hit. (male, female)
            datesOfBirth:
              type: array
              description: The dates of birth associated to the search hit.
              items:
                type: string
                description: Can be in the format YYYY or YYYY-MM-DD
                format: date
            pepTier:
              type: string
              description: >-
                The pep tier associated to the search hit. (pepTier1, pepTier2,
                pepTier3)
            profileImages:
              type: array
              description: The profile images associated to the search hit.
              items:
                type: string
        correlationId:
          type: string
          description: A unique ID assigned to this request.
    ScheduleResponse:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The id of the schedule
                format: uuid
              searchId:
                type: string
                description: The id of the search that was being scheduled
                format: uuid
              isEmailRequired:
                type: boolean
                description: >-
                  Indicates whether the schedule requires an email to be sent
                  when the search is run
              emailRecipients:
                type: array
                items:
                  type: string
                description: >-
                  The email recipients that the email should be sent to when the
                  search is run
              createdById:
                type: integer
                description: The id of the user who created the schedule
                format: int32
              createdAt:
                type: string
                description: The time the schedule was created
                format: date-time
              createdBy:
                type: string
                description: The name of the user who created the schedule
              modifiedById:
                type: integer
                description: The id of the user who last modified the schedule
                format: int32
              modifiedAt:
                type: string
                description: The time the schedule was last modified
                format: date-time
              modifiedBy:
                type: string
                description: The name of the user who last modified the schedule
              type:
                type: string
                description: The type of the schedule, i.e. business or individual
              name:
                type: string
                description: The name used in the search criteria
              firstName:
                type: string
                description: The first name used in the search criteria
              middleName:
                type: string
                description: The middle name used in the search criteria
              lastName:
                type: string
                description: The last name used in the search criteria
              gender:
                type: string
                description: The gender used in the search criteria, i.e. male or female
              dateOfBirth:
                type: string
                description: The date of birth used in the search criteria
                format: date
              countries:
                type: array
                items:
                  type: string
                description: The list of country codes used in the search criteria
              threshold:
                type: integer
                description: The threshold used in the search criteria
                format: int32
              datasets:
                type: array
                items:
                  type: string
                description: The datasets used in the search criteria
              pepTiers:
                type: array
                items:
                  type: string
                description: The pep tiers used in the search criteria
              isDobRequired:
                type:
                  - boolean
                  - 'null'
                description: >-
                  Indicates whether date of birth is required for the individual
                  search.
                default: true
        totalSize:
          type: number
    MODEL1e2683:
      type: object
      properties:
        items:
          type: array
          description: ''
          items:
            type: object
            properties:
              threshold:
                type: integer
                description: "The threshold to use when running the schedule. Must be one of 75, 80, 85, 90, 95, 100.\r\nChanging threshold will cause even decided results to come back again and a new\r\ndecision will need to be made."
                format: int32
              datasets:
                type: array
                description: "The datasets to use when running the schedule.\r\nChanging datasets will cause even decided results to come back again and a new\r\ndecision will need to be made."
                items:
                  type: string
              isEmailRequired:
                type: boolean
                description: "Set to true to send an email when the schedule is run. If there are no email recipients set then\r\nthis will be ignored."
              emailRecipients:
                type: array
                description: >-
                  The list of email recipients to send the email to when the
                  schedule is run. Email will not be sent IsEmailRequired is
                  false.
                items:
                  type: string
              scheduleId:
                type: string
                description: The id of the schedule to be updated
                format: uuid
    PutKYCProtectSchedulesResponse:
      type: object
      properties:
        failed:
          type: array
          items:
            type: object
            properties:
              failedItem:
                type: object
                properties:
                  threshold:
                    type: integer
                    description: "The threshold to use when running the schedule. Must be one of 75, 80, 85, 90, 95, 100.\r\nChanging threshold will cause even decided results to come back again and a new\r\ndecision will need to be made."
                    format: int32
                  datasets:
                    type: array
                    description: "The datasets to use when running the schedule.\r\nChanging datasets will cause even decided results to come back again and a new\r\ndecision will need to be made."
                    items:
                      type: string
                  isEmailRequired:
                    type: boolean
                    description: "Set to true to send an email when the schedule is run. If there are no email recipients set then\r\nthis will be ignored."
                  emailRecipients:
                    type: array
                    description: >-
                      The list of email recipients to send the email to when the
                      schedule is run. Email will not be sent if IsEmailRequired
                      is false.
                    items:
                      type: string
                  scheduleId:
                    type: string
                    description: The id of the schedule to be updated
                    format: uuid
              error:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: integer
                    format: int32
                  detail:
                    type: string
                  instance:
                    type: string
        successful:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The id of the schedule
                format: uuid
              searchId:
                type: string
                description: The id of the search that was being scheduled
                format: uuid
              isEmailRequired:
                type: boolean
                description: >-
                  Indicates whether the schedule requires an email to be sent
                  when the search is run
              emailRecipients:
                type: array
                description: >-
                  The email recipients that the email should be sent to when the
                  search is run
                items:
                  type: string
              createdById:
                type: integer
                description: The id of the user who created the schedule
                format: int32
              createdAt:
                type: string
                description: The time the schedule was created
                format: date-time
              createdBy:
                type: string
                description: The name of the user who created the schedule
              modifiedById:
                type: integer
                description: The id of the user who last modified the schedule
                format: int32
              modifiedAt:
                type: string
                description: The time the schedule was last modified
                format: date-time
              modifiedBy:
                type: string
                description: The name of the user who last modified the schedule
              type:
                type: string
                description: The type of the schedule, i.e. business or individual
              name:
                type: string
                description: The name used in the search criteria
              firstName:
                type: string
                description: The first name used in the search criteria
              middleName:
                type: string
                description: The middle name used in the search criteria
              lastName:
                type: string
                description: The last name used in the search criteria
              gender:
                type: string
                description: The gender used in the search criteria, i.e. male or female
              dateOfBirth:
                type: string
                description: The date of birth used in the search criteria
                format: date
              countries:
                type: array
                description: The list of country codes used in the search criteria
                items:
                  type: string
              threshold:
                type: integer
                description: The threshold used in the search criteria
                format: int32
              datasets:
                type: array
                description: The datasets used in the search criteria
                items:
                  type: string
              pepTiers:
                type: array
                description: >-
                  The pep tiers used in the search criteria, i.e. pepTier1,
                  pepTier2, pepTier3
                items:
                  type: string
              isDobRequired:
                type:
                  - boolean
                  - 'null'
                description: >-
                  Indicates whether date of birth is required for the individual
                  search.
                default: true
        correlationId:
          type: string
          description: A unique ID assigned to this request.
    PostKYCProtectSchedulesRequest:
      type: object
      properties:
        threshold:
          type: integer
          description: "The threshold to use when running the schedule. Must be one of 75, 80, 85, 90, 95, 100.\r\nChanging threshold will cause even decided results to come back again and a new\r\ndecision will need to be made."
          format: int32
        datasets:
          type: array
          items:
            type: string
          description: "The datasets to use when running the schedule.\r\nChanging datasets will cause even decided results to come back again and a new\r\ndecision will need to be made."
        isEmailRequired:
          type: boolean
          description: "Set to true to send an email when the schedule is run. If there are no email recipients set then\r\nthis will be ignored."
        emailRecipients:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            The list of email recipients to send the email to when the schedule
            is run. Email will not be sent if IsEmailRequired is false.
        searchId:
          type: string
          description: The id of the search to be scheduled
          format: uuid
        isDobRequired:
          type:
            - boolean
            - 'null'
          description: >-
            IsDobRequired is optional field and default value is false, valid
            along with dob only.
          default: false
    PostKYCProtectSchedulesResponse:
      type: object
      properties:
        failed:
          type: array
          items:
            type: object
            properties:
              failedItem:
                $ref: '#/components/schemas/PostKYCProtectSchedulesRequest'
              error:
                $ref: '#/components/schemas/KycProtectErrorObject'
        successful:
          type: array
          items:
            $ref: '#/components/schemas/ScheduleResponse'
    DeleteKYCProtectSchedulesResponse:
      type: object
      properties:
        failed:
          type: array
          items:
            type: object
            properties:
              failedItem:
                type: string
                format: uuid
              error:
                $ref: '#/components/schemas/KycProtectErrorObject'
        successful:
          type: array
          items:
            type: string
            format: uuid
    MODEL6bcc20:
      type: object
      properties:
        threshold:
          type: integer
          description: "The threshold to use when running the schedule. Must be one of 75, 80, 85, 90, 95, 100.\r\nChanging threshold will cause even decided results to come back again and a new\r\ndecision will need to be made."
          format: int32
        datasets:
          type: array
          description: "The datasets to use when running the schedule.\r\nChanging datasets will cause even decided results to come back again and a new\r\ndecision will need to be made.<br><br>  Note: Please refer to the corresponding endpoint that the schedule is set against for the correct dataset options"
          items:
            type: string
        isEmailRequired:
          type: boolean
          description: "Set to true to send an email when the schedule is run. If there are no email recipients set then\r\nthis will be ignored."
        emailRecipients:
          type: array
          description: >-
            The list of email recipients to send the email to when the schedule
            is run. Email will not be sent if IsEmailRequired is false.
          items:
            type: string
    KYCProfileScheduleResponse:
      type: object
      properties:
        id:
          type: string
          description: The id of the schedule
          format: uuid
        searchId:
          type: string
          description: The id of the search that was being scheduled
          format: uuid
        isEmailRequired:
          type: boolean
          description: >-
            Indicates whether the schedule requires an email to be sent when the
            search is run
        emailRecipients:
          type: array
          description: >-
            The email recipients that the email should be sent to when the
            search is run
          items:
            type: string
        createdById:
          type: integer
          description: The id of the user who created the schedule
          format: int32
        createdAt:
          type: string
          description: The time the schedule was created
          format: date-time
        createdBy:
          type: string
          description: The name of the user who created the schedule
        modifiedById:
          type: integer
          description: The id of the user who last modified the schedule
          format: int32
        modifiedAt:
          type: string
          description: The time the schedule was last modified
          format: date-time
        modifiedBy:
          type: string
          description: The name of the user who last modified the schedule
        type:
          type: string
          description: The type of the schedule, i.e. business or individual
        name:
          type: string
          description: The name used in the search criteria
        firstName:
          type: string
          description: The first name used in the search criteria
        middleName:
          type: string
          description: The middle name used in the search criteria
        lastName:
          type: string
          description: The last name used in the search criteria
        gender:
          type: string
          description: The gender used in the search criteria, i.e. male or female
        dateOfBirth:
          type: string
          description: The date of birth used in the search criteria
          format: date
        countries:
          type: array
          description: The list of country codes used in the search criteria
          items:
            type: string
        threshold:
          type: integer
          description: The threshold used in the search criteria
          format: int32
        datasets:
          type: array
          description: The datasets used in the search criteria
          items:
            type: string
        pepTiers:
          type: array
          description: >-
            The pep tiers used in the search criteria, i.e. pepTier1, pepTier2,
            pepTier3
          items:
            type: string
        correlationId:
          type: string
          description: A unique ID assigned to this request.
    KYCProfileIdSchedulesScheduleIdResponse:
      type: object
      properties:
        id:
          type: string
          description: The id of the schedule
          format: uuid
        searchId:
          type: string
          description: The id of the search that was being scheduled
          format: uuid
        isEmailRequired:
          type: boolean
          description: >-
            Indicates whether the schedule requires an email to be sent when the
            search is run
        emailRecipients:
          type: array
          description: >-
            The email recipients that the email should be sent to when the
            search is run
          items:
            type: string
        createdById:
          type: integer
          description: The id of the user who created the schedule
          format: int32
        createdAt:
          type: string
          description: The time the schedule was created
          format: date-time
        createdBy:
          type: string
          description: The name of the user who created the schedule
        modifiedById:
          type: integer
          description: The id of the user who last modified the schedule
          format: int32
        modifiedAt:
          type: string
          description: The time the schedule was last modified
          format: date-time
        modifiedBy:
          type: string
          description: The name of the user who last modified the schedule
        type:
          type: string
          description: The type of the schedule, i.e. business or individual
        name:
          type: object
          description: The name used in the search criteria
        firstName:
          type: object
          description: The first name used in the search criteria
        middleName:
          type: object
          description: The middle name used in the search criteria
        lastName:
          type: object
          description: The last name used in the search criteria
        gender:
          type: object
          description: The gender used in the search criteria, i.e. male or female
        dateOfBirth:
          type: object
          description: The date of birth used in the search criteria
          format: date
        countries:
          type: array
          description: The list of country codes used in the search criteria
          items:
            type: string
        threshold:
          type: integer
          description: The threshold used in the search criteria
          format: int32
        datasets:
          type: array
          description: The datasets used in the search criteria
          items:
            type: string
        pepTiers:
          type: array
          description: >-
            The pep tiers used in the search criteria, i.e. pepTier1, pepTier2,
            pepTier3
          items:
            type: string
        correlationId:
          type: string
          description: A unique ID assigned to this request.
    KYCProtectScheduleAmlResponse:
      type: object
      properties:
        id:
          type: string
          description: The id of the schedule.
        searchId:
          type: string
          description: The id of the search that was being scheduled
          format: uuid
        isEmailRequired:
          type: boolean
          description: >-
            Indicates whether the schedule requires an email to be sent when the
            search is run
          default: true
        emailRecipients:
          type: array
          items:
            type: string
          description: >-
            The email recipients that the email should be sent to when the
            search is run.
        name:
          type:
            - string
            - 'null'
          description: The name used in the search criteria.
        countries:
          type:
            - array
            - 'null'
          items:
            type: string
          description: The list of country codes used in the search criteria.
        datasets:
          type:
            - array
            - 'null'
          items:
            type: string
          description: The datasets associated to the search criteria.
        modifiedById:
          type: integer
          description: The id of the user who last modified the schedule.
          format: int32
        modifiedBy:
          type:
            - string
            - 'null'
          description: The name of the user who last modified the schedule.
        modifiedAt:
          type: string
          description: The time the schedule was last modified.
          format: date-time
        createdAt:
          type: string
          description: The time the schedule was created.
          format: date-time
        createdById:
          type: integer
          description: The id of the user who created the schedule
        createdBy:
          type:
            - string
            - 'null'
          description: The name of the user who created the schedule.
        firstName:
          type:
            - string
            - 'null'
          description: The first name used in the search criteria.
        middleName:
          type:
            - string
            - 'null'
          description: The middle name used in the search criteria.
        lastName:
          type:
            - string
            - 'null'
          description: The last name used in the search criteria.
        gender:
          type:
            - string
            - 'null'
          description: The gender used in the search criteria, male, female.
        datesOfBirth:
          type:
            - string
            - 'null'
          description: >-
            The date of birth used in the search criteria. Can be in the format
            YYYY or YYYY-MM-DD
          format: date
        pepTier:
          type:
            - string
            - 'null'
          description: >-
            The pep tiers used in the search criteria, pepTier1, pepTier2,
            pepTier3, byAssociation.
        isDobRequired:
          type:
            - boolean
            - 'null'
          description: Is dob required used in the search criteria.
          default: true
        threshold:
          type: integer
          description: The threshold used in the search criteria.
          format: int32
    KYCProtectBaseIndividualSearchResultHitSummaryResponse:
      type: object
      properties:
        id:
          type: string
          description: The Id of the search hit.
          format: uuid
        hitScore:
          type: integer
          description: The hit score associated to the search hit.
          format: int32
        name:
          type: string
          nullable: true
          description: The name associated to the search hit.
        match:
          type: string
          nullable: true
          description: The match string associated to the search hit.
        countries:
          type: array
          nullable: true
          items:
            type: string
          description: The countries associated to the search hit.
        datasets:
          type: array
          nullable: true
          items:
            type: string
          description: The datasets associated to the search hit.
        decision:
          enum:
            - undecided
            - trueMatch
            - falsePositive
            - discarded
          type: string
          description: The decision made on the search hit.
        note:
          type: string
          nullable: true
          description: The note added to the search hit.
        modifiedById:
          type: integer
          description: The search hit last modified by user id.
          format: int32
        modifiedBy:
          type: string
          nullable: true
          description: The search hit last modified by user name.
        modifiedAt:
          type: string
          description: The search hit last modified date and time.
          format: date-time
        createdAt:
          type: string
          description: The search hit created date and time.
          format: date-time
        firstName:
          type: string
          nullable: true
          description: The first name of the search hit.
        middleName:
          type: string
          nullable: true
          description: The middle name of the search hit.
        lastName:
          type: string
          nullable: true
          description: The last name of the search hit.
        gender:
          enum:
            - male
            - female
          type: string
          nullable: true
          description: The gender associated to the search hit.
        datesOfBirth:
          type: string
          nullable: true
          items:
            type: string
            description: Can be in the format YYYY or YYYY-MM-DD
            format: date
          description: The dates of birth associated to the search hit.
        pepTier:
          enum:
            - pepTier1
            - pepTier2
            - pepTier3
          type: string
          nullable: true
          description: The pep tier associated to the search hit.
        profileImages:
          type: array
          nullable: true
          items:
            type: string
          description: The profile images associated to the search hit.
      additionalProperties: false
    KYCProtectScheduleHitResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The id of the schedule
        searchId:
          type: string
          description: The id of the search that was being scheduled
          format: uuid
        profileId:
          type: string
          nullable: true
          description: The id of the profile linked to the search that was being scheduled
          format: uuid
        scheduleId:
          type: string
          description: The id of the schedule
          format: uuid
        keyPartyId:
          type: string
          nullable: true
          description: >-
            The id of the key party linked to the search that was being
            scheduled
          format: uuid
        searchType:
          enum:
            - individual
            - business
          type: string
          description: The type of the search that was being scheduled
        supersededHit:
          $ref: >-
            #/components/schemas/KYCProtectBaseIndividualSearchResultHitSummaryResponse
        firstName:
          type: string
          nullable: true
          description: The first name of the search hit.
        middleName:
          type: string
          nullable: true
          description: The middle name of the search hit.
        lastName:
          type: string
          nullable: true
          description: The last name of the search hit.
        gender:
          enum:
            - male
            - female
          type: string
          nullable: true
          description: The gender associated to the search hit.
        datesOfBirth:
          type: array
          nullable: true
          items:
            type: string
            description: Can be in the format YYYY or YYYY-MM-DD
            format: date
          description: The dates of birth associated to the search hit.
        pepTier:
          enum:
            - pepTier1
            - pepTier2
            - pepTier3
          type: string
          nullable: true
          description: The pep tier associated to the search hit.
        profileImages:
          type: array
          nullable: true
          items:
            type: string
          description: The profile images associated to the search hit.
        hitScore:
          type: integer
          description: The hit score associated to the search hit.
          format: int32
        name:
          type: string
          nullable: true
          description: The name associated to the search hit.
        match:
          type: string
          nullable: true
          description: The match string associated to the search hit.
        countries:
          type: array
          nullable: true
          items:
            type: string
          description: The countries associated to the search hit.
        datasets:
          type: array
          nullable: true
          items:
            type: string
          description: The datasets associated to the search hit.
        decision:
          enum:
            - undecided
            - trueMatch
            - falsePositive
            - discarded
          type: string
          description: The decision made on the search hit.
        note:
          type: string
          nullable: true
          description: The note added to the search hit.
        modifiedById:
          type: integer
          description: The search hit last modified by user id.
          format: int32
        modifiedBy:
          type: string
          nullable: true
          description: The search hit last modified by user name.
        modifiedAt:
          type: string
          description: The search hit last modified date and time.
          format: date-time
        createdAt:
          type: string
          description: The search hit created date and time.
          format: date-time
      additionalProperties: false
    GetProfileHitsByProfileIdResponse:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The Id of the search hit.
              hitScore:
                type: number
                description: The hit score associated to the search hit.
              name:
                description: The name associated to the search hit.
                type: string
                nullable: true
              match:
                description: The match string associated to the search hit.
                type: string
                nullable: true
              countries:
                description: The countries associated to the search hit.
                type: array
                items:
                  type: string
                nullable: true
              datasets:
                description: The datasets associated to the search hit.
                type: array
                items:
                  type: string
                nullable: true
              decision:
                type: string
                description: The decision made on the search hit.
              note:
                description: The note added to the search hit.
                type: string
                nullable: true
              modifiedById:
                type: number
                description: The search hit last modified by user id.
              modifiedBy:
                description: The search hit last modified by user name.
                type: string
                nullable: true
              modifiedAt:
                type: string
                description: The search hit last modified date and time.
              createdAt:
                type: string
                description: The search hit created date and time.
              firstName:
                description: The first name of the search hit.
                type: string
                nullable: true
              middleName:
                description: The middle name of the search hit.
                type: string
                nullable: true
              lastName:
                description: The last name of the search hit.
                type: string
                nullable: true
              gender:
                description: The gender associated to the search hit.
                type: string
                nullable: true
              datesOfBirth:
                description: The dates of birth associated to the search hit.
                type: array
                items:
                  type: string
                nullable: true
              pepTier:
                description: The pep tier associated to the search hit.
                type: string
                nullable: true
              profileImages:
                description: The profile images associated to the search hit.
                type: array
                items:
                  type: string
                nullable: true
              supersededHit:
                type: object
                properties:
                  id:
                    type: string
                    description: The Id of the search hit.
                  hitScore:
                    type: number
                    description: The hit score associated to the search hit.
                  name:
                    description: The name associated to the search hit.
                    type: string
                    nullable: true
                  match:
                    description: The match string associated to the search hit.
                    type: string
                    nullable: true
                  countries:
                    description: The countries associated to the search hit.
                    type: array
                    items:
                      type: string
                    nullable: true
                  datasets:
                    description: The datasets associated to the search hit.
                    type: array
                    items:
                      type: string
                    nullable: true
                  decision:
                    type: string
                    description: The decision made on the search hit.
                  note:
                    description: The note added to the search hit.
                    type: string
                    nullable: true
                  modifiedById:
                    type: number
                    description: The search hit last modified by user id.
                  modifiedBy:
                    description: The search hit last modified by user name.
                    type: string
                    nullable: true
                  modifiedAt:
                    type: string
                    description: The search hit last modified date and time.
                  createdAt:
                    type: string
                    description: The search hit created date and time.
                  firstName:
                    description: The first name of the search hit.
                    type: string
                    nullable: true
                  middleName:
                    description: The middle name of the search hit.
                    type: string
                    nullable: true
                  lastName:
                    description: The last name of the search hit.
                    type: string
                    nullable: true
                  gender:
                    description: The gender associated to the search hit.
                    type: string
                    nullable: true
                  datesOfBirth:
                    description: The dates of birth associated to the search hit.
                    type: array
                    items:
                      type: string
                    nullable: true
                  pepTier:
                    description: The pep tier associated to the search hit.
                    type: string
                    nullable: true
                  profileImages:
                    description: The profile images associated to the search hit.
                    type: array
                    items:
                      type: string
                    nullable: true
              searchId:
                type: string
                description: The id of the search associated to the hit.
              searchType:
                type: string
                description: The type of search associated to the hit.
        totalSize:
          type: number
    GetKycProtectAsyncAmlJobItemResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - created
            - processing
            - completed
        createdAt:
          type: string
          format: date-time
        createdById:
          type: integer
          format: int32
        createdBy:
          type: string
        startedAt:
          type: string
          format: date-time
          nullable: true
        finishedAt:
          type: string
          format: date-time
          nullable: true
        criteriaCount:
          type: integer
          format: int32
    GetKycProtectAsyncAmlJobResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/GetKycProtectAsyncAmlJobItemResponse'
        totalSize:
          type: integer
    KycProtectAsyncJobCriteriaResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        jobId:
          type: string
          format: uuid
        status:
          enum:
            - submitted
            - processing
            - completed
            - failed
          type: string
        errorMessage:
          type: string
          nullable: true
        targetType:
          enum:
            - profile
            - keyParty
          type: string
        targetId:
          type: string
          format: uuid
        type:
          enum:
            - individual
            - business
          type: string
        startedAt:
          type: string
          format: date-time
          nullable: true
        finishedAt:
          type: string
          format: date-time
          nullable: true
        countryCodes:
          type: array
          items:
            type: string
            nullable: true
        threshold:
          type: integer
          format: int32
        name:
          type: string
          nullable: true
        firstName:
          type: string
          nullable: true
        middleName:
          type: string
          nullable: true
        lastName:
          type: string
          nullable: true
        dateOfBirth:
          type: string
          description: Can be in the format YYYY or YYYY-MM-DD
          format: date
          nullable: true
        gender:
          enum:
            - male
            - female
          type: string
          nullable: true
        pepTiers:
          type: array
          items:
            type: string
            enum:
              - pepTier1
              - pepTier2
              - pepTier3
            nullable: true
        datasets:
          type: array
          items:
            type: string
        isDobRequired:
          type:
            - boolean
            - 'null'
          description: >-
            Indicates whether date of birth is required for the individual
            search.
    GetKycProtectAsyncAmlJobCriteriaResponse:
      type: object
      properties:
        items:
          $ref: '#/components/schemas/KycProtectAsyncJobCriteriaResponse'
        totalSize:
          type: integer
          format: int64
    GetAuditsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Id of the Audit
                format: uuid
              description:
                type: string
                description: Description of the Audit
              category:
                enum:
                  - profile
                  - amlSearch
                type: string
                description: Category of the audit
              subcategory:
                enum:
                  - profileDetails
                  - keyParty
                  - amlMonitoring
                type: string
                description: Subcategory of the audit
                nullable: true
              action:
                enum:
                  - created
                  - updated
                  - deleted
                  - searchRemoved
                  - searchLinked
                  - attachmentCreated
                  - attachmentUpdated
                  - attachmentDeleted
                  - noteCreated
                  - noteUpdated
                  - noteDeleted
                  - noteArchived
                  - noteUnarchived
                  - addressCreated
                  - addressUpdated
                  - addressDeleted
                  - kycStatusUpdated
                  - addedToAmlMonitoring
                  - updatedInAmlMonitoring
                  - removedFromAmlMonitoring
                type: string
                description: Action of the audit
              createdAt:
                type: string
                description: Audit created date and time
                format: date-time
              createdById:
                type: integer
                description: Id of the user who created the audit
                format: int32
              createdBy:
                type: string
                description: Name of the user who created the audit
              payload:
                type: object
                description: >-
                  The `payload` property represents the state of involved
                  entities at the time of action taking place.<br><br> This
                  property contains dynamic data that varies depending on the
                  request parameters and the context of the request. The
                  response and can differ even with the same parameters under
                  different conditions or contexts.<br><br> This means the
                  content of this property is not fixed and can include various
                  data types such as GUIDs, strings, integers, and complex
                  objects.<br><br> Due to its dynamic nature, the `payload` can
                  include any of the following potential structures, but is not
                  limited to these examples  <li> A single key-value pair where
                  thecvalue is a string or number. </li> <li> A nested object
                  containing detailed data structures. </li> <li> An array of
                  objects each with different attributes.</li> <br><br>
                  Consumers of this API should handle the `payload` dynamically
                  and be prepared to encounter different data types and
                  structures.<br> Detailed processing logic based on the
                  specific application needs and context checks is recommended
                  when utilising this field.
                additionalProperties: true
                example:
                  companyId: GB-0-0123456789
                  profileId: 12345f68-1234-1234-1a2b-1a12bb4c578
                  safeNumber: UK0122345678
                  profileName: Example Profile
            additionalProperties: false
            description: Represents a response object for audits.
        totalSize:
          type: integer
        correlationId:
          type: string
    GetBatchUploadsTemplateResponse:
      type: object
      properties:
        downloadUrl:
          type: string
          description: Url of the file to download
        fileName:
          type: string
          description: Name of the file
        expiresAt:
          type: string
          description: Date and time when the url will expire
          format: date-time
        correlationId:
          type: string
          description: Unique GUID for the specific request
    GetKycProtectBatchUploadsByUploadIdItemResponse:
      description: Model for batch upload response
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          description: Batch upload request Id
          format: uuid
        filename:
          type: string
          description: User given file name
        status:
          enum:
            - submitted
            - validating
            - rejected
            - validated
            - insufficientCredits
            - queued
            - inProgress
            - processed
            - completed
            - partiallyCompleted
            - failed
          type: string
          description: Batch upload status
        rowCount:
          type: integer
          description: Batch upload file record count
          format: int32
        successCount:
          type: integer
          description: Successful record count in batch upload file
          format: int32
        uploadedAt:
          type: string
          description: Batch upload requested timestamp
          format: date-time
        uploadedById:
          type: integer
          description: Batch upload requested by user id
          format: int32
        uploadedBy:
          type: string
          description: Batch file uploaded by user
        completedAt:
          type: string
          description: Batch upload completed timestamp
          format: date-time
          nullable: true
    GetKycProtectBatchUploadsByUploadsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/GetKycProtectBatchUploadsByUploadIdItemResponse
        totalSize:
          type: integer
    PostKycProtectBatchUploadsRequest:
      type: object
      required:
        - File
      properties:
        File:
          type: string
          description: The batch file to be processed. Size Limited to 10MB
          format: binary
    GetBatchUploadsDownloadErrorsByUploadIdResponse:
      type: object
      properties:
        downloadUrl:
          type: string
          description: Url of the file to download
        fileName:
          type: string
          description: Name of the file
        expiresAt:
          type: string
          description: Date and time when the url will expire
          format: date-time
    PutBatchUploadsRetryByIdResponse:
      type: object
      properties:
        id:
          type: string
          description: Batch upload request Id
          format: uuid
        filename:
          type: string
          description: User given file name
        status:
          type: string
          description: >-
            Batch upload status (submitted, validating, rejected, validated,
            insufficientCredits, queued, inProgress, processed, completed,
            partiallyCompleted, failed)
        rowCount:
          type: integer
          description: Batch upload file record count
          format: int32
        successCount:
          type: integer
          description: Successful record count in batch upload file
          format: int32
        uploadedAt:
          type: string
          description: Batch upload requested timestamp
          format: date-time
        uploadedById:
          type: integer
          description: Batch upload requested by user id
          format: int32
        uploadedBy:
          type: string
          description: Batch file uploaded by user
        completedAt:
          type: string
          nullable: true
          description: Batch upload completed timestamp
          format: date-time
    PostKYCMonitoringProfilesBulkResquest:
      type: object
      properties:
        items:
          type: array
          items:
            type: string
            format: uuid
          description: Provide the list of profile Id's in the array.
          nullable: true
    PostKYCMonitoringProfilesBulkResponse:
      type: object
      properties:
        failed:
          type: array
          items:
            type: object
            properties:
              failedItem:
                type: string
                format: uuid
                description: Provides a list of failed profiles
              error:
                type: object
                description: Expanded detail about the error on the listed profile
                properties:
                  type:
                    type: string
                    nullable: true
                  title:
                    type: string
                    nullable: true
                  status:
                    type: integer
                    format: int32
                    nullable: true
                  detail:
                    type: string
                    nullable: true
                  instance:
                    type: string
                    nullable: true
          nullable: true
        successful:
          type: array
          items:
            type: string
            format: uuid
            description: >-
              Provides a list of the profiles that have successfully been
              uploaded
          nullable: true
    DeleteKYCMonitoringProfilesResquest:
      type: object
      properties:
        items:
          type: array
          items:
            type: string
            format: uuid
          description: The Request Items collection
          nullable: true
    DeleteKYCMonitoringProfilesResponse:
      type: object
      properties:
        failed:
          type: array
          items:
            type: object
            properties:
              failedItem:
                type: string
                format: uuid
              error:
                type: object
                properties:
                  type:
                    type: string
                    nullable: true
                  title:
                    type: string
                    nullable: true
                  status:
                    type: integer
                    format: int32
                    nullable: true
                  detail:
                    type: string
                    nullable: true
                  instance:
                    type: string
                    nullable: true
          nullable: true
        successful:
          type: array
          items:
            type: string
            format: uuid
          nullable: true
    KycMonitoringKycAlertResponse:
      type: object
      properties:
        id:
          type: string
          description: Id of the kyc alert
          format: uuid
        profileId:
          type: string
          description: Id of the profile
          format: uuid
        safeNumber:
          description: Safe number of the profile
          type: string
          nullable: true
        companyId:
          type: string
          description: Company id of the profile
          nullable: true
        previousValue:
          type: string
          description: Previous value from the kyc alert
          nullable: true
        newValue:
          type: string
          description: New value from the kyc alert
          nullable: true
        ruleName:
          type: string
          description: Rule name from the kyc alert
          nullable: true
        eventAt:
          type: string
          description: Date of the kyc alert when it got created
          format: date-time
        status:
          type: string
          description: Status of kyc alert, open, closedProcessed, closedUnprocessed
        note:
          type: string
          description: Note of kyc alert
        createdAt:
          type: string
          description: Kyc alert created time
          format: date-time
        createdById:
          type: integer
          description: Id of the user who created the kyc alert
          format: int32
        createdBy:
          type: string
          description: Name of the user who created the kyc alert
        modifiedAt:
          type: string
          description: kyc alert last updated time
          format: date-time
          nullable: true
        modifiedById:
          description: Id of the user who last modified the kyc alert
          format: int32
          type: integer
          nullable: true
        modifiedBy:
          type: string
          description: Name of the user who last modified the kyc alert
          nullable: true
    UpdateKycAlertContract:
      type: object
      properties:
        note:
          type: string
          description: Note of kyc alert
          nullable: true
        status:
          type: string
          description: >-
            Status of kyc alert. Allowed values are open, closedProcessed,
            closedUnprocessed
          nullable: true
    KYCProtectProfileAlertsMetricsResponse:
      type: object
      properties:
        profileId:
          description: Id of the Profile
          type: string
          format: uuid
        profileName:
          description: Name of the Profile
          type: string
        internalId:
          description: Internal Id of the Profile
          type: string
          nullable: true
        undecidedSearchHitsCount:
          description: >-
            Count of search hits that are in Undecided state that are associated
            to profile
          type: integer
          format: int32
        openKycAlertsCount:
          description: >-
            Count of kyc alerts that are in Open state that are associated to
            profile
          type: integer
          format: int32
        latestAlertCreatedAt:
          description: The Latest alert created date and time that associated to profile
          type: string
          format: date-time
        latestMonitoringUpdaterRunAt:
          description: The Latest monitoring updater run date and time
          type: string
          format: date-time
          nullable: true
    KYCGetSearchBusinessesDownloadBySearchIdResponse:
      type: object
      properties:
        searchId:
          type: string
          description: Id of the search
          format: uuid
        downloadUrl:
          type: string
          description: Url of the file to download
        fileName:
          type: string
          description: Name of the file
        expiresAt:
          type: string
          description: Date and time when the url will expire
          format: date-time
    KYCGetSearchIndividualsDownloadBySearchIdResponse:
      type: object
      properties:
        searchId:
          type: string
          description: Id of the search
          format: uuid
        downloadUrl:
          type: string
          description: Url of the file to download
        fileName:
          type: string
          description: Name of the file
        expiresAt:
          type: string
          description: Date and time when the url will expire
          format: date-time
    GetKycProtectReportsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
                description: >-
                  Unique identifier for the report, generated when the report is
                  created.
              fileName:
                type: string
                description: >-
                  The name of the report file, as specified during creation or
                  generated automatically.
              status:
                type: string
                description: >
                  Current processing status of the report. Indicates the
                  lifecycle stage, such as:<br> - `submitted`: The report
                  request has been submitted.<br> - `queued`: The report is
                  waiting to be processed.<br> - `inProgress`: The report is
                  currently being generated.<br> - `completed`: The report has
                  been successfully created.<br> - `failed`: The report
                  generation encountered an error.<br>
                enum:
                  - submitted
                  - queued
                  - inProgress
                  - completed
                  - failed
              type:
                type: string
                description: >
                  Type of the report, determining the data and format of the
                  results. Supported values:<br> - `amlAlert`: Report for
                  Anti-Money Laundering alerts.<br> - `audit`: Report for
                  audit-related compliance checks.<br>
                enum:
                  - amlAlert
                  - audit
              createdAt:
                type: string
                format: date-time
                description: The timestamp when the report was initially created.
              createdById:
                type: integer
                format: int32
                description: >-
                  The unique identifier of the user who initiated the creation
                  of the report.
              createdByUser:
                type: string
                description: The username or identifier of the user who created the report.
              modifiedAt:
                type: string
                format: date-time
                description: >-
                  The timestamp of the last modification made to the report, if
                  applicable.
              criteria:
                type: object
                description: >
                  The criteria used to generate the report, reflecting the
                  filters and parameters applied during its creation.<br><br>
                  The structure of the `criteria` object depends on the report
                  `type` (`amlAlert` or `audit`).  Some properties may be nested
                  in arrays or objects.
                properties:
                  fromDate:
                    type: string
                    format: date
                    description: >-
                      The starting date for the report's criteria, defining the
                      range of data included.
                  toDate:
                    type: string
                    format: date
                    description: >-
                      The ending date for the report's criteria. Results exclude
                      this date.
                additionalProperties:
                  description: >
                    Additional fields applicable to the specific report type.
                    These may vary depending on whether the report  type is
                    `amlAlert` or `audit`. Nested arrays and objects are
                    supported for complex criteria.
                  type: object
              expiresAt:
                type: string
                format: date-time
                nullable: true
                description: >-
                  The expiration timestamp for the report, after which it may no
                  longer be accessible.
        totalSize:
          type: integer
          description: The total number of reports available.
        correlationId:
          type: string
          description: >-
            Unique identifier for tracking the request, useful for debugging and
            tracing.
    PostKycProtectReportsRequest:
      type: object
      properties:
        type:
          type: string
          description: Type of the report (e.g., `amlAlert` or `audit`).
          nullable: true
        fileName:
          type: string
          description: File name for the report to be created. This must be unique.
          nullable: true
        criteria:
          type: object
          description: >-
            The criteria used to create the report. These fields should match
            those provided by the `GET /criteria/{type}` endpoint.
          properties:
            additionalProperties:
              type: object
              description: >
                Additional fields specific to the report type (`amlAlert` or
                `audit`) that customize the report's scope  and contents.<br>
                These properties are dynamically generated and may include
                nested objects or arrays  for complex criteria. For example:<br>
                - For `amlAlert`, this may include parameters like
                `hitDecisions` and `hasHits`.<br> - For `audit`, this may
                include date ranges or detailed filtering options.<br><br> Refer
                to the response from the `GET /criteria/{type}` endpoint for a
                complete list of possible fields.
    PostKycProtectReportResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: >-
            Unique identifier for the report, generated when the report is
            created.
        fileName:
          type: string
          description: >-
            The name of the report file, as specified during creation or
            generated automatically.
        status:
          type: string
          description: >
            Current processing status of the report. Indicates the lifecycle
            stage, such as:<br> - `submitted`: The report request has been
            submitted.<br> - `queued`: The report is waiting to be
            processed.<br> - `inProgress`: The report is currently being
            generated.<br> - `completed`: The report has been successfully
            created.<br> - `failed`: The report generation encountered an
            error.<br>
          enum:
            - submitted
            - queued
            - inProgress
            - completed
            - failed
        type:
          type: string
          description: >
            Type of the report, determining the data and format of the results.
            Supported values:<br> - `amlAlert`: Report for Anti-Money Laundering
            alerts.<br> - `audit`: Report for audit-related compliance
            checks.<br>
          enum:
            - amlAlert
            - audit
        createdAt:
          type: string
          format: date-time
          description: The timestamp when the report was initially created.
        createdById:
          type: integer
          format: int32
          description: >-
            The unique identifier of the user who initiated the creation of the
            report.
        createdByUser:
          type: string
          description: The username or identifier of the user who created the report.
        modifiedAt:
          type: string
          format: date-time
          description: >-
            The timestamp of the last modification made to the report, if
            applicable.
        criteria:
          type: object
          description: >
            The criteria used to generate the report, reflecting the filters and
            parameters applied during its creation.<br><br> The structure of the
            `criteria` object depends on the report `type` (`amlAlert` or
            `audit`). Some properties may be nested in arrays or objects.
          properties:
            fromDate:
              type: string
              format: date
              description: >-
                The starting date for the report's criteria, defining the range
                of data included.
            toDate:
              type: string
              format: date
              description: >-
                The ending date for the report's criteria. Results exclude this
                date.
          additionalProperties:
            description: >
              Additional fields applicable to the specific report type. These
              may vary depending on whether the report  type is `amlAlert` or
              `audit`. Nested arrays and objects are supported for complex
              criteria.
            type: object
        expiresAt:
          type: string
          format: date-time
          nullable: true
          description: >-
            The expiration timestamp for the report, after which it may no
            longer be accessible.
        correlationId:
          type: string
          description: >-
            Unique identifier for tracking the request, useful for debugging and
            tracing.
    GetKycProtectReportsResponseByReportId:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: >-
            Unique identifier for the report, generated when the report is
            created.
        fileName:
          type: string
          description: >-
            The name of the report file, as specified during creation or
            generated automatically.
        status:
          type: string
          description: >
            Current processing status of the report. Indicates the lifecycle
            stage, such as:<br> - `submitted`: The report request has been
            submitted.<br> - `queued`: The report is waiting to be
            processed.<br> - `inProgress`: The report is currently being
            generated.<br> - `completed`: The report has been successfully
            created.<br> - `failed`: The report generation encountered an
            error.<br>
          enum:
            - submitted
            - queued
            - inProgress
            - completed
            - failed
        type:
          type: string
          description: >
            Type of the report, determining the data and format of the results.
            Supported values:<br> - `amlAlert`: Report for Anti-Money Laundering
            alerts.<br> - `audit`: Report for audit-related compliance
            checks.<br>
          enum:
            - amlAlert
            - audit
        createdAt:
          type: string
          format: date-time
          description: The timestamp when the report was initially created.
        createdById:
          type: integer
          format: int32
          description: >-
            The unique identifier of the user who initiated the creation of the
            report.
        createdByUser:
          type: string
          description: The username or identifier of the user who created the report.
        modifiedAt:
          type: string
          format: date-time
          description: >-
            The timestamp of the last modification made to the report, if
            applicable.
        criteria:
          type: object
          description: >
            The criteria used to generate the report, reflecting the filters and
            parameters applied during its creation.<br><br> The structure of the
            `criteria` object depends on the report `type` (`amlAlert` or
            `audit`).  Some properties may be nested in arrays or objects.
          properties:
            fromDate:
              type: string
              format: date
              description: >-
                The starting date for the report's criteria, defining the range
                of data included.
            toDate:
              type: string
              format: date
              description: >-
                The ending date for the report's criteria. Results exclude this
                date.
          additionalProperties:
            description: >
              Additional fields applicable to the specific report type. These
              may vary depending on whether the report  type is `amlAlert` or
              `audit`. Nested arrays and objects are supported for complex
              criteria.
            type: object
        expiresAt:
          type: string
          format: date-time
          nullable: true
          description: >-
            The expiration timestamp for the report, after which it may no
            longer be accessible.
        correlationId:
          type: string
          description: >-
            Unique identifier for tracking the request, useful for debugging and
            tracing.
  parameters:
    page:
      name: page
      in: query
      description: Starting page number.
      schema:
        type: integer
        default: 1
    pageSize:
      name: pageSize
      in: query
      description: Number of items to return per Page.
      schema:
        type: integer
security:
  - bearerToken: []
