Exclude a contract from this institution because the worker ported it out

curl --request POST \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "codigoInscricaoEmpregador": "1",
  "codigoProponente": "994",
  "cpfTrabalhador": "99999999999",
  "matricula": "99999999999-A",
  "numeroInscricaoEmpregador": "99999999999881",
  "numeroUnico": "123456789012345678901",
  "ultimaParcelaPaga": 5
}
'

import requests

url = "https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao"

payload = {
    "codigoInscricaoEmpregador": "1",
    "codigoProponente": "994",
    "cpfTrabalhador": "99999999999",
    "matricula": "99999999999-A",
    "numeroInscricaoEmpregador": "99999999999881",
    "numeroUnico": "123456789012345678901",
    "ultimaParcelaPaga": 5
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    codigoInscricaoEmpregador: '1',
    codigoProponente: '994',
    cpfTrabalhador: '99999999999',
    matricula: '99999999999-A',
    numeroInscricaoEmpregador: '99999999999881',
    numeroUnico: '123456789012345678901',
    ultimaParcelaPaga: 5
  })
};

fetch('https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao', 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://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao",
  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([
    'codigoInscricaoEmpregador' => '1',
    'codigoProponente' => '994',
    'cpfTrabalhador' => '99999999999',
    'matricula' => '99999999999-A',
    'numeroInscricaoEmpregador' => '99999999999881',
    'numeroUnico' => '123456789012345678901',
    'ultimaParcelaPaga' => 5
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Idempotency: <x-idempotency>"
  ],
]);

$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://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao"

	payload := strings.NewReader("{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"codigoProponente\": \"994\",\n  \"cpfTrabalhador\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"99999999999881\",\n  \"numeroUnico\": \"123456789012345678901\",\n  \"ultimaParcelaPaga\": 5\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao")
  .header("X-Idempotency", "<x-idempotency>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"codigoProponente\": \"994\",\n  \"cpfTrabalhador\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"99999999999881\",\n  \"numeroUnico\": \"123456789012345678901\",\n  \"ultimaParcelaPaga\": 5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Idempotency"] = '<x-idempotency>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"codigoProponente\": \"994\",\n  \"cpfTrabalhador\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"99999999999881\",\n  \"numeroUnico\": \"123456789012345678901\",\n  \"ultimaParcelaPaga\": 5\n}"

response = http.request(request)
puts response.read_body

{
  "codigoSucesso": "00",
  "competenciaExclusao": 202609,
  "hashOperacao": "34006311",
  "mensagem": "Exclusao realizada com sucesso",
  "numeroContrato": "99999999999AP1",
  "submittedAt": "2026-08-29T12:00:00Z",
  "ultimaParcelaPaga": 5
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Exclude a contract from this institution because the worker ported it out

Proxies excluir-portabilidade-trabalhador (Manual 008 v1.10 §4.1), the ORIGIN institution’s write: the contract named in the path stops being consigned here because the worker moved it to the institution named by codigoProponente. codigoOrigem is never accepted from the caller — it is the authenticated tenant’s own COMPE/CBC. The contract must be an averbação of the authenticated tenant that the rail acknowledged; anything else is 404 before the rail is called. The call is claimed durably before it departs and closed durably after the answer lands, so a retry under the same X-Idempotency key is answered from the retained rail answer instead of excluding a second time, and a call whose outcome nobody established is reconciled against the registry rather than lost. Success publishes consignado.portabilidade.efetivada and a published refusal publishes consignado.portabilidade.rejeitada. A portability the client performs OUTSIDE this gateway publishes nothing: Manual 008 §5.4’s consulta is proponente-only, so the origin institution has no discovery path. X-Idempotency is required.

POST

consignado

contracts

{numero_contrato}

portabilidade

exclusao

Exclude a contract from this institution because the worker ported it out

curl --request POST \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "codigoInscricaoEmpregador": "1",
  "codigoProponente": "994",
  "cpfTrabalhador": "99999999999",
  "matricula": "99999999999-A",
  "numeroInscricaoEmpregador": "99999999999881",
  "numeroUnico": "123456789012345678901",
  "ultimaParcelaPaga": 5
}
'

import requests

url = "https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao"

payload = {
    "codigoInscricaoEmpregador": "1",
    "codigoProponente": "994",
    "cpfTrabalhador": "99999999999",
    "matricula": "99999999999-A",
    "numeroInscricaoEmpregador": "99999999999881",
    "numeroUnico": "123456789012345678901",
    "ultimaParcelaPaga": 5
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    codigoInscricaoEmpregador: '1',
    codigoProponente: '994',
    cpfTrabalhador: '99999999999',
    matricula: '99999999999-A',
    numeroInscricaoEmpregador: '99999999999881',
    numeroUnico: '123456789012345678901',
    ultimaParcelaPaga: 5
  })
};

