Ownership history for one key, addressed by the key

curl --request POST \
  --url https://api.example.com/v1/ownership/audit/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/audit/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/audit/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/audit/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)

{
  "items": [
    {
      "actor": "<string>",
      "changedAt": "2023-11-07T05:31:56Z",
      "keyKind": "ACCOUNT",
      "keyValue": "<string>",
      "newEngineId": "<string>",
      "previousEngineId": "<string>",
      "reason": "<string>"
    }
  ],
  "limit": 2,
  "page": 2
}

{
  "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"
  }
}

{
  "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"
  }
}

Ownership history for one key, addressed by the key

The same history as the by-assignment route, addressed by the key sent as held, normalized exactly as the lookup normalizes it. It needs no live assignment, so the history of a removed key — the removal included — stays readable. Most recent first. A read: it changes nothing and takes no X-Idempotency. The key travels in the body because it is personal data; a malformed key is refused 422 JDC-0104 with a fixed sentence that never repeats it.

POST

ownership

audit

lookup

Ownership history for one key, addressed by the key

curl --request POST \
  --url https://api.example.com/v1/ownership/audit/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/audit/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/audit/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/audit/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)

{
  "items": [
    {
      "actor": "<string>",
      "changedAt": "2023-11-07T05:31:56Z",
      "keyKind": "ACCOUNT",
      "keyValue": "<string>",
      "newEngineId": "<string>",
      "previousEngineId": "<string>",
      "reason": "<string>"
    }
  ],
  "limit": 2,
  "page": 2
}

{
  "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"
  }
}

{
  "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"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

page

integer<int64>

predeterminado:1

Page, 1-based.

Rango requerido: x >= 1

limit

integer<int64>

predeterminado:50

Items per page.

Rango requerido: 1 <= x <= 200

Cuerpo

application/json

keyKind

enum<string>

requerido

The kind of key.

Opciones disponibles:

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

Respuesta

items

object[] | null

requerido

Show child attributes

limit

integer<int64>

requerido

Rango requerido: x >= 1

page

integer<int64>

requerido

Rango requerido: x >= 1

Motores

Mapa de titularidad

API de los motores

Canales

Mensajes

Registro de envíos

Conciliación

Manejo de errores

Ownership history for one key, addressed by the key

Autorizaciones

Parámetros de consulta

Cuerpo

Respuesta