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

# Obtener detalles del alias

Comprueba si hay un alias de pago activo y consulta los datos del propietario enmascarado antes de enviar un pago. Actualmente disponible solo para Colombia.

Consulta la sección [Verificar un alias de pago](https://docs.localpayment.com/es/docs/verify-a-payout-alias.md) para obtener la referencia completa de los campos de respuesta, las reglas de enmascaramiento, la guía para el manejo de errores y una demostración interactiva.


## OpenAPI

````yaml openapi/es/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: Obtener detalles del alias
      operationId: get-alias-detail
      parameters:
        - name: Authorization
          in: header
          description: >-
            Token de acceso Bearer para la autenticación. Este token se obtiene
            de los endpoints [Get Access Token](/es/reference/get-token) o
            [Refresh Access Token](/es/reference/refresh-token).
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                countryISOCode:
                  type: string
                  description: >-
                    País del alias, en formato ISO 3166-1 alfa-2 (no alfa-3, a
                    diferencia de la mayoría de los demás endpoints de
                    Localpayment). Actualmente solo se admite `CO` (Colombia).
                  enum:
                    - CO
                aliasClassification:
                  type: string
                  description: >-
                    Clasificación del alias. Actualmente solo se admite `Breb`
                    (el sistema de pago instantáneo Bre-B de Colombia).
                  enum:
                    - Breb
                aliasValue:
                  type: string
                  description: >-
                    El alias a verificar (número de teléfono, documento, correo
                    electrónico, código de comerciante o clave 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: Nombre de pila registrado del propietario del alias.
                  lastName:
                    type: string
                    description: >-
                      Apellido registrado del propietario del alias.
                      Enmascarado: se muestran las dos primeras letras y el
                      resto se reemplaza con asteriscos (`Doe` se convierte en
                      `Do**`).
                  status:
                    type: string
                    description: Estado actual del alias.
                    examples:
                      - ACTIVE
                  idType:
                    type: string
                    description: >-
                      Tipo de documento de identidad del propietario. Consulta
                      [Tipos de documentos
                      admitidos](/es/docs/colombia#supported-document-types).
                  idValue:
                    type: string
                    description: >-
                      El número del documento de identidad del propietario.
                      Enmascarado: solo se muestran los últimos 4 dígitos, el
                      resto se reemplaza con asteriscos (`20304050` se convierte
                      en `****4050`).
                  aliasType:
                    type: string
                    description: >-
                      Clasificación del alias que se resolvió (documento de
                      identidad, código de comerciante, número de teléfono
                      móvil, dirección de correo electrónico o clave
                      alfanumérica). Los valores confirmados en vivo están en
                      mayúsculas, por ejemplo `PHONE`; la cadena exacta para
                      cada una de las demás categorías aún no está confirmada.
                  aliasValue:
                    type: string
                    description: El alias que consultó, devuelto completo.
                  bankName:
                    type: string
                    description: Nombre del banco donde está registrado el alias.
                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: >-
            Solicitud incorrecta. El alias no corresponde a un propietario
            registrado o está inactivo.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Mensaje de error legible.
                  errorCode:
                    type: string
                    description: Código de error a nivel de aplicación.
              examples:
                400 - Alias not found or inactive.:
                  value:
                    error: 'DICE error: Keys not found or inactive'
                    errorCode: '408'
        '401':
          description: >-
            Acceso no autorizado. El token de acceso no existe, no es válido o
            ha caducado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Información adicional sobre la respuesta.
                  code:
                    type: string
                    description: Código de estado.
                  messages:
                    type: array
                    description: Lista de mensajes.
                    items:
                      type: object
                      properties:
                        token_class:
                          type: string
                          description: Clase de token.
                        token_type:
                          type: string
                          description: Tipo de token.
                        message:
                          type: string
                          description: Mensaje con información adicional.
                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: >-
            Entidad no procesable. La combinación de país o clasificación no es
            compatible.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Mensaje de error legible.
              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.