FrankieOne Audit API

openapi: 3.2.0
info:
  title: Core V2 Audit API
  version: 2.0.0
  description: This is the APIs for V2 Core. It allows you to do common operations, such as read audit entries or get workflow lists.
  contact:
    name: FrankieOne
    url: https://www.frankieone.com/
    email: help@frankieone.com
servers:
- url: https://api.uat.frankie.one
security:
- Api-Key: []
tags:
- name: Audit
  description: Manage audit entries
paths:
  /v2/audit:
    parameters:
    - $ref: '#/components/parameters/Api-Key'
    - $ref: '#/components/parameters/X-Frankie-CustomerID'
    - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
    - $ref: '#/components/parameters/X-Frankie-Channel'
    get:
      summary: List audit events
      description: List all audit events with filtering.
      parameters:
      - $ref: '#/components/parameters/query_filter_entity_id'
      - $ref: '#/components/parameters/query_filter_workflow_names'
      - $ref: '#/components/parameters/query_filter_workflow_risk_levels'
      - $ref: '#/components/parameters/query_filter_sources'
      - $ref: '#/components/parameters/query_filter_request_id'
      - $ref: '#/components/parameters/query_filter_timestamp_after'
      - $ref: '#/components/parameters/query_filter_timestamp_before'
      - $ref: '#/components/parameters/query_filter_channels'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/query_sort_fields'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/limit'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  meta:
                    $ref: '#/components/schemas/List-Operation-Meta'
                  events:
                    description: List of audit events matching the query.
                    type: array
                    items:
                      $ref: '#/components/schemas/Audit'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: listAuditEvents
      tags:
      - Audit
      security:
      - Api-Key: []
