Praecise Platform
Menu

Praecise account/ Reference/ Account

Whether an address or an id is a Praecise account

get/api/accounts/lookup

For the server of a product that acts on accounts on another product's word. Authenticated with that product's own client id and secret; a person's service token or session is not accepted. Give exactly one of email and id; prefer id whenever the caller holds it. Limited to 120 calls a minute for each client, and logged.

Before you call

Credential
Authorization: Basic $KEY
Callers
Products marked for it in the account service's client list (the Praecise Cloud console).

Parameters

  • emailstring (email)
    In the query
  • idstring (uuid)
    In the query. The account's id: sub in ID tokens.

Responses

  • 200application/json
    There is such an account.
    • accountobjectrequired
      • idstring (uuid)required
        Never changes. Keep this, not the address.
      • emailstring (email)required
      • confirmedbooleanrequired
        Whether the person has shown they read that mailbox. When false, do not act for the account on the strength of the address.
  • 400application/json
    Neither or both of email and id were given, or the value is malformed.
    • errorstringrequired
      What went wrong, in a sentence.
    • detailstring
  • 401application/json
    No valid client id and secret.
    • errorstringrequired
      What went wrong, in a sentence.
    • detailstring
  • 403application/json
    This client may not look accounts up.
    • errorstringrequired
      What went wrong, in a sentence.
    • detailstring
  • 404application/json
    No Praecise account has that address, or that id.
    • errorstringrequired
      What went wrong, in a sentence.
    • detailstring
  • 429application/json
    More than 120 lookups in a minute. Retry-After says when to try again.
    • errorstringrequired
      What went wrong, in a sentence.
    • detailstring

This page as Markdown