Resolve which engine owns a key

curl --request POST \
  --url https://api.example.com/v1/ownership/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account": "<string>",
  "branch": "<string>",
  "keyValue": "<string>"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/ownership/lookup"

	payload := strings.NewReader("{\n  \"account\": \"<string>\",\n  \"branch\": \"<string>\",\n  \"keyValue\": \"<string>\"\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))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account: '<string>', branch: '<string>', keyValue: '<string>'})
};

fetch('https://api.example.com/v1/ownership/lookup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/ownership/lookup"

payload = {
    "account": "<string>",
    "branch": "<string>",
    "keyValue": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "keyKind": "ACCOUNT",
  "keyValue": "<string>",
  "resolved": true,
  "resolvedAt": "2023-11-07T05:31:56Z",
  "source": "ASSIGNMENT_MAP",
  "engineId": "<string>",
  "ownedByCaller": true
}

{
  "code": "<string>",
  "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"
  }
}

{
  "code": "<string>",
  "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"
  }
}

{
  "code": "<string>",
  "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"
  }
}

{
  "code": "<string>",
  "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"
  }
}

{
  "code": "<string>",
  "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"
  }
}

Resolve which engine owns a key

Authoritative, never advisory. 200 resolved:true names the owning engine; 200 resolved:false is a decided negative — nobody’s key, or another tenant’s, indistinguishably; 503 means the Courier cannot answer and the caller fails the payment closed. This operation never answers 404. A POST that reads: the key is personal data and travels in the body, never in a URL. An engine treats ANY status other than 200 and 422 as fail-closed — 404, 405, 429 and every 5xx included — and keys on the code (JDC-9001), never on the detail sentence. The 503 sentence names what could not answer — the ownership map, or the engine credential (registry or tenant database) — and both tell the engine to fail closed.

POST

ownership

lookup

curl --request POST \
  --url https://api.example.com/v1/ownership/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account": "<string>",
  "branch": "<string>",
  "keyValue": "<string>"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/ownership/lookup"

	payload := strings.NewReader("{\n  \"account\": \"<string>\",\n  \"branch\": \"<string>\",\n  \"keyValue\": \"<string>\"\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))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account: '<string>', branch: '<string>', keyValue: '<string>'})
};

fetch('https://api.example.com/v1/ownership/lookup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/ownership/lookup"

payload = {
    "account": "<string>",
    "branch": "<string>",
    "keyValue": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "keyKind": "ACCOUNT",
  "keyValue": "<string>",
  "resolved": true,
  "resolvedAt": "2023-11-07T05:31:56Z",
  "source": "ASSIGNMENT_MAP",
  "engineId": "<string>",
  "ownedByCaller": true
}

{
  "code": "<string>",
  "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"
  }
}

{
  "code": "<string>",
  "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"
  }
}

{
  "code": "<string>",
  "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"
  }
}

{
  "code": "<string>",
  "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"
  }
}

{
  "code": "<string>",
  "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"
  }
}

Autorizações

Authorization

string

header

obrigatório

An Access Manager application token whose subject is bound to exactly one engine; an engine may hold several, one per calling product. It reaches only the operations its scopes name; the operator surface refuses it.

Corpo

application/json

keyKind

enum<string>

obrigatório

The kind of key.

Opções disponíveis:

ACCOUNT,

DOCUMENT,

PIX_KEY_EMAIL,

PIX_KEY_PHONE,

PIX_KEY_RANDOM,

PAYMENT_ID,

PIX_RECURRENCE_ID,

PIX_RECURRENCE_ID_CHARGER

account

string

ACCOUNT only: the account number, digits with an optional trailing check-digit letter.

Maximum string length: 256

branch

string

ACCOUNT only: a current account's branch, 1 to 4 digits. Omit it, or send it empty, for a payment account, which has none; empty is never branch 0.

Maximum string length: 256

keyValue

string

The key as the caller holds it, for every kind except ACCOUNT. Do not pre-normalize.

Required string length: 1 - 256

Resposta

keyKind

enum<string>

obrigatório

Opções disponíveis:

ACCOUNT,

DOCUMENT,

PIX_KEY_EMAIL,

PIX_KEY_PHONE,

PIX_KEY_RANDOM,

PAYMENT_ID,

PIX_RECURRENCE_ID,

PIX_RECURRENCE_ID_CHARGER

keyValue

string

obrigatório

The normalized form the Courier resolved against.

Maximum string length: 256

resolved

boolean

obrigatório

resolvedAt

string<date-time>

obrigatório

source

enum<string>

obrigatório

Opções disponíveis:

ASSIGNMENT_MAP

engineId

string

Present only when resolved is true.

ownedByCaller

boolean

Present only when resolved is true: whether the owner is the engine whose credential made this call. Compare on this; an engine never needs its own registry id.

Motores

Mapa de titularidade

API dos motores

Canais

Mensagens

Registro de envios

Conciliação

Tratamento de erros

Resolve which engine owns a key

Autorizações

Corpo

Resposta