> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Read one ownership assignment ## OpenAPI ````yaml /pt/openapi/v3-current/jd-courier.yaml get /v1/ownership/assignments/{assignmentId} openapi: 3.1.0 info: contact: email: support@lerian.studio name: Lerian Studio Support description: >- JD Courier lets several core engines share one JD channel and one ISPB on the SPB and Pix rails. Operators use this API to register the engines, keep the ownership map that decides which engine each message belongs to, activate the rails, re-run the routing of retained messages and reconcile what the channel carried. Engines use it to resolve and claim ownership and to relay a same-bank payment to the core that owns the payee account; their SPB sends and reads go through the Courier's mirror of the vendor's SOAP surface, and their Pix calls through its JDPI transit, not through this API. license: name: Lerian Studio General License title: JD Courier API version: v1.0.0 servers: [] security: - BearerAuth: [] tags: - description: >- The engine registry: the cores that consume the JD channel through the Courier, each with its participant set name: Engines - description: 'The ownership map: which engine owns each key. Every change is audited.' name: ownership - description: >- The rails: what each declares about itself, its activation and state per tenant, and its delivery modes name: channels - description: >- The engines' side of the ownership map: resolution for the on-us gate, authoritative and never advisory, the claim of the accounts, charger documents and Pix Automático recurrences the engine holds, and the declaration of a payment leg it holds. name: ownership-query - description: >- A same-bank Pix or TED between two cores: the Courier asks the map who owns the payee account, forwards the body byte for byte to that engine's address for the rail, and relays its answer. It stores, retries and posts nothing; bodies are not modelled. name: cross-core - description: >- The durable message store: redelivery on demand, without asking the vendor again name: ledger - description: >- Count reconciliation per rail: E(m) = C(m) + T(m) + R(m), the sequence gaps it saw, and the sends whose return leg never arrived name: assurance - description: >- The SPB send journal: every send, written before it leaves, and the sends whose outcome is unknown. A by-hand close records an operator's finding and never resends. name: send-journal - description: >- Per-(tenant, channel) state an operator acts on: lifting a durable channel halt name: channel-leases - description: >- Messages the Courier holds because no engine could receive them. A routing or delivery retention leaves by itself once its cause lifts, or when an operator asks for its routing decision to be run again. name: retained paths: /v1/ownership/assignments/{assignmentId}: get: tags: - ownership summary: Read one ownership assignment operationId: getOwnershipAssignment parameters: - description: >- Surrogate identifier of the assignment. Find one by keyKind + keyValue on the collection. in: path name: assignmentId required: true schema: description: >- Surrogate identifier of the assignment. Find one by keyKind + keyValue on the collection. format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/OwnershipAssignment' description: OK '400': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Bad Request '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unauthorized '403': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Forbidden '404': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Not Found '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error '503': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Service Unavailable components: schemas: OwnershipAssignment: additionalProperties: false properties: assignmentId: format: uuid type: string engineId: pattern: ^[a-z0-9-]{1,32}$ type: string keyKind: enum: - ACCOUNT - DOCUMENT - PIX_KEY_EMAIL - PIX_KEY_PHONE - PIX_KEY_RANDOM - PAYMENT_ID - PIX_RECURRENCE_ID - PIX_RECURRENCE_ID_CHARGER type: string keyValue: description: >- Normalized form. This is what the rails resolve against. ACCOUNT is :, and : for a payment account. maxLength: 256 type: string keyValueRaw: description: Exactly what the operator typed. maxLength: 256 type: string previousEngineId: description: Present after a move. type: - string - 'null' updatedAt: format: date-time type: string updatedBy: maxLength: 128 type: string required: - assignmentId - keyKind - keyValue - engineId - updatedAt type: object Detail: additionalProperties: true properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.