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

# Create Terms Acceptance Link

> Issues a single-use link to a Ripio-hosted page where the customer reads and accepts the active Terms and Conditions. Use it when your integration does not show the terms itself: open `url` in a webview, and when the customer has accepted, the page sends them to `redirectUrl`.

- The link is valid for **30 minutes** (`expiresAt`) and can be used **once**.
- Requesting a new link for the same customer **invalidates the previous one**, even if it has not expired.
- Request it right before opening it. Do not store it or send it by push notification or email.
- `redirectUrl` must match your account's allowlist of prefixes, configured with Ripio. Without an allowlist, any `https://`, `worldapp://` or `worldappstg://` URL is accepted.
- A link is issued even when the customer has already accepted the active version.

Arriving at `redirectUrl` does not prove the customer accepted: confirm with [Get Terms Acceptance Status](/ramps-api/terms-and-conditions/get-terms-acceptance-status). See [Terms and Conditions](/ramps-api/terms-and-conditions/introduction#ripio-hosted-acceptance-page).



## OpenAPI

````yaml ramps-api/openapi.json POST /api/v1/customers/{customerId}/termsLink/
openapi: 3.1.0
info:
  title: Ripio Ramp API
  version: v1
  description: >-
    API for Ripio ramp services, enabling partners to integrate On-Ramp,
    Off-Ramp, customer management, KYC processes, and other financial
    functionalities. This API is RESTful, uses JSON for requests and responses,
    and standard HTTP status codes. This document is based on the
    'onramp-api.pdf' provided and aims to be compliant with OpenAPI
    Specification v3.1.0. The PDF indicates that the API documentation is a
    draft and subject to change.
servers:
  - url: https://skala-sandbox.ripio.com
    description: Sandbox environment
  - url: https://skala.ripio.com
    description: Production environment
security:
  - BearerToken: []
tags:
  - name: Authentication
    description: Operations related to API authentication and authorization.
  - name: Support Tickets
    description: >-
      Operations for raising and tracking customer support tickets with Ripio's
      support team. This feature must be enabled for your account by the Ripio
      team.
  - name: Customers
    description: Operations related to customer management.
  - name: KYC
    description: Operations related to Know Your Customer processes.
  - name: Investor Profile
    description: >-
      Brazilian accounts only: the investor-profile (suitability) questionnaire
      required by Resolução BCB nº 520/2025.
  - name: Fiat Accounts
    description: Operations related to managing fiat accounts and their requirements.
  - name: Quotes
    description: Operations related to obtaining and managing conversion quotes.
  - name: On-Ramp
    description: Operations related to fiat-to-crypto (on-ramp) processes.
  - name: Off-Ramp
    description: Operations related to crypto-to-fiat (off-ramp) processes.
  - name: Refunds
    description: >-
      Operations for returning the money of an on-ramp or off-ramp operation
      that could not be completed. Each ramp must be enabled for your account by
      the Ripio team.
  - name: Transactions
    description: Operations related to listing and managing all transaction types.
  - name: Networks
    description: >-
      Operations related to retrieving available deposit and withdrawal
      networks.
  - name: Rates
    description: Operations related to retrieving market rates.
  - name: Transaction Limits
    description: >-
      Operations related to retrieving per-transaction limits by currency and
      ramp operation.
  - name: Sandbox
    description: Operations specific to the sandbox environment for testing purposes.
  - name: Webhooks
    description: Webhook event notifications from Ripio Ramp API.
  - name: Sell and Pay
    description: >-
      Endpoints for managing Sell and Pay transactions, which allow customers to
      convert cryptocurrency to fiat currency and pay merchants via QR codes
paths:
  /api/v1/customers/{customerId}/termsLink/:
    post:
      tags:
        - Terms and Conditions
      summary: Create Terms Acceptance Link
      description: >-
        Issues a single-use link to a Ripio-hosted page where the customer reads
        and accepts the active Terms and Conditions. Use it when your
        integration does not show the terms itself: open `url` in a webview, and
        when the customer has accepted, the page sends them to `redirectUrl`.


        - The link is valid for **30 minutes** (`expiresAt`) and can be used
        **once**.

        - Requesting a new link for the same customer **invalidates the previous
        one**, even if it has not expired.

        - Request it right before opening it. Do not store it or send it by push
        notification or email.

        - `redirectUrl` must match your account's allowlist of prefixes,
        configured with Ripio. Without an allowlist, any `https://`,
        `worldapp://` or `worldappstg://` URL is accepted.

        - A link is issued even when the customer has already accepted the
        active version.


        Arriving at `redirectUrl` does not prove the customer accepted: confirm
        with [Get Terms Acceptance
        Status](/ramps-api/terms-and-conditions/get-terms-acceptance-status).
        See [Terms and
        Conditions](/ramps-api/terms-and-conditions/introduction#ripio-hosted-acceptance-page).
      operationId: createTermsLink
      parameters:
        - $ref: '#/components/parameters/CustomerId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TermsLinkRequest'
            example:
              redirectUrl: https://partner.example.com/terms/done
      responses:
        '201':
          description: Link issued.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TermsLinkResponse'
              example:
                url: >-
                  https://b2b-widget-onramp.ripio.com/#_at=4f1c2b7e-6a1d-4c39-9a8e-2b5d0f7c3e11.Q2xhdWRlIGV4YW1wbGUgc2VjcmV0
                expiresAt: '2026-11-24T15:30:00Z'
        '400':
          description: >-
            Bad Request - `redirectUrl` is missing, invalid or not allowed for
            your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                RedirectUrlNotAllowed:
                  summary: redirectUrl outside the account's allowlist
                  description: >-
                    `redirectUrl` does not start with any prefix configured for
                    your account (or, without an allowlist, is not an
                    `https://`, `worldapp://` or `worldappstg://` URL). Ask
                    Ripio to add the prefix, or send an allowed URL.
                  value:
                    code: 20115
                    type: TermsLinkRedirectUrlNotAllowedException
                    detail:
                      message: redirectUrl is not allowed for this account.
                    status: 400
                MissingRedirectUrl:
                  summary: redirectUrl missing
                  value:
                    code: 20000
                    type: ValidationError
                    detail:
                      redirectUrl:
                        - message: This field is required.
                          code: required
                    status: 400
        '401':
          description: Unauthorized - Invalid or missing access token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                code: 40001
                type: NotAuthenticated
                detail:
                  message: Authentication credentials were not provided.
                  code: not_authenticated
                status: 401
        '404':
          description: >-
            Not Found - Customer not found or inactive, or no active Terms and
            Conditions for the account's country.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CustomerNotFound:
                  summary: Customer not found or inactive
                  value:
                    code: 40004
                    type: NotFound
                    detail:
                      message: Not found.
                      code: not_found
                    status: 404
                TermsNotFound:
                  summary: No active Terms and Conditions
                  description: >-
                    There is nothing to accept for the account's country. Get
                    Terms Acceptance Status answers `accepted: true` in this
                    case, so you should not need a link.
                  value:
                    code: 20040
                    type: TermsAndConditionsNotFoundException
                    detail:
                      message: >-
                        No active Terms and Conditions found for this id and
                        country.
                    status: 404
components:
  parameters:
    CustomerId:
      name: customerId
      in: path
      required: true
      description: Unique identifier for the customer.
      schema:
        type: string
        format: uuid
      example: 8142b065-79c4-4f48-9e33-11b17bc658d4
  schemas:
    TermsLinkRequest:
      type: object
      properties:
        redirectUrl:
          type: string
          maxLength: 500
          description: >-
            Where the hosted page sends the customer after they accept. Must
            start with one of the prefixes configured for your account; without
            an allowlist, any `https://`, `worldapp://` or `worldappstg://` URL.
          example: https://partner.example.com/terms/done
      required:
        - redirectUrl
    TermsLinkResponse:
      type: object
      properties:
        url:
          type: string
          format: uri
          description: >-
            Single-use link to the Ripio-hosted acceptance page. Open it in a
            webview as is; do not store it or alter it.
          example: >-
            https://b2b-widget-onramp.ripio.com/#_at=4f1c2b7e-6a1d-4c39-9a8e-2b5d0f7c3e11.Q2xhdWRlIGV4YW1wbGUgc2VjcmV0
        expiresAt:
          type: string
          format: date-time
          description: When the link stops working (30 minutes after it was issued).
          example: '2026-11-24T15:30:00Z'
      required:
        - url
        - expiresAt
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          description: Application-specific error code.
        type:
          type: string
          description: Type of error or exception.
        detail:
          type:
            - object
            - array
          description: >-
            Error details. The shape depends on the error:


            - Most business errors return an object with a `message` key.

            - Field validation errors return an object keyed by field name, each
            holding an array of `{ message, code }`.

            - Request-level validation errors (e.g. a missing query parameter)
            return a bare array of `{ message, code }`.
          properties:
            message:
              type: string
              description: Detailed error message.
          additionalProperties: true
        status:
          type: integer
          description: HTTP status code.
      required:
        - code
        - type
        - detail
        - status
  securitySchemes:
    BearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access token obtained via
        [/oauth2/token/](/ramps-api/authentication/acquire-access-token). Use as
        `Authorization: Bearer <access_token>`.

````

## Related topics

- [Terms and Conditions](https://docs.ripio.com/ramps-api/terms-and-conditions/introduction.md)
- [Sign-in and terms](https://docs.ripio.com/ramps-api/widget/flows/identity-and-terms.md)
- [Get Terms Acceptance Status](https://docs.ripio.com/ramps-api/terms-and-conditions/get-terms-acceptance-status.md)
- [QR payments integration](https://docs.ripio.com/ramps-api/guides/qr-payments-integration.md)
- [Off-Ramp integration](https://docs.ripio.com/ramps-api/guides/off-ramp-integration.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.