Obtener detalles del perfil

Este endpoint permite obtener la información del perfil del usuario autenticado.

Entornos

La API de DrEnvío admite dos entornos: Producción y Sandbox.

Entorno de Producción: Este endpoint obtiene la información del perfil para el usuario autenticado:

    https://prod.api-drenvio.com/v2/users/profile/details

Sandbox Environment: Este endpoint obtiene la información del perfil para el usuario autenticado:

    https://sandbox.api-drenvio.com/v2/users/profile/details

Parámetros

Los siguientes parámetros opcionales pueden ser utilizados en la solicitud. Si no se proporcionan parámetros, la respuesta devolverá toda la información disponible. Cuando se incluyen parámetros específicos, solo se devolverán los datos solicitados.

Campo	Descripción	Tipo	Requerido
balance	Devuelve el saldo disponible del usuario en MXN (México) o COP (Colombia).	Boolean	falso
created_at	Devuelve la fecha y hora en que se creó la cuenta del usuario.	Boolean	falso
user	Devuelve el identificador único (ID de Usuario) asociado a la cuenta del usuario.	Boolean	falso
app_country	Devuelve el país donde está registrado el usuario autenticado.	Boolean	falso
security	Devuelve detalles relacionados con la seguridad, como la verificación de remitentes y el estado de la cuenta.	Boolean	falso
profile	Devuelve la información del perfil del usuario, incluyendo nombre, correo electrónico y número de teléfono.	Boolean	falso

Solicitud API (Ejemplo con Parámetros)

Para recuperar la información del perfil del usuario conectado, envíe la siguiente solicitud GET:

GET https://prod.api-drenvio.com/v2/users/profile/details?balance=true&created_at=true&user=true&app_country=true&security=true&profile=true

Respuesta API (Todos los campos)

{
  "code": 200,
  "success":  true,
  "res": {
        "balance": 1000,
        "created_at": "2024-08-29T23:09:31.892Z",
        "user": "auth0|428g65ab1174d50068422000",
        "security": {
            "senders": [
                "87350",
                "66250",
                "57800"
            ],
            "senders_verified": true,
            "identity_verified": true,
            "international_senders": true,
            "identity_verified_by_document": true,
            "vip": true
        },
        "app_country": "MX",
        "profile": {
            "email": "john@drenvio.com",
            "phone": "8681696700",
            "company": "Drenvio",
            "name": "John Doe"
        }
    }
}

Desglose de Campos de Respuesta

Las siguientes secciones describen las diferentes partes de la respuesta cuando se solicitan parámetros específicos.

Descripciones de Campos del Objeto Security

El objeto Security contiene detalles relacionados con la seguridad del usuario autenticado. Estos son los campos que se devolverán en la respuesta cuando se solicite el parámetro de seguridad.

Campo	Descripción	Tipo
senders	Lista de códigos postales que representan las direcciones de los remitentes autorizados para el envío.	Array
senders_verified	Indica si la verificación del remitente está habilitada. Si es true, se pueden usar múltiples direcciones (remitentes); si es false, solo se puede guardar una.	Boolean
identity_verified	Indica si la cuenta ha sido verificada.	Boolean
international_senders	Indica si se permiten envíos internacionales.	Boolean
identity_verified_by_document	Indica si la verificación de identidad se ha completado mediante documentos oficiales.	Boolean
vip	Indica si el usuario tiene estatus VIP.	Boolean

Descripción del Objeto Profile

El objeto Profile contiene la información del perfil del usuario, que incluye detalles básicos como el correo electrónico, teléfono, nombre y empresa. Estos campos se devolverán cuando se solicite el parámetro de perfil.

Campo	Descripción	Tipo
email	La dirección de correo electrónico del usuario.	String
phone	El número de teléfono del usuario.	String
name	El nombre completo del usuario.	String
company	El nombre de la empresa asociada con el usuario.	String