Cadastra um cliente
curl --request POST \
--url https://api-koolisys.eixoassistencia.com.br/v1/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document": "12345678900",
"type": "PF",
"name": "Maria da Silva",
"phone": "11999998888",
"email": "maria@exemplo.com.br",
"birthDate": "1990-05-10",
"contractDate": "2026-08-01",
"zipCode": "01310-100",
"addressLine": "Av. Paulista",
"number": "1000",
"complement": "Sala 12",
"district": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"externalCode": "ERP-000123"
}
'import requests
url = "https://api-koolisys.eixoassistencia.com.br/v1/customers"
payload = {
"document": "12345678900",
"type": "PF",
"name": "Maria da Silva",
"phone": "11999998888",
"email": "maria@exemplo.com.br",
"birthDate": "1990-05-10",
"contractDate": "2026-08-01",
"zipCode": "01310-100",
"addressLine": "Av. Paulista",
"number": "1000",
"complement": "Sala 12",
"district": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"externalCode": "ERP-000123"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
document: '12345678900',
type: 'PF',
name: 'Maria da Silva',
phone: '11999998888',
email: 'maria@exemplo.com.br',
birthDate: '1990-05-10',
contractDate: '2026-08-01',
zipCode: '01310-100',
addressLine: 'Av. Paulista',
number: '1000',
complement: 'Sala 12',
district: 'Bela Vista',
city: 'São Paulo',
state: 'SP',
externalCode: 'ERP-000123'
})
};
fetch('https://api-koolisys.eixoassistencia.com.br/v1/customers', 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-koolisys.eixoassistencia.com.br/v1/customers",
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([
'document' => '12345678900',
'type' => 'PF',
'name' => 'Maria da Silva',
'phone' => '11999998888',
'email' => 'maria@exemplo.com.br',
'birthDate' => '1990-05-10',
'contractDate' => '2026-08-01',
'zipCode' => '01310-100',
'addressLine' => 'Av. Paulista',
'number' => '1000',
'complement' => 'Sala 12',
'district' => 'Bela Vista',
'city' => 'São Paulo',
'state' => 'SP',
'externalCode' => 'ERP-000123'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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-koolisys.eixoassistencia.com.br/v1/customers"
payload := strings.NewReader("{\n \"document\": \"12345678900\",\n \"type\": \"PF\",\n \"name\": \"Maria da Silva\",\n \"phone\": \"11999998888\",\n \"email\": \"maria@exemplo.com.br\",\n \"birthDate\": \"1990-05-10\",\n \"contractDate\": \"2026-08-01\",\n \"zipCode\": \"01310-100\",\n \"addressLine\": \"Av. Paulista\",\n \"number\": \"1000\",\n \"complement\": \"Sala 12\",\n \"district\": \"Bela Vista\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"externalCode\": \"ERP-000123\"\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(string(body))
}HttpResponse<String> response = Unirest.post("https://api-koolisys.eixoassistencia.com.br/v1/customers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document\": \"12345678900\",\n \"type\": \"PF\",\n \"name\": \"Maria da Silva\",\n \"phone\": \"11999998888\",\n \"email\": \"maria@exemplo.com.br\",\n \"birthDate\": \"1990-05-10\",\n \"contractDate\": \"2026-08-01\",\n \"zipCode\": \"01310-100\",\n \"addressLine\": \"Av. Paulista\",\n \"number\": \"1000\",\n \"complement\": \"Sala 12\",\n \"district\": \"Bela Vista\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"externalCode\": \"ERP-000123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-koolisys.eixoassistencia.com.br/v1/customers")
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 \"document\": \"12345678900\",\n \"type\": \"PF\",\n \"name\": \"Maria da Silva\",\n \"phone\": \"11999998888\",\n \"email\": \"maria@exemplo.com.br\",\n \"birthDate\": \"1990-05-10\",\n \"contractDate\": \"2026-08-01\",\n \"zipCode\": \"01310-100\",\n \"addressLine\": \"Av. Paulista\",\n \"number\": \"1000\",\n \"complement\": \"Sala 12\",\n \"district\": \"Bela Vista\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"externalCode\": \"ERP-000123\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 501,
"type": "PF",
"name": "Maria da Silva",
"socialName": null,
"document": "12345678900",
"phone": "11999998888",
"email": "maria@exemplo.com.br",
"birthDate": "1990-05-10",
"contractDate": "2026-08-01",
"externalCode": "ERP-000123",
"zipCode": "01310-100",
"addressLine": "Av. Paulista",
"number": "1000",
"complement": "Sala 12",
"district": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"status": "ACTIVE",
"createdAt": "2026-08-20T13:00:00.000Z",
"updatedAt": "2026-08-20T13:00:00.000Z",
"vehicles": [
{
"id": 9001,
"customerId": 501,
"plate": "ABC1D23",
"chassis": "9BWZZZ377VT004251",
"renavam": "12345678901",
"brand": "Fiat",
"model": "Argo",
"manufactureYear": 2022,
"modelYear": 2023,
"color": "Prata",
"externalCode": "ERP-V-000456",
"status": "ACTIVE",
"createdAt": "2026-08-20T13:02:00.000Z",
"updatedAt": "2026-08-20T13:02:00.000Z"
}
],
"plans": [
{
"contractPlanId": 73,
"contractCode": "CT-2026-0001",
"planName": "Plano Proteção Total",
"appliesTo": "CUSTOMER",
"linkedTo": "CUSTOMER",
"vehicleId": null,
"startedAt": "2026-08-20T13:05:00.000Z"
}
]
},
"meta": {},
"errors": []
}{
"data": {
"id": 501,
"type": "PF",
"name": "Maria da Silva",
"socialName": null,
"document": "12345678900",
"phone": "11999998888",
"email": "maria@exemplo.com.br",
"birthDate": "1990-05-10",
"contractDate": "2026-08-01",
"externalCode": "ERP-000123",
"zipCode": "01310-100",
"addressLine": "Av. Paulista",
"number": "1000",
"complement": "Sala 12",
"district": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"status": "ACTIVE",
"createdAt": "2026-08-20T13:00:00.000Z",
"updatedAt": "2026-08-20T13:00:00.000Z",
"vehicles": [
{
"id": 9001,
"customerId": 501,
"plate": "ABC1D23",
"chassis": "9BWZZZ377VT004251",
"renavam": "12345678901",
"brand": "Fiat",
"model": "Argo",
"manufactureYear": 2022,
"modelYear": 2023,
"color": "Prata",
"externalCode": "ERP-V-000456",
"status": "ACTIVE",
"createdAt": "2026-08-20T13:02:00.000Z",
"updatedAt": "2026-08-20T13:02:00.000Z"
}
],
"plans": [
{
"contractPlanId": 73,
"contractCode": "CT-2026-0001",
"planName": "Plano Proteção Total",
"appliesTo": "CUSTOMER",
"linkedTo": "CUSTOMER",
"vehicleId": null,
"startedAt": "2026-08-20T13:05:00.000Z"
}
]
},
"meta": {},
"errors": []
}{
"data": null,
"errors": [
{
"code": "VALIDATION_ERROR",
"message": "customerDocument: Documento do cliente é obrigatório",
"field": "customerDocument"
}
]
}{
"data": null,
"errors": [
{
"code": "INVALID_TOKEN",
"message": "Token inválido."
}
]
}{
"data": null,
"errors": [
{
"code": "INSUFFICIENT_SCOPE",
"message": "Escopo insuficiente para este endpoint.",
"details": {
"requiredScope": "attendances.read"
}
}
]
}{
"data": null,
"errors": [
{
"code": "IDEMPOTENCY_CONFLICT",
"message": "Chave de idempotência já usada com um corpo de requisição diferente."
}
]
}{
"data": null,
"errors": [
{
"code": "RATE_LIMITED",
"message": "Limite de requisições excedido.",
"details": {
"retryAfterSeconds": 42
}
}
]
}{
"data": null,
"errors": [
{
"code": "FEATURE_DISABLED",
"message": "Feature is disabled: public_api.enabled"
}
]
}customers
Cadastra um cliente
Cadastra um cliente na contratante dona da chave. O documento (CPF/CNPJ) é único por contratante: um documento já cadastrado devolve 409 CUSTOMER_ALREADY_EXISTS com details.customerId apontando o registro existente. O cabeçalho Idempotency-Key é opcional: repetir a mesma chave com o mesmo corpo devolve o cliente já criado (200), nunca um segundo cadastro. O vínculo de plano é um passo separado — POST /v1/customers/{id}/plans.
POST
/
v1
/
customers
Cadastra um cliente
curl --request POST \
--url https://api-koolisys.eixoassistencia.com.br/v1/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document": "12345678900",
"type": "PF",
"name": "Maria da Silva",
"phone": "11999998888",
"email": "maria@exemplo.com.br",
"birthDate": "1990-05-10",
"contractDate": "2026-08-01",
"zipCode": "01310-100",
"addressLine": "Av. Paulista",
"number": "1000",
"complement": "Sala 12",
"district": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"externalCode": "ERP-000123"
}
'import requests
url = "https://api-koolisys.eixoassistencia.com.br/v1/customers"
payload = {
"document": "12345678900",
"type": "PF",
"name": "Maria da Silva",
"phone": "11999998888",
"email": "maria@exemplo.com.br",
"birthDate": "1990-05-10",
"contractDate": "2026-08-01",
"zipCode": "01310-100",
"addressLine": "Av. Paulista",
"number": "1000",
"complement": "Sala 12",
"district": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"externalCode": "ERP-000123"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
document: '12345678900',
type: 'PF',
name: 'Maria da Silva',
phone: '11999998888',
email: 'maria@exemplo.com.br',
birthDate: '1990-05-10',
contractDate: '2026-08-01',
zipCode: '01310-100',
addressLine: 'Av. Paulista',
number: '1000',
complement: 'Sala 12',
district: 'Bela Vista',
city: 'São Paulo',
state: 'SP',
externalCode: 'ERP-000123'
})
};
fetch('https://api-koolisys.eixoassistencia.com.br/v1/customers', 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-koolisys.eixoassistencia.com.br/v1/customers",
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([
'document' => '12345678900',
'type' => 'PF',
'name' => 'Maria da Silva',
'phone' => '11999998888',
'email' => 'maria@exemplo.com.br',
'birthDate' => '1990-05-10',
'contractDate' => '2026-08-01',
'zipCode' => '01310-100',
'addressLine' => 'Av. Paulista',
'number' => '1000',
'complement' => 'Sala 12',
'district' => 'Bela Vista',
'city' => 'São Paulo',
'state' => 'SP',
'externalCode' => 'ERP-000123'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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-koolisys.eixoassistencia.com.br/v1/customers"
payload := strings.NewReader("{\n \"document\": \"12345678900\",\n \"type\": \"PF\",\n \"name\": \"Maria da Silva\",\n \"phone\": \"11999998888\",\n \"email\": \"maria@exemplo.com.br\",\n \"birthDate\": \"1990-05-10\",\n \"contractDate\": \"2026-08-01\",\n \"zipCode\": \"01310-100\",\n \"addressLine\": \"Av. Paulista\",\n \"number\": \"1000\",\n \"complement\": \"Sala 12\",\n \"district\": \"Bela Vista\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"externalCode\": \"ERP-000123\"\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(string(body))
}HttpResponse<String> response = Unirest.post("https://api-koolisys.eixoassistencia.com.br/v1/customers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document\": \"12345678900\",\n \"type\": \"PF\",\n \"name\": \"Maria da Silva\",\n \"phone\": \"11999998888\",\n \"email\": \"maria@exemplo.com.br\",\n \"birthDate\": \"1990-05-10\",\n \"contractDate\": \"2026-08-01\",\n \"zipCode\": \"01310-100\",\n \"addressLine\": \"Av. Paulista\",\n \"number\": \"1000\",\n \"complement\": \"Sala 12\",\n \"district\": \"Bela Vista\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"externalCode\": \"ERP-000123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-koolisys.eixoassistencia.com.br/v1/customers")
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 \"document\": \"12345678900\",\n \"type\": \"PF\",\n \"name\": \"Maria da Silva\",\n \"phone\": \"11999998888\",\n \"email\": \"maria@exemplo.com.br\",\n \"birthDate\": \"1990-05-10\",\n \"contractDate\": \"2026-08-01\",\n \"zipCode\": \"01310-100\",\n \"addressLine\": \"Av. Paulista\",\n \"number\": \"1000\",\n \"complement\": \"Sala 12\",\n \"district\": \"Bela Vista\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"externalCode\": \"ERP-000123\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 501,
"type": "PF",
"name": "Maria da Silva",
"socialName": null,
"document": "12345678900",
"phone": "11999998888",
"email": "maria@exemplo.com.br",
"birthDate": "1990-05-10",
"contractDate": "2026-08-01",
"externalCode": "ERP-000123",
"zipCode": "01310-100",
"addressLine": "Av. Paulista",
"number": "1000",
"complement": "Sala 12",
"district": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"status": "ACTIVE",
"createdAt": "2026-08-20T13:00:00.000Z",
"updatedAt": "2026-08-20T13:00:00.000Z",
"vehicles": [
{
"id": 9001,
"customerId": 501,
"plate": "ABC1D23",
"chassis": "9BWZZZ377VT004251",
"renavam": "12345678901",
"brand": "Fiat",
"model": "Argo",
"manufactureYear": 2022,
"modelYear": 2023,
"color": "Prata",
"externalCode": "ERP-V-000456",
"status": "ACTIVE",
"createdAt": "2026-08-20T13:02:00.000Z",
"updatedAt": "2026-08-20T13:02:00.000Z"
}
],
"plans": [
{
"contractPlanId": 73,
"contractCode": "CT-2026-0001",
"planName": "Plano Proteção Total",
"appliesTo": "CUSTOMER",
"linkedTo": "CUSTOMER",
"vehicleId": null,
"startedAt": "2026-08-20T13:05:00.000Z"
}
]
},
"meta": {},
"errors": []
}{
"data": {
"id": 501,
"type": "PF",
"name": "Maria da Silva",
"socialName": null,
"document": "12345678900",
"phone": "11999998888",
"email": "maria@exemplo.com.br",
"birthDate": "1990-05-10",
"contractDate": "2026-08-01",
"externalCode": "ERP-000123",
"zipCode": "01310-100",
"addressLine": "Av. Paulista",
"number": "1000",
"complement": "Sala 12",
"district": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"status": "ACTIVE",
"createdAt": "2026-08-20T13:00:00.000Z",
"updatedAt": "2026-08-20T13:00:00.000Z",
"vehicles": [
{
"id": 9001,
"customerId": 501,
"plate": "ABC1D23",
"chassis": "9BWZZZ377VT004251",
"renavam": "12345678901",
"brand": "Fiat",
"model": "Argo",
"manufactureYear": 2022,
"modelYear": 2023,
"color": "Prata",
"externalCode": "ERP-V-000456",
"status": "ACTIVE",
"createdAt": "2026-08-20T13:02:00.000Z",
"updatedAt": "2026-08-20T13:02:00.000Z"
}
],
"plans": [
{
"contractPlanId": 73,
"contractCode": "CT-2026-0001",
"planName": "Plano Proteção Total",
"appliesTo": "CUSTOMER",
"linkedTo": "CUSTOMER",
"vehicleId": null,
"startedAt": "2026-08-20T13:05:00.000Z"
}
]
},
"meta": {},
"errors": []
}{
"data": null,
"errors": [
{
"code": "VALIDATION_ERROR",
"message": "customerDocument: Documento do cliente é obrigatório",
"field": "customerDocument"
}
]
}{
"data": null,
"errors": [
{
"code": "INVALID_TOKEN",
"message": "Token inválido."
}
]
}{
"data": null,
"errors": [
{
"code": "INSUFFICIENT_SCOPE",
"message": "Escopo insuficiente para este endpoint.",
"details": {
"requiredScope": "attendances.read"
}
}
]
}{
"data": null,
"errors": [
{
"code": "IDEMPOTENCY_CONFLICT",
"message": "Chave de idempotência já usada com um corpo de requisição diferente."
}
]
}{
"data": null,
"errors": [
{
"code": "RATE_LIMITED",
"message": "Limite de requisições excedido.",
"details": {
"retryAfterSeconds": 42
}
}
]
}{
"data": null,
"errors": [
{
"code": "FEATURE_DISABLED",
"message": "Feature is disabled: public_api.enabled"
}
]
}Authorizations
Token de curta duração devolvido por POST /v1/auth/token, carregando os escopos concedidos à chave — exigido por todo endpoint de dados.
Headers
Identificador único da tentativa de cadastro, gerado pelo integrador (opcional)
Body
application/json
CPF ou CNPJ. Pontuação é ignorada; o documento é validado pelo type.
Example:
"12345678900"
Nome ou razão social
Example:
"Maria da Silva"
PF ou PJ. Quando ausente, é inferido do documento: 11 dígitos → PF, 14 dígitos → PJ.
Available options:
PF, PJ Example:
"PF"
Example:
"11999998888"
Example:
"maria@exemplo.com.br"
Data de nascimento (YYYY-MM-DD)
Example:
"1990-05-10"
Data de contratação junto ao parceiro (YYYY-MM-DD)
Example:
"2026-08-01"
Example:
"01310-100"
Example:
"Av. Paulista"
Example:
"1000"
Example:
"Sala 12"
Example:
"Bela Vista"
Example:
"São Paulo"
UF, duas letras maiúsculas
Example:
"SP"
Código do cliente no sistema do parceiro — único dentro da contratante
Example:
"ERP-000123"