Skip to main content
POST
/
expedientes
/
nuevo
crear expediente
curl --request POST \
  --url https://nufi.azure-api.net/kyb/expedientes/nuevo \
  --header 'Content-Type: application/json' \
  --header 'NUFI-API-KEY: <nufi-api-key>' \
  --header 'X-Workspace: <x-workspace>' \
  --data '
{
  "FlowID": "f-001",
  "ClientId": "0001",
  "ClientName": "Grupo Patito",
  "SendEmail": true,
  "ContactEmail": "contacto@patito.com",
  "SendSms": false,
  "ContactPhone": "5512345678",
  "Company": {
    "CompanyName": "Patito S.A. de C.V.",
    "CompanyRFC": "XXX000000XX0"
  },
  "Data": {}
}
'
{
  "Code": 200,
  "Status": "success",
  "Message": "Documento creado exitosamente",
  "Data": {
    "DocumentId": "2c87459f-b197-4f59-b41c-1d6b83e33043",
    "Url": "https://kyb.nufi.mx/guest/bElWc3M5azlnd1REemE4Z0pQMVczWFNBc2lvQUQrcjZjR0ZIdnByNG1wVT0",
    "ExternalId": null,
    "ClientId": "0001",
    "ClientName": "Patito S.A. de C.V.",
    "Company": {
      "CompanyId": "0001-0001",
      "CompanyName": "Patito S.A. de C.V.",
      "CompanyRfc": null
    }
  }
}
Endpoint para registrar expedientes y obtener un enlace para que el usuario pueda continuar su flujo de ingreso de documentación.

Objetivo

Permitir la creación de un expediente inicial y devolver una URL para que el usuario complete la carga de información y documentos.

Datos requeridos

  • FlowID (string): Identificador del flujo que define qué se solicita.
  • Company.CompanyName (string): Nombre de la compañía/solicitud.

Datos opcionales frecuentes

  • IncludeFlow (string[]): Secciones/documentos a incluir explícitamente.
  • ExcludeFlow (string[]): Secciones/documentos a excluir.
  • ExternalID (string): Identificador externo opcional.
  • ClientId (string): ID de grupo comercial existente.
  • ClientName (string): Nombre del cliente o grupo comercial.
  • SendEmail (boolean): Enviar correo al crear el expediente.
  • ContactEmail (string): Email del contacto (si SendEmail=true se usa para notificación inmediata).
  • SendSms (boolean): Enviar SMS al crear el expediente.
  • ContactPhone (string): Teléfono nacional de 10 dígitos.
  • Company.CompanyRFC (string): RFC de la compañía.
  • Data (object): Información adicional específica del cliente.

Ejemplo de request

{
  "FlowID": "f-001",
  "ClientId": "0001",
  "ClientName": "Grupo Patito",
  "SendEmail": true,
  "ContactEmail": "contacto@patito.com",
  "SendSms": false,
  "ContactPhone": "5512345678",
  "Company": {
    "CompanyName": "Patito S.A. de C.V.",
    "CompanyRFC": "XXX000000XX0"
  },
  "Data": {}
}

Respuesta 200 (éxito)

{
  "Code": 200,
  "Status": "success",
  "Message": "Documento creado exitosamente",
  "Data": {
    "DocumentId": "2c87459f-b197-4f59-b41c-1d6b83e33043",
    "Url": "https://kyb.nufi.mx/guest/bElWc3M5azlnd1REemE4Z0pQMVczWFNBc2lvQUQrcjZjR0ZIdnByNG1wVT0",
    "ExternalId": null,
    "ClientId": "0001",
    "ClientName": "Patito S.A. de C.V.",
    "Company": {
      "CompanyId": "0001-0001",
      "CompanyName": "Patito S.A. de C.V.",
      "CompanyRfc": null
    }
  }
}

Respuesta 400 (error de validación)

{
  "Code": 400,
  "Status": "bad_request",
  "Message": "Error de validacion",
  "Data": [
    "Ha superado el número máximo de intentos permitidos en la versión de prueba.",
    "El campo FlowId es obligatorio",
    "El FlowId no es válido.",
    "El ClientId no es válido.",
    "Company es obligatorio.",
    "El campo CompanyName es obligatorio"
  ]
}

Headers

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

Body

application/json
FlowID
string
required

Identificador del flujo que determina qué documentos e información se solicitarán al usuario.

Company
object
required
IncludeFlow
string[]

Secciones o documentos a incluir explícitamente en el flujo.

ExcludeFlow
string[]

Secciones o documentos a excluir del flujo.

ExternalID
string

Identificador externo opcional.

ClientId
string

Identificador de un grupo comercial existente.

ClientName
string

Nombre del cliente o grupo comercial.

SendEmail
boolean

Si es true, se envía notificación por email al crear el expediente.

ContactEmail
string<email>

Correo del contacto al que se enviarán notificaciones.

SendSms
boolean

Si es true, se envía SMS al número definido en ContactPhone.

ContactPhone
string

Teléfono nacional de 10 dígitos para notificaciones SMS.

Data
object

Información adicional específica del cliente.

Response

OK

Code
integer
Example:

200

Status
string
Example:

"success"

Message
string
Example:

"Documento creado exitosamente"

Data
object