Skip to main content
GET
/
api
/
v1
/
business
/
auth
Verify Credentials
curl --request GET \
  --url https://api-stage.ugift.me/api/v1/business/auth \
  --header 'X-API-Key: <api-key>'
{
  "id": "507f1f77bcf86cd799439011",
  "name": "Example Retail Ltd",
  "status": "verified",
  "email": "billing@example.com",
  "plan": "account"
}

Documentation Index

Fetch the complete documentation index at: https://docs.ugift.me/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Your UGiftMe API key for authentication.

Format: Secure API key (e.g., <your-api-key>)

Required: All endpoints require this header

Example: X-API-Key: <your-api-key>

Response

Credentials verified successfully

​
id
string
required

Account identifier

Example:

"507f1f77bcf86cd799439011"

​
name
string
required

Registered account name

Example:

"Example Retail Ltd"

​
status
string
required

Verification status for the account

Example:

"verified"

​
email
string

Primary contact email when available

Example:

"billing@example.com"

​
plan
string

Current billing plan when available

Example:

"account"