Get current tenant information

Request

Context-aware endpoint for retrieving your own tenant information.

REQUIREMENTS:

Header: x-project-key (project identification)
Optional: Authorization Bearer token (for full access)

RETURNS:

With API Key only: Public tenant information
With Tenant JWT: Full tenant information including allowedTokenIssuers and sensitive config

Security

authJWT or projectKey

curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/tenants/me \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Current tenant information retrieved successfully

Bodyapplication/json

projectNamestringrequired

Name of the tenant.

acronymstringrequired

Acronym of the tenant.

idstringrequired

Unique identifier for tenant. This id is used to identify tenant in the system for client requests.

createdAtstring, (date-time)required

Date when tenant was created.

projectDescriptionstring

Description of the tenant.

projectWebsitestring

Website of the tenant.

projectEmailstring

Email of the tenant.

projectImageUrlstring

Image URL of the tenant.

projectLogoUrlstring

Logo URL of the tenant.

projectApiKeystringrequired

Unique identifier for tenant. This id is used to identify tenant in the system for client requests.

testnetProjectApiKeystringrequired

Testnet project API key for tenant. Used in case of testnet project.

stripeApiKeystring

Stripe API key for tenant (masked). Used in case of stripe payment.

Example:"sk_...a1b2"

stripeWebhookSecretstring

Stripe webhook secret for tenant (masked). Used in case of stripe payment.

Example:"whsec_...x9y0"

loginTokenstring

This is an optional field for any extra login requirements for your users.

allowJWTForUnauthenticatedUsersbooleanrequired

This is an optional field for any extra login requirements for your users.

firebaseTenantIdstring

defaultWalletManagementTypestring or null

Default wallet management type for this tenant. When set, overrides chain-type-based derivation. Fallback chain: explicit → tenant default → chain type.

Enum:"custodial""non-custodial"

ipfsGatewayDomainstringrequired

IPFS Gateway Domain for the tenant. Used for resolving IPFS URIs to HTTP URLs.

Default:"pers.mypinata.cloud"

Example:"pers.mypinata.cloud"

googleApiKeystring

Google API Key for the tenant. Used for Google services integration.

allowedTokenIssuersArray of objects(ExternalTokenIssuerConfigDTO)

List of allowed external JWT token issuers for this tenant.

emailConfigobject(EmailConfigDTO)

Unified email configuration - provider, credentials, sender info, and templates

approvalSettingsobject

Per-entity approval requirements. When true, newly created entities of that type will start in pending_approval state and must be approved by a tenant admin before becoming active.

Example:

{
  "business": false,
  "tokenMetadata": false,
  "campaign": false,
  "redemption": false
}

defaultBusinessCapabilitiesobject

Per-tenant defaults applied to newly created businesses (capability flags are admin/toggle-only, not settable via business create/update requests).

Example:

{
  "canMintToken": true,
  "canChargeToken": true,
  "canManageUsers": true,
  "canReceiveDonation": false
}

Response

{
  "projectName": "string",
  "acronym": "string",
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "projectDescription": "string",
  "projectWebsite": "string",
  "projectEmail": "string",
  "projectImageUrl": "string",
  "projectLogoUrl": "string",
  "projectApiKey": "string",
  "testnetProjectApiKey": "string",
  "stripeApiKey": "sk_...a1b2",
  "stripeWebhookSecret": "whsec_...x9y0",
  "loginToken": "string",
  "allowJWTForUnauthenticatedUsers": true,
  "firebaseTenantId": "string",
  "defaultWalletManagementType": "custodial",
  "ipfsGatewayDomain": "pers.mypinata.cloud",
  "googleApiKey": "string",
  "allowedTokenIssuers": [
    { … }
  ],
  "emailConfig": {
    "provider": "sendgrid",
    "fromEmail": "noreply@tenant.com",
    "fromName": "Tenant Name",
    "templates": { … },
    "apiKey": "...a1b2",
    "apiSecret": "...x9y8"
  },
  "approvalSettings": {
    "business": false,
    "tokenMetadata": false,
    "campaign": false,
    "redemption": false
  },
  "defaultBusinessCapabilities": {
    "canMintToken": true,
    "canChargeToken": true,
    "canManageUsers": true,
    "canReceiveDonation": false
  }
}