Skip to main content
POST
/
authorisations
/
terms
Creates a new authorisation term.
curl --request POST \
  --url https://api.sandbox.goteal.co/authorisations/terms \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "Data Sharing Agreement",
  "authorisation_text": "I agree to share my payroll data with the lender for the purpose of income verification.",
  "authorisation_category": "one_time",
  "deactivate_previous": true
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "is_active": true,
  "is_system_term": false,
  "authorisation_version": 1,
  "created_at": "2019-05-17T00:00:00.000Z",
  "name": "Data Sharing Agreement",
  "authorisation_text": "I agree to share my payroll data with the lender for the purpose of income verification.",
  "authorisation_category": "one_time"
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
name
string
required

Human-readable name for the authorisation term

Example:

"Data Sharing Agreement"

​
authorisation_text
string
required

The legal authorisation text that users will accept

Example:

"I agree to share my payroll data with the lender for the purpose of income verification."

​
authorisation_category
enum<string>
required

The category of authorisation

Available options:
one_time,
recurring
Example:

"one_time"

​
deactivate_previous
boolean
default:false

If true, deactivates any existing active term for the same category. Defaults to false.

Example:

true

Response

Created

​
id
string<uuid>
required

Unique identifier for the authorisation term

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
is_active
boolean
default:true
required

Whether this authorisation term is currently active and can be accepted

Example:

true

​
is_system_term
boolean
required

True for Teal's default terms, false for client-created terms

Example:

false

​
authorisation_version
integer<int32>
required

Auto-incremented version number for the authorisation term

Example:

1

​
created_at
string<date-time>
required

When the authorisation term was created

Example:

"2019-05-17T00:00:00.000Z"

​
name
string
required

Human-readable name for the authorisation term

Example:

"Data Sharing Agreement"

​
authorisation_text
string
required

The legal authorisation text that users will accept

Example:

"I agree to share my payroll data with the lender for the purpose of income verification."

​
authorisation_category
enum<string>
required

The category of authorisation

Available options:
one_time,
recurring
Example:

"one_time"