API Reference

Crear tercero

El endpoint de registro de tercero y usuario permite crear un nuevo tercero en el sistema. Este proceso es esencial para asegurar que todos los datos relevantes de los terceros y usuarios se capturen y gestionen correctamente.

{
    "name": "Luis H",
    "lastName": "hernandez",
    "document": "31532123",
    "typeDocumentId": 1,
    "emailNotification": "[email protected]",
    "indicativeContact": "+57",
    "phoneContact": "3000000025",
    "categoryId": 3,
    "thirdDirectoryUuid": "3b9ecaa3-309f-4ee9-ad4e-14999168aea0",
    "typeUuid": "PROFILE"
}

Parámetros para el Endpoint

PARÁMETRODESCRIPCIÓNPNPJ
nameNombre de pila de la persona.X
lastNameApellido de la persona.X
tradeNamesolo cuando el tipo de documento es 3(NIT)
Nombre bajo el que se desarrolla la actividad comercial. En este caso, podría ser el nombre de un negocio o emprendimiento.
X
legalNamesolo cuando el tipo de documento es 3(NIT)
Nombre oficial registrado ante las autoridades. En este caso, podría ser la razón social de una empresa.
X
documentDocumento del tercero.XX
typeDocumentIdID del tipo de documento del tercero.XX
dvDígito de verificación del documento (solo si el tipo de documento lo requiere).X
emailNotificationDirección de correo electrónico para notificaciones del tercero.XX
indicativeContactIndicativo de país para el número de teléfono de contacto del tercero.XX
phoneContactNúmero de teléfono de contacto del tercero.XX
categoryIdID de la categoría del tercero.XX
thirdDirectoryUuidUUID del directorio del tercero, puedes consultarlo por alias aquí.XX
typeUuidTipo de UUID (puede ser "PROFILE" o "ACCOUNT"), puedes consultarlo por alias aquí.XX

Para registrar un nuevo tercero y usuario en el sistema, es crucial proporcionar todos los parámetros mencionados anteriormente. Cada uno de estos campos es necesario para asegurar que el tercero y el usuario estén correctamente identificados y que todas las transacciones y comunicaciones relacionadas puedan realizarse de manera eficiente y segura.

Proporcionar esta información de manera completa y precisa es fundamental para la correcta operación y gestión de los terceros y usuarios en el sistema.

Campos de respuesta


CampoDescripción
errorIndica si hubo un error. 0 significa que no hubo error.
messageMensaje descriptivo del resultado de la operación.
dataContiene la información del registro guardado.
data.uuidUUID del tercero.
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!