Create an Access Key

An access key provides authentication to use the Taxcloud API.

Note: Currently, keys generated via the TaxCloud web app do not include the necessary scopes to interact with the Management API. To request access, contact our support team.

Request

This endpoint expects an object.

accountIdlongRequired

Id of the taxcloud account created in the access key

namestringRequired

name of the access key

audienceslist of objectsOptional

Response

apiKeystring

api key value to use as ‘X-API-KEY’ on the tax service

createdAtstringformat: "date-time"

Unix timestamp of when the record was created as RFC3339 datetime

grantslist of objects

grants of the access key

idlong

Id of the taxcloud account created in the access key

namestring

name of the access key

updatedAtstringformat: "date-time"

Unix timestamp the record was last updated as RFC3339 datetime

$schemastring or nullformat: "uri"

A URL to the JSON Schema for this object.

1	curl -X POST https://api.v3.taxcloud.com/mgmt/accesskeys \
2	-H "X-API-KEY: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"accountId": 42,
6	"name": "foo"
7	}'

1	{
2	"apiKey": "foo",
3	"createdAt": "foo",
4	"grants": [
5	{
6	"audience": "foo",
7	"id": 42,
8	"scopes": [
9	"foo"
10	]
11	}
12	],
13	"id": 42,
14	"name": "foo",
15	"updatedAt": "foo",
16	"$schema": "https://example.com/mgmt/schemas/AccessKeyResponse.json"
17	}

Create an Access Key

Headers

Request

Response

Errors