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

# Finish onboarding: capture submission and deliver a ToS link to the seller

> Final step of seller onboarding. Captures the seller's full KYB submission body and PIX payout config, then mints a single-use link to accept the settlement partner's terms. `delivery: 'email'` (default) emails the seller (requires the account's `email`); `delivery: 'link'` returns the `acceptUrl` for you to deliver yourself. The BlindPay submission (then payout registration) fires automatically once the seller accepts. Seller accounts only; the account must still be `created`.



## OpenAPI

````yaml https://api.caratuva.com/docs-json post /v1/accounts/{id}/request-tos
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/accounts/{id}/request-tos:
    post:
      tags:
        - Accounts
      summary: >-
        Finish onboarding: capture submission and deliver a ToS link to the
        seller
      description: >-
        Final step of seller onboarding. Captures the seller's full KYB
        submission body and PIX payout config, then mints a single-use link to
        accept the settlement partner's terms. `delivery: 'email'` (default)
        emails the seller (requires the account's `email`); `delivery: 'link'`
        returns the `acceptUrl` for you to deliver yourself. The BlindPay
        submission (then payout registration) fires automatically once the
        seller accepts. Seller accounts only; the account must still be
        `created`.
      operationId: ConnectedAccountsController_requestTos
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                submit:
                  type: object
                  properties:
                    tosId:
                      type: string
                      minLength: 1
                    kycTier:
                      type: string
                      enum:
                        - standard
                        - enhanced
                    email:
                      type: string
                      format: email
                    country:
                      type: string
                      minLength: 2
                      maxLength: 2
                    phone:
                      type: string
                      minLength: 3
                      maxLength: 32
                    firstName:
                      type: string
                      minLength: 1
                      maxLength: 100
                    lastName:
                      type: string
                      minLength: 1
                      maxLength: 100
                    dateOfBirth:
                      type: string
                    taxId:
                      type: string
                      minLength: 1
                      maxLength: 64
                    addressLine1:
                      type: string
                      minLength: 1
                      maxLength: 200
                    addressLine2:
                      type: string
                      maxLength: 200
                    city:
                      type: string
                      minLength: 1
                      maxLength: 120
                    stateProvinceRegion:
                      type: string
                      minLength: 1
                      maxLength: 120
                    postalCode:
                      type: string
                      minLength: 1
                      maxLength: 32
                    idDocCountry:
                      type: string
                      minLength: 2
                      maxLength: 2
                    idDocType:
                      type: string
                      enum:
                        - PASSPORT
                        - ID_CARD
                        - DRIVERS
                    idDocNumber:
                      type: string
                      minLength: 1
                      maxLength: 64
                    selfieFile:
                      type: string
                      format: uri
                    idDocFrontFile:
                      type: string
                      format: uri
                    idDocBackFile:
                      type: string
                      format: uri
                    legalName:
                      type: string
                      minLength: 1
                      maxLength: 200
                    cnpj:
                      type: string
                      pattern: ^\d{14}$
                    formationDate:
                      type: string
                    website:
                      type: string
                      format: uri
                    incorporationDocFile:
                      type: string
                      format: uri
                    proofOfOwnershipDocFile:
                      type: string
                      format: uri
                    proofOfAddressDocType:
                      type: string
                      enum:
                        - UTILITY_BILL
                        - BANK_STATEMENT
                        - RENTAL_AGREEMENT
                        - TAX_DOCUMENT
                        - GOVERNMENT_CORRESPONDENCE
                    proofOfAddressDocFile:
                      type: string
                      format: uri
                    owners:
                      type: array
                      items:
                        type: object
                        properties:
                          role:
                            type: string
                            enum:
                              - beneficial_controlling
                              - beneficial_owner
                              - controlling_person
                          firstName:
                            type: string
                            minLength: 1
                            maxLength: 100
                          lastName:
                            type: string
                            minLength: 1
                            maxLength: 100
                          dateOfBirth:
                            type: string
                            pattern: ^\d{4}-\d{2}-\d{2}$
                          taxId:
                            type: string
                            minLength: 1
                            maxLength: 64
                          taxType:
                            type: string
                            enum:
                              - SSN
                              - ITIN
                          addressLine1:
                            type: string
                            minLength: 1
                            maxLength: 200
                          addressLine2:
                            type: string
                            maxLength: 200
                          city:
                            type: string
                            minLength: 1
                            maxLength: 120
                          stateProvinceRegion:
                            type: string
                            minLength: 1
                            maxLength: 120
                          postalCode:
                            type: string
                            minLength: 1
                            maxLength: 32
                          country:
                            type: string
                            minLength: 2
                            maxLength: 2
                          phone:
                            type: string
                            minLength: 3
                            maxLength: 32
                          idDocCountry:
                            type: string
                            minLength: 2
                            maxLength: 2
                          idDocType:
                            type: string
                            enum:
                              - PASSPORT
                              - ID_CARD
                              - DRIVERS
                          idDocNumber:
                            type: string
                            minLength: 1
                            maxLength: 64
                          selfieFile:
                            type: string
                            format: uri
                          idDocFrontFile:
                            type: string
                            format: uri
                          idDocBackFile:
                            type: string
                            format: uri
                          proofOfAddressDocType:
                            type: string
                            enum:
                              - UTILITY_BILL
                              - BANK_STATEMENT
                              - RENTAL_AGREEMENT
                              - TAX_DOCUMENT
                              - GOVERNMENT_CORRESPONDENCE
                          proofOfAddressDocFile:
                            type: string
                            format: uri
                        required:
                          - role
                          - firstName
                          - lastName
                          - dateOfBirth
                          - taxId
                          - addressLine1
                          - city
                          - stateProvinceRegion
                          - postalCode
                          - country
                          - idDocCountry
                          - idDocType
                          - selfieFile
                          - idDocFrontFile
                          - proofOfAddressDocType
                          - proofOfAddressDocFile
                        additionalProperties: false
                      minItems: 1
                      maxItems: 10
                    metadata:
                      type: object
                      additionalProperties:
                        type: string
                  additionalProperties: false
                payout:
                  anyOf:
                    - type: object
                      properties:
                        pixKey:
                          type: string
                          minLength: 1
                          maxLength: 200
                        accountHolderName:
                          type: string
                          minLength: 1
                          maxLength: 200
                        name:
                          type: string
                          minLength: 1
                          maxLength: 120
                      required:
                        - pixKey
                      additionalProperties: false
                    - anyOf:
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - pix
                            name:
                              type: string
                              minLength: 1
                              maxLength: 120
                            pixKey:
                              type: string
                              minLength: 1
                              maxLength: 200
                          required:
                            - type
                            - pixKey
                          additionalProperties: false
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - international_swift
                            name:
                              type: string
                              minLength: 1
                              maxLength: 120
                            accountClass:
                              type: string
                              minLength: 1
                            swiftCodeBic:
                              type: string
                              minLength: 1
                            swiftAccountHolderName:
                              type: string
                              minLength: 1
                            swiftAccountNumberIban:
                              type: string
                              minLength: 1
                            swiftBeneficiaryAddressLine1:
                              type: string
                              minLength: 1
                            swiftBeneficiaryCountry:
                              type: string
                              minLength: 2
                              maxLength: 2
                            swiftBeneficiaryCity:
                              type: string
                              minLength: 1
                            swiftBeneficiaryStateProvinceRegion:
                              type: string
                              minLength: 1
                            swiftBeneficiaryPostalCode:
                              type: string
                              minLength: 1
                            swiftBankName:
                              type: string
                              minLength: 1
                            swiftBankAddressLine1:
                              type: string
                              minLength: 1
                            swiftBankAddressLine2:
                              type: string
                            swiftBankCountry:
                              type: string
                              minLength: 2
                              maxLength: 2
                            swiftBankCity:
                              type: string
                              minLength: 1
                            swiftBankStateProvinceRegion:
                              type: string
                              minLength: 1
                            swiftBankPostalCode:
                              type: string
                              minLength: 1
                            recipientRelationship:
                              type: string
                              minLength: 1
                            swiftPaymentCode:
                              type: string
                            businessIndustry:
                              type: string
                            taxId:
                              type: string
                            phoneNumber:
                              type: string
                          required:
                            - type
                            - accountClass
                            - swiftCodeBic
                            - swiftAccountHolderName
                            - swiftAccountNumberIban
                            - swiftBeneficiaryAddressLine1
                            - swiftBeneficiaryCountry
                            - swiftBeneficiaryCity
                            - swiftBeneficiaryStateProvinceRegion
                            - swiftBeneficiaryPostalCode
                            - swiftBankName
                            - swiftBankAddressLine1
                            - swiftBankCountry
                            - swiftBankCity
                            - swiftBankStateProvinceRegion
                            - swiftBankPostalCode
                            - recipientRelationship
                          additionalProperties: false
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - ach
                            name:
                              type: string
                              minLength: 1
                              maxLength: 120
                            beneficiaryName:
                              type: string
                              minLength: 1
                            routingNumber:
                              type: string
                              minLength: 1
                            accountNumber:
                              type: string
                              minLength: 1
                            accountType:
                              type: string
                              minLength: 1
                            accountClass:
                              type: string
                              minLength: 1
                            addressLine1:
                              type: string
                              minLength: 1
                            addressLine2:
                              type: string
                            city:
                              type: string
                              minLength: 1
                            stateProvinceRegion:
                              type: string
                              minLength: 1
                            country:
                              type: string
                              minLength: 2
                              maxLength: 2
                            postalCode:
                              type: string
                              minLength: 1
                            recipientRelationship:
                              type: string
                              minLength: 1
                          required:
                            - type
                            - beneficiaryName
                            - routingNumber
                            - accountNumber
                            - accountType
                            - accountClass
                            - addressLine1
                            - city
                            - stateProvinceRegion
                            - country
                            - postalCode
                            - recipientRelationship
                          additionalProperties: false
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - wire
                            name:
                              type: string
                              minLength: 1
                              maxLength: 120
                            beneficiaryName:
                              type: string
                              minLength: 1
                            routingNumber:
                              type: string
                              minLength: 1
                            accountNumber:
                              type: string
                              minLength: 1
                            accountClass:
                              type: string
                              minLength: 1
                            addressLine1:
                              type: string
                              minLength: 1
                            addressLine2:
                              type: string
                            city:
                              type: string
                              minLength: 1
                            stateProvinceRegion:
                              type: string
                              minLength: 1
                            country:
                              type: string
                              minLength: 2
                              maxLength: 2
                            postalCode:
                              type: string
                              minLength: 1
                            recipientRelationship:
                              type: string
                              minLength: 1
                          required:
                            - type
                            - beneficiaryName
                            - routingNumber
                            - accountNumber
                            - accountClass
                            - addressLine1
                            - city
                            - stateProvinceRegion
                            - country
                            - postalCode
                            - recipientRelationship
                          additionalProperties: false
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - rtp
                            name:
                              type: string
                              minLength: 1
                              maxLength: 120
                            beneficiaryName:
                              type: string
                              minLength: 1
                            routingNumber:
                              type: string
                              minLength: 1
                            accountNumber:
                              type: string
                              minLength: 1
                            accountClass:
                              type: string
                              minLength: 1
                            addressLine1:
                              type: string
                              minLength: 1
                            addressLine2:
                              type: string
                            city:
                              type: string
                              minLength: 1
                            stateProvinceRegion:
                              type: string
                              minLength: 1
                            country:
                              type: string
                              minLength: 2
                              maxLength: 2
                            postalCode:
                              type: string
                              minLength: 1
                            recipientRelationship:
                              type: string
                              minLength: 1
                          required:
                            - type
                            - beneficiaryName
                            - routingNumber
                            - accountNumber
                            - accountClass
                            - addressLine1
                            - city
                            - stateProvinceRegion
                            - country
                            - postalCode
                            - recipientRelationship
                          additionalProperties: false
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - spei_bitso
                            name:
                              type: string
                              minLength: 1
                              maxLength: 120
                            beneficiaryName:
                              type: string
                              minLength: 1
                            speiProtocol:
                              type: string
                              minLength: 1
                            speiInstitutionCode:
                              type: string
                              minLength: 1
                            speiClabe:
                              type: string
                              minLength: 1
                          required:
                            - type
                            - beneficiaryName
                            - speiProtocol
                            - speiInstitutionCode
                            - speiClabe
                          additionalProperties: false
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - ach_cop_bitso
                            name:
                              type: string
                              minLength: 1
                              maxLength: 120
                            accountType:
                              type: string
                              minLength: 1
                            achCopBeneficiaryFirstName:
                              type: string
                              minLength: 1
                            achCopBeneficiaryLastName:
                              type: string
                              minLength: 1
                            achCopDocumentId:
                              type: string
                              minLength: 1
                            achCopDocumentType:
                              type: string
                              minLength: 1
                            achCopEmail:
                              type: string
                              minLength: 1
                            achCopBankCode:
                              type: string
                              minLength: 1
                            achCopBankAccount:
                              type: string
                              minLength: 1
                          required:
                            - type
                            - accountType
                            - achCopBeneficiaryFirstName
                            - achCopBeneficiaryLastName
                            - achCopDocumentId
                            - achCopDocumentType
                            - achCopEmail
                            - achCopBankCode
                            - achCopBankAccount
                          additionalProperties: false
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - transfers_bitso
                            name:
                              type: string
                              minLength: 1
                              maxLength: 120
                            beneficiaryName:
                              type: string
                              minLength: 1
                            transfersType:
                              type: string
                              minLength: 1
                            transfersAccount:
                              type: string
                              minLength: 1
                          required:
                            - type
                            - beneficiaryName
                            - transfersType
                            - transfersAccount
                          additionalProperties: false
                delivery:
                  type: string
                  enum:
                    - email
                    - link
                  default: email
              required:
                - submit
              additionalProperties: false
            examples:
              default:
                value:
                  submit:
                    legalName: Fazenda Boa Vista Café LTDA
                    cnpj: '12345678000190'
                    email: finance@fazendaboavista.com.br
                    country: BR
                  payout:
                    pixKey: acme@pix.example.com
                    accountHolderName: Fazenda Boa Vista Café LTDA
      responses:
        '201':
          description: >-
            Submission captured; ToS acceptance link returned (and emailed to
            the seller when delivery=email)
          content:
            application/json:
              schema:
                type: object
                properties:
                  connectedAccountId:
                    type: string
                  acceptUrl:
                    type: string
                    format: uri
                  emailSent:
                    type: boolean
                required:
                  - connectedAccountId
                  - acceptUrl
                  - emailSent
                additionalProperties: false
              examples:
                default:
                  value:
                    connectedAccountId: ckacc042
                    acceptUrl: https://api.caratuva.com/v1/public/tos/start?t=abc123
                    emailSent: true
        '400':
          description: >-
            SellerEmailRequired — A seller email is required to send the ToS
            acceptance link (also: TosRequestSellerOnly, TosAlreadyRequested).
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  error:
                    type: string
                    example: SellerEmailRequired
                  message:
                    type: string
                    example: >-
                      A seller email is required to send the ToS acceptance link
                      (also: TosRequestSellerOnly, TosAlreadyRequested).
      security:
        - apiKey: []
        - bearer: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````