infinihash-com Status API

openapi: 3.2.0
info:
  title: Infinihash KYC Status 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: Status
  description: Health and service status.
paths:
  /kyc-status:
    get:
      x-route-source:
        file: routes/status.js
        method: get
        path: /
      summary: Is this subject KYC-complete?
      description: Service-to-service check (used by ClearBox before funding an escrow). Finds the latest completed submission matching `email` (metadata.email or entity name) and/or `org_id` (the API key owner) and reports its tier and expiry. At least one of email, org_id is required. Ordinary keys only see their own owner's submissions; an org_id different from the key's owner answers 404. 404 with reason no_record is the normal "not verified" answer.
      tags:
      - Status
      operationId: get_kyc_status
      parameters:
      - name: email
        in: query
        required: false
        schema:
          type: string
        description: Subject email (case-insensitive); matched against submission metadata.email or the entity name.
      - name: org_id
        in: query
        required: false
        schema:
          type: string
        description: Owning organisation id (ApiKey.ownerId).
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      responses:
        '200':
          description: Latest completed KYC
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycStatusResult'
        '400':
          description: 'Provide at least one of: email, org_id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid API key
        '404':
          description: No completed KYC on record (in_progress:true if one is still running)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycStatusNotFound'
        '429':
          description: Rate limited
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/kyc-status:
    get:
      x-route-source:
        file: routes/status.js
        method: get
        path: /
      summary: Is this subject KYC-complete?
      description: Service-to-service check (used by ClearBox before funding an escrow). Finds the latest completed submission matching `email` (metadata.email or entity name) and/or `org_id` (the API key owner) and reports its tier and expiry. At least one of email, org_id is required. Ordinary keys only see their own owner's submissions; an org_id different from the key's owner answers 404. 404 with reason no_record is the normal "not verified" answer.
      tags:
      - Status
      operationId: getKycStatus
      parameters:
      - name: email
        in: query
        required: false
        schema:
          type: string
        description: Subject email (case-insensitive); matched against submission metadata.email or the entity name.
      - name: org_id
        in: query
        required: false
        schema:
          type: string
        description: Owning organisation id (ApiKey.ownerId).
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
      responses:
        '200':
          description: Latest completed KYC
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycStatusResult'
        '400':
          description: 'Provide at least one of: email, org_id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid API key
        '404':
          description: No completed KYC on record (in_progress:true if one is still running)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycStatusNotFound'
        '429':
          description: Rate limited
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /health:
    get:
      summary: Liveness probe
      description: Returns 200 whenever the process can serve traffic.
      tags:
      - Status
      operationId: getHealth
      security: []
      responses:
        '200':
          description: Service is alive (always 200 while the process serves; sanctions readiness is /health/sanctions)
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - ok
                  sanctionsStatus:
                    type: string
                    enum:
                    - ok
                    - degraded
                    description: Coarse verdict only; per-source detail needs an API key at /health/sanctions
                  version:
                    type: string
                  entityTypes:
                    type: array
                    items:
                      type: string
                  riskTiers:
                    type: array
                    items:
                      type: string
components:
  schemas:
    KycStatusResult:
      type: object
      properties:
        kyc_complete:
          type: boolean
          description: false when the latest completed KYC has expired.
        tier:
          type: string
          enum:
          - basic
          - enhanced
          description: basic (low risk, valid 12 months) or enhanced (otherwise, valid 6 months).
        submission_id:
          type: string
        completed_at:
          type:
          - string
          - 'null'
          format: date-time
        expires_at:
          type:
          - string
          - 'null'
          format: date-time
        expired:
          type: boolean
      required:
      - kyc_complete
      - tier
      - submission_id
      - expired
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
    KycStatusNotFound:
      type: object
      properties:
        kyc_complete:
          type: boolean
          enum:
          - false
        reason:
          type: string
          enum:
          - no_record
        in_progress:
          type: boolean
          description: Present (true) when a pending/running submission matches but none is complete.
        created_at:
          type: string
          format: date-time
          description: Creation time of the in-progress submission.
      required:
      - kyc_complete
      - reason
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
    BearerAuth:
      type: http
      scheme: bearer