Basis Theory

Basis Theory Proxy API

Manage pre-configured proxies and invoke the detokenizing Proxy.

GitHub OpenAPI

Operations 11

POST /proxies Create a pre-configured proxy #
GET /proxies List pre-configured proxies #
GET /proxies/{id} Get a pre-configured proxy #
PUT /proxies/{id} Update a pre-configured proxy #
PATCH /proxies/{id} Patch a pre-configured proxy #
DELETE /proxies/{id} Delete a pre-configured proxy #
GET /proxy Invoke the proxy (GET) #
POST /proxy Invoke the proxy (POST) #
PUT /proxy Invoke the proxy (PUT) #
PATCH /proxy Invoke the proxy (PATCH) #
DELETE /proxy Invoke the proxy (DELETE) #

Documentation

📖
Documentation
https://developers.basistheory.com/docs/api/tokens
📖
APIReference
https://developers.basistheory.com/docs/api/tokens/token-object
📖
Documentation
https://developers.basistheory.com/docs/api/tokens/tokenize
📖
APIReference
https://developers.basistheory.com/docs/api/tokens/detokenize
📖
Documentation
https://developers.basistheory.com/docs/api/applications
📖
APIReference
https://developers.basistheory.com/docs/api/applications/application-object
📖
Documentation
https://developers.basistheory.com/docs/api/proxies
📖
APIReference
https://developers.basistheory.com/docs/api/proxies/pre-configured-proxies
📖
Documentation
https://developers.basistheory.com/docs/api/reactors
📖
APIReference
https://developers.basistheory.com/docs/api/reactors/reactor-object
📖
Documentation
https://developers.basistheory.com/docs/api/3ds
📖
APIReference
https://developers.basistheory.com/docs/api/3ds/sessions
📖
Documentation
https://developers.basistheory.com/docs/api/tenants
📖
APIReference
https://developers.basistheory.com/docs/api/logs
📖
Documentation
https://developers.basistheory.com/docs/api/webhooks
📖
APIReference
https://developers.basistheory.com/docs/api/webhooks/api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/basis-theory/refs/heads/main/openapi/basis-theory-proxy-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/basis-theory/refs/heads/main/collections/basis-theory.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/basis-theory/refs/heads/main/collections/basis-theory.opencollection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/basis-theory-proxy-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

basis-theory-proxy-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Basis Theory Proxy API
  description: The Basis Theory API is a PCI Level 1 compliant tokenization and data vault platform. It lets developers tokenize, store, and use sensitive data - cardholder data, PII, PHI, and bank account numbers - without that data touching their own systems. The API exposes Tokens, batch Tokenize / Detokenize, Applications, the detokenizing Proxy (pre-configured and ephemeral), serverless Reactors, 3D Secure, Tenants, Logs, and Webhooks. All requests are authenticated with a `BT-API-KEY` request header.
  termsOfService: https://basistheory.com/terms
  contact:
    name: Basis Theory Support
    email: support@basistheory.com
    url: https://developers.basistheory.com
  version: '1.0'
servers:
- url: https://api.basistheory.com
  description: Production environment (PRODUCTION tenants)
- url: https://api.test.basistheory.com
  description: Test environment (TEST tenants)
security:
- ApiKey: []
tags:
- name: Proxy
  description: Manage pre-configured proxies and invoke the detokenizing Proxy.
paths:
  /proxies:
    post:
      operationId: createProxy
      tags:
      - Proxy
      summary: Create a pre-configured proxy
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProxyRequest'
      responses:
        '201':
          description: The created proxy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Proxy'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationProblem'
    get:
      operationId: listProxies
      tags:
      - Proxy
      summary: List pre-configured proxies
      responses:
        '200':
          description: A paginated list of proxies.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyPaginatedList'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /proxies/{id}:
    get:
      operationId: getProxy
      tags:
      - Proxy
      summary: Get a pre-configured proxy
      parameters:
      - $ref: '#/components/parameters/ProxyId'
      responses:
        '200':
          description: The requested proxy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Proxy'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: updateProxy
      tags:
      - Proxy
      summary: Update a pre-configured proxy
      parameters:
      - $ref: '#/components/parameters/ProxyId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProxyRequest'
      responses:
        '200':
          description: The updated proxy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Proxy'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: patchProxy
      tags:
      - Proxy
      summary: Patch a pre-configured proxy
      parameters:
      - $ref: '#/components/parameters/ProxyId'
      requestBody:
        required: true
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/CreateProxyRequest'
      responses:
        '200':
          description: The patched proxy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Proxy'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteProxy
      tags:
      - Proxy
      summary: Delete a pre-configured proxy
      parameters:
      - $ref: '#/components/parameters/ProxyId'
      responses:
        '204':
          description: The proxy was deleted.
        '404':
          $ref: '#/components/responses/NotFound'
  /proxy:
    get:
      operationId: invokeProxyGet
      tags:
      - Proxy
      summary: Invoke the proxy (GET)
      description: Invokes the Proxy. For a pre-configured proxy supply the `BT-PROXY-KEY` header; for an ephemeral proxy supply the `BT-PROXY-URL` header with the destination base URL. The Proxy detokenizes any detokenization expressions in the request and forwards the result to the destination.
      parameters:
      - $ref: '#/components/parameters/BtProxyUrl'
      - $ref: '#/components/parameters/BtProxyKey'
      responses:
        '200':
          description: The response forwarded from the destination.
        '400':
          description: Bad proxy request.
    post:
      operationId: invokeProxyPost
      tags:
      - Proxy
      summary: Invoke the proxy (POST)
      parameters:
      - $ref: '#/components/parameters/BtProxyUrl'
      - $ref: '#/components/parameters/BtProxyKey'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: The response forwarded from the destination.
    put:
      operationId: invokeProxyPut
      tags:
      - Proxy
      summary: Invoke the proxy (PUT)
      parameters:
      - $ref: '#/components/parameters/BtProxyUrl'
      - $ref: '#/components/parameters/BtProxyKey'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: The response forwarded from the destination.
    patch:
      operationId: invokeProxyPatch
      tags:
      - Proxy
      summary: Invoke the proxy (PATCH)
      parameters:
      - $ref: '#/components/parameters/BtProxyUrl'
      - $ref: '#/components/parameters/BtProxyKey'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: The response forwarded from the destination.
    delete:
      operationId: invokeProxyDelete
      tags:
      - Proxy
      summary: Invoke the proxy (DELETE)
      parameters:
      - $ref: '#/components/parameters/BtProxyUrl'
      - $ref: '#/components/parameters/BtProxyKey'
      responses:
        '200':
          description: The response forwarded from the destination.