components:
  schemas:
    Supplementary-Data-AuditEvent-Activity-Detail:
      type: object
      properties:
        activityId:
          $ref: '#/components/schemas/Activity-ID'
        processResultId:
          $ref: '#/components/schemas/Process-Result-ID'
    Supplementary-Data-AuditEvent-Fraud-Details:
      type: object
      description: Details of a single fraud check result.
      properties:
        checkType:
          $ref: '#/components/schemas/Fraud-Check-Types'
        processResultId:
          $ref: '#/components/schemas/Process-Result-ID'
        result:
          type: string
          description: The outcome of the fraud check.
    Supplementary-Data-AuditEvent-KYC:
      type: object
      description: 'Contains requirements and results for KYC supplementary data.

        '
      allOf:
      - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Base'
      - type: object
        description: 'Contains requirements and results for KYC supplementary data.

          '
        properties:
          requirements:
            type: string
            description: The requirements for this KYC check.
          result:
            type: string
            description: The result of this KYC check.
    Attribute:
      type: object
      required:
      - type
      - value
      properties:
        type:
          description: The attribute type.
          type: string
          maxLength: 64
        value:
          description: The value assigned to the attribute.
          type: string
    Object-Type:
      description: The type of object being annotated.
      type: string
      enum:
      - ADDRESS
      - NAME
      - PHONE_NUMBER
      - EMAIL
      - DATE_OF_BIRTH
      - WEBSITE
      - SHAREHOLDER
      - OFFICIAL
      - UBO
      - REGISTRATION
      - SHAREHOLDING
      - SHARECAPITAL
      - DOCUMENT
      - DOCUMENT_ATTACHMENT
      - RESULT_PROCESS
      - RESULT_STEP
      - RESULT_WORKFLOW
      - SERVICE_PROFILE
      - AUDIT_EVENT
      - EXTERNAL_REFERENCE
      - RISK_ASSESSMENT
      - MATCHLIST
    Supplementary-Data-AuditEvent-AML:
      type: object
      description: 'Includes requirements and results for AML supplementary data.

        '
      allOf:
      - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Base'
      - type: object
        description: 'Includes requirements and results for AML supplementary data.

          '
        properties:
          result:
            type: string
            description: The result of the AML check.
          numHits:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits from this provider.
          numFalsePositives:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits marked as false positives from this provider.
          numTruePositives:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits marked as true positives from this provider.
          numUnknown:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits marked as unknown from this provider.
          numUnresolved:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits that remain unresolved from this provider.
          numUnresolvedPEP:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits with unresolved PEP entries from this provider.
          numUnresolvedSanction:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits with unresolved sanction entries from this provider.
          numUnresolvedWatchlist:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits with unresolved watchlist entries from this provider.
          numUnresolvedAdverseMedia:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits with unresolved adverse media entries from this provider.
    Supplementary-Data-AuditEvent-Fraud:
      type: object
      description: Contains details relevant to fraud hits for an audit event.
      allOf:
      - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Base'
      - type: object
        properties:
          result:
            type: string
            description: The overall result of the fraud check.
          details:
            type: array
            description: A list of fraud checks that were performed and their results.
            items:
              $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Fraud-Details'
    Supplementary-Data-AuditEvent-Individual-Change:
      type: object
      description: 'Contains information about changes to individual KYC supplementary data, including added, updated, invalidated fields, and validation issues.

        '
      allOf:
      - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Base'
      - type: object
        properties:
          fieldsAdded:
            type: array
            items:
              $ref: '#/components/schemas/Audit-Event-Change'
            description: New fields that were added.
          fieldsUpdated:
            type: array
            items:
              $ref: '#/components/schemas/Audit-Event-Change'
            description: Fields that were updated.
          fieldsInvalidated:
            type: array
            items:
              $ref: '#/components/schemas/Audit-Event-Change'
            description: Fields that were changed and invalidated a result.
          resultsInvalidated:
            type: array
            items:
              $ref: '#/components/schemas/Audit-Event-Change'
            description: Results that were invalidated.
          validationIssues:
            type: array
            items:
              $ref: '#/components/schemas/Audit-Event-Error'
            description: Issues found during validation that prevented the change from being made.
    Workflow-Step-Risk-Result-Detail:
      type: object
      description: 'Details of a calculated risk result for a workflow step.

        '
      required:
      - factor
      - score
      - value
      properties:
        factor:
          type: string
          description: Name of the risk factor contributing to this score.
        score:
          type: integer
          description: Score contributed by this factor.
        value:
          type: string
          description: Value used for the score factor.
    Supplementary-Data-AuditEvent-Risk-Override:
      type: object
      description: "Contains all details related to a risk override event, including:\n  - The previous risk profile (score and level before the override).\n  - The current risk profile (score and level after the override).\n  - The type of override applied.\n  - The risk factors affected by the override.\n"
      allOf:
      - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Base'
      - $ref: '#/components/schemas/Audit-Event-Risk-Override-Result'
    Workflow-Execution-ResultEnum:
      type: string
      description: "Outcome of this workflow execution. Possible results:\n  - UNCHECKED: The workflow has not yet been run and has no result.\n  - IN_PROGRESS: The workflow is currently running and awaiting completion.\n  - REVIEW: The workflow produced results that require review. Check the risks and step results for more details.\n  - PASS: The workflow successfully completed with a PASS recommendation.\n  - FAIL: The workflow finished with a FAIL recommendation.\n  - COMPLETE: The workflow has finished and the results are considered complete. PASS/FAIL is not required.\n  - INCOMPLETE: The workflow has finished and the results are considered incomplete. PASS/FAIL is not required.\n  - NEEDS_APPROVAL: The workflow requires an approval process. Once approved, re-run the workflow.\n  - APPROVED: The workflow was approved, typically by an external source such as a human.\n  - REJECTED: The workflow was rejected, typically by an external source such as a human.\n  - BLOCKED: The workflow was blocked from completing. Manual review is required.\n  - CLEAR: The workflow completed with no issues raised. Often used for ongoing monitoring workflows.\n  - URGENT: The workflow completed with matters requiring urgent review. Often used for ongoing monitoring workflows that return sanctions or similarly critical items.\n  - MONITOR: The workflow completed and further monitoring is required. Should be manually reviewed.\n"
      default: UNCHECKED
      enum:
      - UNCHECKED
      - IN_PROGRESS
      - REVIEW
      - PASS
      - FAIL
      - COMPLETE
      - INCOMPLETE
      - NEEDS_APPROVAL
      - APPROVED
      - REJECTED
      - BLOCKED
      - CLEAR
      - URGENT
      - MONITOR
    Audit:
      type: object
      required:
      - eventId
      - schemaVersion
      - requestId
      - level
      - type
      - description
      - source
      - channel
      - eventStatus
      - timestamp
      properties:
        eventId:
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
          description: Unique identifier for the audit event.
        schemaVersion:
          type: integer
          example: 2
          description: Version of the audit event schema.
        elapsedTimeInMilliSeconds:
          type: integer
          example: 2
          description: The total time, in milliseconds, that the operation took.
        level:
          type: integer
          example: 2
          description: 'Level of the audit event.

            1 -- Conclusion of the entire process. What happened.

            2 -- Conclusion of a sub-task. Why the overall event happened.

            3 -- Finer detail within a task. How the overall event came to be.

            '
        requestId:
          $ref: '#/components/schemas/Request-ID'
        type:
          $ref: '#/components/schemas/AuditEvent-Type'
        timestamp:
          type: string
          format: date-time
          example: '2020-01-01T00:00:00.000Z'
          description: The timestamp of the audit event.
        source:
          type: string
          example: FrankieOne System
          description: Source of the audit event, which could be an internal system or a user.
        functionName:
          type: string
          example: executeVendorCheck
          description: Name of the function that generated the audit event.
        description:
          type: string
          example: Executing Vendor Check for Entity
          description: Brief description of the audit event.
        descriptionDetails:
          type: string
          example: "A new entity has been created with the following attributes:\n - Name\n - Address\n"
          description: More in-depth description of the audit log event.
        objectId:
          type: string
        objectType:
          $ref: '#/components/schemas/Object-Type'
        entityId:
          $ref: '#/components/schemas/Entity-ID'
        batchId:
          type: string
          description: ID of the batch associated with the audit event.
        channel:
          $ref: '#/components/schemas/AuditEvent-Channel'
        serviceProfileId:
          type: string
          description: ID of the profile associated with the audit event.
        serviceName:
          type: string
          example: kyc
          description: Name of the profile associated with the audit event.
        status:
          $ref: '#/components/schemas/Workflow-Execution-ResultEnum'
          description: Current status of the workflow.
        workflowExecutionId:
          type: string
          description: ID of the workflow execution associated with the audit event.
        workflowName:
          type: string
          example: safe_harbour_1+1
          description: Name of the workflow associated with the audit event.
        workflowVersion:
          type: string
          example: v23
          description: Version of the workflow associated with the audit event.
        stepResultId:
          type: string
          description: ID of the step result associated with the audit event.
        stepName:
          type: string
          example: kyc-equifax
          description: Name of the step associated with the audit event.
        stepVersion:
          type: string
          example: v2.0.0
          description: Version of the step associated with the audit event.
        eventStatus:
          $ref: '#/components/schemas/AuditEvent-Status'
        riskScore:
          type: number
          example: 10
          description: Risk score associated with the audit event.
        riskLevel:
          $ref: '#/components/schemas/Risk-Level'
          description: Risk level associated with the audit event.
        entityType:
          $ref: '#/components/schemas/Entity-Type'
        userComment:
          $ref: '#/components/schemas/Comment'
        lifecyclePhase:
          $ref: '#/components/schemas/Workflow-LifecyclePhaseEnum'
        supplementaryData:
          type: object
          oneOf:
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Risk-Assessment'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-KYC'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Decision'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Individual-Change'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-KYC-Connector'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Result-Update'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-AML-Connector'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-AML'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-IDV'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-IDV-Connector'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Risk-Override'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Entity-Lookup'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-KYB'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Organization-Data-Fetch-Connector'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Matchlist'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Matchlist-Entry'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Matchlist-Entries'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Matchlist-Result'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Duplicate'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Entity-Profile-State-Change'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Activity'
          - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Fraud'
          discriminator:
            propertyName: type
            mapping:
              RISK_ASSESSMENT: '#/components/schemas/Supplementary-Data-AuditEvent-Risk-Assessment'
              KYC: '#/components/schemas/Supplementary-Data-AuditEvent-KYC'
              DECISION: '#/components/schemas/Supplementary-Data-AuditEvent-Decision'
              INDIVIDUAL_CHANGE: '#/components/schemas/Supplementary-Data-AuditEvent-Individual-Change'
              KYC_CONNECTOR: '#/components/schemas/Supplementary-Data-AuditEvent-KYC-Connector'
              RESULT_UPDATE: '#/components/schemas/Supplementary-Data-AuditEvent-Result-Update'
              AML_CONNECTOR: '#/components/schemas/Supplementary-Data-AuditEvent-AML-Connector'
              AML: '#/components/schemas/Supplementary-Data-AuditEvent-AML'
              IDV: '#/components/schemas/Supplementary-Data-AuditEvent-IDV'
              IDV_CONNECTOR: '#/components/schemas/Supplementary-Data-AuditEvent-IDV-Connector'
              RISK_OVERRIDE: '#/components/schemas/Supplementary-Data-AuditEvent-Risk-Override'
              ENTITY_LOOKUP: '#/components/schemas/Supplementary-Data-AuditEvent-Entity-Lookup'
              KYB: '#/components/schemas/Supplementary-Data-AuditEvent-KYB'
              ORG_DATA_FETCH_CONNECTOR: '#/components/schemas/Supplementary-Data-AuditEvent-Organization-Data-Fetch-Connector'
              MATCHLIST: '#/components/schemas/Supplementary-Data-AuditEvent-Matchlist'
              MATCHLIST_ENTRY: '#/components/schemas/Supplementary-Data-AuditEvent-Matchlist-Entry'
              MATCHLIST_ENTRIES: '#/components/schemas/Supplementary-Data-AuditEvent-Matchlist-Entries'
              MATCHLIST_RESULT: '#/components/schemas/Supplementary-Data-AuditEvent-Matchlist-Result'
              DUPLICATE: '#/components/schemas/Supplementary-Data-AuditEvent-Duplicate'
              ENTITY_PROFILE_STATE_UPDATE: '#/components/schemas/Supplementary-Data-AuditEvent-Entity-Profile-State-Change'
              ACTIVITY: '#/components/schemas/Supplementary-Data-AuditEvent-Activity'
              FRAUD: '#/components/schemas/Supplementary-Data-AuditEvent-Fraud'
    Organization-Registry:
      type: object
      properties:
        registry:
          description: Registry the organization is registered at
          type: string
        registryDescription:
          description: The description of the registry
          type: string
    Request-ID:
      type: string
      example: 01HN9XHZN6MGXM9JXG50K59Q85
      description: The unique request identifier for the API call made.
    Workflow-Step-Risk-Result:
      type: object
      description: 'Calculated risk result for a workflow step.

        '
      properties:
        level:
          type: string
          description: Current risk level.
        contributedScore:
          type: integer
          description: Risk score contributed by this step.
        overallScore:
          type: integer
          description: Current overall risk score.
        factors:
          type: array
          description: List of contributing score factors.
          items:
            $ref: '#/components/schemas/Workflow-Step-Risk-Result-Detail'
    Supplementary-Data-AuditEvent-Matchlist-Entries:
      type: object
      description: 'Contains audit event details for managing multiple matchlist entries. Only a summary of the changes is provided, not the full list of entries.


        For a single operation, use `Supplementary-Data-AuditEvent-Matchlist-Entry`.

        '
      allOf:
      - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Base'
      - $ref: '#/components/schemas/Audit-Matchlist'
      - type: object
        properties:
          entries:
            $ref: '#/components/schemas/Audit-Matchlist-Entries'
    Workflow-Step-Summary-Entity-Lookup-Residential:
      type: object
      required:
      - country
      - status
      properties:
        country:
          type: string
          description: 'Country The ISO-3166-1 country. You must use the alpha3 country code (e.g. AUS, USA, IDR, KOR, etc).


            For more details refer to: https://en.wikipedia.org/wiki/ISO_3166-1

            '
        status:
          type: string
          description: "The status of the address, indicating its relevance over time. \n\n* `CURRENT` - The address is currently in use.\n* `PREVIOUS` - The address was used in the past.\n* `FUTURE` - The address is planned for future use.\n* `UNKNOWN` - There is no valid address status available.\n"
          enum:
          - CURRENT
          - PREVIOUS
          - FUTURE
          - UNKNOWN
    Supplementary-Data-AuditEvent-KYC-Connector:
      type: object
      description: 'Contains requirements and results for KYC Connector supplementary data.

        '
      allOf:
      - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Base-Connector'
    Audit-Matchlist-Entry:
      type: object
      description: 'A single entry in a matchlist.

        For bulk operations, use `Audit-Matchlist-Entries`.

        '
      allOf:
      - $ref: '#/components/schemas/Matchlist-Entry-Base'
      - type: object
        description: 'Audit event details for managing a single matchlist entry operation.

          '
        title: Matchlist Entry
        properties:
          attributes:
            type: array
            description: 'A list of attributes associated with the matchlist entry, including details such as attribute type, value, and any additional metadata relevant to the entry.

              '
            minItems: 1
            items:
              $ref: '#/components/schemas/Matchlist-Entry-Attribute-Type'
          state:
            $ref: '#/components/schemas/Matchlist-Entry-State'
          batchName:
            type: string
            description: 'Optional batch name to identify the source of this entry.

              '
            example: blocklist.csv
    Risk-Level:
      type: string
      enum:
      - UNKNOWN
      - LOW
      - MEDIUM
      - HIGH
      - UNACCEPTABLE
      description: "The risk level classification:\n  - UNKNOWN: Risk level is not determined.\n  - LOW: Low risk.\n  - MEDIUM: Medium risk.\n  - HIGH: High risk.\n  - UNACCEPTABLE: Risk level is unacceptable.\n"
    Comment:
      type: object
      properties:
        commentId:
          type: string
          description: Unique identifier for the comment.
          example: 55fc5d54-46f7-49c8-bf78-e07ec79cd6e7
          readOnly: true
        text:
          type: string
          description: The text content of the comment.
          example: Update after speaking to customer over the phone directly.
    Supplementary-Data-AuditEvent-Organization-Data-Fetch-Connector:
      type: object
      description: Contains details relevant to KYB Connector audit events.
      allOf:
      - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Base-Connector'
    Audit-Event-Connector-Config:
      type: object
      properties:
        configurationKey:
          type: string
          description: The key or name of the configuration that was used.
        description:
          type: string
          description: A brief description of the purpose or function of the configuration.
        value:
          type: string
          description: The value assigned to the configuration.
    Supplementary-Data-AuditEvent-Result-Update:
      type: object
      description: 'Contains details about changes to results.

        '
      allOf:
      - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Base'
      - type: object
        properties:
          resultsUpdated:
            type: array
            items:
              $ref: '#/components/schemas/Audit-Result-Change'
            description: Results that were updated.
    Matchlist-Entry-State:
      type: string
      description: "The state of the matchlist entry.\n  - `ACTIVE`: The matchlist entry is active and can be used for matching.\n  - `EXPIRED`: The matchlist entry has expired. It is visible and retrievable, but cannot be used for matching.\n  - `DELETED`: The matchlist entry has been marked as deleted, rendering it unusable.\n\nTo modify an entry's state, use `Matchlist-Entry-State-Writeable`."
      default: ACTIVE
      readOnly: true
      enum:
      - ACTIVE
      - EXPIRED
      - DELETED
    Audit-Event-Organization-Entity-Match:
      type: object
      description: Details of the entity matching process during creation, specifically for KYB (Know Your Business).
      properties:
        country:
          type: string
          description: 'The ISO-3166-1 country code. You must use the alpha-3 country code (e.g., AUS, USA, IDR, KOR, etc). Conversion will be handled as needed.

            For more details, refer to: https://en.wikipedia.org/wiki/ISO_3166-1'
        registrationNumber:
          type: string
          description: The registration number of the organization in the registry.
        registry:
          $ref: '#/components/schemas/Organization-Registry'
        subdivision:
          type: string
          description: The administrative area, state, or sub-division. Use local abbreviations, such as VIC (Victoria) or TX (Texas).
        name:
          type: string
          description: The name as registered in the primary registry of the organization.
    Supplementary-Data-AuditEvent-AML-Connector:
      type: object
      description: 'Includes requirements and results for AML Connector supplementary data.

        '
      allOf:
      - $ref: '#/components/schemas/Supplementary-Data-AuditEvent-Base-Connector'
      - type: object
        description: Includes requirements and results for AML Connector supplementary data.
        properties:
          numHits:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits from this provider.
          numFalsePositives:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits marked as false positives from this provider.
          numTruePositives:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits marked as true positives from this provider.
          numUnknown:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits marked as unknown from this provider.
          numUnresolved:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits that remain unresolved from this provider.
          numUnresolvedPEP:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits with unresolved PEP entries from this provider.
          numUnresolvedSanction:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits with unresolved sanction entries from this provider.
          numUnresolvedWatchlist:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits with unresolved watchlist entries from this provider.
          numUnresolvedAdverseMedia:
            type: integer
            format: int32
            minimum: 0
            description: Total number of AML hits with unresolved adverse media entries from this provider.
    Workflow-Step-Summary-Entity-Lookup-Address:
      type: object
      description: 'Object containing address details, categorized by address type.

        Each address type may include specific properties relevant to its context.

        '
      properties:
        RESIDENTIAL:
          description: 'Represents a residential address, typically used for services or communications directed to personal living spaces.

            '
          $ref: '#/components/schemas/Workflow-Step-Summary-Entity-Lookup-Residential'
    Supplementary-Data-AuditEvent-Base:
      type: object
      required:
      - type
      properties:
        type:
          type: string
          enum:
          - RISK_ASSESSMENT
          - KYC
          - DECISION
          - KYC_CONNECTOR
          - INDIVIDUAL_CHANGE
          - KYB
          - ORG_DATA_FETCH_CONNECTOR
          - RESULT_UPDATE
          - AML_CONNECTOR
          - AML
          - IDV
          - IDV_CONNECTOR
          - RISK_OVERRIDE
          - ENTITY_LOOKUP
          - MATCHLIST
          - MATCHLIST_ENTRY
          - MATCHLIST_ENTRIES
          - MATCHLIST_RESULT
          - VISA
          - ACTIVITY
          - FRAUD
        origin:
          $ref: '#/components/schemas/Audit-Event-Origin'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Audit-Event-Error'
          description: Any errors that occurred during the process and prevented the results from being retrieved or gen

# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/frankieone/refs/heads/main/openapi/frankieone-audit-api-openapi.yml