Get Profile details

This endpoint allows retrieving the profile information of the authenticated user.

Environments

The DrEnvío API supports two environments: Production and Sandbox.

Production Environment: This endpoint retrieves profile information for the authenticated user:

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

Sandbox Environment: This endpoint retrieves profile information for the authenticated user:

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

Params

The following optional parameters can be used in the request. If no parameters are provided, the response will return all available information. When specific parameters are included, only the requested data will be returned.

Field	Description	Type	Required
balance	Returns the user’s available balance in MXN (Mexico) or COP (Colombia).	Boolean	false
created_at	Returns the date and time when the user account was created.	Boolean	false
user	Returns the unique identifier (User ID) associated with the user’s account.	Boolean	false
app_country	Returns the country where the authenticated user is registered.	Boolean	false
security	Returns security-related details, such as sender verification and account status.	Boolean	false
profile	Returns the user’s profile information, including name, email, and phone number.	Boolean	false

API Request (Example with Parameters)

To retrieve profile information for the logged-in user, send the following GET request:

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

API response (All fields)

{
  "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"
        }
    }
}

Response Fields Breakdown

The following sections describe the different parts of the response when specific parameters are requested.

SecurityObject Field Descriptions

The SecurityObject contains security-related details about the authenticated user. These are the fields that will be returned in the response when the security parameter is requested.

Field	Description	Type
senders	List of postal codes representing sender addresses authorized for shipping.	Array
senders_verified	Indicates whether sender verification is enabled. If true, multiple addresses (senders) can be used; if false, only one can be saved.	Boolean
identity_verified	Indicates whether the account has been verified.	Boolean
international_senders	Indicates whether international shipments are allowed.	Boolean
identity_verified_by_document	Indicates whether identity verification has been completed using official documents.	Boolean
vip	Indicates whether the user has VIP status.	Boolean

ProfileObject Field description

The ProfileObject contains the user’s profile information, which includes basic details like email, phone, name, and company. These fields will be returned when the profile parameter is requested.

Field	Description	Type
email	The user’s email address.	String
phone	The user’s phone number.	String
name	The full name of the user.	String
company	The name of the company associated with the user.	String