> ## 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.

# Receive and parse a remittance file

> A caller POSTs the object key of a file already present in the shared inbound bucket, the institution id, and the SISBAJUD file-type code; the service runs the receive and parse pipeline synchronously. A bad body maps to 422; a missing inbound object to 404; a benign concurrent skip to 200.



## OpenAPI

````yaml en/openapi/v3-current/sisbajud.yaml post /remittance-files/notifications
openapi: 3.1.0
info:
  description: >-
    API for Lerian SISBAJUD — the participant-side rail that integrates the
    institution with Banco Central do Brasil's SISBAJUD (Sistema de Busca de
    Ativos do Poder Judiciário) system for judicial asset blocking and
    unblocking. It covers judicial-order administration, remittance and return
    file management, reconciliation, SLA monitoring, LGPD data-subject requests,
    and per-institution configuration and connector credentials.
  title: Lerian SISBAJUD API
  version: 1.0.0
servers:
  - url: https://sisbajud.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - description: >-
      Institution configuration lifecycle: create (with key provisioning), read,
      and partial update of a connector configuration addressed by institution
      id.
    name: Institution
  - description: >-
      LGPD data-subject access, portability, resolution, and cryptographic
      erasure operations, addressed by institution id.
    name: LGPD
  - description: >-
      Manual cryptographic key administration: KEK and tokenization-keyset
      rotation for an institution, addressed by institution id.
    name: Security
  - description: >-
      Judicial-order operational resilience write operations, such as
      reprocessing a FAILED order, addressed by institution id.
    name: Order Operations
  - description: >-
      Non-compliance-log administration, such as registering an SLA-breach
      justification, addressed by institution id.
    name: Non-Compliance
  - description: >-
      Manual reconciliation administration, such as triggering an on-demand
      reconciliation run.
    name: Reconciliation
  - description: >-
      Authenticated remittance-file reception: a caller notifies the service of
      a file already present in the inbound bucket and the service runs the
      receive and parse pipeline.
    name: Remittance File
  - description: >-
      Return (response) file administration, such as forcing an on-demand
      return-file generation outside the scheduled cron.
    name: Return File
  - description: >-
      Local/development-only admin routes (return-file content, monitoring
      close, unblock execute). Mounted only in local and development
      environments; never present in staging or production.
    name: Dev-Only
  - description: >-
      Admin read API: institution-scoped order, file, reconciliation, SLA, and
      processing-stats queries, plus audit-trail integrity verification. PII
      fields are masked unless the caller proves a cleartext grant.
    name: Admin
  - description: >-
      Connector credential registration and rotation: provisions an
      institution's per-connector outbound credential into the SecretStore and
      persists only its reference.
    name: Connector
  - description: >-
      Cross-organization subject summary: consolidates a subject's active blocks
      across the caller institution's Midaz organizations. Reading a subject by
      document is a privileged, audited PII access.
    name: Cross-Org
paths:
  /remittance-files/notifications:
    post:
      tags:
        - Remittance File
      summary: Receive and parse a remittance file
      description: >-
        A caller POSTs the object key of a file already present in the shared
        inbound bucket, the institution id, and the SISBAJUD file-type code; the
        service runs the receive and parse pipeline synchronously. A bad body
        maps to 422; a missing inbound object to 404; a benign concurrent skip
        to 200.
      operationId: notify-remittance-file
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemittanceNotificationRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemittanceNotificationResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    RemittanceNotificationRequest:
      additionalProperties: false
      properties:
        fileType:
          description: The SISBAJUD file-type code.
          examples:
            - REMESSA
          type: string
        institutionCode:
          description: >-
            The institution's BACEN CNPJ code (8 digits) used for file header
            validation.
          examples:
            - '12345678'
          type: string
        institutionId:
          description: The institution id the file belongs to.
          examples:
            - 44444444-4444-4444-4444-444444444444
          type: string
        objectKey:
          description: >-
            The object key of the file already present in the shared inbound
            bucket.
          examples:
            - inbound/2026/07/14/remessa-001.txt
          type: string
      required:
        - objectKey
        - institutionId
        - institutionCode
        - fileType
      type: object
    RemittanceNotificationResponse:
      additionalProperties: false
      properties:
        environment:
          description: The resolved SISBAJUD environment (processed outcomes only).
          examples:
            - production
          type: string
        fileId:
          description: The persisted file id (processed outcomes only).
          examples:
            - dddddddd-dddd-dddd-dddd-dddddddddddd
          type: string
        reason:
          description: The skip reason (skipped outcomes only).
          examples:
            - skipped
          type: string
        status:
          description: The reception outcome (processed or skipped).
          examples:
            - processed
          type: string
      required:
        - status
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          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
      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
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````