Skip to main content
POST
/
v1
/
api
/
tenant
/
register-tenant
Register tenant to Upsolve
curl --request POST \
  --url 'https://api.upsolve.ai/v1/api/tenant/register-tenant?apiKey=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "apiKey": "<string>",
  "displayName": "<string>",
  "prefilters": {}
}
'
{
  "status": "success",
  "data": {
    "message": "Tenant Google Inc registered.",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7InBhcmVudE9yZ0lkIjoiYWJkZTZmMjQtYWYwZi00Zjg3LWI4NzEtNzk0NGIyYzhjM2IzIiwiZGlzcGxheU5hbWUiOiJEZW1vIChBZG1pbikiLCJwYXlsb2FkIjp7fX0sImlhdCI6MTcwOTI2NTcyOSwiZXhwIjoxNzA5MjY5MzI5fQ.nfMwGbPe7zwCwlky079PVjA-ox0G2OtTuFo_0MXoLCE"
  }
}

Authorizations

​
apiKey
string
query
required

apiKey MUST be supplied within the request body instead of query

Body

application/json

POST /v1/api/tenant/register-tenant Request body

​
apiKey
string
required

Upsolve API key, generated in the Deploy tab of the Upsolve Hub.

Minimum string length: 1
Example:

"up_embed_************"

​
displayName
string
required

Display name for this user. This will appear in the Upsolve Hub.

Example:

"Google Inc"

​
prefilters
object
required
Example:
{
  "company_id": "company-google",
  "company_class": "tech"
}

Response

POST /v1/api/tenant/register-tenant Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required
Example:
{
  "message": "Tenant Google Inc registered.",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7InBhcmVudE9yZ0lkIjoiYWJkZTZmMjQtYWYwZi00Zjg3LWI4NzEtNzk0NGIyYzhjM2IzIiwiZGlzcGxheU5hbWUiOiJEZW1vIChBZG1pbikiLCJwYXlsb2FkIjp7fX0sImlhdCI6MTcwOTI2NTcyOSwiZXhwIjoxNzA5MjY5MzI5fQ.nfMwGbPe7zwCwlky079PVjA-ox0G2OtTuFo_0MXoLCE"
}