> ## 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.

# Invite the buyer

> Transition `approved` -> `awaiting_buyer` and queue a magic-link email to the buyer of record. If the buyer is already KYC-approved (a pre-created buyer account), the invoice fast-forwards past the KYC step so the buyer goes straight to payment.



## OpenAPI

````yaml https://api.caratuva.com/docs-json post /v1/invoices/{id}/invite-buyer
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/invoices/{id}/invite-buyer:
    post:
      tags:
        - Invoices
      summary: Invite the buyer
      description: >-
        Transition `approved` -> `awaiting_buyer` and queue a magic-link email
        to the buyer of record. If the buyer is already KYC-approved (a
        pre-created buyer account), the invoice fast-forwards past the KYC step
        so the buyer goes straight to payment.
      operationId: InvoicesController_inviteBuyer
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: Invoice transitioned and magic-link queued for delivery
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: sent
                  invoiceId:
                    type: string
                    example: ckxinv042
              examples:
                default:
                  value:
                    status: sent
                    invoiceId: ckxinv042
      security:
        - apiKey: []
        - bearer: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````