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

# Consultar CVU o alias

> Consulta información del beneficiario por CVU (22 dígitos) o alias.
Devuelve alias, CUIT, CVU, nombre y tipo de persona.

**Servicio de pago**: Este endpoint es una función de pago. Su uso puede generar cargos. Consulte a su contador o al equipo de facturación de HG.Cash para conocer los precios.




## OpenAPI

````yaml /api-reference/openapi.es.yaml post /alias-lookup
openapi: 3.1.0
info:
  title: HG.Cash API
  description: >
    # 🚀 API de transacciones HG.Cash


    API REST moderna para que los usuarios creen transacciones de salida desde
    sus cuentas.


    ## 🧾 Cómo funciona


    - HG.Cash asigna cuentas a su usuario

    - Cuando estas cuentas tienen movimientos (entrada o salida), HG.Cash
    notificará su backend usando la URL de webhook que configure en el panel de
    HG.Cash

    - **Firma de webhooks (HMAC)**: En la configuración de la cuenta puede
    generar un secreto de firma. Cuando está configurado, cada POST de webhook
    incluye el encabezado `X-HG-Webhook-Signature: sha256=<hex>` donde el valor
    es HMAC-SHA256 del cuerpo JSON sin procesar usando su secreto. Verifíquelo
    en su endpoint para asegurar que la solicitud es auténtica.

    - Para crear retiros (dinero que sale de sus cuentas), debe llamar al
    endpoint **Cash Out**: **Crear solicitud de transacción** (`POST
    /transactions`)


    ## 📊 Primeros pasos


    1. **Genere su token de API** en la página de configuración de la cuenta

    2. **Pruebe los endpoints** usando la documentación interactiva a
    continuación

    3. **Implemente** en sus servicios de backend (nunca exponga tokens en el
    frontend)

    4. **Supervise** su integración y maneje los errores adecuadamente


    ## 🔐 Autenticación


    Esta API usa autenticación **Bearer Token**. Incluya el token de API del
    usuario en el encabezado Authorization, por ejemplo `Authorization: Bearer
    cash_your_token_here`.


    ## ⚠️ Notas importantes de seguridad


    - Nunca comparta ni exponga su token de autenticación de API de usuario

    - Almacene los tokens de forma segura solo en sus servidores de backend

    - Todas las llamadas a la API deben realizarse desde servicios de backend
    seguros

    - Contacte a los administradores inmediatamente si su token se ve
    comprometido
  version: 1.0.0
  contact:
    name: HG.Cash API Support
    email: api-support@hg.cash
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://hg.cash/api/v1
    description: Servidor de producción
  - url: http://dev.hg.cash/api/v1
    description: Servidor de desarrollo
security:
  - bearerAuth: []
tags:
  - name: Transacciones
    description: >-
      Gestión de transacciones - Crear y administrar transacciones en el sistema
      HG.Cash. Todos los endpoints de transacciones requieren autenticación.
  - name: Cuentas
    description: >-
      Cuentas - Obtener información de cuentas y saldos del usuario autenticado.
      Todos los endpoints de cuentas requieren autenticación.
  - name: Datos de referencia
    description: >-
      Datos de referencia - Obtener datos de referencia como estados y tipos de
      transacción. Estos endpoints requieren autenticación.
  - name: Webhooks
    description: Webhooks - Notificaciones de eventos enviadas a su endpoint HTTP.
  - name: Brasil
    description: Brasil — Crear y consultar transacciones PIX (BRL).
  - name: Chile
    description: Chile — Checkout hospedado y payouts bancarios (CLP).
  - name: Bolivia
    description: Bolivia — Cash-in con QR y payouts ACH (BOB).
  - name: Checkouts
    description: Sesiones de checkout hospedado para AR, BR, CL y BO
paths:
  /alias-lookup:
    post:
      tags:
        - Datos de referencia
      summary: Consultar CVU o alias
      description: >
        Consulta información del beneficiario por CVU (22 dígitos) o alias.

        Devuelve alias, CUIT, CVU, nombre y tipo de persona.


        **Servicio de pago**: Este endpoint es una función de pago. Su uso puede
        generar cargos. Consulte a su contador o al equipo de facturación de
        HG.Cash para conocer los precios.
      operationId: aliasLookup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AliasLookupRequest'
            examples:
              by_alias:
                summary: Consulta por alias
                value:
                  alias: miempresa.cbu
              by_cvu:
                summary: Consulta por CVU
                value:
                  alias: '0000003100012345678901'
      responses:
        '200':
          description: Información del beneficiario encontrada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AliasLookupResponse'
        '400':
          description: Solicitud incorrecta - Entrada inválida o no encontrada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                not_found:
                  summary: no encontrado
                  value:
                    error: Not found
                    message: No information found for this CVU or alias
        '401':
          description: No autorizado - Token inválido o ausente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Prohibido - El usuario no tiene acceso al servicio de consulta de
            alias
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                service_not_enabled:
                  summary: Servicio no habilitado
                  value:
                    error: Access denied
                    code: ALIAS_LOOKUP_NOT_ENABLED
                    message: >-
                      This user does not have access to the alias lookup
                      service. Contact your administrator.
        '500':
          description: Error interno del servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    AliasLookupRequest:
      type: object
      required:
        - alias
      properties:
        alias:
          type: string
          description: CVU (22 dígitos) o alias a consultar
          example: miempresa.cbu
    AliasLookupResponse:
      type: object
      properties:
        alias:
          type: string
          nullable: true
          description: Alias de la cuenta
        cuit:
          type: string
          nullable: true
          description: CUIT/CUIL del titular de la cuenta
        cvu:
          type: string
          description: CVU (22 dígitos)
        nombre:
          type: string
          nullable: true
          description: Nombre del titular de la cuenta
        tipoPersona:
          type: string
          nullable: true
          description: Tipo de persona
    ErrorResponse:
      type: object
      description: Carga de error devuelta por la API.
      additionalProperties: true
      required:
        - error
      properties:
        error:
          type: string
          example: Invalid request
        code:
          type: string
          description: Código de error legible por máquina (cuando esté disponible)
          example: INSUFFICIENT_NET_BALANCE
        message:
          type: string
          example: The provided data is invalid
        details:
          type: object
          description: Detalles adicionales del error
          example:
            field: amount
            code: INVALID_VALUE
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Token de autenticación de API de usuario con formato
        `cash_<64-char-hex>`. Valor de ejemplo
        `cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2`.

````