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

# Mint a settlement-partner ToS-acceptance session URL

> Mint a settlement-partner ToS-acceptance session URL. Direct your buyer to the returned `url`; on acceptance the settlement partner redirects to your `redirectUrl` with `?tos_id=...&idempotency_key=...` query params. Then call `/tos-accepted` (or pass `tosId` in the next `/buyer-kyc` submit).



## OpenAPI

````yaml https://api.caratuva.com/docs-json post /v1/buyer-kyc/{buyerId}/tos-session
openapi: 3.0.0
info:
  title: Caratuva API
  description: >-
    Cross-border B2B payments. Fiat on-ramp → USDC → PIX off-ramp.


    Every request runs in **test** or **live** mode on this single host — there
    is no separate sandbox URL. API keys carry the mode in their prefix
    (`pk_test_…` / `pk_live_…`); dashboard JWTs start in test and re-mint via
    `POST /v1/auth/switch-mode`. Test mode runs the full pipeline against a
    sandbox payment instance (KYB/KYC auto-approve, no real money); live runs on
    real rails and requires approved KYB. Test and live data are fully isolated.
    Check readiness with `GET /v1/onboarding/status`.
  version: 1.0.0
  contact: {}
servers: []
security: []
tags:
  - name: Invoices
    description: Create and manage invoices that collect for one of your sellers.
  - name: Payments
    description: Create a payment (keep your own checkout), fetch it, or cancel it.
  - name: Accounts
    description: >-
      Onboard and manage your sellers, buyers, and your own (self) account at
      the settlement partner.
  - name: Webhooks
    description: Subscribe to outbound event notifications and manage signing secrets.
  - name: API keys
    description: Issue, list, and revoke the API keys that authenticate your integration.
  - name: Access
    description: Request and check production (live-mode) access for your organization.
  - name: Reports
    description: Pull settlement and transfer-pricing reports.
paths:
  /v1/buyer-kyc/{buyerId}/tos-session:
    post:
      tags:
        - Accounts
      summary: Mint a settlement-partner ToS-acceptance session URL
      description: >-
        Mint a settlement-partner ToS-acceptance session URL. Direct your buyer
        to the returned `url`; on acceptance the settlement partner redirects to
        your `redirectUrl` with `?tos_id=...&idempotency_key=...` query params.
        Then call `/tos-accepted` (or pass `tosId` in the next `/buyer-kyc`
        submit).
      operationId: BuyerKycController_tosSession
      parameters:
        - name: buyerId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                redirectUrl:
                  type: string
                  format: uri
              required:
                - redirectUrl
              additionalProperties: false
            examples:
              default:
                value:
                  redirectUrl: https://erp.example.com/buyers/ckbuy001/kyc/tos-accepted
      responses:
        '201':
          description: ToS session URL minted
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                    format: uri
                  idempotencyKey:
                    type: string
                    format: uuid
                required:
                  - url
                  - idempotencyKey
                additionalProperties: false
              examples:
                default:
                  value:
                    url: https://app.blindpay.com/tos/accept?session=abc123
                    idempotencyKey: 3f9a1c7e-0b2d-4f6a-8c1e-3b5d7f9a0c2e
        '404':
          description: NotFound — No buyer with that buyerId.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  error:
                    type: string
                    example: NotFound
                  message:
                    type: string
                    example: No buyer with that buyerId.
      security:
        - apiKey: []
        - bearer: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````