NAnamsor
admin

Read API Key info.

Changed on
get/api2/json/apiKeyInfo

Request

  • Base URL
    https://v2.namsor.com/NamSorAPIv2
  • Auth
    API key in header X-API-KEY

Response

Read API Key (uncached, i.e. DB read)

apiKeystring

The user API Key.

userIdstring

The user identifier.

adminboolean

The API Key has admin role.

vettedboolean

The API Key is vetted (assumed truthful) for machine learning.

learnableboolean

The API Key is learnable (without assuming truthfulness) for machine learning. Set learnable=false and anonymized=true for highest privacy (ie. to forget data as it's processed).

anonymizedboolean

The API Key is anonymized (using SHA-252 digest for logging). Set learnable=false and anonymized=true for highest privacy (ie. to forget data as it's processed).

partnerboolean

The API Key has partner role.

stripedboolean

The API Key is associated to a valid Stripe account.

corporateboolean

The API Key has role corporate (ex SWIFT payments instead of Stripe payments).

disabledboolean

The API Key is temporarily or permanently disabled.

explainableboolean

The API Key supports the AI explainability option (may require a specific license).

duplicateNamesRatiointeger

The duplicateNamesRatio = 0 ou 10 ou 20.

ipAddressstring

Changes

  • 6297d39b756dRevision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • c084be2dba5aRevision changes
    • info

      endpoint added