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

# Look up CVU or Alias

> Look up beneficiary information by CVU (22 digits) or alias.
Returns alias, CUIT, CVU, name, and person type.

**Paid service**: This endpoint is a paid feature. Usage may incur charges. Consult your accountant or HG.Cash billing team for pricing details.




## OpenAPI

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


    API REST moderna para usuários criarem transações de saída a partir de suas
    contas.


    ## 🧾 Como funciona


    - A HG.Cash atribui contas ao seu usuário

    - Quando essas contas têm movimentação (entrada ou saída), a HG.Cash
    notifica o seu backend usando a URL de webhook configurada no painel

    - **Assinatura de webhooks (HMAC)**: Nas configurações da conta é possível
    gerar um segredo de assinatura. Quando configurado, cada POST de webhook
    inclui o cabeçalho `X-HG-Webhook-Signature: sha256=<hex>` com HMAC-SHA256 do
    corpo JSON usando o seu segredo. Verifique no seu endpoint para garantir
    autenticidade.

    - Para criar saques é necessário chamar o endpoint **Cash Out**: **Criar
    solicitação de transação** (`POST /transactions`)


    ## 📊 Primeiros passos


    1. **Gere seu token de API** na página de configurações da conta

    2. **Teste os endpoints** com a documentação interativa

    3. **Implemente** nos seus serviços de backend (nunca exponha tokens no
    frontend)

    4. **Monitore** a integração e trate erros adequadamente


    ## 🔐 Autenticação


    Esta API usa autenticação **Bearer Token**. Inclua o token de API do usuário
    no cabeçalho Authorization, por exemplo `Authorization: Bearer
    cash_your_token_here`.


    ## ⚠️ Segurança


    - Não compartilhe nem exponha o token de autenticação da API

    - Armazene tokens apenas em servidores backend seguros

    - Todas as chamadas devem ser feitas a partir de backends seguros

    - Se o token for comprometido, entre em contato com os administradores
    imediatamente
  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 produção
  - url: http://dev.hg.cash/api/v1
    description: Servidor de desenvolvimento
security:
  - bearerAuth: []
tags:
  - name: Transactions
    description: >-
      Transaction Management - Create and manage transactions in the HG.Cash
      system. All transaction endpoints require authentication.
  - name: Accounts
    description: >-
      Accounts - Retrieve account information and balances for the authenticated
      user. All account endpoints require authentication.
  - name: Reference Data
    description: >-
      Reference Data - Get reference data like transaction statuses and types.
      These endpoints require authentication.
  - name: Webhooks
    description: Webhooks - Event notifications sent to your HTTP endpoint.
  - name: Brazil
    description: Brasil — Criar e consultar transações PIX (BRL).
  - name: Chile
    description: Chile — Checkout hospedado e payouts bancários (CLP).
  - name: Bolivia
    description: Bolívia — Cash-in com QR e payouts ACH (BOB).
  - name: Checkouts
    description: Sessões de checkout hospedado para AR, BR, CL e BO
paths:
  /alias-lookup:
    post:
      tags:
        - Reference Data
      summary: Look up CVU or Alias
      description: >
        Look up beneficiary information by CVU (22 digits) or alias.

        Returns alias, CUIT, CVU, name, and person type.


        **Paid service**: This endpoint is a paid feature. Usage may incur
        charges. Consult your accountant or HG.Cash billing team for pricing
        details.
      operationId: aliasLookup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AliasLookupRequest'
            examples:
              by_alias:
                summary: Lookup by alias
                value:
                  alias: miempresa.cbu
              by_cvu:
                summary: Lookup by CVU
                value:
                  alias: '0000003100012345678901'
      responses:
        '200':
          description: Beneficiary information found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AliasLookupResponse'
        '400':
          description: Bad Request - Invalid input or not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                not_found:
                  summary: not found
                  value:
                    error: Not found
                    message: No information found for this CVU or alias
        '401':
          description: Unauthorized - Invalid or missing token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden - User does not have access to the alias lookup service
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                service_not_enabled:
                  summary: Service not enabled
                  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: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    AliasLookupRequest:
      type: object
      required:
        - alias
      properties:
        alias:
          type: string
          description: CVU (22 digits) or alias to look up
          example: miempresa.cbu
    AliasLookupResponse:
      type: object
      properties:
        alias:
          type: string
          nullable: true
          description: Alias of the account
        cuit:
          type: string
          nullable: true
          description: CUIT/CUIL of the account holder
        cvu:
          type: string
          description: CVU (22 digits)
        nombre:
          type: string
          nullable: true
          description: Name of the account holder
        tipoPersona:
          type: string
          nullable: true
          description: Person type
    ErrorResponse:
      type: object
      description: Error payload returned by the API.
      additionalProperties: true
      required:
        - error
      properties:
        error:
          type: string
          example: Invalid request
        code:
          type: string
          description: Machine-readable error code (when available)
          example: INSUFFICIENT_NET_BALANCE
        message:
          type: string
          example: The provided data is invalid
        details:
          type: object
          description: Additional error details
          example:
            field: amount
            code: INVALID_VALUE
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        User API authentication token with format `cash_<64-char-hex>`. Sample
        value
        `cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2`.

````