Battlegrounds Mobile India (BGMI) Account ID (UID) Validation API Documentation - HL GAMING OFFICIAL

Home Developers Loading...

Navigation

Overview

Authentication

Obtaining Credentials

Rate Limits & Plans

Endpoint URL

Parameters

Request Examples

Response Schema

Example Responses

Error Responses

Best Practices

Security Recommendations

Logging & Analytics

FAQ

Changelog

Support & Tester

Overview

The BGMI Account UID Validation API enables real-time verification of any Battlegrounds Mobile India (BGMI) user’s UID against HL Gaming Official’s global servers. It is ideal for tournament platforms, community directories, reward systems, or any service that requires assurance the submitted BGMI UID corresponds to an actual in-game account. Each request is proxied through our edge-caching layer, minimizing upstream calls and delivering sub-second response times even under heavy load.

Highlights:

• Instant Verification: Quickly returns whether the UID exists and is bound to a device, plus human-readable messages.
• Official Metadata: Pulls username, player ID, country, device binding status, rank activity, and estimated level.
• Detailed Server Health: Includes latency, queue status, uptime, and concurrent load for on-the-fly diagnostics.
• Robust Security: All traffic is encrypted, integrity-checked, and served over SSL with strict certificate validation.

// JavaScript GET example:
fetch(
  "https://hl-gaming-official-main-v4-api.vercel.app/api" +
  "?sectionName=verify-bgmi" +
  "&useruid=YOUR_DEV_ID" +
  "&api=YOUR_API_KEY" +
  "&uid=514083312"
)
.then(res => res.json())
.then(json => console.log("BGMI Validation:", json))
.catch(console.error);
      

Authentication

Access to the BGMI UID Validation endpoint requires two credentials on every call: useruid (your HL Gaming Official Developer ID) and api (your secret API Key). Missing or invalid credentials result in a 403 Forbidden response.

Security Note: Store your API key securely on server-side environments. Never embed it in client-side code or publicly exposed repositories.

// GET form:
?useruid=dev123UID&api=abcDEFkey123

// POST JSON body:
{
  "sectionName": "verify-bgmi",
  "useruid":      "dev123UID",
  "api":          "abcDEFkey123",
  "uid":          "514083312"
}
      

Obtaining Your Credentials

Before invoking the BGMI UID Validation API, you must have:

• Developer UID — Issued to your HL Gaming Official account.
• API Key — Secret key for request signing.

Retrieve both by logging into the HL Gaming Official Developer Portal:

Visit: https://www.hlgamingofficial.com/p/api.html
      

1. Sign in with your HL Gaming Official developer account.
2. Navigate to API Credentials — copy your useruid and api values.

Tip: Rotate your API key every 90 days and revoke any key you suspect has been compromised.

Rate Limits & Plans

Each developer account gets a daily quota of UID checks. Quotas reset 24 hours after your first call in the previous cycle. Monitor usage.remainingToday in each response to avoid interruptions.

Plan	Validations / 24h	USD / mo
Free	700+	$0
Starter	6,000	$19
Pro	10,000	$++
Enterprise	Unlimited	Contact Sales

Developer Tip: Cache successful UID→player mappings for 5–10 minutes to reduce calls and speed up repeat lookups.

Endpoint URL

https://hl-gaming-official-main-v4-api.vercel.app/api
  ?sectionName=verify-bgmi
  &useruid={YOUR_DEV_ID}
  &api={YOUR_API_KEY}
  &uid={BGMI_UID}
      

Supports both GET (query parameters) and POST (JSON body) methods.

Parameters

Parameter	Required	Type	Description
sectionName	Yes	string	Must be exactly verify-bgmi.
useruid	Yes	string	Your developer UID from HL Gaming Official.
api	Yes	string	Your secret API key.
uid	Yes	string	The BGMI account UID to verify.

Important: All parameters are case-sensitive. Missing or malformed parameters result in 400 Bad Request.

Request Examples

GET Example

curl "https://hl-gaming-official-main-v4-api.vercel.app/api?
  sectionName=verify-bgmi
  &useruid=dev123UID
  &api=abcDEFkey123
  &uid=514083312"
      

POST Example

curl -X POST https://hl-gaming-official-main-v4-api.vercel.app/api \
  -H "Content-Type: application/json" \
  -d '{
    "sectionName":"verify-bgmi",
    "useruid":"dev123UID",
    "api":"abcDEFkey123",
    "uid":"514083312"
  }'
      

Response Schema

