The building blocks
A partner is a record of your tenant. The rows after it describe what you set for a partner.
Products that accept partners
You can give a partner permissions only on a product that accepts partners. A product accepts partners when it publishes a scope catalog with the partner opt-in. To see which products accept partners in your deployment, read the scope catalogs with List scope catalogs. A product accepts partners when its entry has
partners: true. A product without an entry has not published a scope catalog.
In the Console, the Products step of the new partner page lists only the products that accept partners, and says how many other products do not accept partners.
Each product has its own page with its restrictions, the fields where the partner names its items, and the refusals it receives:
- Partners in Midaz
- Partners in Pix JD
- Partners in Pix Lerian
- Partners in Reporter
- Partners in Flowker
- Partners in BC Correios
- Partners in TED
- Partners in TED Lerian
- Partners in Payments BTG
loanProductId). See Lender REST API.
Tracer also accepts partners, confined to rules, limits, transaction validations, audit events, portfolios, segments, merchants or accounts. See Tracer environment variables.
Lerian Consignado accepts partners on its fund and originador routes, confined to funds or originadores. See How Lerian Consignado works.
JD Courier accepts JD as a partner. See JD Courier deployment.
What you need to know
- Each product sets its own dimensions in its scope catalog. The catalog says if a dimension is required, and if it takes more than one value.
- A partner with permissions in a product that declares dimensions needs a scope there. Give it at least one scope entry for that product. Without one, Access Manager refuses to create or change the partner, with
400andIDE-1060. A partner saved before this rule, without a scope entry, is refused with403on every request to that product until you add one. - The exception is a permission entry that holds only permissions that the product reserves for partners. Such an entry needs no scope, and it applies to the whole tenant. In Pix JD, these are JD’s channel permissions.
- When a product marks a dimension as required, a partner with permissions on that product needs a scope entry for it. Without it, Access Manager refuses the partner with
IDE-0001. - Outside an entry of reserved permissions, a partner reaches only what its permissions and its scope both allow.
- When a product publishes which dimensions each of its routes carries, Access Manager refuses a permission that no request of the partner can use inside its scope. The refusal is
400withIDE-1052, and its message names the product, the resource, and the action. - Access Manager does not check that scope values exist in the product. It stores the values you enter. Copy them from the product’s own API or Console.
- You cannot delete a partner that has applications. Delete its applications first.
- Access Manager refuses a permission above the ceiling with
IDE-1043. The Console marks it as Not allowed.
How a request is decided
Every request that a partner’s application sends to a product is checked against the partner’s record, in this order. The first check that fails decides the answer:
- Network address. The caller’s address is checked against the partner’s own IP list, or your tenant’s list when the partner has none.
- State. The partner must be
active. - Validity window. The request must be inside the partner’s validity window.
- Permissions. The product, the resource, and the action must be in the partner’s permissions.
- Scope. The items that the request names must be inside the partner’s scope. A permission that the product reserves for partners skips this check.
When a change applies
Every change you make to a partner applies without a new token: its permissions, its scope, its state, its validity window, and its IP list.
Next steps
Manage partners in the Console
Create a partner step by step, create its applications, suspend it, or delete it.
Manage partners via API
The partner operations, their fields, examples, and error codes.
Partners in Midaz
Confine a partner to one organization and to its ledgers, accounts, or routes.
Partners in Pix JD
Confine a partner to a direct participant or to one indirect participant.
IP allowlist
Your tenant’s list of trusted network addresses.

