Embedded Tax API

Base URL

Every endpoint below is served from this host. Call it from your backend, never from a browser.

https://api.awaken.tax/api

Authentication

Send your client ID and API secret as headers on every request. If you do not have a secret yet, ask us and we will issue one.

The Hosted Portal is the exception: it runs in your user's browser and authenticates with a short-lived access token instead, which you mint from your backend. See Access tokens.

-H "x-client-id: $AWAKEN_CLIENT_ID" \
-H "x-api-secret: $AWAKEN_API_SECRET"

Response shape

JSON endpoints use the same envelope. Successful calls carry a data payload; failures carry a message explaining why.

Report downloads are the exception: they return the report file itself with its own content type, not this envelope, so read them as bytes rather than decoding them as JSON.

{
  "type": "success",
  "message": "Reports retrieved successfully",
  "data": []
}

OpenAPI 3.1 contract

Endpoint pages are generated from openapi/partners.yaml. Request and response details reflect the current Express handlers; a route-census check prevents registered routes from being omitted.