Skip to main content
POST
/
users
Creates a user.
curl --request POST \
  --url https://api.sandbox.goteal.co/users \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "forename": "John",
  "surname": "Smith",
  "date_of_birth": "2019-05-17T00:00:00.000Z",
  "post_codes": [
    "SW1A 1AA",
    "SW1A 1AB"
  ],
  "payroll_period_months": 123,
  "middle_names": "Smith",
  "ni_number": "QQ123456C",
  "ext_id": "ext-12345",
  "recurring_checks_enabled": true,
  "recurring_check_frequency": "WEEKLY",
  "recurring_check_end_date": "2019-05-17T00:00:00.000Z",
  "payslip_upload_enabled": true,
  "payroll_connections_enabled": true
}
'
{
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2019-05-17T00:00:00.000Z",
  "forename": "John",
  "surname": "Smith",
  "date_of_birth": "2019-05-17T00:00:00.000Z",
  "post_codes": [
    "SW1A 1AA",
    "SW1A 1AB"
  ],
  "payroll_period_months": 123,
  "middle_names": "Smith",
  "ni_number": "QQ123456C",
  "ext_id": "ext-12345",
  "recurring_checks_enabled": true,
  "recurring_check_frequency": "WEEKLY",
  "recurring_check_end_date": "2019-05-17T00:00:00.000Z",
  "payslip_upload_enabled": true,
  "payroll_connections_enabled": true
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
forename
string
required

Forename of the user.

Example:

"John"

​
surname
string
required

Surname of the user.

Example:

"Smith"

​
date_of_birth
string<date-time>
required

Date of birth of the user. Used for direct connections.

Example:

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

​
post_codes
string[]
required

One or more post codes of the user over the period of the check. Used for direct connections where we need to verify payroll data matches the user given current and past post codes.

Example:
["SW1A 1AA", "SW1A 1AB"]
​
payroll_period_months
integer<int32>
required

Lookback period of the payroll to search on account creation. Overrides the same setting if present in client level configuration.

​
middle_names
string

Middle names of the user.

Example:

"Smith"

​
ni_number
string

National Insurance number of the user. Used for direct connections.

Example:

"QQ123456C"

​
ext_id
string | null

External ID or any string there might be a need for saving alongside the User information. This is an optional identifier that can be used to reference the user in external systems.

Example:

"ext-12345"

​
recurring_checks_enabled
boolean

Determines if recurring checks are enabled for this user. Overrides the same setting if present in client level configuration.

​
recurring_check_frequency
string

Frequency of the recurring check for this user. Overrides the same setting if present in client level configuration. Available frequencies in production are [WEEKLY, DAILY]. Sandbox allows HOURLY frequency in addition.

Example:

"WEEKLY"

​
recurring_check_end_date
string<date-time>

End date of the recurring check schedule. Overrides the same setting if present in client level configuration.

Example:

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

​
payslip_upload_enabled
boolean

Determines if payslip upload is enabled for this user. Overrides the same setting if present in client level configuration.

​
payroll_connections_enabled
boolean

Determines if payroll connections feature is enabled for this user. Overrides the same setting if present in client level configuration.

Response

Created

​
user_id
string<uuid>
required

Unique identifier for user

​
created_at
string<date-time>
required

Creation time in UTC of the user

Example:

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

​
forename
string
required

Forename of the user.

Example:

"John"

​
surname
string
required

Surname of the user.

Example:

"Smith"

​
date_of_birth
string<date-time>
required

Date of birth of the user. Used for direct connections.

Example:

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

​
post_codes
string[]
required

One or more post codes of the user over the period of the check. Used for direct connections where we need to verify payroll data matches the user given current and past post codes.

Example:
["SW1A 1AA", "SW1A 1AB"]
​
payroll_period_months
integer<int32>
required

Lookback period of the payroll to search on account creation. Overrides the same setting if present in client level configuration.

​
middle_names
string

Middle names of the user.

Example:

"Smith"

​
ni_number
string

National Insurance number of the user. Used for direct connections.

Example:

"QQ123456C"

​
ext_id
string | null

External ID or any string there might be a need for saving alongside the User information. This is an optional identifier that can be used to reference the user in external systems.

Example:

"ext-12345"

​
recurring_checks_enabled
boolean

Determines if recurring checks are enabled for this user. Overrides the same setting if present in client level configuration.

​
recurring_check_frequency
string

Frequency of the recurring check for this user. Overrides the same setting if present in client level configuration. Available frequencies in production are [WEEKLY, DAILY]. Sandbox allows HOURLY frequency in addition.

Example:

"WEEKLY"

​
recurring_check_end_date
string<date-time>

End date of the recurring check schedule. Overrides the same setting if present in client level configuration.

Example:

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

​
payslip_upload_enabled
boolean

Determines if payslip upload is enabled for this user. Overrides the same setting if present in client level configuration.

​
payroll_connections_enabled
boolean

Determines if payroll connections feature is enabled for this user. Overrides the same setting if present in client level configuration.