Authentication Errors

FREE Plan - Credits Exhausted

FREE plan accounts receive an error after consuming their allocated amount of free credits.

Error example:

//Error code: 403
{
    You have reached the limit of ### credits with your free plan for '####'.
    Upgrade your plan at https://co.tatum.io/3JjG5Ih
}

📘

If you get this error and have a free plan, you will need to upgrade your account - Pricing page.

Unauthenticated Request

Tatum requires users to authenticate all requests, where each request has a cost in credits.

Error example:

 url: '#####',
  status: 401,
  statusText: 'Unauthorized',
  body: {
    statusCode: 401,
    errorCode: 'ip-address-key.unauthorized',
    message: "Authentication required. Make sure your requests are authenticated with a Tatum API key. Find out how at: https://docs.tatum.io/docs/authentication. If you don't have one, get one for FREE via the Tatum Dashboard at https://dashboard.tatum.io."
  }

📘

If you have a paid plan and get this error, make sure you are authenticating your requests. Additional information is available in the following article.

Request Blocked by API Key Access Restrictions

An API key with access restrictions rejects requests from IP addresses or origins that aren't on its allowlists with a 403 Forbidden error. The x-ttm-error-reason header says why: ip_not_allowed, origin_not_allowed or origin_missing.

Error example:

//Error code: 403
{
    "statusCode": 403,
    "message": "Requests from IP address 203.0.113.7 are not allowed for this API key. Update the allowed IP addresses in the Tatum Dashboard."
}

📘

Add the request's public IP address or origin to the key's allowlists in the Tatum Dashboard, or remove the restrictions. See Troubleshooting a 403.