Accounts

Lookup Account

Changed on

Resolve a user UUID to its credit wallet, creating it on first sight.

Get-or-create, so a brand-new user always has a uuid to submit with. A created account starts at zero credits — exactly the account POST /videos would have provisioned — so can_upload is false until credits are bought.

user_id is the canonical billing key. Email and org_id remain supported only as legacy lookup inputs.

post/api/v1/accounts/lookup

Request

  • Base URL
    https://developer.preciser.io
  • URL
    https://developer.preciser.io/api/v1/accounts/lookup
  • Auth
    none declared. Required headers: x-api-key, League

Headers

x-api-keystring required

Required API key issued by Preciser.

Leaguestring required

Required tenant/database selector, for example pitchbio-master.

Request body

OR
OR

Response

Successful Response

user_idstring required

User UUID — send this as user_id on POST /videos and in the JWT

org_idstring nullable

Deprecated wallet-id alias retained for legacy clients

org_namestring required

Legacy account handle; normally blank for user-id wallets

video_quotainteger required

Credits ever granted to this account

video_usageinteger required

Credits finalized and already spent

video_reservedinteger required

Credits temporarily held by videos awaiting game info; these are not spent yet but are unavailable to another concurrent upload

remaininginteger required

Unspent and unreserved credits left (never negative)

can_uploadboolean required

False means the next POST /videos returns payment_required — send the user to the purchase page first

return_urlstring nullable

HTTPS return URL bound to the requested user and video UUID, if one was supplied with POST /videos.

Changes

  • 9b0abde08b06Revision changes
    • breaking

      the header request parameter League became required

    • breaking

      the header request parameter x-api-key became required

    • breaking

      header request parameter League list-of-types was narrowed by removing types null

    • breaking

      header request parameter x-api-key list-of-types was narrowed by removing types null

    • info

      for the header request parameter League, the type was generalized from no type to string

    • info

      for the header request parameter x-api-key, the type was generalized from no type to string

  • edd51549cfb6Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status