tipo_sol, el endpoint crea un negocio nuevo o sincroniza uno existente, permitiendo agregar, actualizar o eliminar participantes.tipo_sol = 2), el arreglo participantes representa el estado completo y actual del negocio. Los participantes existentes que no sean enviados serán eliminados.tipo_sol | Descripción | Resultado cuando no se envía folio_juridico | Resultado cuando sí se envía folio_juridico |
|---|---|---|---|
1 | Inicial. Crea un negocio nuevo junto con sus participantes. | Se crea el negocio y todos los participantes quedan sin folio jurídico. | Se crea el negocio y todos los participantes reciben el folio jurídico, ya que todos son participantes nuevos. |
2 | Complementaria. Actualiza un negocio existente sincronizando la información enviada. | Los participantes nuevos se crean sin folio jurídico y los existentes únicamente se actualizan. | Solo los participantes nuevos (id = 0, null o ausente) reciben el folio jurídico. Los participantes existentes conservan el folio jurídico que ya tenían. |
tipo_sol = 2:id eid_persona.participantes representa la lista completa vigente del negocio.tipo_sol = 1){
"id_negocio": 0,
"cod_negocio": "COD-0",
"business_name": "",
"tipo_sol": 1,
"folio_juridico": "FJ-0",
"responsible_user": {
"name": "",
"first_last_name": "",
"second_last_name": "",
"email": ""
},
"participantes": [
{
"id_persona": 0,
"tipo_per": "FIS",
"tipo_part": "",
"nombre": "",
"apellido_paterno": "",
"apellido_materno": "",
"email": "",
"codigo_telefonico": "",
"telefono": "",
"mod_carga": "PER",
"roles": [
"A",
"B"
],
"tipo_doctos": [],
"id_per_base": 0,
"alias": "",
"ocupacion": "",
"id_fiscal": "",
"codigo_pais_id_fiscal": ""
},
{
"id_persona": 0,
"tipo_per": "MOR",
"nombre": "",
"apellido_paterno": "",
"apellido_materno": "",
"email": "",
"telefono": "",
"mod_carga": "REP",
"representante": {
"nombre": "",
"apellido_paterno": "",
"apellido_materno": "",
"email": "",
"codigo_telefonico": "",
"telefono": ""
},
"roles": [
"A"
],
"tipo_doctos": [
{
"cod_tipo_docto": "0",
"id_descarga": 0
}
]
}
]
}tipo_sol = 2){
"id_negocio": 0,
"cod_negocio": "COD-0",
"business_name": "",
"tipo_sol": 2,
"folio_juridico": "FJ-0",
"responsible_user": {
"name": "",
"first_last_name": "",
"second_last_name": "",
"email": ""
},
"participantes": [
{
"id": 123,
"id_persona": 5001,
"tipo_per": "FIS",
"tipo_part": "",
"nombre": "",
"apellido_paterno": "",
"apellido_materno": "",
"email": "",
"codigo_telefonico": "",
"telefono": "",
"mod_carga": "PER",
"roles": ["A", "B"],
"tipo_doctos": [],
"id_per_base": 0,
"alias": "",
"ocupacion": "",
"id_fiscal": "",
"codigo_pais_id_fiscal": ""
},
{
"id": 0,
"id_persona": 5002,
"tipo_per": "MOR",
"nombre": "",
"apellido_paterno": "",
"apellido_materno": "",
"email": "",
"telefono": "",
"mod_carga": "REP",
"representante": {
"nombre": "",
"apellido_paterno": "",
"apellido_materno": "",
"email": "",
"codigo_telefonico": "",
"telefono": ""
},
"roles": ["A"],
"tipo_doctos": [
{
"cod_tipo_docto": "0",
"id_descarga": 0
}
]
}
]
}| Nombre | Obligatorio | Descripción |
|---|---|---|
id_negocio | Sí | Identificador externo del negocio. Debe ser mayor que 0. |
cod_negocio | Sí | Código externo del negocio. |
business_name | No | Nombre del negocio. |
tipo_sol | Sí | Tipo de solicitud: 1 = Inicial, 2 = Complementaria. |
folio_juridico | No | Folio del acto jurídico que será asignado únicamente a los participantes nuevos creados durante la solicitud. |
responsible_user | No | Información del responsable del negocio. |
participantes | Sí | Lista de participantes del negocio. Debe contener al menos un participante. |
| Campo | Obligatorio | Descripción |
|---|---|---|
id | No | Identificador interno del participante. Si es mayor que 0, el participante se considera existente. Si es 0, null o no se envía, el participante se considera nuevo. |
id_persona | Sí | Identificador externo de la persona. |
tipo_per | Sí | Tipo de persona. Valores permitidos: FIS (Persona Física) o MOR (Persona Moral). |
tipo_part | No | Tipo de participante. |
nombre | Sí | Nombre del participante. |
apellido_paterno | Sí | Apellido paterno. |
apellido_materno | Sí | Apellido materno. |
email | Sí | Correo electrónico. |
codigo_telefonico | No | Lada o código telefónico internacional. |
telefono | Sí | Número telefónico. |
mod_carga | Sí | Modo de carga documental. Valores permitidos: PER (documentación propia) o REP (mediante representante). |
representante | Condicional | Obligatorio cuando mod_carga es REP. |
roles | Sí | Lista de roles del participante dentro del negocio. |
tipo_doctos | No | Lista de documentos asociados al participante. |
id_per_base | No | Identificador de la persona base asociada al participante. |
alias | No | Alias del participante. |
ocupacion | No | Ocupación. |
id_fiscal | No | RFC o identificador fiscal. |
codigo_pais_id_fiscal | No | Código ISO del país del identificador fiscal. |
rolesroles permite enviar uno o varios roles para un mismo participante."roles": [ "A", "B"]tipo_doctos no se envía o se envía vacío, los roles serán utilizados para determinar los documentos que deberán solicitarse al participante.tipo_doctos con uno o más documentos, éstos serán utilizados y los documentos asociados a los roles no serán considerados.folio_juridicofolio_juridico es opcional y representa el folio asociado a un acto jurídico.id = 0, null o ausente).id > 0).{
"data": {},
"success": true,
"message": "Business request processed successfully"
}tipo_sol únicamente acepta los valores 1 (Inicial) y 2 (Complementaria).tipo_sol = 1), el negocio no debe existir previamente.tipo_sol = 2), el negocio debe existir previamente.participantes.mod_carga es REP, el objeto representante es obligatorio.roles deben existir previamente en el catálogo fiduciario configurado para el cliente; de lo contrario, la solicitud devolverá un error.folio_juridico es opcional y únicamente se asigna a los participantes nuevos de la solicitud.participantes representa el estado completo del negocio; los participantes omitidos serán eliminados.x-api-key, service y Authorization con un Bearer Token válido para evitar errores de autenticación.code_message, el cual puede variar dependiendo del tipo de error (por ejemplo: invalid_request, unauthorized o server_error).curl --location '/api/v4/fiduciary/request' \
--header 'x-api-key: {{api-key}}' \
--header 'service: {{service}}' \
--header 'Content-Type: application/json' \
--data '// Initial
{
"id_negocio": 0, // ID externo del negocio (obligatorio, > 0)
"cod_negocio": "COD-0", // Código externo del negocio (obligatorio)
"business_name": "", // Nombre del negocio (opcional)
"tipo_sol": 1, // Tipo de solicitud: 1 = alta inicial, 2 = complementaria (obligatorio)
"folio_juridico": "FJ-0", // Folio de acto jurídico (opcional, todos los participantes son nuevos, el folio se les asigna a todos)
"responsible_user": { // Usuario responsable del negocio (opcional)
"name": "", // Nombre (requerido)
"first_last_name": "", // Apellido paterno (requerido)
"second_last_name": "", // Apellido materno (requerido)
"email": "" // Correo (requerido)
},
"participantes": [ // Arreglo de participantes (obligatorio, mínimo 1)
{
"id_persona": 0, // ID externo de la persona (obligatorio)
"tipo_per": "FIS | MOR", // Tipo de persona: física o moral (obligatorio)
"tipo_part": "", // Tipo de participante (opcional)
"nombre": "", // Nombre (obligatorio)
"apellido_paterno": "", // Apellido paterno (obligatorio)
"apellido_materno": "", // Apellido materno (obligatorio)
"email": "", // Correo (obligatorio)
"codigo_telefonico": "", // Lada/código de país del teléfono (opcional)
"telefono": "", // Teléfono (obligatorio)
"mod_carga": "PER", // Modo de carga de documentos: "PER" = propia, "REP" = vía representante (obligatorio)
"roles": ["A","B"], // Roles del participante en el negocio, debe coincidir con el nombre definido en el catalogo de cliente (obligatorio)
"tipo_doctos": [], // Documentos requeridos (opcional)
"id_per_base": 0, // ID de persona base, a la cual esta ligada (opcional)
"alias": "", // Alias del participante (opcional)
"ocupacion": "", // Ocupación (opcional)
"id_fiscal": "", // RFC / ID fiscal (opcional)
"codigo_pais_id_fiscal": "" // Código país ISO del ID fiscal, ej. MX, US (opcional)
},
{
"id": null,
"id_persona": 0,
"tipo_per": "FIS | MOR",
"nombre": "",
"apellido_paterno": "",
"apellido_materno": "",
"email": "",
"telefono": "",
"mod_carga": "REP", // Con "REP" se debe incluir "representante"
"representante": { // Datos del representante legal (obligatorio si mod_carga="REP")
"nombre": "", // Nombre (obligatorio)
"apellido_paterno": "", // Apellido paterno (obligatorio)
"apellido_materno": "", // Apellido materno (obligatorio)
"email": "", // Correo (obligatorio)
"codigo_telefonico": "", // Lada/código de país (opcional)
"telefono": "" // Teléfono (obligatorio)
},
"roles": ["A"],
"tipo_doctos": [
{
"cod_tipo_docto": "0", // Código del tipo de documento (obligatorio)
"id_descarga": 0 // ID de descarga del documento en el sistema externo (opcional)
},
{
"cod_tipo_docto": "0",
"id_descarga": 0
}
]
}
]
}
// Complementary
// Se requiere enviar todo el payload completo como en tipo_sol = 1.
/*{
"id_negocio": 0, // ID externo del negocio YA EXISTENTE (obligatorio, debe existir o da error)
"cod_negocio": "COD-0",
"business_name": "",
"tipo_sol": 2, // 2 = complementaria (obligatorio)
"folio_juridico": "FJ-0", // Opcional. Solo se asigna en participantes que NO existían
"responsible_user": {
"name": "",
"first_last_name": "",
"second_last_name": "",
"email": ""
},
"participantes": [ // OJO: se trata como la lista COMPLETA vigente. Cualquier participante que YA
// estaba en el negocio y NO aparezca aquí, se ELIMINA
{
"id": 0, // Necesario para asignar folio juridico a los nuevos y no a todos (incluyendo existentes)
"id_persona": 5001, // OBLIGATORIO en complementaria. Es lo que hace el match contra BD:
// - si coincide con un participante ya guardado -> se ACTUALIZA
// - si no coincide con ninguno -> se CREA como nuevo
"tipo_per": "FIS | MOR",
"tipo_part": "",
"nombre": "",
"apellido_paterno": "",
"apellido_materno": "",
"email": "",
"codigo_telefonico": "",
"telefono": "",
"mod_carga": "PER",
"roles": ["A","B"],
"tipo_doctos": [],
"id_per_base": 0,
"alias": "", //
"ocupacion": "",
"id_fiscal": "",
"codigo_pais_id_fiscal": ""
},
{
"id": null,
"id_persona": 0,
"tipo_per": "FIS | MOR",
"nombre": "",
"apellido_paterno": "",
"apellido_materno": "",
"email": "",
"telefono": "",
"mod_carga": "REP",
"representante": {
"nombre": "",
"apellido_paterno": "",
"apellido_materno": "",
"email": "",
"codigo_telefonico": "",
"telefono": ""
},
"roles": ["A"],
"tipo_doctos": [
{
"cod_tipo_docto": "0",
"id_descarga": 0
}
]
}
]
}*/'{
"data": {
"code_message": "data_saved",
"business_id": 0
},
"message": "Fiduciary data saved successfully",
"success": true
}