Skip to main content
POST
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 (por SMS, correo o por el canal del propio cliente), y el solicitante completa el flujo desde su teléfono: consentimiento, validación biométrica, fotos con sello de ubicación y formulario.

Datos requeridos

  • ProductKey o ProductId: uno de los dos. Si mandas ambos, gana ProductId.
  • Modality: Domiciliar o Laboral (no es sensible a mayúsculas).
  • FullName: nombre del solicitante que recibirá la liga.
  • Phone o Email: 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: true por omisión (nosotros mandamos SMS/correo). false = solo se crea y se te devuelve la liga.

Ejemplo de request

Respuesta 200

La liga se entrega una sola vez. El token se guarda cifrado y no es reversible: ApplicantUrl solo viaja en esta respuesta. Guárdala de tu lado. Si se pierde, usa reenviar: genera una liga nueva e invalida la anterior.

Errores de validación (400)

Data trae todos los errores encontrados, no solo el primero. Mensajes posibles:
  • Se requiere ProductKey o ProductId
  • El campo Modality es obligatorio
  • El campo Modality debe ser Domiciliar o Laboral
  • El campo FullName es obligatorio
  • El campo FullName no debe exceder 200 caracteres
  • Se requiere Phone o Email para entregarle la liga al solicitante
  • El campo Phone no debe exceder 20 caracteres
  • El campo Email no debe exceder 200 caracteres
  • El campo Email no es válido
  • El campo ExternalReference no debe exceder 100 caracteres

Notas de integración

  • Cobro de mensajes. Cada SMS y cada correo se factura. Con SendLink: false no 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 ExternalReference para detectar duplicados.
  • Vigencia. La liga vence según el producto (7 días por omisión).

Headers

NUFI-API-KEY
string
required

Llave de la API. También se acepta como x-functions-key o ?code= en la URL.

X-Workspace
string
required

Identificador del cliente (GUID). Determina el catálogo de productos disponible.

Body

application/json
Modality
enum<string>
required

Domiciliar o Laboral. No es sensible a mayúsculas.

Available options:
Domiciliar,
Laboral
FullName
string
required

Nombre del solicitante que recibirá la liga.

Maximum string length: 200
ProductKey
string

Clave del producto contratado (p. ej. AUTOPLAZO). Obligatorio si no se envía ProductId.

Maximum string length: 40
ProductId
string<uuid>

Alternativa a ProductKey. Si se envían ambos, gana ProductId.

Phone
string

10 dígitos. Se antepone 52 automáticamente si no lo trae. Obligatorio si no se envía Email.

Maximum string length: 20
Email
string<email>

Destino del correo con la liga. Obligatorio si no se envía Phone.

Maximum string length: 200
Street
string

Calle del domicilio declarado.

ExteriorNumber
string

Número exterior del domicilio declarado.

Neighborhood
string

Colonia del domicilio declarado.

Municipality
string

Municipio del domicilio declarado.

City
string

Ciudad del domicilio declarado.

State
string

Estado del domicilio declarado.

PostalCode
string

Código postal del domicilio declarado.

ExternalReference
string

Folio o id externo. Se devuelve en consultas y es buscable por analistas.

Maximum string length: 100

true = se envía SMS y/o correo. false = solo se crea y se devuelve la liga.

Response

Verificación creada

Code
integer
Example:

200

Status
string
Example:

"Success"

Message
string
Example:

"Verificación creada"

Data
object