> ## 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 ou alias > Consulta informações do beneficiário por CVU (22 dígitos) ou alias. Retorna alias, CUIT, CVU, nome e tipo de pessoa. **Serviço pago**: Este endpoint é um recurso pago. O uso pode gerar cobranças. Consulte seu contador ou a equipe de faturamento da HG.Cash para detalhes de preços. ## 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=` 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: Transações description: >- Gestão de transações — Criar e gerenciar transações no sistema HG.Cash. Todos os endpoints de transação exigem autenticação. - name: Contas description: >- Contas — Obter informações de conta e saldos do usuário autenticado. Todos os endpoints de conta exigem autenticação. - name: Dados de referência description: >- Dados de referência — Obter dados de referência como status e tipos de transação. Esses endpoints exigem autenticação. - name: Webhooks description: Webhooks — Notificações de eventos enviadas ao seu endpoint HTTP. - name: Brasil description: Brasil — Criar e consultar transações PIX (BRL). - name: Chile description: Chile — Checkout hospedado e payouts bancários (CLP). - name: Bolívia 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: - Dados de referência summary: Consultar CVU ou alias description: > Consulta informações do beneficiário por CVU (22 dígitos) ou alias. Retorna alias, CUIT, CVU, nome e tipo de pessoa. **Serviço pago**: Este endpoint é um recurso pago. O uso pode gerar cobranças. Consulte seu contador ou a equipe de faturamento da HG.Cash para detalhes de preços. 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: Informações do beneficiário encontradas content: application/json: schema: $ref: '#/components/schemas/AliasLookupResponse' '400': description: Requisição inválida — entrada inválida ou não encontrada content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: not_found: summary: Não encontrado value: error: Not found message: No information found for this CVU or alias '401': description: Não autorizado — token inválido ou ausente content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Proibido — o usuário não tem acesso ao serviço de consulta de alias content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: service_not_enabled: summary: Serviço não 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: Erro interno do 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) ou alias a consultar example: miempresa.cbu AliasLookupResponse: type: object properties: alias: type: string nullable: true description: Alias da conta cuit: type: string nullable: true description: CUIT/CUIL do titular da conta cvu: type: string description: CVU (22 dígitos) nombre: type: string nullable: true description: Nome do titular da conta tipoPersona: type: string nullable: true description: Tipo de pessoa ErrorResponse: type: object description: Payload de erro retornado pela API. additionalProperties: true required: - error properties: error: type: string example: Invalid request code: type: string description: Código de erro legível por máquina (quando disponível) example: INSUFFICIENT_NET_BALANCE message: type: string example: The provided data is invalid details: type: object description: Detalhes adicionais do erro example: field: amount code: INVALID_VALUE securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Token de autenticação da API do usuário com o formato `cash_<64-char-hex>`. Valor de exemplo `cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2`. ````