Crear verificación
Alta de una verificación domiciliaria o laboral. El cliente crea la solicitud, la plataforma entrega al solicitante una liga de un solo uso (SMS, correo o canal propio), y el solicitante completa el flujo desde su teléfono.
Datos requeridos
ProductKeyoProductId: uno de los dos. Si mandas ambos, ganaProductId.Modality:DomiciliaroLaboral(no es sensible a mayúsculas).FullName: nombre del solicitante que recibirá la liga.PhoneoEmail: al menos uno para entregarle la liga.
Datos opcionales
- Domicilio declarado (
Street,ExteriorNumber,Neighborhood,Municipality,City,State,PostalCode): contra el que se compara la ubicación real. Sin domicilio no hay comparación geográfica. ExternalReference: tu folio o id. Se devuelve en todas las consultas.SendLink:truepor omisión (nosotros mandamos SMS/correo).false= solo se crea y se te devuelve la liga.
Ejemplo de request
Respuesta 200
Errores de validación (400)
Data trae todos los errores encontrados, no solo el primero. Mensajes posibles:
Se requiere ProductKey o ProductIdEl campo Modality es obligatorioEl campo Modality debe ser Domiciliar o LaboralEl campo FullName es obligatorioEl campo FullName no debe exceder 200 caracteresSe requiere Phone o Email para entregarle la liga al solicitanteEl campo Phone no debe exceder 20 caracteresEl campo Email no debe exceder 200 caracteresEl campo Email no es válidoEl campo ExternalReference no debe exceder 100 caracteres
Notas de integración
- Cobro de mensajes. Cada SMS y cada correo se factura. Con
SendLink: falseno hay cargo de mensajería. - Reenvíos automáticos. Si el producto lo tiene configurado, la plataforma reenvía sola (por omisión a las 24, 48 y 72 h).
- Idempotencia. El alta no es idempotente: dos POST idénticos crean dos verificaciones. Usa
ExternalReferencepara detectar duplicados. - Vigencia. La liga vence según el producto (7 días por omisión).
Headers
Llave de la API. También se acepta como x-functions-key o ?code= en la URL.
Identificador del cliente (GUID). Determina el catálogo de productos disponible.
Body
Domiciliar o Laboral. No es sensible a mayúsculas.
Domiciliar, Laboral Nombre del solicitante que recibirá la liga.
200Clave del producto contratado (p. ej. AUTOPLAZO). Obligatorio si no se envía ProductId.
40Alternativa a ProductKey. Si se envían ambos, gana ProductId.
10 dígitos. Se antepone 52 automáticamente si no lo trae. Obligatorio si no se envía Email.
20Destino del correo con la liga. Obligatorio si no se envía Phone.
200Calle del domicilio declarado.
Número exterior del domicilio declarado.
Colonia del domicilio declarado.
Municipio del domicilio declarado.
Ciudad del domicilio declarado.
Estado del domicilio declarado.
Código postal del domicilio declarado.
Folio o id externo. Se devuelve en consultas y es buscable por analistas.
100true = se envía SMS y/o correo. false = solo se crea y se devuelve la liga.
.png?fit=max&auto=format&n=SrFWYqQUIKuRmdvu&q=85&s=29a9d6074794b17ba1b2d2cd5d208849)