openapi: 3.0.1
info:
  title: Sikoia API
  termsOfService: https://sikoia.com/About/Terms
  version: '1.0'
servers:
- url: https://api.sikoia.com
  description: API (Production)
- url: https://oauth2.sikoia.com
  description: Authorization Server (Production)
- url: https://api-staging.sikoia.com
  description: API (Staging)
- url: https://oauth2-staging.sikoia.com
  description: Authorization Server (Staging)
tags:
- name: Adverse Media
- name: Affordability Insights
- name: Authentication
- name: Banking
- name: Cases
- name: Checklist
- name: Companies & People
- name: Company Credit Report
- name: Company Registry
- name: Data Sources
- name: Documents
- name: Excel Report
- name: Identity Verification
- name: Income & Employer Verification
- name: Online Data
- name: PEPs & Sanctions
- name: User Management
- name: Validation Checklists
- name: Webhooks
paths:
  /token:
    post:
      tags:
      - Authentication
      summary: Creates an access token
      description: "### To generate an access token, make a request to one of the following:\r\n- Production Environment:\
        \ `https://oauth2.sikoia.com` \r\n- Staging Environment: `https://oauth2-staging.sikoia.com`\r\n\r\n ### Ensure that\
        \ the following parameters are provided: \r\n- `client_id:` See our Guides section for more information on how to\
        \ obtain your `client_id`.\r\n- `client_secret:` See our Guides section for more information on how to obtain your\
        \ `client_secret`.\r\n- `grant_type:` Set this parameter to client_credentials.\r\n- `scope:` Set this parameter to:\
        \ \r\n- * Production Environment: `https://api.sikoia.com/.default`\r\n- * Staging Environment: `https://api-staging.sikoia.com/.default`\r\
        \n\r\n The endpoint will return the access token in JSON Web Token (JWT) format, along with metadata indicating its\
        \ expiry and validity."
      operationId: POST_token
      security: []
      servers:
      - url: https://oauth2.sikoia.com
        description: Authorization Server (Production)
      - url: https://oauth2-staging.sikoia.com
        description: Authorization Server (Staging)
      requestBody:
        description: Token request
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ObtainTokenRequest'
      responses:
        '201':
          description: Returns the access token in JWT format along with metadata about token expiry and validity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenResponse'
        '400':
          description: Error response compliant with Oauth 2.0 specification
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenErrorResponse'
  /v2/users:
    get:
      tags:
      - User Management
      summary: List all users
      description: "### Retrieves a list of all users.\r\n\r\nReturns a list of users affiliated with your organisation.\r\
        \n\r\nRefer to our Guides section for additional information on users, user roles, and user permissions.\r\n"
      operationId: GET_v2-users
      responses:
        '200':
          description: All User are retrieved
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MicroserviceUserManagement.Resources.External.User'
              example:
              - user_id: 592d6b22-a5d4-4226-b5a3-c374cf1a38fe
                first_name: John
                last_name: Smith
                email: john.smith@acme.com
                account_date_created: '2024-01-19T03:06:41.0000000+00:00'
                account_date_updated: '2024-01-19T03:06:41.0000000+00:00'
                roles:
                - name: Admin
                  description: Admin Role
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse401'
              example:
                type: InvalidToken
                status: '401'
                title: Invalid Token
                detail: Invalid token
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse429'
              example:
                type: RateLimit
                status: '429'
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse500'
              example:
                type: ServerError
                status: '500'
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
  /v2/webhooks:
    post:
      tags:
      - Webhooks
      summary: Create a new webhook
      description: "### Creates a webhook for one or more events.\r\n\r\nA webhook is an HTTP request that keeps your system\
        \ informed about changes in the Sikoia Platform in real-time. Refer to our Guides section for additional information\
        \ on webhooks.\r\nYou can retrieve a complete list of supported `event_types` by using the `GET/v2/webhooks/event-types`\
        \ endpoint.\r\n"
      operationId: POST_v2-webhooks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MicroserviceUserManagement.Resources.External.Webhook'
            example:
              webhook_id: string
              webhook_name: Bank Statement Hook
              webhook_callback_url: https://yourdomain.com/webhook/
              external_ref: IntRef001
              event_types: '["BankStatementProcessing.Completed"]'
              datetime_created: '2024-01-18T12:37:35.0000000+00:00'
              datetime_updated: '2024-01-18T12:37:35.0000000+00:00'
      responses:
        '201':
          description: Webhook successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.External.Webhook'
              example:
                webhook_id: string
                webhook_name: Bank Statement Hook
                webhook_callback_url: https://yourdomain.com/webhook/
                external_ref: IntRef001
                event_types: '["BankStatementProcessing.Completed"]'
                datetime_created: '2024-01-18T12:37:35.0000000+00:00'
                datetime_updated: '2024-01-18T12:37:35.0000000+00:00'
        '400':
          description: Validation failure trying to create webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse400'
              example:
                type: InvalidRequest
                status: '400'
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse401'
              example:
                type: InvalidToken
                status: '401'
                title: Invalid Token
                detail: Invalid token
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse429'
              example:
                type: RateLimit
                status: '429'
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse500'
              example:
                type: ServerError
                status: '500'
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
    get:
      tags:
      - Webhooks
      summary: List all webhooks
      description: "### Retrieves a list of all available webhooks.\r\n\r\nReturns a list of all webhooks affiliated with\
        \ your organisation.\r\n\r\nThis list includes the `webhook_id`, which can be used to update or delete the webhook\
        \ using the `GET/v2/webhooks/{webhook_id}` and `DELETE/v2/webhooks/{webhook_id}` endpoints.\r\n"
      operationId: GET_v2-webhooks
      responses:
        '200':
          description: Webhooks successfully retrieved
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MicroserviceUserManagement.Resources.External.Webhook'
              example:
              - webhook_id: string
                webhook_name: Bank Statement Hook
                webhook_callback_url: https://yourdomain.com/webhook/
                external_ref: IntRef001
                event_types: '["BankStatementProcessing.Completed"]'
                datetime_created: '2024-01-18T12:37:35.0000000+00:00'
                datetime_updated: '2024-01-18T12:37:35.0000000+00:00'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse401'
              example:
                type: InvalidToken
                status: '401'
                title: Invalid Token
                detail: Invalid token
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse429'
              example:
                type: RateLimit
                status: '429'
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse500'
              example:
                type: ServerError
                status: '500'
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
  /v2/webhooks/{webhook_id}:
    get:
      tags:
      - Webhooks
      summary: Retrieve a webhook
      description: "### Retrieves a webhook.\r\n\r\nReturns information about a webhook, including the `webhook_callback_url`\
        \ and a list of associated `event_types`.\r\n"
      operationId: GET_v2-webhooks-webhook_id
      parameters:
      - name: webhook_id
        in: path
        description: Webhook Id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Webhook successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.External.Webhook'
              example:
                webhook_id: string
                webhook_name: Bank Statement Hook
                webhook_callback_url: https://yourdomain.com/webhook/
                external_ref: IntRef001
                event_types: '["BankStatementProcessing.Completed"]'
                datetime_created: '2024-01-18T12:37:35.0000000+00:00'
                datetime_updated: '2024-01-18T12:37:35.0000000+00:00'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse401'
              example:
                type: InvalidToken
                status: '401'
                title: Invalid Token
                detail: Invalid token
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '404':
          description: Webhook does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse404'
              example:
                type: ResourceNotFound
                status: '404'
                title: Resource Not Found
                detail: No resources found with id 6afd715b195c4d11b9e796bcdfbdfd9a.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse429'
              example:
                type: RateLimit
                status: '429'
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse500'
              example:
                type: ServerError
                status: '500'
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
    patch:
      tags:
      - Webhooks
      summary: Update a webhook
      description: "### Updates details for an existing webhook.\r\n\r\nWhile all fields are optional, the request must include\
        \ at least one field.\r\nTo clear a field, send an empty string as the field value.\r\n"
      operationId: PATCH_v2-webhooks-webhook_id
      parameters:
      - name: webhook_id
        in: path
        description: Webhook Id
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MicroserviceUserManagement.Resources.External.WebhookUpdate'
            example:
              webhook_name: Bank Statement Hook
              webhook_callback_url: https://yourdomain.com/webhook/
              external_ref: IntRef001
              event_types: '["BankStatementProcessing.Completed"]'
      responses:
        '200':
          description: Webhook successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.External.Webhook'
              example:
                webhook_id: string
                webhook_name: Bank Statement Hook
                webhook_callback_url: https://yourdomain.com/webhook/
                external_ref: IntRef001
                event_types: '["BankStatementProcessing.Completed"]'
                datetime_created: '2024-01-18T12:37:35.0000000+00:00'
                datetime_updated: '2024-01-18T12:37:35.0000000+00:00'
        '400':
          description: Validation failure trying to update webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse400'
              example:
                type: InvalidRequest
                status: '400'
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse401'
              example:
                type: InvalidToken
                status: '401'
                title: Invalid Token
                detail: Invalid token
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '404':
          description: Webhook does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse404'
              example:
                type: ResourceNotFound
                status: '404'
                title: Resource Not Found
                detail: No resources found with id 6afd715b195c4d11b9e796bcdfbdfd9a.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse429'
              example:
                type: RateLimit
                status: '429'
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse500'
              example:
                type: ServerError
                status: '500'
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
    delete:
      tags:
      - Webhooks
      summary: Delete a webhook
      description: "### Deletes a single webhook.\r\n\r\nPlease note that this action cannot be undone.\r\n"
      operationId: DELETE_v2-webhooks-webhook_id
      parameters:
      - name: webhook_id
        in: path
        description: Webhook Id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Webhook successfully deleted
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse401'
              example:
                type: InvalidToken
                status: '401'
                title: Invalid Token
                detail: Invalid token
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '404':
          description: Webhook does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse404'
              example:
                type: ResourceNotFound
                status: '404'
                title: Resource Not Found
                detail: No resources found with id 6afd715b195c4d11b9e796bcdfbdfd9a.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse429'
              example:
                type: RateLimit
                status: '429'
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse500'
              example:
                type: ServerError
                status: '500'
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
  /v2/webhooks/event-types:
    get:
      tags:
      - Webhooks
      summary: List all event types
      description: "### Retrieves a list of all available webhook event_types.\r\n\r\nThe list includes the name of all events\
        \ that a webhook can subscribe to.\r\nRefer to our Guides section for additional information on webhooks.\r\n"
      operationId: GET_v2-webhooks-event-types
      responses:
        '200':
          description: Event types successfully returned
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MicroserviceUserManagement.Resources.External.WebhookEventGroup'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse401'
              example:
                type: InvalidToken
                status: '401'
                title: Invalid Token
                detail: Invalid token
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse429'
              example:
                type: RateLimit
                status: '429'
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse500'
              example:
                type: ServerError
                status: '500'
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
  /v2/webhooks/{webhook_id}/requests:
    get:
      tags:
      - Webhooks
      summary: List all webhook requests
      description: Returns a paginated list of all requests with the most recent request provided first.
      operationId: GET_v2-webhooks-webhook_id-requests
      parameters:
      - name: webhook_id
        in: path
        description: Webhook Id
        required: true
        schema:
          type: string
          format: uuid
      - name: after_request_id
        in: query
        description: Last Request Id Seen
        schema:
          type: string
          format: uuid
      - name: event_status
        in: query
        description: Event Status
        schema:
          $ref: '#/components/schemas/MicroserviceUserManagement.Domain.Model.Webhooks.WebhookEventStatusCode'
      - name: pagination_direction
        in: query
        description: Pagination Direction
        schema:
          $ref: '#/components/schemas/MicroserviceUserManagement.Domain.Model.Common.PaginationDirection'
      responses:
        '200':
          description: Webhook requests successfully returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.External.PaginatedWebhookRequestsResponse'
              example:
                pagination_meta_data:
                  next_page_url: https://api.sikoia.com/v2/{resource}?after_request_id=354c8709-8941-4a8e-a614-a618555034a0&pagination_direction=Forward
                  previous_page_url: https://api.sikoia.com/v2/{resource}?after_request_id=354c8709-8941-4a8e-a614-a618555034a0&pagination_direction=Backward
                  page_size: '25'
                  page_count: '5'
                webhook_requests:
                - request_id: 2bf8cbc7-b646-41ad-9881-4944ad2b786e
                  grouping_id: 07322b4b-6739-486c-9eb4-5466a8bc1875
                  event_type: BankStatementProcessing.Completed
                  webhook_callback_url: https://yourdomain.com/webhook/
                  datetime_created: '2024-01-18T12:37:35.0000000+00:00'
                  event_data: '{"key":"value","key2":"value2"]}'
                  webhook_event_status: Complete
                  request_attempts: '[{"attempt_id":"8b1391e4-7ace-41a2-a04b-55decffb9fe5","requested_on":"2024-01-18T12:37:35.053Z","http_response_code":200}]'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse401'
              example:
                type: InvalidToken
                status: '401'
                title: Invalid Token
                detail: Invalid token
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '404':
          description: Webhook or Request does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse404'
              example:
                type: ResourceNotFound
                status: '404'
                title: Resource Not Found
                detail: No resources found with id 6afd715b195c4d11b9e796bcdfbdfd9a.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse429'
              example:
                type: RateLimit
                status: '429'
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse500'
              example:
                type: ServerError
                status: '500'
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
  /v2/webhooks/secrets:
    get:
      tags:
      - Webhooks
      summary: Get a shared secret
      description: "### Retrieves a single secret key used to sign all webhook requests.\r\n\r\nThis secret will be used to\
        \ create a HMACSHA256 hash of every webhook request sent. The result will be Base64 encoded and sent under the `X-HMAC-SHA256-Signature`\
        \ header in the request."
      operationId: GET_v2-webhooks-secrets
      responses:
        '200':
          description: Webhook Secret successfully returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.External.WebhookSecret'
              example:
                shared_key: string
                date_created: string
                date_updated: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse401'
              example:
                type: InvalidToken
                status: '401'
                title: Invalid Token
                detail: Invalid token
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '404':
          description: Webhook Secret Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse404'
              example:
                type: ResourceNotFound
                status: '404'
                title: Resource Not Found
                detail: No resources found with id 6afd715b195c4d11b9e796bcdfbdfd9a.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse429'
              example:
                type: RateLimit
                status: '429'
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse500'
              example:
                type: ServerError
                status: '500'
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
    post:
      tags:
      - Webhooks
      summary: Create a shared secret
      description: "### Creates a new secret key to be used to sign all webhook requests.\r\n\r\nAll subsequent wehook requests\
        \ sent will include a HMACSHA256 hash that has been Base64 encoded in the `X-HMAC-SHA256-Signature` header. Comparing\
        \ this hashed value against a SHA256 hash of the request body (using the secret as a key) enables you to verify the\
        \ payload has not been tampered with."
      operationId: POST_v2-webhooks-secrets
      responses:
        '201':
          description: Create a new webhook secret
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.External.WebhookSecret'
              example:
                shared_key: string
                date_created: string
                date_updated: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse401'
              example:
                type: InvalidToken
                status: '401'
                title: Invalid Token
                detail: Invalid token
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '409':
          description: Cannot create multiple webhook secrets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse409'
              example:
                type: UnprocessableRequest
                status: '409'
                title: Cannot create multiple webhook secrets
                detail: Only one webhook secret is supported. Please refer to the API docs on how to either rotate the existing
                  key value or delete it from the system.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse429'
              example:
                type: RateLimit
                status: '429'
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse500'
              example:
                type: ServerError
                status: '500'
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
    delete:
      tags:
      - Webhooks
      summary: Delete a shared secret
      description: "### Deletes a secret key used to sign webhook requests.\r\n\r\nPlease note that this action cannot be\
        \ undone. Webhooks will continue to be sent without a secret - they will just not include the `X-HMAC-SHA256-Signature`\
        \ header for verification purposes."
      operationId: DELETE_v2-webhooks-secrets
      responses:
        '204':
          description: Webhook secret successfully deleted
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse401'
              example:
                type: InvalidToken
                status: '401'
                title: Invalid Token
                detail: Invalid token
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '404':
          description: No secret exists to be deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse404'
              example:
                type: ResourceNotFound
                status: '404'
                title: Resource Not Found
                detail: No resources found with id 6afd715b195c4d11b9e796bcdfbdfd9a.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse429'
              example:
                type: RateLimit
                status: '429'
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse500'
              example:
                type: ServerError
                status: '500'
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
  /v2/webhooks/secrets/rotate:
    patch:
      tags:
      - Webhooks
      summary: Change a shared secret
      description: "### Changes the shared secret to a new secure value.\r\n\r\nGenerates a new secret used to create the\
        \ `X-HMAC-SHA256-Signature` header on all webhook requests.  This new secret will be implemented on all requests sent\
        \ after the date_updated timestamp included in the response."
      operationId: PATCH_v2-webhooks-secrets-rotate
      responses:
        '200':
          description: Webhook secret rotated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.External.WebhookSecret'
              example:
                shared_key: string
                date_created: string
                date_updated: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse401'
              example:
                type: InvalidToken
                status: '401'
                title: Invalid Token
                detail: Invalid token
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '404':
          description: No secret has been created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse404'
              example:
                type: ResourceNotFound
                status: '404'
                title: Resource Not Found
                detail: No resources found with id 6afd715b195c4d11b9e796bcdfbdfd9a.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse429'
              example:
                type: RateLimit
                status: '429'
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceUserManagement.Resources.SikoiaErrorResponse500'
              example:
                type: ServerError
                status: '500'
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: a28d1abd-ad97-4a1f-bd14-6698c5214544
  /v2/cases:
    get:
      tags:
      - Cases
      summary: List all cases
      description: "### Returns a list of all cases.\r\n\r\nThis list can be filtered using query parameters such as `case_type`,\
        \ `stage`, `source`, `owner`, `owner_id` and `keyword`.\r\n\r\nThe `keyword` query parameter searches for matching\
        \ strings within the Case's `name`, `reference` and `description` fields.\r\n\r\nSupport for multiple filters is available\
        \ by separating them with a comma. For instance, to retrieve all approved and rejected cases, use the `stage` query\
        \ parameter with the value `Approved,Rejected`.\r\n"
      operationId: GET_v2-cases
      parameters:
      - name: case_type
        in: query
        description: Case Types
        schema:
          enum:
          - Business
          - Consumer
          type: string
      - name: stage
        in: query
        description: Case Stages
        schema:
          enum:
          - New
          - InProgressWaitingCustomer
          - InProgressNeedsReview
          - Approved
          - Rejected
          - Dormant
          type: string
      - name: source
        in: query
        description: Source
        schema:
          type: string
      - name: owner
        in: query
        description: Owner
        schema:
          type: string
          deprecated: true
      - name: owner_id
        in: query
        description: Owner Id
        schema:
          type: string
      - name: keyword
        in: query
        description: Keywords
        schema:
          type: string
      responses:
        '200':
          description: List of cases
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Responses.CasesResponse'
              example:
              - case_id: 64cd8202-2db4-44d5-85be-79438d65eb7b
                name: Acme Ltd Loan Application
                case_type: Business
                stage: New
                datetime_created: '2023-02-10T10:59:46.0000000+00:00'
                datetime_last_modified: '2023-02-12T01:04:21.0000000+00:00'
                reference: LOAN03584
                reference_customer_id: CUST67044
                reference_customer_name: Building Society Ltd
                description: Acme Ltd looking to borrow money to fund a new fleet of delivery vehicles.
                source: API
                owner: Cecilia Adams
                ownership:
                - owner_id: 6a9f8d73-29f4-4a6a-80dc-21b8cbecff75
                  owner_type: user
                number_of_companies: '2'
                number_of_persons: '5'
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: 9a518655-9572-43fa-b747-b282ca41365e
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: b16595e7-e145-4656-bc54-0f6acbcf3dcd
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 6df0d285-68aa-4132-b164-3212c2076e4e
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: e8eae48b-e73b-4a2e-8a63-e750f96437f2
    post:
      tags:
      - Cases
      summary: Create a case
      description: "### Creates a new case\r\n\r\nYou have the option to add companies and people at the point of case creation\
        \ or at a later stage.\r\n\r\nWhen adding companies at the point of case creation, you can retrieve company registration\
        \ data by setting `registry_search` to `true`, and ensuring that `company_name`, `company_number`, and `jurisdiction_code`\
        \ are not empty.  If the company registration data cannot be found, the case is created with the provided company\
        \ details. If the company registration data is found, the `status`, `number_of_officers`, and `number_of_owners` are\
        \ updated to reflect the registry data.\r\n\r\nAdditionally, you can choose to add all the company's (human) officers\
        \ to the case by setting `add_directors` to `true`. Note that this flag is applicable only when `registry_search`\
        \ is set to `true`.\r\n"
      operationId: POST_v2-cases
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Requests.CreateCaseRequest'
            example:
              name: Acme Ltd Loan Application
              case_type: Business
              stage: New
              reference: LOAN03584
              reference_customer_id: CUST67044
              reference_customer_name: Building Society Ltd
              owner: Cecilia Adams
              ownership:
              - owner_id: 6a9f8d73-29f4-4a6a-80dc-21b8cbecff75
                owner_type: user
              description: Acme Ltd looking to borrow money to fund a new fleet of delivery vehicles.
              source: API
              companies:
              - company_name: Acme Limited
                company_number: '77642080'
                jurisdiction_code: GB
                registry_search: true
                add_directors: true
              persons:
              - first_name: Wilson
                last_name: Pascale
                email: wislon@acme.ltd.uk
                postal_address:
                  house_number: '123'
                  building_name: Main House
                  sub_building_name: string
                  address_line_1: Main Street
                  address_line_2: Apt.101
                  locality: Test County
                  city: Test Town
                  post_code: X9 9AA
                  country: GB
                date_of_birth: '1985-06-12'
                employer: Acme Limited
                is_officer: true
                reference_person_id: Wilson5432
      responses:
        '201':
          description: The created case
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Responses.CaseResponse'
              example:
                case_id: 64cd8202-2db4-44d5-85be-79438d65eb7b
                name: Acme Ltd Loan Application
                case_type: Business
                stage: New
                datetime_created: '2023-02-10T10:59:46.0260000+00:00'
                datetime_last_modified: '2023-02-12T13:04:21.3260000+00:00'
                reference: LOAN03584
                reference_customer_id: CUST67044
                reference_customer_name: Building Society Ltd
                description: Acme Ltd looking to borrow money to fund a new fleet of delivery vehicles.
                source: API
                owner: Cecilia Adams
                ownership:
                - owner_id: 6a9f8d73-29f4-4a6a-80dc-21b8cbecff75
                  owner_type: user
                number_of_companies: '2'
                number_of_persons: '5'
                companies:
                - company_id: a035d37a-dee1-4a4e-b098-168a6a1f4603
                  company_name: Acme Limited
                  company_number: '77642080'
                  jurisdiction_code: GB
                  status: Active
                  number_of_officers: '5'
                  number_of_owners: '2'
                  media_adverse_requested: true
                  pep_sanction_requested: true
                persons:
                - person_id: 8303ce21-3120-4981-9a19-560ef110502b
                  first_name: Wilson
                  last_name: Pascale
                  name: Wilson Pascale
                  email: wislon@acme.ltd.uk
                  postal_address:
                    house_number: '123'
                    building_name: Main House
                    sub_building_name: string
                    address_line_1: Main Street
                    address_line_2: Apt. 101
                    locality: Test Country
                    city: Test Town
                    post_code: X9 9AA
                    country: GB
                    summary_line: 123, Main Street, Main House, Apt. 101, Test County, Test Town, X9 9AA, GB
                  date_of_birth: '1985-06-12'
                  employer: Acme Limited
                  is_officer: true
                  appointments: string
                  reference_person_id: Wilson5432
                  media_adverse_requested: true
                  pep_sanction_requested: true
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: 582535be-c42a-4e5f-9efa-a121842cc6f8
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 2622efbf-488c-4824-91d8-01ccdd2010f2
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: e1c426b8-6f38-47d9-8efd-76e29653e977
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 844d74d3-d437-46db-8781-ee8f55e0676b
  /v2/cases/{case_id}:
    get:
      tags:
      - Cases
      summary: Retrieve a case
      description: "### Retrieve a single case.\r\n\r\nReturns information about a case, including lists of the individual\
        \ companies and people within it as well as their associated `company_id` or `person_id`.\r\n"
      operationId: GET_v2-cases-case_id
      parameters:
      - name: case_id
        in: path
        description: Sikoia ID for the case
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Retrieved Case
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Responses.CaseResponse'
              example:
                case_id: 64cd8202-2db4-44d5-85be-79438d65eb7b
                name: Acme Ltd Loan Application
                case_type: Business
                stage: New
                datetime_created: '2023-02-10T10:59:46.0260000+00:00'
                datetime_last_modified: '2023-02-12T13:04:21.3260000+00:00'
                reference: LOAN03584
                reference_customer_id: CUST67044
                reference_customer_name: Building Society Ltd
                description: Acme Ltd looking to borrow money to fund a new fleet of delivery vehicles.
                source: API
                owner: Cecilia Adams
                ownership:
                - owner_id: 6a9f8d73-29f4-4a6a-80dc-21b8cbecff75
                  owner_type: user
                number_of_companies: '2'
                number_of_persons: '5'
                companies:
                - company_id: a035d37a-dee1-4a4e-b098-168a6a1f4603
                  company_name: Acme Limited
                  company_number: '77642080'
                  jurisdiction_code: GB
                  status: Active
                  number_of_officers: '5'
                  number_of_owners: '2'
                  media_adverse_requested: true
                  pep_sanction_requested: true
                persons:
                - person_id: 8303ce21-3120-4981-9a19-560ef110502b
                  first_name: Wilson
                  last_name: Pascale
                  name: Wilson Pascale
                  email: wislon@acme.ltd.uk
                  postal_address:
                    house_number: '123'
                    building_name: Main House
                    sub_building_name: string
                    address_line_1: Main Street
                    address_line_2: Apt. 101
                    locality: Test Country
                    city: Test Town
                    post_code: X9 9AA
                    country: GB
                    summary_line: 123, Main Street, Main House, Apt. 101, Test County, Test Town, X9 9AA, GB
                  date_of_birth: '1985-06-12'
                  employer: Acme Limited
                  is_officer: true
                  appointments: string
                  reference_person_id: Wilson5432
                  media_adverse_requested: true
                  pep_sanction_requested: true
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 187f6c48-c248-4179-a1b5-f4114096690b
        '404':
          description: Case Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 29ae6bb5-0a12-4c6c-98c3-92d160fb34dc.
                correlation_id: dae3c74a-526d-4f0d-846a-5bdec0c569c3
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 5a2e5909-67e1-4406-aeb0-2cfac015a2ad
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 3126f0a6-7775-45d6-8082-b0281648be06
    patch:
      tags:
      - Cases
      summary: Update a case
      description: "### Updates details for an existing case.\r\n\r\nWhile all fields are optional, the request must include\
        \ at least one field.\r\n\r\nTo clear a field, send an empty string as the field value.\r\n"
      operationId: PATCH_v2-cases-case_id
      parameters:
      - name: case_id
        in: path
        description: Sikoia ID for the case
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Requests.UpdateCaseRequest'
            example:
              name: Acme Ltd 2nd Loan Application
              stage: Approved
              reference: LOAN03584
              reference_customer_id: CUST67044
              reference_customer_name: Building Society Ltd
              description: Acme Ltd looking for another loan
              source: API
              owner: Katerina Valentin
              ownership:
              - owner_id: 6a9f8d73-29f4-4a6a-80dc-21b8cbecff75
                owner_type: user
      responses:
        '200':
          description: Updated Case
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Responses.CaseResponse'
              example:
                case_id: 64cd8202-2db4-44d5-85be-79438d65eb7b
                name: Acme Ltd Loan Application
                case_type: Business
                stage: New
                datetime_created: '2023-02-10T10:59:46.0260000+00:00'
                datetime_last_modified: '2023-02-12T13:04:21.3260000+00:00'
                reference: LOAN03584
                reference_customer_id: CUST67044
                reference_customer_name: Building Society Ltd
                description: Acme Ltd looking to borrow money to fund a new fleet of delivery vehicles.
                source: API
                owner: Cecilia Adams
                ownership:
                - owner_id: 6a9f8d73-29f4-4a6a-80dc-21b8cbecff75
                  owner_type: user
                number_of_companies: '2'
                number_of_persons: '5'
                companies:
                - company_id: a035d37a-dee1-4a4e-b098-168a6a1f4603
                  company_name: Acme Limited
                  company_number: '77642080'
                  jurisdiction_code: GB
                  status: Active
                  number_of_officers: '5'
                  number_of_owners: '2'
                  media_adverse_requested: true
                  pep_sanction_requested: true
                persons:
                - person_id: 8303ce21-3120-4981-9a19-560ef110502b
                  first_name: Wilson
                  last_name: Pascale
                  name: Wilson Pascale
                  email: wislon@acme.ltd.uk
                  postal_address:
                    house_number: '123'
                    building_name: Main House
                    sub_building_name: string
                    address_line_1: Main Street
                    address_line_2: Apt. 101
                    locality: Test Country
                    city: Test Town
                    post_code: X9 9AA
                    country: GB
                    summary_line: 123, Main Street, Main House, Apt. 101, Test County, Test Town, X9 9AA, GB
                  date_of_birth: '1985-06-12'
                  employer: Acme Limited
                  is_officer: true
                  appointments: string
                  reference_person_id: Wilson5432
                  media_adverse_requested: true
                  pep_sanction_requested: true
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: bdc39a61-17f3-4d27-958b-86abe1bda15b
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: fff255f3-be78-48d9-826a-6b394e52bb49
        '404':
          description: Case Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id cb74296c-3b8c-4005-933b-355219d150cc.
                correlation_id: 0bbcff17-0ed8-4ee3-80f0-a30c0334f12e
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 1174d652-7f7f-4d9f-9e01-e56844de42f0
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 7ae566db-bf25-4297-9db4-c9ea466ecfab
    delete:
      tags:
      - Cases
      summary: Delete a case
      description: "### Deletes a single case.\r\n\r\nThis also deletes all of the associated companies, people and documents\
        \ within the case.\r\n\r\nPlease note that this action cannot be undone.\r\n"
      operationId: DELETE_v2-cases-case_id
      parameters:
      - name: case_id
        in: path
        description: Sikoia ID for the case
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted case
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 1b8c07df-23c9-48c8-88bd-ffff6cdb37c9
        '404':
          description: Case Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id e3d720d8-8c4f-4737-85a5-382bd0be6105.
                correlation_id: 9829fa7d-8a1d-4194-a82d-7fa94e907cf2
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 9b1d1da1-d9b0-4a83-871c-6d4241a0cf0d
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 5569a5d0-dbfe-4fd0-81ad-822ab33ff2ad
  /v2/cases/{case_id}/entities:
    post:
      tags:
      - Companies & People
      summary: Add entities to a case
      description: "### Adds companies and / or people to an existing case.\r\n\r\nThis endpoint behaves the same as the Create\
        \ Case endpoint when adding companies and / or people.\r\n\r\nWhen adding companies, you can retrieve company registration\
        \ data by setting `registry_search` to `true`, and ensuring that `company_name`, `company_number`, and `jurisdiction_code`\
        \ are not empty. If the data cannot be found, the case is created with the provided company details. If the company\
        \ registration data is found, the `status`, `number_of_officers`, and `number_of_owners` are updated to reflect the\
        \ registry data.\r\n\r\nAdditionally, you can choose to add all the company's (human) officers to the case by setting\
        \ `add_directors` to `true`. Note that this flag is applicable only when `registry_search` is set to `true`.\r\n"
      operationId: POST_v2-cases-case_id-entities
      parameters:
      - name: case_id
        in: path
        description: Sikoia ID for the case
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Requests.AddEntitiesToCaseRequest'
            example:
              companies:
              - company_name: Acme Limited
                company_number: '77642080'
                jurisdiction_code: GB
                registry_search: true
                add_directors: true
              persons:
              - first_name: Wilson
                last_name: Pascale
                email: wislon@acme.ltd.uk
                postal_address:
                  house_number: '123'
                  building_name: Main House
                  sub_building_name: string
                  address_line_1: Main Street
                  address_line_2: Apt.101
                  locality: Test County
                  city: Test Town
                  post_code: X9 9AA
                  country: GB
                date_of_birth: '1985-06-12'
                employer: Acme Limited
                is_officer: true
                reference_person_id: Wilson5432
      responses:
        '201':
          description: Case with New Entities
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Responses.CaseResponse'
              example:
                case_id: 64cd8202-2db4-44d5-85be-79438d65eb7b
                name: Acme Ltd Loan Application
                case_type: Business
                stage: New
                datetime_created: '2023-02-10T10:59:46.0260000+00:00'
                datetime_last_modified: '2023-02-12T13:04:21.3260000+00:00'
                reference: LOAN03584
                reference_customer_id: CUST67044
                reference_customer_name: Building Society Ltd
                description: Acme Ltd looking to borrow money to fund a new fleet of delivery vehicles.
                source: API
                owner: Cecilia Adams
                ownership:
                - owner_id: 6a9f8d73-29f4-4a6a-80dc-21b8cbecff75
                  owner_type: user
                number_of_companies: '2'
                number_of_persons: '5'
                companies:
                - company_id: a035d37a-dee1-4a4e-b098-168a6a1f4603
                  company_name: Acme Limited
                  company_number: '77642080'
                  jurisdiction_code: GB
                  status: Active
                  number_of_officers: '5'
                  number_of_owners: '2'
                  media_adverse_requested: true
                  pep_sanction_requested: true
                persons:
                - person_id: 8303ce21-3120-4981-9a19-560ef110502b
                  first_name: Wilson
                  last_name: Pascale
                  name: Wilson Pascale
                  email: wislon@acme.ltd.uk
                  postal_address:
                    house_number: '123'
                    building_name: Main House
                    sub_building_name: string
                    address_line_1: Main Street
                    address_line_2: Apt. 101
                    locality: Test Country
                    city: Test Town
                    post_code: X9 9AA
                    country: GB
                    summary_line: 123, Main Street, Main House, Apt. 101, Test County, Test Town, X9 9AA, GB
                  date_of_birth: '1985-06-12'
                  employer: Acme Limited
                  is_officer: true
                  appointments: string
                  reference_person_id: Wilson5432
                  media_adverse_requested: true
                  pep_sanction_requested: true
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: 12ae3d33-4fd1-4641-8e3c-a03ad1b5c42b
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 70657df9-f195-4800-bda3-a6c75f045e4d
        '404':
          description: Case Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id d7734fe3-71a7-4bce-a852-ca4bc24268ff.
                correlation_id: aa068a8a-47d8-4a41-8fcb-fbbbbb2b947c
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: f5dc01bb-e320-4cdc-a993-56e34981453f
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 10ac4d01-4dd8-4935-8cb1-953a3e4706be
    patch:
      tags:
      - Companies & People
      summary: Update entities in a case
      description: "### Updates existing companies and / or people in a case.\r\n\r\nAll fields are optional, except for `company_id`\
        \ or `person_id`; however, the request must include at least one field.\r\n\r\nTo clear a field, simply send an empty\
        \ string as the field value.\r\n"
      operationId: PATCH_v2-cases-case_id-entities
      parameters:
      - name: case_id
        in: path
        description: Sikoia ID for the case
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Requests.UpdateCaseEntitiesRequest'
            example:
              companies:
              - company_id: a035d37a-dee1-4a4e-b098-168a6a1f4603
                company_name: Acme Limited
                company_number: '77642080'
                jurisdiction_code: GB
              persons:
              - person_id: 8303ce21-3120-4981-9a19-560ef110502b
                first_name: Wilson
                last_name: Pascale
                email: wislon@acme.ltd.uk
                postal_address:
                  house_number: '123'
                  building_name: Main House
                  sub_building_name: string
                  address_line_1: Main Street
                  address_line_2: Apt.101
                  locality: Test County
                  city: Test Town
                  post_code: X9 9AA
                  country: GB
                date_of_birth: '1985-06-12'
                employer: Acme Limited
                reference_person_id: Wilson5432
      responses:
        '201':
          description: Case with Updated Entities
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Responses.CaseResponse'
              example:
                case_id: 64cd8202-2db4-44d5-85be-79438d65eb7b
                name: Acme Ltd Loan Application
                case_type: Business
                stage: New
                datetime_created: '2023-02-10T10:59:46.0260000+00:00'
                datetime_last_modified: '2023-02-12T13:04:21.3260000+00:00'
                reference: LOAN03584
                reference_customer_id: CUST67044
                reference_customer_name: Building Society Ltd
                description: Acme Ltd looking to borrow money to fund a new fleet of delivery vehicles.
                source: API
                owner: Cecilia Adams
                ownership:
                - owner_id: 6a9f8d73-29f4-4a6a-80dc-21b8cbecff75
                  owner_type: user
                number_of_companies: '2'
                number_of_persons: '5'
                companies:
                - company_id: a035d37a-dee1-4a4e-b098-168a6a1f4603
                  company_name: Acme Limited
                  company_number: '77642080'
                  jurisdiction_code: GB
                  status: Active
                  number_of_officers: '5'
                  number_of_owners: '2'
                  media_adverse_requested: true
                  pep_sanction_requested: true
                persons:
                - person_id: 8303ce21-3120-4981-9a19-560ef110502b
                  first_name: Wilson
                  last_name: Pascale
                  name: Wilson Pascale
                  email: wislon@acme.ltd.uk
                  postal_address:
                    house_number: '123'
                    building_name: Main House
                    sub_building_name: string
                    address_line_1: Main Street
                    address_line_2: Apt. 101
                    locality: Test Country
                    city: Test Town
                    post_code: X9 9AA
                    country: GB
                    summary_line: 123, Main Street, Main House, Apt. 101, Test County, Test Town, X9 9AA, GB
                  date_of_birth: '1985-06-12'
                  employer: Acme Limited
                  is_officer: true
                  appointments: string
                  reference_person_id: Wilson5432
                  media_adverse_requested: true
                  pep_sanction_requested: true
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: 8798afca-4df6-44dc-9633-e62cab611697
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 6147d230-72bb-41c1-8e0e-d7bc6ca93700
        '404':
          description: Case Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 91b32550-0b6c-415b-9451-2e0a09e13f1a.
                correlation_id: 551a5561-1c8a-4f83-88de-3726c315b932
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 47c2726c-23bf-4a8f-963f-0666604689ab
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: cad08426-bf63-446c-84f1-24cac1af8a70
  /v2/cases/{case_id}/entities/delete:
    post:
      tags:
      - Companies & People
      summary: Delete entities in a case
      description: "### Deletes companies and / or people from a case.\r\n\r\nAccepts a list of person and / or company IDs\
        \ to delete from the case.\r\n\r\nPlease note that this action cannot be undone.\r\n"
      operationId: POST_v2-cases-case_id-entities-delete
      parameters:
      - name: case_id
        in: path
        description: Sikoia ID for the case
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Requests.DeleteCaseEntityRequest'
            example:
              companies: '["ddf1d8ef-2cca-41ef-89c1-00fb0c05c54f"]'
              persons: '["c28c88d6-7fb5-4c2f-a5a1-559cd2675293"]'
      responses:
        '200':
          description: Case with Deleted Entities
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Responses.CaseResponse'
              example:
                case_id: 64cd8202-2db4-44d5-85be-79438d65eb7b
                name: Acme Ltd Loan Application
                case_type: Business
                stage: New
                datetime_created: '2023-02-10T10:59:46.0260000+00:00'
                datetime_last_modified: '2023-02-12T13:04:21.3260000+00:00'
                reference: LOAN03584
                reference_customer_id: CUST67044
                reference_customer_name: Building Society Ltd
                description: Acme Ltd looking to borrow money to fund a new fleet of delivery vehicles.
                source: API
                owner: Cecilia Adams
                ownership:
                - owner_id: 6a9f8d73-29f4-4a6a-80dc-21b8cbecff75
                  owner_type: user
                number_of_companies: '2'
                number_of_persons: '5'
                companies:
                - company_id: a035d37a-dee1-4a4e-b098-168a6a1f4603
                  company_name: Acme Limited
                  company_number: '77642080'
                  jurisdiction_code: GB
                  status: Active
                  number_of_officers: '5'
                  number_of_owners: '2'
                  media_adverse_requested: true
                  pep_sanction_requested: true
                persons:
                - person_id: 8303ce21-3120-4981-9a19-560ef110502b
                  first_name: Wilson
                  last_name: Pascale
                  name: Wilson Pascale
                  email: wislon@acme.ltd.uk
                  postal_address:
                    house_number: '123'
                    building_name: Main House
                    sub_building_name: string
                    address_line_1: Main Street
                    address_line_2: Apt. 101
                    locality: Test Country
                    city: Test Town
                    post_code: X9 9AA
                    country: GB
                    summary_line: 123, Main Street, Main House, Apt. 101, Test County, Test Town, X9 9AA, GB
                  date_of_birth: '1985-06-12'
                  employer: Acme Limited
                  is_officer: true
                  appointments: string
                  reference_person_id: Wilson5432
                  media_adverse_requested: true
                  pep_sanction_requested: true
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: 77429fb5-9be7-40d7-b689-459cd9600861
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 5a6cb4f7-1ef9-40d4-9307-961ad146b764
        '404':
          description: Case Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 1f84f8ca-b1d1-4fe4-9729-b56c6f47e7f4.
                correlation_id: cdb6963a-754f-4716-8aba-2c05032bd48e
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 231373e9-557b-40c2-9c3a-5bc07e654d8f
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 2374085c-c9e0-4afa-97f0-1d428ba480a7
  /v2/company-registry-data:
    post:
      tags:
      - Company Registry
      summary: Request registry data
      description: "### Requests registry data for a company.\r\n\r\nYou can create a request with only the `company_id`,\
        \ and the necessary data will be retrieved from the company entity. If the company entity is missing `company_number`\
        \ or `country_code`, a 422 - Unprocessable error will be raised.\r\n\r\nAlternatively, you can override the company\
        \ entity details by sending `company_number`, `company_name`, and `country_code` alongside the `company_id` in the\
        \ request body.  \r\n\r\nIf it is not possible to identify a single company in the relevant registry based on the\
        \ data provided, the response will have a status of `TooManyResults`. You can resolve this picklist using the `POST\
        \ /v2/company-registry-data/picklist endpoint`.\r\n"
      operationId: POST_v2-company-registry-data
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Request.RegistryDataRequest'
            example:
              company_id: 78662640-73fc-4fa9-8367-ef4660d35cee
              company_number: '12345678'
              company_name: Acme Inc
              country_code: GB
      responses:
        '201':
          description: Registry Data Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.RegistryDataResponse'
              example:
                request_id: 276c102b-85d3-4e86-a69d-de1b2ba72150
                status: Complete
                company_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                datetime_requested: '2024-02-12T13:18:28.9780000+00:00'
                message: string
                company_number: '12345678'
                company_name: Acme Inc
                country_code: GB
                picklist: '[]'
        '400':
          description: Company Entity Deleted/Not Found or Country Not Recognised
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: 71673cbb-3f75-48f1-b480-03d3c6c82a8a
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: ca87a716-7eb6-4093-8227-d46111b3b049
        '403':
          description: Insufficient Credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InsufficientPermissions
                status: 403
                title: Service not enabled
                detail: Service is not currently enabled.
                correlation_id: 8a83523b-7add-4dca-98f9-280ac083c62e
        '422':
          description: Company Entity Missing Information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: UnprocessableRequest
                status: 422
                title: Entity Missing Information
                detail: Entity with id 2ad611a0-d26e-4502-a68c-7a70f58f12e2 is missing required information, please update
                  entity.
                correlation_id: 6c184595-c5a0-46ee-accd-ab97eed3c968
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 0c6d8b85-901a-44f2-861f-fdb7b22d60c5
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: d305a79e-fef3-4adc-a063-6469eb4daabc
  /v2/companies/{company_id}/registry-data:
    get:
      tags:
      - Company Registry
      summary: List all registry data requests
      description: "### Returns a list of all registry data requests for a company.\r\n\r\nThe list includes the `request_id`\
        \ for each request, which can be used to retrieve detailed registry data using the `GET /v2/company-registry-data/{request_id}`\
        \ endpoint.\r\n"
      operationId: GET_v2-companies-company_id-registry-data
      parameters:
      - name: company_id
        in: path
        description: Sikoia ID for the Company
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Registry Data Requests List
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.RegistryDataListResponse'
              example:
                company_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                registry_data_requests:
                - request_id: 276c102b-85d3-4e86-a69d-de1b2ba72150
                  status: Complete
                  datetime_requested: '2024-02-12T13:18:28.9780000+00:00'
                  message: string
                  company_number: '12345678'
                  company_name: Acme Inc
                  country_code: GB
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: eede0337-baf7-48c5-b07f-641558af3f18
        '404':
          description: Company Entity Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 51d093e0-2ef7-426c-9d20-e454fc87ded6.
                correlation_id: b592f462-ab3f-4aa0-b236-2a51c0491d0c
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: fd2efe10-b38c-4d4b-af30-8534788fba00
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 02ddd458-6e9f-408c-a223-8f50c9b9b92a
  /v2/company-registry-data/{request_id}:
    get:
      tags:
      - Company Registry
      summary: Retrieve registry data
      description: "### Returns detailed company registry data\r\n\r\nThis endpoint returns the full registry data associated\
        \ with a specific request_id.\r\n"
      operationId: GET_v2-company-registry-data-request_id
      parameters:
      - name: request_id
        in: path
        description: Sikoia ID for the request
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Registry Data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.RegistryDataMappedResponse'
              example:
                request_id: string
                status: string
                company_id: string
                datetime_requested: string
                message: string
                company_number: string
                company_name: string
                country_code: string
                data:
                  company_name: string
                  company_number: string
                  status: string
                  registry_status: string
                  registry_name: string
                  registry_url: string
                  data_provider: string
                  generic_legal_form: string
                  registry_legal_form: string
                  country_code: string
                  date_established: string
                  date_dissolved: string
                  official_address:
                    address_line_1: 10 Main Street
                    address_line_2: Apt. 101
                    address_line_3: Main House
                    address_line_4: string
                    city: Test Town
                    region: Test Country
                    country: GB
                    post_code: X9 9AA
                    full_address: 123 Main Street, Main House, Apt. 101, Test County, Test Town, X9 9AA, GB
                  summary_info:
                    has_insolvency_history: true
                  special_characteristics:
                  - string
                  previous_company_names:
                  - company_name: string
                    date_from: string
                    date_to: string
                  accounts:
                    last_accounts:
                      made_up_to: string
                      period_start: string
                      period_end: string
                      type: string
                    next_accounts:
                      overdue: true
                      period_start: string
                      period_end: string
                      due_date: string
                  industry_codes:
                  - code: string
                    description: string
                  officers:
                    people:
                    - source_id: string
                      officer_role: string
                      date_appointed: string
                      date_resigned: string
                      status: string
                      tax_id: string
                      first_name: string
                      surname: string
                      full_name: string
                      date_of_birth: string
                      birth_year: 0
                      birth_month: 0
                      birth_day: 0
                      nationality: string
                      address:
                        address_line_1: 10 Main Street
                        address_line_2: Apt. 101
                        address_line_3: Main House
                        address_line_4: string
                        city: Test Town
                        region: Test Country
                        country: GB
                        post_code: X9 9AA
                        full_address: 123 Main Street, Main House, Apt. 101, Test County, Test Town, X9 9AA, GB
                      occupation: string
                    companies:
                    - source_id: string
                      officer_role: string
                      date_appointed: string
                      date_resigned: string
                      status: string
                      name: string
                      address:
                        address_line_1: 10 Main Street
                        address_line_2: Apt. 101
                        address_line_3: Main House
                        address_line_4: string
                        city: Test Town
                        region: Test Country
                        country: GB
                        post_code: X9 9AA
                        full_address: 123 Main Street, Main House, Apt. 101, Test County, Test Town, X9 9AA, GB
                      occupation: string
                  owners:
                    people:
                    - source_id: string
                      first_name: string
                      surname: string
                      full_name: string
                      type: string
                      date_from: string
                      date_to: string
                      natures_of_control:
                      - string
                      date_of_birth: string
                      birth_year: 0
                      birth_month: 0
                      birth_day: 0
                      nationality: string
                      address:
                        address_line_1: 10 Main Street
                        address_line_2: Apt. 101
                        address_line_3: Main House
                        address_line_4: string
                        city: Test Town
                        region: Test Country
                        country: GB
                        post_code: X9 9AA
                        full_address: 123 Main Street, Main House, Apt. 101, Test County, Test Town, X9 9AA, GB
                    companies:
                    - source_id: string
                      name: string
                      type: string
                      date_from: string
                      date_to: string
                      natures_of_control:
                      - string
                      address:
                        address_line_1: 10 Main Street
                        address_line_2: Apt. 101
                        address_line_3: Main House
                        address_line_4: string
                        city: Test Town
                        region: Test Country
                        country: GB
                        post_code: X9 9AA
                        full_address: 123 Main Street, Main House, Apt. 101, Test County, Test Town, X9 9AA, GB
                  filings:
                  - category: string
                    description: string
                    type: string
                    filing_date: string
                  charges:
                  - charge_code: string
                    status: string
                    created_on: string
                    delivered_on: string
                    satisfied_on: string
                    details:
                      type: string
                      description: string
                    transactions:
                    - filing_type: string
                      delivered_on: string
                    classification:
                      type: string
                      description: string
                    persons_entitled:
                    - name: string
                    secured_details:
                      type: string
                      description: string
                  insolvencies:
                  - type: string
                    dates:
                    - date: string
                      type: string
                  controlling_entity:
                    company_name: string
                    company_number: string
                    country_code: string
                    generic_legal_form: string
                  foreign_controlling_entity:
                    company_name: string
                    company_number: string
                    country_code: string
                    generic_legal_form: string
                picklist:
                - index: '1'
                  company_name: ACME INC
                  company_number: '12345678'
                  company_status: Active
                  provider_id: string
                  date_established: '1982-01-07'
                  country_code: GB
                  branch_status: string
                  official_address:
                    address_line_1: 10 Main Street
                    address_line_2: Apt. 101
                    address_line_3: Main House
                    address_line_4: string
                    city: Test Town
                    region: Test Country
                    country: GB
                    post_code: X9 9AA
                    full_address: 123 Main Street, Main House, Apt. 101, Test County, Test Town, X9 9AA, GB
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 8a512044-8d46-4ea7-b928-c9d44192879b
        '404':
          description: Request ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id c10219d7-72f7-4643-9c4f-729a8031fb48.
                correlation_id: 15d870cc-3acc-41d2-a22f-c1ebd2353da2
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 40b4e40f-bfcf-4131-b7ca-35cfde573846
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 9e4905dc-233c-4336-a443-0d6bc1893bc8
  /v2/company-registry-data/picklist:
    post:
      tags:
      - Company Registry
      summary: Resolve registry picklist
      description: "### Resolves a company registry data picklist.\r\n\r\nTo resolve a picklist, send the original `request_id`\
        \ and the `picklist_index` to this endpoint.\r\n\r\nThis will create a new entry in the list of registry data requests\
        \ for the company entity.\r\n\r\nYou can retrieve a list of all registry data requests for a company using the `GET\
        \ /v2/companies/{company_id}/registry-data` endpoint.\r\n"
      operationId: POST_v2-company-registry-data-picklist
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Request.ResolvePicklistRequest'
            example:
              request_id: cfed4c7f-37e8-4657-b185-7cf572d0b019
              picklist_index: '1'
      responses:
        '201':
          description: Picklist Resolved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.RegistryDataResponse'
              example:
                request_id: 276c102b-85d3-4e86-a69d-de1b2ba72150
                status: Complete
                company_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                datetime_requested: '2024-02-12T13:18:28.9780000+00:00'
                message: string
                company_number: '12345678'
                company_name: Acme Inc
                country_code: GB
                picklist: '[]'
        '400':
          description: Company Entity Deleted/Not Found or Request Did Not Produce Picklist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: aca89a98-76f7-4421-9f58-3cd2da4b5228
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 3382f396-8ecb-4e33-8d31-04a5826db4cd
        '403':
          description: Insufficient Credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InsufficientPermissions
                status: 403
                title: Service not enabled
                detail: Service is not currently enabled.
                correlation_id: 65cd7ade-d30d-43ea-b8a7-ce5bde41fe0e
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 95494aab-3b27-47ca-a451-085863b080dd
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 6f37c6d5-fedb-4ff8-8efd-97b0737f5e30
  /v2/company-registry-data/search:
    post:
      tags:
      - Company Registry
      summary: Search for a company
      description: "### Searches for a company in business registries.\r\n\r\nSearch using the `company_name` and at least\
        \ one of `jurisdiction_code` or `country_code`.  If both codes are specified, jurisdiction_code takes priority.\r\n\
        \r\nYou can exclude inactive companies from results by setting `exclude_inactive` to `true`.\r\n\r\nIf your search\
        \ is associated with a specific company entity instead of a standalone search, include the `company_id` in the request.\
        \  Keep in mind that even when using a `company_id`, the search data is transient and won't be stored against the\
        \ company.\r\n\r\n"
      operationId: POST_v2-company-registry-data-search
      parameters:
      - name: items_per_page
        in: query
        schema:
          type: integer
          description: Items Per Page
          format: integer
          default: 100
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Request.CompanySearchRequest'
            example:
              company_name: Acme Inc
              jurisdiction_code: GB
              country_code: GB
              exclude_inactive: 'true'
              company_id: 78662640-73fc-4fa9-8367-ef4660d35cee
      responses:
        '200':
          description: Companies Retrieved
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.CompanySearchMappedResponse'
              example:
              - index: '1'
                company_name: ACME INC
                company_number: '12345678'
                company_status: Active
                provider_id: string
                date_established: '1982-01-07'
                country_code: GB
                branch_status: string
                official_address:
                  address_line_1: 10 Main Street
                  address_line_2: Apt. 101
                  address_line_3: Main House
                  address_line_4: string
                  city: Test Town
                  region: Test Country
                  country: GB
                  post_code: X9 9AA
                  full_address: 123 Main Street, Main House, Apt. 101, Test County, Test Town, X9 9AA, GB
        '400':
          description: Company Entity Deleted/Not Found or Country Not Recognised
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: 5114e597-5de1-443b-b28f-912f9b61d882
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 40a84628-ed55-4437-a53f-74dbbfc933c5
        '403':
          description: Insufficient Credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InsufficientPermissions
                status: 403
                title: Service not enabled
                detail: Service is not currently enabled.
                correlation_id: ea2adc39-2ef4-4aa0-a1bb-5a1732bf4a99
        '404':
          description: No Search Results Returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 4ec085e2-2335-48cb-a1c7-2e0548b7594d.
                correlation_id: 8a4ae9e5-9083-4305-939c-574f3a41ec40
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: ffc188eb-c7a4-48ef-92de-fc92a002a2ea
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 12f7d835-67a3-4146-a5f9-74d106485fbc
  /v2/company-credit-reports:
    post:
      tags:
      - Company Credit Report
      summary: Request credit report
      description: "### Requests a credit report for a company.\r\n\r\nYou can create a request with only the `company_id`,\
        \ and the necessary data will be retrieved from the company entity. A 422 - Unprocessable Error will be raised if\
        \ the company entity is missing `company_number` or `country_code`.\r\n\r\nAlternatively, you can override the company\
        \ entity details by sending `company_number`, `company_name`, and `country_code` alongside the `company_id` in the\
        \ request body. The credit report returned will be associated with the `company_id` on the request.\r\n\r\nAs a third\
        \ option, you can send a 3rd party data provider `provider_id` for a specific company within their system. The credit\
        \ report returned will be associated with the `company_id` on the request.\r\n\r\nIf resolving the credit report to\
        \ a single company is not possible, the response will have a status of `TooManyResults`. You can resolve this picklist\
        \ using the `POST /v2/company-credit-reports/picklist` endpoint.\r\n\r\n"
      operationId: POST_v2-company-credit-reports
      requestBody:
        content:
          application/json:
            schema:
              title: Credit Report Request
              oneOf:
              - $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Request.CreditReportRequest'
              - $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Request.CreditReportRequestByCompanyId'
              - $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Request.CreditReportRequestByDetails'
              - $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Request.CreditReportRequestByProviderId'
            example:
              company_id: 78662640-73fc-4fa9-8367-ef4660d35cee
              company_number: '12345678'
              company_name: Acme Inc
              country_code: GB
              provider_id: string
      responses:
        '201':
          description: Credit Report Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.CreditReportResponse'
              example:
                request_id: cfed4c7f-37e8-4657-b185-7cf572d0b019
                status: Complete
                company_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                datetime_requested: '2024-02-12T14:50:10.3830000+00:00'
                message: string
                company_number: '12345678'
                company_name: Acme Inc
                country_code: GB
                provider_id: string
                picklist: '[]'
        '400':
          description: Company Entity Deleted/Not Found or Country Not Recognised
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: a769b6bf-4e90-4eb3-980f-a42e4a13ffdf
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: b40f2abc-a5e4-4fda-bfea-a1a42d1c118b
        '403':
          description: Insufficient Credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InsufficientPermissions
                status: 403
                title: Service not enabled
                detail: Service is not currently enabled.
                correlation_id: 039d29c0-cf91-4f48-9573-fa31c14957a3
        '422':
          description: Company Entity Missing Information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: UnprocessableRequest
                status: 422
                title: Entity Missing Information
                detail: Entity with id 7ebd8c19-f0fb-4d87-b333-708e45af7bc4 is missing required information, please update
                  entity.
                correlation_id: 4404f52b-d8bd-4ad7-8b6d-8277a36e7067
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 7599dc4e-5ad2-49ea-a2cb-b616d0744344
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 359c08cb-90f2-4f7f-b086-a9f82b4cc7a8
  /v2/companies/{company_id}/credit-reports:
    get:
      tags:
      - Company Credit Report
      summary: List all credit report requests
      description: "### Returns a list of all credit reports requested for a company.\r\n\r\nThe list includes the `request_id`\
        \ for each request, which can be used to retrieve detailed company credit report data using the `GET /v2/company-credit-reports/{request_id}`\
        \ endpoint.\r\n"
      operationId: GET_v2-companies-company_id-credit-reports
      parameters:
      - name: company_id
        in: path
        description: Sikoia ID for the Company
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Credit Report Requests List
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.CreditReportListResponse'
              example:
                company_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                credit_report_requests:
                - request_id: cfed4c7f-37e8-4657-b185-7cf572d0b019
                  status: Complete
                  datetime_requested: '2024-02-12T14:50:10.3830000+00:00'
                  message: string
                  company_number: '12345678'
                  company_name: Acme Inc
                  country_code: GB
                  provider_id: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 37b7d04c-2f5f-442d-879c-e36a38e16e40
        '404':
          description: Company Entity Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id e407c607-53b5-425d-980c-896a75b78188.
                correlation_id: b83fcb8c-8aa6-4c06-ae70-8d247ededb52
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 48f7a66a-bc22-4106-b1b6-39bd46513700
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: df614cda-8e28-454b-a03c-d3537cfa750f
  /v2/company-credit-reports/{request_id}:
    get:
      tags:
      - Company Credit Report
      summary: Retrieve credit report
      description: "### Returns a company credit report.\r\n\r\nThis endpoint returns the full company credit report associated\
        \ with a specific `request_id`.\r\n"
      operationId: GET_v2-company-credit-reports-request_id
      parameters:
      - name: request_id
        in: path
        description: Sikoia ID for the request
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Credit Report
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.CreditReportMappedResponse'
              example:
                request_id: string
                status: string
                company_id: string
                datetime_requested: string
                message: string
                company_number: string
                company_name: string
                country_code: string
                provider_id: string
                data:
                  company_information:
                    company_number: string
                    company_name: string
                    country_code: string
                    status: string
                    date_established: string
                    date_dissolved: string
                    generic_legal_form: string
                    registry_legal_form: string
                    vat_number: string
                    official_address:
                      address_line_1: string
                      address_line_2: string
                      address_line_3: string
                      address_line_4: string
                      city: string
                      region: string
                      country: string
                      post_code: string
                      full_address: string
                  industry_codes:
                  - code: string
                    description: string
                    classification: string
                  credit_rating:
                    international_credit_rating: string
                    international_credit_rating_description: string
                    local_credit_rating: string
                    local_credit_rating_description: string
                    rating_date: string
                    probability_of_default: 0
                    national_percentile: 0
                    credit_limit: 0
                    credit_limit_currency: string
                    credit_rating_history:
                    - international_credit_rating: string
                      international_credit_rating_description: string
                      local_credit_rating: string
                      local_credit_rating_description: string
                      rating_date: string
                    credit_limit_history:
                    - date: string
                      value: string
                      currency: string
                  officers:
                    people:
                    - first_name: string
                      surname: string
                      full_name: string
                      status: string
                      officer_role: string
                      date_appointed: string
                      date_resigned: string
                      date_of_birth: string
                      birth_year: 0
                      birth_month: 0
                      birth_day: 0
                      nationality: string
                      address:
                        address_line_1: string
                        address_line_2: string
                        address_line_3: string
                        address_line_4: string
                        city: string
                        region: string
                        country: string
                        post_code: string
                        full_address: string
                    companies:
                    - name: string
                      status: string
                      officer_role: string
                      date_appointed: string
                      date_resigned: string
                      address:
                        address_line_1: string
                        address_line_2: string
                        address_line_3: string
                        address_line_4: string
                        city: string
                        region: string
                        country: string
                        post_code: string
                        full_address: string
                  owners:
                    people:
                    - first_name: string
                      surname: string
                      full_name: string
                      status: string
                      holding_percentage: 0
                      holding_percentage_band: string
                      voting_percentage: 0
                      voting_percentage_band: string
                      date_appointed: string
                      date_resigned: string
                      date_of_birth: string
                      birth_year: 0
                      birth_month: 0
                      birth_day: 0
                      nationality: string
                      address:
                        address_line_1: string
                        address_line_2: string
                        address_line_3: string
                        address_line_4: string
                        city: string
                        region: string
                        country: string
                        post_code: string
                        full_address: string
                    companies:
                    - name: string
                      status: string
                      holding_percentage: 0
                      holding_percentage_band: string
                      voting_percentage: 0
                      voting_percentage_band: string
                      date_appointed: string
                      date_resigned: string
                      address:
                        address_line_1: string
                        address_line_2: string
                        address_line_3: string
                        address_line_4: string
                        city: string
                        region: string
                        country: string
                        post_code: string
                        full_address: string
                  commentaries:
                  - commentary: string
                    sentiment: string
                  capital_structure:
                    currency: string
                    nominal_capital: 0
                    issued_capital: 0
                    number_of_shares: 0
                    shareholders:
                      people:
                      - first_name: string
                        surname: string
                        full_name: string
                        status: string
                        holding_percentage: 0
                        holding_percentage_band: string
                        voting_percentage: 0
                        voting_percentage_band: string
                        number_of_shares: 0
                        share_value: 0
                        officer_role: string
                        date_appointed: string
                        date_resigned: string
                        date_of_birth: string
                        birth_year: 0
                        birth_month: 0
                        birth_day: 0
                        nationality: string
                        address:
                          address_line_1: string
                          address_line_2: string
                          address_line_3: string
                          address_line_4: string
                          city: string
                          region: string
                          country: string
                          post_code: string
                          full_address: string
                      companies:
                      - name: string
                        status: string
                        holding_percentage: 0
                        holding_percentage_band: string
                        voting_percentage: 0
                        voting_percentage_band: string
                        number_of_shares: 0
                        share_value: 0
                        officer_role: string
                        date_appointed: string
                        date_resigned: string
                        address:
                          address_line_1: string
                          address_line_2: string
                          address_line_3: string
                          address_line_4: string
                          city: string
                          region: string
                          country: string
                          post_code: string
                          full_address: string
                  judgments:
                  - date: string
                    type: string
                    court_name: string
                    amount: 0
                    reference_number: string
                    currency: string
                    status: string
                  bad_debts:
                  - date: string
                    company_number: string
                    company_name: string
                    currency: string
                    amount: 0
                  financial_statements:
                    global_reports:
                    - type: string
                      start_date: string
                      end_date: string
                      number_of_weeks: 0
                      currency: string
                      original_currency: string
                      currency_conversion_rate: 0
                      consolidated_accounts: true
                      amended_accounts: true
                      profit_and_loss:
                        revenue: 0
                        operating_costs: 0
                        operating_profit: 0
                        wages_and_salaries: 0
                        pension_costs: 0
                        depreciation: 0
                        financial_income: 0
                        amortisation: 0
                        financial_expenses: 0
                        extraordinary_income: 0
                        extraordinary_costs: 0
                        profit_before_tax: 0
                        tax: 0
                        profit_after_tax: 0
                        dividends: 0
                        minority_interests: 0
                        other_appropriations: 0
                        retained_profit: 0
                      balance_sheet:
                        land_and_buildings: 0
                        plant_and_machinery: 0
                        other_tangible_assets: 0
                        total_tangible_assets: 0
                        goodwill: 0
                        other_intangible_assets: 0
                        total_intangible_assets: 0
                        investments: 0
                        loans_to_group: 0
                        other_loans: 0
                        miscellaneous_fixed_assets: 0
                        total_other_fixed_assets: 0
                        total_fixed_assets: 0
                        raw_materials: 0
                        work_in_progress: 0
                        finished_goods: 0
                        other_inventories: 0
                        total_inventories: 0
                        trade_receivables: 0
                        group_receivables: 0
                        receivables_due_after_1_year: 0
                        miscellaneous_receivables: 0
                        total_receivables: 0
                        cash: 0
                        other_current_assets: 0
                        total_current_assets: 0
                        total_assets: 0
                        trade_payables: 0
                        bank_liabilities: 0
                        other_loans_or_finance: 0
                        group_payables: 0
                        miscellaneous_liabilities: 0
                        total_current_liabilities: 0
                        trade_payables_due_after_1_year: 0
                        bank_liabilities_due_after_1_year: 0
                        other_loans_or_finance_due_after_1_year: 0
                        group_payables_due_after_1_year: 0
                        miscellaneous_liabilities_due_after_1_year: 0
                        total_long_term_liabilities: 0
                        total_liabilities: 0
                        called_up_share_capital: 0
                        share_premium: 0
                        revenue_reserves: 0
                        other_reserves: 0
                        total_shareholders_equity: 0
                      other_financials:
                        contingent_liabilities: string
                        working_capital: 0
                        net_worth: 0
                      ratios:
                        pre_tax_profit_margin: 0
                        return_on_capital_employed: 0
                        return_on_total_assets_employed: 0
                        return_on_net_assets_employed: 0
                        sales_or_net_working_capital: 0
                        stock_turnover_ratio: 0
                        debtor_days: 0
                        creditor_days: 0
                        current_ratio: 0
                        liquidity_ratio_or_acid_test: 0
                        current_debt_ratio: 0
                        gearing: 0
                        equity_in_percentage: 0
                        total_debt_ratio: 0
                picklist:
                - index: 0
                  company_number: '12345678'
                  company_name: Acme Inc
                  country_code: GB
                  provider_id: ABC123
                  status: Active
                  branch: 'true'
                  official_address:
                    address_line_1: string
                    address_line_2: string
                    address_line_3: string
                    address_line_4: string
                    city: string
                    region: string
                    country: string
                    post_code: string
                    full_address: string
                  vat_number:
                  - string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 723292a4-eba8-4a9d-be06-40a3d4af4879
        '404':
          description: Request ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id ab5eeeb6-86de-4660-a047-2dcee7b84ab1.
                correlation_id: 5a9d3e82-815a-463c-8d11-067391d04ddf
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 09d3ec65-fdd3-4211-b907-2198ab8a4271
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 0f0645e2-14c0-428e-8184-72fe8b749fe9
  /v2/company-credit-reports/picklist:
    post:
      tags:
      - Company Credit Report
      summary: Resolve credit report picklist
      description: "### Resolves a company credit report picklist.\r\n\r\nTo resolve a picklist, send the original `request_id`\
        \ and the `picklist_index` to this endpoint.\r\n\r\nThis will create a new entry in the list of Credit Report requests\
        \ for the company entity.\r\n\r\nYou can retrieve a list of all credit report requests for a company using the `GET\
        \ /v2/companies/{company_id}/credit-reports` endpoint.\r\n"
      operationId: POST_v2-company-credit-reports-picklist
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Request.ResolvePicklistRequest'
            example:
              request_id: 9133edc8-6ac5-45ee-827a-fa717c90d47b
              picklist_index: '1'
      responses:
        '201':
          description: Picklist Resolved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.CreditReportResponse'
              example:
                request_id: cfed4c7f-37e8-4657-b185-7cf572d0b019
                status: Complete
                company_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                datetime_requested: '2024-02-12T14:50:10.3830000+00:00'
                message: string
                company_number: '12345678'
                company_name: Acme Inc
                country_code: GB
                provider_id: string
                picklist: '[]'
        '400':
          description: Company Entity Deleted/Not Found or Request Did Not Produce Picklist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: 2917b7ff-11b8-4ba7-93f4-aeb48533e3ea
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 6cd3b4a8-bc37-444b-9078-d08005ea72a2
        '403':
          description: Insufficient Credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InsufficientPermissions
                status: 403
                title: Service not enabled
                detail: Service is not currently enabled.
                correlation_id: 1157375d-bf43-4ebb-9ef5-2b3b89cf4475
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 915d46fa-011c-4057-b7b0-a3f5c7177763
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 4eaab818-a226-4300-bccb-ce2a380d7179
  /v2/openbanking:
    post:
      tags:
      - Banking
      summary: Create Open Banking connection
      description: "### Creates a new Open Banking connection request.\r\n\r\nThis generates a URL that takes your end customer\
        \ through a consent flow to connect their accounts.\r\n\r\nThe `country_code` is optional.  If it is included then\
        \ your end customer will only be able to select a bank institution from that country.\r\n"
      operationId: POST_v2-openbanking
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.CreateTokenRequest'
            example:
              entity_id: 78662640-73fc-4fa9-8367-ef4660d35cee
              entity_type: company
              country_code: GB
      responses:
        '201':
          description: The Token Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.CreateTokenResponse'
              example:
                bank_connection_id: e81154bd-f85f-4223-8b4f-36643843fa99
                bank_connection_url: https://verify.sikoia.com/openbanking/123456
                entity_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                entity_type: company
                datetime_requested: '2024-02-12T04:21:07.0000000+00:00'
                datetime_refreshed: '2024-02-11T04:21:07.0000000+00:00'
                datetime_connected: '2024-02-14T04:21:07.0000000+00:00'
                datetime_expiry: '2024-05-12T04:24:34.0000000+00:00'
                status: Connected
                country_code: GB
                institution_name: Sandbox
                institution_logo: https://logolink.com
                account_connection_ids: '["820eec09-dbdd-4c90-b0f2-acbca66f1ad5", "132d3353-ad29-46e0-b66a-caed8b572e93",
                  "93886787-3307-4319-afa7-48540bf21362"]'
                source: Document
                document_id: r51154bd-f85f-4223-8b4f-36643843fa33
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: 26adafd9-9c08-4ec2-8532-251f771630ef
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: b747b03f-caaf-42f8-b04b-2d4427f2dbec
        '404':
          description: Entity ID or Type Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id f6566eff-e7de-4437-afec-754d6842d1e0.
                correlation_id: 7b3e3dee-48ad-426b-9b60-1f744fa73006
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 6fc274ac-f322-48a8-8acb-b276b5beafab
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: b988cbda-f68a-4d49-b14d-2ca90810b0e3
  /v2/openbanking/{bank_connection_id}:
    get:
      tags:
      - Banking
      summary: Retrieve Open Banking connection status
      description: "### Returns an Open Banking connection status.\r\n\r\nThis endpoint returns the status of the Open Banking\
        \ connection, revealing the state of the end customer consent flow.\r\n\r\nIt will also return a list of connected\
        \ accounts once the connection has been successfully established.\r\n"
      operationId: GET_v2-openbanking-bank_connection_id
      parameters:
      - name: bank_connection_id
        in: path
        description: Bank Connection Id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Retrieved Open Banking Connection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.CreateTokenResponse'
              example:
                bank_connection_id: e81154bd-f85f-4223-8b4f-36643843fa99
                bank_connection_url: https://verify.sikoia.com/openbanking/123456
                entity_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                entity_type: company
                datetime_requested: '2024-02-12T04:21:07.0000000+00:00'
                datetime_refreshed: '2024-02-11T04:21:07.0000000+00:00'
                datetime_connected: '2024-02-14T04:21:07.0000000+00:00'
                datetime_expiry: '2024-05-12T04:24:34.0000000+00:00'
                status: Connected
                country_code: GB
                institution_name: Sandbox
                institution_logo: https://logolink.com
                account_connection_ids: '["820eec09-dbdd-4c90-b0f2-acbca66f1ad5", "132d3353-ad29-46e0-b66a-caed8b572e93",
                  "93886787-3307-4319-afa7-48540bf21362"]'
                source: Document
                document_id: r51154bd-f85f-4223-8b4f-36643843fa33
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: dba18918-728e-4547-af42-8dc770613c0c
        '404':
          description: Bank Connection ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 0e4a8ab3-2d28-411a-acd8-55106076bda2.
                correlation_id: 5b68753e-ee86-4ba2-ac94-1ab5c58342a1
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 2e7f1bec-f9b0-40be-887c-610b06c9a3e2
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: f8b87f95-c0be-4ad3-bf02-bd3e36d1aa32
    delete:
      tags:
      - Banking
      summary: Delete an Open Banking connection
      description: "### Deletes an existing Open Banking connection\r\n\r\nThis also deletes all of the associated account,\
        \ balance, and transaction data for the Open Banking connection.\r\n\r\nPlease note that this action cannot be undone.\r\
        \n"
      operationId: DELETE_v2-openbanking-bank_connection_id
      parameters:
      - name: bank_connection_id
        in: path
        description: Bank Connection Id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successfully Deleted Open Banking connection
        '400':
          description: Open Banking connection Deleted/Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: 45be1c62-2c31-4809-9ab7-68ffbfc05009
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 1b324e61-e778-479a-8172-a184a4555587
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 1be35715-d9ad-48f9-8683-c14ccba45e19
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 25741886-17c7-49c6-ba07-c7e73cd4c01e
  /v2/{entity_type}/{entity_id}/openbanking:
    get:
      tags:
      - Banking
      summary: List all Open Banking connections
      description: "### Returns a list of all open banking connections requested for an entity.\r\n\r\nThis list includes\
        \ `bank_connection_id` and associated `account_connection_id`, which can be used to retrieve more detailed account\
        \ data.\r\n\r\nInclude the query parameter completed with a value of `true` if you only want to retrieve completed\
        \ connections.\r\n"
      operationId: GET_v2-entity_type-entity_id-openbanking
      parameters:
      - name: entity_type
        in: path
        description: Entity Type
        required: true
        schema:
          enum:
          - Companies
          - Persons
          - Cases
          type: string
      - name: entity_id
        in: path
        description: Entity ID
        required: true
        schema:
          type: string
      - name: completed
        in: query
        description: Return complete/incomplete/all OB Connections
        schema:
          type: boolean
      responses:
        '200':
          description: List of Open Banking Connections
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.CreateTokenResponse'
              example:
              - bank_connection_id: e81154bd-f85f-4223-8b4f-36643843fa99
                bank_connection_url: https://verify.sikoia.com/openbanking/123456
                entity_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                entity_type: company
                datetime_requested: '2024-02-12T04:21:07.0000000+00:00'
                datetime_refreshed: '2024-02-11T04:21:07.0000000+00:00'
                datetime_connected: '2024-02-14T04:21:07.0000000+00:00'
                datetime_expiry: '2024-05-12T04:24:34.0000000+00:00'
                status: Connected
                country_code: GB
                institution_name: Sandbox
                institution_logo: https://logolink.com
                account_connection_ids: '["820eec09-dbdd-4c90-b0f2-acbca66f1ad5", "132d3353-ad29-46e0-b66a-caed8b572e93",
                  "93886787-3307-4319-afa7-48540bf21362"]'
                source: Document
                document_id: r51154bd-f85f-4223-8b4f-36643843fa33
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 9ea93a05-8486-4ea4-b326-7155d11e3696
        '404':
          description: Entity ID or Type Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 875a09f4-0ef7-4026-a839-77b54f941166.
                correlation_id: aa910e9b-fb08-4faa-9b49-7f0ad79a1f6f
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 27b878d6-acca-49a7-a638-d83a07b870e5
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 3ade176a-f5e5-4566-9281-1bba5f022f6c
  /v2/bankaccounts/{account_connection_id}:
    get:
      tags:
      - Banking
      summary: Retrieve account details
      description: "### Returns detailed account data.\r\n\r\nFetches the account details for a specific `account_connection_id`\
        \ covering accounts connected through open banking or those for which bank statements have been uploaded.\r\n"
      operationId: GET_v2-bankaccounts-account_connection_id
      parameters:
      - name: account_connection_id
        in: path
        description: Account Connection Id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Account Details Retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.GetAccountDetailsResponse'
              example:
                account_connection_id: 132d3353-ad29-46e0-b66a-caed8b572e93
                account_type: CREDIT_CARD
                status: Connected
                currency: GBP
                owners_name: '["Acme Inc"]'
                identifications:
                - type: SORT_CODE
                  value: '100001'
                bank_connection_id: e81154bd-f85f-4223-8b4f-36643843fa99
                datetime_last_refreshed: '2024-02-12T04:28:00.0000000+00:00'
                datetime_connected: '2024-02-12T04:24:50.0000000+00:00'
                datetime_expiry: '2024-05-12T04:24:34.0000000+00:00'
                country_code: GB
                institution_logo: https://logolink.com
                institution_name: Sandbox
                source: Document
                document_id: r51154bd-f85f-4223-8b4f-36643843fa33
                data_source_id: 01951375-a680-77ce-b196-44d1feedc47c
                full_address: Flat 23, 49 Sample Street, London
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: df6a0d9a-046f-47e7-8a78-ee91ba629e13
        '404':
          description: Account Connection ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 616ee00a-fbd6-4706-ba79-e7be3a71837a.
                correlation_id: 731be44f-376b-4be0-ba1e-c794de930d41
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: d94609b6-a46b-47fa-b4fd-ebf265991a96
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: f8687c0d-2c03-4737-aa3e-3d74c15b27ff
  /v2/{entity_type}/{entity_id}/bankaccounts:
    get:
      tags:
      - Banking
      summary: List all accounts
      description: "### Returns a list of all bank accounts for an entity.\r\n\r\nProvides a comprehensive list of all bank\
        \ accounts associated with an entity. This includes accounts connected through open banking or for which bank statements\
        \ have been uploaded.\r\n\r\nThis list includes the account_connection_id for each account, which can be used to retrieve\
        \ more detailed data from the following endpoints:\r\n*`GET /v2/bankaccounts/{account_connection_id}`\r\n*`GET /v2/bankaccounts/{account_connection_id}/balances`\r\
        \n*`GET /v2/bankaccounts/{account_connection_id}/transactions`\r\n"
      operationId: GET_v2-entity_type-entity_id-bankaccounts
      parameters:
      - name: entity_type
        in: path
        description: Entity Type
        required: true
        schema:
          enum:
          - Companies
          - Persons
          - Cases
          type: string
      - name: entity_id
        in: path
        description: Entity ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of Accounts Retrieved
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.GetAccountDetailsResponse'
              example:
              - account_connection_id: 132d3353-ad29-46e0-b66a-caed8b572e93
                account_type: CREDIT_CARD
                status: Connected
                currency: GBP
                owners_name: '["Acme Inc"]'
                identifications:
                - type: SORT_CODE
                  value: '100001'
                bank_connection_id: e81154bd-f85f-4223-8b4f-36643843fa99
                datetime_last_refreshed: '2024-02-12T04:28:00.0000000+00:00'
                datetime_connected: '2024-02-12T04:24:50.0000000+00:00'
                datetime_expiry: '2024-05-12T04:24:34.0000000+00:00'
                country_code: GB
                institution_logo: https://logolink.com
                institution_name: Sandbox
                source: Document
                document_id: r51154bd-f85f-4223-8b4f-36643843fa33
                data_source_id: 01951375-a680-77ce-b196-44d1feedc47c
                full_address: Flat 23, 49 Sample Street, London
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: b89a5490-4bf4-4aba-984d-3b39b1580c9e
        '404':
          description: Entity ID or Entity Type Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 48a668b7-0d22-4924-aa4f-a30d6363963f.
                correlation_id: fcdd14a2-79a0-4f9b-bb3a-8f87eb54fbde
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 39deb474-0600-4a03-b763-153ea6b6f75a
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 21234e98-6397-456d-9691-6dfe688aabcf
  /v2/bankaccounts/{account_connection_id}/balances:
    get:
      tags:
      - Banking
      summary: Retrieve account balances
      description: "### Returns bank account balances.\r\n\r\nFetches the account balance details for a specific `account_connection_id`\
        \ covering accounts connected through open banking or those for which bank statements have been uploaded.\r\n"
      operationId: GET_v2-bankaccounts-account_connection_id-balances
      parameters:
      - name: account_connection_id
        in: path
        description: Account Connection Id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Account Balances Retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.AccountBalancesResponse'
              example:
                account_connection_id: 132d3353-ad29-46e0-b66a-caed8b572e93
                balances:
                - type: CLOSING_AVAILABLE
                  amount:
                    value: '1528-08-01'
                    currency: USD
                  date: '2024-02-12T16:24:50.1490000+00:00'
                datetime_refreshed: '2024-02-12T04:25:09.0000000+00:00'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 35e72111-9c05-4843-8f37-13c56ece25b6
        '404':
          description: Account Connection ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id fccb194f-5c85-4f6c-8548-ec58106ac3c1.
                correlation_id: 3e4e883a-7b12-4500-b62a-66cf9f0aee33
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 50794c6f-cc99-4bbc-9c8e-4b9649e84f96
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 89deb46e-1126-4bbd-888f-3179d329d467
  /v2/bankaccounts/{account_connection_id}/transactions:
    get:
      tags:
      - Banking
      summary: Retrieve account transactions
      description: "### Returns detailed bank account transaction data.\r\n\r\nFetches a list off all available transactions\
        \ for a specific `account_connection_id` covering accounts connected through open banking or those for which bank\
        \ statements have been uploaded.\r\n"
      operationId: GET_v2-bankaccounts-account_connection_id-transactions
      parameters:
      - name: account_connection_id
        in: path
        description: Account Connection Id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Account Balances Retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.AccountTransactionsResponse'
              example:
                account_connection_id: 132d3353-ad29-46e0-b66a-caed8b572e93
                transactions:
                - transaction_id: 0730deba-767a-4c40-bc89-ac7c96e5a1c9
                  date: '2024-02-12T02:57:24.0000000+00:00'
                  booking_datetime: '2024-02-12T02:57:24.0000000+00:00'
                  value_date_time: '2024-02-12T02:57:24.0000000+00:00'
                  status: PENDING
                  amount:
                    amount: '-1.1'
                    currency: GBP
                  currency: GBP
                  reference: Acme123Ltd
                  description: 1B8BAA320D3E4BFAB8B32495157B3604
                  merchant:
                    merchant_name: string
                    merchant_category: string
                  iso_bank_transaction_code:
                    domain_code:
                      code: PMNT
                      name: Payments
                    family_code:
                      code: PMNT
                      name: Payments
                    sub_family_code:
                      code: PMNT
                      name: Payments
                  proprietary_bank_transaction_code:
                    code: open-banking-sip-Debit
                    issuer: ozone
                datetime_refreshed: '2024-02-12T03:34:25.0000000+00:00'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 6afe5488-dfa0-4fee-803f-ce31b471ce17
        '404':
          description: Account Connection ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 3db67787-8bb1-42b2-bab2-19cc165a558c.
                correlation_id: 2554038b-b911-4263-8064-07a86ba471a6
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 3c4294c9-6a34-46be-9e6b-ac3344066caa
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 44e146ba-a608-4f4c-84f9-a8c16f1ade42
  /v2/bankaccounts/{account_connection_id}/refresh:
    post:
      tags:
      - Banking
      summary: Refresh an account
      description: "### Initiates a refresh of account data.\r\n\r\nTriggers an asynchronous refresh of the account details,\
        \ balances and transactions for a specific Open Banking `account_connection_id`.\r\n"
      operationId: POST_v2-bankaccounts-account_connection_id-refresh
      parameters:
      - name: account_connection_id
        in: path
        description: Account Connection Id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Account Details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.GetAccountDetailsResponse'
              example:
                account_connection_id: 132d3353-ad29-46e0-b66a-caed8b572e93
                account_type: CREDIT_CARD
                status: Connected
                currency: GBP
                owners_name: '["Acme Inc"]'
                identifications:
                - type: SORT_CODE
                  value: '100001'
                bank_connection_id: e81154bd-f85f-4223-8b4f-36643843fa99
                datetime_last_refreshed: '2024-02-12T04:28:00.0000000+00:00'
                datetime_connected: '2024-02-12T04:24:50.0000000+00:00'
                datetime_expiry: '2024-05-12T04:24:34.0000000+00:00'
                country_code: GB
                institution_logo: https://logolink.com
                institution_name: Sandbox
                source: Document
                document_id: r51154bd-f85f-4223-8b4f-36643843fa33
                data_source_id: 01951375-a680-77ce-b196-44d1feedc47c
                full_address: Flat 23, 49 Sample Street, London
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 8eeb9a0a-aab1-4a4e-90d2-55926ace8173
        '404':
          description: Account Connection ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 540ab31b-4c1d-4ea3-9716-20e8a6532db6.
                correlation_id: a95eb858-dfa7-4a43-bc71-cde0e20c6b7b
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 8cad8ef5-550f-4771-a3d8-728505d9265a
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: f2fb27ba-a132-4f4d-bde7-499849c6dba2
  /v2/peps-sanctions:
    post:
      tags:
      - PEPs & Sanctions
      summary: Request PEPs & Sanctions search
      description: "### Requests a PEPs & Sanctions search for an entity.\r\n\r\nCheck if the entity is listed in any Politically\
        \ Exposed Persons (PEPs) or Sanctions lists.\r\n\r\n* If the `entity_type` is case, a `search_term` must be included.\r\
        \n* If the `entity_type` is person or company, the search term is taken from the name on the entity. If the `search_term`\
        \ is included, the entity data is overridden.\r\n* If `entity_type` is person, providing a `birth_date` enhances search\
        \ accuracy.\r\n* Adjust the `fuzziness` level (ranging from 0-1) to control spelling variations. Lower levels yield\
        \ fewer variations, while higher levels increase flexibility.\r\n\r\nThis endpoint returns the number of matches the\
        \ entity has. For detailed match information, refer to the Sikoia Dashboard.\r\n"
      operationId: POST_v2-peps-sanctions
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.ComplyAdvantage.AntiMoneyLaunderingRequest'
            example:
              search_term: Acme Inc
              entity_type: company
              entity_id: 78662640-73fc-4fa9-8367-ef4660d35cee
              birth_date: string
              monitored: 'true'
              fuzziness: '0.2'
      responses:
        '201':
          description: PEPs & Sanctions Search
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.ComplyAdvantage.AntiMoneyLaunderingResponse'
              example:
                request_id: e6b1b4d6-d5cf-426e-a4dc-d9c0264299df
                search_ref: 1729289992-b91nmEFh
                status: Complete
                entity_type: company
                entity_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                search_term: Acme Inc
                birthdate: '1950-08-08'
                monitored: 'true'
                datetime_requested: '2024-02-12T16:02:06.9000000+00:00'
                total_matches: '9'
                search_certificate_uri: https://sikoialake.blob.core.windows.net/sikoia/complyadvantagecertificate/01929b28-c39d-739e-beb8-6ceda5136d24.pdf?sv=2021-08-06&se=2024-10-17T15%3A56%3A33Z&sr=b&sp=r&sig=4E4X3hxHkpVvCS2pJvBVxGM6MvHcgpdZryC%2BpJmNRHE%3D
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: a83b5de5-68f0-4e96-a254-8a8a1392ed8b
        '404':
          description: Details Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 2cd278b5-eb0d-4813-82ee-1755bfbaaa26.
                correlation_id: f574a91c-1ee3-47bb-afaf-0cbdd957d666
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 6c1018af-58c0-4bd5-a8b3-723237c8cf05
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 5c1b6b40-2c45-4bfd-9384-d487cdab5f16
  /v2/{entity_type}/{entity_id}/peps-sanctions:
    get:
      tags:
      - PEPs & Sanctions
      summary: List all PEPs & Sanctions searches
      description: "### Returns a list of all PEPs & Sanctions searches for an entity.\r\n\r\nThe response returns the number\
        \ of matches returned in each search.\r\nFor detailed match information, refer to the Sikoia Dashboard.\r\n"
      operationId: GET_v2-entity_type-entity_id-peps-sanctions
      parameters:
      - name: entity_type
        in: path
        description: The type of entity (company, person, case)
        required: true
        schema:
          enum:
          - Companies
          - Persons
          - Cases
          type: string
      - name: entity_id
        in: path
        description: The company_id, person_id or case_id of the entity
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Adverse Media Retrieved
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.ComplyAdvantage.AntiMoneyLaunderingResponse'
              example:
              - request_id: e6b1b4d6-d5cf-426e-a4dc-d9c0264299df
                search_ref: 1729289992-b91nmEFh
                status: Complete
                entity_type: company
                entity_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                search_term: Acme Inc
                birthdate: '1950-08-08'
                monitored: 'true'
                datetime_requested: '2024-02-12T16:02:06.9000000+00:00'
                total_matches: '9'
                search_certificate_uri: https://sikoialake.blob.core.windows.net/sikoia/complyadvantagecertificate/01929b28-c39d-739e-beb8-6ceda5136d24.pdf?sv=2021-08-06&se=2024-10-17T15%3A56%3A33Z&sr=b&sp=r&sig=4E4X3hxHkpVvCS2pJvBVxGM6MvHcgpdZryC%2BpJmNRHE%3D
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 584f3e31-8319-4ca8-8fed-659a59e34cee
        '404':
          description: Entity Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 06ed4634-9775-4c59-8fbf-326f1729ce2d.
                correlation_id: 5089355a-3b89-490f-8143-8efedce5c609
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: ca604701-282d-42a1-a684-fb4cfb6a8f70
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: a00d2b49-2fc3-43f8-9e42-d1fddb76a52b
  /v2/adverse-media:
    post:
      tags:
      - Adverse Media
      summary: Request Adverse Media search
      description: "### Requests an Adverse Media search for an entity.\r\n\r\nCheck if the entity has any potential Adverse\
        \ Media results.\r\n\r\n* If the `entity_type` is case, a search_term must be included.\r\n* If the `entity_type`\
        \ is person or company, the search term is taken from the name on the entity. If the `search_term` is included, the\
        \ entity data is overridden.\r\n* If `entity_type` is person, providing a `birth_date` enhances search accuracy.\r\
        \n* Adjust the `fuzziness` level (ranging from 0-1) to control spelling variations. Lower levels yield fewer variations,\
        \ while higher levels increase flexibility.\r\n\r\nThis endpoint returns the number of matches the entity has. For\
        \ detailed match information, refer to the Sikoia Dashboard.\r\n"
      operationId: POST_v2-adverse-media
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.ComplyAdvantage.AntiMoneyLaunderingRequest'
            example:
              search_term: Acme Inc
              entity_type: company
              entity_id: 78662640-73fc-4fa9-8367-ef4660d35cee
              birth_date: string
              monitored: 'true'
              fuzziness: '0.2'
      responses:
        '200':
          description: Adverse Media Search
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.ComplyAdvantage.AntiMoneyLaunderingResponse'
              example:
                request_id: e6b1b4d6-d5cf-426e-a4dc-d9c0264299df
                search_ref: 1729289992-b91nmEFh
                status: Complete
                entity_type: company
                entity_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                search_term: Acme Inc
                birthdate: '1950-08-08'
                monitored: 'true'
                datetime_requested: '2024-02-12T16:02:06.9000000+00:00'
                total_matches: '9'
                search_certificate_uri: https://sikoialake.blob.core.windows.net/sikoia/complyadvantagecertificate/01929b28-c39d-739e-beb8-6ceda5136d24.pdf?sv=2021-08-06&se=2024-10-17T15%3A56%3A33Z&sr=b&sp=r&sig=4E4X3hxHkpVvCS2pJvBVxGM6MvHcgpdZryC%2BpJmNRHE%3D
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: ce61d563-9353-4407-9f79-a71ca508566b
        '404':
          description: Details Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id a313ba4f-e1c3-4430-929c-7ed126c7de95.
                correlation_id: 5bafbbd7-b21c-4085-8b2a-1b7df04c1469
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: d789669a-aae9-4818-89c8-ee4a1d0de7c7
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 55bad154-b9e5-4f65-8ece-a3afebb52156
  /v2/{entity_type}/{entity_id}/adverse-media:
    get:
      tags:
      - Adverse Media
      summary: List all Adverse Media searches
      description: "### Returns a list of all Adverse Media searches for an entity.\r\n\r\nThe response returns the number\
        \ of matches returned in each search.\r\nFor detailed match information, refer to the Sikoia Dashboard.\r\n"
      operationId: GET_v2-entity_type-entity_id-adverse-media
      parameters:
      - name: entity_type
        in: path
        description: The type of entity (company, person, case)
        required: true
        schema:
          enum:
          - Companies
          - Persons
          - Cases
          type: string
      - name: entity_id
        in: path
        description: The company_id, person_id or case_id of the entity
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Adverse Media Retrieved
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.ComplyAdvantage.AntiMoneyLaunderingResponse'
              example:
              - request_id: e6b1b4d6-d5cf-426e-a4dc-d9c0264299df
                search_ref: 1729289992-b91nmEFh
                status: Complete
                entity_type: company
                entity_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                search_term: Acme Inc
                birthdate: '1950-08-08'
                monitored: 'true'
                datetime_requested: '2024-02-12T16:02:06.9000000+00:00'
                total_matches: '9'
                search_certificate_uri: https://sikoialake.blob.core.windows.net/sikoia/complyadvantagecertificate/01929b28-c39d-739e-beb8-6ceda5136d24.pdf?sv=2021-08-06&se=2024-10-17T15%3A56%3A33Z&sr=b&sp=r&sig=4E4X3hxHkpVvCS2pJvBVxGM6MvHcgpdZryC%2BpJmNRHE%3D
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: f404c0a1-9e56-4739-a319-51628962f37f
        '404':
          description: Entity Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 6f7b9161-2a30-49a1-aa53-3d804f4cfda9.
                correlation_id: 630ff69e-fd74-4b0f-8bb0-9c1e5ca38956
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 168b11b5-5c00-4dbc-9d3c-804bde7aada7
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 9f55622c-e244-41c0-85d1-c2e47de56259
  /v2/documents:
    post:
      tags:
      - Documents
      summary: Upload a document to an entity
      description: "### Uploads a document to a `case`, `person`, or `company`.\r\n\r\nThe document must be base64 encoded\
        \ and included as a string in the file field.\r\n\r\nEnsure that the `file_name` field includes the file extension.\r\
        \n"
      operationId: POST_v2-documents
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.DocumentUpload.Request.DocumentUploadRequest'
            example:
              entity_id: 3f615611-3dc3-418b-bed5-a53c4390c97c
              entity_type: person
              file: c29tZSBlbmNvZGVkIGRhdGE=
              document_type: BankStatement
              display_name: January 2023 Bank Statement
              file_name: January-2023-Bank-Statement.pdf
      responses:
        '201':
          description: Document
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.DocumentUpload.Response.DocumentUploadResponse'
              example:
                document_id: 181eba57-b6b4-4288-8c97-f8299530f071
                document_uri: https://sikoialake.blob.core.windows.net/clientid/documents/181eba57-b6b4-4288-8c97-f8299530f071.pdf?sv=2021-08-06&st=2023-05-26T14%3A49%3A36Z&se=2023-05-26T14%3A59%3A36Z&sr=b&sp=r&sig=lMhD8hOX0USZid8RpkYGDZr3DQ8ouN6PDCXM1cRNI3w%3D
                entity_type: company
                entity_id: 3f615611-3dc3-418b-bed5-a53c4390c97c
                file_type: .pdf
                display_name: January 2023 Bank Statement
                document_type: BankStatement
                sikoia_document_type: BankStatement
                file_name: January-2023-Bank-Statement.pdf
                status: Complete
                datetime_created: '2023-02-10T10:59:46.0260000+00:00'
                date_created: string
                datetime_last_modified: '2023-02-10T10:59:46.0260000+00:00'
                date_uploaded: string
        '400':
          description: Entity deleted/not found or invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: b10650aa-a046-4a93-9071-1815a8c9a0c4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 42629208-38a2-47ec-a270-bb4cfb848345
        '403':
          description: Document upload not enabled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InsufficientPermissions
                status: 403
                title: Service not enabled
                detail: Service is not currently enabled.
                correlation_id: 5383963d-002b-4e5c-8316-af455da386dc
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: ca297a48-0486-4087-abcc-a4b91eed7186
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 81ca7064-baa8-4ccb-ab5b-827a345c455e
  /v2/documents/{document_id}:
    get:
      tags:
      - Documents
      summary: Retrieve a document
      description: "### Returns a document.\r\n\r\nThe document is returned as a short lived URI.\r\n"
      operationId: GET_v2-documents-document_id
      parameters:
      - name: document_id
        in: path
        description: Sikoia ID for the document
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Document
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.DocumentUpload.Response.DocumentUploadResponse'
              example:
                document_id: 181eba57-b6b4-4288-8c97-f8299530f071
                document_uri: https://sikoialake.blob.core.windows.net/clientid/documents/181eba57-b6b4-4288-8c97-f8299530f071.pdf?sv=2021-08-06&st=2023-05-26T14%3A49%3A36Z&se=2023-05-26T14%3A59%3A36Z&sr=b&sp=r&sig=lMhD8hOX0USZid8RpkYGDZr3DQ8ouN6PDCXM1cRNI3w%3D
                entity_type: company
                entity_id: 3f615611-3dc3-418b-bed5-a53c4390c97c
                file_type: .pdf
                display_name: January 2023 Bank Statement
                document_type: BankStatement
                sikoia_document_type: BankStatement
                file_name: January-2023-Bank-Statement.pdf
                status: Complete
                datetime_created: '2023-02-10T10:59:46.0260000+00:00'
                date_created: string
                datetime_last_modified: '2023-02-10T10:59:46.0260000+00:00'
                date_uploaded: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 77e69b59-543c-49e5-9e1f-9887e036f6fd
        '404':
          description: Document deleted/not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id b1e9a05d-084d-490d-95fa-db7dd47357b1.
                correlation_id: 5b7d829a-0e95-4549-b98a-93f33bbe2d96
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 4802da9c-d792-4329-9544-c69e9a8f6ae1
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: bb95deb0-efaa-4dd9-a5a5-849869378061
    delete:
      tags:
      - Documents
      summary: Delete a document
      description: "### Deletes a document.\r\n\r\nPlease note that this action cannot be undone.\r\n"
      operationId: DELETE_v2-documents-document_id
      parameters:
      - name: document_id
        in: path
        description: Sikoia ID for the document
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 833691de-e857-486e-b1e9-50be38c5eb86
        '404':
          description: Document deleted/not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 03d85f8b-041e-4634-b4a5-72cb97cd0e5a.
                correlation_id: 78438c9f-245a-4234-bd5d-9c89651b7198
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: b78bab89-e879-4f5c-92ef-a65bdfe4917e
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: affb7a0c-6686-415e-83cc-8faf9329be29
  /v2/{entity_type}/{entity_id}/documents:
    get:
      tags:
      - Documents
      summary: List all documents for an entity
      description: "### Returns a list of documents for an entity.\r\n\r\nThe list includes the `document_id` for each document,\
        \ which can be used to retrieve or delete the file using the following endpoints:\r\n*`GET /v2/documents/{document_id}`\r\
        \n*`DELETE /v2/documents/{document_id}`\r\n"
      operationId: GET_v2-entity_type-entity_id-documents
      parameters:
      - name: entity_type
        in: path
        description: The type of entity (company, person, case)
        required: true
        schema:
          enum:
          - Companies
          - Persons
          - Cases
          type: string
      - name: entity_id
        in: path
        description: The company_id, person_id or case_id of the entity
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Documents
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.DocumentUpload.Response.DocumentUploadResponse'
              example:
              - document_id: 181eba57-b6b4-4288-8c97-f8299530f071
                document_uri: https://sikoialake.blob.core.windows.net/clientid/documents/181eba57-b6b4-4288-8c97-f8299530f071.pdf?sv=2021-08-06&st=2023-05-26T14%3A49%3A36Z&se=2023-05-26T14%3A59%3A36Z&sr=b&sp=r&sig=lMhD8hOX0USZid8RpkYGDZr3DQ8ouN6PDCXM1cRNI3w%3D
                entity_type: company
                entity_id: 3f615611-3dc3-418b-bed5-a53c4390c97c
                file_type: .pdf
                display_name: January 2023 Bank Statement
                document_type: BankStatement
                sikoia_document_type: BankStatement
                file_name: January-2023-Bank-Statement.pdf
                status: Complete
                datetime_created: '2023-02-10T10:59:46.0260000+00:00'
                date_created: string
                datetime_last_modified: '2023-02-10T10:59:46.0260000+00:00'
                date_uploaded: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 27649ad7-ea2d-497b-a4d6-869971d85043
        '404':
          description: Entity deleted/not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id c14abbe4-81c4-42f9-ba49-3bee5171876c.
                correlation_id: 13df5e64-ef33-4137-867b-bb758556aa0e
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 1e1509b5-8a1a-46dd-82d9-bfc8e9df9e75
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: cfa81e92-8d77-4573-858a-e5baa905c35a
  /v2/{entity_type}/{entity_id}/integrity-checks:
    get:
      tags:
      - Documents
      summary: List all integrity checklist requests
      description: "### List all integrity checklist requests.\r\n\r\nReturns a list of all integrity checklists requested\
        \ for an entity.\r\n\r\nThe list includes the document_id for each request, which can be used to retrieve the integrity\
        \ check rules result using the GET `/v2/documents/{document_id}/integrity-checks` endpoint.\r\n"
      operationId: GET_v2-entity_type-entity_id-integrity-checks
      parameters:
      - name: entity_type
        in: path
        description: Entity Type
        required: true
        schema:
          enum:
          - Companies
          - Persons
          - Cases
          type: string
      - name: entity_id
        in: path
        description: Entity ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Integrity Check Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.EventProcessor.Checklist.Response.IntegrityCheckRequestListResponse'
              example:
                entity_id: 3345857d-fa2b-43ab-8b15-67e5fea8e896
                entity_type: case
                integrity_check_requests:
                - integrity_type_id: a9d3f2b1-4c76-4a9b-8e1d-5f3a7c6e9d4b
                  document_id: 1f7a9d27-fa27-4e15-aefd-9b5a5e32f4c1
                  status: Complete
                  datetime_requested: '2024-01-29T12:21:52.9330000+00:00'
                  datetime_completed: '2024-01-30T09:44:22.4660000+00:00'
                  message: Integrity Check complete
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: ae8211c8-105e-42bd-b171-f4463ddab871
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id f9bb5b1c-4beb-4333-8199-6f41cd46e4df.
                correlation_id: 04837ba7-371e-4e07-b002-4e57293f1f56
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 962bff24-d810-42eb-89e1-a934f0ccd98d
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 138048c4-2fe3-435d-8ced-5ad9e968a894
  /v2/documents/{document_id}/integrity-checks:
    get:
      tags:
      - Documents
      summary: Retrieve integrity checklist result
      description: "### Returns an instance of a integrity checklist.\r\n\r\nThis endpoint returns the integrity check results\
        \ associated with a specific `document_id`.\r\n"
      operationId: GET_v2-documents-document_id-integrity-checks
      parameters:
      - name: document_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Integrity Check
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.EventProcessor.Checklist.Response.IntegrityCheckInstanceResponse'
              example:
                integrity_type_id: a9d3f2b1-4c76-4a9b-8e1d-5f3a7c6e9d4b
                document_id: 1f7a9d27-fa27-4e15-aefd-9b5a5e32f4c1
                integrity_check_name: Payslip Integrity Checks
                integrity_check_version: '1'
                status: Pass
                entity_id: 3345857d-fa2b-43ab-8b15-67e5fea8e896
                entity_type: case
                datetime_requested: '2024-01-01T12:38:45.7110000+00:00'
                datetime_completed: '2024-01-02T12:22:07.7470000+00:00'
                message: Integrity Check request pending
                rules:
                - data_source_id: 01951375-a680-77ce-b196-44d1feedc47c
                  rule_name: Payslips are not handwritten
                  decision: Pass
                  message: Integrity Check Passed
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: fa15abf3-1779-47cd-a668-c9b8afa34d6c
        '404':
          description: Integrity check instance not found for docuemnt ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 3a80ebfd-57e6-4a04-a886-f0e844168a67.
                correlation_id: 31447cf7-eb8a-4106-85da-aa2196731698
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: bf6f83dd-ae82-41b3-9a64-dbe571bc7a07
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 8c8e4236-b3d2-462a-b7d1-29264dfa7023
  /v2/identity:
    post:
      tags:
      - Identity Verification
      summary: Request IDV
      description: "### Requests an identity verification for a person.\r\n\r\nProvide the `person_id`, and optionally specify\
        \ the `country_code` if you already know the country of issue for the document to be provided.\r\n\r\nThis returns\
        \ Sikoia's `verification_url` and an IDV provider's `direct_url` (if the country is specified in the request). Both\
        \ URLs can be used to commence the identity verification process.\r\n"
      operationId: POST_v2-identity
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.Identity.Request.IdentityVerificationRequest'
            example:
              person_id: 0fa323ec-b6e2-4a7a-8fea-58f2b264c57e
              country_code: GB
      responses:
        '201':
          description: IDV Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.Identity.Response.IdentityVerificationResponse'
              example:
                request_id: 0baa703c-950b-46b7-a424-8c24991987fd
                status: Pending
                person_id: 0fa323ec-b6e2-4a7a-8fea-58f2b264c57e
                datetime_requested: '2024-02-12T15:03:40.3890000+00:00'
                datetime_completed: string
                message: string
                country_code: GB
                verification_url: https://verify.sikoia.com/v2/123456
                direct_url: https://alchemy.veriff.com/v/123456
        '400':
          description: Company Entity Deleted/Not Found or Country Not Recognised
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: ee62da4a-9d31-4665-a6bc-078f43e702cb
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 1bc27606-b675-4a5e-aa93-19bfe4b88d07
        '403':
          description: Insufficient Credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InsufficientPermissions
                status: 403
                title: Service not enabled
                detail: Service is not currently enabled.
                correlation_id: f6a20bae-f8ee-47ee-9a87-2f48b5392ff9
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 76074003-8334-4910-aa14-867f5bd0ecc0
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: e7388aa0-caf7-4472-ba83-9fd773c67dba
  /v2/persons/{person_id}/identity-verifications:
    get:
      tags:
      - Identity Verification
      summary: List all IDV requests
      description: "### Returns a list of all identity verification requests for a person.\r\n\r\nThis endpoint provides a\
        \ list of all identity verification requests created for a specific `person_id`.\r\n\r\nThe list includes the `request_id`\
        \ for each request, which can be used to retrieve the identity verification result using the `GET /v2/identity/{request_id}`\
        \ endpoint.\r\n"
      operationId: GET_v2-persons-person_id-identity-verifications
      parameters:
      - name: person_id
        in: path
        description: Sikoia ID for the person
        required: true
        schema:
          type: string
      - name: complete
        in: query
        description: Exclude incomplete requests from the list, defaults to false
        schema:
          type: boolean
      - name: verification_status
        in: query
        description: Filter by verification status. Can be comma-separated for multiple values.
        schema:
          type: string
      responses:
        '200':
          description: IDV Requests List
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.Identity.Response.IdentityVerificationListResponse'
              example:
                person_id: 0fa323ec-b6e2-4a7a-8fea-58f2b264c57e
                identity_verification_requests:
                - request_id: 0baa703c-950b-46b7-a424-8c24991987fd
                  status: Pending
                  verification_status: ''
                  datetime_requested: '2024-02-12T15:03:40.3890000+00:00'
                  datetime_completed: string
                  message: string
                  country_code: GB
                  verification_url: https://verify.sikoia.com/v2/123456
                  direct_url: https://alchemy.veriff.com/v/123456
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 081c4cdd-3b7c-42c2-81b9-5f7b903f0f2f
        '404':
          description: Person Entity Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 014cd371-3a72-4933-ad88-4c62bd3f1b24.
                correlation_id: bda9e81b-f8c0-4f75-a059-6acc5d8c5175
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 8066dd9e-42e3-43e8-85fc-a3585d8b52a1
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: c9f4ad7f-1ed1-49df-80d9-765a66c5c8bb
  /v2/identity/{request_id}:
    get:
      tags:
      - Identity Verification
      summary: Retrieve IDV result
      description: "### Retrieve IDV status and result.\r\n\r\nThis endpoint provides the result of a specific IDV request\
        \ identified by `request_id` in a structured format.\r\n\r\nThe information includes details on the verification status,\
        \ the verified person, and the provided document.\r\n"
      operationId: GET_v2-identity-request_id
      parameters:
      - name: request_id
        in: path
        description: Sikoia ID for the request
        required: true
        schema:
          type: string
      responses:
        '200':
          description: IDV Result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.Identity.Response.Mapped.IdentityVerificationMappedResponse'
              example:
                request_id: 0baa703c-950b-46b7-a424-8c24991987fd
                status: Complete
                person_id: 0fa323ec-b6e2-4a7a-8fea-58f2b264c57e
                datetime_requested: '2024-02-12T15:03:40.3890000+00:00'
                datetime_completed: '2024-02-12T15:19:37.2110000+00:00'
                message: string
                country_code: GB
                verification_url: https://verify.sikoia.com/v2/123456
                direct_url: https://alchemy.veriff.com/v/123456
                data:
                  verification_status: Approved
                  acceptance_time: '2024-02-12T15:03:40.2370000+00:00'
                  decision_time: '2024-02-12T15:19:34.9040000+00:00'
                  person:
                    first_name: John
                    surname: Smith
                    full_name: John Smith
                    date_of_birth: '1980-01-01'
                    birth_year: '1980'
                    birth_month: '1'
                    birth_day: '1'
                    place_of_birth: string
                    gender: string
                    nationality: string
                    address: string
                  document:
                    type: Passport
                    number: '1234567890'
                    country_code: GB
                    date_of_issue: '2020-01-01'
                    date_of_expiry: '2030-01-01'
                  media:
                  - mime_type: video/webm
                    type: selfid_video
                    size: '621901'
                    upload_date: string
                    uri: https://sikoialake.blob.core.windows.net/12345678
                    uri_expiry_in_minutes: '30'
                  meta_data:
                    status_codes:
                    - value: '0'
                      type: DocumentStatusReport2.Remark
                      description: The authentication tests passed.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 00b3d778-84d1-40da-aaed-519c498ea4bf
        '404':
          description: Request ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 1221d5e0-8bc5-46b9-9943-65bb609a8ce2.
                correlation_id: 1ed8383f-c0dd-4bc4-93d3-842e636b3355
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 75fe7a2e-1381-4e30-8ae5-af394d31f8f8
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: c14ab866-e8fe-4ccd-af70-4cd448d93008
  /v2/company-online-data:
    post:
      tags:
      - Online Data
      summary: Request online data
      description: "### Requests online data for a company.\r\n\r\nProvide the `company_id` and optionally specify the `company_name`.\
        \ If the company_name is specified, it will override the company entity name.\r\n"
      operationId: POST_v2-company-online-data
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.OnlineData.Request.OnlineDataRequest'
            example:
              company_id: string
              company_name: string
      responses:
        '201':
          description: Request online data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.OnlineData.Response.OnlineDataResponse'
              example:
                request_id: 98aacc2c-5bcd-43da-8425-cbd17034e826
                status: Complete
                company_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                entity_type: company
                datetime_requested: '2024-02-12T15:34:25.4850000+00:00'
                message: string
                company_name: Acme Inc
        '400':
          description: Company Entity Deleted/Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: 77fbd479-b1c8-4b7e-b3a7-427700993552
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: c594501e-e8ec-496e-9295-e5178844947b
        '422':
          description: Company Entity Missing Information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: UnprocessableRequest
                status: 422
                title: Entity Missing Information
                detail: Entity with id 5b6d1a09-726f-4807-adaa-b4adbdbc3248 is missing required information, please update
                  entity.
                correlation_id: 859ff592-0ae3-466c-bea4-27dc8c24c90e
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 47e2f72b-6b86-4c80-8587-21be8666a8fe
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 33eff0e9-bf76-418d-995e-6b92d899b7c1
  /v2/companies/{company_id}/online-data:
    get:
      tags:
      - Online Data
      summary: List all online data requests
      description: "### Returns a list of all online data requests for a company.\r\n\r\nThe list includes the `request_id`\
        \ for each request, which can be used to retrieve detailed registry data using the `GET /v2/company-online-data/{request_id}`\
        \ endpoint.\r\n"
      operationId: GET_v2-companies-company_id-online-data
      parameters:
      - name: company_id
        in: path
        description: Sikoia ID for the Company
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Online Data Requests List
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.OnlineData.Response.OnlineDataListResponse'
              example:
                company_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                online_data_requests:
                - request_id: 98aacc2c-5bcd-43da-8425-cbd17034e826
                  status: Complete
                  datetime_requested: '2024-02-12T15:34:25.4850000+00:00'
                  message: string
                  company_name: Acme Inc
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 807e9735-f25f-4067-89b0-9ee706277047
        '404':
          description: Company Entity Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id a4b186c4-2c16-45b1-ac5e-b48d6c5138df.
                correlation_id: bcc61d95-51a2-4968-bc1a-66561852ac20
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: cb73af08-2a34-4972-be4e-1c908172b9a9
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: b38daf1f-ac34-49eb-87ce-f681a4c09fe7
  /v2/company-online-data/{request_id}:
    get:
      tags:
      - Online Data
      summary: Retrieve online data
      description: "### Returns online data for a company.\r\n\r\nThis endpoint returns the company online data associated\
        \ with a specific `request_id`.\r\n"
      operationId: GET_v2-company-online-data-request_id
      parameters:
      - name: request_id
        in: path
        description: Sikoia ID for the request
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Online Data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.OnlineData.Response.Mapped.OnlineDataMappedResponse'
              example:
                request_id: 98aacc2c-5bcd-43da-8425-cbd17034e826
                status: Complete
                company_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                datetime_requested: '2024-02-12T15:34:25.4850000+00:00'
                message: string
                company_name: Acme Inc
                data:
                  website_url: https://www.acmeinc.com
                  phones: '[]'
                  emails: ''
                  online_accounts: ''
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: ab799048-1821-4f19-9ff7-b5477b08305d
        '404':
          description: Request ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 46f48fd1-94d4-4b7e-8530-f827e78334cc.
                correlation_id: c465c8b7-fbf5-4c58-be97-c1fdd11b5427
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 03de5d9a-076c-47a3-837b-e20eb927426c
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 46c8dc43-1952-4c3c-8bef-88280b6e6f1f
  /v2/affordability-insights:
    post:
      tags:
      - Affordability Insights
      summary: Request affordability insight
      description: "### Request an affordability insights for a `case`, `person`, or `company` entity.\r\n\r\nBefore making\
        \ the request, ensure that at least one data source with a status of `Complete` is associated with the entity.\r\n\
        A successful response will include a `request_id` that can be used to check the status of the request.\r\n"
      operationId: POST_v2-affordability-insights
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Request.AffordabilityInsightsRequest'
            example:
              entity_id: 3f615611-3dc3-418b-bed5-a53c4390c97c
              entity_type: case
      responses:
        '201':
          description: Affordability Insights Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.AffordabilityInsightsResponse'
              example:
                request_id: a5f84a41-01cf-4d21-901d-124c5a7c743a
                status: Pending
                entity_id: 7885857d-fa2b-43ab-8b15-67e5fea8e896
                entity_type: case
                datetime_requested: '2023-11-24T12:38:45.7110000+00:00'
                datetime_completed: '2023-11-24T12:41:14.2220000+00:00'
                message: Affordability insights pending
        '400':
          description: Entity deleted/not found or invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: 91475491-a429-4d3b-8e7e-dcce0e4d5ef6
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 85da31dd-7c62-468d-8c4b-a47dfe2818a4
        '403':
          description: Affordability Insights not enabled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InsufficientPermissions
                status: 403
                title: Service not enabled
                detail: Service is not currently enabled.
                correlation_id: 7786209b-0423-486e-a72b-919a237c6ac1
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 52d21edd-0901-4210-9c9b-ea601fd6208d
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: a11b9bab-9fbe-4305-88e7-c72ddac0f322
  /v2/{entity_type}/{entity_id}/affordability-insights:
    get:
      tags:
      - Affordability Insights
      summary: List all affordability insight requests
      description: "### Returns a list of all affordability insights requested for an entity.\r\n\r\nThe list includes the\
        \ `request_id` for each request, which can be used to retrieve the affordability insight using the `GET /v2/affordability-insights/{request_id}`\
        \ endpoint.\r\n"
      operationId: GET_v2-entity_type-entity_id-affordability-insights
      parameters:
      - name: entity_type
        in: path
        description: The type of entity (company, person, case)
        required: true
        schema:
          enum:
          - Companies
          - Persons
          - Cases
          type: string
      - name: entity_id
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Affordability Insights List
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.OrchestrationListResponse'
              example:
                entity_id: 7885857d-fa2b-43ab-8b15-67e5fea8e896
                entity_type: case
                affordability_insights_requests:
                - request_id: a5f84a41-01cf-4d21-901d-124c5a7c743a
                  status: Complete
                  datetime_requested: '2023-11-29T12:21:52.9330000+00:00'
                  datetime_completed: '2023-11-29T12:22:07.7470000+00:00'
                  message: Affordability insights complete
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 244b0164-df50-4fca-8bf6-a4cb897e451a
        '404':
          description: Entity deleted/not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id e6e472d3-a892-41b6-8497-a014ba88c0d9.
                correlation_id: d4a13baf-0b0e-4c51-a6e5-01a9f048de13
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 29decd6a-f48c-48c9-ac15-914fc4821506
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 0c8f9aa5-df23-470c-a598-5c1aa2491687
  /v2/affordability-insights/{request_id}:
    get:
      tags:
      - Affordability Insights
      summary: Retrieve affordability insight
      description: "### Returns an affordability insight.\r\n\r\nThis endpoint returns the affordability insight associated\
        \ with a specific `request_id`.\r\n"
      operationId: GET_v2-affordability-insights-request_id
      parameters:
      - name: request_id
        in: path
        description: Sikoia ID for the request
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Affordability Insights
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.AffordabilityInsightsMappedResponse'
              example:
                request_id: a5f84a41-01cf-4d21-901d-124c5a7c743a
                status: Complete
                entity_id: 7885857d-fa2b-43ab-8b15-67e5fea8e896
                entity_type: case
                datetime_requested: '2023-11-29T12:21:52.9330000+00:00'
                datetime_completed: '2023-11-29T12:22:07.7470000+00:00'
                message: Affordability insights pending
                data:
                  cashflow:
                  - group: Income
                    value: '5249.19'
                    categories:
                    - name: Employment and/or Self-employment
                      value: '5109.45'
                      subcategories:
                      - name: Phone / Broadband
                        value: '5109.45'
                  indicators:
                  - name: Benefits
                    present: 'true'
                    transactions:
                    - transaction_id: e77cc404-5978-4429-a25a-135303cd8fdf
                      account_connection_id: e77cc404-5978-4429-a25a-135303cd8fdf
                      date: '2025-01-24'
                      group: Essential expenditure
                      category: Utilities
                      subcategory: Phone and broadband
                      short_description: EE Limited
                      long_description: EE LIMITED, LONDON GB
                      amount: '-6.90'
                  data_sources:
                  - source_id: 4b9ac393-d34b-4a14-9ee3-88ce2d244e90
                    source_name: Stmt - current - Feb 2023 - J Smith and J Hayley
                    source_category_type: Document
                    source_type: BankStatement
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 565240aa-b14a-4a5c-bec6-c2bc41cac423
        '404':
          description: Request ID not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 2b63ef4e-3397-4606-aab1-3bfd9eba7efb.
                correlation_id: 27ad5fea-c1bb-4ff4-b9a2-1780eb7d58f1
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 38e76326-17b6-4695-bec6-b5b8e276c9aa
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 392e2b48-fb50-48ba-991f-8b3944ed02ca
  /v2/affordability-insights/{request_id}/transactions:
    get:
      tags:
      - Affordability Insights
      summary: Retrieve a monthly summary of transaction data
      description: "### Returns aggregated transaction data per month for an affordability insight.\r\n\r\nThis endpoint returns\
        \ a monthly summary of all the transactions used to generate a specific affordability insight identified by a unique\
        \ `request_id`.\r\n"
      operationId: GET_v2-affordability-insights-request_id-transactions
      parameters:
      - name: request_id
        in: path
        description: Sikoia ID for the request
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Transaction View
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.TransactionViewMappedResponse'
              example:
                request_id: a5f84a41-01cf-4d21-901d-124c5a7c743a
                status: Complete
                entity_id: 7885857d-fa2b-43ab-8b15-67e5fea8e896
                entity_type: case
                datetime_requested: '2023-11-29T12:21:52.9330000+00:00'
                datetime_completed: '2023-11-29T12:22:07.7470000+00:00'
                message: Affordability insights completed.
                data:
                - group: Essential expenditure
                  category: Utilities
                  subcategory: Phone / Broadband
                  short_description: EE Limited
                  number_of_transactions: '6'
                  total_value: '-271.4'
                  average_value: '-45.2'
                  minimum_value: '-50.34'
                  maximum_value: '-40.14'
                  monthly_data:
                  - year: '2023'
                    month: '10'
                    total_value: '-90.48'
                data_sources:
                - source_id: 4b9ac393-d34b-4a14-9ee3-88ce2d244e90
                  source_name: Stmt - current - Feb 2023 - J Smith and J Hayley
                  source_category_type: Document
                  source_type: BankStatement
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 73d64331-7e33-41c4-98a7-901530bbf525
        '404':
          description: Request ID not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 37ef26f9-4e18-4e8c-a835-57f03f0d3b23.
                correlation_id: 743ae536-fc39-4a06-94eb-34ceb39b1fc7
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 3e8b5cfd-f55d-4198-a994-2926d1e81196
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 176b9a17-d24b-435d-b899-ee29d9b23786
  /v2/affordability-insights/{request_id}/transaction-details:
    get:
      tags:
      - Affordability Insights
      summary: Retrieve a full breakdown of all transaction data
      description: "### Returns all transactions for an affordability insight.\r\n\r\nThis endpoint returns all the transactions\
        \ used to generate a specific affordability insight identified by a unique `request_id`.\r\n"
      operationId: GET_v2-affordability-insights-request_id-transaction-details
      parameters:
      - name: request_id
        in: path
        description: Sikoia ID for the request
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Transaction Details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.TransactionDetailMappedResponse'
              example:
                request_id: a5f84a41-01cf-4d21-901d-124c5a7c743a
                status: Complete
                entity_id: 7885857d-fa2b-43ab-8b15-67e5fea8e896
                entity_type: case
                datetime_requested: '2023-11-29T12:21:52.9330000+00:00'
                datetime_completed: '2023-11-29T12:22:07.7470000+00:00'
                message: Affordability insights completed.
                data:
                - transaction_id: e77cc404-5978-4429-a25a-135303cd8fdf
                  account_connection_id: e77cc404-5978-4429-a25a-135303cd8fdf
                  date: '2025-01-24'
                  group: Essential expenditure
                  category: Utilities
                  subcategory: Phone and broadband
                  short_description: EE Limited
                  long_description: EE LIMITED, LONDON GB
                  amount: '-6.90'
                data_sources:
                - source_id: 4b9ac393-d34b-4a14-9ee3-88ce2d244e90
                  source_name: Stmt - current - Feb 2023 - J Smith and J Hayley
                  source_category_type: Document
                  source_type: BankStatement
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 6970a547-1612-41f1-925e-0f0e601cdea7
        '404':
          description: Request ID not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 1e24100b-1c1f-4189-a5e2-3b518836d75c.
                correlation_id: 1720f95a-8404-4db2-9dcd-724f19c737f4
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: dc8b20e9-0cb5-4895-8997-fa1be9de8c2b
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 8c61978d-602b-49db-9c9d-7b4654130fce
  /v2/income-employer:
    post:
      tags:
      - Income & Employer Verification
      summary: Request income & employer verification
      description: "### Requests an income and employer verification for a case, person, or company\r\n\r\nThis endpoint automatically\
        \ verifies an entity’s income from various sources including documents and open banking connections.\r\n\r\nTo proceed,\
        \ ensure that both `entity_id` and `entity_type` are valid and ensure that at least one income-related document or\
        \ open banking connection has been attached to the entity.\r\n\r\nA successful response will include a `request_id`\
        \ that can be used to check the status of the request.\r\n"
      operationId: POST_v2-income-employer
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Request.IncomeEmployerRequest'
            example:
              entity_id: 473078e-e392-4943-9ea9-efe7590eb503
              entity_type: case
      responses:
        '201':
          description: The income request is pending
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.IncomeEmployerResponse'
              example:
                request_id: 8ef5079a-b3de-44a5-b4ff-c534259e752c
                status: Pending
                entity_id: b3f6ed8f-bc57-4a23-801e-e744aecb7b03
                entity_type: case
                datetime_requested: '2024-01-01T12:38:45.7110000+00:00'
                datetime_completed: '2024-01-02T12:22:07.7470000+00:00'
                message: Income request pending
        '400':
          description: Entity Deleted/Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: b10206b6-1f88-49ce-bae8-41a86d4a2652
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 57fc27f4-fd09-484c-af3d-2226a31a70b4
        '403':
          description: Income Employer Service not enabled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InsufficientPermissions
                status: 403
                title: Service not enabled
                detail: Service is not currently enabled.
                correlation_id: 051565d3-e71e-4354-ab7d-18a22f062488
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: b77a6768-9b44-4c2d-b4dd-aac635537fcd
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 07e52f5f-f19e-4bb6-b191-d0b65d96ab6f
  /v2/{entity_type}/{entity_id}/income-employer:
    get:
      tags:
      - Income & Employer Verification
      summary: List all income & employer verifications
      description: "### This returns a list of all the income employer requests for the specified entity.\r\n\r\nReturns a\
        \ list of all income & employer verifications requested for an entity.\r\n\r\nThe list includes the `request_id` for\
        \ each request, which can be used to retrieve the income and employer verification using the GET `/v2/income-employer/{request_id}`\
        \ endpoint.\r\n"
      operationId: GET_v2-entity_type-entity_id-incomeemployer
      parameters:
      - name: entity_type
        in: path
        description: Entity Type
        required: true
        schema:
          enum:
          - Companies
          - Persons
          - Cases
          type: string
      - name: entity_id
        in: path
        description: Entity ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Income Employer Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.OrchestrationListResponse'
              example:
                entity_id: 3345857d-fa2b-43ab-8b15-67e5fea8e896
                entity_type: case
                income_employer_requests:
                - request_id: w5f84a41-01cf-4d21-901d-124c5a7c743a
                  status: Complete
                  datetime_requested: '2024-01-29T12:21:52.9330000+00:00'
                  datetime_completed: '2024-01-30T09:44:22.4660000+00:00'
                  message: Income Employer complete
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 34c972c5-5c53-4967-8891-eb29cbb38372
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id d9b5dedb-6541-405a-bd57-134ca39a4149.
                correlation_id: 81bcd82c-5f87-447b-bdfa-2ec35ba67b70
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 3cb70b1c-c44e-4256-97a3-c9bd9713b6bd
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 6ed01b71-ad4c-497d-a06f-dc44f17f2e67
  /v2/income-employer/{request_id}:
    get:
      tags:
      - Income & Employer Verification
      summary: Retrieve income & employer verification
      description: "### Returns an income & employer verification.\r\n\r\nThis endpoint returns the income & employer verification\
        \ associated with a specific `request_id`.\r\n"
      operationId: GET_v2-income-employer-request_id
      parameters:
      - name: request_id
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Income Employer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.IncomeEmployerMappedResponse'
              example:
                request_id: 8ef5079a-b3de-44a5-b4ff-c534259e752c
                status: Pending
                entity_id: b3f6ed8f-bc57-4a23-801e-e744aecb7b03
                entity_type: case
                datetime_requested: '2024-01-01T12:38:45.7110000+00:00'
                datetime_completed: '2024-01-02T12:22:07.7470000+00:00'
                message: Income request pending
                data:
                  income_details:
                  - income_recipient: Sharon Smith
                    income_type: Employment
                    income_source: BUILDING HOME LTD
                    annual_gross_pay: '23657.04'
                    monthly_gross_pay: '1971.42'
                    monthly_deductions: '319.49'
                    monthly_net_pay: '1561.93'
                    pay_frequencies:
                    - string
                    national_insurance_number:
                    - string
                    national_insurance_letters:
                    - string
                    unique_taxpayer_references:
                    - string
                    job_titles:
                    - string
                    tax_codes:
                    - string
                    paye_references:
                    - string
                    employee_numbers:
                    - string
                    ytd_gross_pay: '22472.85'
                    ytd_net_pay: '18070.33'
                    ytd_tax_paid: '1100.63'
                    ytd_ni_paid: '1100.63'
                    ytd_pension_paid: '1100.63'
                    ytd_other_deductions: '1100.63'
                    additional_information:
                      bonuses:
                      - amount: '222.22'
                        date: '2024-01-01'
                      monthly_student_loan_deductions: '222.44'
                      monthly_gross_pay_details:
                      - category: MonthlyBasicPay
                        amount: '222.44'
                      monthly_deductions_details:
                      - category: MonthlyIncomeTax
                        amount: '167.15'
                      average_income_items:
                      - category: PayFromAllEmployments
                        value: '1971.42'
                      average_tax_items:
                      - category: Tax
                        short_description: Class 4 NIC
                        value: '1971.42'
                    income_source_addresses:
                    - summary_line: Flat 23, Sample Street, London
                      post_code: SW4 4PL
                    employee_addresses:
                    - summary_line: 19, Sample Street, London
                      post_code: SW1 1PN
                    income_data_sources:
                    - source_type: Payslip
                      number_of_sources: '1'
                      start_date: '2024-01-01'
                      end_date: '2024-02-01'
                      data_sources:
                      - source_name: Stmt - current - Feb 2023 - J Smith and J Hayley
                        source_id: 4b9ac393-d34b-4a14-9ee3-88ce2d244e90
                        source_category_type: Document
                        source_type: Payslip
                  data_sources:
                  - source_name: Stmt - current - Feb 2023 - J Smith and J Hayley
                    source_id: 4b9ac393-d34b-4a14-9ee3-88ce2d244e90
                    source_category_type: Document
                    source_type: Payslip
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 8b9df2bb-c107-4a12-b0b7-747882c21de5
        '404':
          description: Request ID not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 03f4fd05-45d9-4d2e-ab62-694799e0ce00.
                correlation_id: e242fc86-f42d-4186-ad55-aa43fc3b6701
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: b21530fe-b761-48cc-991d-0d844828e809
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 0cac9510-4791-42bc-b1d7-9e5ba0dfb02d
  /v2/income-employer/{request_id}/additional-details:
    get:
      tags:
      - Income & Employer Verification
      summary: Retrieve detailed payslip, bank statement, tax documents and/or open banking connection data
      description: "### Returns detailed data from individual payslips, bank statements, tax documents and/or open banking\
        \ connections behind an income & employer verification.\r\n\r\nThis endpoint returns data from all the individual\
        \ payslips, bank statements, tax documents and/or open banking connections used to generate a specific income & employer\
        \ verification identified by a unique `request_id`.\r\n"
      operationId: GET_v2-income-employer-request_id-additional-details
      parameters:
      - name: request_id
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Income Employer Additional Details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.IncomeEmployerAdditionalDetailsResponse'
              example:
                request_id: 8ef5079a-b3de-44a5-b4ff-c534259e752c
                status: Pending
                entity_id: b3f6ed8f-bc57-4a23-801e-e744aecb7b03
                entity_type: case
                datetime_requested: '2024-01-01T12:38:45.7110000+00:00'
                datetime_completed: '2024-01-02T12:22:07.7470000+00:00'
                message: Income request pending
                data:
                - income_recipient: Sharon Smith
                  income_type: Employment
                  income_source: BUILDING HOME LTD
                  details:
                  - source_type: Payslip
                    source_id: 4b9ac393-d34b-4a14-9ee3-88ce2d244e90
                    data_source_id: 01951375-a680-77ce-b196-44d1feedc47c
                    source_name: Stmt - current - Feb 2023 - J Smith and J Hayley.pdf
                    income_source_data:
                      payslip_date: '2024-01-31'
                      pay_period_start_date: '2024-01-01'
                      pay_period_end_date: '2024-01-31'
                      payment_date: '2024-01-31'
                      start_date: '2024-01-01'
                      end_date: '2024-04-01'
                      pay_frequency: Monthly
                      pay_period: '5'
                      gross_pay: '1971.42'
                      total_deductions: '319.49'
                      net_pay: Basic Pay
                      national_insurance_number: QQ123456B
                      national_insurance_letter: Q
                      unique_taxpayer_reference: '1234567890'
                      tax_code: 1257L
                      paye_reference: 123/AB456
                      employee_name: Sharon Smith
                      employer_name: BUILDING HOME LTD
                      employee_number: '1234567890'
                      job_title: Customer Services Officer
                      income_source_address:
                        summary_line: Flat 23, Sample Street, London
                        post_code: SW4 4PL
                      employee_address:
                        summary_line: 19, Sample Street, London
                        post_code: SW1 1PN
                      ytd_gross_pay: '7000.00'
                      ytd_net_pay: '2600.00'
                      ytd_tax_paid: '1100.00'
                      ytd_ni_paid: '1100.00'
                      ytd_pension_paid: '1100.00'
                      ytd_other_deductions: '1100.00'
                      detailed_pay_items:
                      - category: BasicPay
                        short_description: January Salary
                        value: '1971.42'
                        rate: '1'
                        quantity: '1'
                      detailed_deduction_items:
                      - category: IncomeTax
                        short_description: PAYE
                        value: '319.49'
                      tax_information:
                        summary:
                          employment_income: '21843.00'
                          total_income: '48933.00'
                          net_income: '47437.30'
                          allowances_and_reliefs: '12570.00'
                          tax_due: '3348.70'
                        income:
                          income_from_employments: '21843.00'
                          income_from_benefits: 0
                          allowable_expenses: 0
                          non_employment_income:
                            share_schemes: 0
                            profit_from_self_employment: 0
                            profit_from_partnerships: 0
                            interest_from_partnerships: 0
                            dividends_from_partnerships: 0
                            profit_from_uk_land_and_property: '14590.00'
                            foreign_income: 0
                            foreign_dividends: 0
                            foreign_savings: 0
                            trusts_and_estates: 0
                            interest_from_uk_banks: 0
                            dividends_from_uk_companies: '12500.00'
                            uk_pensions_and_state_benefits: 0
                            gains_on_life_insurance_policies: 0
                            other_income: 0
                            subtotal: '27090.00'
                          total: '48933.00'
                        tax_and_charges:
                          tax_charged_before_reliefs: '5560-10-01'
                          tax_charged_after_reliefs: '3348.70'
                          tax_relief_for_financing_costs: '-1959.40'
                          other_tax_reductions_and_reliefs: '-252.00'
                          national_insurance: 0
                          student_loan_repayments: 0
                          capital_gains_tax: 0
                          other_amounts_paid_via_tax: 0
                          total_tax_due: '3348.70'
                          tax_deducted: '-1853.00'
                          net_tax_due: '1495.70'
                        payments:
                          tax_already_paid_for_this_year: 0
                          outstanding_from_last_year: 0
                          balancing_payment_for_this_year: 0
                          first_payment_on_account_for_next_year: 0
                          second_payment_on_account_for_next_year: 0
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 7d2e0b5e-02dc-40f8-ab9b-56868b9b6665
        '404':
          description: Request ID not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id e2a97946-247e-4b1e-81f4-fa347d4455c8.
                correlation_id: c589cfd2-d403-49a4-81f7-ae678cc8582e
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: e6c35586-4c0e-495c-9ee3-3656b8cc0275
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 5c137f9e-769b-47f1-8fe4-b8697429b278
  /v2/{entity_type}/{entity_id}/insight-data-sources:
    get:
      tags:
      - Data Sources
      summary: List data sources for an entity
      description: "### Returns a list of all data sources for an entity.\r\nProvides a list of all data sources attached\
        \ to an entity which might be used to generate Sikoia Insights and their status. Possible statuses include: Provided,\
        \ Pending, Complete, Failed.\r\nOnly data sources with a status of 'Complete' will be used to generate Affordability\
        \ Insights or Income & Employer Verifications."
      operationId: GET_v2-entity_type-entity_id-insight-data-sources
      parameters:
      - name: entity_type
        in: path
        description: Type of entity to find all related data sources for
        required: true
        schema:
          $ref: '#/components/schemas/SikoiaSharedModels.Global.Enums.PathEntityTypeEnum'
      - name: entity_id
        in: path
        description: ID of entity to find all related data sources for
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Insight Data Sources
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.Global.DataSources.Insight'
              example:
                entity_id: 181eba57-b6b4-4288-8c97-f8299530f071
                entity_type: case
                data_sources:
                - source_name: Stmt - current - Feb 2023 - J Smith and J Hayley
                  source_id: 4b9ac393-d34b-4a14-9ee3-88ce2d244e90
                  data_source_id: 01951375-a680-77ce-b196-44d1feedc47c
                  source_category_type: Document
                  source_type: None
                  status: Provided
                  message: Some message explaining what's happened
                  recipient: Jane Smith
                  source_date: '2023-02-01'
                  source_uris: '["https://api.sikoia.com/v2/documents/4b9ac393-d34b-4a14-9ee3-88ce2d244e90"]'
                  start_date: '2023-02-01'
                  end_date: '2023-03-01'
                  provided_date: '2023-02-10T10:59:46.0000000+00:00'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 1c2ae529-318c-4286-b47a-d654597159b5
        '404':
          description: Entity Not Found or Deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id b09d7075-7a9a-4528-9937-433a8935761f.
                correlation_id: 6b47bc4d-0944-4d5c-80ef-28b37174bc27
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: b6efbb23-ebd3-4195-b627-5feffb9d592f
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: string
                status: 0
                title: string
                detail: string
                correlation_id: string
  /v2/validation-checks/validation-types:
    get:
      tags:
      - Validation Checklists
      summary: List all validation checklists
      description: "### Returns a list of all validation checklists available.\r\n\r\nThis list includes all available checklists\
        \ along with their `validation_type_id`, `validation_check_name`, `validation_description` and `entity_type`.\r\n"
      operationId: GET_v2-validation-checks-validation-types
      responses:
        '200':
          description: Checklist types
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SikoiaSharedModels.EventProcessor.Checklist.Response.Models.CheckListValidationType'
              example:
              - validation_type_id: a072e37a-dee1-4a4e-b098-168a6a1f4603
                validation_check_name: Last 3 months of payslips
                validation_description: Checks if all payslips from the last 3 months have been provided
                entity_type: case
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 185dd335-3a93-4e3a-8d37-e59bd5a14259
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: a76ae66e-9aee-4aae-93c1-c2ed14d36e1b
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: bfbb0cfa-0c8e-43a5-a87a-2ffe32a493d3
  /v2/validation-checks:
    post:
      tags:
      - Validation Checklists
      summary: Run a validation checklist
      description: "### Runs a validation checklist against a specific case, person, company, or data source.\r\n\r\nThis\
        \ endpoint automatically checks whether an entity passes all the rules in a specific validation checklist.\r\n\r\n\
        To proceed, ensure that `validation_type_id`, `entity_id` and `entity_type` are valid.\r\n\r\nTo run the checklist\
        \ against a specific data source use the `check_params` filter and provide the `source_id` and `source_id_type` of\
        \ the data source you want to use.\r\n\r\nA successful response will include a `validation_instance_id` that can be\
        \ used to check the status of the request.\r\n"
      operationId: POST_v2-validation-checks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.EventProcessor.Checklist.Request.CheckListValidationRequest'
            example:
              validation_type_id: a072e37a-dee1-4a4e-b098-168a6a1f4603
              entity_id: 3f615611-3dc3-418b-bed5-a53c4390c97c
              entity_type: case
              checklist_params:
              - source_id: 5c8a9d27-fa27-4e15-aefd-9b5a5e32f4c1
                source_category_type: Document
      responses:
        '201':
          description: The validation check is pending
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.EventProcessor.Checklist.Response.RequestValidationCheckResponse'
              example:
                validation_instance_id: 2ef5079a-b3de-44a5-b4ff-c534259e752c
                validation_type_id: a072e37a-dee1-4a4e-b098-168a6a1f4603
                status: Pending
                entity_id: b3f6ed8f-bc57-4a23-801e-e744aecb7b03
                entity_type: case
                checklist_params:
                - source_id: 5c8a9d27-fa27-4e15-aefd-9b5a5e32f4c1
                  source_category_type: Document
                datetime_requested: '2024-01-01T12:38:45.7110000+00:00'
                datetime_completed: '2024-01-02T12:22:07.7470000+00:00'
                message: Validation Check request pending
        '400':
          description: Entity Deleted/Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: d8c6e7b5-4ad6-4b22-a35c-0a107b7780e1
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: edf58a4d-b90f-4cdd-96d7-20c2d4dbbe9b
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 3edfe4be-2ab6-4518-9a1d-c6b0d31edd3a
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: e87eba1c-ee27-4469-9ac1-3dffe8ff577f
  /v2/{entity_type}/{entity_id}/validation-checks:
    get:
      tags:
      - Validation Checklists
      summary: List all validation checklist requests
      description: "### List all validation checklist requests.\r\n\r\nReturns a list of all validation checklists requested\
        \ for an entity.\r\n\r\nThe list includes the validation_instance_id for each request, which can be used to retrieve\
        \ the validation check rules result using the GET `/v2/validation-checks/{validation_instance_id}` endpoint.\r\n"
      operationId: GET_v2-entity_type-entity_id-validation-checks
      parameters:
      - name: entity_type
        in: path
        description: Entity Type
        required: true
        schema:
          enum:
          - Companies
          - Persons
          - Cases
          type: string
      - name: entity_id
        in: path
        description: Entity ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Validation Check Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.EventProcessor.Checklist.Response.ValidationCheckRequestListResponse'
              example:
                entity_id: 3345857d-fa2b-43ab-8b15-67e5fea8e896
                entity_type: case
                validation_check_requests:
                - validation_instance_id: 2ef5079a-b3de-44a5-b4ff-c534259e752c
                  validation_type_id: a072e37a-dee1-4a4e-b098-168a6a1f4603
                  status: Complete
                  datetime_requested: '2024-01-29T12:21:52.9330000+00:00'
                  datetime_completed: '2024-01-30T09:44:22.4660000+00:00'
                  message: Income Employer complete
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: b52cb216-280c-4a8b-8505-49cb5e59463d
        '404':
          description: Entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 85d2cc51-4be8-473a-9ec6-60d7920b978e.
                correlation_id: c883325a-bd60-47c9-b053-4541e4e686ba
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: fe491217-07f7-4d3b-8a06-2ecf6ef5af4e
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 376efd61-9519-41d5-8c22-55f6239e9f54
  /v2/validation-checks/{validation_instance_id}:
    get:
      tags:
      - Validation Checklists
      summary: Retrieve validation checklist result
      description: "### Returns an instance of a validation checklist.\r\n\r\nThis endpoint returns the validation check results\
        \ associated with a specific `validation_instance_id`.\r\n"
      operationId: GET_v2-validation-checks-validation_instance_id
      parameters:
      - name: validation_instance_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Validation Check
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.EventProcessor.Checklist.Response.ValidationCheckInstanceResponse'
              example:
                validation_instance_id: 2ef5079a-b3de-44a5-b4ff-c534259e752c
                validation_type_id: a072e37a-dee1-4a4e-b098-168a6a1f4603
                validation_check_name: Last 3 months of payslips
                status: Complete
                entity_id: 3345857d-fa2b-43ab-8b15-67e5fea8e896
                entity_type: case
                checklist_params:
                - source_id: 5c8a9d27-fa27-4e15-aefd-9b5a5e32f4c1
                  source_category_type: Document
                datetime_requested: '2024-01-01T12:38:45.7110000+00:00'
                datetime_completed: '2024-01-02T12:22:07.7470000+00:00'
                message: Validation Check request pending
                rules:
                - rule_name: Payslips span a 3 month period
                  decision: Pass
                  recipient: Sam Smith
                  message: Validation Check Passed
                  sources:
                  - source_id: 6f6b61c2-fe31-42be-b46c-20a0b9685aaf
                    source_category_type: Document
                    source_uri: https://api.sikoia.com/v2/documents/6f6b61c2-fe31-42be-b46c-20a0b9685aaf
                    date: '2025-01-25'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 7f70212a-e64c-471b-8e3f-c962b0ece194
        '404':
          description: Validation check instance ID not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id b7b98885-7e10-4eec-940b-2f60b51b6ef1.
                correlation_id: 4dafab83-28a4-4545-875a-3f1e39753312
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 27b7cb17-34de-4679-bcf1-de2a1bd427d0
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: ea5bf8d0-72ec-472c-946e-d8fa4ef2fd8a
  /v2/{entity_type}/{entity_id}/excel-report:
    get:
      tags:
      - Excel Report
      summary: Retrieve excel report
      description: "### Generates an Excel report with a summary of key data for the specified entity.\r\n\r\nThis endpoint\
        \ returns a report containing data on income and employment verification, affordability insights, validation checklists,\
        \ and integrity checks.\r\n\r\nThe only validation checklists that are included in the report, if you have requested\
        \ them, are:\r\n- `Last 3 months of payslips`\r\n- `Last 3 months of bank transactions`\r\n"
      operationId: GET_v2-entity_type-entity_id-excel-report
      parameters:
      - name: entity_type
        in: path
        description: Entity Type
        required: true
        schema:
          enum:
          - Companies
          - Persons
          - Cases
          type: string
      - name: entity_id
        in: path
        description: Entity ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Excel Report
          content:
            application/json:
              schema:
                type: string
                format: binary
              example: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 6ebde479-c50f-43b2-b831-a32b51c859c0
        '404':
          description: Entity deleted/not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 0208fd85-0ae2-45b8-82d3-2d2b022b2e78.
                correlation_id: b9c12a9b-2cf0-4b59-a776-51780a31f13b
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: e5367b1c-3eeb-4785-af90-49b4d0278839
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: ae1b4b15-8df7-464c-8203-2042cd3a8510
  /v2/completeness-income-checks:
    post:
      tags:
      - Checklist
      summary: Run a completeness and income insights check
      description: "### Check Completness and Income.\r\n\r\nThis endpoint executes a two-stage workflow: it first validates\
        \ the entity against all completeness rules, \r\n\r\nthen automatically initiates income verification upon success.\r\
        \n\r\nA successful response returns the combined data from both processes.\r\n"
      operationId: POST_v2-completeness-income-checks
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.EventProcessor.Checklist.Request.CheckListValidationRequest'
            example:
              validation_type_id: a072e37a-dee1-4a4e-b098-168a6a1f4603
              entity_id: 3f615611-3dc3-418b-bed5-a53c4390c97c
              entity_type: case
              checklist_params:
              - source_id: 5c8a9d27-fa27-4e15-aefd-9b5a5e32f4c1
                source_category_type: Document
      responses:
        '200':
          description: The validation check is completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroserviceEventProcessor.Application.Models.Response.CompletnessAndIncomeResponse'
              example:
                completness_verification:
                  validation_instance_id: 2ef5079a-b3de-44a5-b4ff-c534259e752c
                  validation_type_id: a072e37a-dee1-4a4e-b098-168a6a1f4603
                  validation_check_name: Last 3 months of payslips
                  status: Complete
                  entity_id: 3345857d-fa2b-43ab-8b15-67e5fea8e896
                  entity_type: case
                  checklist_params:
                  - source_id: 5c8a9d27-fa27-4e15-aefd-9b5a5e32f4c1
                    source_category_type: Document
                  datetime_requested: '2024-01-01T12:38:45.7110000+00:00'
                  datetime_completed: '2024-01-02T12:22:07.7470000+00:00'
                  message: Validation Check request pending
                  rules:
                  - rule_name: Payslips span a 3 month period
                    decision: Pass
                    recipient: Sam Smith
                    message: Validation Check Passed
                    sources:
                    - source_id: 6f6b61c2-fe31-42be-b46c-20a0b9685aaf
                      source_category_type: Document
                      source_uri: https://api.sikoia.com/v2/documents/6f6b61c2-fe31-42be-b46c-20a0b9685aaf
                      date: '2025-01-25'
                income_verification:
                  request_id: 8ef5079a-b3de-44a5-b4ff-c534259e752c
                  status: Pending
                  entity_id: b3f6ed8f-bc57-4a23-801e-e744aecb7b03
                  entity_type: case
                  datetime_requested: '2024-01-01T12:38:45.7110000+00:00'
                  datetime_completed: '2024-01-02T12:22:07.7470000+00:00'
                  message: Income request pending
                  data:
                    income_details:
                    - income_recipient: Sharon Smith
                      income_type: Employment
                      income_source: BUILDING HOME LTD
                      annual_gross_pay: '23657.04'
                      monthly_gross_pay: '1971.42'
                      monthly_deductions: '319.49'
                      monthly_net_pay: '1561.93'
                      pay_frequencies:
                      - string
                      national_insurance_number:
                      - string
                      national_insurance_letters:
                      - string
                      unique_taxpayer_references:
                      - string
                      job_titles:
                      - string
                      tax_codes:
                      - string
                      paye_references:
                      - string
                      employee_numbers:
                      - string
                      ytd_gross_pay: '22472.85'
                      ytd_net_pay: '18070.33'
                      ytd_tax_paid: '1100.63'
                      ytd_ni_paid: '1100.63'
                      ytd_pension_paid: '1100.63'
                      ytd_other_deductions: '1100.63'
                      additional_information:
                        bonuses:
                        - amount: '222.22'
                          date: '2024-01-01'
                        monthly_student_loan_deductions: '222.44'
                        monthly_gross_pay_details:
                        - category: MonthlyBasicPay
                          amount: '222.44'
                        monthly_deductions_details:
                        - category: MonthlyIncomeTax
                          amount: '167.15'
                        average_income_items:
                        - category: PayFromAllEmployments
                          value: '1971.42'
                        average_tax_items:
                        - category: Tax
                          short_description: Class 4 NIC
                          value: '1971.42'
                      income_source_addresses:
                      - summary_line: Flat 23, Sample Street, London
                        post_code: SW4 4PL
                      employee_addresses:
                      - summary_line: 19, Sample Street, London
                        post_code: SW1 1PN
                      income_data_sources:
                      - source_type: Payslip
                        number_of_sources: '1'
                        start_date: '2024-01-01'
                        end_date: '2024-02-01'
                        data_sources:
                        - source_name: Stmt - current - Feb 2023 - J Smith and J Hayley
                          source_id: 4b9ac393-d34b-4a14-9ee3-88ce2d244e90
                          source_category_type: Document
                          source_type: Payslip
                    data_sources:
                    - source_name: Stmt - current - Feb 2023 - J Smith and J Hayley
                      source_id: 4b9ac393-d34b-4a14-9ee3-88ce2d244e90
                      source_category_type: Document
                      source_type: Payslip
        '400':
          description: Entity Deleted/Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: d28a74a4-82e8-49d5-a84a-95f73ccc4bf7
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: be813fea-3ad6-4083-9e27-e693386dd73e
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 7a771ccf-e2c3-48a1-8554-ddee03ee4343
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 3bf2a265-4055-4342-baf8-c67273bc5b9f
components:
  schemas:
    ObtainTokenRequest:
      title: ObtainToken
      required:
      - grant_type
      - scope
      - client_id
      - client_secret
      type: object
      properties:
        grant_type:
          type: string
          description: The type of Oauth 2.0 grant. Must be set to `client_credentials`
          nullable: false
          example: client_credentials
        scope:
          type: string
          description: The scope of the token. Must be set to `https://api.sikoia.com/.default` for production and `https://api-staging.sikoia.com/.default`
            for staging
          nullable: false
          example: https://api.sikoia.com/.default
        client_id:
          type: string
          description: The client ID of your application
          format: uuid
          nullable: false
          example: e5ca26ec-f3a0-4d7f-bcf1-b6ebd5446aee
        client_secret:
          type: string
          description: The client secret that you created for your application
          nullable: false
          example: Yoa8Q@of26stihrz3~JfP4Wz6TGby0fJFT2^UcU0
      additionalProperties: false
    TokenResponse:
      title: Token Response
      type: object
      properties:
        access_token:
          type: string
          description: The access token in JWT format
          example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
        token_type:
          type: string
          description: The type of the token. Will be returned as `Bearer`
          example: Bearer
        not_before:
          type: integer
          description: Epoch timestamp of when the token is valid from
          example: '1729153756'
        expires_in:
          type: integer
          description: Expiry time of the token in seconds
          example: '3600'
        expires_on:
          type: integer
          description: Epoch timestamp of when the token expires
          example: '1729157356'
        resource:
          type: string
          description: fdd608dc-2f2f-48b1-aefe-3fed991f587e
          example: Audience of the token
      additionalProperties: false
    TokenErrorResponse:
      title: Token Error Response
      type: object
      properties:
        error:
          type: string
          enum:
          - invalid_request
          - invalid_client
          - invalid_grant
          - unauthorized_client
          - unsupported_grant_type
          - invalid_scope
          description: A string describing the error type.
          example: invalid_request
        error_description:
          type: string
          description: A more detailed description of the error.
          example: Invalid client secret is provided
      additionalProperties: false
    MicroserviceUserManagement.Resources.External.Role:
      type: object
      properties:
        name:
          type: string
          description: The role assigned to the user
          nullable: true
          readOnly: true
          example: Admin
        description:
          type: string
          description: A description of the role assigned to the user
          nullable: true
          readOnly: true
          example: Admin Role
      additionalProperties: false
    MicroserviceUserManagement.Resources.External.User:
      type: object
      properties:
        user_id:
          type: string
          description: Sikoia ID for the user
          format: uuid
          readOnly: true
          example: 592d6b22-a5d4-4226-b5a3-c374cf1a38fe
        first_name:
          type: string
          description: The user’s first name
          nullable: true
          example: John
        last_name:
          type: string
          description: The user’s last name
          nullable: true
          example: Smith
        email:
          type: string
          description: The user’s email address
          nullable: true
          example: john.smith@acme.com
        account_date_created:
          type: string
          description: The date the user was created
          format: date-time
          readOnly: true
          example: '2024-01-19T03:06:41.0000000+00:00'
        account_date_updated:
          type: string
          description: The date the user’s details were last updated
          format: date-time
          readOnly: true
          example: '2024-01-19T03:06:41.0000000+00:00'
        roles:
          type: array
          items:
            $ref: '#/components/schemas/MicroserviceUserManagement.Resources.External.Role'
          nullable: true
      additionalProperties: false
    MicroserviceUserManagement.Resources.SikoiaErrorResponse401:
      title: MicroserviceUserManagement.Resources.SikoiaErrorResponse
      type: object
      properties:
        type:
          type: string
          description: The error type
          readOnly: true
          example: InvalidToken
        status:
          type: integer
          description: HTTP status code of the error
          format: HttpCode
          readOnly: true
          example: '401'
        title:
          type: string
          description: A short description of the error
          readOnly: true
          example: Invalid Token
        detail:
          type: string
          description: More details about what went wrong
          readOnly: true
          example: Invalid token
        correlation_id:
          type: string
          description: Correlation ID, please include this in any support tickets raised
          readOnly: true
          example: a28d1abd-ad97-4a1f-bd14-6698c5214544
      additionalProperties: false
    MicroserviceUserManagement.Resources.SikoiaErrorResponse429:
      title: MicroserviceUserManagement.Resources.SikoiaErrorResponse
      type: object
      properties:
        type:
          type: string
          description: The error type
          readOnly: true
          example: RateLimit
        status:
          type: integer
          description: HTTP status code of the error
          format: HttpCode
          readOnly: true
          example: '429'
        title:
          type: string
          description: A short description of the error
          readOnly: true
          example: Too Many Requests
        detail:
          type: string
          description: More details about what went wrong
          readOnly: true
          example: You've exceeded the maximum API request limit per minute. Please try again later.
        correlation_id:
          type: string
          description: Correlation ID, please include this in any support tickets raised
          readOnly: true
          example: a28d1abd-ad97-4a1f-bd14-6698c5214544
      additionalProperties: false
    MicroserviceUserManagement.Resources.SikoiaErrorResponse500:
      title: MicroserviceUserManagement.Resources.SikoiaErrorResponse
      type: object
      properties:
        type:
          type: string
          description: The error type
          readOnly: true
          example: ServerError
        status:
          type: integer
          description: HTTP status code of the error
          format: HttpCode
          readOnly: true
          example: '500'
        title:
          type: string
          description: A short description of the error
          readOnly: true
          example: Internal Server Error
        detail:
          type: string
          description: More details about what went wrong
          readOnly: true
          example: Something has gone wrong, please try again
        correlation_id:
          type: string
          description: Correlation ID, please include this in any support tickets raised
          readOnly: true
          example: a28d1abd-ad97-4a1f-bd14-6698c5214544
      additionalProperties: false
    MicroserviceUserManagement.Resources.External.Webhook:
      required:
      - event_types
      - webhook_callback_url
      - webhook_name
      type: object
      properties:
        webhook_id:
          type: string
          format: uuid
          readOnly: true
        webhook_name:
          maxLength: 50
          minLength: 1
          type: string
          description: The user friendly, case sensitive, name for a webhook - it does not have to be unique
          example: Bank Statement Hook
        webhook_callback_url:
          maxLength: 2048
          minLength: 1
          type: string
          description: The absolute HTTPS URL that a POST request will be made to when the webhook is triggered
          example: https://yourdomain.com/webhook/
        external_ref:
          type: string
          description: Optional value if you need to associate a webhook instance with a reference in your system
          nullable: true
          example: IntRef001
        event_types:
          minItems: 1
          type: array
          items:
            type: string
          description: Supported events a webhook can subscribe to
          example: '["BankStatementProcessing.Completed"]'
        datetime_created:
          type: string
          description: 'UTC Date and time when the webhook was created, formatted: yyyy-MM-ddTHH:mm:ss.fffZ'
          format: date-time
          readOnly: true
          example: '2024-01-18T12:37:35.0000000+00:00'
        datetime_updated:
          type: string
          description: 'UTC Date and time when the webhook was last updated, formatted: yyyy-MM-ddTHH:mm:ss.fffZ'
          format: date-time
          readOnly: true
          example: '2024-01-18T12:37:35.0000000+00:00'
      additionalProperties: false
    MicroserviceUserManagement.Resources.SikoiaErrorResponse400:
      title: MicroserviceUserManagement.Resources.SikoiaErrorResponse
      type: object
      properties:
        type:
          type: string
          description: The error type
          readOnly: true
          example: InvalidRequest
        status:
          type: integer
          description: HTTP status code of the error
          format: HttpCode
          readOnly: true
          example: '400'
        title:
          type: string
          description: A short description of the error
          readOnly: true
          example: Validation Errors
        detail:
          type: string
          description: More details about what went wrong
          readOnly: true
          example: Entity Id is required.
        correlation_id:
          type: string
          description: Correlation ID, please include this in any support tickets raised
          readOnly: true
          example: a28d1abd-ad97-4a1f-bd14-6698c5214544
      additionalProperties: false
    MicroserviceUserManagement.Resources.SikoiaErrorResponse404:
      title: MicroserviceUserManagement.Resources.SikoiaErrorResponse
      type: object
      properties:
        type:
          type: string
          description: The error type
          readOnly: true
          example: ResourceNotFound
        status:
          type: integer
          description: HTTP status code of the error
          format: HttpCode
          readOnly: true
          example: '404'
        title:
          type: string
          description: A short description of the error
          readOnly: true
          example: Resource Not Found
        detail:
          type: string
          description: More details about what went wrong
          readOnly: true
          example: No resources found with id 6afd715b195c4d11b9e796bcdfbdfd9a.
        correlation_id:
          type: string
          description: Correlation ID, please include this in any support tickets raised
          readOnly: true
          example: a28d1abd-ad97-4a1f-bd14-6698c5214544
      additionalProperties: false
    MicroserviceUserManagement.Resources.External.WebhookUpdate:
      type: object
      properties:
        webhook_name:
          type: string
          description: The user friendly, case sensitive, name for a webhook - it does not have to be unique
          nullable: true
          example: Bank Statement Hook
        webhook_callback_url:
          type: string
          description: The absolute HTTPS URL that a POST request will be made to when the webhook is triggered
          nullable: true
          example: https://yourdomain.com/webhook/
        external_ref:
          type: string
          description: Optional value if you need to associate a webhook instance with a reference in your system
          nullable: true
          example: IntRef001
        event_types:
          type: array
          items:
            type: string
          description: Supported events a webhook can subscribe to
          nullable: true
          example: '["BankStatementProcessing.Completed"]'
      additionalProperties: false
    MicroserviceUserManagement.Resources.External.WebhookEventGroup:
      type: object
      properties:
        event_group_name:
          type: string
          description: The unique name that groups together a related hierarchy of event types
          readOnly: true
          example: Document Lifecycle
        event_types:
          type: array
          items:
            $ref: '#/components/schemas/MicroserviceUserManagement.Resources.External.WebhookEventType'
          description: The top most 'coarse' event types under a given group
          readOnly: true
          example: '[{"event_group_name":"Document Lifecycle","event_types":[{"event_name":"DocumentProcessing.Completed","event_types":[{"event_name":"BankStatementProcessing.Completed","event_types":[]}]}]}]'
      additionalProperties: false
    MicroserviceUserManagement.Resources.External.WebhookEventType:
      type: object
      properties:
        event_name:
          type: string
          description: The unique name of an event you can subscribe to notifications for
          readOnly: true
          example: DocumentProcessing.Completed
        event_types:
          type: array
          items: {}
          description: The event types that exist hierarchically under this current event type
          readOnly: true
          example: '[{"event_name":"BankStatementProcessing.Completed", "event_types":[{"event_name":"ExampleBankStatementProcessing.Completed",
            "event_types":[]}]}]'
      additionalProperties: false
    MicroserviceUserManagement.Domain.Model.Common.PaginationDirection:
      enum:
      - Forward
      - Backward
      type: string
    MicroserviceUserManagement.Domain.Model.Webhooks.WebhookEventStatusCode:
      enum:
      - NotRequested
      - Pending
      - Complete
      - Failed
      type: string
    MicroserviceUserManagement.Resources.External.PaginatedWebhookRequestsResponse:
      type: object
      properties:
        pagination_meta_data:
          $ref: '#/components/schemas/MicroserviceUserManagement.Resources.External._Shared.PaginationMetaData'
        webhook_requests:
          type: array
          items:
            $ref: '#/components/schemas/MicroserviceUserManagement.Resources.External.WebhookRequest'
          description: All known requests made for a given webhook limited to the page size specified in pagination_meta_data.page_size
          readOnly: true
      additionalProperties: false
      description: An ordered (most recent first) subset of webhook requests
    MicroserviceUserManagement.Resources.External.WebhookRequest:
      type: object
      properties:
        request_id:
          type: string
          description: The unique identifier of a single webhook request
          format: uuid
          readOnly: true
          example: 2bf8cbc7-b646-41ad-9881-4944ad2b786e
        grouping_id:
          type: string
          description: The identifier that groups related webhook requests triggered by the same event
          format: uuid
          readOnly: true
          example: 07322b4b-6739-486c-9eb4-5466a8bc1875
        event_type:
          type: string
          description: The specific event type that triggered a webhook request being sent
          readOnly: true
          example: BankStatementProcessing.Completed
        webhook_callback_url:
          type: string
          description: The URL that the request was made to
          example: https://yourdomain.com/webhook/
        datetime_created:
          type: string
          description: An optional value that indicates when a webhook was successfully received at a given callback url
          format: date-time
          nullable: true
          readOnly: true
          example: '2024-01-18T12:37:35.0000000+00:00'
        event_data:
          description: The exact event data sent in the body of the webhook request
          example: '{"key":"value","key2":"value2"]}'
        webhook_event_status:
          type: string
          description: The exact status a request has been marked with
          example: Complete
        request_attempts:
          type: array
          items:
            $ref: '#/components/schemas/MicroserviceUserManagement.Resources.External.WebhookRequestAttempt'
          description: Each unique attempt at delivering a webhook before a success response was returned
          example: '[{"attempt_id":"8b1391e4-7ace-41a2-a04b-55decffb9fe5","requested_on":"2024-01-18T12:37:35.053Z","http_response_code":200}]'
      additionalProperties: false
      description: Represents a historic request made after a webhook was triggered by event in the Sikoia platform
    MicroserviceUserManagement.Resources.External.WebhookRequestAttempt:
      type: object
      properties:
        attempt_id:
          type: string
          description: The unique identifier of each attempt to send a request
          format: uuid
          example: 8b1391e4-7ace-41a2-a04b-55decffb9fe5
        datetime_created:
          type: string
          description: The date and time a request was attempted
          format: date-time
          example: '2024-01-18T12:37:35.0000000+00:00'
        http_response_code:
          type: integer
          description: The HTTP response code we received back from a given request attempt
          format: int32
          example: '200'
      additionalProperties: false
      description: Represents each attempt made to deliver a webhook request to a callback URL
    MicroserviceUserManagement.Resources.External._Shared.PaginationMetaData:
      type: object
      properties:
        next_page_url:
          type: string
          description: A pre-formatted URL containing the location of the next ordered page of data
          nullable: true
          readOnly: true
          example: https://api.sikoia.com/v2/{resource}?after_request_id=354c8709-8941-4a8e-a614-a618555034a0&pagination_direction=Forward
        previous_page_url:
          type: string
          description: A pre-formatted URL containing the location of the previous ordered page of data
          nullable: true
          readOnly: true
          example: https://api.sikoia.com/v2/{resource}?after_request_id=354c8709-8941-4a8e-a614-a618555034a0&pagination_direction=Backward
        page_size:
          type: integer
          description: The maxium number of items that may be returned in a given page (the actual number may be equal to
            or less than)
          format: int32
          readOnly: true
          example: '25'
        page_count:
          type: integer
          description: ' Number of records in the current page (will be less than or equal to page_size)'
          format: int32
          readOnly: true
          example: '5'
      additionalProperties: false
      description: Basic structure for keyset pagination results
    MicroserviceUserManagement.Resources.External.WebhookSecret:
      type: object
      properties:
        shared_key:
          type: string
          description: The UTF8 encoded value used as the key in the SHA256 hash.
          readOnly: true
        date_created:
          type: string
          description: 'The timestamp for when the secret started being used to add a HMACSHA256 header to all webhook requests.
            Formatted: yyyy-MM-ddTHH:mm:ss.fffZ'
          format: date-time
          readOnly: true
        date_updated:
          type: string
          description: 'The timestamp for when the key last changed. If a key is rotated this will be different to the date_created.
            Formatted: yyyy-MM-ddTHH:mm:ss.fffZ'
          format: date-time
          readOnly: true
      additionalProperties: false
      description: The current secret used as the shared key for the HMACSHA256 header.
    MicroserviceUserManagement.Resources.SikoiaErrorResponse409:
      title: MicroserviceUserManagement.Resources.SikoiaErrorResponse
      type: object
      properties:
        type:
          type: string
          description: The error type
          readOnly: true
          example: UnprocessableRequest
        status:
          type: integer
          description: HTTP status code of the error
          format: HttpCode
          readOnly: true
          example: '409'
        title:
          type: string
          description: A short description of the error
          readOnly: true
          example: Cannot create multiple webhook secrets
        detail:
          type: string
          description: More details about what went wrong
          readOnly: true
          example: Only one webhook secret is supported. Please refer to the API docs on how to either rotate the existing
            key value or delete it from the system.
        correlation_id:
          type: string
          description: Correlation ID, please include this in any support tickets raised
          readOnly: true
          example: a28d1abd-ad97-4a1f-bd14-6698c5214544
      additionalProperties: false
    SikoiaCore.Common.SikoiaErrorResponse:
      title: Error Response
      type: object
      properties:
        type:
          type: string
          description: The error type
          readOnly: true
        status:
          type: integer
          description: HTTP status code of the error
          format: HttpCode
          readOnly: true
        title:
          type: string
          description: A short description of the error
          readOnly: true
        detail:
          type: string
          description: More details about what went wrong
          readOnly: true
        correlation_id:
          type: string
          description: Correlation ID, please include this in any support tickets raised
          readOnly: true
      additionalProperties: false
      description: 'See the [Response Guide](https://docs.sikoia.com/docs/api-behaviour#responses) for more detail '
    SikoiaSharedModels.CaseManagement.Responses.CasesResponse:
      title: Cases Record
      type: object
      properties:
        case_id:
          type: string
          description: Sikoia ID for the case
          format: uuid
          readOnly: true
          example: 64cd8202-2db4-44d5-85be-79438d65eb7b
        name:
          type: string
          description: Name of the case
          example: Acme Ltd Loan Application
        case_type:
          enum:
          - Business
          - Consumer
          type: string
          description: The type of case
          example: Business
        stage:
          enum:
          - New
          - InProgressWaitingCustomer
          - InProgressNeedsReview
          - Approved
          - Rejected
          - Dormant
          type: string
          description: The stage of the case
          example: New
        datetime_created:
          type: string
          description: The time the case was created
          format: date-time
          readOnly: true
          example: '2023-02-10T10:59:46.0000000+00:00'
        datetime_last_modified:
          type: string
          description: The time the case was last modified
          format: date-time
          readOnly: true
          example: '2023-02-12T01:04:21.0000000+00:00'
        reference:
          type: string
          description: Your external reference for the case
          nullable: true
          example: LOAN03584
        reference_customer_id:
          type: string
          description: Your external reference for the ID of the customer the case belongs to
          nullable: true
          example: CUST67044
        reference_customer_name:
          type: string
          description: Your external reference for the name of the customer the case belongs to
          nullable: true
          example: Building Society Ltd
        description:
          type: string
          description: The description for the case
          nullable: true
          example: Acme Ltd looking to borrow money to fund a new fleet of delivery vehicles.
        source:
          type: string
          description: The source of the case, this defaults to `API`
          nullable: true
          example: API
        owner:
          type: string
          description: The owner of the case
          nullable: true
          example: Cecilia Adams
          deprecated: true
        ownership:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Responses.Owner'
          description: The list of owners of the case
          nullable: true
        number_of_companies:
          type: integer
          description: Number of Companies in the Case
          format: int32
          readOnly: true
          example: '2'
        number_of_persons:
          type: integer
          description: Number of People in the Case
          format: int32
          readOnly: true
          example: '5'
      additionalProperties: false
    SikoiaSharedModels.CaseManagement.Responses.Owner:
      type: object
      properties:
        owner_id:
          type: string
          description: The case owner id
          nullable: true
          example: 6a9f8d73-29f4-4a6a-80dc-21b8cbecff75
        owner_type:
          enum:
          - User
          type: string
          description: The type of owner. This should be set to 'user'
          nullable: true
          example: user
      additionalProperties: false
    SikoiaSharedModels.CaseManagement.Requests.CreateCaseRequest:
      title: Create Case
      required:
      - case_type
      - name
      type: object
      properties:
        name:
          minLength: 1
          type: string
          description: Name of the case
          example: Acme Ltd Loan Application
        case_type:
          enum:
          - Business
          - Consumer
          type: string
          description: The type of case
          example: Business
        stage:
          enum:
          - New
          - InProgressWaitingCustomer
          - InProgressNeedsReview
          - Approved
          - Rejected
          - Dormant
          type: string
          description: The stage of the case, this defaults to `New`
          nullable: true
          example: New
        reference:
          type: string
          description: Your external reference for the case
          nullable: true
          example: LOAN03584
        reference_customer_id:
          type: string
          description: Your external reference for the ID of the customer the case belongs to
          nullable: true
          example: CUST67044
        reference_customer_name:
          type: string
          description: Your external reference for the name of the customer the case belongs to
          nullable: true
          example: Building Society Ltd
        owner:
          type: string
          description: The current owner of the case
          nullable: true
          example: Cecilia Adams
          deprecated: true
        ownership:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Responses.Owner'
          description: The list of owner model of the case
          nullable: true
        description:
          type: string
          description: The description of the case
          nullable: true
          example: Acme Ltd looking to borrow money to fund a new fleet of delivery vehicles.
        source:
          type: string
          description: The source of the case creation, this defaults to `API`
          nullable: true
          example: API
        companies:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Requests.Models.CaseCompanyRecord'
          description: The list of companies to add to the case
          nullable: true
        persons:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Requests.Models.CasePersonRecord'
          description: The list of people to add to the case
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CaseManagement.Requests.Models.CaseCompanyRecord:
      title: Company
      required:
      - company_name
      type: object
      properties:
        company_name:
          minLength: 1
          type: string
          description: The name of the company
          example: Acme Limited
        company_number:
          type: string
          description: The company registration number
          nullable: true
          example: '77642080'
        jurisdiction_code:
          pattern: ^\w{2}(_\w{2})?$
          type: string
          description: The jurisdiction of the company as a two letter country code (optionally, the state can be included
            separated by `_`)
          nullable: true
          example: GB
        registry_search:
          type: boolean
          description: Search registries for the company details, defaults to `false`
        add_directors:
          type: boolean
          description: Add directors to the list of people on the case, `registry_search` must be `true`, defaults to `false`
      additionalProperties: false
    SikoiaSharedModels.CaseManagement.Requests.Models.CasePersonRecord:
      title: Person
      required:
      - first_name
      - last_name
      type: object
      properties:
        first_name:
          minLength: 1
          type: string
          description: The person's first name
          example: Wilson
        last_name:
          minLength: 1
          type: string
          description: The person's last name
          example: Pascale
        email:
          type: string
          description: The person's email address
          format: email
          nullable: true
          example: wislon@acme.ltd.uk
        postal_address:
          $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Requests.Models.PostalAddressRequestModel'
        date_of_birth:
          type: string
          description: The person's date of birth
          nullable: true
          example: '1985-06-12'
        employer:
          type: string
          description: The name of the person's employer
          nullable: true
          example: Acme Limited
        is_officer:
          type: boolean
          description: Whether the person is an officer of their employer
          readOnly: true
        reference_person_id:
          type: string
          description: Your external reference for the ID of the person/applicant in the case
          nullable: true
          example: Wilson5432
      additionalProperties: false
    SikoiaSharedModels.CaseManagement.Requests.Models.PostalAddressRequestModel:
      title: Address
      type: object
      properties:
        house_number:
          type: string
          description: The building or house number
          nullable: true
          example: '123'
        building_name:
          type: string
          description: The building or house name
          nullable: true
          example: Main House
        sub_building_name:
          type: string
          description: The name of the sub-building
          nullable: true
        address_line_1:
          type: string
          description: The first line of the postal address, typically used for the street address
          nullable: true
          example: Main Street
        address_line_2:
          type: string
          description: The second line of the postal address, typically used for additional information such as apartment
            or suite number
          nullable: true
          example: Apt.101
        locality:
          type: string
          description: The locality of the postal address
          nullable: true
          example: Test County
        city:
          type: string
          description: The city of the postal address
          nullable: true
          example: Test Town
        post_code:
          type: string
          description: The post code for the address. This is sometimes also referred to as postal code, ZIP code, Postal
            Index Number, or Eircode.
          nullable: true
          example: X9 9AA
        country:
          type: string
          description: Two letter ISO country code
          nullable: true
          example: GB
      additionalProperties: false
    SikoiaSharedModels.CaseManagement.Responses.CaseResponse:
      title: Case Record
      type: object
      properties:
        case_id:
          type: string
          description: Sikoia ID for the case
          format: uuid
          readOnly: true
          example: 64cd8202-2db4-44d5-85be-79438d65eb7b
        name:
          type: string
          description: Name of the case
          example: Acme Ltd Loan Application
        case_type:
          enum:
          - Business
          - Consumer
          type: string
          description: The type of case
          example: Business
        stage:
          enum:
          - New
          - InProgressWaitingCustomer
          - InProgressNeedsReview
          - Approved
          - Rejected
          - Dormant
          type: string
          description: The stage of the case
          example: New
        datetime_created:
          type: string
          description: The time the case was created
          nullable: true
          readOnly: true
          example: '2023-02-10T10:59:46.026Z'
        datetime_last_modified:
          type: string
          description: The time the case was last modified
          nullable: true
          readOnly: true
          example: '2023-02-12T13:04:21.326Z'
        reference:
          type: string
          description: Your external reference for the case
          nullable: true
          example: LOAN03584
        reference_customer_id:
          type: string
          description: Your external reference for the ID of the customer the case belongs to
          nullable: true
          example: CUST67044
        reference_customer_name:
          type: string
          description: Your external reference for the name of the customer the case belongs to
          nullable: true
          example: Building Society Ltd
        description:
          type: string
          description: The description for the case
          nullable: true
          example: Acme Ltd looking to borrow money to fund a new fleet of delivery vehicles.
        source:
          type: string
          description: The source of the case, this defaults to `API`
          nullable: true
          example: API
        owner:
          type: string
          description: The owner of the case
          nullable: true
          example: Cecilia Adams
          deprecated: true
        ownership:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Responses.Owner'
          description: The list of owners of the case
          nullable: true
        number_of_companies:
          type: integer
          description: Number of companies in the case
          format: int32
          readOnly: true
          example: '2'
        number_of_persons:
          type: integer
          description: Number of people in the case
          format: int32
          readOnly: true
          example: '5'
        companies:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Responses.CompanyRecordResponseModel'
          nullable: true
        persons:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Responses.PersonRecordResponseModel'
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CaseManagement.Responses.CompanyRecordResponseModel:
      title: Company
      type: object
      properties:
        company_id:
          type: string
          description: Sikoia ID for the company
          format: uuid
          readOnly: true
          example: a035d37a-dee1-4a4e-b098-168a6a1f4603
        company_name:
          type: string
          description: The name of the company
          example: Acme Limited
        company_number:
          type: string
          description: The company registration number
          nullable: true
          example: '77642080'
        jurisdiction_code:
          type: string
          description: The jurisdiction of the company as a two letter country code (optionally, the state can be included
            separated by `_`)
          nullable: true
          example: GB
        status:
          type: string
          description: The operational status of the company, defaults to `unknown`
          readOnly: true
          example: Active
        number_of_officers:
          type: integer
          description: The number of officers
          format: int32
          readOnly: true
          example: '5'
        number_of_owners:
          type: integer
          description: The number of owners
          format: int32
          readOnly: true
          example: '2'
        media_adverse_requested:
          type: boolean
          deprecated: true
        pep_sanction_requested:
          type: boolean
          deprecated: true
      additionalProperties: false
    SikoiaSharedModels.CaseManagement.Responses.PersonRecordResponseModel:
      title: Person
      type: object
      properties:
        person_id:
          type: string
          description: Sikoia ID for the person
          format: uuid
          nullable: true
          readOnly: true
          example: 8303ce21-3120-4981-9a19-560ef110502b
        first_name:
          type: string
          description: The person's first name
          nullable: true
          example: Wilson
        last_name:
          type: string
          description: The person's last name
          nullable: true
          example: Pascale
        name:
          type: string
          description: The person's full name
          nullable: true
          readOnly: true
          example: Wilson Pascale
        email:
          type: string
          description: The person's email address
          format: email
          nullable: true
          example: wislon@acme.ltd.uk
        postal_address:
          $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Responses.PostalAddressResponseModel'
        date_of_birth:
          type: string
          description: The person's date of birth
          format: date
          nullable: true
          example: '1985-06-12'
        employer:
          type: string
          description: The name of the person's employer
          nullable: true
          example: Acme Limited
        is_officer:
          type: boolean
          description: Whether the person is an officer of their employer
          readOnly: true
        appointments:
          type: string
          nullable: true
        reference_person_id:
          type: string
          description: Your external reference for the ID of the person/applicant in the case
          nullable: true
          example: Wilson5432
        media_adverse_requested:
          type: boolean
          deprecated: true
        pep_sanction_requested:
          type: boolean
          deprecated: true
      additionalProperties: false
    SikoiaSharedModels.CaseManagement.Responses.PostalAddressResponseModel:
      title: Address
      type: object
      properties:
        house_number:
          type: string
          description: The building or house number
          nullable: true
          example: '123'
        building_name:
          type: string
          description: The building or house name
          nullable: true
          example: Main House
        sub_building_name:
          type: string
          description: The name of the sub-building
          nullable: true
        address_line_1:
          type: string
          description: The first line of the postal address, typically used for the street address.
          nullable: true
          example: Main Street
        address_line_2:
          type: string
          description: The second line of the postal address, typically used for additional information such as apartment
            or suite number.
          nullable: true
          example: Apt. 101
        locality:
          type: string
          description: The locality of the postal address.
          nullable: true
          example: Test Country
        city:
          type: string
          description: The city of the postal address.
          nullable: true
          example: Test Town
        post_code:
          type: string
          description: The post code for the address. This is sometimes also referred to as postal code, ZIP code, Postal
            Index Number, or Eircode.
          nullable: true
          example: X9 9AA
        country:
          type: string
          description: Two letter ISO country code
          nullable: true
          example: GB
        summary_line:
          type: string
          nullable: true
          example: 123, Main Street, Main House, Apt. 101, Test County, Test Town, X9 9AA, GB
      additionalProperties: false
    SikoiaSharedModels.CaseManagement.Requests.UpdateCaseRequest:
      title: Update Case
      type: object
      properties:
        name:
          type: string
          description: Name of the case
          nullable: true
          example: Acme Ltd 2nd Loan Application
        stage:
          enum:
          - New
          - InProgressWaitingCustomer
          - InProgressNeedsReview
          - Approved
          - Rejected
          - Dormant
          type: string
          description: The stage of the case
          nullable: true
          example: Approved
        reference:
          type: string
          description: Your external reference for the case
          nullable: true
          example: LOAN03584
        reference_customer_id:
          type: string
          description: Your external reference for the ID of the customer the case belongs to
          nullable: true
          example: CUST67044
        reference_customer_name:
          type: string
          description: Your external reference for the name of the customer the case belongs to
          nullable: true
          example: Building Society Ltd
        description:
          type: string
          description: The description of the case
          nullable: true
          example: Acme Ltd looking for another loan
        source:
          type: string
          description: The source of the case creation, this defaults to `API`
          nullable: true
          example: API
        owner:
          type: string
          description: The current owner of the case
          nullable: true
          example: Katerina Valentin
          deprecated: true
        ownership:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Responses.Owner'
          description: The list of owner model of the case
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CaseManagement.Requests.AddEntitiesToCaseRequest:
      title: Add Entities
      type: object
      properties:
        companies:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Requests.Models.CaseCompanyRecord'
          description: List of companies to add
          nullable: true
        persons:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Requests.Models.CasePersonRecord'
          description: List of people to add
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CaseManagement.Requests.Models.UpdateCaseEntitiesCompanyRequestModel:
      title: Company
      required:
      - company_id
      type: object
      properties:
        company_id:
          type: string
          description: Sikoia ID for the company
          format: uuid
          example: a035d37a-dee1-4a4e-b098-168a6a1f4603
        company_name:
          type: string
          description: The name of the company
          nullable: true
          example: Acme Limited
        company_number:
          type: string
          description: The company registration number
          nullable: true
          example: '77642080'
        jurisdiction_code:
          pattern: ^\w{2}(_\w{2})?$
          type: string
          description: The jurisdiction of the company as a two letter country code (optionally, the state can be included
            separated by `_`)
          nullable: true
          example: GB
      additionalProperties: false
    SikoiaSharedModels.CaseManagement.Requests.Models.UpdateCaseEntitiesPersonRequestModel:
      title: Person
      required:
      - person_id
      type: object
      properties:
        person_id:
          type: string
          description: Sikoia ID for the person
          format: uuid
          example: 8303ce21-3120-4981-9a19-560ef110502b
        first_name:
          type: string
          description: The person's first name
          nullable: true
          example: Wilson
        last_name:
          type: string
          description: The person's last name
          nullable: true
          example: Pascale
        email:
          type: string
          description: The person's email address
          format: email
          nullable: true
          example: wislon@acme.ltd.uk
        postal_address:
          $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Requests.Models.PostalAddressRequestModel'
        date_of_birth:
          type: string
          description: The person's date of birth
          format: date
          nullable: true
          example: '1985-06-12'
        employer:
          type: string
          description: The name of the person's employer
          nullable: true
          example: Acme Limited
        reference_person_id:
          type: string
          description: Your external reference for the ID of the person/applicant in the case
          nullable: true
          example: Wilson5432
      additionalProperties: false
    SikoiaSharedModels.CaseManagement.Requests.UpdateCaseEntitiesRequest:
      title: Update Entities
      type: object
      properties:
        companies:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Requests.Models.UpdateCaseEntitiesCompanyRequestModel'
          description: List of companies to update
          nullable: true
        persons:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CaseManagement.Requests.Models.UpdateCaseEntitiesPersonRequestModel'
          description: List of people to update
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CaseManagement.Requests.DeleteCaseEntityRequest:
      title: Delete Entities
      type: object
      properties:
        companies:
          type: array
          items:
            type: string
          description: List of company IDs to delete
          format: uuid
          nullable: true
          example: '["ddf1d8ef-2cca-41ef-89c1-00fb0c05c54f"]'
        persons:
          type: array
          items:
            type: string
          description: List of person IDs to delete
          format: uuid
          nullable: true
          example: '["c28c88d6-7fb5-4c2f-a5a1-559cd2675293"]'
      additionalProperties: false
    SikoiaSharedModels.Company.External.Request.RegistryDataRequest:
      title: Registry Data Request
      required:
      - company_id
      type: object
      properties:
        company_id:
          minLength: 1
          type: string
          description: Sikoia ID for the Company
          example: 78662640-73fc-4fa9-8367-ef4660d35cee
        company_number:
          type: string
          description: The company registration number
          nullable: true
          example: '12345678'
        company_name:
          type: string
          description: The legal name of the company
          nullable: true
          example: Acme Inc
        country_code:
          type: string
          description: Two letter ISO country code, e.g. GB
          nullable: true
          example: GB
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.CompanySearchMappedResponse:
      title: Company Search Response
      type: object
      properties:
        index:
          type: integer
          description: The index of the company
          format: int32
          nullable: true
          example: '1'
        company_name:
          type: string
          description: The legal name of the company
          nullable: true
          example: ACME INC
        company_number:
          type: string
          description: The company registration number
          nullable: true
          example: '12345678'
        company_status:
          type: string
          description: The operational status of the company
          nullable: true
          example: Active
        provider_id:
          type: string
          description: The data provider’s ID for the company
          nullable: true
        date_established:
          type: string
          description: The date the company was established
          nullable: true
          example: '1982-01-07'
        country_code:
          type: string
          description: Two letter ISO country code, e.g. GB
          nullable: true
          example: GB
        branch_status:
          type: string
          description: The branch status of the company
          nullable: true
        official_address:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.OfficialAddress'
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.OfficialAddress:
      title: Official Address
      type: object
      properties:
        address_line_1:
          type: string
          description: The First Line of Address
          nullable: true
          example: 10 Main Street
        address_line_2:
          type: string
          description: The Second Line of Address
          nullable: true
          example: Apt. 101
        address_line_3:
          type: string
          description: The Third Line of Address
          nullable: true
          example: Main House
        address_line_4:
          type: string
          description: The Fourth Line of Address
          nullable: true
        city:
          type: string
          description: The Name of the City
          nullable: true
          example: Test Town
        region:
          type: string
          description: The Name of the Region
          nullable: true
          example: Test Country
        country:
          type: string
          description: The Name of the Country
          nullable: true
          example: GB
        post_code:
          type: string
          description: The PostCode of the Address
          nullable: true
          example: X9 9AA
        full_address:
          type: string
          description: The Full Address
          nullable: true
          example: 123 Main Street, Main House, Apt. 101, Test County, Test Town, X9 9AA, GB
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.RegistryDataResponse:
      title: Registry Data Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          format: uuid
          readOnly: true
          example: 276c102b-85d3-4e86-a69d-de1b2ba72150
        status:
          type: string
          description: The status of the request(`Complete` `Failed` `TooManyResults`)
          nullable: true
          example: Complete
        company_id:
          type: string
          description: Sikoia ID for the Company
          format: uuid
          readOnly: true
          example: 78662640-73fc-4fa9-8367-ef4660d35cee
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          readOnly: true
          example: '2024-02-12T13:18:28.978Z'
        message:
          type: string
          description: Additional detail about the request
          nullable: true
        company_number:
          type: string
          description: The company registration number
          nullable: true
          example: '12345678'
        company_name:
          type: string
          description: The legal name of the company
          nullable: true
          example: Acme Inc
        country_code:
          type: string
          description: Two letter ISO country code, e.g. GB
          nullable: true
          example: GB
        picklist:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.CompanySearchMappedResponse'
          description: If the response status is “TooManyResults”, this object will list the potential matches for the company
          nullable: true
          example: '[]'
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.RegistryDataListResponse:
      title: Registry Data List Response
      type: object
      properties:
        company_id:
          type: string
          description: Sikoia ID for the Company
          format: uuid
          readOnly: true
          example: 78662640-73fc-4fa9-8367-ef4660d35cee
        registry_data_requests:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.RegistryDataOrchestrationResponse'
          description: The list of all registry data requests for the company
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.RegistryDataOrchestrationResponse:
      title: Registry Data Orchestration Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          format: uuid
          readOnly: true
          example: 276c102b-85d3-4e86-a69d-de1b2ba72150
        status:
          type: string
          description: The status of the request(`Complete` `Failed` `TooManyResults`)
          nullable: true
          example: Complete
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          readOnly: true
          example: '2024-02-12T13:18:28.978Z'
        message:
          type: string
          description: Additional detail about the request
          nullable: true
        company_number:
          type: string
          description: The company registration number
          nullable: true
          example: '12345678'
        company_name:
          type: string
          description: The legal name of the company
          nullable: true
          example: Acme Inc
        country_code:
          type: string
          description: Two letter ISO country code, e.g. GB
          nullable: true
          example: GB
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.Accounts:
      title: Accounts
      type: object
      properties:
        last_accounts:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.LastAccounts'
        next_accounts:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.NextAccounts'
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.Charge:
      title: Charge
      type: object
      properties:
        charge_code:
          type: string
          description: The Charge Code
          nullable: true
        status:
          type: string
          description: The Status
          nullable: true
        created_on:
          type: string
          description: Charge Created On
          nullable: true
        delivered_on:
          type: string
          description: Charge Delivered On
          nullable: true
        satisfied_on:
          type: string
          description: Charge Satisfied On
          nullable: true
        details:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.Details'
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.Transaction'
          description: List of Transactions
          nullable: true
        classification:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.Classification'
        persons_entitled:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.PersonEntitled'
          description: Persons Entitled
          nullable: true
        secured_details:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.SecuredDetails'
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.Classification:
      title: Classification
      type: object
      properties:
        type:
          type: string
          description: The Classification Type
          nullable: true
        description:
          type: string
          description: The Classification Description
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.CompanyOfficer:
      title: Company Officer
      type: object
      properties:
        source_id:
          type: string
          description: The Source ID
          nullable: true
          readOnly: true
        officer_role:
          type: string
          description: The Role of the Officer
          nullable: true
        date_appointed:
          type: string
          description: The Date when Officer was Appointed
          nullable: true
        date_resigned:
          type: string
          description: The Date when Officer Resigned
          nullable: true
        status:
          type: string
          description: The Status
          nullable: true
        name:
          type: string
          description: The Name of the Company Officer
          nullable: true
        address:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.OfficialAddress'
        occupation:
          type: string
          description: The Occupation of the Officer
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.CompanyOwner:
      title: Company Owner
      type: object
      properties:
        source_id:
          type: string
          description: The Source ID
          nullable: true
          readOnly: true
        name:
          type: string
          description: The Name of the Company Owner
          nullable: true
        type:
          type: string
          description: The Type of the Company Owner
          nullable: true
        date_from:
          type: string
          description: The Date From
          nullable: true
        date_to:
          type: string
          description: The Date To
          nullable: true
        natures_of_control:
          type: array
          items:
            type: string
          description: List of Natures of Control
          nullable: true
        address:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.OfficialAddress'
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.Details:
      title: Details
      type: object
      properties:
        type:
          type: string
          description: The Details Type
          nullable: true
        description:
          type: string
          description: The Details Description
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.Filing:
      title: Filing
      type: object
      properties:
        category:
          type: string
          description: The Filing Category
          nullable: true
        description:
          type: string
          description: The Filing Description
          nullable: true
        type:
          type: string
          description: Filing Type
          nullable: true
        filing_date:
          type: string
          description: Filing Date
          nullable: true
          readOnly: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.IndustryCode:
      title: Industry Code
      type: object
      properties:
        code:
          type: string
          description: The Industry Code
          nullable: true
        description:
          type: string
          description: The Industry Description
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.Insolvency:
      title: Insolvency
      type: object
      properties:
        type:
          type: string
          description: Type of Insolvency
          nullable: true
        dates:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.InsolvencyDate'
          description: List of Insolvency Dates
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.InsolvencyDate:
      title: Insolvency Date
      type: object
      properties:
        date:
          type: string
          description: Date of Insolvency
          nullable: true
        type:
          type: string
          description: Type of Insolvency Date
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.LastAccounts:
      title: Last Accounts
      type: object
      properties:
        made_up_to:
          type: string
          description: Last Accounts Made Up To
          nullable: true
        period_start:
          type: string
          description: Period Start for Last Accounts
          nullable: true
        period_end:
          type: string
          description: Period End for Last Accounts
          nullable: true
        type:
          type: string
          description: Type
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.NextAccounts:
      title: Next Accounts
      type: object
      properties:
        overdue:
          type: boolean
          description: Is Next Accounts Overdue?
          nullable: true
        period_start:
          type: string
          description: Start Period for Next Accounts
          nullable: true
        period_end:
          type: string
          description: End Period for Next Accounts
          nullable: true
        due_date:
          type: string
          description: Due Date for Next Accounts
          nullable: true
          readOnly: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.Officers:
      title: Officers
      type: object
      properties:
        people:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.PersonOfficer'
          description: The List of People
          nullable: true
        companies:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.CompanyOfficer'
          description: The List of Companies
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.Owners:
      title: Owners
      type: object
      properties:
        people:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.PersonOwner'
          description: The List of People
          nullable: true
        companies:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.CompanyOwner'
          description: The List of Companies
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.PersonEntitled:
      title: Person Entitled
      type: object
      properties:
        name:
          type: string
          description: Name of the Entitled Person
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.PersonOfficer:
      title: Person Officer
      type: object
      properties:
        source_id:
          type: string
          description: The Source ID
          format: uuid
          nullable: true
          readOnly: true
        officer_role:
          type: string
          description: The Role of the Officer
          nullable: true
        date_appointed:
          type: string
          description: The Date when Officer was Appointed
          nullable: true
        date_resigned:
          type: string
          description: The Date when Officer Resigned
          nullable: true
        status:
          type: string
          description: The Status
          nullable: true
        tax_id:
          type: string
          description: The Tax ID
          nullable: true
        first_name:
          type: string
          description: The Firstname of the Officer
          nullable: true
        surname:
          type: string
          description: The Surname of the Officer
          nullable: true
        full_name:
          type: string
          description: The Full Name of the Officer
          nullable: true
        date_of_birth:
          type: string
          description: The Date of Birth of the Officer
          nullable: true
          readOnly: true
        birth_year:
          type: integer
          description: The Year of Birth
          format: int32
          nullable: true
        birth_month:
          type: integer
          description: The Month of Birth
          format: int32
          nullable: true
        birth_day:
          type: integer
          description: The Day of Birth
          format: int32
          nullable: true
        nationality:
          type: string
          description: The Day of Birth
          nullable: true
        address:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.OfficialAddress'
        occupation:
          type: string
          description: The Occupation of the Officer
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.PersonOwner:
      title: Person Owner
      type: object
      properties:
        source_id:
          type: string
          description: The Source ID
          nullable: true
          readOnly: true
        first_name:
          type: string
          description: The Firstname of the Owner
          nullable: true
        surname:
          type: string
          description: The Surname of the Owner
          nullable: true
        full_name:
          type: string
          description: The Full Name of the Owner
          nullable: true
        type:
          type: string
          description: The Type of the Owner
          nullable: true
        date_from:
          type: string
          description: The Date From
          nullable: true
        date_to:
          type: string
          description: The Date To
          nullable: true
        natures_of_control:
          type: array
          items:
            type: string
          description: List of Natures of Control
          nullable: true
        date_of_birth:
          type: string
          description: The Date of Birth of the Owner
          nullable: true
          readOnly: true
        birth_year:
          type: integer
          description: The Year of Birth of the Owner
          format: int32
          nullable: true
        birth_month:
          type: integer
          description: The Month of Birth of the Owner
          format: int32
          nullable: true
        birth_day:
          type: integer
          description: The Day of Birth of the Owner
          format: int32
          nullable: true
        nationality:
          type: string
          description: The Nationality of the Owner
          nullable: true
        address:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.OfficialAddress'
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.PreviousCompanyName:
      title: Previous Company Name
      type: object
      properties:
        company_name:
          type: string
          description: Name of a Company
          nullable: true
        date_from:
          type: string
          description: From Date
          nullable: true
        date_to:
          type: string
          description: To Date
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.RegistryData:
      title: Registry Data
      type: object
      properties:
        company_name:
          type: string
          description: The legal name of the company
          nullable: true
        company_number:
          type: string
          description: The company registration number
          nullable: true
        status:
          type: string
          description: "The Sikoia standardised company status. Possible values are:\n- **Active**: The company is actively\
            \ trading.\n- **Restricted**: The company is not dissolved, but it's not trading normally. This includes companies\
            \ in Administration, Liquidation or Dormant. Companies whose filings have some irregularity will also have this\
            \ status.\n- **Closed**: The company has been dissolved. Merged companies will also have this status. \n- **Other**:\
            \ The registry status could not be mapped to any of the above. \n"
          nullable: true
        registry_status:
          type: string
          description: The Registry Status
          nullable: true
        registry_name:
          type: string
          description: The Registry Name
          nullable: true
        registry_url:
          type: string
          description: The Registry URL
          nullable: true
        data_provider:
          type: string
          description: The Data Provider
          nullable: true
        generic_legal_form:
          type: string
          description: "The Sikoia standardised legal form. Possible values are:\n- **Public Company**: A company whose ownership\
            \ is distributed amongst general public shareholders through publicly-traded stock shares.\n- **Limited Company**:\
            \ A private company whose owners are legally responsible for its debts only to the extent of the amount of capital\
            \ they invested.\n- **Partnership**: A business owned by two or more people who share profits and losses.\n- **Investment\
            \ Company**: A regulated entity that pools and manages investors' capital, investing in securities and other financial\
            \ instruments.\n- **Cooperative**: A business owned and operated by its members for their mutual benefit.\n- **Sole\
            \ Proprietorship**: A type of business owned and operated by a single person.\n- **Government Entity**: A legal\
            \ entity created by a government to carry out a specific function or service.\n- **Other**: The registry legal\
            \ form could not be mapped to any of the above. \n"
          nullable: true
        registry_legal_form:
          type: string
          description: The Registry Legal Form
          nullable: true
        country_code:
          type: string
          description: The Country Code
          nullable: true
        date_established:
          type: string
          description: The Established Date
          nullable: true
          readOnly: true
        date_dissolved:
          type: string
          description: The Dissolved Date
          nullable: true
          readOnly: true
        official_address:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.OfficialAddress'
        summary_info:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.SummaryInfo'
        special_characteristics:
          type: array
          items:
            type: string
          description: List of Special Characteristic
          nullable: true
        previous_company_names:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.PreviousCompanyName'
          description: List of Previous Company Name
          nullable: true
        accounts:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.Accounts'
        industry_codes:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.IndustryCode'
          description: List of Industry Codes
          nullable: true
        officers:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.Officers'
        owners:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.Owners'
        filings:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.Filing'
          description: List of Filings
          nullable: true
        charges:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.Charge'
          description: List of Charges
          nullable: true
        insolvencies:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.Insolvency'
          description: List of Insolvencies
          nullable: true
        controlling_entity:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.RelatedCompany'
        foreign_controlling_entity:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.RelatedCompany'
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.RegistryDataMappedResponse:
      title: Registry Data Mapped Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          format: uuid
          nullable: true
          readOnly: true
        status:
          type: string
          description: The status of the request(`Complete` `Failed` `TooManyResults`)
          nullable: true
        company_id:
          type: string
          description: Sikoia ID for the Company
          format: uuid
          nullable: true
          readOnly: true
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          readOnly: true
        message:
          type: string
          description: Additional detail about the request
          nullable: true
        company_number:
          type: string
          description: The company registration number
          nullable: true
        company_name:
          type: string
          description: The legal name of the company
          nullable: true
        country_code:
          type: string
          description: Two letter ISO country code, e.g. GB
          nullable: true
        data:
          $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.RegistryData'
        picklist:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.Company.External.Response.Mapped.CompanySearchMappedResponse'
          description: Company search response
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.RelatedCompany:
      title: Related Company
      type: object
      properties:
        company_name:
          type: string
          description: Name of the Related Company
          nullable: true
        company_number:
          type: string
          description: Company Number
          nullable: true
        country_code:
          type: string
          description: Country Code
          nullable: true
        generic_legal_form:
          type: string
          description: Generic Legal Form
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.SecuredDetails:
      title: Secured Details
      type: object
      properties:
        type:
          type: string
          description: Type of Secured Details
          nullable: true
        description:
          type: string
          description: Description of Secured Details
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.SummaryInfo:
      title: Information Summary
      type: object
      properties:
        has_insolvency_history:
          type: boolean
          description: Insolvency History
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Response.Mapped.Transaction:
      title: Transaction
      type: object
      properties:
        filing_type:
          type: string
          description: The Filing Type of a Transaction
          nullable: true
        delivered_on:
          type: string
          description: Transaction Delivered On
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.Company.External.Request.ResolvePicklistRequest:
      title: Resolve Picklist Request
      required:
      - picklist_index
      - request_id
      type: object
      properties:
        request_id:
          minLength: 1
          type: string
          description: Sikoia ID for the request
          example: cfed4c7f-37e8-4657-b185-7cf572d0b019
        picklist_index:
          minimum: 0
          exclusiveMinimum: true
          type: integer
          description: Picklist index of the company you wish to select
          format: int32
          example: '1'
      additionalProperties: false
    SikoiaSharedModels.Company.External.Request.CompanySearchRequest:
      title: Company Search
      required:
      - company_name
      type: object
      properties:
        company_name:
          minLength: 1
          type: string
          description: The legal name of the company
          example: Acme Inc
        jurisdiction_code:
          type: string
          description: The jurisdiction of the company as an ISO 3166-2 code, e.g.US_DE
          nullable: true
          example: GB
        country_code:
          type: string
          description: Two letter ISO country code, e.g. GB
          nullable: true
          example: GB
        exclude_inactive:
          type: boolean
          description: Exclude inactive companies from the search, defaults to `false`
          example: 'true'
        company_id:
          type: string
          description: Sikoia ID for the Company
          nullable: true
          example: 78662640-73fc-4fa9-8367-ef4660d35cee
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Request.CreditReportRequest:
      title: Credit Report Request
      required:
      - company_id
      type: object
      properties:
        company_id:
          minLength: 1
          type: string
          description: Sikoia ID for the Company
          example: 78662640-73fc-4fa9-8367-ef4660d35cee
        company_number:
          type: string
          description: The company registration number
          nullable: true
          example: '12345678'
        company_name:
          type: string
          description: The legal name of the company
          nullable: true
          example: Acme Inc
        country_code:
          type: string
          description: Two letter ISO country code, e.g. GB
          nullable: true
          example: GB
        provider_id:
          type: string
          description: Internal ID of the Credit Report Provider
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Request.CreditReportRequestByCompanyId:
      title: By Company ID
      required:
      - CompanyId
      type: object
      properties:
        company_id:
          type: string
          description: Sikoia ID for the Company
          nullable: true
          example: a035d37a-dee1-4a4e-b098-168a6a1f4603
      additionalProperties: false
      description: Company details are retrieved from the company entity.
    SikoiaSharedModels.CreditCheck.External.Request.CreditReportRequestByDetails:
      title: By Company Details
      required:
      - CompanyId
      - CompanyName
      - CompanyNumber
      - CountryCode
      type: object
      properties:
        company_id:
          type: string
          description: Sikoia ID for the Company
          nullable: true
          example: a035d37a-dee1-4a4e-b098-168a6a1f4603
        company_number:
          type: string
          description: Company Registration Number
          nullable: true
          example: '77642080'
        company_name:
          type: string
          description: Company Name
          nullable: true
          example: Acme Limited
        country_code:
          type: string
          description: 2 Letter ISO Country Code
          nullable: true
          example: GB
      additionalProperties: false
      description: Company details are provided directly in the call. They override what is defined in the company entity,
        but the report is still associated to it.
    SikoiaSharedModels.CreditCheck.External.Request.CreditReportRequestByProviderId:
      title: By Provider ID
      required:
      - CompanyId
      - ProviderId
      type: object
      properties:
        company_id:
          type: string
          description: Sikoia ID for the Company
          nullable: true
          example: a035d37a-dee1-4a4e-b098-168a6a1f4603
        provider_id:
          type: string
          description: Internal ID of the Credit Report Provider
          nullable: true
      additionalProperties: false
      description: Company details are not provided. The internal ID of the credit report provider is used instead. The report
        is still associated to the company entity specified.
    SikoiaSharedModels.CreditCheck.External.Response.CreditReportResponse:
      title: Credit Report Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          nullable: true
          example: cfed4c7f-37e8-4657-b185-7cf572d0b019
        status:
          type: string
          description: The status of the request(`Complete` `Failed` `TooManyResults`)
          nullable: true
          example: Complete
        company_id:
          type: string
          description: Sikoia ID for the Company
          format: uuid
          nullable: true
          readOnly: true
          example: 78662640-73fc-4fa9-8367-ef4660d35cee
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          readOnly: true
          example: '2024-02-12T14:50:10.383Z'
        message:
          type: string
          description: Additional detail about the request
          nullable: true
        company_number:
          type: string
          description: The company registration number
          nullable: true
          example: '12345678'
        company_name:
          type: string
          description: The legal name of the company
          nullable: true
          example: Acme Inc
        country_code:
          type: string
          description: Two letter ISO country code, e.g. GB
          nullable: true
          example: GB
        provider_id:
          type: string
          description: The data provider’s ID for the company
          nullable: true
        picklist:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.CreditSearchMappedResponse'
          description: If the response status is “TooManyResults”, this object will list the potential matches for the company
          nullable: true
          example: '[]'
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.CreditSearchMappedResponse:
      title: Credit Search Response
      type: object
      properties:
        index:
          type: integer
          description: The index of the company
          format: int32
          nullable: true
        company_number:
          type: string
          description: The company registration number
          nullable: true
          example: '12345678'
        company_name:
          type: string
          description: The legal name of the company
          nullable: true
          example: Acme Inc
        country_code:
          type: string
          description: Two letter ISO country code, e.g. GB
          nullable: true
          example: GB
        provider_id:
          type: string
          description: Internal ID of the Credit Report Provider
          nullable: true
          example: ABC123
        status:
          type: string
          description: The operational status of the company
          nullable: true
          example: Active
        branch:
          type: boolean
          description: The branch status of the company
          nullable: true
          example: 'true'
        official_address:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.OfficialAddress'
        vat_number:
          type: array
          items:
            type: string
          description: List of VAT numbers for the company
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.OfficialAddress:
      title: Official Address
      type: object
      properties:
        address_line_1:
          type: string
          description: The First Line of Address
          nullable: true
        address_line_2:
          type: string
          description: The Second Line of Address
          nullable: true
        address_line_3:
          type: string
          description: The Third Line of Address
          nullable: true
        address_line_4:
          type: string
          description: The Fourth Line of Address
          nullable: true
        city:
          type: string
          description: The Name of the City
          nullable: true
        region:
          type: string
          description: The Name of the Region
          nullable: true
        country:
          type: string
          description: The Name of the Country
          nullable: true
        post_code:
          type: string
          description: The PostCode of the Address
          nullable: true
        full_address:
          type: string
          description: The Full Address
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.CreditReportListResponse:
      title: Credit Report List Response
      type: object
      properties:
        company_id:
          type: string
          description: Sikoia ID for the Company
          format: uuid
          nullable: true
          readOnly: true
          example: 78662640-73fc-4fa9-8367-ef4660d35cee
        credit_report_requests:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.CreditReportOrchestrationResponse'
          description: The list of all credit report requests for the company
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.CreditReportOrchestrationResponse:
      title: Credit Report Orchestration Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          nullable: true
          example: cfed4c7f-37e8-4657-b185-7cf572d0b019
        status:
          type: string
          description: The status of the request(`Complete` `Failed` `TooManyResults`)
          nullable: true
          example: Complete
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          readOnly: true
          example: '2024-02-12T14:50:10.383Z'
        message:
          type: string
          description: Additional detail about the request
          nullable: true
        company_number:
          type: string
          description: The company registration number
          nullable: true
          example: '12345678'
        company_name:
          type: string
          description: The legal name of the company
          nullable: true
          example: Acme Inc
        country_code:
          type: string
          description: Two letter ISO country code, e.g. GB
          nullable: true
          example: GB
        provider_id:
          type: string
          description: The data provider’s ID for the company
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.BadDebt:
      title: Bad Debt
      type: object
      properties:
        date:
          type: string
          description: Date of Bad Debt
          nullable: true
        company_number:
          type: string
          description: Company Number
          nullable: true
        company_name:
          type: string
          description: Company Name
          nullable: true
        currency:
          type: string
          description: Currency
          nullable: true
        amount:
          type: number
          description: Amount
          format: double
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.BalanceSheet:
      type: object
      properties:
        land_and_buildings:
          type: number
          format: double
          nullable: true
        plant_and_machinery:
          type: number
          format: double
          nullable: true
        other_tangible_assets:
          type: number
          format: double
          nullable: true
        total_tangible_assets:
          type: number
          format: double
          nullable: true
        goodwill:
          type: number
          format: double
          nullable: true
        other_intangible_assets:
          type: number
          format: double
          nullable: true
        total_intangible_assets:
          type: number
          format: double
          nullable: true
        investments:
          type: number
          format: double
          nullable: true
        loans_to_group:
          type: number
          format: double
          nullable: true
        other_loans:
          type: number
          format: double
          nullable: true
        miscellaneous_fixed_assets:
          type: number
          format: double
          nullable: true
        total_other_fixed_assets:
          type: number
          format: double
          nullable: true
        total_fixed_assets:
          type: number
          format: double
          nullable: true
        raw_materials:
          type: number
          format: double
          nullable: true
        work_in_progress:
          type: number
          format: double
          nullable: true
        finished_goods:
          type: number
          format: double
          nullable: true
        other_inventories:
          type: number
          format: double
          nullable: true
        total_inventories:
          type: number
          format: double
          nullable: true
        trade_receivables:
          type: number
          format: double
          nullable: true
        group_receivables:
          type: number
          format: double
          nullable: true
        receivables_due_after_1_year:
          type: number
          format: double
          nullable: true
        miscellaneous_receivables:
          type: number
          format: double
          nullable: true
        total_receivables:
          type: number
          format: double
          nullable: true
        cash:
          type: number
          format: double
          nullable: true
        other_current_assets:
          type: number
          format: double
          nullable: true
        total_current_assets:
          type: number
          format: double
          nullable: true
        total_assets:
          type: number
          format: double
          nullable: true
        trade_payables:
          type: number
          format: double
          nullable: true
        bank_liabilities:
          type: number
          format: double
          nullable: true
        other_loans_or_finance:
          type: number
          format: double
          nullable: true
        group_payables:
          type: number
          format: double
          nullable: true
        miscellaneous_liabilities:
          type: number
          format: double
          nullable: true
        total_current_liabilities:
          type: number
          format: double
          nullable: true
        trade_payables_due_after_1_year:
          type: number
          format: double
          nullable: true
        bank_liabilities_due_after_1_year:
          type: number
          format: double
          nullable: true
        other_loans_or_finance_due_after_1_year:
          type: number
          format: double
          nullable: true
        group_payables_due_after_1_year:
          type: number
          format: double
          nullable: true
        miscellaneous_liabilities_due_after_1_year:
          type: number
          format: double
          nullable: true
        total_long_term_liabilities:
          type: number
          format: double
          nullable: true
        total_liabilities:
          type: number
          format: double
          nullable: true
        called_up_share_capital:
          type: number
          format: double
          nullable: true
        share_premium:
          type: number
          format: double
          nullable: true
        revenue_reserves:
          type: number
          format: double
          nullable: true
        other_reserves:
          type: number
          format: double
          nullable: true
        total_shareholders_equity:
          type: number
          format: double
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.CapitalStructure:
      title: Capital Structure
      type: object
      properties:
        currency:
          type: string
          description: Currency
          nullable: true
        nominal_capital:
          type: number
          description: Nominal Capital
          format: double
          nullable: true
        issued_capital:
          type: number
          description: Issued Capital
          format: double
          nullable: true
        number_of_shares:
          type: integer
          description: Number of Shares
          format: int64
          nullable: true
        shareholders:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.Shareholders'
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.CommentaryWithSentiment:
      title: Commentary with Sentiment
      type: object
      properties:
        commentary:
          type: string
          description: Commentary
          nullable: true
        sentiment:
          type: string
          description: Sentiment
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.CompanyInformation:
      type: object
      properties:
        company_number:
          type: string
          description: The Company Number
          nullable: true
        company_name:
          type: string
          description: The Company Name
          nullable: true
        country_code:
          type: string
          description: The Country Code
          nullable: true
        status:
          type: string
          description: The Status
          nullable: true
        date_established:
          type: string
          description: The Established Date
          nullable: true
          readOnly: true
        date_dissolved:
          type: string
          description: The Dissolved Date
          nullable: true
          readOnly: true
        generic_legal_form:
          type: string
          description: Generic Legal Form
          nullable: true
        registry_legal_form:
          type: string
          description: Registry Legal Form
          nullable: true
        vat_number:
          type: string
          description: Vat Number
          nullable: true
        official_address:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.OfficialAddress'
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.CompanyOfficer:
      title: Company Officer
      type: object
      properties:
        name:
          type: string
          description: The Name of the Company Officer
          nullable: true
        status:
          type: string
          description: The Status
          nullable: true
        officer_role:
          type: string
          description: The Role of the Officer
          nullable: true
        date_appointed:
          type: string
          description: The Date when Officer was Appointed
          nullable: true
        date_resigned:
          type: string
          description: The Date when Officer Resigned
          nullable: true
        address:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.OfficialAddress'
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.CompanyOwner:
      title: Company Owner
      type: object
      properties:
        name:
          type: string
          description: The Name of the Company Owner
          nullable: true
        status:
          type: string
          description: The Status
          nullable: true
        holding_percentage:
          type: number
          description: Holding Percentage
          format: double
          nullable: true
        holding_percentage_band:
          type: string
          description: Holding Percentage Band
          nullable: true
        voting_percentage:
          type: number
          description: Voting Percentage
          format: double
          nullable: true
        voting_percentage_band:
          type: string
          description: Voting Percentage Band
          nullable: true
        date_appointed:
          type: string
          description: Date Appointed
          nullable: true
        date_resigned:
          type: string
          description: Date Resigned
          nullable: true
        address:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.OfficialAddress'
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.CompanyShareholder:
      title: Company Shareholder
      type: object
      properties:
        name:
          type: string
          description: The Name of the Shareholder
          nullable: true
        status:
          type: string
          description: The Status
          nullable: true
        holding_percentage:
          type: number
          description: Holding Percentage
          format: double
          nullable: true
        holding_percentage_band:
          type: string
          description: Holding Percentage Band
          nullable: true
        voting_percentage:
          type: number
          description: Voting Percentage
          format: double
          nullable: true
        voting_percentage_band:
          type: string
          description: Voting Percentage Band
          nullable: true
        number_of_shares:
          type: integer
          description: Number of Shares
          format: int64
          nullable: true
        share_value:
          type: number
          description: Share Value
          format: double
          nullable: true
        officer_role:
          type: string
          description: Officer Role
          nullable: true
        date_appointed:
          type: string
          description: Date Appointed
          nullable: true
        date_resigned:
          type: string
          description: Date Resigned
          nullable: true
        address:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.OfficialAddress'
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.CreditLimitHistoryItem:
      title: Credit Limit History
      type: object
      properties:
        date:
          type: string
          description: Date of Credit Limit History
          nullable: true
          readOnly: true
        value:
          type: string
          description: Value of Credit Limit History
          nullable: true
        currency:
          type: string
          description: Currency of Credit Limit History
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.CreditRating:
      title: Credit Rating
      type: object
      properties:
        international_credit_rating:
          type: string
          description: International Credit Rating
          nullable: true
        international_credit_rating_description:
          type: string
          description: International Credit Rating Description
          nullable: true
        local_credit_rating:
          type: string
          description: Local Credit Rating
          nullable: true
        local_credit_rating_description:
          type: string
          description: Local Credit Rating Description
          nullable: true
        rating_date:
          type: string
          description: The Credit Rating Date
          nullable: true
          readOnly: true
        probability_of_default:
          type: number
          description: Default Probability
          format: double
          nullable: true
        national_percentile:
          type: number
          description: National Percentile
          format: double
          nullable: true
        credit_limit:
          type: number
          description: Credit Limit
          format: double
          nullable: true
        credit_limit_currency:
          type: string
          description: Credit Limit Currency
          nullable: true
        credit_rating_history:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.CreditRatingHistoryItem'
          description: List of Credit Rating History
          nullable: true
        credit_limit_history:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.CreditLimitHistoryItem'
          description: List of Credit Limit History
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.CreditRatingHistoryItem:
      title: Credit Rating History Item
      type: object
      properties:
        international_credit_rating:
          title: International Credit Rating
          type: string
          nullable: true
        international_credit_rating_description:
          title: International Credit Rating Description
          type: string
          nullable: true
        local_credit_rating:
          title: Local Credit Rating
          type: string
          nullable: true
        local_credit_rating_description:
          title: Local Credit Rating Description
          type: string
          nullable: true
        rating_date:
          title: Rating Date
          type: string
          nullable: true
          readOnly: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.CreditReportData:
      title: Credit Report Data
      type: object
      properties:
        company_information:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.CompanyInformation'
        industry_codes:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.IndustryCode'
          description: List of Industry Codes
          nullable: true
        credit_rating:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.CreditRating'
        officers:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.Officers'
        owners:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.Owners'
        commentaries:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.CommentaryWithSentiment'
          description: List of Comments With Sentiment
          nullable: true
        capital_structure:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.CapitalStructure'
        judgments:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.Judgment'
          description: List of Judgments
          nullable: true
        bad_debts:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.BadDebt'
          description: List of Bad Debts
          nullable: true
        financial_statements:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.FinancialStatements'
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.CreditReportMappedResponse:
      title: Credit Report Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          nullable: true
        status:
          type: string
          description: The status of the request(`Complete` `Failed` `TooManyResults`)
          nullable: true
        company_id:
          type: string
          description: Sikoia ID for the Company
          format: uuid
          nullable: true
          readOnly: true
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          readOnly: true
        message:
          type: string
          description: Additional detail about the request
          nullable: true
        company_number:
          type: string
          description: The company registration number
          nullable: true
        company_name:
          type: string
          description: The legal name of the company
          nullable: true
        country_code:
          type: string
          description: Two letter ISO country code, e.g. GB
          nullable: true
        provider_id:
          type: string
          description: Internal ID of the Credit Report Provider
          nullable: true
        data:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.CreditReportData'
        picklist:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.CreditSearchMappedResponse'
          description: Credit search response
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.FinancialStatements:
      title: Financial Statements
      type: object
      properties:
        global_reports:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.GlobalFinancialStatement'
          description: List of Financial Statements
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.GlobalFinancialStatement:
      type: object
      properties:
        type:
          type: string
          nullable: true
        start_date:
          type: string
          nullable: true
        end_date:
          type: string
          nullable: true
        number_of_weeks:
          type: integer
          format: int32
          nullable: true
        currency:
          type: string
          nullable: true
        original_currency:
          type: string
          nullable: true
        currency_conversion_rate:
          type: number
          format: double
          nullable: true
        consolidated_accounts:
          type: boolean
          nullable: true
        amended_accounts:
          type: boolean
          nullable: true
        profit_and_loss:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.ProfitAndLoss'
        balance_sheet:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.BalanceSheet'
        other_financials:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.OtherFinancials'
        ratios:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.Ratios'
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.IndustryCode:
      title: Industry Code
      type: object
      properties:
        code:
          type: string
          description: The Industry Code
          nullable: true
        description:
          type: string
          description: The Industry Description
          nullable: true
        classification:
          type: string
          description: The Industry Classification
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.Judgment:
      title: Judgment
      type: object
      properties:
        date:
          type: string
          description: Date of Judgment
          nullable: true
        type:
          type: string
          description: Type of Judgment
          nullable: true
        court_name:
          type: string
          description: Name of the Court
          nullable: true
        amount:
          type: number
          description: Amount
          format: double
          nullable: true
        reference_number:
          type: string
          description: Reference Number
          nullable: true
        currency:
          type: string
          description: Currency
          nullable: true
        status:
          type: string
          description: The Status
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.Officers:
      title: Officers
      type: object
      properties:
        people:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.PersonOfficer'
          description: List of People Officers
          nullable: true
        companies:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.CompanyOfficer'
          description: List of Company Officers
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.OtherFinancials:
      type: object
      properties:
        contingent_liabilities:
          type: string
          nullable: true
        working_capital:
          type: number
          format: double
          nullable: true
        net_worth:
          type: number
          format: double
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.Owners:
      title: Owners
      type: object
      properties:
        people:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.PersonOwner'
          description: The List of People
          nullable: true
        companies:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.CompanyOwner'
          description: The List of Companies
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.PersonOfficer:
      type: object
      properties:
        first_name:
          type: string
          nullable: true
        surname:
          type: string
          nullable: true
        full_name:
          type: string
          nullable: true
        status:
          type: string
          nullable: true
        officer_role:
          type: string
          nullable: true
        date_appointed:
          type: string
          nullable: true
        date_resigned:
          type: string
          nullable: true
        date_of_birth:
          type: string
          nullable: true
        birth_year:
          type: integer
          format: int32
          nullable: true
        birth_month:
          type: integer
          format: int32
          nullable: true
        birth_day:
          type: integer
          format: int32
          nullable: true
        nationality:
          type: string
          nullable: true
        address:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.OfficialAddress'
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.PersonOwner:
      title: Person Owner
      type: object
      properties:
        first_name:
          type: string
          description: The First Name of the Owner
          nullable: true
        surname:
          type: string
          description: The Surname of the Owner
          nullable: true
        full_name:
          type: string
          description: The Full Name of the Owner
          nullable: true
        status:
          type: string
          description: The Status
          nullable: true
        holding_percentage:
          type: number
          description: Holding Percentage
          format: double
          nullable: true
        holding_percentage_band:
          type: string
          description: Holding Percentage Band
          nullable: true
        voting_percentage:
          type: number
          description: Voting Percentage
          format: double
          nullable: true
        voting_percentage_band:
          type: string
          description: Voting Percentage Band
          nullable: true
        date_appointed:
          type: string
          description: Date Appointed
          nullable: true
        date_resigned:
          type: string
          description: Date Resigned
          nullable: true
        date_of_birth:
          type: string
          description: The Date of Birth of the Owner
          nullable: true
        birth_year:
          type: integer
          description: The Year of Birth of the Owner
          format: int32
          nullable: true
        birth_month:
          type: integer
          description: The Month of Birth of the Owner
          format: int32
          nullable: true
        birth_day:
          type: integer
          description: The Day of Birth of the Owner
          format: int32
          nullable: true
        nationality:
          type: string
          description: The Nationality of the Owner
          nullable: true
        address:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.OfficialAddress'
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.PersonShareholder:
      title: Person Shareholder
      type: object
      properties:
        first_name:
          type: string
          description: The Firstname of the Shareholder
          nullable: true
        surname:
          type: string
          description: The Surname of the Shareholder
          nullable: true
        full_name:
          type: string
          description: The Full Name of the Shareholder
          nullable: true
        status:
          type: string
          description: The Status
          nullable: true
        holding_percentage:
          type: number
          description: Holding Percentage
          format: double
          nullable: true
        holding_percentage_band:
          type: string
          description: Holding Percentage Band
          nullable: true
        voting_percentage:
          type: number
          description: Voting Percentage
          format: double
          nullable: true
        voting_percentage_band:
          type: string
          description: Voting Percentage Band
          nullable: true
        number_of_shares:
          type: integer
          description: Number of Shares
          format: int64
          nullable: true
        share_value:
          type: number
          description: Share Value
          format: double
          nullable: true
        officer_role:
          type: string
          description: Officer Role
          nullable: true
        date_appointed:
          type: string
          description: Date Appointed
          nullable: true
        date_resigned:
          type: string
          description: Date Resigned
          nullable: true
        date_of_birth:
          type: string
          description: The Date of Birth of the Shareholder
          nullable: true
        birth_year:
          type: integer
          description: The Year of Birth of the Shareholder
          format: int32
          nullable: true
        birth_month:
          type: integer
          description: The Month of Birth of the Shareholder
          format: int32
          nullable: true
        birth_day:
          type: integer
          description: The Day of Birth of the Shareholder
          format: int32
          nullable: true
        nationality:
          type: string
          description: The Nationality of the Shareholder
          nullable: true
        address:
          $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.OfficialAddress'
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.ProfitAndLoss:
      type: object
      properties:
        revenue:
          type: number
          format: double
          nullable: true
        operating_costs:
          type: number
          format: double
          nullable: true
        operating_profit:
          type: number
          format: double
          nullable: true
        wages_and_salaries:
          type: number
          format: double
          nullable: true
        pension_costs:
          type: number
          format: double
          nullable: true
        depreciation:
          type: number
          format: double
          nullable: true
        financial_income:
          type: number
          format: double
          nullable: true
        amortisation:
          type: number
          format: double
          nullable: true
        financial_expenses:
          type: number
          format: double
          nullable: true
        extraordinary_income:
          type: number
          format: double
          nullable: true
        extraordinary_costs:
          type: number
          format: double
          nullable: true
        profit_before_tax:
          type: number
          format: double
          nullable: true
        tax:
          type: number
          format: double
          nullable: true
        profit_after_tax:
          type: number
          format: double
          nullable: true
        dividends:
          type: number
          format: double
          nullable: true
        minority_interests:
          type: number
          format: double
          nullable: true
        other_appropriations:
          type: number
          format: double
          nullable: true
        retained_profit:
          type: number
          format: double
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.Ratios:
      type: object
      properties:
        pre_tax_profit_margin:
          type: number
          format: double
          nullable: true
        return_on_capital_employed:
          type: number
          format: double
          nullable: true
        return_on_total_assets_employed:
          type: number
          format: double
          nullable: true
        return_on_net_assets_employed:
          type: number
          format: double
          nullable: true
        sales_or_net_working_capital:
          type: number
          format: double
          nullable: true
        stock_turnover_ratio:
          type: number
          format: double
          nullable: true
        debtor_days:
          type: number
          format: double
          nullable: true
        creditor_days:
          type: number
          format: double
          nullable: true
        current_ratio:
          type: number
          format: double
          nullable: true
        liquidity_ratio_or_acid_test:
          type: number
          format: double
          nullable: true
        current_debt_ratio:
          type: number
          format: double
          nullable: true
        gearing:
          type: number
          format: double
          nullable: true
        equity_in_percentage:
          type: number
          format: double
          nullable: true
        total_debt_ratio:
          type: number
          format: double
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Response.Mapped.Shareholders:
      title: Shareholders
      type: object
      properties:
        people:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.PersonShareholder'
          description: List of Person Shareholders
          nullable: true
        companies:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.CreditCheck.External.Response.Mapped.CompanyShareholder'
          description: List of Company Shareholders
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.CreditCheck.External.Request.ResolvePicklistRequest:
      title: Resolve Picklist Request
      required:
      - picklist_index
      - request_id
      type: object
      properties:
        request_id:
          minLength: 1
          type: string
          description: Sikoia ID for the request
          example: 9133edc8-6ac5-45ee-827a-fa717c90d47b
        picklist_index:
          minimum: 0
          exclusiveMinimum: true
          type: integer
          description: Picklist Index
          format: int32
          example: '1'
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.OpenBanking.CreateTokenRequest:
      title: Create Open Banking Connection
      required:
      - entity_id
      - entity_type
      type: object
      properties:
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity
          format: uuid
          example: 78662640-73fc-4fa9-8367-ef4660d35cee
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of the entity
          example: company
        country_code:
          type: string
          description: Must be ISO 2 digit country code. Limits the institution selection to country provided.
          nullable: true
          example: GB
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.OpenBanking.CreateTokenResponse:
      title: Open Banking Connection
      type: object
      properties:
        bank_connection_id:
          type: string
          description: The Open Banking Connection ID
          format: uuid
          nullable: true
          readOnly: true
          example: e81154bd-f85f-4223-8b4f-36643843fa99
        bank_connection_url:
          type: string
          description: The URL for the bank connection consent flow
          format: url
          nullable: true
          example: https://verify.sikoia.com/openbanking/123456
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity
          format: uuid
          readOnly: true
          example: 78662640-73fc-4fa9-8367-ef4660d35cee
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of the entity
          nullable: true
          example: company
        datetime_requested:
          type: string
          description: The time the connection was requested
          format: date-time
          nullable: true
          readOnly: true
          example: '2024-02-12T04:21:07.0000000+00:00'
        datetime_refreshed:
          type: string
          description: The time the connection was refreshed
          format: date-time
          nullable: true
          readOnly: true
          example: '2024-02-11T04:21:07.0000000+00:00'
        datetime_connected:
          type: string
          description: The time the connection was connected
          format: date-time
          nullable: true
          readOnly: true
          example: '2024-02-14T04:21:07.0000000+00:00'
        datetime_expiry:
          type: string
          description: The expiry time of the connection
          format: date-time
          nullable: true
          readOnly: true
          example: '2024-05-12T04:24:34.0000000+00:00'
        status:
          type: string
          description: The connection status(`Created` `SelectingInstitutions` `Rejected` `Authorising` `Connected` `Deleted`)
          nullable: true
          example: Connected
        country_code:
          type: string
          description: The country code of the selected institution
          nullable: true
          example: GB
        institution_name:
          type: string
          description: Name of the institution
          nullable: true
          example: Sandbox
        institution_logo:
          type: string
          description: Logo of the institution
          nullable: true
          example: https://logolink.com
        account_connection_ids:
          type: array
          items:
            type: string
          description: List of connected accounts as Account Connection IDs
          nullable: true
          example: '["820eec09-dbdd-4c90-b0f2-acbca66f1ad5", "132d3353-ad29-46e0-b66a-caed8b572e93", "93886787-3307-4319-afa7-48540bf21362"]'
        source:
          type: string
          description: The banking source(`Document` `OpenBanking`)
          example: Document
        document_id:
          type: string
          description: The document ID (when source is Document)
          example: r51154bd-f85f-4223-8b4f-36643843fa33
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.OpenBanking.GetAccountDetailsResponse:
      title: Account Details
      type: object
      properties:
        account_connection_id:
          type: string
          description: The Account Connection ID of the bank
          format: uuid
          nullable: true
          readOnly: true
          example: 132d3353-ad29-46e0-b66a-caed8b572e93
        account_type:
          type: string
          description: The type of account
          nullable: true
          example: CREDIT_CARD
        status:
          type: string
          description: The account status(`Created` `SelectingInstitutions` `Rejected` `Authorising` `Connected` `Deleted`)
          nullable: true
          example: Connected
        currency:
          type: string
          description: The currency of the account
          nullable: true
          example: GBP
        owners_name:
          type: array
          items:
            type: string
          description: List of the owners' name
          nullable: true
          example: '["Acme Inc"]'
        identifications:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.Models.IdentificationModel'
          description: List of Account Identifiers
          nullable: true
        bank_connection_id:
          type: string
          description: The open banking Connection ID
          format: uuid
          nullable: true
          readOnly: true
          example: e81154bd-f85f-4223-8b4f-36643843fa99
        datetime_last_refreshed:
          type: string
          description: The time the account was last refreshed
          format: date-time
          nullable: true
          readOnly: true
          example: '2024-02-12T04:28:00.0000000+00:00'
        datetime_connected:
          type: string
          description: The time the account was connected
          format: date-time
          nullable: true
          readOnly: true
          example: '2024-02-12T04:24:50.0000000+00:00'
        datetime_expiry:
          type: string
          description: The access expiry date of the account
          format: date-time
          nullable: true
          readOnly: true
          example: '2024-05-12T04:24:34.0000000+00:00'
        country_code:
          type: string
          description: The country code of the institution
          nullable: true
          example: GB
        institution_logo:
          type: string
          description: The logo of the institution
          nullable: true
          example: https://logolink.com
        institution_name:
          type: string
          description: The name of the institution
          nullable: true
          example: Sandbox
        source:
          type: string
          description: The banking source(`Document` `OpenBanking`)
          example: Document
        document_id:
          type: string
          description: The Document ID
          example: r51154bd-f85f-4223-8b4f-36643843fa33
        data_source_id:
          type: string
          description: A unique identifier for a specific data source within a document, such as an individual bank statement
            in a multi-statement document.
          readOnly: true
          example: 01951375-a680-77ce-b196-44d1feedc47c
        full_address:
          type: string
          description: Full Address
          nullable: true
          example: Flat 23, 49 Sample Street, London
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.OpenBanking.Models.IdentificationModel:
      title: Account Identifiers
      type: object
      properties:
        type:
          type: string
          description: The type of a Account Identifier
          nullable: true
          example: SORT_CODE
        value:
          type: string
          description: The value of the Account Identifier
          nullable: true
          example: '100001'
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.OpenBanking.AccountBalances:
      title: Account Balances
      type: object
      properties:
        type:
          type: string
          description: The type of account balances
          nullable: true
          example: CLOSING_AVAILABLE
        amount:
          $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.AmountDetails'
        date:
          type: string
          description: The balance date
          nullable: true
          example: '2024-02-12T16:24:50.149Z'
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.OpenBanking.AccountBalancesResponse:
      title: Account Balances
      type: object
      properties:
        account_connection_id:
          type: string
          description: The Account Connection ID of the bank account
          format: uuid
          nullable: true
          readOnly: true
          example: 132d3353-ad29-46e0-b66a-caed8b572e93
        balances:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.AccountBalances'
          description: The list of account balances
          nullable: true
        datetime_refreshed:
          type: string
          description: The time the balances were refreshed
          format: date-time
          readOnly: true
          example: '2024-02-12T04:25:09.0000000+00:00'
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.OpenBanking.AmountDetails:
      type: object
      properties:
        value:
          type: string
          nullable: true
          example: '1528.08'
        currency:
          type: string
          nullable: true
          example: USD
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.OpenBanking.AccountTransaction:
      title: Account Transactions
      type: object
      properties:
        transaction_id:
          type: string
          description: Account Transaction ID
          nullable: true
          example: 0730deba-767a-4c40-bc89-ac7c96e5a1c9
        date:
          type: string
          description: The account transaction date
          format: date-time
          nullable: true
          readOnly: true
          example: '2024-02-12T02:57:24.0000000+00:00'
        booking_datetime:
          type: string
          description: The booking date
          format: date-time
          nullable: true
          readOnly: true
          example: '2024-02-12T02:57:24.0000000+00:00'
        value_date_time:
          type: string
          description: The value date
          format: date-time
          nullable: true
          readOnly: true
          example: '2024-02-12T02:57:24.0000000+00:00'
        status:
          type: string
          description: The status
          nullable: true
          example: PENDING
        amount:
          $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.TransactionAmount'
        currency:
          type: string
          description: The transaction currency
          nullable: true
          example: GBP
        reference:
          type: string
          description: The transaction reference
          nullable: true
          example: Acme123Ltd
        description:
          type: string
          description: The transaction description
          nullable: true
          example: 1B8BAA320D3E4BFAB8B32495157B3604
        merchant:
          $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.Merchant'
        iso_bank_transaction_code:
          $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.IsoBankTransactionCode'
        proprietary_bank_transaction_code:
          $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.ProprietaryBankTransaction'
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.OpenBanking.AccountTransactionsResponse:
      title: Account Transactions
      type: object
      properties:
        account_connection_id:
          type: string
          description: The Account Connection ID for the bank account
          format: uuid
          nullable: true
          readOnly: true
          example: 132d3353-ad29-46e0-b66a-caed8b572e93
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.AccountTransaction'
          description: The list of account transactions
          nullable: true
        datetime_refreshed:
          type: string
          description: The time the transactions were refreshed
          format: date-time
          readOnly: true
          example: '2024-02-12T03:34:25.0000000+00:00'
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.OpenBanking.CommonCode:
      type: object
      properties:
        code:
          type: string
          nullable: true
          example: PMNT
        name:
          type: string
          nullable: true
          example: Payments
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.OpenBanking.IsoBankTransactionCode:
      title: Iso Bank Transaction Code
      type: object
      properties:
        domain_code:
          $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.CommonCode'
        family_code:
          $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.CommonCode'
        sub_family_code:
          $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.CommonCode'
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.OpenBanking.Merchant:
      title: Merchant
      type: object
      properties:
        merchant_name:
          type: string
          description: The merchant name
          nullable: true
        merchant_category:
          type: string
          description: The merchant category
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.OpenBanking.ProprietaryBankTransaction:
      title: Proprietary Bank Transaction
      type: object
      properties:
        code:
          type: string
          description: The proprietary bank transaction code
          nullable: true
          example: open-banking-sip-Debit
        issuer:
          type: string
          description: The issuer
          nullable: true
          example: ozone
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.OpenBanking.TransactionAmount:
      title: Transaction Amount
      type: object
      properties:
        amount:
          type: number
          description: The transaction amount
          format: double
          example: '-1.1'
        currency:
          type: string
          description: The transaction currency
          nullable: true
          example: GBP
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.ComplyAdvantage.AntiMoneyLaunderingRequest:
      title: Anti Money Laundering Request
      required:
      - entity_id
      - entity_type
      type: object
      properties:
        search_term:
          type: string
          description: The name of the entity
          nullable: true
          example: Acme Inc
        entity_type:
          minLength: 1
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity
          example: company
        entity_id:
          minLength: 1
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity
          example: 78662640-73fc-4fa9-8367-ef4660d35cee
        birth_date:
          type: string
          description: The date of birth of the person
          format: date-time
          nullable: true
        monitored:
          type: boolean
          description: Indicates if search should be automatically updated when new data is found.Set to `true` by default
          example: 'true'
        fuzziness:
          type: number
          description: Float to control for spelling variations
          format: float
          nullable: true
          example: '0.2'
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.ComplyAdvantage.AntiMoneyLaunderingResponse:
      title: Anti Money Laundering Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          nullable: true
          example: e6b1b4d6-d5cf-426e-a4dc-d9c0264299df
        search_ref:
          type: string
          description: Data provider’s search ID
          nullable: true
          example: 1729289992-b91nmEFh
        status:
          type: string
          description: The status of the request(`Complete` `Failed`)
          nullable: true
          example: Complete
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity
          nullable: true
          example: company
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity
          nullable: true
          example: 78662640-73fc-4fa9-8367-ef4660d35cee
        search_term:
          type: string
          description: The name of the entity
          nullable: true
          example: Acme Inc
        birthdate:
          type: string
          description: The date of birth of the person
          nullable: true
          example: '1950-08-08'
        monitored:
          type: boolean
          description: Indicates if search should be automatically updated when new data is found. Set to `true` by default
          example: 'true'
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          example: '2024-02-12T16:02:06.9Z'
        total_matches:
          type: integer
          description: The total number of potential matches found
          format: int32
          example: '9'
        search_certificate_uri:
          type: string
          description: The URI of the Search Certificate
          nullable: true
          example: https://sikoialake.blob.core.windows.net/sikoia/complyadvantagecertificate/01929b28-c39d-739e-beb8-6ceda5136d24.pdf?sv=2021-08-06&se=2024-10-17T15%3A56%3A33Z&sr=b&sp=r&sig=4E4X3hxHkpVvCS2pJvBVxGM6MvHcgpdZryC%2BpJmNRHE%3D
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.DocumentUpload.Request.DocumentUploadRequest:
      title: Upload File
      required:
      - display_name
      - entity_id
      - entity_type
      - file
      - file_name
      type: object
      properties:
        entity_id:
          minLength: 1
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity
          example: 3f615611-3dc3-418b-bed5-a53c4390c97c
        entity_type:
          minLength: 1
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity
          example: person
        file:
          minLength: 1
          type: string
          description: File data base64 encoded
          example: c29tZSBlbmNvZGVkIGRhdGE=
        document_type:
          enum:
          - BankStatement
          - Payslip
          - Identity
          - Contract
          - FactFind
          - Other
          - CompanyRegistration
          - StakeholdersDisclosure
          - UtilityBill
          - CreditReport
          - SavingsStatement
          - SA302
          - TaxOverview
          - P45
          - P60
          - EmploymentLetter
          - EmploymentContract
          - ChildBenefitLetter
          - BenefitAwardLetter
          - StudentLoanLetter
          - PensionStatement
          - FinancialAccounts
          type: string
          description: The type of document
          nullable: true
          example: BankStatement
        display_name:
          minLength: 1
          type: string
          description: Display name
          example: January 2023 Bank Statement
        file_name:
          minLength: 1
          type: string
          description: File name including file extension
          example: January-2023-Bank-Statement.pdf
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.DocumentUpload.Response.DocumentUploadResponse:
      title: Document Response
      type: object
      properties:
        document_id:
          type: string
          description: Sikoia ID for the document
          readOnly: true
          example: 181eba57-b6b4-4288-8c97-f8299530f071
        document_uri:
          type: string
          description: The uri for the document
          readOnly: true
          example: https://sikoialake.blob.core.windows.net/clientid/documents/181eba57-b6b4-4288-8c97-f8299530f071.pdf?sv=2021-08-06&st=2023-05-26T14%3A49%3A36Z&se=2023-05-26T14%3A59%3A36Z&sr=b&sp=r&sig=lMhD8hOX0USZid8RpkYGDZr3DQ8ouN6PDCXM1cRNI3w%3D
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity
          readOnly: true
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity
          readOnly: true
          example: 3f615611-3dc3-418b-bed5-a53c4390c97c
        file_type:
          type: string
          description: The type of file
          readOnly: true
          example: .pdf
        display_name:
          type: string
          description: The display name of the document
          readOnly: true
          example: January 2023 Bank Statement
        document_type:
          enum:
          - BankStatement
          - Payslip
          - Identity
          - Contract
          - FactFind
          - Other
          - CompanyRegistration
          - StakeholdersDisclosure
          - UtilityBill
          - CreditReport
          - SavingsStatement
          - SA302
          - TaxOverview
          - P45
          - P60
          - EmploymentLetter
          - EmploymentContract
          - ChildBenefitLetter
          - BenefitAwardLetter
          - StudentLoanLetter
          - PensionStatement
          - FinancialAccounts
          type: string
          description: The type of document
          nullable: true
          readOnly: true
          example: BankStatement
        sikoia_document_type:
          enum:
          - BankStatement
          - Payslip
          - Identity
          - Contract
          - FactFind
          - Other
          - CompanyRegistration
          - StakeholdersDisclosure
          - UtilityBill
          - CreditReport
          - SavingsStatement
          - SA302
          - TaxOverview
          - P45
          - P60
          - EmploymentLetter
          - EmploymentContract
          - ChildBenefitLetter
          - BenefitAwardLetter
          - StudentLoanLetter
          - PensionStatement
          - FinancialAccounts
          type: string
          description: Document type, as classified by Sikoia's AI system
          nullable: true
          readOnly: true
          example: BankStatement
        file_name:
          type: string
          description: The name of the file
          readOnly: true
          example: January-2023-Bank-Statement.pdf
        status:
          type: string
          description: 'The status of the document upload. Possible values: `Complete`, `Failed`'
          readOnly: true
          example: Complete
        datetime_created:
          type: string
          description: The time the document was created
          readOnly: true
          example: '2023-02-10T10:59:46.026Z'
        date_created:
          type: string
          description: Date Created
          format: date-time
          readOnly: true
          deprecated: true
        datetime_last_modified:
          type: string
          description: The time the document was last modified
          readOnly: true
          example: '2023-02-10T10:59:46.026Z'
        date_uploaded:
          type: string
          description: Date Uploaded
          format: date-time
          readOnly: true
          deprecated: true
      additionalProperties: false
    SikoiaSharedModels.EventProcessor.Checklist.Response.IntegrityCheckRequestInstance:
      title: Integrity Check Request Instance
      type: object
      properties:
        integrity_type_id:
          type: string
          description: The unique identifier for the integrity type, such as the ID for the 'Payslip Integrity' check.
          nullable: true
          example: a9d3f2b1-4c76-4a9b-8e1d-5f3a7c6e9d4b
        document_id:
          type: string
          description: The unique identifier for the document
          nullable: true
          example: 1f7a9d27-fa27-4e15-aefd-9b5a5e32f4c1
        status:
          type: string
          description: 'The current status of the check, which may be one of the following: `Complete`, `Failed`, or `Pending`.'
          nullable: true
          example: Complete
        datetime_requested:
          type: string
          description: The date and time when the request was initiated.
          nullable: true
          example: '2024-01-29T12:21:52.933Z'
        datetime_completed:
          type: string
          description: The date and time when the request was completed.
          nullable: true
          example: '2024-01-30T09:44:22.466Z'
        message:
          type: string
          description: An optional field providing additional context about the status of the check.
          nullable: true
          example: Integrity Check complete
      additionalProperties: false
    SikoiaSharedModels.EventProcessor.Checklist.Response.IntegrityCheckRequestListResponse:
      title: Integrity Check Request Instances Response
      type: object
      properties:
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity.
          nullable: true
          example: 3345857d-fa2b-43ab-8b15-67e5fea8e896
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity.
          nullable: true
          example: case
        integrity_check_requests:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EventProcessor.Checklist.Response.IntegrityCheckRequestInstance'
          description: A list of integrity check instance requests for the entity.
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.EventProcessor.Checklist.Response.IntegrityCheckInstanceResponse:
      title: Integrity Check Instance Response
      type: object
      properties:
        integrity_type_id:
          type: string
          description: The unique identifier for the integrity type, such as the ID for the 'Payslip Integrity' check.
          nullable: true
          example: a9d3f2b1-4c76-4a9b-8e1d-5f3a7c6e9d4b
        document_id:
          type: string
          description: The unique identifier for the document
          nullable: true
          example: 1f7a9d27-fa27-4e15-aefd-9b5a5e32f4c1
        integrity_check_name:
          type: string
          description: The name of the check type, such as 'Payslip Integrity Checks'.
          nullable: true
          example: Payslip Integrity Checks
        integrity_check_version:
          type: string
          description: The version number of the integrity check.
          example: '1'
        status:
          type: string
          description: 'The current status of the check, which may be one of the following: `Complete`, `Failed`, or `Pending`.'
          nullable: true
          example: Pass
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity.
          nullable: true
          example: 3345857d-fa2b-43ab-8b15-67e5fea8e896
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity.
          nullable: true
          example: case
        datetime_requested:
          type: string
          description: The date and time when the request was initiated.
          nullable: true
          example: '2024-01-01T12:38:45.711Z'
        datetime_completed:
          type: string
          description: The date and time when the request was completed.
          nullable: true
          example: '2024-01-02T12:22:07.747Z'
        message:
          type: string
          description: An optional field providing additional context about the status of the check.
          nullable: true
          example: Integrity Check request pending
        rules:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EventProcessor.Checklist.Response.Models.IntegrityRuleResponse'
          description: A list of rules to be evaluated as part of the check.
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.EventProcessor.Checklist.Response.Models.IntegrityRuleResponse:
      title: Integrity Rule Response
      type: object
      properties:
        data_source_id:
          type: string
          description: 'A unique identifier for a specific data source within a document, such as an individual payslip in
            a multi-payslip file or an individual bank statement in a multi-statement document. For a full list of available
            data-sources, please visit this link: https://docs.sikoia.com/docs/data-sources-1.'
          readOnly: true
          example: 01951375-a680-77ce-b196-44d1feedc47c
        rule_name:
          type: string
          description: The name of the rule, such as 'Payslips are not handwritten'.
          nullable: true
          example: Payslips are not handwritten
        decision:
          type: string
          description: 'The current decision of the rule evaluation, which may be one of the following: `Pass`, `Fail`, `Refer`.'
          nullable: true
          example: Pass
        message:
          type: string
          description: An optional field providing additional context regarding the status of the rule evaluation.
          nullable: true
          example: Integrity Check Passed
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.Identity.Request.IdentityVerificationRequest:
      title: Identity Verification Request
      required:
      - person_id
      type: object
      properties:
        person_id:
          minLength: 1
          type: string
          description: Sikoia ID for the person
          format: uuid
          example: 0fa323ec-b6e2-4a7a-8fea-58f2b264c57e
        country_code:
          type: string
          description: Two letter ISO country code, e.g. GB
          nullable: true
          example: GB
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.Identity.Response.IdentityVerificationResponse:
      title: Identity Verification Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          nullable: true
          example: 0baa703c-950b-46b7-a424-8c24991987fd
        status:
          type: string
          description: The status of the request(`Pending` `Failed`)
          nullable: true
          example: Pending
        person_id:
          type: string
          description: Sikoia ID for the person
          format: uuid
          nullable: true
          readOnly: true
          example: 0fa323ec-b6e2-4a7a-8fea-58f2b264c57e
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          readOnly: true
          example: '2024-02-12T15:03:40.389Z'
        datetime_completed:
          type: string
          description: The time the identity verification was completed
          nullable: true
          readOnly: true
        message:
          type: string
          description: Additional detail about the request
          nullable: true
        country_code:
          type: string
          description: Two letter ISO country code, e.g. GB
          nullable: true
          example: GB
        verification_url:
          type: string
          description: Sikoia’s verification URL
          nullable: true
          example: https://verify.sikoia.com/v2/123456
        direct_url:
          type: string
          description: IDV Provider's Verification URL
          nullable: true
          example: https://alchemy.veriff.com/v/123456
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.Identity.Response.IdentityVerificationListResponse:
      title: Identity Verification List Response
      type: object
      properties:
        person_id:
          type: string
          description: Sikoia ID for the person
          format: uuid
          nullable: true
          readOnly: true
          example: 0fa323ec-b6e2-4a7a-8fea-58f2b264c57e
        identity_verification_requests:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.Identity.Response.IdentityVerificationOrchestrationResponse'
          description: The list of all IDV requests for the person
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.Identity.Response.IdentityVerificationOrchestrationResponse:
      title: Identity Verification Orchestration Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          nullable: true
          example: 0baa703c-950b-46b7-a424-8c24991987fd
        status:
          type: string
          description: The status of the request(`Pending` `Complete` `Failed` `Expired`)
          nullable: true
          example: Pending
        verification_status:
          enum:
          - Approved
          - Declined
          - ResubmissionRequested
          - NotCompleted
          type: string
          description: The Status of Verification
          nullable: true
          example: ''
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          readOnly: true
          example: '2024-02-12T15:03:40.389Z'
        datetime_completed:
          type: string
          description: The time the request was completed
          nullable: true
          readOnly: true
        message:
          type: string
          description: Additional detail about the request
          nullable: true
        country_code:
          type: string
          description: Two letter ISO country code, e.g. GB
          nullable: true
          example: GB
        verification_url:
          type: string
          description: Sikoia’s verification URL
          nullable: true
          example: https://verify.sikoia.com/v2/123456
        direct_url:
          type: string
          description: IDV provider’s verification URL
          nullable: true
          example: https://alchemy.veriff.com/v/123456
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.Identity.Response.Mapped.Document:
      title: Document
      type: object
      properties:
        type:
          type: string
          description: The Document Type (e.g. Driving License)
          nullable: true
          example: Passport
        number:
          type: string
          description: The Document Number
          nullable: true
          example: '1234567890'
        country_code:
          type: string
          description: The Country Code
          nullable: true
          example: GB
        date_of_issue:
          type: string
          description: The Document Date Of Issue
          nullable: true
          example: '2020-01-01'
        date_of_expiry:
          type: string
          description: The Document Date Of Expiry
          nullable: true
          example: '2030-01-01'
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.Identity.Response.Mapped.IdentityVerificationData:
      title: Identity Verification Data
      type: object
      properties:
        verification_status:
          enum:
          - Approved
          - Declined
          - ResubmissionRequested
          - NotCompleted
          type: string
          description: "The Sikoia standardised verification status. Possible values are:\n- `Approved`: The IDV has been\
            \ successful. The document is authentic and matches the person.\n- `Declined`: The IDV has been declined. The\
            \ document may not be authentic or not match the person.\n- `Resubmission Requested`: It was not possible to make\
            \ a decision based on the media provided (e.g. they were blurry). The person will need to go through the IDV process\
            \ again.\n- `Not Completed`: The IDV process was either never started or abandoned. \n"
          nullable: true
          example: Approved
        acceptance_time:
          type: string
          description: The Acceptance Time of the IDV Request
          nullable: true
          example: '2024-02-12T15:03:40.237Z'
        decision_time:
          type: string
          description: The Decision Time of the IDV Request
          nullable: true
          example: '2024-02-12T15:19:34.904Z'
        person:
          $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.Identity.Response.Mapped.Person'
        document:
          $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.Identity.Response.Mapped.Document'
        media:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.Identity.Response.Mapped.Media'
          description: The List of Images/Videos Collected for the IDV
          nullable: true
        meta_data:
          $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.Identity.Response.Mapped.IdentityVerificationMetaData'
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.Identity.Response.Mapped.IdentityVerificationMappedResponse:
      title: Identity Verification Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          nullable: true
          example: 0baa703c-950b-46b7-a424-8c24991987fd
        status:
          type: string
          description: The status of the request(`Pending` `Complete` `Failed` `Expired`)
          nullable: true
          example: Complete
        person_id:
          type: string
          description: Sikoia ID for the person
          format: uuid
          nullable: true
          readOnly: true
          example: 0fa323ec-b6e2-4a7a-8fea-58f2b264c57e
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          readOnly: true
          example: '2024-02-12T15:03:40.389Z'
        datetime_completed:
          type: string
          description: The time the request was completed
          nullable: true
          readOnly: true
          example: '2024-02-12T15:19:37.211Z'
        message:
          type: string
          description: Additional detail about the request
          nullable: true
        country_code:
          type: string
          description: Two letter ISO country code, e.g. GB
          nullable: true
          example: GB
        verification_url:
          type: string
          description: Sikoia’s verification URL
          nullable: true
          example: https://verify.sikoia.com/v2/123456
        direct_url:
          type: string
          description: IDV provider’s verification URL
          nullable: true
          example: https://alchemy.veriff.com/v/123456
        data:
          $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.Identity.Response.Mapped.IdentityVerificationData'
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.Identity.Response.Mapped.IdentityVerificationMetaData:
      title: Identity Verification Meta Data
      type: object
      properties:
        status_codes:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.Identity.Response.Mapped.Status'
          description: All status codes found in the IDV response and their definitions. May contain success, failure and/or
            information codes that qualify the overall IDV decision.
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.Identity.Response.Mapped.Media:
      title: Media
      type: object
      properties:
        mime_type:
          type: string
          description: The MIME Type of the Media (e.g. image/jpg)
          nullable: true
          example: video/webm
        type:
          type: string
          description: The Type of the Media (e.g. ID Front or Selfie)
          nullable: true
          example: selfid_video
        size:
          type: integer
          description: The Size (in bytes) of the Media
          format: int32
          nullable: true
          example: '621901'
        upload_date:
          type: string
          description: The Timestamp of the Media Upload
          nullable: true
        uri:
          type: string
          description: The URI Where the Media Can Be Downloaded
          nullable: true
          example: https://sikoialake.blob.core.windows.net/12345678
        uri_expiry_in_minutes:
          type: integer
          description: The Expiry Time (in minutes) of the URI
          format: int32
          nullable: true
          example: '30'
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.Identity.Response.Mapped.Person:
      title: Person
      type: object
      properties:
        first_name:
          type: string
          description: The First Name Found on the Document
          nullable: true
          example: John
        surname:
          type: string
          description: The Surname Found on the Document
          nullable: true
          example: Smith
        full_name:
          type: string
          description: The Full Name Found on the Document
          nullable: true
          example: John Smith
        date_of_birth:
          type: string
          description: The Date Of Birth Found on the Document
          nullable: true
          example: '1980-01-01'
        birth_year:
          type: integer
          description: The Birth Year Found on the Document
          format: int32
          nullable: true
          example: '1980'
        birth_month:
          type: integer
          description: The Birth Month Found on the Document
          format: int32
          nullable: true
          example: '1'
        birth_day:
          type: integer
          description: The Birth Day Found on the Document
          format: int32
          nullable: true
          example: '1'
        place_of_birth:
          type: string
          description: The Place Of Birth Found on the Document
          nullable: true
        gender:
          type: string
          description: The Gender Found on the Document
          nullable: true
        nationality:
          type: string
          description: The Nationality Found on the Document
          nullable: true
        address:
          type: string
          description: The Address Found on the Document
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.Identity.Response.Mapped.Status:
      title: Identity Verification Status
      type: object
      properties:
        value:
          type: string
          description: The actual status value, can be either numeric or text
          nullable: true
          example: '0'
        type:
          type: string
          description: The context for the content in `value` to separate full status messages from supplementary information
            provided in remarks
          nullable: true
          example: DocumentStatusReport2.Remark
        description:
          type: string
          description: A short explanation for the content in `value`
          nullable: true
          example: The authentication tests passed.
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.OnlineData.Request.OnlineDataRequest:
      title: Online Data Request
      required:
      - company_id
      type: object
      properties:
        company_id:
          minLength: 1
          pattern: ^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$
          type: string
          description: Sikoia ID for the Company
        company_name:
          type: string
          description: The legal name of the company
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.OnlineData.Response.OnlineDataResponse:
      title: Online Data Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          format: uuid
          readOnly: true
          example: 98aacc2c-5bcd-43da-8425-cbd17034e826
        status:
          type: string
          description: The status of the request(`Complete` `Failed`)
          nullable: true
          example: Complete
        company_id:
          type: string
          description: Sikoia ID for the Company
          format: uuid
          readOnly: true
          example: 78662640-73fc-4fa9-8367-ef4660d35cee
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity
          nullable: true
          example: company
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          readOnly: true
          example: '2024-02-12T15:34:25.485Z'
        message:
          type: string
          description: Additional detail about the request
          nullable: true
        company_name:
          type: string
          description: The name of the company
          nullable: true
          example: Acme Inc
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.OnlineData.Response.OnlineDataListResponse:
      title: Online Data List Response
      type: object
      properties:
        company_id:
          type: string
          description: Sikoia ID for the Company
          format: uuid
          readOnly: true
          example: 78662640-73fc-4fa9-8367-ef4660d35cee
        online_data_requests:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.OnlineData.Response.OnlineDataOrchestrationResponse'
          description: The list of all online data requests for the company
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.OnlineData.Response.OnlineDataOrchestrationResponse:
      title: Online Data Orchestration Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          format: uuid
          readOnly: true
          example: 98aacc2c-5bcd-43da-8425-cbd17034e826
        status:
          type: string
          description: The status of the request(`Complete` `Failed`)
          nullable: true
          example: Complete
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          readOnly: true
          example: '2024-02-12T15:34:25.485Z'
        message:
          type: string
          description: Additional detail about the request
          nullable: true
        company_name:
          type: string
          description: The name of the company
          nullable: true
          example: Acme Inc
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.OnlineData.Response.Mapped.Email:
      title: Email
      type: object
      properties:
        email_type:
          type: string
          description: The Email Type (e.g. Work vs Private)
          nullable: true
          example: Work
        date_from:
          type: string
          description: Creation Date of the Email
          nullable: true
          example: '2020-01-01T00:00:00Z'
        date_to:
          type: string
          description: Deleteion Date of the Email
          nullable: true
          example: '2024-05-03T00:00:00Z'
        email_address:
          type: string
          description: The Email Address
          nullable: true
          example: info@acmeinc.com
        email_domain:
          type: string
          description: The Email Domain
          nullable: true
          example: acme.com
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.OnlineData.Response.Mapped.OnlineAccount:
      title: Online Account
      type: object
      properties:
        provider_name:
          type: string
          description: The Name of the Account Provider (e.g. LinkedIn)
          nullable: true
          example: Facebook
        provider_url:
          type: string
          description: The URL of the Account Provider
          nullable: true
          example: https://www.facebook.com/
        account_name:
          type: string
          description: The Account Name (if any)
          nullable: true
          example: John Doe
        account_url:
          type: string
          description: The Account URL
          nullable: true
          example: https://www.facebook.com/AcmeInc
        date_from:
          type: string
          description: Creation Date of the Account
          nullable: true
          example: '2020-01-01T00:00:00Z'
        date_to:
          type: string
          description: Deletion Date of the Account
          nullable: true
          example: '2024-05-03T00:00:00Z'
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.OnlineData.Response.Mapped.OnlineData:
      title: Online Data
      type: object
      properties:
        website_url:
          type: string
          description: The Website URL
          nullable: true
          example: https://www.acmeinc.com
        phones:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.OnlineData.Response.Mapped.Phone'
          description: The Company Phones
          nullable: true
          example: '[]'
        emails:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.OnlineData.Response.Mapped.Email'
          description: The Company Emails
          nullable: true
          example: ''
        online_accounts:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.OnlineData.Response.Mapped.OnlineAccount'
          description: The Company Online Accounts
          nullable: true
          example: ''
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.OnlineData.Response.Mapped.OnlineDataMappedResponse:
      title: Online Data Mapped Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          format: uuid
          nullable: true
          readOnly: true
          example: 98aacc2c-5bcd-43da-8425-cbd17034e826
        status:
          type: string
          description: The status of the request(`Complete` `Failed`)
          nullable: true
          example: Complete
        company_id:
          type: string
          description: Sikoia ID for the Company
          format: uuid
          nullable: true
          readOnly: true
          example: 78662640-73fc-4fa9-8367-ef4660d35cee
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          readOnly: true
          example: '2024-02-12T15:34:25.485Z'
        message:
          type: string
          description: Additional detail about the request
          nullable: true
        company_name:
          type: string
          description: The name of the company
          nullable: true
          example: Acme Inc
        data:
          $ref: '#/components/schemas/SikoiaSharedModels.BusinessSupport.OnlineData.Response.Mapped.OnlineData'
      additionalProperties: false
    SikoiaSharedModels.BusinessSupport.OnlineData.Response.Mapped.Phone:
      title: Phone
      type: object
      properties:
        number_type:
          type: string
          description: The Number Type (e.g. Work vs Private)
          nullable: true
        date_from:
          type: string
          description: Creation Date of the Number
          nullable: true
        date_to:
          type: string
          description: Deleteion Date of the Number
          nullable: true
        country_code:
          type: string
          description: The Country Code of the Number
          nullable: true
        full_number:
          type: string
          description: The Full Number
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.AffordabilityInsights.Request.AffordabilityInsightsRequest:
      title: Affordability Insights Request
      required:
      - entity_id
      - entity_type
      type: object
      properties:
        entity_id:
          minLength: 1
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity
          example: 3f615611-3dc3-418b-bed5-a53c4390c97c
        entity_type:
          minLength: 1
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity
          example: case
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.AffordabilityInsightsResponse:
      title: Affordability Insights Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          nullable: true
          example: a5f84a41-01cf-4d21-901d-124c5a7c743a
        status:
          type: string
          description: The status of the request(`Pending` `Failed`)
          nullable: true
          example: Pending
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity
          nullable: true
          example: 7885857d-fa2b-43ab-8b15-67e5fea8e896
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity
          nullable: true
          example: case
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          example: '2023-11-24T12:38:45.711Z'
        datetime_completed:
          type: string
          description: The time the request was completed
          nullable: true
          example: '2023-11-24T12:41:14.222Z'
        message:
          type: string
          description: Additional detail about the request
          nullable: true
          example: Affordability insights pending
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.OrchestrationListResponse:
      title: Affordability Insights List Response
      type: object
      properties:
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity
          nullable: true
          example: 7885857d-fa2b-43ab-8b15-67e5fea8e896
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity
          nullable: true
          example: case
        affordability_insights_requests:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.OrchestrationResponse'
          description: The List of Affordability Insights Requests
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.OrchestrationResponse:
      title: Affordability Insights Orchestration Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          nullable: true
          example: a5f84a41-01cf-4d21-901d-124c5a7c743a
        status:
          type: string
          description: The status of the request(`Pending` `Complete` `Failed`)
          nullable: true
          example: Complete
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          example: '2023-11-29T12:21:52.933Z'
        datetime_completed:
          type: string
          description: The time the request was completed
          nullable: true
          example: '2023-11-29T12:22:07.747Z'
        message:
          type: string
          description: Additional detail about the request
          nullable: true
          example: Affordability insights complete
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.AffordabilityInsightsData:
      title: Affordability Insights Data
      type: object
      properties:
        cashflow:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.Cashflow'
          description: The Cashflow
          nullable: true
        indicators:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.Indicator'
          description: The Indicators
          nullable: true
        data_sources:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.DataSource'
          description: The Data Sources
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.AffordabilityInsightsMappedResponse:
      title: Affordability Insights Mapped Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          nullable: true
          example: a5f84a41-01cf-4d21-901d-124c5a7c743a
        status:
          type: string
          description: The status of the request(`Pending` `Complete` `Failed`)
          nullable: true
          example: Complete
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity
          nullable: true
          example: 7885857d-fa2b-43ab-8b15-67e5fea8e896
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity
          nullable: true
          example: case
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          example: '2023-11-29T12:21:52.933Z'
        datetime_completed:
          type: string
          description: The time the request was completed
          nullable: true
          example: '2023-11-29T12:22:07.747Z'
        message:
          type: string
          description: Additional detail about the request
          nullable: true
          example: Affordability insights pending
        data:
          $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.AffordabilityInsightsData'
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.Cashflow:
      title: Cashflow
      type: object
      properties:
        group:
          type: string
          description: The Group of the Categories(`Income` `Essential expenditure` `Non-essential expenditure` `Other`)
          nullable: true
          example: Income
        value:
          type: number
          description: The Total Value of the Group Cashflow
          format: double
          nullable: true
          example: '5249.19'
        categories:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.Category'
          description: The List of Categories in the Group
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.Category:
      title: Category
      type: object
      properties:
        name:
          type: string
          description: The Category Name(`Employment and/or Self-employment` `Benefits` `Other income` `Mortgage and rent`
            `Transportation and travel` `Utilities` `Groceries and shopping` `Credit cards and loans` `Cash withdrawal` `Insurance
            premiums` `Petcare` `Tax` `Healthcare` `Education` `Other essential expenditure` `Entertainment` `TV and subscriptions`
            `Savings` `Gambling` `Shopping` `Other non-essential expenses` `Other` `Other inflows` `Transfers`)
          nullable: true
          example: Employment and/or Self-employment
        value:
          type: number
          description: The Value of the Category Cashflow
          format: double
          nullable: true
          example: '5109.45'
        subcategories:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.SubCategory'
          description: Contains detailed breakdown of the category cashflow with granular sub-categories
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.DataSource:
      title: Data Source
      type: object
      properties:
        source_id:
          type: string
          description: The ID of the root source of data, this can be a document ID for files like bank statements or an account
            id for a successful open banking connection
          readOnly: true
          example: 4b9ac393-d34b-4a14-9ee3-88ce2d244e90
        source_name:
          type: string
          description: Optional value that is either the name of the file (like a bank statement) or null if the data source
            has no name (like a banking connection)
          nullable: true
          readOnly: true
          example: Stmt - current - Feb 2023 - J Smith and J Hayley
        source_category_type:
          type: string
          description: The name of the base source of data e.g. a document or open banking(`Document` `OpenBanking`)
          nullable: true
          example: Document
        source_type:
          type: string
          description: The specific type of data that was identified such as a bank statement or bank account(`BankStatement`
            `BankAccount`)
          nullable: true
          example: BankStatement
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.DetailedTransaction:
      title: Detailed Transaction
      type: object
      properties:
        transaction_id:
          type: string
          description: The unique identifier of a single transaction
          nullable: true
          example: e77cc404-5978-4429-a25a-135303cd8fdf
        account_connection_id:
          type: string
          description: The Account Connection ID of the bank
          nullable: true
          example: e77cc404-5978-4429-a25a-135303cd8fdf
        date:
          type: string
          description: The date the transaction was made
          nullable: true
          example: '2025-01-24'
        group:
          type: string
          description: The Group of the Transaction(`Income` `Essential expenditure` `Non-essential expenditure` `Other`)
          nullable: true
          example: Essential expenditure
        category:
          type: string
          description: The Category of the Transaction(`Employment and/or Self-employment` `Benefits` `Other income` `Mortgage
            and rent` `Transportation and travel` `Utilities` `Groceries and shopping` `Credit cards and loans` `Cash withdrawal`
            `Insurance premiums` `Petcare` `Tax` `Healthcare` `Education` `Other essential expenditure` `Entertainment` `TV
            and subscriptions` `Savings` `Gambling` `Shopping` `Other non-essential expenses` `Other` `Other inflows` `Transfers`)
          nullable: true
          example: Utilities
        subcategory:
          type: string
          description: 'The Sub-category of the Transaction. For a full list of available sub-categories, please visit this
            link: https://docs.sikoia.com/docs/groups-categories-indicators.'
          nullable: true
          example: Phone and broadband
        short_description:
          type: string
          description: The Short Description of the Transaction
          nullable: true
          example: EE Limited
        long_description:
          type: string
          description: The Long Description of the Transaction
          nullable: true
          example: EE LIMITED, LONDON GB
        amount:
          type: number
          description: The Value of the Transaction
          format: double
          example: '-6.90'
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.Indicator:
      title: Indicator
      type: object
      properties:
        name:
          type: string
          description: The Indicator Name(`Benefits` `Children` `Gambling` `High value transactions` `Insurance` `Loans (excluding
            credit cards)`)
          nullable: true
          example: Benefits
        present:
          type: boolean
          description: Flag for Indicator Presence
          nullable: true
          example: 'true'
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.DetailedTransaction'
          description: Any transactions that caused this specific flag to be true
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.SubCategory:
      title: SubCategory
      type: object
      properties:
        name:
          type: string
          description: 'The Sub-category Name. For a full list of available sub-categories, please visit this link: https://docs.sikoia.com/docs/groups-categories-indicators.'
          nullable: true
          example: Phone / Broadband
        value:
          type: number
          description: The Value of the Sub-category Cashflow
          format: double
          nullable: true
          example: '5109.45'
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.MonthlyData:
      title: Monthly Data
      type: object
      properties:
        year:
          type: integer
          description: The Year
          format: int32
          nullable: true
          example: '2023'
        month:
          type: integer
          description: The Month
          format: int32
          nullable: true
          example: '10'
        total_value:
          type: number
          description: The Total Value of the Transactions for the Period
          format: double
          nullable: true
          example: '-90.48'
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.Transaction:
      title: Transaction
      type: object
      properties:
        group:
          type: string
          description: The Group of the Transactions(`Income` `Essential expenditure` `Non-essential expenditure` `Other`)
          nullable: true
          example: Essential expenditure
        category:
          type: string
          description: The Category of the Transactions(`Employment and/or Self-employment` `Benefits` `Other income` `Mortgage
            and rent` `Transportation and travel` `Utilities` `Groceries and shopping` `Credit cards and loans` `Cash withdrawal`
            `Insurance premiums` `Petcare` `Tax` `Healthcare` `Education` `Other essential expenditure` `Entertainment` `TV
            and subscriptions` `Savings` `Gambling` `Shopping` `Other non-essential expenses` `Other` `Other inflows` `Transfers`)
          nullable: true
          example: Utilities
        subcategory:
          type: string
          description: 'The Sub-category of the Transactions. For a full list of available sub-categories, please visit this
            link: https://docs.sikoia.com/docs/groups-categories-indicators.'
          nullable: true
          example: Phone / Broadband
        short_description:
          type: string
          description: The Short Description of the Transactions
          nullable: true
          example: EE Limited
        number_of_transactions:
          type: integer
          description: The Number of Transactions
          format: int32
          nullable: true
          example: '6'
        total_value:
          type: number
          description: The Total Value of the Transactions
          format: double
          nullable: true
          example: '-271.4'
        average_value:
          type: number
          description: The Average Value of the Transactions
          format: double
          nullable: true
          example: '-45.2'
        minimum_value:
          type: number
          description: The Minimum Value of the Transactions
          format: double
          nullable: true
          example: '-50.34'
        maximum_value:
          type: number
          description: The Maximum Value of the Transactions
          format: double
          nullable: true
          example: '-40.14'
        monthly_data:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.MonthlyData'
          description: The Monthly Breakdown of Transactions
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.TransactionViewMappedResponse:
      title: Transaction View Mapped Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          nullable: true
          example: a5f84a41-01cf-4d21-901d-124c5a7c743a
        status:
          type: string
          description: The status of the request(`Pending` `Complete` `Failed`)
          nullable: true
          example: Complete
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity
          nullable: true
          example: 7885857d-fa2b-43ab-8b15-67e5fea8e896
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity
          nullable: true
          example: case
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          example: '2023-11-29T12:21:52.933Z'
        datetime_completed:
          type: string
          description: The time the request was completed
          nullable: true
          example: '2023-11-29T12:22:07.747Z'
        message:
          type: string
          description: Additional detail about the request
          nullable: true
          example: Affordability insights completed.
        data:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.Transaction'
          description: The Data
          nullable: true
        data_sources:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.DataSource'
          description: The Data Sources
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.TransactionDetailMappedResponse:
      title: Transaction Detail Mapped Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          nullable: true
          example: a5f84a41-01cf-4d21-901d-124c5a7c743a
        status:
          type: string
          description: The status of the request(`Pending` `Complete` `Failed`)
          nullable: true
          example: Complete
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity
          nullable: true
          example: 7885857d-fa2b-43ab-8b15-67e5fea8e896
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity
          nullable: true
          example: case
        datetime_requested:
          type: string
          description: The time the request was made
          nullable: true
          example: '2023-11-29T12:21:52.933Z'
        datetime_completed:
          type: string
          description: The time the request was completed
          nullable: true
          example: '2023-11-29T12:22:07.747Z'
        message:
          type: string
          description: Additional detail about the request
          nullable: true
          example: Affordability insights completed.
        data:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.DetailedTransaction'
          description: The Data
          nullable: true
        data_sources:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.AffordabilityInsights.Response.Mapped.DataSource'
          description: The Data Sources
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Request.IncomeEmployerRequest:
      title: Income Employer Request
      required:
      - entity_id
      - entity_type
      type: object
      properties:
        entity_id:
          minLength: 1
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity
          example: 473078e-e392-4943-9ea9-efe7590eb503
        entity_type:
          minLength: 1
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity
          example: case
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.IncomeEmployerResponse:
      title: Income Employer Response
      type: object
      properties:
        request_id:
          type: string
          description: The unique Sikoia identifier for the request.
          nullable: true
          example: 8ef5079a-b3de-44a5-b4ff-c534259e752c
        status:
          type: string
          description: The current status of the request, which can be `Pending`, or `Failed`.
          nullable: true
          example: Pending
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity.
          nullable: true
          example: b3f6ed8f-bc57-4a23-801e-e744aecb7b03
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity.
          nullable: true
          example: case
        datetime_requested:
          type: string
          description: The date and time when the request was initiated.
          nullable: true
          example: '2024-01-01T12:38:45.711Z'
        datetime_completed:
          type: string
          description: The date and time when the request was completed.
          nullable: true
          example: '2024-01-02T12:22:07.747Z'
        message:
          type: string
          description: Additional details or context about the request.
          nullable: true
          example: Income request pending
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.OrchestrationListResponse:
      title: Income Employer List Response
      type: object
      properties:
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity
          nullable: true
          example: 3345857d-fa2b-43ab-8b15-67e5fea8e896
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity
          nullable: true
          example: case
        income_employer_requests:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.OrchestrationResponse'
          description: A list of income & employer verification requests for the entity
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.OrchestrationResponse:
      title: Income Employer Orchestration Response
      type: object
      properties:
        request_id:
          type: string
          description: Sikoia ID for the request
          nullable: true
          example: w5f84a41-01cf-4d21-901d-124c5a7c743a
        status:
          type: string
          description: The status of the request, such as `Pending` `Complete` `Failed`.
          nullable: true
          example: Complete
        datetime_requested:
          type: string
          description: The time the request was made.
          nullable: true
          example: '2024-01-29T12:21:52.933Z'
        datetime_completed:
          type: string
          description: The time the request was completed.
          nullable: true
          example: '2024-01-30T09:44:22.466Z'
        message:
          type: string
          description: Additional detail about the request.
          nullable: true
          example: Income Employer complete
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.AdditionalInformation:
      type: object
      properties:
        bonuses:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.Bonus'
          description: Any income received as bonuses, in addition to regular pay. Only available for payslips.
          nullable: true
        monthly_student_loan_deductions:
          type: number
          description: The total monthly deductions for student loan repayments. Only available for payslips.
          format: double
          nullable: true
          example: '222.44'
          deprecated: true
        monthly_gross_pay_details:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.PayItem'
          description: Contains detailed breakdown of the monthly gross pay. Only available for payslips.
          nullable: true
        monthly_deductions_details:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.DeductionItem'
          description: Contains a detailed breakdown of the monthly deductions from pay. Only available for payslips.
          nullable: true
        average_income_items:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.AverageIncomeItem'
          description: Contains a list of the income items averaged across the SA302s provided. Only available for SA302s.
          nullable: true
        average_tax_items:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.AverageTaxItem'
          description: Contains a list of the tax items averaged across the SA302s provided. Only available for tax documents.
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.AverageIncomeItem:
      type: object
      properties:
        category:
          type: string
          description: The category of the income item(`PayFromAllEmployments` `BenefitsAndExpenses` `AllowableExpenses` `TotalEmploymentIncome`
            `ShareSchemes` `SelfEmployment` `InterestFromPartnerships` `DividendsFromPartnerships` `PropertyIncome` `ForeignIncome`
            `ForeignDividends` `ForeignSavings` `ForeignLifeInsurance` `TrustsAndEstates` `UkInterest` `UkDividends` `UkPensionsAndBenefits`
            `UkLifeInsurance` `OtherIncome` `TotalIncomeReceived` `RetirementAnnuityDeduction` `ForeignTaxOnEstatesDeduction`
            `IncomeTaxRelief` `AnnuityDeduction` `GiftsToCharity` `PersonalAllowance` `MarriageAllowanceTransfer` `BlindPersonAllowance`
            `TotalDeductionsApplied` `TotalTaxableIncome`)
          nullable: true
          example: PayFromAllEmployments
        value:
          type: number
          description: The average value of the income item across the SA302s provided.
          format: double
          nullable: true
          example: '1971.42'
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.AverageTaxItem:
      type: object
      properties:
        category:
          type: string
          description: The category of the tax item(`Tax` `TaxOverpaid` `Surcharges` `Interest` `Penalties` `Subtotal` `PaymentsForThisYear`
            `OtherAdjustments` `Total`)
          nullable: true
          example: Tax
        short_description:
          type: string
          description: The category of the tax item.
          nullable: true
          example: Class 4 NIC
        value:
          type: number
          description: The average value of the tax item across the tax documents provided.
          format: double
          nullable: true
          example: '1971.42'
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.Bonus:
      type: object
      properties:
        amount:
          type: number
          description: The value of the bonus payment.
          format: double
          nullable: true
          example: '222.22'
        date:
          type: string
          description: The date the bonus was paid or awarded.
          nullable: true
          example: '2024-01-01'
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.Data:
      type: object
      properties:
        income_details:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.IncomeEmployerDetail'
          description: A list of income employment details, where each item represents an 'income recipient' and 'income source'
            pair.
          nullable: true
        data_sources:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.DataSource'
          description: Income Employment Sources
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.DataSource:
      type: object
      properties:
        source_name:
          type: string
          description: Optional. The name of the data source (e.g. a file name like 'payslip') or null if no specific name
            is provided (e.g. for banking connections).
          nullable: true
          readOnly: true
          example: Stmt - current - Feb 2023 - J Smith and J Hayley
        source_id:
          type: string
          description: The ID of the primary data source, such as a document ID for files (e.g. payslips) or an account ID
            for an open banking connection.
          readOnly: true
          example: 4b9ac393-d34b-4a14-9ee3-88ce2d244e90
        source_category_type:
          type: string
          description: The category of the data source, such as `Document` or `OpenBanking`.
          readOnly: true
          example: Document
        source_type:
          type: string
          description: The specific type of data identified, such as `Payslip`, `BankStatement`, `BankAccount`, `SA302`, `TaxOverview`.
          nullable: true
          readOnly: true
          example: Payslip
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.DeductionItem:
      type: object
      properties:
        category:
          type: string
          description: Sikoia’s categorisation of the deduction type(`MonthlyIncomeTax` `MonthlyEmployeePension` `MonthlyEmployerPension`
            `MonthlyNationalInsurance` `MonthlyStudentLoan` `MonthlyHealthInsurance` `MonthlyOtherLoans` `MonthlyChildcare`
            `MonthlyChildcareVouchers` `MonthlySalarySacrifice` `MonthlyOtherDeductions`)
          nullable: true
          example: MonthlyIncomeTax
        amount:
          type: number
          description: The amount of the deduction for the specified category.
          format: double
          nullable: true
          example: '167.15'
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.IncomeDataSource:
      type: object
      properties:
        source_type:
          type: string
          description: The specific type of data identified, such as `Payslip`, `BankStatement`, `BankAccount`, `SA302`, `TaxOverview`.
          nullable: true
          readOnly: true
          example: Payslip
        number_of_sources:
          type: integer
          description: The number of data sources.
          format: int32
          example: '1'
        start_date:
          type: string
          description: The start of the date range covered by the data sources.
          nullable: true
          example: 2024-01
        end_date:
          type: string
          description: The end of the date range covered by the data sources.
          nullable: true
          example: 2024-02
        data_sources:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.DataSource'
          description: A list of the individual data sources used, such as 'payslip documents'.
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.IncomeEmployeeAddress:
      type: object
      properties:
        summary_line:
          type: string
          description: The address of the employer, as stated on the payslip.
          nullable: true
          example: 19, Sample Street, London
        post_code:
          type: string
          description: The postcode of the employer, as stated on the payslip.
          nullable: true
          example: SW1 1PN
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.IncomeEmployerDetail:
      type: object
      properties:
        income_recipient:
          type: string
          description: The recipient of the income.
          nullable: true
          example: Sharon Smith
        income_type:
          type: string
          description: The type of income, which can be `Employment`, `Employment and/or Self-employment`, `Benefits`, `Pensions`,
            `Property`, `Dividends` or `Other`.
          nullable: true
          example: Employment
        income_source:
          type: string
          description: The source of the income, such as the employer or organization providing the income.  Only available
            for payslips and bank statements.
          nullable: true
          example: BUILDING HOME LTD
        annual_gross_pay:
          type: number
          description: The total annual gross pay before deductions. Only available for payslips.
          format: double
          nullable: true
          example: '23657.04'
        monthly_gross_pay:
          type: number
          description: The total monthly gross pay before deductions. Only available for payslips.
          format: double
          nullable: true
          example: '1971.42'
        monthly_deductions:
          type: number
          description: The total monthly deductions from the gross pay. Only available for payslips.
          format: double
          nullable: true
          example: '319.49'
        monthly_net_pay:
          type: number
          description: The total monthly net pay after deductions. Only available for payslips and bank statements.
          format: double
          nullable: true
          example: '1561.93'
        pay_frequencies:
          type: array
          items:
            type: string
          description: A list of pay frequencies derived from all data sources, such as `Monthly`, `Weekly`, `TwoWeekly`,
            or `FourWeekly`. Only available for payslips.
          nullable: true
        national_insurance_number:
          type: array
          items:
            type: string
          description: A list of National Insurance Numbers associated with the individual, derived from all relevant data
            sources. Only available for payslips and SA302s.
          nullable: true
        national_insurance_letters:
          type: array
          items:
            type: string
          description: A list of National Insurance Letters associated with the individual, derived from all relevant data
            sources. Only available for payslips.
          nullable: true
        unique_taxpayer_references:
          type: array
          items:
            type: string
          description: A list of Unique Taxpayer References associated with the individual, derived from all relevant data
            sources. Only available for tax documents.
          nullable: true
        job_titles:
          type: array
          items:
            type: string
          description: A list of the job titles associated with the individual. Only available for payslips.
          nullable: true
        tax_codes:
          type: array
          items:
            type: string
          description: A list of the tax codes associated with the individual, used for tax calculation purposes. Only available
            for payslips.
          nullable: true
        paye_references:
          type: array
          items:
            type: string
          description: A list of the paye references associated with the individual, used for tax calculation purposes. Only
            available for payslips.
          nullable: true
        employee_numbers:
          type: array
          items:
            type: string
          description: A list of the employee numbers associated with the individual, used for tax calculation purposes. Only
            available for payslips.
          nullable: true
        ytd_gross_pay:
          type: number
          description: The gross pay earned by the individual year-to-date. Only available for payslips.
          format: double
          nullable: true
          example: '22472.85'
        ytd_net_pay:
          type: number
          description: The net pay earned by the individual year-to-date. Only available for payslips.
          format: double
          nullable: true
          example: '18070.33'
        ytd_tax_paid:
          type: number
          description: The total tax paid by the individual year-to-date. Only available for payslips.
          format: double
          nullable: true
          example: '1100.63'
        ytd_ni_paid:
          type: number
          description: The total National Insurance contributions paid by the individual year-to-date. Only available for
            payslips.
          format: double
          nullable: true
          example: '1100.63'
        ytd_pension_paid:
          type: number
          description: The total pension contributions made by the individual year-to-date. Only available for payslips.
          format: double
          nullable: true
          example: '1100.63'
        ytd_other_deductions:
          type: number
          description: Any additional deductions paid by the individual year-to-date. Only available for payslips.
          format: double
          nullable: true
          example: '1100.63'
        additional_information:
          $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.AdditionalInformation'
        income_source_addresses:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.IncomeSourceAddress'
          description: The employer addresses and postcodes. Only available for payslips.
          nullable: true
        employee_addresses:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.IncomeEmployeeAddress'
          description: The employee addresses and postcodes. Only available for payslips.
          nullable: true
        income_data_sources:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.IncomeDataSource'
          description: The sources of income used to generate this 'income recipient' and 'income source' pair, such as `Payslip`
            or `BankStatement`.
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.IncomeEmployerMappedResponse:
      title: Income Employer Response
      type: object
      properties:
        request_id:
          type: string
          description: The unique Sikoia identifier for the request.
          nullable: true
          example: 8ef5079a-b3de-44a5-b4ff-c534259e752c
        status:
          type: string
          description: The current status of the request, which can be `Pending`, `Complete`, or `Failed`.
          nullable: true
          example: Pending
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity.
          nullable: true
          example: b3f6ed8f-bc57-4a23-801e-e744aecb7b03
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity.
          nullable: true
          example: case
        datetime_requested:
          type: string
          description: The date and time when the request was initiated.
          nullable: true
          example: '2024-01-01T12:38:45.711Z'
        datetime_completed:
          type: string
          description: The date and time when the request was completed.
          nullable: true
          example: '2024-01-02T12:22:07.747Z'
        message:
          type: string
          description: Additional details or context about the request.
          nullable: true
          example: Income request pending
        data:
          $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.Data'
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.IncomeSourceAddress:
      type: object
      properties:
        summary_line:
          type: string
          description: The address of the employer, as stated on the payslip.
          nullable: true
          example: Flat 23, Sample Street, London
        post_code:
          type: string
          description: The postcode of the employer, as stated on the payslip.
          nullable: true
          example: SW4 4PL
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.PayItem:
      type: object
      properties:
        category:
          type: string
          description: Sikoia’s categorisation of the pay type(`MonthlyBonusPay` `MonthlyBasicPay` `MonthlyArrears` `MonthlyPensionPay`
            `MonthlySalarySacrifice` `MonthlyCommissionPay` `MonthlyParentalPay` `MonthlySickPay` `MonthlyOvertimePay` `MonthlyShiftAllowancePay`
            `MonthlyHolidayPay` `MonthlyCarAllowancePay` `MonthlyOtherBenefitsInKind` `MonthlyHealthcareBenefitPay` `MonthlyOtherGrossPay`)
          nullable: true
          example: MonthlyBasicPay
        amount:
          type: number
          description: The amount of pay for the specified category.
          format: double
          nullable: true
          example: '222.44'
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.Detail:
      type: object
      properties:
        source_type:
          type: string
          description: The specific type of data identified, such as `Payslip`, `BankStatement`, `BankAccount`, `SA302`, `TaxOverview`.
          nullable: true
          example: Payslip
        source_id:
          type: string
          description: The ID of the primary data source, such as a document ID for files (e.g. payslips) or an account connection
            ID for an open banking connection.
          nullable: true
          example: 4b9ac393-d34b-4a14-9ee3-88ce2d244e90
        data_source_id:
          type: string
          description: A unique identifier for a specific data source within a document, such as an individual payslip in
            a multi-payslip file or an individual bank statement in a multi-statement document.
          readOnly: true
          example: 01951375-a680-77ce-b196-44d1feedc47c
        source_name:
          type: string
          description: Optional. The name of the data source (e.g. a file name like 'Payslip Jane Smith') or null if no specific
            name is provided (e.g. for banking connections).
          nullable: true
          example: Stmt - current - Feb 2023 - J Smith and J Hayley.pdf
        income_source_data:
          $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.IncomeSourceData'
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.DetailedDeductionItem:
      type: object
      properties:
        category:
          type: string
          description: Sikoia’s categorisation of the deduction type(`IncomeTax` `EmployeePension` `EmployerPension` `NationalInsurance`
            `StudentLoan` `OtherLoans` `HealthInsurance` `Childcare` `ChildcareVouchers` `SalarySacrifice` `Other`)
          nullable: true
          example: IncomeTax
        short_description:
          type: string
          description: The description of the deduction item, as stated on the payslip.
          nullable: true
          example: PAYE
        value:
          type: number
          description: The value of the deduction item, as stated on the payslip.
          format: double
          nullable: true
          example: '319.49'
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.DetailedPayItem:
      type: object
      properties:
        category:
          type: string
          description: Sikoia’s categorisation of the pay type(`BonusPay` `BasicPay` `Arrears` `PensionPay` `SalarySacrifice`
            `CommissionPay` `ParentalPay` `SickPay` `OvertimePay` `ShiftAllowancePay` `HolidayPay` `CarAllowancePay` `OtherBenefitsInKind`
            `HealthcareBenefitPay` `Other`)
          nullable: true
          example: BasicPay
        short_description:
          type: string
          description: The description of the pay item, as stated on the payslip.
          nullable: true
          example: January Salary
        value:
          type: number
          description: The value of the pay item, as stated on the payslip.
          format: double
          nullable: true
          example: '1971.42'
        rate:
          type: number
          description: The rate of the pay item, as stated on the payslip.
          format: double
          nullable: true
          example: '1'
        quantity:
          type: number
          description: The quantity of the pay item, as stated on the payslip.
          format: double
          nullable: true
          example: '1'
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.IncomeData:
      type: object
      properties:
        income_recipient:
          type: string
          description: The recipient of the income.
          nullable: true
          example: Sharon Smith
        income_type:
          type: string
          description: The type of income, which can be `Employment`, `Employment and/or Self-employment`, `Benefits`, `Pensions`,
            `Property`, `Dividends` or `Other`.
          nullable: true
          example: Employment
        income_source:
          type: string
          description: The source of the income, such as the employer or organisation providing the income. Only available
            for payslips and bank statements.
          nullable: true
          example: BUILDING HOME LTD
        details:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.Detail'
          description: A list of income employment details, where each item represents an 'income recipient' and 'income source'
            pair.
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.IncomeEmployeeAddress:
      type: object
      properties:
        summary_line:
          type: string
          description: The address of the employer, as stated on the payslip.
          nullable: true
          example: 19, Sample Street, London
        post_code:
          type: string
          description: The postcode of the employer, as stated on the payslip.
          nullable: true
          example: SW1 1PN
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.IncomeEmployerAdditionalDetailsResponse:
      title: Income Employer Details Response
      type: object
      properties:
        request_id:
          type: string
          description: The unique Sikoia identifier for the request.
          nullable: true
          example: 8ef5079a-b3de-44a5-b4ff-c534259e752c
        status:
          type: string
          description: The current status of the request, which can be `Pending`, `Complete`, or `Failed`.
          nullable: true
          example: Pending
        entity_id:
          type: string
          description: The `company_id`; `person_id` or `case_id` of the entity.
          nullable: true
          example: b3f6ed8f-bc57-4a23-801e-e744aecb7b03
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity.
          nullable: true
          example: case
        datetime_requested:
          type: string
          description: The date and time when the request was initiated.
          nullable: true
          example: '2024-01-01T12:38:45.711Z'
        datetime_completed:
          type: string
          description: The date and time when the request was completed.
          nullable: true
          example: '2024-01-02T12:22:07.747Z'
        message:
          type: string
          description: Additional details or context about the request.
          nullable: true
          example: Income request pending
        data:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.IncomeData'
          description: The Income & Employer data items.
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.IncomeSourceAddress:
      type: object
      properties:
        summary_line:
          type: string
          description: The address of the employer, as stated on the payslip.
          nullable: true
          example: Flat 23, Sample Street, London
        post_code:
          type: string
          description: The postcode of the employer, as stated on the payslip.
          nullable: true
          example: SW4 4PL
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.TaxInformation:
      title: Tax information surfaced from an uploaded file such as an `SA302` or `TaxYearOverview`
      type: object
      properties:
        summary:
          $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.TaxInformationSummary'
        income:
          $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.TaxInformationIncome'
        tax_and_charges:
          $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.TaxInformationTaxAndCharges'
        payments:
          $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.TaxInformationPayments'
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.TaxInformationIncome:
      type: object
      properties:
        income_from_employments:
          type: number
          description: The total of all income items gained from employment
          format: double
          nullable: true
          example: '21843.00'
        income_from_benefits:
          type: number
          description: The total of all income from taxable state issued benefits excluding pensions
          format: double
          nullable: true
        allowable_expenses:
          type: number
          description: Any claims to reduce taxable earnings such as interest on business loans
          format: double
          nullable: true
        non_employment_income:
          $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.TaxInformationNonEmploymentIncome'
        total:
          type: number
          description: The (gross) total income earned by an individual from all sources
          format: double
          nullable: true
          example: '48933.00'
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.TaxInformationNonEmploymentIncome:
      title: ''
      type: object
      properties:
        share_schemes:
          type: number
          description: Any income gained from share schemes in UK companies
          format: double
          nullable: true
        profit_from_self_employment:
          type: number
          description: Any profit earned from an individual's self employment role
          format: double
          nullable: true
        profit_from_partnerships:
          type: number
          description: Any profit earned from a UK partnership
          format: double
          nullable: true
        interest_from_partnerships:
          type: number
          description: Any interest from a UK partnership
          format: double
          nullable: true
        dividends_from_partnerships:
          type: number
          description: Any dividends paid out to a shareholder in a UK parternship
          format: double
          nullable: true
        profit_from_uk_land_and_property:
          type: number
          description: Any profit earned from land and property assets in the UK
          format: double
          nullable: true
          example: '14590.00'
        foreign_income:
          type: number
          description: Any income earned from sources outside of the UK
          format: double
          nullable: true
        foreign_dividends:
          type: number
          description: Any dividends paid out from non-UK companies
          format: double
          nullable: true
        foreign_savings:
          type: number
          description: Any earnings from savings accounts outside of the UK
          format: double
          nullable: true
        trusts_and_estates:
          type: number
          description: Any earnings from trusts and estates registered in the UK
          format: double
          nullable: true
        interest_from_uk_banks:
          type: number
          description: Any interest earned in bank accounts registered in the UK
          format: double
          nullable: true
        dividends_from_uk_companies:
          type: number
          description: Any dividend payments from UK registered companies
          format: double
          nullable: true
          example: '12500.00'
        uk_pensions_and_state_benefits:
          type: number
          description: The combined income from pensions and taxable state benefits
          format: double
          nullable: true
        gains_on_life_insurance_policies:
          type: number
          description: Any income earned from a life insurance policy paying out
          format: double
          nullable: true
        other_income:
          type: number
          description: All other income not already broken down in one of the named fields
          format: double
          nullable: true
        subtotal:
          type: number
          description: The total of all non employment income figures shown here
          format: double
          nullable: true
          example: '27090.00'
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.TaxInformationPayments:
      type: object
      properties:
        tax_already_paid_for_this_year:
          type: number
          description: Any tax payments already made towards the oustanding balance owed
          format: double
          nullable: true
        outstanding_from_last_year:
          type: number
          description: Any tax payments still owed from the previous financial year
          format: double
          nullable: true
        balancing_payment_for_this_year:
          type: number
          description: Any tax still outstanding before January 31st following the end of the tax year before penalties/interest
            may start being charged
          format: double
          nullable: true
        first_payment_on_account_for_next_year:
          type: number
          description: Any payment on account due by the 31st of January at the end of the current tax year
          format: double
          nullable: true
        second_payment_on_account_for_next_year:
          type: number
          description: Any payment on account due by 31st July for the previous tax year
          format: double
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.TaxInformationSummary:
      type: object
      properties:
        employment_income:
          type: number
          description: The total of all income items gained from employment
          format: double
          nullable: true
          example: '21843.00'
        total_income:
          type: number
          description: The total (gross) of all income items
          format: double
          nullable: true
          example: '48933.00'
        net_income:
          type: number
          description: The total income remaining after all owed taxes have been taken away
          format: double
          nullable: true
          example: '47437.30'
        allowances_and_reliefs:
          type: number
          description: The total of all items that reduce a person's tax liability including any personal allowance
          format: double
          nullable: true
          example: '12570.00'
        tax_due:
          type: number
          description: The total (gross) amount of tax due
          format: double
          nullable: true
          example: '3348.70'
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.TaxInformationTaxAndCharges:
      type: object
      properties:
        tax_charged_before_reliefs:
          type: number
          description: Tax amount charged before reductions and reliefs are considered
          format: double
          nullable: true
          example: '5560.10'
        tax_charged_after_reliefs:
          type: number
          description: Tax amount charged after reductions and reliefs are considered
          format: double
          nullable: true
          example: '3348.70'
        tax_relief_for_financing_costs:
          type: number
          description: Any reliefs (reduction in tax) applicable due to financing costs
          format: double
          nullable: true
          example: '-1959.40'
        other_tax_reductions_and_reliefs:
          type: number
          description: Any other reductions in tax applicable to the final amount owed
          format: double
          nullable: true
          example: '-252.00'
        national_insurance:
          type: number
          description: Any mandatory contributions outstanding for paying National Insurance
          format: double
          nullable: true
        student_loan_repayments:
          type: number
          description: Any payments due for paying off a student loan previously taken out
          format: double
          nullable: true
        capital_gains_tax:
          type: number
          description: Any tax due from profitting from the sale of an asset that has increased in value such as property
            or shares
          format: double
          nullable: true
        other_amounts_paid_via_tax:
          type: number
          description: Any other tax contributions paid by this individual
          format: double
          nullable: true
        total_tax_due:
          type: number
          description: Total (gross) tax amount owed by this individual
          format: double
          nullable: true
          example: '3348.70'
        tax_deducted:
          type: number
          description: All deductions made to reduce the net value owed
          format: double
          nullable: true
          example: '-1853.00'
        net_tax_due:
          type: number
          description: Final tax amount owed by the individual once all reductions and reliefs have been taken into account
          format: double
          nullable: true
          example: '1495.70'
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Response.IncomeSourceData:
      type: object
      properties:
        payslip_date:
          type: string
          description: The date on which the payslip was issued. Only available for payslips.
          nullable: true
          example: '2024-01-31'
        pay_period_start_date:
          type: string
          description: The starting date of the payment period covered by the payslip. Only available for payslips.
          nullable: true
          example: '2024-01-01'
        pay_period_end_date:
          type: string
          description: The ending date of the payment period covered by the payslip. Only available for payslips.
          nullable: true
          example: '2024-01-31'
        payment_date:
          type: string
          description: The date the payment was issued or is scheduled to be issued. Only available for payslips.
          nullable: true
          example: '2024-01-31'
        start_date:
          type: string
          description: The starting date of the bank transactions. Only available for bank statements and tax documents.
          nullable: true
          example: '2024-01-01'
        end_date:
          type: string
          description: The ending date of the bank transactions. Only available for bank statements and tax documents.
          nullable: true
          example: '2024-04-01'
        pay_frequency:
          type: string
          description: A list of pay frequencies derived from all data sources, such as `Monthly`, `Weekly`, `TwoWeekly`,
            or `FourWeekly`. Only available for payslips.
          nullable: true
          example: Monthly
        pay_period:
          type: integer
          description: The period of the fiscal year for which the income is being paid, e.g. 5, 32. Only available for payslips.
          format: int32
          nullable: true
          example: '5'
        gross_pay:
          type: number
          description: The total gross pay as shown on the payslip. Only available for payslips.
          format: double
          nullable: true
          example: '1971.42'
        total_deductions:
          type: number
          description: The total deductions as shown on the payslip. Only available for payslips.
          format: double
          nullable: true
          example: '319.49'
        net_pay:
          type: number
          description: The total net pay displayed on the document. Only available for payslips and bank statements.
          format: double
          nullable: true
          example: Basic Pay
        national_insurance_number:
          type: string
          description: The National Insurance Number associated with the individual. Only available for payslips and SA302s.
          nullable: true
          example: QQ123456B
        national_insurance_letter:
          type: string
          description: The National Insurance Letter associated with the individual. Only available for payslips.
          nullable: true
          example: Q
        unique_taxpayer_reference:
          type: string
          description: The Unique Taxpayer Reference associated with the individual. Only available for tax documents.
          nullable: true
          example: '1234567890'
        tax_code:
          type: string
          description: The Tax Code associated with the individual. Only available for payslips.
          nullable: true
          example: 1257L
        paye_reference:
          type: string
          description: The unique code given to an employer by HMRC. Only available for payslips.
          nullable: true
          example: 123/AB456
        employee_name:
          type: string
          description: The employee name as it appears in the source. Only available for payslips.
          nullable: true
          example: Sharon Smith
        employer_name:
          type: string
          description: The employer name as it appears in the source. Only available for payslips.
          nullable: true
          example: BUILDING HOME LTD
        employee_number:
          type: string
          description: The Employee ID or number associated with the individual. Only available for payslips.
          nullable: true
          example: '1234567890'
        job_title:
          type: string
          description: The employee job title or position. Only available for payslips.
          nullable: true
          example: Customer Services Officer
        income_source_address:
          $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.IncomeSourceAddress'
        employee_address:
          $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.IncomeEmployeeAddress'
        ytd_gross_pay:
          type: number
          description: The total gross pay year-to-date (YTD) as shown on the payslip. Only available for payslips.
          format: double
          nullable: true
          example: '7000.00'
        ytd_net_pay:
          type: number
          description: The total net pay year-to-date (YTD) as shown on the payslip. Only available for payslips.
          format: double
          nullable: true
          example: '2600.00'
        ytd_tax_paid:
          type: number
          description: The total tax paid year-to-date (YTD) as shown on the payslip. Only available for payslips.
          format: double
          nullable: true
          example: '1100.00'
        ytd_ni_paid:
          type: number
          description: The total National Insurance (NI) contributions paid year-to-date (YTD) as shown on the payslip. Only
            available for payslips.
          format: double
          nullable: true
          example: '1100.00'
        ytd_pension_paid:
          type: number
          description: The total pension contributions paid year-to-date (YTD) as shown on the payslip. Only available for
            payslips.
          format: double
          nullable: true
          example: '1100.00'
        ytd_other_deductions:
          type: number
          description: Any additional deductions paid year-to-date (YTD) as shown on the payslip. Only available for payslips.
          format: double
          nullable: true
          example: '1100.00'
        detailed_pay_items:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.DetailedPayItem'
          description: Contains a detailed breakdown of the gross pay. Only available for payslips and bank statements.
          nullable: true
        detailed_deduction_items:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.DetailedDeductionItem'
          description: Contains a detailed breakdown of the deductions from pay. Only available for payslips.
          nullable: true
        tax_information:
          $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.AdditionalDetails.TaxInformation'
      additionalProperties: false
    SikoiaSharedModels.EndUser.IncomeEmployer.Enums.SourceCategoryType:
      title: Source Category Types
      enum:
      - Document
      - OpenBanking
      type: string
      description: The name of the base source of data e.g. a document or open banking
    SikoiaSharedModels.Global.DataSources.DataSource:
      title: Data Source
      type: object
      properties:
        source_name:
          type: string
          description: An optional field containing the name of the data source, such as a file name (e.g. a payslip). If
            the source has no name (e.g. an open banking connection), this field is null.
          nullable: true
          readOnly: true
          example: Stmt - current - Feb 2023 - J Smith and J Hayley
        source_id:
          type: string
          description: The identifier for the root source of the data, such as a document ID for files (e.g. payslips) or
            an account connection ID for a successful open banking connection.
          format: uuid
          readOnly: true
          example: 4b9ac393-d34b-4a14-9ee3-88ce2d244e90
        data_source_id:
          type: string
          description: A unique identifier for a specific data source within a document, such as an individual payslip in
            a multi-payslip file or an individual bank statement in a multi-statement document.
          format: uuid
          readOnly: true
          example: 01951375-a680-77ce-b196-44d1feedc47c
        source_category_type:
          $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Enums.SourceCategoryType'
        source_type:
          $ref: '#/components/schemas/SikoiaSharedModels.Global.DataSources.Enums.DataSourceType'
        status:
          $ref: '#/components/schemas/SikoiaSharedModels.Global.DataSources.Enums.DataSourceStatus'
        message:
          type: string
          description: An optional field providing additional context about the status.
          nullable: true
          readOnly: true
          example: Some message explaining what's happened
        recipient:
          type: string
          description: An optional field populated when the data source includes a named individual, such as the person on
            a payslip or bank statement.
          nullable: true
          readOnly: true
          example: Jane Smith
        source_date:
          type: string
          description: The date associated with the document's data, such as the tax year date on an SA302 form, the payment
            date on a payslip, or the issuance date of the document.
          nullable: true
          readOnly: true
          example: '2023-02-01'
        source_uris:
          type: array
          items:
            type: string
          description: One or more URLs that provide access to additional information about the data source, such as a link
            to retrieve an uploaded bank statement.
          readOnly: true
          example: '["https://api.sikoia.com/v2/documents/4b9ac393-d34b-4a14-9ee3-88ce2d244e90"]'
        start_date:
          type: string
          description: Optional. The starting date, applicable for data sources that span a period, such as a monthly bank
            statement or an open banking connection.
          nullable: true
          readOnly: true
          example: '2023-02-01'
        end_date:
          type: string
          description: Optional. The ending date, applicable for data sources that span a period, such as a monthly bank statement
            or an open banking connection.
          nullable: true
          readOnly: true
          example: '2023-03-01'
        provided_date:
          type: string
          description: The date the data source (e.g. a document) was originally uploaded or created.
          format: date-time
          readOnly: true
          example: '2023-02-10T10:59:46.0000000+00:00'
      additionalProperties: false
    SikoiaSharedModels.Global.DataSources.Enums.DataSourceStatus:
      title: Data Source Statuses
      enum:
      - Provided
      - Pending
      - Complete
      - Failed
      - Excluded
      type: string
      description: Indicates the current state of the data source e.g. is it still being processed, has a failure been encountered
        etc
    SikoiaSharedModels.Global.DataSources.Enums.DataSourceType:
      title: Data Source Types
      enum:
      - None
      - BankStatement
      - Payslip
      - Identity
      - Contract
      - FactFind
      - Other
      - CompanyRegistration
      - StakeholdersDisclosure
      - UtilityBill
      - CreditReport
      - SavingsStatement
      - SA302
      - TaxOverview
      - P45
      - P60
      - EmploymentLetter
      - EmploymentContract
      - ChildBenefitLetter
      - BenefitAwardLetter
      - StudentLoanLetter
      - PensionStatement
      - FinancialAccounts
      - OpenBankingConnection
      - BankAccount
      type: string
      description: The specific type of data that was identified such as a Payslip or SA302 or Bank Account
    SikoiaSharedModels.Global.DataSources.Insight:
      title: Insight
      type: object
      properties:
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity
          format: uuid
          readOnly: true
          example: 181eba57-b6b4-4288-8c97-f8299530f071
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of the entity
          readOnly: true
          example: case
        data_sources:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.Global.DataSources.DataSource'
          description: All available data sources for a given entity
          readOnly: true
      additionalProperties: false
    SikoiaSharedModels.Global.Enums.PathEntityTypeEnum:
      enum:
      - Companies
      - Persons
      - Cases
      type: string
    SikoiaSharedModels.EventProcessor.Checklist.Response.Models.CheckListValidationType:
      type: object
      properties:
        validation_type_id:
          type: string
          description: The unique identifier for the check type, such as the ID for the 'Last 3 months of payslips' check.
          format: uuid
          example: a072e37a-dee1-4a4e-b098-168a6a1f4603
        validation_check_name:
          type: string
          description: The name of the check type, such as 'Last 3 months of payslips'.
          nullable: true
          example: Last 3 months of payslips
        validation_description:
          type: string
          description: A detailed description of the check type, explaining its purpose and scope.
          nullable: true
          example: Checks if all payslips from the last 3 months have been provided
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity.
          nullable: true
          example: case
      additionalProperties: false
    SikoiaSharedModels.EventProcessor.Checklist.Request.CheckListValidationRequest:
      type: object
      properties:
        validation_type_id:
          type: string
          description: The unique identifier for the check type, such as the ID for the 'Last 3 months of payslips' check.
          nullable: true
          example: a072e37a-dee1-4a4e-b098-168a6a1f4603
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity.
          nullable: true
          example: 3f615611-3dc3-418b-bed5-a53c4390c97c
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity.
          nullable: true
          example: case
        checklist_params:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EventProcessor.Checklist.Request.Models.CheckListParameter'
          description: A list of parameters for the validation check to run against, such as specifying an individual document
            instead of the entire entity.
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.EventProcessor.Checklist.Request.Models.CheckListParameter:
      type: object
      properties:
        source_id:
          type: string
          description: Unique identifier for source
          nullable: true
          example: 5c8a9d27-fa27-4e15-aefd-9b5a5e32f4c1
        source_category_type:
          type: string
          description: Type of source
          nullable: true
          example: Document
      additionalProperties: false
    SikoiaSharedModels.EventProcessor.Checklist.Response.RequestValidationCheckResponse:
      title: Request Validation Check Instance Response
      type: object
      properties:
        validation_instance_id:
          type: string
          description: The unique identifier for a specific instance of the check type.
          nullable: true
          example: 2ef5079a-b3de-44a5-b4ff-c534259e752c
        validation_type_id:
          type: string
          description: The unique identifier for the check type, such as the ID for the 'Last 3 months of payslips' check.
          nullable: true
          example: a072e37a-dee1-4a4e-b098-168a6a1f4603
        status:
          type: string
          description: 'The current status of the check, which may be one of the following: `Pending`.'
          nullable: true
          example: Pending
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity.
          nullable: true
          example: b3f6ed8f-bc57-4a23-801e-e744aecb7b03
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity.
          nullable: true
          example: case
        checklist_params:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EventProcessor.Checklist.Request.Models.CheckListParameter'
          description: A list of parameters for the validation check to run against, such as specifying an individual document
            instead of the entire entity.
          nullable: true
        datetime_requested:
          type: string
          description: The date and time when the request was initiated.
          nullable: true
          example: '2024-01-01T12:38:45.711Z'
        datetime_completed:
          type: string
          description: The date and time when the request was completed.
          nullable: true
          example: '2024-01-02T12:22:07.747Z'
        message:
          type: string
          description: An optional field providing additional context about the status of the check.
          nullable: true
          example: Validation Check request pending
      additionalProperties: false
    SikoiaSharedModels.EventProcessor.Checklist.Response.ValidationCheckRequestInstance:
      title: Validation Check Request Instance
      type: object
      properties:
        validation_instance_id:
          type: string
          description: The unique identifier for a specific instance of the check type.
          nullable: true
          example: 2ef5079a-b3de-44a5-b4ff-c534259e752c
        validation_type_id:
          type: string
          description: The unique identifier for the check type, such as the ID for the 'Last 3 months of payslips' check.
          nullable: true
          example: a072e37a-dee1-4a4e-b098-168a6a1f4603
        status:
          type: string
          description: 'The current status of the check, which may be one of the following: `Complete`, `Failed`, or `Pending`.'
          nullable: true
          example: Complete
        datetime_requested:
          type: string
          description: The date and time when the request was initiated.
          nullable: true
          example: '2024-01-29T12:21:52.933Z'
        datetime_completed:
          type: string
          description: The date and time when the request was completed.
          nullable: true
          example: '2024-01-30T09:44:22.466Z'
        message:
          type: string
          description: An optional field providing additional context about the status of the check.
          nullable: true
          example: Income Employer complete
      additionalProperties: false
    SikoiaSharedModels.EventProcessor.Checklist.Response.ValidationCheckRequestListResponse:
      title: Validation Check Request Instances Response
      type: object
      properties:
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity.
          nullable: true
          example: 3345857d-fa2b-43ab-8b15-67e5fea8e896
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity.
          nullable: true
          example: case
        validation_check_requests:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EventProcessor.Checklist.Response.ValidationCheckRequestInstance'
          description: A list of validation check instance requests for the entity.
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.EventProcessor.Checklist.Response.Models.ValidationCheckSource:
      type: object
      properties:
        source_id:
          type: string
          description: The identifier for the root source of the data, such as a document ID for files (e.g. payslips) or
            an account connection ID for a successful open banking connection.
          nullable: true
          example: 6f6b61c2-fe31-42be-b46c-20a0b9685aaf
        source_category_type:
          type: string
          description: The category of the data source, such as `Document` or `OpenBanking`.
          nullable: true
          example: Document
        source_uri:
          type: string
          description: The URI of the data source, such as the URI to call in order to retrieve the original document.
          nullable: true
          example: https://api.sikoia.com/v2/documents/6f6b61c2-fe31-42be-b46c-20a0b9685aaf
        date:
          type: string
          description: The date of the data source.
          nullable: true
          example: '2025-01-25'
      additionalProperties: false
    SikoiaSharedModels.EventProcessor.Checklist.Response.Models.ValidationRuleResponse:
      type: object
      properties:
        rule_name:
          type: string
          description: The name of the rule, such as 'Payslips span a 3 month period'.
          nullable: true
          example: Payslips span a 3 month period
        decision:
          type: string
          description: 'The current decision of the rule evaluation, which may be one of the following: `Pass`, `Fail`, `Refer`.'
          nullable: true
          example: Pass
        recipient:
          type: string
          description: The name of the recipient
          nullable: true
          example: Sam Smith
        message:
          type: string
          description: An optional field providing additional context regarding the status of the rule evaluation.
          nullable: true
          example: Validation Check Passed
        sources:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EventProcessor.Checklist.Response.Models.ValidationCheckSource'
          description: The data sources used for evaluating the rule.
          nullable: true
      additionalProperties: false
    SikoiaSharedModels.EventProcessor.Checklist.Response.ValidationCheckInstanceResponse:
      title: Validation Check Instance Response
      type: object
      properties:
        validation_instance_id:
          type: string
          description: The unique identifier for a specific instance of the check type.
          nullable: true
          example: 2ef5079a-b3de-44a5-b4ff-c534259e752c
        validation_type_id:
          type: string
          description: The unique identifier for the check type, such as the ID for the 'Last 3 months of payslips' check.
          nullable: true
          example: a072e37a-dee1-4a4e-b098-168a6a1f4603
        validation_check_name:
          type: string
          description: The name of the check type, such as 'Last 3 months of payslips'.
          nullable: true
          example: Last 3 months of payslips
        status:
          type: string
          description: 'The current status of the check, which may be one of the following: `Complete`, `Failed`, or `Pending`.'
          nullable: true
          example: Complete
        entity_id:
          type: string
          description: The `company_id`, `person_id` or `case_id` of the entity.
          nullable: true
          example: 3345857d-fa2b-43ab-8b15-67e5fea8e896
        entity_type:
          enum:
          - company
          - person
          - case
          type: string
          description: The type of entity.
          nullable: true
          example: case
        checklist_params:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EventProcessor.Checklist.Request.Models.CheckListParameter'
          description: A list of parameters for the validation check to run against, such as specifying an individual document
            instead of the entire entity.
          nullable: true
        datetime_requested:
          type: string
          description: The date and time when the request was initiated.
          nullable: true
          example: '2024-01-01T12:38:45.711Z'
        datetime_completed:
          type: string
          description: The date and time when the request was completed.
          nullable: true
          example: '2024-01-02T12:22:07.747Z'
        message:
          type: string
          description: An optional field providing additional context about the status of the check.
          nullable: true
          example: Validation Check request pending
        rules:
          type: array
          items:
            $ref: '#/components/schemas/SikoiaSharedModels.EventProcessor.Checklist.Response.Models.ValidationRuleResponse'
          description: A list of rules to be evaluated as part of the check.
          nullable: true
      additionalProperties: false
    MicroserviceEventProcessor.Application.Models.Response.CompletnessAndIncomeResponse:
      type: object
      properties:
        completness_verification:
          $ref: '#/components/schemas/SikoiaSharedModels.EventProcessor.Checklist.Response.ValidationCheckInstanceResponse'
        income_verification:
          $ref: '#/components/schemas/SikoiaSharedModels.EndUser.IncomeEmployer.Response.Overview.IncomeEmployerMappedResponse'
      additionalProperties: false
  securitySchemes:
    authorizationHeader:
      type: http
      scheme: bearer
      bearerFormat: JWT
    apiKeyHeader:
      type: apiKey
      name: apikey
      in: header
security:
- authorizationHeader: []
- apiKeyHeader: []