Verify Tenant

1 min

GET

https://api.upstartcommerce.com/v1/tenants/{tenantId}/verify

This endpoint verifies a new tenant using the verification code sent via email. This must be called after tenant creation to activate the tenant.

Authorized permissions:

None required (public endpoint for verification)

Path Parameters

tenantIdstringrequired
Description
Unique identifier for a given tenant.

Query Parameters

codestringrequired
Description
The code to verify the tenant with.

Responses

202

Success-verified tenant.

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

ValidationErrorResponse
Example
```
{
  "name": "ValidationError",
  "code": "INVALID_EMAIL_FORMAT",
  "detail": "The email field must be a valid email address. Received: \"invalid-email\""
}
```
Description
Error response returned when request validation fails (HTTP 400). Contains details about which fields failed validation and why. Used for client-side error display and form validation feedback.
- namestringrequired
  Example
  ValidationError
  Description
  The error type, typically 'ValidationError' for all validation failures. Use this to distinguish validation errors from other error types in your error handling logic.
- codestringrequired
  Example
  INVALID_EMAIL_FORMAT
  Description
  A validation-specific error code indicating the validation rule that failed. Examples include 'REQUIRED_FIELD_MISSING', 'INVALID_FORMAT', 'VALUE_OUT_OF_RANGE', 'DUPLICATE_VALUE'. Use for specific handling of different validation scenarios.
- detailstring
  Example
  The email field must be a valid email address. Received: "invalid-email"
  Description
  Human-readable validation error message describing which field(s) failed and why. Should be specific enough for developers to fix the issue. May include field paths for nested objects (e.g., 'sites[0].url is not a valid domain').

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

UnauthorizedError
Example
```
{
  "name": "AuthorizationError",
  "code": "INSUFFICIENT_PERMISSIONS",
  "detail": "User does not have the required tenant.create permission to perform this operation.",
  "reason": "Your access token does not include the necessary permissions. Contact your administrator to request access."
}
```
Description
Returned when credentials are missing, expired or insufficient (HTTP 401).
- namestringrequired
  Description
  The high-level error category or type name.
- codestringrequired
  Description
  A specific error code identifying the exact error condition.
- detailstring
  Description
  A human-readable description of what went wrong.
- reasonstring
  Description
  Optional additional context or suggested resolution.

404The requested resource was not found in the NoChannel system.

NotFoundError
Example
```
{
  "name": "ResourceNotFoundError",
  "code": "TENANT_NOT_FOUND",
  "detail": "The tenant with ID \"acme001\" was not found in the system.",
  "reason": "The tenant may have been deleted or you may not have permission to access it. Verify the tenant ID and your access rights."
}
```
Description
Returned when the requested resource does not exist (HTTP 404).
- namestringrequired
  Description
  The high-level error category or type name.
- codestringrequired
  Description
  A specific error code identifying the exact error condition.
- detailstring
  Description
  A human-readable description of what went wrong.
- reasonstring
  Description
  Optional additional context or suggested resolution.

422

The request was well-formed but contains semantic errors or violates business rules that prevent processing.

UnprocessableEntityError
Example
```
{
  "name": "UnprocessableEntityError",
  "code": "INVALID_SITE_CONFIGURATION",
  "detail": "The deactivationDate must be after the activationDate.",
  "reason": "A site cannot be deactivated before it is activated. Please adjust the dates so that deactivation occurs after activation."
}
```
Description
Returned when the request is well-formed but violates business rules (HTTP 422).
- namestringrequired
  Description
  The high-level error category or type name.
- codestringrequired
  Description
  A specific error code identifying the exact error condition.
- detailstring
  Description
  A human-readable description of what went wrong.
- reasonstring
  Description
  Optional additional context or suggested resolution.

500

An unexpected internal server error occurred. The request may be retried, and if the problem persists, contact support with the traceId from the error response.

InternalServerError
Example
```
{
  "name": "InternalServerError",
  "code": "UNEXPECTED_ERROR",
  "detail": "An unexpected error occurred while processing your request.",
  "reason": "Our team has been notified. Please try again, and if the problem persists, contact support with trace ID: 550e8400-e29b-41d4-a716-446655440000"
}
```
Description
Returned for an unexpected server-side failure (HTTP 500).
- namestringrequired
  Description
  The high-level error category or type name.
- codestringrequired
  Description
  A specific error code identifying the exact error condition.
- detailstring
  Description
  A human-readable description of what went wrong.
- reasonstring
  Description
  Optional additional context or suggested resolution.

503

A downstream dependency was unavailable, so the request could not be authorized or completed. The request may be retried.

ServiceUnavailableError
Example
```
{
  "name": "Service Unavailable",
  "code": "UNKNOWN",
  "detail": "Permission resolution is unavailable, please retry",
  "reason": "A dependency required to authorize this request is temporarily unreachable. Please retry shortly."
}
```
Description
Returned when a downstream dependency this request needed is unavailable (HTTP 503).

Distinct from 401: the caller's credentials are fine. The service could not resolve the permissions required to authorize the request, so the outcome is unknown rather than denied. The request may be retried.
- namestringrequired
  Description
  The high-level error category or type name.
- codestringrequired
  Description
  A specific error code identifying the exact error condition.
- detailstring
  Description
  A human-readable description of what went wrong.
- reasonstring
  Description
  Optional additional context or suggested resolution.

curl

curl --request GET \
     --url 'https://api.upstartcommerce.com/v1/tenants/{tenantId}/verify?code=string' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.upstartcommerce.com/v1/tenants/{tenantId}/verify?code=string", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.upstartcommerce.com/v1/tenants/{tenantId}/verify?code=string")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.upstartcommerce.com/v1/tenants/{tenantId}/verify?code=string"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

202

// Success-verified tenant.

400

// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.
{
  "name": "ValidationError",
  "code": "INVALID_EMAIL_FORMAT",
  "detail": "The email field must be a valid email address. Received: \"invalid-email\""
}

401

// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}

404

// The requested resource was not found in the NoChannel system.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}

422

// The request was well-formed but contains semantic errors or violates business rules that prevent processing.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}

500

// An unexpected internal server error occurred. The request may be retried, and if the problem persists, contact support with the traceId from the error response.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}

503

// A downstream dependency was unavailable, so the request could not be authorized or completed. The request may be retried.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}