Skip to main content
References

Error Codes

Error codes returned by the API

Overview​

Carta's API uses HTTP response status codes to indicate a success or failure.

  • 2xx status codes indicates that your request was accepted and processed successfully.
  • 4xx status codes indicate that something related to your request caused a problem (e.g., a missing header, an incorrect parameter, etc.).
  • 5xx status codes indicate that an unexpected error occurred with Carta's server.

200 OK​

Carta successfully processed your request.

400 Bad Request​

Our server did not understand your request. This might happen due to bad syntax or headers not being set correctly.

401 Unauthorized​

The request is missing or has invalid authentication credentials.

Reason codes​

MISSING_OR_INVALID_ACCESS_TOKEN - The access token is missing, expired, revoked, malformed, or invalid.

{
    "code": 16,
    "message": "Unauthorized",
    "details": [
        {
            "@type": "type.googleapis.com/carta.proto.publicapi.errors.v1alpha1.ErrorInfo",
            "reason": "MISSING_OR_INVALID_ACCESS_TOKEN",
            "metadata": {}
        }
    ]
}

403 Forbidden​

The access_token you provided does not have the appropriate permission to access the resource you requested.

Reason codes:​

INSUFFICIENT_SCOPE - Your request requires additional privileges not provided by your current access token. ACCESS_TO_RESOURCE_RESTRICTED - The Carta user who granted the access token did not grant access to the requested Issuer or Portfolio. MISSING_INTERNAL_PERMISSION - The Carta user who granted the access token does not have the appropriate permission to fulfill the request (see Permissions and Roles).

{
    "code": 7,
    "message": "Access to resource denied",
    "details": [
        {
            "@type": "type.googleapis.com/carta.proto.publicapi.errors.v1alpha1.ErrorInfo",
            "reason": "INSUFFICIENT_SCOPE",
            "metadata": {}
        }
    ]
}

404 Not Found​

The requested resource was not found.

{
    "code": 5,
    "message": "Resource not found"
}

429 Too Many Requests​

Your application has exceeded our rate limit. See our rate limiting documentation for more information.

500 Internal Server Error​

An unexpected internal server error occured with Carta's server.

{
    "code": 13,
    "message": "Internal server error"
}

503 Service Unavailable​

The server is currently unavailable. One or more of Carta's services might be experiencing an outage. Check Carta's status page for more information.

{
    "code": 14,
    "message": "Service currently unavailable"
}