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

> ## Agent Instructions
> Test in the sandbox first: base URL https://api-sandbox.y.uno (Test Mode in the Dashboard). Production is https://api.y.uno (Live Mode).
> Every API request needs the public-api-key and private-secret-key headers. Get them in the Dashboard at https://dashboard.y.uno/developers (Developers > Credentials); sandbox and production keys are different.
> Send an X-Idempotency-Key (a UUID) when creating payments, refunds and cancels, so retries do not create duplicates.
> Start with the Quickstart (https://docs.y.uno/docs/quickstart.md) and the agent guide (https://docs.y.uno/agents.md). To search these docs from a coding agent, connect the docs MCP server at https://docs.y.uno/mcp.

# Actualizar onboarding

> Actualiza los datos o la documentación de un onboarding existente de un destinatario

Actualiza un onboarding existente de un destinatario. Solo se actualizarán los campos especificados.

Este endpoint actualiza un onboarding existente de un destinatario, lo que permite modificar los detalles del onboarding después de su creación inicial. Úsalo cuando necesites actualizar la información del proveedor, la documentación, los datos bancarios u otros parámetros del onboarding de destinatarios existentes en el [marketplace de pagos con split](https://docs.y.uno/es/docs/payment-features/split-payments-marketplace.md#/).

## Requisitos previos

Este endpoint requiere un onboarding existente creado mediante [Create Onboarding](https://docs.y.uno/es/reference/recipients-for-marketplace/create-onboarding.md)

## Cuentas con onboarding previo

Para volver a registrar un onboarding `PREVIOUSLY_ONBOARDED` existente, por ejemplo después de que terminó en `ERROR` porque un id de cuenta era incorrecto, llama a `PATCH /v1/recipients/{recipient_id}/onboardings/{onboarding_id}` con el objeto `provider`: `provider.id`, `provider.connection_id` y los ids de cuenta.

```json theme={"theme":{"light":"github-dark","dark":"github-dark-dimmed"}}
{
  "provider": {
    "id": "PROVIDER_ID",
    "connection_id": "8fee3cc6-f3cb-455d-b139-973866111a03",
    "recipient_id": "ACCOUNT_ID_AT_PROVIDER",
    "balance_account_id": "BALANCE_ACCOUNT_ID_AT_PROVIDER"
  }
}
```

Los ids de cuenta son los mismos que al crear: `provider.recipient_id`, `provider.recipient_additional_id`, `provider.balance_account_id`, `provider.legal_entity` y `provider.recipient_type`. Cuáles de ellos necesita un proveedor lo define su integración. Se reenvían exactamente como se envían.

* **La integración admite adoptar cuentas existentes**: Yuno repite el registro en el proveedor y aplica su respuesta. El onboarding pasa a `SUCCEEDED` (webhook `onboarding.succeeded`) o a `ERROR` con el mensaje del proveedor en `response_message` (webhook `onboarding.error`). Un onboarding en `ERROR` pasa a `SUCCEEDED` una vez que el proveedor acepta los ids corregidos.
* **Cualquier otro proveedor**: los ids se almacenan y no se hace ninguna llamada al proveedor. No se validan en el proveedor.

Una actualización sin ids del proveedor solo reenvía la notificación del estado actual; no vuelve a registrar la cuenta.

Qué proveedores adoptan cuentas existentes es una configuración del lado de Yuno por entorno, no un campo de la API. Para saber si está disponible para tu conexión con el proveedor, contacta a tu Key Account Manager.

## Actualizar una cuenta bancaria

Para los onboardings de Zoop y Pagar.me con un ID de destinatario del proveedor, una actualización explícita de `withdrawal_methods.bank` espera el resultado del proveedor. Actualiza solo el onboarding seleccionado; el valor predeterminado del destinatario y los demás onboardings permanecen sin cambios.

Solo se guarda para el onboarding una cuenta confirmada. Los resultados de la actualización bancaria no cambian su estado de ciclo de vida. Envía una cuenta completa cuando el onboarding no muestre ninguna cuenta bancaria. Consulta [errores bancarios y reintentos](https://docs.y.uno/es/reference/recipients-for-marketplace/update-recipient-1.md#bank-errors-and-retries) para ver resultados parciales, respuestas `400` y la guía de conciliación de `409`.

Para estos onboardings compatibles vinculados al proveedor, los campos que no son bancarios, distintos de `documentation`, se guardan en Yuno sin una actualización separada del perfil en el proveedor. Enviar una descripción o metadata no reenvía la cuenta bancaria guardada. En una solicitud mixta, el banco se procesa primero; los demás campos se guardan solo después de que tenga éxito. Los destinatarios incorporados previamente conservan la notificación de estado existente para las actualizaciones no bancarias sin `documentation`.

Por ejemplo, cambiar solo la descripción de una tienda deja sin cambios su cuenta de pago confirmada y el estado del onboarding. Para cambiar la cuenta de pago, incluye `withdrawal_methods.bank` de forma explícita.

## Actualizar la documentación

Para los onboardings de Zoop con un ID de destinatario del proveedor, una solicitud con `documentation` envía a Zoop los documentos de esa solicitud y espera el resultado. Esto incluye a los destinatarios incorporados previamente. Solo se envían las categorías de documentos de la solicitud, y la cuenta bancaria no se reenvía.

* Si Zoop acepta los documentos, el onboarding toma el estado y los requisitos que informa Zoop, y se envía el webhook de onboarding habitual.
* Si Zoop rechaza los documentos, o no se puede confirmar el envío o el estado resultante, la respuesta es `400` con el código `PROVIDER_OPERATION_FAILED`. Los documentos se guardan en Yuno, y el onboarding conserva su estado y requisitos anteriores. Reenvía solo `documentation`.
* En una solicitud que también actualiza la cuenta bancaria, la actualización bancaria se procesa primero. Si luego fallan los documentos, el `400` también informa el resultado bancario. Un cambio bancario informado como `APPLIED` permanece aplicado, por lo que debes reenviar solo `documentation`.

Los onboardings en estado `CANCELLED`, `BLOCKED`, `INACTIVE` o `TRANSFERRED` rechazan las actualizaciones con `400 INVALID_STATE`, excepto los destinatarios incorporados previamente: su actualización guarda `documentation` en Yuno sin enviarla al proveedor. Un onboarding `TERMINATED` siempre devuelve `400 INVALID_STATE`.


## OpenAPI

````yaml openapi/es/recipients-for-marketplace/update-onboarding.json PATCH /recipients/{recipient_id}/onboardings/{onboarding_id}
openapi: 3.1.0
info:
  title: Recipients API
  version: 1.0.0
  description: >-
    API for managing recipients in split payment scenarios. This feature enables
    merchants to split payments among multiple recipients, which is particularly
    beneficial for marketplace models where transactions need to be divided
    among different sellers or stakeholders.
servers:
  - url: https://api-sandbox.y.uno/v1
    description: Sandbox
  - url: https://api.y.uno/v1
    description: Production (US)
security:
  - sec0: []
    sec1: []
paths:
  /recipients/{recipient_id}/onboardings/{onboarding_id}:
    patch:
      summary: Actualizar onboarding
      description: >-
        En los onboardings vinculados a proveedor de Zoop y Pagar.me, las
        actualizaciones bancarias explícitas esperan la confirmación del
        proveedor. Los resultados desconocidos devuelven 409; los cambios
        confirmados no se revierten. Consulta la guía del endpoint para el
        direccionamiento, los resultados parciales y las pautas de reintento.
      operationId: update-onboarding
      parameters:
        - in: path
          name: recipient_id
          description: ID del destinatario cuyo onboarding se actualizará
          schema:
            type: string
          required: true
          example: 9104911d-5df9-429e-8488-ad41abea1a4b
        - in: path
          name: onboarding_id
          description: ID del onboarding que se va a actualizar
          schema:
            type: string
          required: true
          example: 9104911d-5df9-429e-8488-ad41abea1a4b
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                account_id:
                  type: string
                  description: ID único de la cuenta en Yuno
                  example: 9104911d-5df9-429e-8488-ad41abea1a4b
                type:
                  type: string
                  enum:
                    - PREVIOUSLY_ONBOARDED
                    - ONE_STEP_ONBOARDING
                    - TWO_STEP_ONBOARDING
                  description: >-
                    Tipo de flujo de onboarding. PREVIOUSLY_ONBOARDED asocia una
                    cuenta que ya existe en el proveedor, ONE_STEP_ONBOARDING
                    crea la cuenta y hace el KYC en un solo paso, y
                    TWO_STEP_ONBOARDING primero crea la cuenta y hace el KYC
                    después.


                    Para volver a registrar un onboarding PREVIOUSLY_ONBOARDED,
                    envía `provider.id`, `provider.connection_id` y los ids de
                    la cuenta del proveedor. Cuando la integración del proveedor
                    permite adoptar cuentas existentes, Yuno repite el registro
                    y aplica la respuesta: el onboarding pasa a `SUCCEEDED` o a
                    `ERROR` con el mensaje del proveedor en `response_message`.
                    Con cualquier otro proveedor, los ids se guardan y no se
                    llama al proveedor. Una actualización sin ids del proveedor
                    solo vuelve a enviar la notificación del estado actual. Qué
                    proveedores adoptan cuentas existentes es una configuración
                    de Yuno por entorno; consulta a tu Key Account Manager.
                  example: PREVIOUSLY_ONBOARDED
                workflow:
                  type: string
                  enum:
                    - HOSTED_BY_PROVIDER
                    - HOSTED_BY_YUNO
                    - DIRECT
                  description: Flujo del onboarding
                  example: HOSTED_BY_PROVIDER
                callback_url:
                  type: string
                  format: uri
                  description: >-
                    URL a la que redirigir a tu cliente después del proceso de
                    onboarding con el proveedor, si es necesario.
                  example: https://www.google.com
                provider:
                  type: object
                  description: >-
                    Proveedor del onboarding. En PREVIOUSLY_ONBOARDED, los ids
                    de la cuenta del proveedor se reenvían a la integración del
                    proveedor exactamente como se enviaron; qué ids necesita
                    cada proveedor lo define su integración. Envía `id` y
                    `connection_id` junto con los ids para volver a registrar la
                    cuenta.
                  properties:
                    id:
                      type: string
                      description: ID del proveedor
                      example: PAGARME
                    connection_id:
                      type: string
                      description: ID de la conexión en Yuno
                      example: 104911d-5df9-429e-8488-ad41abea1a4b
                    recipient_id:
                      type: string
                      description: Identificador único del destinatario del proveedor.
                      example: AAAAA01
                    recipient_additional_id:
                      type: string
                      description: >-
                        Identificador adicional del destinatario en el
                        proveedor, para los proveedores que identifican una
                        cuenta con más de un id. Si hace falta o no lo define la
                        integración del proveedor.
                      example: AAAAA01-SUB
                    balance_account_id:
                      type: string
                      description: >-
                        Identificador de la cuenta de saldo del destinatario en
                        el proveedor. Si hace falta o no lo define la
                        integración del proveedor.
                      example: BA00000000000000000000001
                    legal_entity:
                      type: string
                      description: >-
                        Identificador de la entidad legal del destinatario en el
                        proveedor. Si hace falta o no lo define la integración
                        del proveedor.
                      example: LE00000000000000000000001
                    recipient_type:
                      type: string
                      description: El tipo de destinatario para el proveedor.
                      enum:
                        - MEAL
                        - FOOD
                        - MULTI_BENEFITS
                        - FLEET
                      example: MEAL
                documentation:
                  type: array
                  description: Especifica el objeto de documentación.
                  items:
                    type: object
                    required:
                      - file_name
                      - content_type
                      - content_category
                      - content
                    properties:
                      file_name:
                        type: string
                        minLength: 3
                        maxLength: 255
                        description: >-
                          El nombre de la documentación enviada (MAX 255; MIN
                          3).
                        example: PDF
                      content_type:
                        type: string
                        enum:
                          - application/pdf
                          - image/jpeg
                          - image/png
                        description: El tipo de documentación enviada por el comercio
                        example: application/pdf
                      content_category:
                        type: string
                        enum:
                          - ACCOUNT_REQUIREMENT
                          - BANK_STATEMENT
                          - BUSINESS_ICON
                          - BUSINESS_LOGO
                          - CANCEL_POLICY
                          - CUSTOMER_INTERACTION
                          - DRIVERS_LICENCE
                          - IDENTIFICATION_DOCUMENT
                          - IDENTIFICATION_DOCUMENT_BACK
                          - IDENTIFICATION_DOCUMENT_FRONT
                          - LEGAL_AGREEMENT
                          - OTHERS
                          - PASSPORT
                          - PAYMENT_DETAIL
                          - PROOF_OF_ADDRESS
                          - PROOF_OF_AUTHENTICITY
                          - PROOF_OF_DELIVERY
                          - PROOF_OF_DIRECTOR
                          - PROOF_OF_INDUSTRY
                          - PROOF_OF_NATIONAL_ID_NUMBER
                          - PROOF_OF_OWNERSHIP
                          - PROOF_OF_REGISTRATION
                          - PROOF_OF_RELATIONSHIP
                          - PROOF_OF_SERVICE
                          - PROOF_OF_SOURCE_OF_FUNDS
                          - PROOF_OF_SOURCE_OF_WEALTH
                          - PROOF_OF_TAX
                          - PROVIDER_IDENTITY_DOCUMENT
                          - RECEIPT
                          - REFUND_POLICY
                          - SELFIE
                          - SERVICE_AGREEMENT
                          - SIGNATURE
                          - TERMS_AND_CONDITIONS
                          - VAT_DOCUMENT
                        description: >-
                          La categoría de la documentación enviada por el
                          comercio
                      content:
                        type: string
                        format: byte
                        description: >-
                          Contenido de la documentación enviada por el comercio,
                          codificado en base64. Tamaño máximo: 1MB.
                        example: >-
                          JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCg==
                withdrawal_methods:
                  type: object
                  description: Especifica el objeto de métodos de retiro.
                  properties:
                    bank:
                      type: object
                      description: struct
                      properties:
                        code:
                          type: string
                          minLength: 3
                          maxLength: 3
                          description: Código del banco (MAX 3; MIN 3)
                          example: '246'
                        branch:
                          type: string
                          minLength: 3
                          maxLength: 3
                          description: Sucursal del banco (MAX 3; MIN 3)
                          example: XXXX
                        branch_digit:
                          type: string
                          minLength: 3
                          maxLength: 3
                          description: Dígito de la sucursal del banco (MAX 3; MIN 3)
                        account:
                          type: string
                          minLength: 3
                          maxLength: 250
                          description: >-
                            Número de cuenta bancaria del beneficiario (MAX 3;
                            MIN 250)
                          example: '1093333333'
                        account_digit:
                          type: string
                          minLength: 3
                          maxLength: 250
                          description: >-
                            Dígito de la cuenta bancaria del beneficiario (MAX
                            3; MIN 250)
                        account_type:
                          type: string
                          enum:
                            - CHECKINGS
                            - SAVINGS
                            - VISTA
                            - PIX_EMAIL
                            - PIX_PHONE
                            - PIX_DOCUMENT_ID
                            - PIX_BANK_ACCOUNT
                          description: >-
                            Tipo de cuenta bancaria del beneficiario (MAX 1; MIN
                            3). Puede ser: CHECKINGS, SAVINGS, VISTA, PIX_EMAIL,
                            PIX_PHONE, PIX_DOCUMENT_ID, PIX_BANK_ACCOUNT
                          example: SAVINGS
                        routing:
                          type: string
                          description: >-
                            Número de ruta de la cuenta bancaria del
                            beneficiario
                          example: XXXXYYYYC
                        country:
                          type: string
                          minLength: 2
                          maxLength: 2
                          description: País de la cuenta bancaria (ISO 3166-1 MAX 2; MIN 2)
                          example: CO
                        currency:
                          type: string
                          minLength: 3
                          maxLength: 3
                          description: >-
                            Moneda de la cuenta bancaria (ISO 3166-1 MAX 3; MIN
                            3)
                          example: COP
                legal_representatives:
                  type: array
                  description: >-
                    Objeto que indica los propietarios de la organización.
                    Adyen, Stripe y dlocal tienen campos relacionados con esto.
                  items:
                    type: object
                    properties:
                      merchant_reference:
                        type: string
                        minLength: 3
                        maxLength: 255
                        description: >-
                          ID de identificación del representante legal (MAX 255;
                          MIN 3).
                      first_name:
                        type: string
                        minLength: 1
                        maxLength: 255
                        description: Nombre del representante legal. (MAX 255; MIN 1).
                        example: John
                      last_name:
                        type: string
                        minLength: 1
                        maxLength: 255
                        description: Apellido del representante legal. (MAX 255; MIN 1).
                        example: Doe
                      email:
                        type: string
                        format: email
                        minLength: 1
                        maxLength: 255
                        description: Email del representante legal (MAX 255; MIN 1).
                        example: john.doe@email.com
                      date_of_birth:
                        type: string
                        format: date
                        minLength: 10
                        maxLength: 10
                        description: >-
                          Fecha de nacimiento del representante legal en formato
                          YYYY-MM-DD (MAX 10; MIN 10).
                        example: '1990-02-28'
                      country:
                        type: string
                        minLength: 2
                        maxLength: 2
                        description: País del representante legal (ISO 3166-1 MAX 2; MIN 2)
                        example: CO
                      nationality:
                        type: string
                        minLength: 2
                        maxLength: 2
                        description: >-
                          Nacionalidad del representante legal (MAX 2; MIN 2;
                          ISO 3166-1).
                        example: CO
                      title:
                        type: string
                        minLength: 1
                        maxLength: 255
                        description: Cargo del representante legal (MAX 255; MIN 1).
                        example: CTO
                      publicly_exposed_person:
                        type: boolean
                        description: >-
                          Indica si el representante legal es una persona
                          expuesta políticamente
                        example: false
                      ultimate_beneficial_owner:
                        type: boolean
                        description: >-
                          Indica si el representante legal es un beneficiario
                          final de la empresa
                        example: false
                terms_of_service:
                  type: object
                  description: Objeto que describe los términos de servicio.
                  required:
                    - acceptance
                    - date
                  properties:
                    acceptance:
                      type: boolean
                      description: Si el destinatario aceptó los términos de servicio
                      example: true
                    date:
                      type: string
                      format: date-time
                      description: Fecha de aceptación de los términos de servicio
                      example: '2022-07-09T20:43:54.786342Z'
                    ip:
                      type: string
                      format: ipv4
                      description: IP de aceptación de los términos de servicio
                      example: 192.168.1.100
            examples:
              Update Onboarding:
                value:
                  account_id: '{{account_id}}'
                  provider:
                    id: YUNO_TEST_PAYMENT_GW
                    connection_id: '{{connection_id}}'
                    recipient_type: MULTI_BENEFITS
      responses:
        '200':
          description: Actualizado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipientResponse'
        '400':
          description: >-
            Solicitud no válida, rechazo bancario definitivo para el onboarding
            seleccionado, o un estado de onboarding que no acepta
            actualizaciones bancarias (INVALID_STATE). Un 400 también puede
            darse después de un cambio bancario confirmado cuando falla un paso
            posterior que no es bancario (REQUEST_CANNOT_BE_PROCESSED); lee los
            mensajes del resultado. La documentación que el proveedor rechaza, o
            cuya entrega no se puede confirmar, devuelve
            PROVIDER_OPERATION_FAILED; los documentos se guardan y el onboarding
            conserva su estado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Invalid Parameters:
                  value:
                    code: INVALID_PARAMETERS
                    messages:
                      - >-
                        Provider rejected or requires attention to field:
                        withdrawal_methods.bank.
                Documents not delivered:
                  value:
                    code: PROVIDER_OPERATION_FAILED
                    messages:
                      - >-
                        Documents saved, but not delivered to the provider.
                        Resend only documentation.
        '401':
          description: No autorizado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Unauthorized:
                  value:
                    code: INVALID_CREDENTIALS
                    messages:
                      - Invalid credentials
        '403':
          description: Prohibido
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Forbidden:
                  value:
                    code: AUTHORIZATION_REQUIRED
                    messages:
                      - The merchant has no authorization to use this API.
        '409':
          description: >-
            Resultado bancario sin confirmar, o una operación de onboarding
            impide esta solicitud. Revisa el código y los mensajes; es posible
            que ya se haya producido un cambio confirmado en el proveedor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Unconfirmed bank update:
                  value:
                    code: PROVIDER_TIMEOUT_AMBIGUOUS
                    messages:
                      - >-
                        Provider ZOOP, onboarding
                        3f6c1a2e-8b4d-4c7e-9a1f-5d2e7b9c0a14: UNKNOWN.
                      - >-
                        The provider did not confirm this bank update. Inspect
                        the provider account before retrying; untrusted provider
                        diagnostics were omitted.
                      - >-
                        Unconfirmed outcomes require provider reconciliation
                        before a different bank is submitted. Resend the same
                        intended account after the approximately three-minute
                        cooldown.
                Operation in progress:
                  value:
                    code: ONBOARDING_OPERATION_IN_PROGRESS
                    messages:
                      - >-
                        A bank or onboarding operation is in progress. After an
                        unconfirmed result, reconcile the provider account
                        before resending the same intended account after about
                        three minutes.
components:
  schemas:
    RecipientResponse:
      type: object
      properties:
        id:
          type: string
          description: El identificador único del destinatario.
          example: 3aaa4d82-11e8-48ce-8ef5-04eee3a10802
        account_id:
          type: string
          description: El identificador de cuenta asociado a este destinatario.
          example: fe14c7c6-c75e-43b7-bdbe-4c87ad52c482
        merchant_recipient_id:
          type: string
          description: Identificador único del destinatario definido por el comercio.
          example: MERCHANT_182acf1d-faeb-4ff0-94cd-7fab11b282f6
        national_entity:
          type: string
          description: Tipo de entidad nacional del beneficiario.
          example: INDIVIDUAL
        entity_type:
          type: string
          description: Tipo de organización del beneficiario.
          example: PRIVATE
        first_name:
          type: string
          description: Nombre del beneficiario.
          example: Juan
        last_name:
          type: string
          description: Apellido del beneficiario.
          example: Perez
        legal_name:
          type:
            - string
            - 'null'
          description: Razón social del beneficiario.
          example: null
        email:
          type: string
          description: El correo electrónico del beneficiario.
          example: juan.perez@example.com
        date_of_birth:
          type: string
          description: Fecha de nacimiento del beneficiario.
          example: '1990-01-15'
        country:
          type: string
          description: El país del beneficiario.
          example: CO
        website:
          type: string
          description: La URL del sitio web del vendedor.
          example: https://juanperez.com
        industry:
          type: string
          description: El sector del vendedor.
          example: Technology
        merchant_category_code:
          type: string
          description: El código de categoría del comercio (MCC) (MAX 235; MIN 1).
          example: '5734'
        document:
          type: object
          properties:
            document_number:
              type: string
              example: '1234567890'
            document_type:
              type: string
              example: CC
        phone:
          type: object
          properties:
            country_code:
              type: string
              example: '57'
            number:
              type: string
              example: '3001234567'
        address:
          type: object
          properties:
            address_line_1:
              type: string
              example: 'Carrera 7 # 32-16'
            address_line_2:
              type:
                - string
                - 'null'
              example: Oficina 201
            city:
              type: string
              example: Bogota
            country:
              type: string
              example: CO
            state:
              type: string
              example: Cundinamarca
            zip_code:
              type: string
              example: '110311'
            neighborhood:
              type: string
              example: Centro
        legal_representatives:
          type: array
          items:
            type: object
            properties:
              merchant_reference:
                type: string
                example: REP_001
              first_name:
                type: string
                example: Maria
              last_name:
                type: string
                example: Gonzalez
              email:
                type: string
                example: maria.gonzalez@example.com
              date_of_birth:
                type: string
                example: '1985-05-20'
              country:
                type: string
                example: CO
              nationality:
                type: string
                example: CO
              title:
                type: string
                example: CEO
              publicly_exposed_person:
                type: boolean
                example: false
              ultimate_beneficial_owner:
                type: boolean
                example: true
              document:
                type: object
                properties:
                  document_type:
                    type: string
                    example: CC
                  document_number:
                    type: string
                    example: '0987654321'
              phone:
                type: object
                properties:
                  country_code:
                    type: string
                    example: '57'
                  number:
                    type: string
                    example: '3109876543'
              address:
                type: object
                properties:
                  address_line_1:
                    type: string
                    example: 'Calle 26 # 13-19'
                  address_line_2:
                    type:
                      - string
                      - 'null'
                    example: null
                  country:
                    type: string
                    example: CO
                  state:
                    type: string
                    example: Cundinamarca
                  city:
                    type: string
                    example: Bogota
                  zip_code:
                    type: string
                    example: '110311'
        withdrawal_methods:
          type: object
          properties:
            bank:
              type: object
              properties:
                code:
                  type: string
                  example: '001'
                branch:
                  type: string
                  example: '004'
                branch_digit:
                  type:
                    - string
                    - 'null'
                  example: '123'
                account:
                  type: string
                  example: '1234567890'
                account_digit:
                  type:
                    - string
                    - 'null'
                  example: '123'
                account_type:
                  type: string
                  example: SAVINGS
                routing:
                  type: string
                  example: '021000021'
                country:
                  type: string
                  example: CO
                currency:
                  type: string
                  example: COP
        documentation:
          type: array
          items:
            type: object
            properties:
              file_name:
                type: string
                example: cc-front.pdf
              content_type:
                type: string
                example: application/pdf
              content_category:
                type: string
                example: IDENTIFICATION
              content:
                type: string
                example: JVBERi0xLjQKJ...
        onboardings:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                example: 84c42684-dbe5-4e0f-bd17-4d094e19762d
              type:
                type: string
                example: ONBOARD_ONTO_THE_PROVIDER
              workflow:
                type: string
                example: DIRECT
              status:
                type: string
                example: PENDING
              callback_url:
                type: string
                example: https://merchant.example.com/webhook/onboarding
              provider:
                type: object
                properties:
                  id:
                    type: string
                    example: ALELO
                  connection_id:
                    type: string
                    example: cc389b51-53a1-4a29-af40-c8cee26c3399
                  recipient_id:
                    type:
                      - string
                      - 'null'
                    example: null
                  redirect_url:
                    type:
                      - string
                      - 'null'
                    example: null
                  onboarding_url:
                    type:
                      - string
                      - 'null'
                    example: null
                  legal_entity:
                    type:
                      - string
                      - 'null'
                    example: null
                  balance_account_id:
                    type:
                      - string
                      - 'null'
                    example: null
                  legal_entity_id:
                    type:
                      - string
                      - 'null'
                    example: null
              documentation:
                type: array
                items:
                  type: object
                  properties:
                    file_name:
                      type: string
                      example: utility-bill.pdf
                    content_type:
                      type: string
                      example: application/pdf
                    content_category:
                      type: string
                      example: ADDRESS_PROOF
                    content:
                      type: string
                      example: JVBERi0xLjQKJ...
              legal_representatives:
                type: array
                items:
                  type: object
                example: []
              requirements:
                type: array
                items:
                  type: object
                  properties:
                    field:
                      type: string
                      example: document.cc
                    message:
                      type: string
                      example: Provide CC document image
                    status:
                      type: string
                      example: PENDING
              withdrawal_methods:
                type: object
                properties:
                  bank:
                    type: object
                    properties:
                      code:
                        type: string
                        example: '002'
                      branch:
                        type: string
                        example: '002'
                      branch_digit:
                        type:
                          - string
                          - 'null'
                        example: null
                      account:
                        type: string
                        example: '9876543210'
                      account_digit:
                        type:
                          - string
                          - 'null'
                        example: null
                      account_type:
                        type: string
                        example: SAVINGS
                      routing:
                        type: string
                        example: '021000022'
                      country:
                        type: string
                        example: CO
                      currency:
                        type: string
                        example: COP
              terms_of_service:
                type: object
                properties:
                  acceptance:
                    type: boolean
                    example: true
                  date:
                    type: string
                    example: '2025-07-21T20:43:54Z'
                  ip:
                    type: string
                    example: 129.21.111.11
              created_at:
                type: string
                format: date-time
                example: '2025-08-27T15:41:19.516982Z'
              updated_at:
                type: string
                format: date-time
                example: '2025-08-27T15:41:19.516989Z'
        split_configuration:
          type: object
          description: >-
            Reglas para el cálculo automático de la división a nivel de
            destinatario.
          properties:
            calculation_type:
              type: string
              description: El método que se usa para calcular el monto del split.
              enum:
                - PERCENTAGE
                - FIXED
                - MIXED
              example: PERCENTAGE
            percentage:
              type: number
              description: >-
                Porcentaje del monto total del pago que se va a dividir
                (0.01-100.00). Obligatorio si calculation_type es PERCENTAGE o
                MIXED.
              minimum: 0.01
              maximum: 100
              example: 10.5
            fixed_amount:
              type: number
              description: >-
                Monto fijo que se va a dividir. Obligatorio si calculation_type
                es FIXED o MIXED.
              minimum: 0.0001
              example: 5
            currency:
              type: string
              description: >-
                Código de moneda ISO 4217. Obligatorio para todos los tipos de
                cálculo.
              example: USD
            rounding_mode:
              type: string
              description: >-
                La estrategia de redondeo para los montos calculados.
                Obligatorio para PERCENTAGE y MIXED.
              enum:
                - STANDARD
                - ROUND_UP
                - ROUND_DOWN
              example: STANDARD
        created_at:
          type: string
          format: date-time
          description: Fecha de creación del destinatario (ISO 8601 MAX 27; MIN 27).
          example: '2025-08-27T15:41:19.497413Z'
        updated_at:
          type: string
          format: date-time
          description: >-
            Fecha de la última actualización del destinatario (ISO 8601 MAX 27;
            MIN 27).
          example: '2025-08-27T15:41:19.497425Z'
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          example: INVALID_PARAMETERS
        messages:
          type: array
          items:
            type: string
            example: Invalid request
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: public-api-key
      x-default: <Your public-api-key>
    sec1:
      type: apiKey
      in: header
      name: private-secret-key
      x-default: <Your private-secret-key>

````

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