Update an Executor Configuration
curl --request PATCH \
--url https://flowker.sandbox.lerian.net/v1/executors/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"authentication": {
"type": "api_key",
"config": {
"key": "sk-live-abc123def456",
"header": "X-API-Key"
}
},
"baseUrl": "https://api.serasa.com.br/v2",
"endpoints": [
{
"method": "POST",
"name": "validate-identity",
"path": "/identity/validate",
"timeout": 30
}
],
"name": "Serasa KYC",
"description": "Serasa KYC provider for identity validation",
"metadata": {}
}
'import requests
url = "https://flowker.sandbox.lerian.net/v1/executors/{id}"
payload = {
"authentication": {
"type": "api_key",
"config": {
"key": "sk-live-abc123def456",
"header": "X-API-Key"
}
},
"baseUrl": "https://api.serasa.com.br/v2",
"endpoints": [
{
"method": "POST",
"name": "validate-identity",
"path": "/identity/validate",
"timeout": 30
}
],
"name": "Serasa KYC",
"description": "Serasa KYC provider for identity validation",
"metadata": {}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
authentication: {type: 'api_key', config: {key: 'sk-live-abc123def456', header: 'X-API-Key'}},
baseUrl: 'https://api.serasa.com.br/v2',
endpoints: [
{
method: 'POST',
name: 'validate-identity',
path: '/identity/validate',
timeout: 30
}
],
name: 'Serasa KYC',
description: 'Serasa KYC provider for identity validation',
metadata: {}
})
};
fetch('https://flowker.sandbox.lerian.net/v1/executors/{id}', 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://flowker.sandbox.lerian.net/v1/executors/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'authentication' => [
'type' => 'api_key',
'config' => [
'key' => 'sk-live-abc123def456',
'header' => 'X-API-Key'
]
],
'baseUrl' => 'https://api.serasa.com.br/v2',
'endpoints' => [
[
'method' => 'POST',
'name' => 'validate-identity',
'path' => '/identity/validate',
'timeout' => 30
]
],
'name' => 'Serasa KYC',
'description' => 'Serasa KYC provider for identity validation',
'metadata' => [
]
]),
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://flowker.sandbox.lerian.net/v1/executors/{id}"
payload := strings.NewReader("{\n \"authentication\": {\n \"type\": \"api_key\",\n \"config\": {\n \"key\": \"sk-live-abc123def456\",\n \"header\": \"X-API-Key\"\n }\n },\n \"baseUrl\": \"https://api.serasa.com.br/v2\",\n \"endpoints\": [\n {\n \"method\": \"POST\",\n \"name\": \"validate-identity\",\n \"path\": \"/identity/validate\",\n \"timeout\": 30\n }\n ],\n \"name\": \"Serasa KYC\",\n \"description\": \"Serasa KYC provider for identity validation\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://flowker.sandbox.lerian.net/v1/executors/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"authentication\": {\n \"type\": \"api_key\",\n \"config\": {\n \"key\": \"sk-live-abc123def456\",\n \"header\": \"X-API-Key\"\n }\n },\n \"baseUrl\": \"https://api.serasa.com.br/v2\",\n \"endpoints\": [\n {\n \"method\": \"POST\",\n \"name\": \"validate-identity\",\n \"path\": \"/identity/validate\",\n \"timeout\": 30\n }\n ],\n \"name\": \"Serasa KYC\",\n \"description\": \"Serasa KYC provider for identity validation\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowker.sandbox.lerian.net/v1/executors/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"authentication\": {\n \"type\": \"api_key\",\n \"config\": {\n \"key\": \"sk-live-abc123def456\",\n \"header\": \"X-API-Key\"\n }\n },\n \"baseUrl\": \"https://api.serasa.com.br/v2\",\n \"endpoints\": [\n {\n \"method\": \"POST\",\n \"name\": \"validate-identity\",\n \"path\": \"/identity/validate\",\n \"timeout\": 30\n }\n ],\n \"name\": \"Serasa KYC\",\n \"description\": \"Serasa KYC provider for identity validation\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"name": "Serasa KYC",
"description": "Serasa identity validation service",
"baseUrl": "https://api.serasa.com.br/v2",
"endpoints": [
{
"name": "validate-identity",
"path": "/identity/validate",
"method": "POST",
"timeout": 30
}
],
"authentication": {
"type": "api_key",
"config": {
"key": "********",
"header": "X-API-Key"
}
},
"status": "active",
"metadata": {},
"createdAt": "2026-03-15T10:00:00Z",
"updatedAt": "2026-03-16T09:30:00Z",
"lastTestedAt": "2026-03-16T09:30:00Z"
}{
"code": "FLK-0001",
"message": "Invalid input provided",
"title": "Bad Request"
}{
"code": "FLK-0001",
"message": "Invalid input provided",
"title": "Bad Request"
}{
"code": "FLK-0001",
"message": "Invalid input provided",
"title": "Bad Request"
}{
"code": "FLK-0001",
"message": "Invalid input provided",
"title": "Bad Request"
}Update an Executor Configuration
Use this endpoint to update an existing executor configuration. Only configurations with unconfigured or configured status can be updated.
PATCH
/
v1
/
executors
/
{id}
Update an Executor Configuration
curl --request PATCH \
--url https://flowker.sandbox.lerian.net/v1/executors/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"authentication": {
"type": "api_key",
"config": {
"key": "sk-live-abc123def456",
"header": "X-API-Key"
}
},
"baseUrl": "https://api.serasa.com.br/v2",
"endpoints": [
{
"method": "POST",
"name": "validate-identity",
"path": "/identity/validate",
"timeout": 30
}
],
"name": "Serasa KYC",
"description": "Serasa KYC provider for identity validation",
"metadata": {}
}
'import requests
url = "https://flowker.sandbox.lerian.net/v1/executors/{id}"
payload = {
"authentication": {
"type": "api_key",
"config": {
"key": "sk-live-abc123def456",
"header": "X-API-Key"
}
},
"baseUrl": "https://api.serasa.com.br/v2",
"endpoints": [
{
"method": "POST",
"name": "validate-identity",
"path": "/identity/validate",
"timeout": 30
}
],
"name": "Serasa KYC",
"description": "Serasa KYC provider for identity validation",
"metadata": {}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
authentication: {type: 'api_key', config: {key: 'sk-live-abc123def456', header: 'X-API-Key'}},
baseUrl: 'https://api.serasa.com.br/v2',
endpoints: [
{
method: 'POST',
name: 'validate-identity',
path: '/identity/validate',
timeout: 30
}
],
name: 'Serasa KYC',
description: 'Serasa KYC provider for identity validation',
metadata: {}
})
};
fetch('https://flowker.sandbox.lerian.net/v1/executors/{id}', 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://flowker.sandbox.lerian.net/v1/executors/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'authentication' => [
'type' => 'api_key',
'config' => [
'key' => 'sk-live-abc123def456',
'header' => 'X-API-Key'
]
],
'baseUrl' => 'https://api.serasa.com.br/v2',
'endpoints' => [
[
'method' => 'POST',
'name' => 'validate-identity',
'path' => '/identity/validate',
'timeout' => 30
]
],
'name' => 'Serasa KYC',
'description' => 'Serasa KYC provider for identity validation',
'metadata' => [
]
]),
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://flowker.sandbox.lerian.net/v1/executors/{id}"
payload := strings.NewReader("{\n \"authentication\": {\n \"type\": \"api_key\",\n \"config\": {\n \"key\": \"sk-live-abc123def456\",\n \"header\": \"X-API-Key\"\n }\n },\n \"baseUrl\": \"https://api.serasa.com.br/v2\",\n \"endpoints\": [\n {\n \"method\": \"POST\",\n \"name\": \"validate-identity\",\n \"path\": \"/identity/validate\",\n \"timeout\": 30\n }\n ],\n \"name\": \"Serasa KYC\",\n \"description\": \"Serasa KYC provider for identity validation\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://flowker.sandbox.lerian.net/v1/executors/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"authentication\": {\n \"type\": \"api_key\",\n \"config\": {\n \"key\": \"sk-live-abc123def456\",\n \"header\": \"X-API-Key\"\n }\n },\n \"baseUrl\": \"https://api.serasa.com.br/v2\",\n \"endpoints\": [\n {\n \"method\": \"POST\",\n \"name\": \"validate-identity\",\n \"path\": \"/identity/validate\",\n \"timeout\": 30\n }\n ],\n \"name\": \"Serasa KYC\",\n \"description\": \"Serasa KYC provider for identity validation\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowker.sandbox.lerian.net/v1/executors/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"authentication\": {\n \"type\": \"api_key\",\n \"config\": {\n \"key\": \"sk-live-abc123def456\",\n \"header\": \"X-API-Key\"\n }\n },\n \"baseUrl\": \"https://api.serasa.com.br/v2\",\n \"endpoints\": [\n {\n \"method\": \"POST\",\n \"name\": \"validate-identity\",\n \"path\": \"/identity/validate\",\n \"timeout\": 30\n }\n ],\n \"name\": \"Serasa KYC\",\n \"description\": \"Serasa KYC provider for identity validation\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
"name": "Serasa KYC",
"description": "Serasa identity validation service",
"baseUrl": "https://api.serasa.com.br/v2",
"endpoints": [
{
"name": "validate-identity",
"path": "/identity/validate",
"method": "POST",
"timeout": 30
}
],
"authentication": {
"type": "api_key",
"config": {
"key": "********",
"header": "X-API-Key"
}
},
"status": "active",
"metadata": {},
"createdAt": "2026-03-15T10:00:00Z",
"updatedAt": "2026-03-16T09:30:00Z",
"lastTestedAt": "2026-03-16T09:30:00Z"
}{
"code": "FLK-0001",
"message": "Invalid input provided",
"title": "Bad Request"
}{
"code": "FLK-0001",
"message": "Invalid input provided",
"title": "Bad Request"
}{
"code": "FLK-0001",
"message": "Invalid input provided",
"title": "Bad Request"
}{
"code": "FLK-0001",
"message": "Invalid input provided",
"title": "Bad Request"
}Authorizations
API key for authenticating requests to the Flowker API. Provisioned via the API_KEY environment variable during deployment.
Path Parameters
Unique identifier of the executor configuration.
Body
application/json
Request body containing the updated executor configuration details.
Show child attributes
Show child attributes
Base URL of the external service.
Maximum string length:
500Example:
"https://api.serasa.com.br/v2"
List of HTTP endpoints exposed by this executor.
Minimum array length:
1Show child attributes
Show child attributes
Display name for the executor configuration.
Required string length:
1 - 100Example:
"Serasa KYC"
Human-readable description of this executor configuration.
Maximum string length:
500Example:
"Serasa KYC provider for identity validation"
Custom key-value pairs for tagging.
Show child attributes
Show child attributes
Response
Indicates that the request was successful and the response contains the requested data.
Show child attributes
Show child attributes
Base URL of the external service.
Example:
"https://api.serasa.com.br/v2"
Timestamp when the configuration was created.
Example:
"2026-03-15T10:00:00Z"
Human-readable description.
Example:
"Serasa identity validation service"
List of configured HTTP endpoints.
Show child attributes
Show child attributes
Unique identifier of the executor configuration.
Example:
"b2c3d4e5-f6a7-8901-bcde-f23456789012"
Timestamp of the last connectivity test. Null if never tested.
Example:
"2026-03-16T09:30:00Z"
Custom metadata.
Show child attributes
Show child attributes
Display name.
Example:
"Serasa KYC"
Current lifecycle status: unconfigured, configured, tested, active, or disabled.
Available options:
unconfigured, configured, tested, active, disabled Example:
"active"
Timestamp of the last update.
Example:
"2026-03-16T09:30:00Z"
Was this page helpful?
⌘I