Developers

Identity

Describe the calling API key (no scope required)

GET/me
Authentication
ApiKeyAuth
Execution
synchronous

Responses

The key, its scopes and rate-limit policy.

Headers

  • X-Request-Idstring
    The client's X-Request-Id if supplied, otherwise a server-generated id. Equals traceId in problems.
  • RateLimit-Limitinteger
  • RateLimit-Remaininginteger
  • RateLimit-Resetinteger
    Seconds until the window resets.

Schema application/json

  • objectstringrequired

    Allowed values: api_key

  • apiKeyobjectrequired
    The calling key. Keys have no separate id; prefix + last4 identify one in the portal.
    • prefixstring

      Example: nbm_live_3f9a

    • last4stringrequired
    • namestringrequired
      The label given in the portal.
    • createdAtstring (date-time)required
      RFC 3339, UTC, with millisecond precision.

      Example: 2026-09-18T10:15:30.123Z

  • merchantIdstring (uuid)required
    A uuid (time-ordered, UUIDv7) — the id of something the portal owns: your merchant, a saved recipient. A resource of this API has a prefixed id instead (pay_…, fx_…, evt_…, txn_…, acc_…).

    Example: 019985c2-4a6e-7c3b-9f10-2d5e8a1b3c4d

  • merchantNamestringrequired
  • merchantNumberstring
    Your public merchant number — what another business sends a transfer to. Absent until assigned.

    pattern ^[0-9]{10}$

  • environmentstringrequired

    Allowed values: sandboxlive

  • scopesarray<string>required
    Always expanded — a wildcard grant is reported as the full list it covers. sandbox:write is reported only in the sandbox, the only environment with endpoints that need it.
  • rateLimitobjectrequired
    • requestsPerMinuteintegerrequired
  • ipAllowlistarray<string>required