> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.finput.com.au/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.finput.com.au/_mcp/server.

# Mint an API token

POST https://api.finput.com.au/api/v1/api-tokens
Content-Type: application/json

Creates a bearer token for scripting the API without a browser
session. Send it as `Authorization: Bearer <token>`.

**The response is the only time the secret is shown.** Store it
immediately; if it is lost, revoke the token and mint another.

A token can never do more than its owner could through the UI: a
`read_write` token is bounded by the intersection with the owner's
own permissions. A token is only accepted by the environment
that issued it.

Reference: https://docs.finput.com.au/api/endpoints/api-tokens/create-api-token

## Authentication

- `Authorization` header (bearer token, required) — JWT access token obtained from `POST /api/v1/auth/login`, or a `finput_sk_...` API token

## Request

### Body (application/json)

This endpoint expects an object.

- `name` (string, required)
- `scope` (enum, required) — `read` allows every `GET`, plus the five computation endpoints: `POST /calculator`, `/calculator/recalculate`, `/calculator/abn-lookup`, `/matrix/` and `/matrix-calculator/`. Running those still consumes daily calculator/Matrix allowance and adds to the caller's own recents; what `read` prevents is changing data another request reads back, saved scenarios included. `read_write` additionally allows mutations. Both are bounded by the owner's own permissions — a token can never exceed what its owner could do in the UI.
  - Allowed values: `read`, `read_write`
- `expires_in_days` (enum, required)
  - Allowed values: `30`, `60`, `90`, `365`

## Response

### 201

Created — carries the secret, once

- `id` (integer, optional)
- `name` (string, optional)
- `token_id` (string, optional) — Public identifier, safe to log.
- `last_four` (string, optional) — Last four characters, for recognising a token in a list.
- `scope` (enum, optional) — `read` allows every `GET`, plus the five computation endpoints: `POST /calculator`, `/calculator/recalculate`, `/calculator/abn-lookup`, `/matrix/` and `/matrix-calculator/`. Running those still consumes daily calculator/Matrix allowance and adds to the caller's own recents; what `read` prevents is changing data another request reads back, saved scenarios included. `read_write` additionally allows mutations. Both are bounded by the owner's own permissions — a token can never exceed what its owner could do in the UI.
  - Allowed values: `read`, `read_write`
- `environment` (enum, optional) — The environment this token was minted in. A token is only accepted by the environment that issued it.
  - Allowed values: `local`, `qa`, `stage`, `prod`
- `origin` (enum, optional) — How the token was created: `ui` from Settings, `mcp` by approving an AI assistant's connection request. Read-only — it cannot be set at mint time, and only `mcp` tokens are accepted at `POST /mcp`.
  - Allowed values: `ui`, `mcp`
- `created_at` (datetime, optional)
- `expires_at` (datetime, optional)
- `last_used_at` (datetime, optional, nullable)
- `revoked_at` (datetime, optional, nullable)
- `token` (string, optional) — The secret. Shown once, at creation, and never again.
- `warning` (string, optional)

## Errors

### 400 Bad Request Error

Validation error, or the 20-active-token limit is already reached.

- `error` (string, optional)
- `errors` (map from string to list of string, optional)

## Examples

**Request**

```json
{
  "name": "Matrix data entry",
  "scope": "read",
  "expires_in_days": 30
}
```

**Response**

```json
{
  "id": 1,
  "name": "string",
  "token_id": "string",
  "last_four": "string",
  "scope": "read",
  "environment": "local",
  "origin": "ui",
  "created_at": "2024-01-15T09:30:00Z",
  "expires_at": "2024-01-15T09:30:00Z",
  "last_used_at": "2024-01-15T09:30:00Z",
  "revoked_at": "2024-01-15T09:30:00Z",
  "token": "string",
  "warning": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.finput.com.au/api/v1/api-tokens"

payload = {
    "name": "Matrix data entry",
    "scope": "read",
    "expires_in_days": 30
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.finput.com.au/api/v1/api-tokens';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"Matrix data entry","scope":"read","expires_in_days":30}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.finput.com.au/api/v1/api-tokens"

	payload := strings.NewReader("{\n  \"name\": \"Matrix data entry\",\n  \"scope\": \"read\",\n  \"expires_in_days\": 30\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.finput.com.au/api/v1/api-tokens")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Matrix data entry\",\n  \"scope\": \"read\",\n  \"expires_in_days\": 30\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.finput.com.au/api/v1/api-tokens")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Matrix data entry\",\n  \"scope\": \"read\",\n  \"expires_in_days\": 30\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.finput.com.au/api/v1/api-tokens', [
  'body' => '{
  "name": "Matrix data entry",
  "scope": "read",
  "expires_in_days": 30
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.finput.com.au/api/v1/api-tokens");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Matrix data entry\",\n  \"scope\": \"read\",\n  \"expires_in_days\": 30\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "Matrix data entry",
  "scope": "read",
  "expires_in_days": 30
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.finput.com.au/api/v1/api-tokens")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```