Lead

Lead #

Crear lead #

Crea nuevos prospectos que representan una búsqueda potencial de obtención de crédito, su integración al core dará visualización en el entorno de asignación de crédito de las entidades financieras. El método devuelve la información enviada con el registro.

Ejemplo

POST /create-lead

{
  "address": "string",
  "business_name": "string",
  "created_at": "string",
  "email": "string",
  "image": "string",
  "lead_status": "string",
  "name": "string",
  "nit": "string",
  "phone": "string"
}

Resultado

{
  "address": "string",
  "business_name": "string",
  "created_at": "string",
  "email": "string",
  "id": "string",
  "image": "string",
  "lead_status": "string",
  "loan_priority": 0,
  "name": "string",
  "nit": "string",
  "phone": "string",
  "records": [{}]
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Consultar lead #

Consulta información de un lead específico, devuelve un objeto con el perfil de datos asociados a su registro y su estado en el ecosistema. Realice una solicitud enviando uno de los siguientes campos requeridos, id, nit o número telefónico registrado del lead.

Para obtener detalles del lead se debe contar con el registro de éste de manera previa en nuestra base de datos. Consulte la guía relacionada Crear lead.

Ejemplo

GET /lead

https://www.api.sandbox-middleware.leancore.co/lead?id=f9bb9fd7-a45f-445c-966d-1bb5d2e3dbad
o
https://www.api.sandbox-middleware.leancore.co/lead?nit=10000000
o también
https://www.api.sandbox-middleware.leancore.co/lead?phone=3010000000

Resultado

{
  "address": "string",
  "business_name": "string",
  "email": "string",
  "id": "string",
  "image": "string",
  "lead_status": "string",
  "name": "string",
  "nit": "string",
  "payment_data": {},
  "phone": "string",
  "records": [{}],
  "score": 0
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Actualizar lead #

Actualiza un lead específico en el ecosistema definiendo los parámetros a modificar en campos de datos básicos, status del lead y campos relacionados al estado de asignación de crédito. Envíe una solicitud con uno de los campos requeridos id o nit del lead para obtener información.

Ejemplo

POST /update-lead

{
  "address": "string",
  "business_name": "string",
  "created_at": "string",
  "email": "string",
  "id": "string",
  "lead_status": "string",
  "loan_priority": 0,
  "name": "string",
  "nit": "string",
  "phone": "string",
  "records": [{}]
}

Resultado

{
  "address": "string",
  "business_name": "string",
  "created_at": "string",
  "email": "string",
  "id": "string",
  "image": "string",
  "lead_status": "string",
  "loan_priority": 0,
  "name": "string",
  "nit": "string",
  "phone": "string",
  "records": [{}]
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Solicitar préstamo #

Crea una solicitud de crédito de un lead existente en el ecosistema para su validación en el entorno de asignación de crédito de las entidades financieras. Realice una solicitud enviando el id del lead solicitante.

Ejemplo

POST /request-loan

{
  "address": "string",
  "business_name": "string",
  "email": "string",
  "id": "string",
  "name": "string",
  "nit": "string",
  "phone": "string"
}

Resultado

{
  "address": "string",
  "business_name": "string",
  "created_at": "string",
  "email": "string",
  "id": "string",
  "image": "string",
  "lead_status": "string",
  "loan_priority": 0,
  "name": "string",
  "nit": "string",
  "phone": "string",
  "records": [{}]
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>

Convertir lead en cliente #

Convierte un lead existente en cliente. Este método permite la asignación del lead a su entorno de colocación de crédito. Realice una solicitud enviando el id del lead a convertir como campo requerido, devuelve el objeto lead con su información asociada.

Ejemplo

POST /turn-lead-into-client

{
  "financial_entity_id": "string",
  "lead_id": "string"
}

Resultado

{
  "address": "string",
  "business_name": "string",
  "email": "string",
  "id": "string",
  "image": "string",
  "lead_status": "string",
  "name": "string",
  "nit": "string",
  "payment_data": {},
  "phone": "string",
  "records": [{}],
  "score": 0
}

Uso en la cabecera de petición Authorization

Authorization: Bearer <access>