Crear cliente

Registra un nuevo cliente en el sistema. Incluye datos personales, información de contacto y ubicación geográfica.

---

Entorno

URL base: https://api.guarani.app

Endpoint

POST /clientes

Ejemplo de solicitud

curl -X POST "https://api.guarani.app/clientes" \
  -H "Content-Type: application/json" \
  -H "x-api-key: Bearer <access_token>" \
  -d '{
    "tipo_persona": 1,
    "tipo_documento": 1,
    "documento": "1234567",
    "nombre": "Cliente Ejemplo",
    "nombre_fantasia": "",
    "nacionalidad": "PRY",
    "fecha_nacimiento": "11/09/2025",
    "whatsapp": "+595981234567",
    "email": "[email protected]",
    "direccion": "Calle 123",
    "numero_casa": "",
    "barrio": "Barrio Ejemplo",
    "ciudad_id": "67ef2e9f-0fa7-43e7-ad5e-87a694e56341"
  }' | jq

Nota: Asegúrate de reemplazar <access_token> con un token JWT válido proporcionado por el equipo Guarani. Importante:
Es imprescindible incluir un token de acceso válido en el encabezado x-api-key para autenticar y autorizar el uso de este endpoint. Sin este token, la solicitud será rechazada.

---

Encabezados de la solicitud

Encabezado	Valor	Descripción
Content-Type	application/json	Indica que los datos se envían en formato JSON.
x-api-key	Bearer <access_token>	Token de autenticación necesario para acceder al recurso.

Descripción de Campos

Campo	Tipo	Requerido	Tamaño	Descripción
tipo_persona	number	Sí	-	Tipo de persona (por ejemplo: 1 = Física, 2 = Jurídica). ver (tipos de personas)
tipo_documento	number	Sí	-	Tipo de documento (por ejemplo: 1 = CI, 0 = RUC, etc.). ver (tipos de documentos)
documento	string	Sí	15	Número del documento del cliente.
nombre	string	Sí	100	Nombre completo de la persona o razón social. Debe mantener al menos un 90 % de similitud con el nombre registrado para el documento.
nombre_fantasia	string	No	100	Nombre de fantasía o nombre comercial, si aplica.
nacionalidad	string	Sí	3	Nacionalidad de la persona (código ISO 3166-1 alfa-3, ej. “PRY”).
fecha_nacimiento	date	Sí	-	Fecha de nacimiento (formato DD/MM/YYYY).
whatsapp	string	Sí	15	Número de WhatsApp en formato internacional (ej. +595981765432).
email	string	Sí	100	Dirección de correo electrónico.
direccion	string	Sí	255	Dirección física de la persona.
numero_casa	string	No	10	Número de casa, si aplica.
barrio	string	No	100	Barrio o zona de residencia.
ciudad_id	uuid	No	36	Identificador único de la ciudad. ver (ciudades)

Ejemplo de respuesta

{
  "success": true,
  "codigo": "201",
  "message": "Recurso creado con éxito.",
  "data": {
    "id": "658686dc-93b5-44d5-b294-906f736035aa",
    "tipo_persona": 1,
    "tipo_documento": 1,
    "documento": "1234567",
    "nombre": "Cliente Ejemplo",
    "nombre_fantasia": "Cliente Ejemplo",
    "nacionalidad": "PRY",
    "fecha_nacimiento": "11/09/2025",
    "whatsapp": "+595981234567",
    "email": "[email protected]",
    "direccion": "Calle 123",
    "numero_casa": "0",
    "barrio": "Barrio Ejemplo",
    "ciudad": {
      "id": "67ef2e9f-0fa7-43e7-ad5e-87a694e56341",
      "nombre": "SANTA RITA",
      "codigo_sifen": "3556",
      "distrito": {
        "id": "78d49201-91f9-4e6c-aadb-4927f56767c0",
        "nombre": "SANTA RITA",
        "codigo_sifen": "209",
        "departamento": {
          "id": "750d3163-6a53-45df-b349-e8139d1ff3a9",
          "nombre": "ALTO PARANA",
          "codigo_sifen": "11"
        }
      }
    }
  }
}

Descripción de campos de respuesta

Campos principales

Campo	Tipo	Descripción
id	uuid	Identificador único del cliente generado por el sistema.
tipo_persona	number	Tipo de persona. 1 = Persona Física, 2 = Persona Jurídica.
tipo_documento	number	Tipo de documento. 1 = Cédula, 2 = Pasaporte, 3 = RUC, etc.
documento	string	Número del documento de identidad del cliente.
nombre	string	Nombre completo del cliente (razón social para personas jurídicas).
nombre_fantasia	string	Nombre comercial o fantasía del cliente.
nacionalidad	string	Código de nacionalidad en formato ISO 3166-1 alpha-3 (ej: PRY, ARG, BRA).
fecha_nacimiento	string	Fecha de nacimiento del cliente en formato DD/MM/YYYY.
whatsapp	string	Número de WhatsApp del cliente en formato internacional.
email	string	Dirección de correo electrónico del cliente.
direccion	string	Dirección completa del cliente.
numero_casa	string	Número de casa o edificio de la dirección del cliente.
barrio	string	Nombre del barrio donde reside el cliente.
ciudad	objeto	Objeto con información de la ciudad del cliente. (ver ciudades)

Campos de ciudad

Campo	Tipo	Descripción
id	uuid	Identificador único de la ciudad.
nombre	string	Nombre de la ciudad.
codigo_sifen	string	Código de la ciudad según el catálogo SIFEN.
distrito	objeto	Objeto con información del distrito al que pertenece la ciudad.

Campos de distrito

Campo	Tipo	Descripción
id	uuid	Identificador único del distrito.
nombre	string	Nombre del distrito.
codigo_sifen	string	Código del distrito según el catálogo SIFEN.
departamento	objeto	Objeto con información del departamento.

Campos de departamento

Campo	Tipo	Descripción
id	uuid	Identificador único del departamento.
nombre	string	Nombre del departamento.
codigo_sifen	string	Código del departamento según el catálogo SIFEN.

Recursos adicionales

Para más información sobre posibles errores relacionados, consulta la sección errores.