infinihash-com Sandbox API

openapi: 3.2.0
info:
  title: Infinihash KYC Sandbox 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: Sandbox
  description: 'Free self-serve test environment on the production API. A sandbox key (kyc_sbx_...) runs the real create/run/poll/export lifecycle with deterministic results and is never billed; no provider is called. Magic entity names: SANCTIONED (sanctions HIT -> failed), UNSCREENED (list not searched -> never approves), PEP (pep_screen review), ADVERSE (negative_news review), LIVENESS_FAIL; any other name passes. Sandbox keys may call only POST/GET /api/kyc, GET /api/kyc/{id}, POST /api/kyc/{id}/run, POST /api/kyc/screen, GET /api/kyc/{id}/export/pdf, GET /checklist/*; other routes return 403 sandbox_route_unavailable.'
paths:
  /sandbox:
    get:
      x-route-source:
        file: routes/sandbox.js
        method: get
        path: /
      summary: Describe the sandbox
      description: What the sandbox does, the magic entity names and the routes a sandbox key may call. No authentication.
      tags:
      - Sandbox
      operationId: get_sandbox
      security: []
      responses:
        '200':
          description: Sandbox description
          content:
            application/json:
              schema:
                type: object
  /sandbox/keys:
    post:
      x-route-source:
        file: routes/sandbox.js
        method: post
        path: /keys
      summary: Get a sandbox API key
      description: 'Self-serve: returns a kyc_sbx_ API key once. No authentication; rate-limited per connection (5/hour) and globally per day. The email is stored only as a hash.'
      tags:
      - Sandbox
      operationId: post_sandbox_keys
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - email
              properties:
                email:
                  type: string
                  format: email
      security: []
      responses:
        '201':
          description: Sandbox key issued (shown once)
          content:
            application/json:
              schema:
                type: object
                properties:
                  apiKey:
                    type: string
                  keyId:
                    type: string
                  tier:
                    type: string
                    enum:
                    - sandbox
                  note:
                    type: string
        '400':
          description: Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '429':
          description: Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
  /api/sandbox:
    get:
      x-route-source:
        file: routes/sandbox.js
        method: get
        path: /
      summary: Describe the sandbox
      description: What the sandbox does, the magic entity names and the routes a sandbox key may call. No authentication.
      tags:
      - Sandbox
      operationId: getSandbox
      security: []
      responses:
        '200':
          description: Sandbox description
          content:
            application/json:
              schema:
                type: object
  /api/sandbox/keys:
    post:
      x-route-source:
        file: routes/sandbox.js
        method: post
        path: /keys
      summary: Get a sandbox API key
      description: 'Self-serve: returns a kyc_sbx_ API key once. No authentication; rate-limited per connection (5/hour) and globally per day. The email is stored only as a hash.'
      tags:
      - Sandbox
      operationId: createSandboxKey
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - email
              properties:
                email:
                  type: string
                  format: email
      security: []
      responses:
        '201':
          description: Sandbox key issued (shown once)
          content:
            application/json:
              schema:
                type: object
                properties:
                  apiKey:
                    type: string
                  keyId:
                    type: string
                  tier:
                    type: string
                    enum:
                    - sandbox
                  note:
                    type: string
        '400':
          description: Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '429':
          description: Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
    BearerAuth:
      type: http
      scheme: bearer