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

# Retrieve Beneficiary PII

> Detokenizes and returns the PII stored in Basis Theory for this beneficiary.
Every access is recorded in the merchant audit log (PCI DSS 10.2.1).

Use this to pre-populate edit forms or verify submitted identity data.




## OpenAPI

````yaml GET /v1/beneficiaries/{id}/pii
openapi: 3.1.0
info:
  title: Anton Payments API
  version: 1.0.0
  summary: Cross-border payout infrastructure. Fiat, stablecoin, and crypto.
  description: >
    The Anton Payments merchant API. Versioned, idempotent, cursor-paginated.


    - **Authentication**: OAuth 2.0 client_credentials with DPoP
    proof-of-possession (RFC 6749 §4.4 + RFC 9449). Programmatic clients
    exchange `(client_id, client_secret)` for a short-lived access token at
    `POST /oauth/token`, then send each request with `Authorization: DPoP
    <access_token>` plus a per-request `DPoP: <proof>` header. Static API keys
    are not accepted on v1.

    - Base URLs: `https://api.antonpayments.com` (production),
    `https://api.antonpayments.dev` (sandbox).

    - Monetary amounts are decimal strings. Never floats.

    - Timestamps are RFC 3339 UTC.

    - All mutating endpoints support the `Idempotency-Key` header.

    - Anton's OAuth public signing key is published at `GET
    /.well-known/jwks.json` (5-minute cache; RFC 8615).


    See the Cross-Cutting section of the docs for idempotency, pagination, rate
    limits, errors, webhook events, and webhook signing.
  contact:
    name: Anton Payments Support
    url: https://help.antonpayments.com
  license:
    name: Proprietary
    url: https://www.antonpayments.com
servers:
  - url: https://api.antonpayments.com
    description: Production
  - url: https://api.antonpayments.dev
    description: Sandbox
security:
  - oauthDPoP: []
    dpopHeader: []
tags:
  - name: Authentication
    description: >-
      OAuth 2.0 token endpoint and JWKS publication. See the API description for
      the full DPoP-bound flow.
  - name: OAuth Clients
    description: >-
      Manage OAuth credentials (programmatic access). Portal-only — JWT auth
      required.
  - name: Reference Data
    description: Currencies, countries, and supported payment methods.
  - name: Beneficiaries
    description: Create and manage the people and businesses you pay.
  - name: Instruments
    description: >-
      Payment instruments attached to beneficiaries — bank accounts, wallets,
      cards.
  - name: Payouts
    description: Initiate and track payouts.
  - name: Batches
    description: CSV-driven bulk payout processing.
  - name: Balances
    description: Merchant balance by currency.
  - name: Accounts
    description: Virtual accounts for merchant funding.
  - name: Webhooks
    description: Subscribe to event notifications.
  - name: Documents
    description: Upload and manage KYB and supporting documents.
  - name: RFIs
    description: Respond to Requests for Information raised during review.
  - name: Pricing
    description: Read merchant pricing plans and quote fees.
  - name: FX
    description: Quote, lock, and execute currency exchanges between balances.
  - name: Corridors
    description: Active cross-border corridors for your merchant.
  - name: Balance Alerts
    description: >-
      Per-currency low-balance thresholds that drive the `balance.low` webhook
      event.
  - name: Sandbox
    description: Reset and seed your sandbox environment.
  - name: Merchant
    description: Merchant profile, branding, preferences, and security posture.
  - name: API Keys
    description: Issue, list, and revoke API keys.
  - name: Users
    description: Self-service profile, MFA, and team management.
  - name: Notifications
    description: Per-user notification channels and preferences.
  - name: Velocity
    description: Merchant-scoped risk rules and what-if simulation.
  - name: Engine
    description: Glass-box view of Anton's risk intelligence.
  - name: Onboarding
    description: Authenticated KYB onboarding draft and submission.
  - name: Public Onboarding
    description: >-
      Session-authenticated hosted onboarding flow. Not intended for SDK
      consumption.
paths:
  /v1/beneficiaries/{id}/pii:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          pattern: ^ben_[a-zA-Z0-9]+$
    get:
      tags:
        - Beneficiaries
      summary: Retrieve beneficiary PII
      description: >
        Detokenizes and returns the PII stored in Basis Theory for this
        beneficiary.

        Every access is recorded in the merchant audit log (PCI DSS 10.2.1).


        Use this to pre-populate edit forms or verify submitted identity data.
      operationId: getBeneficiaryPII
      responses:
        '200':
          description: Beneficiary PII, detokenized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryPII'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    BeneficiaryPII:
      type: object
      description: >
        Detokenized PII for a beneficiary. Returned by `GET
        /v1/beneficiaries/{id}/pii`.

        Exactly one of `individual` or `business` is populated matching the

        beneficiary's `type`.
      properties:
        type:
          type: string
          enum:
            - individual
            - business
        individual:
          $ref: '#/components/schemas/IndividualDetails'
        business:
          $ref: '#/components/schemas/BusinessDetails'
    IndividualDetails:
      type: object
      required:
        - first_name
        - last_name
        - email
        - phone
        - date_of_birth
        - nationality
        - address
      description: PII for an `individual` beneficiary. Tokenized on creation.
      properties:
        first_name:
          type: string
          example: Jane
        middle_name:
          type: string
          example: R
        last_name:
          type: string
          example: Smith
        email:
          type: string
          format: email
          example: jane@example.com
        phone:
          type: string
          description: E.164-formatted phone number.
          example: '+442079460000'
        date_of_birth:
          type: string
          description: YYYY-MM-DD.
          pattern: ^\d{4}-\d{2}-\d{2}$
          example: '1988-05-12'
        nationality:
          $ref: '#/components/schemas/CountryCode'
        tax_id:
          type: string
          description: >
            Tax identification number (e.g. US SSN/ITIN, UK NINO,
            foreign-equivalent).

            Tokenized in the PII vault on creation — never stored in plaintext
            on

            the beneficiary record. Optional.
          example: 123-45-6789
        address:
          $ref: '#/components/schemas/Address'
    BusinessDetails:
      type: object
      required:
        - legal_name
        - registration_number
        - email
        - phone
        - address
      description: PII for a `business` beneficiary. Tokenized on creation.
      properties:
        legal_name:
          type: string
          example: Example GmbH
        trading_name:
          type: string
          description: Name the business trades as, if different from legal name.
          example: Example
        registration_number:
          type: string
          example: HRB12345
        tax_id:
          type: string
          example: DE123456789
        entity_type:
          type: string
          description: Legal entity form.
          enum:
            - llc
            - corporation
            - partnership
            - sole_proprietorship
            - trust
            - other
        incorporation_country:
          $ref: '#/components/schemas/CountryCode'
        incorporation_date:
          type: string
          description: YYYY-MM-DD.
          pattern: ^\d{4}-\d{2}-\d{2}$
        email:
          type: string
          format: email
        phone:
          type: string
          description: E.164-formatted phone number.
          example: '+493012345678'
        website:
          type: string
          format: uri
          example: https://example.de
        address:
          $ref: '#/components/schemas/Address'
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
          properties:
            message:
              type: string
              description: Human-readable description of what went wrong.
            code:
              type: string
              description: Machine-readable error code. Branch on this, not on `message`.
              example: insufficient_balance
      example:
        error:
          message: insufficient funds for this payout
          code: insufficient_balance
    CountryCode:
      type: string
      description: ISO 3166-1 alpha-2 country code.
      pattern: ^[A-Z]{2}$
      example: US
    Address:
      type: object
      required:
        - street_line_1
        - city
        - postal_code
        - country
      properties:
        street_line_1:
          type: string
          example: 10 Example Street
        street_line_2:
          type: string
          example: Apt 4B
        city:
          type: string
          example: London
        state:
          type: string
          description: >-
            State, province, or region. Required in some countries (e.g. US, CA,
            AU).
          example: Greater London
        postal_code:
          type: string
          example: SW1A 1AA
        country:
          $ref: '#/components/schemas/CountryCode'
  responses:
    Unauthorized:
      description: Missing or invalid API key, or key used against the wrong environment.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            missing_key:
              summary: Missing bearer token
              value:
                error:
                  code: unauthorized
                  message: missing or invalid credentials
            wrong_environment:
              summary: Test key used against production
              value:
                error:
                  code: key_environment_mismatch
                  message: this API key is not valid for this environment
    NotFound:
      description: The resource does not exist, or belongs to a different merchant.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    RateLimited:
      description: Rate limit exceeded. See `Retry-After`.
      headers:
        Retry-After:
          $ref: '#/components/headers/Retry-After'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  headers:
    Retry-After:
      description: Seconds to wait before retrying. Included on 429 responses.
      schema:
        type: integer
  securitySchemes:
    oauthDPoP:
      type: oauth2
      description: >
        OAuth 2.0 client_credentials grant (RFC 6749 §4.4) bound to a DPoP
        keypair (RFC 9449).


        **Flow** (every authenticated `/v1` call requires both an access token
        AND a fresh per-request DPoP proof):


        1. Register a credential via the merchant portal. Anton issues a
        `client_id` (`ant_oc_<env>_<32hex>`) and a `client_secret`
        (`ant_ocs_<env>_<48hex>`, shown ONCE). The portal generates an ES256 or
        Ed25519 DPoP keypair in your browser; you store the private half.

        2. Mint an access token: `POST /oauth/token` with `Authorization: Basic
        <client_id:client_secret>` and `Content-Type:
        application/x-www-form-urlencoded`. Body:
        `grant_type=client_credentials`. A `DPoP` header carrying a proof signed
        for the token endpoint is required (no `ath` claim on this proof).

        3. Use the token: send `Authorization: DPoP <access_token>` plus a fresh
        `DPoP: <proof>` header on every `/v1` request. The proof JWT MUST carry
        `htm` (request method), `htu` (request URL, no query/fragment), `iat`
        (within ±60s), `jti` (unique within 5 min), and `ath` (SHA-256 of the
        access token, base64url).


        Tokens expire in **1 hour** in production / staging and **8 hours** in
        sandbox. There are no refresh tokens — call `/oauth/token` again with
        your secret. Anton's public signing key is published at
        `/.well-known/jwks.json`.


        OpenAPI 3.0 has no native DPoP scheme; this declaration plus
        `dpopHeader` together convey both the access-token Authorization and the
        per-request proof header.
      flows:
        clientCredentials:
          tokenUrl: /oauth/token
          scopes: {}
    dpopHeader:
      type: apiKey
      in: header
      name: DPoP
      description: >
        Per-request DPoP proof JWT (RFC 9449). MUST accompany the
        `Authorization: DPoP <access_token>` header on every protected
        operation. The proof is signed by the merchant's private DPoP key and
        carries `htm`, `htu`, `iat`, `jti`, and `ath` claims.

````