Skip to main content
POST
/
enrollment
/
v1
/
url
enrollment
curl --request POST \
  --url https://nufi.azure-api.net/kyb/enrollment/v1/url \
  --header 'Content-Type: application/json' \
  --header 'NUFI-API-KEY: <nufi-api-key>' \
  --header 'X-Workspace: <x-workspace>' \
  --data '
{
  "DocumentId": "eaeea393-81db-4269-9dcc-ede8669f2ecf",
  "PersonId": "7c1cf3c0-9c2c-4c66-9b34-6b5f4c6c9a1e",
  "AgentMail": "ejecutivo@correo.com"
}
'
{
  "Code": 200,
  "Status": "Success",
  "Message": "Enrolamiento generado",
  "Data": {
    "Id": "2b0db6c2-9e1d-4a4b-8a4b-5a7b7d9b6c3f",
    "EnrollmentUrl": "https://oam.institucional.com:5442/AbeWeb#/firstStepOrq?data=sample"
  }
}
Generar un enlace de enrolamiento para que el ejecutivo pueda detonarlo.

​
Objetivo

Este endpoint permite crear una URL de enrolamiento por persona dentro de un expediente existente, para iniciar el proceso desde el canal de atención (por ejemplo, Microsoft Teams).

​
¿Cuándo usarlo?

Úsalo cuando:
  • Ya cuentas con un DocumentId válido del expediente.
  • Ya identificaste a la persona (PersonId) que debe completar su enrolamiento.
  • En la petición de tracking, el campo IsEnrollmentAllowed es true.

​
Datos requeridos

La petición requiere:
  • DocumentId: identificador del expediente.
  • PersonId: identificador de la persona a enrolar.
  • AgentMail: correo del ejecutivo que dispara la acción.
Ejemplo de payload: 
{
  "DocumentId": "eaeea393-81db-4269-9dcc-ede8669f2ecf",
  "PersonId": "7c1cf3c0-9c2c-4c66-9b34-6b5f4c6c9a1e",
  "AgentMail": "ejecutivo@correo.com"
}

​
Respuesta esperada (200)

Cuando la operación es exitosa, se devuelve un objeto con:
  • Code: código de resultado interno.
  • Status: estado general de la operación.
  • Message: mensaje descriptivo.
  • Data.Id: identificador del registro generado.
  • Data.EnrollmentUrl: URL de enrolamiento lista para compartirse con el ejecutivo.
Ejemplo: 
{
  "Code": 200,
  "Status": "Success",
  "Message": "Enrolamiento generado",
  "Data": {
    "Id": "2b0db6c2-9e1d-4a4b-8a4b-5a7b7d9b6c3f",
    "EnrollmentUrl": "https://oam.institucional.com:5442/AbeWeb#/firstStepOrq?data=..."
  }
}

​
Posibles respuestas de error

CódigoEscenarioDescripción
400ValidaciónFaltan campos requeridos o formato inválido (DocumentId, PersonId, AgentMail).
401AutenticaciónAPI Key inválida o sin suscripción activa.
403AutorizaciónWorkspace inválido o inactivo.
404Regla de negocioEnrolamiento no permitido para la persona/expediente.

​
Recomendación operativa

Después de generar EnrollmentUrl, compártela de inmediato al ejecutivo y registra el seguimiento con el endpoint de tracking para monitorear el avance del enrolamiento.

Headers

​
NUFI-API-KEY
string
required
​
X-Workspace
string
required

Body

application/json
​
DocumentId
string
required
​
PersonId
string
required
​
AgentMail
string
required

Response

OK

​
Code
integer
Example:

200

​
Status
string
Example:

"Success"

​
Message
string
Example:

"Enrolamiento generado"

​
Data
object