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": 36,
"ni_number": "QQ123456C",
"ext_id": "ext-12345",
"recurring_checks_enabled": true,
"recurring_check_frequency": "WEEKLY",
"recurring_check_end_date": "2050-01-01T00:00:00.000Z",
"hmrc_enabled": false,
"payslip_upload_enabled": true,
"payroll_connections_enabled": true
}
'import requests
url = "https://api.sandbox.goteal.co/users"
payload = {
"forename": "John",
"surname": "Smith",
"date_of_birth": "2019-05-17T00:00:00.000Z",
"post_codes": ["SW1A 1AA", "SW1A 1AB"],
"payroll_period_months": 36,
"ni_number": "QQ123456C",
"ext_id": "ext-12345",
"recurring_checks_enabled": True,
"recurring_check_frequency": "WEEKLY",
"recurring_check_end_date": "2050-01-01T00:00:00.000Z",
"hmrc_enabled": False,
"payslip_upload_enabled": True,
"payroll_connections_enabled": True
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
forename: 'John',
surname: 'Smith',
date_of_birth: '2019-05-17T00:00:00.000Z',
post_codes: ['SW1A 1AA', 'SW1A 1AB'],
payroll_period_months: 36,
ni_number: 'QQ123456C',
ext_id: 'ext-12345',
recurring_checks_enabled: true,
recurring_check_frequency: 'WEEKLY',
recurring_check_end_date: '2050-01-01T00:00:00.000Z',
hmrc_enabled: false,
payslip_upload_enabled: true,
payroll_connections_enabled: true
})
};
fetch('https://api.sandbox.goteal.co/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.goteal.co/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'forename' => 'John',
'surname' => 'Smith',
'date_of_birth' => '2019-05-17T00:00:00.000Z',
'post_codes' => [
'SW1A 1AA',
'SW1A 1AB'
],
'payroll_period_months' => 36,
'ni_number' => 'QQ123456C',
'ext_id' => 'ext-12345',
'recurring_checks_enabled' => true,
'recurring_check_frequency' => 'WEEKLY',
'recurring_check_end_date' => '2050-01-01T00:00:00.000Z',
'hmrc_enabled' => false,
'payslip_upload_enabled' => true,
'payroll_connections_enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.goteal.co/users"
payload := strings.NewReader("{\n \"forename\": \"John\",\n \"surname\": \"Smith\",\n \"date_of_birth\": \"2019-05-17T00:00:00.000Z\",\n \"post_codes\": [\n \"SW1A 1AA\",\n \"SW1A 1AB\"\n ],\n \"payroll_period_months\": 36,\n \"ni_number\": \"QQ123456C\",\n \"ext_id\": \"ext-12345\",\n \"recurring_checks_enabled\": true,\n \"recurring_check_frequency\": \"WEEKLY\",\n \"recurring_check_end_date\": \"2050-01-01T00:00:00.000Z\",\n \"hmrc_enabled\": false,\n \"payslip_upload_enabled\": true,\n \"payroll_connections_enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.goteal.co/users")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"forename\": \"John\",\n \"surname\": \"Smith\",\n \"date_of_birth\": \"2019-05-17T00:00:00.000Z\",\n \"post_codes\": [\n \"SW1A 1AA\",\n \"SW1A 1AB\"\n ],\n \"payroll_period_months\": 36,\n \"ni_number\": \"QQ123456C\",\n \"ext_id\": \"ext-12345\",\n \"recurring_checks_enabled\": true,\n \"recurring_check_frequency\": \"WEEKLY\",\n \"recurring_check_end_date\": \"2050-01-01T00:00:00.000Z\",\n \"hmrc_enabled\": false,\n \"payslip_upload_enabled\": true,\n \"payroll_connections_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.goteal.co/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"forename\": \"John\",\n \"surname\": \"Smith\",\n \"date_of_birth\": \"2019-05-17T00:00:00.000Z\",\n \"post_codes\": [\n \"SW1A 1AA\",\n \"SW1A 1AB\"\n ],\n \"payroll_period_months\": 36,\n \"ni_number\": \"QQ123456C\",\n \"ext_id\": \"ext-12345\",\n \"recurring_checks_enabled\": true,\n \"recurring_check_frequency\": \"WEEKLY\",\n \"recurring_check_end_date\": \"2050-01-01T00:00:00.000Z\",\n \"hmrc_enabled\": false,\n \"payslip_upload_enabled\": true,\n \"payroll_connections_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"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": 36,
"ni_number": "QQ123456C",
"ext_id": "ext-12345",
"recurring_checks_enabled": true,
"recurring_check_frequency": "WEEKLY",
"recurring_check_end_date": "2050-01-01T00:00:00.000Z",
"hmrc_enabled": false,
"payslip_upload_enabled": true,
"payroll_connections_enabled": true
}{
"errors": [
"The request is missing the required field `name`"
]
}{
"errors": [
"No X-API-KEY header provided or wrong value"
]
}{
"errors": [
"This user already exists. [name] and [email] must be a unique combination"
]
}Users
Create a User
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": 36,
"ni_number": "QQ123456C",
"ext_id": "ext-12345",
"recurring_checks_enabled": true,
"recurring_check_frequency": "WEEKLY",
"recurring_check_end_date": "2050-01-01T00:00:00.000Z",
"hmrc_enabled": false,
"payslip_upload_enabled": true,
"payroll_connections_enabled": true
}
'import requests
url = "https://api.sandbox.goteal.co/users"
payload = {
"forename": "John",
"surname": "Smith",
"date_of_birth": "2019-05-17T00:00:00.000Z",
"post_codes": ["SW1A 1AA", "SW1A 1AB"],
"payroll_period_months": 36,
"ni_number": "QQ123456C",
"ext_id": "ext-12345",
"recurring_checks_enabled": True,
"recurring_check_frequency": "WEEKLY",
"recurring_check_end_date": "2050-01-01T00:00:00.000Z",
"hmrc_enabled": False,
"payslip_upload_enabled": True,
"payroll_connections_enabled": True
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
forename: 'John',
surname: 'Smith',
date_of_birth: '2019-05-17T00:00:00.000Z',
post_codes: ['SW1A 1AA', 'SW1A 1AB'],
payroll_period_months: 36,
ni_number: 'QQ123456C',
ext_id: 'ext-12345',
recurring_checks_enabled: true,
recurring_check_frequency: 'WEEKLY',
recurring_check_end_date: '2050-01-01T00:00:00.000Z',
hmrc_enabled: false,
payslip_upload_enabled: true,
payroll_connections_enabled: true
})
};
fetch('https://api.sandbox.goteal.co/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.goteal.co/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'forename' => 'John',
'surname' => 'Smith',
'date_of_birth' => '2019-05-17T00:00:00.000Z',
'post_codes' => [
'SW1A 1AA',
'SW1A 1AB'
],
'payroll_period_months' => 36,
'ni_number' => 'QQ123456C',
'ext_id' => 'ext-12345',
'recurring_checks_enabled' => true,
'recurring_check_frequency' => 'WEEKLY',
'recurring_check_end_date' => '2050-01-01T00:00:00.000Z',
'hmrc_enabled' => false,
'payslip_upload_enabled' => true,
'payroll_connections_enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.goteal.co/users"
payload := strings.NewReader("{\n \"forename\": \"John\",\n \"surname\": \"Smith\",\n \"date_of_birth\": \"2019-05-17T00:00:00.000Z\",\n \"post_codes\": [\n \"SW1A 1AA\",\n \"SW1A 1AB\"\n ],\n \"payroll_period_months\": 36,\n \"ni_number\": \"QQ123456C\",\n \"ext_id\": \"ext-12345\",\n \"recurring_checks_enabled\": true,\n \"recurring_check_frequency\": \"WEEKLY\",\n \"recurring_check_end_date\": \"2050-01-01T00:00:00.000Z\",\n \"hmrc_enabled\": false,\n \"payslip_upload_enabled\": true,\n \"payroll_connections_enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.goteal.co/users")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"forename\": \"John\",\n \"surname\": \"Smith\",\n \"date_of_birth\": \"2019-05-17T00:00:00.000Z\",\n \"post_codes\": [\n \"SW1A 1AA\",\n \"SW1A 1AB\"\n ],\n \"payroll_period_months\": 36,\n \"ni_number\": \"QQ123456C\",\n \"ext_id\": \"ext-12345\",\n \"recurring_checks_enabled\": true,\n \"recurring_check_frequency\": \"WEEKLY\",\n \"recurring_check_end_date\": \"2050-01-01T00:00:00.000Z\",\n \"hmrc_enabled\": false,\n \"payslip_upload_enabled\": true,\n \"payroll_connections_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.goteal.co/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"forename\": \"John\",\n \"surname\": \"Smith\",\n \"date_of_birth\": \"2019-05-17T00:00:00.000Z\",\n \"post_codes\": [\n \"SW1A 1AA\",\n \"SW1A 1AB\"\n ],\n \"payroll_period_months\": 36,\n \"ni_number\": \"QQ123456C\",\n \"ext_id\": \"ext-12345\",\n \"recurring_checks_enabled\": true,\n \"recurring_check_frequency\": \"WEEKLY\",\n \"recurring_check_end_date\": \"2050-01-01T00:00:00.000Z\",\n \"hmrc_enabled\": false,\n \"payslip_upload_enabled\": true,\n \"payroll_connections_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"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": 36,
"ni_number": "QQ123456C",
"ext_id": "ext-12345",
"recurring_checks_enabled": true,
"recurring_check_frequency": "WEEKLY",
"recurring_check_end_date": "2050-01-01T00:00:00.000Z",
"hmrc_enabled": false,
"payslip_upload_enabled": true,
"payroll_connections_enabled": true
}{
"errors": [
"The request is missing the required field `name`"
]
}{
"errors": [
"No X-API-KEY header provided or wrong value"
]
}{
"errors": [
"This user already exists. [name] and [email] must be a unique combination"
]
}Body
application/json
Response
Created