infinihash-com Risk Config API

openapi: 3.2.0
info:
  title: Infinihash KYC Risk Config API
  version: 1.0.0
  description: 'Identity verification, KYB, sanctions screening, UBO orchestration and periodic review.


    Auth: send your key as `X-API-Key: ` (or `Authorization: Bearer `).


    Most endpoints are mounted twice — at the root (`/kyc/...`) and under `/api` (`/api/kyc/...`). Prefer the `/api` form; it is what the hosted portals and SDKs use.


    Python SDK: `pip install "git+https://github.com/Infinihash/kyc-python@v0.1.0"` (https://github.com/Infinihash/kyc-python; runnable examples in examples/).'
  contact:
    name: Infinihash
    url: https://kyc.infinihash.com
servers:
- url: https://kyc-api.infinihash.com
  description: Production
tags:
- name: Risk Config
paths:
  /risk-weights:
    get:
      x-route-source:
        file: routes/riskweights.js
        method: get
        path: /
      summary: List risk weights
      description: Lists the calling key's configured risk-factor weights grouped by category (sorted by category then factorKey). Returns an empty object when none are configured.
      tags:
      - Risk Config
      operationId: listRiskWeights
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      responses:
        '200':
          description: Weights by category
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RiskWeightsGrouped'
        '401':
          description: Missing API key, or invalid or revoked API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Unexpected server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /risk-weights/{factorKey}:
    put:
      x-route-source:
        file: routes/riskweights.js
        method: put
        path: /:factorKey
      summary: Set a risk factor weight
      description: Creates or updates the weight for a factor key for the calling API key. The weight must be between 0.1 and 10.0.
      tags:
      - Risk Config
      operationId: setRiskWeight
      parameters:
      - name: factorKey
        in: path
        required: true
        schema:
          type: string
        description: factorKey
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RiskWeightWrite'
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      responses:
        '200':
          description: Stored weight
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RiskWeight'
        '400':
          description: weight must be 0.1-10.0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing API key, or invalid or revoked API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Unexpected server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /risk-weights/calculate/{submissionId}:
    get:
      x-route-source:
        file: routes/riskweights.js
        method: get
        path: /calculate/:submissionId
      summary: Score a submission with the risk weights
      description: Computes a 0-100 risk score for a submission owned by the calling key from its weights (each triggered factor adds weight x 10, capped at 100). Only the factors jurisdiction_fatf_grey, entity_pep and entity_complex_structure can trigger. Tier is high >= 70, medium >= 40, otherwise low. Read-only.
      tags:
      - Risk Config
      operationId: calculateRiskScore
      parameters:
      - name: submissionId
        in: path
        required: true
        schema:
          type: string
        description: KYC submission id
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      responses:
        '200':
          description: Risk score
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RiskScore'
        '401':
          description: Missing API key, or invalid or revoked API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Submission not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Unexpected server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    RiskWeightWrite:
      type: object
      required:
      - weight
      properties:
        weight:
          type: number
          minimum: 0.1
          maximum: 10
          description: Weight 0.1-10.0 (parsed with parseFloat).
        description:
          type: string
          description: Optional; on update only overwritten when non-empty.
        category:
          type: string
          description: Used only when the factor is created (default 'custom').
    RiskWeightsGrouped:
      type: object
      description: Weights grouped by category.
      additionalProperties:
        type: array
        items:
          $ref: '#/components/schemas/RiskWeight'
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
    RiskWeight:
      type: object
      required:
      - id
      - apiKeyId
      - category
      - factorKey
      - weight
      - description
      - createdAt
      - updatedAt
      properties:
        id:
          type: string
        apiKeyId:
          type: string
        category:
          type: string
        factorKey:
          type: string
        weight:
          type: number
        description:
          type:
          - string
          - 'null'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    RiskScore:
      type: object
      required:
      - submissionId
      - score
      - tier
      - factors
      properties:
        submissionId:
          type: string
        score:
          type: integer
          minimum: 0
          maximum: 100
        tier:
          type: string
          enum:
          - low
          - medium
          - high
        factors:
          type: array
          items:
            type: object
            required:
            - key
            - weight
            - triggered
            - score
            properties:
              key:
                type: string
              weight:
                type: number
              triggered:
                type: boolean
              score:
                type: number
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
    BearerAuth:
      type: http
      scheme: bearer