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

# Obter detalhes do alias

Verifique se um alias de pagamento está ativo e confira os detalhes do proprietário mascarado antes de enviar um pagamento. Disponível atualmente apenas para a Colômbia.

Consulte a seção [Verificar um Alias de Pagamento](https://docs.localpayment.com/pt-br/docs/verify-a-payout-alias.md) para obter a referência completa dos campos de resposta, regras de mascaramento, orientações sobre tratamento de erros e uma demonstração interativa.


## OpenAPI

````yaml openapi/pt-br/localpayment.json POST /api/payment/alias-detail
openapi: 3.1.0
info:
  version: '1.0'
  title: Localpayment
  contact:
    name: Support
    url: mailto:support@localpayment.com
servers:
  - url: https://api.stage.localpayment.com
    description: Stage
security:
  - token: []
paths:
  /api/payment/alias-detail:
    post:
      summary: Obter detalhes do alias
      operationId: get-alias-detail
      parameters:
        - name: Authorization
          in: header
          description: >-
            Token de acesso Bearer para autenticação. Este token é obtido nos
            endpoints [Obter token de acesso](/pt-br/reference/get-token) ou
            [Renovar token de acesso](/pt-br/reference/refresh-token).
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                countryISOCode:
                  type: string
                  description: >-
                    País do alias, no formato ISO 3166-1 alpha-2 (não alpha-3,
                    ao contrário da maioria dos outros endpoints da
                    Localpayment). Atualmente, somente `CO` (Colômbia) é
                    suportado.
                  enum:
                    - CO
                aliasClassification:
                  type: string
                  description: >-
                    Classificação do alias. Atualmente, somente `Breb` (sistema
                    de pagamento instantâneo Bre-B da Colômbia) é suportado.
                  enum:
                    - Breb
                aliasValue:
                  type: string
                  description: >-
                    O alias para verificação (número de telefone, documento,
                    e-mail, código do comerciante ou chave alfanumérica).
              required:
                - countryISOCode
                - aliasClassification
                - aliasValue
              x-examples:
                Example 1:
                  countryISOCode: CO
                  aliasClassification: Breb
                  aliasValue: '3668933567'
            examples:
              Example 1:
                value:
                  countryISOCode: CO
                  aliasClassification: Breb
                  aliasValue: '3668933567'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  firstName:
                    type: string
                    description: Nome registrado do proprietário do alias.
                  lastName:
                    type: string
                    description: >-
                      Sobrenome registrado do proprietário do alias. Mascarado:
                      as duas primeiras letras são exibidas e o restante é
                      substituído por asteriscos (`Doe` torna-se `Do**`).
                  status:
                    type: string
                    description: Status atual do alias.
                    examples:
                      - ACTIVE
                  idType:
                    type: string
                    description: >-
                      Tipo de documento de identidade do titular. Consulte
                      [Tipos de Documentos
                      Suportados](/pt-br/docs/colombia#supported-document-types).
                  idValue:
                    type: string
                    description: >-
                      Número do documento de identidade do proprietário.
                      Mascarado: apenas os últimos 4 dígitos são exibidos e o
                      restante é substituído por asteriscos (`20304050` vira
                      `****4050`).
                  aliasType:
                    type: string
                    description: >-
                      Classificação do alias que foi resolvido (documento de
                      identidade, código de comerciante, número de celular,
                      endereço de e-mail ou chave alfanumérica). Os valores
                      ativos confirmados estão em maiúsculas, por exemplo
                      `PHONE`; a string exata de cada uma das outras categorias
                      ainda não foi confirmada.
                  aliasValue:
                    type: string
                    description: O alias que você consultou, retornado por completo.
                  bankName:
                    type: string
                    description: Nome do banco onde o alias está registrado.
                x-examples:
                  Example 1:
                    aliasType: PHONE
                    aliasValue: '3668933567'
                    bankName: KAMIN S.A
                    firstName: John
                    idType: CC
                    idValue: '******0695'
                    lastName: Do**
                    status: ACTIVE
              examples:
                200 - Phone alias resolved.:
                  value:
                    aliasType: PHONE
                    aliasValue: '3668933567'
                    bankName: KAMIN S.A
                    firstName: John
                    idType: CC
                    idValue: '******0695'
                    lastName: Do**
                    status: ACTIVE
        '400':
          description: >-
            Solicitação inválida. O alias não corresponde a um proprietário
            registrado ou está inativo.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Mensagem de erro legível para humanos.
                  errorCode:
                    type: string
                    description: Código de erro em nível de aplicação.
              examples:
                400 - Alias not found or inactive.:
                  value:
                    error: 'DICE error: Keys not found or inactive'
                    errorCode: '408'
        '401':
          description: >-
            Não autorizado. O token de acesso está ausente, é inválido ou
            expirou.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Informações adicionais sobre a resposta.
                  code:
                    type: string
                    description: Código de status.
                  messages:
                    type: array
                    description: Lista de mensagens.
                    items:
                      type: object
                      properties:
                        token_class:
                          type: string
                          description: Classe Token.
                        token_type:
                          type: string
                          description: Tipo de token.
                        message:
                          type: string
                          description: Mensagem com informações adicionais.
                x-examples:
                  Example 1:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
              examples:
                401 - Token is invalid or expired:
                  value:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                      - token_class: AccessToken
                        token_type: access
                        message: Token is invalid or expired
        '422':
          description: >-
            Entidade não processável. A combinação de país ou classificação não
            é suportada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Mensagem de erro legível para humanos.
              examples:
                422 - Service not available.:
                  value:
                    error: Service not available for Breb in COL
      security:
        - token: []
      servers:
        - url: https://api.stage.localpayment.com
          description: Stage
components:
  securitySchemes:
    token:
      type: http
      scheme: bearer

````

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