> ## Documentation Index
> Fetch the complete documentation index at: https://docs.osint.ly/llms.txt
> Use this file to discover all available pages before exploring further.

# Run all Ubisoft collectors



## OpenAPI

````yaml /tools-reference/openapi.json post /tools/ubisoft/all
openapi: 3.1.0
info:
  title: Osintly Tools API
  version: 1.0.0
  description: >-
    OpenAPI specification for Osintly intelligence and gaming tools, saved
    results, and catalog endpoints.
  contact:
    name: Osintly
    url: https://docs.osint.ly/tools-reference/introduction
servers:
  - url: https://api.osint.ly
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Domain Intelligence
    description: Domain infrastructure and exposure intelligence.
  - name: Tools Catalog
    description: Discover available tools, metadata, and route costs.
  - name: Epic Games
    description: Direct Epic Games account validation and enrichment endpoints.
  - name: Vehicle History Finder
    description: >-
      Vehicle history enrichment endpoints for US VINs and French license
      plates.
  - name: Xbox
    description: Direct Xbox Live account validation and enrichment endpoints.
  - name: Ubisoft
    description: Direct Ubisoft Connect account lookup and enrichment endpoints.
  - name: PlayStation Network
    description: Direct PlayStation Network account validation and enrichment endpoints.
  - name: Roblox
    description: Direct Roblox account validation and enrichment endpoints.
  - name: Steam
    description: Direct Steam account validation and enrichment endpoints.
  - name: Social Club
    description: Direct Rockstar Social Club account validation and enrichment endpoints.
  - name: Reddit
    description: >-
      Reddit profile and public archived activity validation and enrichment
      endpoints.
  - name: IP Intelligence
    description: IP ownership, routing and public exposure.
paths:
  /tools/ubisoft/all:
    post:
      tags:
        - Ubisoft
      summary: Run all Ubisoft collectors
      operationId: runUbisoftAll
      requestBody:
        $ref: '#/components/requestBodies/UbisoftRequest'
      responses:
        '200':
          $ref: '#/components/responses/GamingToolResponse'
        '400':
          $ref: '#/components/responses/ValidationError'
        '503':
          $ref: '#/components/responses/ProviderUnavailable'
components:
  requestBodies:
    UbisoftRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UbisoftRequest'
          example:
            value: SomeUbisoftName
            type: username
  responses:
    GamingToolResponse:
      description: Tool response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GamingToolResponse'
          example:
            tool: epic-games
            operation: search
            query:
              value: some-player
              type: epic_display_name
            data: {}
            meta:
              timestamp: '2026-06-28T12:00:00.000Z'
    ValidationError:
      description: Invalid request body or parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: VALIDATION_ERROR
              message: Invalid request body
              details:
                - path: value
                  message: Invalid value
            meta:
              timestamp: '2026-06-28T12:00:00.000Z'
    ProviderUnavailable:
      description: Required enrichment source configuration is missing
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: PROVIDER_UNAVAILABLE
              message: Provider unavailable
              details: A required enrichment source is unavailable for this operation
            meta:
              timestamp: '2026-06-28T12:00:00.000Z'
  schemas:
    UbisoftRequest:
      type: object
      required:
        - value
        - type
      properties:
        value:
          type: string
          description: Ubisoft name, Ubisoft ID, or linked platform identifier to look up.
          examples:
            - SomeUbisoftName
            - 0ab3ec03-b309-4f46-a89a-f53b6cfe3073
            - '76561198000000000'
        type:
          type: string
          description: >-
            Canonical Ubisoft search type or accepted alias. A UUID sent as
            `username` is searched as `user_id`.
          enum:
            - username
            - user_id
            - psn
            - xbl
            - steam
            - discord
            - epic
            - ubisoft
            - uplay
            - nickname
            - id
            - uuid
            - ubisoft_id
            - playstation
            - xbox
            - gamertag
            - xuid
            - epic_games
          example: username
        save:
          type: boolean
          description: >-
            Only used on `/all`. When true, saves the synchronous result for
            later retrieval.
          default: false
      additionalProperties: false
    GamingToolResponse:
      type: object
      required:
        - data
        - meta
        - operation
        - query
        - tool
      properties:
        data:
          type: object
          additionalProperties: true
        meta:
          $ref: '#/components/schemas/ResponseMeta'
        operation:
          type: string
        query:
          type: object
          required:
            - value
            - type
          properties:
            value:
              type: string
            type:
              type: string
            normalizedType:
              type: string
          additionalProperties: true
        tool:
          type: string
          enum:
            - epic-games
            - vehicle-history-finder
            - xbox
            - playstation
            - roblox
            - steam
            - socialclub
            - ubisoft
      additionalProperties: false
    ErrorResponse:
      type: object
      required:
        - error
        - meta
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          additionalProperties: true
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      additionalProperties: false
    ResponseMeta:
      type: object
      required:
        - timestamp
      properties:
        timestamp:
          type: string
          format: date-time
        savedResult:
          $ref: '#/components/schemas/SavedToolResult'
      additionalProperties: true
    SavedToolResult:
      type: object
      required:
        - id
        - url
      properties:
        id:
          type: string
          format: uuid
        url:
          type: string
          format: uri
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.