Check 0Gate eligibility

0Gate is the primary public integration path for hosted payment, ramp, and swap experiences. Keep secret-key operations on your server and hand only browser-safe values to the widget.

Endpoint

Use it for

Answer "can a user in this region use the ramp — optionally for a given currency and asset?" before you create a session or lock a quote. Use it to decide whether to show the buy/sell entry point, a waitlist, or an unsupported-region notice.

This endpoint is read-only and never a money path. An unsupported or unresolved region returns eligible: false with a machine-readable unavailable_reason rather than an error, so you can branch client-side instead of catching exceptions.

Production rules

• Keep secret keys on your server. This endpoint requires an sk_* key; a publishable pk_* key can only call embed-bootstrap.
• Branch on eligible, then on unavailable_reason — do not parse a display string.
• Treat eligible: false as a normal, expected outcome, not a failure to retry in a loop.
• Inspect geo_source to know whether the decision was driven by your explicit country_code or the caller's IP region.
• Treat examples and placeholder values as fake data only.

Request

This is a GET with no body. The currency and asset parameters are optional refinements.

Response

Always 200. Returns a single eligibility object.

unavailable_reason values

The first failing gate wins, in precedence order region → currency → asset.

Examples

curl 'https://gate-api.0bit.app/v1/capabilities/eligibility?country_code=GB&currency=GBP&asset=USDC' \
  -H "Authorization: Bearer sk_test_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

{
  "object": "eligibility",
  "country_code": "GB",
  "eligible": true,
  "supported": true,
  "default_currency": "GBP",
  "currency_supported": true,
  "asset_supported": true,
  "geo_source": "explicit",
  "unavailable_reason": null
}

{
  "object": "eligibility",
  "country_code": "ZZ",
  "eligible": false,
  "supported": false,
  "default_currency": null,
  "currency_supported": null,
  "asset_supported": null,
  "geo_source": "explicit",
  "unavailable_reason": "country_not_supported"
}

{
  "object": "eligibility",
  "country_code": null,
  "eligible": false,
  "supported": false,
  "default_currency": null,
  "currency_supported": null,
  "asset_supported": null,
  "geo_source": "none",
  "unavailable_reason": "country_unresolved"
}

Errors

This endpoint does not return a 4xx for an unsupported or unresolved region — it answers with eligible: false. The unified envelope (with an X-Request-Id response header) applies only to the cases below. Branch on code/type/statusCode, not on the free-form message.

{
  "type": "unauthorized",
  "code": "unauthorized",
  "message": "Example auth error using fake data.",
  "request_id": "req_test_000000000123",
  "doc_url": null,
  "statusCode": 401
}

Related pages

Public boundary

This reference covers partner-scoped capability discovery. Internal operations, administrative routes, settlement venues and providers, and unsupported availability claims are outside the public API contract.