{
  "source": "BGMI UID Verification",
  "result": {
    "success": boolean,            // True if request processed without internal errors
    "verified": boolean,           // True if UID exists and is bound
    "official_response": {         // Raw response from upstream BGMI servers
      "status": "success"|"fail",
      "username"?: string,
      "id"?: string,
      "message"?: string
    },
    "message": string,             // Human-readable result summary
    "player": {
      "username": string|null,
      "player_id": string,
      "verified_at": string,       // ISO8601 timestamp
      "status": "Verified"|"Not Found",
      "remark": string,
      "device_bound": boolean,
      "country": string,
      "platform": string,
      "rank_status": string,
      "estimated_level": string
    },
    "server": {
      "name": string,
      "region": string,
      "latency_ms": number,
      "request_id": string,
      "api_type": string,
      "uptime": string,
      "load": {
        "concurrent_checks": number,
        "queue_status": string,
        "system": string
      }
    },
    "security": {
      "encrypted": boolean,
      "integrity_check": string,
      "certificate": string,
      "access_scope": string,
      "api_whitelist": string[]
    },
    "meta": {
      "version": string,
      "endpoint": string,
      "maintainer": string,
      "documentation": string,
      "usage": string,
      "timezone": string,
      "audit_log_id": string
    },
    "timestamp": string           // ISO8601 timestamp
  },
  "usage": {
    "usedToday": number,
    "dailyLimit": number,
    "remainingToday": number
  }
}
      

The result object contains both high-level flags and deep diagnostic data. The usage object tracks daily quota consumption and resets 24 hours after your first call.

Example Responses

Valid UID

{
  "source":"BGMI UID Verification",
  "result":{
    "success":true,
    "verified":true,
    "official_response":{
      "status":"success",
      "username":"PistolBaazē",
      "id":"514083312"
    },
    "message":"✅ Congratulations! The BGMI account \"PistolBaazē\" (ID: 514083312) has been verified.",
    "player":{
      "username":"PistolBaazē",
      "player_id":"514083312",
      "verified_at":"2025-05-30T18:48:03.610Z",
      "status":"Verified",
      "remark":"Player record exists in HL Gaming Official database.",
      "device_bound":true,
      "country":"India",
      "platform":"Android/iOS",
      "rank_status":"Active Ranked",
      "estimated_level":"45-75"
    },
    "server":{ /* server section as above */ },
    "security":{ /* security section as above */ },
    "meta":{ /* meta section as above */ },
    "timestamp":"2025-05-30T18:48:03.610Z"
  },
  "usage":{
    "usedToday":4,
    "dailyLimit":999,
    "remainingToday":995
  }
}
      

Invalid UID

{
  "source":"BGMI UID Verification",
  "result":{
    "success":true,
    "verified":false,
    "official_response":{
      "status":"fail",
      "message":"ID not found"
    },
    "message":"❌ No player found for ID: 51408753312.",
    "player":{
      "username":null,
      "player_id":"51408753312",
      "verified_at":"2025-05-30T18:53:16.491Z",
      "status":"Not Found",
      "remark":"The given ID does not match any player record.",
      "device_bound":false,
      "country":"India",
      "platform":"Android/iOS",
      "rank_status":"N/A",
      "estimated_level":"N/A"
    },
    "server":{ /* server section as above */ },
    "security":{ /* security section as above */ },
    "meta":{ /* meta section as above */ },
    "timestamp":"2025-05-30T18:53:16.491Z"
  },
  "usage":{
    "usedToday":5,
    "dailyLimit":999,
    "remainingToday":994
  }
}
      

Error Responses

400 Bad Request

{ "error": "Missing or malformed parameters." }

Returned when sectionName, useruid, api, or uid is absent or invalid.

403 Forbidden

{ "error": "Unauthorized." }

Invalid useruid or api key.

429 Too Many Requests

{ "error": "Quota exceeded." }

No calls allowed until quota resets 24h after first request.

502 Bad Gateway

{ "error": "BGMI Verification service unavailable." }

Upstream BGMI server unreachable. Retry after a short delay.

500 Internal Server Error

{ "error": "Internal server error." }

General failure; retry later.

Best Practices

• Validate uid format client-side before calling API.
• Cache positive results for 5–10 minutes to minimize repeated lookups.
• Implement exponential backoff for 502 and 500 responses.
• Monitor usage.remainingToday to avoid unexpected quota blocks.

Security Recommendations

• Use HTTPS to secure credentials in transit.
• Store api and useruid in secure vaults or env vars.
• Restrict API access by IP or domain where possible.
• Rotate API keys every 90 days and revoke compromised keys immediately.

Logging & Analytics

All requests and responses (with timestamps, params, and statuses) are logged in HL Gaming Official’s central audit system. Integrate with your APM (Datadog, New Relic, etc.) to track latency, error rates, and usage trends over time.

FAQ

Q: What if the UID is valid but device binding is false?
A: verified:true but device_bound:false indicates the account exists but isn’t bound to any recognized device yet.

Q: When exactly does the quota reset?
A: 24 hours after your first successful call in the previous cycle. Check usage.remainingToday for live status.

Changelog

• v2.0.0 — Launched BGMI UID Verification API with full metadata, security, and load diagnostics.

Support & Tester

For live testing, interactive docs, and developer support, visit: HL Gaming Official BGMI Verify API Docs.