fetch('https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao', 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://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao",
  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([
    'codigoInscricaoEmpregador' => '1',
    'codigoProponente' => '994',
    'cpfTrabalhador' => '99999999999',
    'matricula' => '99999999999-A',
    'numeroInscricaoEmpregador' => '99999999999881',
    'numeroUnico' => '123456789012345678901',
    'ultimaParcelaPaga' => 5
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Idempotency: <x-idempotency>"
  ],
]);

$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://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao"

	payload := strings.NewReader("{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"codigoProponente\": \"994\",\n  \"cpfTrabalhador\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"99999999999881\",\n  \"numeroUnico\": \"123456789012345678901\",\n  \"ultimaParcelaPaga\": 5\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	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://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao")
  .header("X-Idempotency", "<x-idempotency>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"codigoProponente\": \"994\",\n  \"cpfTrabalhador\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"99999999999881\",\n  \"numeroUnico\": \"123456789012345678901\",\n  \"ultimaParcelaPaga\": 5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Idempotency"] = '<x-idempotency>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"codigoProponente\": \"994\",\n  \"cpfTrabalhador\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"99999999999881\",\n  \"numeroUnico\": \"123456789012345678901\",\n  \"ultimaParcelaPaga\": 5\n}"

response = http.request(request)
puts response.read_body

{
  "codigoSucesso": "00",
  "competenciaExclusao": 202609,
  "hashOperacao": "34006311",
  "mensagem": "Exclusao realizada com sucesso",
  "numeroContrato": "99999999999AP1",
  "submittedAt": "2026-08-29T12:00:00Z",
  "ultimaParcelaPaga": 5
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency

string

required

Client-chosen idempotency key. REQUIRED: an absent key is 422, never a generated default. It is the durable replay identity of this command.

Required string length: 1 - 128

Example:

"idem-exclusao-portabilidade-0001"

Path Parameters

numero_contrato

string

required

The contract leaving this institution. Must be an averbação of the authenticated tenant that the rail acknowledged.

Required string length: 2 - 15

Example:

"99999999999AP1"

Body

application/json

codigoInscricaoEmpregador

string

required

Employer inscription type: 1 CNPJ, 2 CPF.

Pattern: ^[12]$

Example:

"1"

codigoProponente

string

required

COMPE/CBC of the DESTINATION institution taking the contract. Caller input, because this gateway cannot know it.

Required string length: 1 - 3

Pattern: ^[0-9]{1,3}$

Example:

"994"

cpfTrabalhador

string

required

Worker CPF, 11 digits.

Required string length: 11

Pattern: ^[0-9]{11}$

Example:

"99999999999"

matricula

string

required

Matrícula assigned to the worker by the employer.

Required string length: 1 - 30

Example:

"99999999999-A"

numeroInscricaoEmpregador

string

required

Employer inscription number, Texto per the manual (the mirrored Swagger still types this int64).

Required string length: 1 - 14

Example:

"99999999999881"

numeroUnico

string

required

Número único identificador da portabilidade (NSU oriundo da CIP). A digit STRING: Manual 008 publishes exactly 21 algarismos, which overflows every conventional numeric type, so it stays text end to end.

Required string length: 21

Pattern: ^[0-9]{21}$

Example:

"123456789012345678901"

ultimaParcelaPaga

integer<int64>

Last instalment already paid on the contract being excluded. Optional; omit it rather than sending 0 when unknown.

Required range: 0 <= x <= 999

Example:

5

Response

codigoSucesso

string

required

The rail's own success code.

Example:

"00"

competenciaExclusao

integer<int64>

required

Payroll competência in which the exclusion takes effect, yyyyMM.

Example:

202609

hashOperacao

string

required

The rail's own identity for this operation. Texto on this operation, unlike the other exclusion operations where the same field name is Número.

Example:

"34006311"

mensagem

string

required

The rail's own message.

Example:

"Exclusao realizada com sucesso"

numeroContrato

string

required

The contract this exclusion removed from the origin institution.

Example:

"99999999999AP1"

submittedAt

string<date-time>

required

When this gateway durably authorized the rail call, RFC 3339 UTC.

Example:

"2026-08-29T12:00:00Z"

ultimaParcelaPaga

integer<int64>

Last instalment the rail reports as paid on the excluded contract. Omitted when the acknowledgement carries no entry for the commanded contract: 0 is a live value (exclusion before any instalment was paid), so absence must not fabricate it.

Example:

5

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado — Dataprev

Exclude a contract from this institution because the worker ported it out

Authorizations

Headers

Path Parameters

Body

Response