Skip to main content
POST
Verifica una llave Bre-B (celular, correo, alias, o cédula) contra el directorio oficial del Banco de la República y retorna el titular registrado. Scope requerido: WRITE (expone identidad del titular — no apto para llaves READ)

Body

string
required
La llave a verificar. Aceptamos los 4 formatos Bre-B:
  • Celular: 10 dígitos comenzando con 3 (ej. 3115551234)
  • Correo: formato email válido (ej. pagos@empresa.com)
  • Alias: 3-40 chars alfanuméricos, opcional @ prefix (ej. @empresaxyz)
  • Documento: cédula CC o NIT, 5-15 dígitos (ej. 900123456)
Length: 3-64 chars.
string
default:"AUTO"
Opcional. Si lo omitís (recomendado), Mouv usa AUTO y la red Bre-B detecta el tipo automáticamente. Valores válidos: PHONE, EMAIL, ALPHANUM, NRIC, AUTO.

Response 200 (llave encontrada y activa)

boolean
true
string
Identificador interno Bre-B (úsalo si quisieras llamar el send directamente con targetAnchorHandle)
string
Tipo real detectado por Bre-B: PHONE, EMAIL, ALPHANUM, o NRIC
string
El valor de la llave (normalizado por Bre-B si aplica)
object
Información del titular (proviene del directorio Bre-B)

Response 422 (llave no encontrada o inactiva)

Ejemplos

Notas

  • No comprometés fondos: este endpoint es consulta pura, no genera transacciones
  • Auto-detect: el keyType retornado proviene de Bre-B oficial — siempre confiable
  • SARLAFT: el recipient.idValue es el documento del titular registrado. Persistilo como targetDocument al enviar
  • Cache: NO cacheés este response — la llave puede desactivarse en cualquier momento