API Reference

Vinculación de usuario

Creación del objeto

{
    "tradeName": "OFFICWEE COL",  
    "legalName": "OFFIC",  
    "document": "85454545",
    "typeDocumentId": "1",
    "emailNotification": "[email protected]",
    "indicativeContact": "+57",
    "phoneContact": "300000000",
    "categoryId": "3",
    "address": "7217 NW 2nd Ave",
    "thirdCredentials": {
        "type": "CARD",
        "fullName": "Jaider Perez",
        "accountNumber": "99999999",
        "expirationDate": "203112"
    }
}


Explicación General para el Usuario

Para vincular un nuevo 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.

Referencia

  • PN: Persona Natural.
  • PJ: Persona Jurídica.
PARÁMETRODESCRIPCIÓNPNPJ
lastNameApellido de la persona.X
nameNombre de pila 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
documentNúmero de documento 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
addressDirección física del tercero.XX
thirdCredentials.typeTipo de credencial utilizada para las transacciones (e.j., CARD, BANK).XX
thirdCredentials.fullNameNombre completo del titular de la credencial.XX
thirdCredentials.accountNumberNúmero de cuenta o tarjeta.XX
thirdCredentials.expirationDateFecha de expiración de la tarjeta en formato YYYYMM.XX
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!