Skip to main content
POST
/
accounts
Creates an account for the user e.g. a Xero account
curl --request POST \
  --url https://api.sandbox.goteal.co/accounts \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "user_id": "95a0e70b-fe02-4f47-aef9-2efff279df71",
  "payroll_provider": "quickbooks",
  "user_name": "john.smith@company.com",
  "password": "very-secret-password",
  "extra_login_params": {
    "company_name": "ACME Corp"
  }
}
'
{
  "account_id": "95a0e70b-fe02-4f47-aef9-2efff279df71",
  "payroll_provider": "quickbooks",
  "user_name": "john.smith@company.com",
  "created_at": "2019-05-17T00:00:00.000Z",
  "status": "PENDING",
  "mfa_enabled": true,
  "latest_pay_date": "2019-05-17T00:00:00.000Z",
  "authorization_url": "https://provider/authenticate?redirect_url=https://api.teal.com/auth&state=state&scope=read",
  "mfa_method": {
    "type": "Code",
    "source": "AUTHENTICATOR_APP"
  }
}
This endpoint requires a valid authorisation for the user. If no active authorisation exists, the request will be rejected. You can optionally pass the x-teal-authorisation-id header to specify which authorisation to use; otherwise the system will resolve a valid authorisation automatically. See Authorisations for more details.

Authorizations

​
X-API-KEY
string
header
required

Headers

​
x-teal-authorisation-id
string<uuid>

Optional authorisation ID to associate with this request. If not provided, the system will attempt to resolve a valid authorisation for the user automatically.

Example:

"7f3b8c2a-1d4e-5f6g-7h8i-9j0k1l2m3n4o"

Body

application/json
​
user_id
string
required

The id of the user

Example:

"95a0e70b-fe02-4f47-aef9-2efff279df71"

​
payroll_provider
string
required

The payroll provider to use

Example:

"quickbooks"

​
user_name
string

The login of the user

Example:

"john.smith@company.com"

​
password
string

The password of the user

Example:

"very-secret-password"

​
extra_login_params
object

Optional extra login parameters required by some providers. Dayforce connections require extra_login_params.company_name.

Example:
{ "company_name": "ACME Corp" }

Response

Created

​
account_id
string
required

The id of the account

Example:

"95a0e70b-fe02-4f47-aef9-2efff279df71"

​
payroll_provider
string
required

The payroll provider to use

Example:

"quickbooks"

​
user_name
string
required

The login of the user

Example:

"john.smith@company.com"

​
created_at
string<date-time>
required
Example:

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

​
status
string

Status of account

Example:

"PENDING"

​
mfa_enabled
boolean

Is mfa enabled for this account

​
latest_pay_date
string<date-time>

The latest pay date of the payroll under this account

Example:

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

​
authorization_url
string

Authrorization url for provider using OAUTH2

Example:

"https://provider/authenticate?redirect_url=https://api.teal.com/auth&state=state&scope=read"

​
mfa_method
object
Example:
{
  "type": "Code",
  "source": "AUTHENTICATOR_APP"
}