Skip to content
RocketVerifierDOCS
GEThttps://api.rocketverifier.com/v1/me

Get the connected account

In short

GET /v1/me returns the account the current credential acts for, whether it bills a personal or an organization account, the available credits and the scopes. OAuth access tokens also get the connected app and its monthly credit cap, and need the account:read scope. API keys can always call it, and it works at a zero balance.

OAuth scope account:read

curl https://api.rocketverifier.com/v1/me \
  -H "Authorization: Bearer $ROCKETVERIFIER_ACCESS_TOKEN"
Response 200
{
  "email": "jane@acme.com",
  "name": "Jane Doe",
  "account_type": "organization",
  "organization": { "id": "org_8f2a", "name": "Acme Inc" },
  "credits": 12400,
  "auth_type": "oauth",
  "scopes": ["verify:single", "verify:bulk", "jobs:read", "account:read"],
  "app": {
    "client_id": "rvapp_3kq9x2",
    "name": "Pengo",
    "monthly_credit_limit": 5000,
    "credits_used_this_month": 320
  }
}

Apps built on RocketVerifier Connect use this endpoint to show "Connected as jane@acme.com, 12,400 credits" right after the user approves them. With an API key, it is a quick way to check which account and scopes a key carries.

Request#

Send the credential in the Authorization header. There are no parameters.

  • OAuth access tokens (rv_at_) need the account:read scope. Without it, the call returns 403 insufficient_scope.
  • API keys can always call it, whatever their scopes.
  • Balance: works at a zero balance and costs nothing.

Response#

  • emailstring or null

    Email of the user the credential acts for (the owner, for organization keys).

  • namestring or null

    The user's name. Set for OAuth tokens.

  • account_typeenumrequired

    organization for organization API keys and for OAuth tokens that bill an organization.

    personalorganization
  • organizationobject or null

    Set when the credential bills an organization.

    › Show 2 child fields
    • idstring
    • namestring or null

      Set for OAuth tokens.

  • creditsintegerrequired

    Credits available to this credential now.

  • auth_typeenumrequired
    api_keyoauth
  • scopesarray of stringsrequired

    The scopes this credential carries.

  • appobject or null

    The OAuth app the token was issued to. Null for API keys.

    › Show 4 child fields

Read the response by credential#

The same fields describe four kinds of credential.

Credentialauth_typeaccount_typeorganizationapp
Personal API keyapi_keypersonalnullnull
Organization API keyapi_keyorganization{ "id": ... }null
OAuth token for a personal accountoauthpersonalnullThe connected app
OAuth token that bills an organizationoauthorganization{ "id", "name" }The connected app
  • email is the user the credential acts for. Organization keys act as the organization's owner.
  • credits is the balance available to this credential, the same number as GET /v1/credits. On an organization with credit pooling, it is the larger of the pool and the billed user's own balance.
  • scopes lists what the credential can call. Check it before you show features that need a scope the user did not approve.
  • app.monthly_credit_limit is the monthly cap the user set for your app, and app.credits_used_this_month is what your app used against it. A charge past the cap returns 402 api_key_spend_cap_reached.

Errors#

Statuserror.codeWhen it happens
401unauthorizedNo credential, or an invalid or revoked API key.
401api_key_expiredThe API key passed its expiry date.
401invalid_tokenThe OAuth access token expired or was revoked. Refresh it and retry once.
403insufficient_scopeThe OAuth token lacks account:read.
403ip_not_allowedThe key or organization has an IP allowlist that does not include the caller.
403account_suspendedThe account is suspended.
429rate_limitedToo many requests. Wait for the Retry-After seconds.

Every error uses the standard error shape. The authentication guide covers keys and tokens in depth.

Frequently asked questions

Does an API key need the account:read scope?

No. API keys can always call GET /v1/me. Only OAuth access tokens need account:read.

What is the difference between /v1/me and /v1/credits?

Both return the same available balance. /v1/me adds who the credential acts for and its scopes, and /v1/credits adds today's and this month's usage.

Which email does an organization API key return?

The email of the organization's owner, because organization keys act and are billed as the owner. account_type is organization and organization.id names the organization.

Updated 11 November 2026Suggest an edit