components:
  responses:
    ValidationProblem:
      description: The request failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationProblemDetails'
    Unauthorized:
      description: The BT-API-KEY header is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    Forbidden:
      description: The application lacks the required permission.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
  schemas:
    CreateProxyRequest:
      type: object
      required:
      - name
      - destination_url
      properties:
        name:
          type: string
        destination_url:
          type: string
          format: uri
        request_reactor_id:
          type: string
          format: uuid
        response_reactor_id:
          type: string
          format: uuid
        request_transform:
          $ref: '#/components/schemas/ProxyTransform'
        response_transform:
          $ref: '#/components/schemas/ProxyTransform'
        application:
          type: object
          properties:
            id:
              type: string
              format: uuid
        configuration:
          type: object
          additionalProperties:
            type: string
        require_auth:
          type: boolean
          default: true
    ProxyPaginatedList:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        data:
          type: array
          items:
            $ref: '#/components/schemas/Proxy'
    Application:
      type: object
      properties:
        id:
          type: string
          format: uuid
        tenant_id:
          type: string
          format: uuid
        name:
          type: string
        key:
          type: string
          description: The application key, returned only on creation when create_key is true.
        type:
          type: string
          enum:
          - public
          - private
          - management
          - expiring
        permissions:
          type: array
          items:
            type: string
        rules:
          type: array
          items:
            $ref: '#/components/schemas/AccessRule'
        expires_at:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
    Proxy:
      type: object
      properties:
        id:
          type: string
          format: uuid
        key:
          type: string
        tenant_id:
          type: string
          format: uuid
        name:
          type: string
        destination_url:
          type: string
          format: uri
        request_reactor_id:
          type: string
          format: uuid
        response_reactor_id:
          type: string
          format: uuid
        request_transform:
          $ref: '#/components/schemas/ProxyTransform'
        response_transform:
          $ref: '#/components/schemas/ProxyTransform'
        application:
          $ref: '#/components/schemas/Application'
        configuration:
          type: object
          additionalProperties:
            type: string
        require_auth:
          type: boolean
        created_at:
          type: string
          format: date-time
    Pagination:
      type: object
      properties:
        total_items:
          type: integer
        page_number:
          type: integer
        page_size:
          type: integer
        total_pages:
          type: integer
    ValidationProblemDetails:
      type: object
      properties:
        title:
          type: string
        status:
          type: integer
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    ProblemDetails:
      type: object
      properties:
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
    ProxyTransform:
      type: object
      properties:
        type:
          type: string
        code:
          type: string
        matcher:
          type: string
    AccessRule:
      type: object
      properties:
        description:
          type: string
        priority:
          type: integer
        container:
          type: string
        transform:
          type: string
          enum:
          - redact
          - mask
          - reveal
        permissions:
          type: array
          items:
            type: string
  parameters:
    BtProxyUrl:
      name: BT-PROXY-URL
      in: header
      required: false
      description: For ephemeral proxy requests, the destination base URL to proxy to.
      schema:
        type: string
        format: uri
    BtProxyKey:
      name: BT-PROXY-KEY
      in: header
      required: false
      description: For pre-configured proxy requests, the short key identifying the proxy.
      schema:
        type: string
    ProxyId:
      name: id
      in: path
      required: true
      description: The unique identifier of the proxy.
      schema:
        type: string
        format: uuid
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: BT-API-KEY
      description: Authenticate every request with a Basis Theory Application key supplied in the BT-API-KEY request header.