User

These endpoints let you access and manage user-related information. See the details below for more information on how to use them.

GET/user/details

Retrieve User Details

This endpoint allows you to fetch information about a user.

Request

GET

/user/details

curl --location 'https://api.mailverify.ai/api/v1/user/details' \
--header 'x-auth-mailverify: apiKey'

Response

{
"userDetails": {
    "firstName": "John",
    "lastName": "Doe",
    "userId": "132",
    "email": "[email protected]",
    "googleSignIn": true,
    "reachinboxSignIn": false,
    "isVerified": true,
    "createdAt": "2024-11-21T12:56:21.603Z",
    "planStartDate": "2024-11-21T12:56:23.397Z",
    "planEndDate": "2024-12-21T12:56:23.397Z",
    "planType": "MONTHLY",
    "monthlyCreditLimit": 500000,
    "creditsLeft": 49998,
    "addonCreditsLeft": 0,
    "subscriptionStatus": null,
    "ipFlagValue": 0
}
}

POST/user/details

Update User Details

This endpoint allows you to update information about a user.

Request

POST

/user/details

curl --location 'https://api.mailverify.ai/api/v1/user/details' \
--header 'Content-Type: application/json' \
--header 'x-auth-mailverify: apiKey' \
--data-raw '{
  "firstName": "NewFirstName",
  "lastName": "NewLastName",
}'

Response

  {
"userDetails": {
    "firstName": "John",
    "lastName": "Doe",
    "userId": "132",
    "email": "[email protected]",
    "googleSignIn": true,
    "reachinboxSignIn": false,
    "isVerified": true,
    "createdAt": "2024-11-21T12:56:21.603Z",
    "planStartDate": "2024-11-21T12:56:23.397Z",
    "planEndDate": "2024-12-21T12:56:23.397Z",
    "planType": "MONTHLY",
    "monthlyCreditLimit": 500000,
    "creditsLeft": 49998,
    "addonCreditsLeft": 0,
    "subscriptionStatus": null,
    "ipFlagValue": 0
}
}

GET/credits_left

Retrieve User Credit Details

This endpoint allows you to fetch the remaining credits for the user.

Request

GET

/credits_left

curl --location 'https://api.mailverify.ai/api/v1/user/credits_left' \
--header 'x-auth-mailverify: apiKey'

Response

{
"creditsLeft": 484237,
"creditsLimit": 500000,
"addonCreditsLeft": 0
}

GET/credits_history

Retrieve User Credit History

This endpoint allows you to fetch the credit usage history of the user.

Request

GET

/credit_history

curl --location 'https://api.mailverify.ai/api/v1/user/credit_history' \
--header 'x-auth-mailverify: apiKey'

Response

[
{
    "list_id": null,
    "credits_consumed": "-1",
    "balance": "1158",
    "reason": "Single Email Verification",
    "created_at": "2024-11-21T06:42:43.485Z"
},
{
    "list_id": "302",
    "credits_consumed": "-280",
    "balance": "879",
    "reason": "Bulk Email Verification",
    "created_at": "2024-11-21T06:46:47.386Z"
},
{
    "list_id": "302",
    "credits_consumed": "70",
    "reason": "Refund for Unknown Email",
    "createdAt": "2024-11-21T06:48:01.459Z",
    "balance": "949"
}
]