Criar operação de borderô
Cria uma operação de borderô a partir de um CNAB 400 (parte file) e, opcionalmente, um ZIP de XMLs de NFe (parte xmls) para validação cruzada. Enfileira a análise e retorna 202. Faça polling em GET /operations/ e busque o resultado em /result.
curl --request POST \
--url https://221b-api.sherlocker.com.br/api/v1/operations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form cedente_cnpj=12345678000195 \
--form xmls='@example-file' \
--form engine_id=template-padrao \
--form 'purpose=<string>' \
--form 'legal_basis=<string>'import requests
url = "https://221b-api.sherlocker.com.br/api/v1/operations"
files = {
"file": ("example-file", open("example-file", "rb")),
"xmls": ("example-file", open("example-file", "rb"))
}
payload = {
"cedente_cnpj": "12345678000195",
"engine_id": "template-padrao",
"purpose": "<string>",
"legal_basis": "<string>"
}
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('cedente_cnpj', '12345678000195');
form.append('xmls', '<string>');
form.append('engine_id', 'template-padrao');
form.append('purpose', '<string>');
form.append('legal_basis', '<string>');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://221b-api.sherlocker.com.br/api/v1/operations', 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://221b-api.sherlocker.com.br/api/v1/operations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cedente_cnpj\"\r\n\r\n12345678000195\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"xmls\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"engine_id\"\r\n\r\ntemplate-padrao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"purpose\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"legal_basis\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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://221b-api.sherlocker.com.br/api/v1/operations"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cedente_cnpj\"\r\n\r\n12345678000195\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"xmls\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"engine_id\"\r\n\r\ntemplate-padrao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"purpose\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"legal_basis\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://221b-api.sherlocker.com.br/api/v1/operations")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cedente_cnpj\"\r\n\r\n12345678000195\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"xmls\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"engine_id\"\r\n\r\ntemplate-padrao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"purpose\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"legal_basis\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://221b-api.sherlocker.com.br/api/v1/operations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cedente_cnpj\"\r\n\r\n12345678000195\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"xmls\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"engine_id\"\r\n\r\ntemplate-padrao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"purpose\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"legal_basis\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z"
}{
"operation_id": "b2c3d4e5-0000-0000-0000-000000000001",
"status": "queued",
"created_at": "2026-07-09T12:00:00.000Z"
}{
"type": "https://docs.sherlocker.com.br/problems/validation_error",
"title": "Validation Error",
"status": 400,
"code": "validation_error",
"detail": "One or more fields failed validation.",
"errors": [
{
"field": "file",
"message": "No file provided"
}
],
"instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}{
"type": "https://docs.sherlocker.com.br/problems/unauthorized",
"title": "Unauthorized",
"status": 401,
"code": "unauthorized",
"detail": "Authentication is required to access this resource.",
"instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}{
"type": "https://docs.sherlocker.com.br/problems/insufficient_tokens",
"title": "Payment Required",
"status": 402,
"code": "insufficient_tokens",
"detail": "Insufficient tokens: 5 available, 12 required",
"required": 12,
"balance": 5,
"instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}{
"type": "https://docs.sherlocker.com.br/problems/feature_not_enabled",
"title": "Feature Not Enabled",
"status": 403,
"code": "feature_not_enabled",
"detail": "The analysis_engine feature is not enabled for this workspace. To request access visit https://docs.sherlocker.com.br/api/access or contact support at https://docs.sherlocker.com.br/support.",
"request_access_url": "https://docs.sherlocker.com.br/api/access",
"instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}{
"type": "https://docs.sherlocker.com.br/problems/idempotency_conflict",
"title": "Conflict",
"status": 409,
"code": "idempotency_conflict",
"detail": "A request with the same idempotency key is already in progress or completed.",
"instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}{
"type": "https://docs.sherlocker.com.br/problems/no_engine",
"title": "Unprocessable Entity",
"status": 422,
"code": "no_engine",
"detail": "No bordero engine is available for this operation.",
"instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}{
"type": "https://docs.sherlocker.com.br/problems/server_error",
"title": "Internal Server Error",
"status": 500,
"code": "server_error",
"detail": "An unexpected error occurred.",
"instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}Authorizations
Chave de API do workspace (prefixo slhk_), enviada no header: Authorization: Bearer slhk_sua_chave_aqui
Headers
Opcional. Presente: reenviar a mesma key com o mesmo payload devolve a resposta original (HTTP 200), sem nova operação nem nova cobrança; a mesma key com payload diferente devolve 409 idempotency_conflict. Ausente: cada POST cria uma operação nova.
Identificador de rastreio opcional fornecido pelo cliente. Ecoado no header da resposta (nunca no body).
Body
Arquivo CNAB 400 remessa (.REM) — Banco Paulista 611, 444 colunas, Windows-1252. Obrigatório. Máximo de 16 MB.
CNPJ do cedente, 14 dígitos ou formatado. Obrigatório; o dígito verificador é validado.
"12345678000195"
ZIP com os XMLs de NFe (nfeProc) dos títulos, para validação cruzada. Opcional. Máximo de 32 MB.
ID da engine de borderô a usar. Omitido ou "template-padrao": usa a engine template do sistema. Engine não utilizável retorna 422 no_engine.
"template-padrao"
Finalidade da análise (auditoria LGPD). Opcional.
Base legal LGPD para os sacados PF. Opcional.
Response
Replay idempotente: mesma Idempotency-Key + mesmo payload. Corpo idêntico ao da resposta 202 original; nenhum token adicional é cobrado.
curl --request POST \
--url https://221b-api.sherlocker.com.br/api/v1/operations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form cedente_cnpj=12345678000195 \
--form xmls='@example-file' \
--form engine_id=template-padrao \
--form 'purpose=<string>' \
--form 'legal_basis=<string>'import requests
url = "https://221b-api.sherlocker.com.br/api/v1/operations"
files = {
"file": ("example-file", open("example-file", "rb")),
"xmls": ("example-file", open("example-file", "rb"))
}
payload = {
"cedente_cnpj": "12345678000195",
"engine_id": "template-padrao",
"purpose": "<string>",
"legal_basis": "<string>"
}
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('cedente_cnpj', '12345678000195');
form.append('xmls', '<string>');
form.append('engine_id', 'template-padrao');
form.append('purpose', '<string>');
form.append('legal_basis', '<string>');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://221b-api.sherlocker.com.br/api/v1/operations', 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://221b-api.sherlocker.com.br/api/v1/operations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cedente_cnpj\"\r\n\r\n12345678000195\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"xmls\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"engine_id\"\r\n\r\ntemplate-padrao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"purpose\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"legal_basis\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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://221b-api.sherlocker.com.br/api/v1/operations"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cedente_cnpj\"\r\n\r\n12345678000195\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"xmls\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"engine_id\"\r\n\r\ntemplate-padrao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"purpose\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"legal_basis\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://221b-api.sherlocker.com.br/api/v1/operations")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cedente_cnpj\"\r\n\r\n12345678000195\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"xmls\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"engine_id\"\r\n\r\ntemplate-padrao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"purpose\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"legal_basis\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://221b-api.sherlocker.com.br/api/v1/operations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cedente_cnpj\"\r\n\r\n12345678000195\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"xmls\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"engine_id\"\r\n\r\ntemplate-padrao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"purpose\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"legal_basis\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z"
}{
"operation_id": "b2c3d4e5-0000-0000-0000-000000000001",
"status": "queued",
"created_at": "2026-07-09T12:00:00.000Z"
}{
"type": "https://docs.sherlocker.com.br/problems/validation_error",
"title": "Validation Error",
"status": 400,
"code": "validation_error",
"detail": "One or more fields failed validation.",
"errors": [
{
"field": "file",
"message": "No file provided"
}
],
"instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}{
"type": "https://docs.sherlocker.com.br/problems/unauthorized",
"title": "Unauthorized",
"status": 401,
"code": "unauthorized",
"detail": "Authentication is required to access this resource.",
"instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}{
"type": "https://docs.sherlocker.com.br/problems/insufficient_tokens",
"title": "Payment Required",
"status": 402,
"code": "insufficient_tokens",
"detail": "Insufficient tokens: 5 available, 12 required",
"required": 12,
"balance": 5,
"instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}{
"type": "https://docs.sherlocker.com.br/problems/feature_not_enabled",
"title": "Feature Not Enabled",
"status": 403,
"code": "feature_not_enabled",
"detail": "The analysis_engine feature is not enabled for this workspace. To request access visit https://docs.sherlocker.com.br/api/access or contact support at https://docs.sherlocker.com.br/support.",
"request_access_url": "https://docs.sherlocker.com.br/api/access",
"instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}{
"type": "https://docs.sherlocker.com.br/problems/idempotency_conflict",
"title": "Conflict",
"status": 409,
"code": "idempotency_conflict",
"detail": "A request with the same idempotency key is already in progress or completed.",
"instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}{
"type": "https://docs.sherlocker.com.br/problems/no_engine",
"title": "Unprocessable Entity",
"status": 422,
"code": "no_engine",
"detail": "No bordero engine is available for this operation.",
"instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}{
"type": "https://docs.sherlocker.com.br/problems/server_error",
"title": "Internal Server Error",
"status": 500,
"code": "server_error",
"detail": "An unexpected error occurred.",
"instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}