API reference · Communities & institutions

Credit union returns, supervision and complaints

GET/credit-union/{reference}/access-logRead the cross-union access log
POST/credit-union/{reference}/complaintRecord a complaint
POST/credit-union/{reference}/complaint/{complaintReference}/assignmentAssign a complaint for investigation
POST/credit-union/{reference}/complaint/{complaintReference}/resolutionResolve a complaint
GET/credit-union/{reference}/complaintsRead the complaints register
GET/credit-union/{reference}/report/affiliate-aggregateRead the consolidated affiliate aggregate
GET/credit-union/{reference}/report/affiliate-returnsRead the affiliate return register
GET/credit-union/{reference}/report/complaintsRead the complaints ageing
POST/credit-union/{reference}/returnCompute a return
GET/credit-union/{reference}/return-calendarRead the return calendar
GET/credit-union/{reference}/return/{returnReference}Read one return with its attestations
POST/credit-union/{reference}/return/{returnReference}/acknowledgementRecord the supervisor's acknowledgement or rejection
POST/credit-union/{reference}/return/{returnReference}/attestationAttest a return
POST/credit-union/{reference}/return/{returnReference}/submissionRecord that a return was filed
GET/credit-union/{reference}/returnsList every return this union has computed
POST/credit-union/{reference}/supervisorEngage a supervisor
DELETE/credit-union/{reference}/supervisor/{supervisionReference}Revoke a supervisory relationship
GET/credit-union/{reference}/supervisorsList this union's supervisors

GET Read the cross-union access log

GET /credit-union/{reference}/access-log

Readable by the board of the union whose data was read.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Query parameters

Name	Default
`page`	0
`size`	50

Example

Response: GenericResponseListCrossUnionAccessLogResponse

curl -X GET "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/access-log?page=value&size=50" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "subjectUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "requestingUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "requesterUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "basis": "INSPECTION",
      "scope": "AGGREGATE",
      "scopeDetail": "string",
      "recordsReturned": 0,
      "accessedAt": "2026-09-25T10:00:00Z"
    }
  ],
  "description": "Access log retrieved successfully"
}

Responses

Status	When
`200`	Access log retrieved successfully

POST Record a complaint

POST /credit-union/{reference}/complaint

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`

Example

Request body: RecordComplaintRequest · Response: GenericResponseComplaintResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/complaint" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "category": "TARIFF_OR_CHARGE",
  "channel": "IN_PERSON",
  "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "complainantName": "string",
  "complainantContact": "string",
  "summary": "string",
  "receivedOn": "2026-09-25",
  "subjectReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

{
  "category": "TARIFF_OR_CHARGE",
  "channel": "IN_PERSON",
  "positionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "complainantName": "string",
  "complainantContact": "string",
  "summary": "string",
  "receivedOn": "2026-09-25",
  "subjectReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "respondentRole": "OCCUPANT",
    "subject": "string",
    "status": "AWAITING_DELIVERY",
    "deliveredAt": "2026-09-25T10:00:00Z",
    "responseDueAt": "2026-09-25T10:00:00Z",
    "respondedAt": "2026-09-25T10:00:00Z",
    "confirmationDueAt": "2026-09-25T10:00:00Z",
    "closedAt": "2026-09-25T10:00:00Z",
    "thread": [
      {
        "authorPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "body": "string",
        "creationDateTime": "2026-09-25T10:00:00Z"
      }
    ]
  },
  "description": "Complaint recorded successfully"
}

Responses

Status	When
`200`	Complaint recorded successfully

POST Assign a complaint for investigation

POST /credit-union/{reference}/complaint/{complaintReference}/assignment

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`
`complaintReference`

Example

Request body: AssignComplaintRequest · Response: GenericResponseComplaintResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/complaint/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/assignment" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "assignedToUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "note": "string"
}'

{
  "assignedToUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "note": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "respondentRole": "OCCUPANT",
    "subject": "string",
    "status": "AWAITING_DELIVERY",
    "deliveredAt": "2026-09-25T10:00:00Z",
    "responseDueAt": "2026-09-25T10:00:00Z",
    "respondedAt": "2026-09-25T10:00:00Z",
    "confirmationDueAt": "2026-09-25T10:00:00Z",
    "closedAt": "2026-09-25T10:00:00Z",
    "thread": [
      {
        "authorPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "body": "string",
        "creationDateTime": "2026-09-25T10:00:00Z"
      }
    ]
  },
  "description": "Complaint assigned successfully"
}

Responses

Status	When
`200`	Complaint assigned successfully

POST Resolve a complaint

POST /credit-union/{reference}/complaint/{complaintReference}/resolution

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`
`complaintReference`

Example

Request body: ResolveComplaintRequest · Response: GenericResponseComplaintResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/complaint/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/resolution" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "outcome": "UPHELD",
  "resolutionText": "string",
  "resolvedOn": "2026-09-25",
  "remedyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

{
  "outcome": "UPHELD",
  "resolutionText": "string",
  "resolvedOn": "2026-09-25",
  "remedyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "respondentRole": "OCCUPANT",
    "subject": "string",
    "status": "AWAITING_DELIVERY",
    "deliveredAt": "2026-09-25T10:00:00Z",
    "responseDueAt": "2026-09-25T10:00:00Z",
    "respondedAt": "2026-09-25T10:00:00Z",
    "confirmationDueAt": "2026-09-25T10:00:00Z",
    "closedAt": "2026-09-25T10:00:00Z",
    "thread": [
      {
        "authorPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "body": "string",
        "creationDateTime": "2026-09-25T10:00:00Z"
      }
    ]
  },
  "description": "Complaint resolved successfully"
}

Responses

Status	When
`200`	Complaint resolved successfully

GET Read the complaints register

GET /credit-union/{reference}/complaints

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Query parameters

Name	Default
`status`	Optional
`page`	0
`size`	50

Example

Response: GenericResponseListComplaintResponse

curl -X GET "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/complaints?page=value&size=50" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "tenancyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "respondentRole": "OCCUPANT",
      "subject": "string",
      "status": "AWAITING_DELIVERY",
      "deliveredAt": "2026-09-25T10:00:00Z",
      "responseDueAt": "2026-09-25T10:00:00Z",
      "respondedAt": "2026-09-25T10:00:00Z",
      "confirmationDueAt": "2026-09-25T10:00:00Z",
      "closedAt": "2026-09-25T10:00:00Z",
      "thread": [
        {
          "authorPartyReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "body": "string",
          "creationDateTime": "2026-09-25T10:00:00Z"
        }
      ]
    }
  ],
  "description": "Complaints retrieved successfully"
}

Responses

Status	When
`200`	Complaints retrieved successfully

GET Read the consolidated affiliate aggregate

GET /credit-union/{reference}/report/affiliate-aggregate

Aggregate by default: counts, totals and ratios, never a name or a member number. A figure resting on fewer members than the suppression threshold is withheld rather than rounded, and the read itself is written to the access log.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Query parameters

Name	Default
`asOf`	Optional

Example

Response: GenericResponseAffiliateAggregateResponse

curl -X GET "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/report/affiliate-aggregate" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "asOf": "2026-09-25",
    "currencyCode": "string",
    "affiliatesIncluded": 0,
    "affiliatesWithoutAnAttestedReturn": 0,
    "figures": {},
    "suppressed": [
      "string"
    ],
    "suppressionThreshold": 0,
    "eliminations": {}
  },
  "description": "Affiliate aggregate retrieved successfully"
}

Responses

Status	When
`200`	Affiliate aggregate retrieved successfully

GET Read the affiliate return register

GET /credit-union/{reference}/report/affiliate-returns

Aggregates from affiliates' attested returns only. An affiliate that has not filed appears as a gap, because a consolidated figure with a silent gap in it is the worst of both.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Query parameters

Name	Default
`returnCode`	Optional
`asOf`	Optional

Example

Response: GenericResponseAffiliateReturnRegisterResponse

curl -X GET "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/report/affiliate-returns?returnCode=value" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "returnCode": "CAPITAL_ADEQUACY",
    "periodEnd": "2026-09-25",
    "affiliatesExpected": 0,
    "affiliatesAttested": 0,
    "affiliatesMissing": 0,
    "lines": [
      {
        "affiliateUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "affiliateName": "string",
        "dueOn": "2026-09-25",
        "filingStatus": "FILED",
        "returnReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "attestedAt": "2026-09-25T10:00:00Z",
        "figuresHash": "string",
        "daysLate": 0
      }
    ]
  },
  "description": "Affiliate return register retrieved successfully"
}

Responses

Status	When
`200`	Affiliate return register retrieved successfully

GET Read the complaints ageing

GET /credit-union/{reference}/report/complaints

A union that cannot say how many complaints it received and how long it took to answer them has no complaints process, whatever its bye-laws say.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Query parameters

Name	Default
`from`	Optional
`to`	Optional

Example

Response: GenericResponseComplaintAgeingResponse

curl -X GET "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/report/complaints" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "asOf": "2026-09-25",
    "received": 0,
    "open": 0,
    "resolved": 0,
    "overdue": 0,
    "averageDaysToResolve": 0,
    "openByBucket": {},
    "byCategory": {},
    "byOutcome": {}
  },
  "description": "Complaint ageing retrieved successfully"
}

Responses

Status	When
`200`	Complaint ageing retrieved successfully

POST Compute a return

POST /credit-union/{reference}/return

Freezes the figures and hashes them. Nothing is computed on unreconciled books, and recomputing makes a new return that supersedes the old one rather than editing figures underneath a signature.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`

Example

Request body: ComputeReturnRequest · Response: GenericResponseRegulatoryReturnResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/return" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "returnCode": "CAPITAL_ADEQUACY",
  "periodType": "DAILY",
  "periodEnd": "2026-09-25",
  "currencyCode": "string"
}'

{
  "returnCode": "CAPITAL_ADEQUACY",
  "periodType": "DAILY",
  "periodEnd": "2026-09-25",
  "currencyCode": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "returnCode": "CAPITAL_ADEQUACY",
    "periodType": "DAILY",
    "periodStart": "2026-09-25",
    "periodEnd": "2026-09-25",
    "dueOn": "2026-09-25",
    "status": "DRAFT",
    "currencyCode": "string",
    "figures": {},
    "figuresHash": "string",
    "computedAt": "2026-09-25T10:00:00Z",
    "computedFromReconciliationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "attestedAt": "2026-09-25T10:00:00Z",
    "submittedAt": "2026-09-25T10:00:00Z",
    "submissionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "acknowledgementReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "rejectionReason": "string",
    "supersedesReturnReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "attestations": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "returnReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "attesterUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "officeCode": "CHAIRPERSON",
        "attestedAt": "2026-09-25T10:00:00Z",
        "statementText": "string",
        "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
      }
    ],
    "breachesInPeriod": [
      "string"
    ]
  },
  "description": "Return computed successfully"
}

Responses

Status	When
`200`	Return computed successfully

GET Read the return calendar

GET /credit-union/{reference}/return-calendar

Derived from the returns each live supervisor requires, never stored. An affiliate's deadline comes from its parent's less the affiliation's lead days, so the two cannot drift apart.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Query parameters

Name	Default
`asOf`	Optional

Example

Response: GenericResponseListReturnCalendarEntryResponse

curl -X GET "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/return-calendar" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "returnCode": "CAPITAL_ADEQUACY",
      "periodType": "DAILY",
      "periodStart": "2026-09-25",
      "periodEnd": "2026-09-25",
      "dueOn": "2026-09-25",
      "leadDaysFromParent": 0,
      "filingStatus": "FILED",
      "returnReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "daysUntilDue": 0
    }
  ],
  "description": "Return calendar retrieved successfully"
}

Responses

Status	When
`200`	Return calendar retrieved successfully

GET Read one return with its attestations

GET /credit-union/{reference}/return/{returnReference}

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`
`returnReference`

Example

Response: GenericResponseRegulatoryReturnResponse

curl -X GET "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/return/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "returnCode": "CAPITAL_ADEQUACY",
    "periodType": "DAILY",
    "periodStart": "2026-09-25",
    "periodEnd": "2026-09-25",
    "dueOn": "2026-09-25",
    "status": "DRAFT",
    "currencyCode": "string",
    "figures": {},
    "figuresHash": "string",
    "computedAt": "2026-09-25T10:00:00Z",
    "computedFromReconciliationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "attestedAt": "2026-09-25T10:00:00Z",
    "submittedAt": "2026-09-25T10:00:00Z",
    "submissionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "acknowledgementReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "rejectionReason": "string",
    "supersedesReturnReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "attestations": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "returnReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "attesterUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "officeCode": "CHAIRPERSON",
        "attestedAt": "2026-09-25T10:00:00Z",
        "statementText": "string",
        "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
      }
    ],
    "breachesInPeriod": [
      "string"
    ]
  },
  "description": "Return retrieved successfully"
}

Responses

Status	When
`200`	Return retrieved successfully

POST Record the supervisor's acknowledgement or rejection

POST /credit-union/{reference}/return/{returnReference}/acknowledgement

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`
`returnReference`

Example

Request body: AcknowledgeReturnRequest · Response: GenericResponseRegulatoryReturnResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/return/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/acknowledgement" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "acknowledgementReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "rejectionReason": "string"
}'

{
  "acknowledgementReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "rejectionReason": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "returnCode": "CAPITAL_ADEQUACY",
    "periodType": "DAILY",
    "periodStart": "2026-09-25",
    "periodEnd": "2026-09-25",
    "dueOn": "2026-09-25",
    "status": "DRAFT",
    "currencyCode": "string",
    "figures": {},
    "figuresHash": "string",
    "computedAt": "2026-09-25T10:00:00Z",
    "computedFromReconciliationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "attestedAt": "2026-09-25T10:00:00Z",
    "submittedAt": "2026-09-25T10:00:00Z",
    "submissionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "acknowledgementReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "rejectionReason": "string",
    "supersedesReturnReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "attestations": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "returnReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "attesterUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "officeCode": "CHAIRPERSON",
        "attestedAt": "2026-09-25T10:00:00Z",
        "statementText": "string",
        "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
      }
    ],
    "breachesInPeriod": [
      "string"
    ]
  },
  "description": "Return acknowledgement recorded successfully"
}

Responses

Status	When
`200`	Return acknowledgement recorded successfully

POST Attest a return

POST /credit-union/{reference}/return/{returnReference}/attestation

The signature names the office it was given in. A return reaches ATTESTED only when every office that must sign it has, against the same figures hash.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`
`returnReference`

Example

Request body: AttestReturnRequest · Response: GenericResponseReturnAttestationResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/return/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/attestation" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "officeCode": "CHAIRPERSON",
  "statementText": "string",
  "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

{
  "officeCode": "CHAIRPERSON",
  "statementText": "string",
  "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "returnReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "attesterUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "officeCode": "CHAIRPERSON",
    "attestedAt": "2026-09-25T10:00:00Z",
    "statementText": "string",
    "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  },
  "description": "Return attested successfully"
}

Responses

Status	When
`200`	Return attested successfully

POST Record that a return was filed

POST /credit-union/{reference}/return/{returnReference}/submission

The module computes, packages and records. It does not transmit.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`
`returnReference`

Example

Request body: SubmitReturnRequest · Response: GenericResponseRegulatoryReturnResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/return/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/submission" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "submissionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "filedToSupervisorReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

{
  "submissionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "filedToSupervisorReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "returnCode": "CAPITAL_ADEQUACY",
    "periodType": "DAILY",
    "periodStart": "2026-09-25",
    "periodEnd": "2026-09-25",
    "dueOn": "2026-09-25",
    "status": "DRAFT",
    "currencyCode": "string",
    "figures": {},
    "figuresHash": "string",
    "computedAt": "2026-09-25T10:00:00Z",
    "computedFromReconciliationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "attestedAt": "2026-09-25T10:00:00Z",
    "submittedAt": "2026-09-25T10:00:00Z",
    "submissionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "acknowledgementReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "rejectionReason": "string",
    "supersedesReturnReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "attestations": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "returnReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "attesterUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "officeCode": "CHAIRPERSON",
        "attestedAt": "2026-09-25T10:00:00Z",
        "statementText": "string",
        "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
      }
    ],
    "breachesInPeriod": [
      "string"
    ]
  },
  "description": "Return submission recorded successfully"
}

Responses

Status	When
`200`	Return submission recorded successfully

GET List every return this union has computed

GET /credit-union/{reference}/returns

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseListRegulatoryReturnResponse

curl -X GET "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/returns" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "returnCode": "CAPITAL_ADEQUACY",
      "periodType": "DAILY",
      "periodStart": "2026-09-25",
      "periodEnd": "2026-09-25",
      "dueOn": "2026-09-25",
      "status": "DRAFT",
      "currencyCode": "string",
      "figures": {},
      "figuresHash": "string",
      "computedAt": "2026-09-25T10:00:00Z",
      "computedFromReconciliationReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "attestedAt": "2026-09-25T10:00:00Z",
      "submittedAt": "2026-09-25T10:00:00Z",
      "submissionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "acknowledgementReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "rejectionReason": "string",
      "supersedesReturnReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "attestations": [
        {
          "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "returnReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "attesterUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
          "officeCode": "CHAIRPERSON",
          "attestedAt": "2026-09-25T10:00:00Z",
          "statementText": "string",
          "documentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
        }
      ],
      "breachesInPeriod": [
        "string"
      ]
    }
  ],
  "description": "Returns retrieved successfully"
}

Responses

Status	When
`200`	Returns retrieved successfully

POST Engage a supervisor

POST /credit-union/{reference}/supervisor

Supervision is a relationship, not an assumption. A union may answer to its parent, to a regulator, or to both at once, and each requires its own set of returns.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`reference`

Example

Request body: SupervisoryRelationshipRequest · Response: GenericResponseSupervisoryRelationshipResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/supervisor" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "supervisorType": "PARENT_UNION",
  "supervisorUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "supervisorName": "string",
  "returnCodes": [
    "CAPITAL_ADEQUACY"
  ],
  "effectiveFrom": "2026-09-25",
  "filingDayOfMonth": 0
}'

{
  "supervisorType": "PARENT_UNION",
  "supervisorUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "supervisorName": "string",
  "returnCodes": [
    "CAPITAL_ADEQUACY"
  ],
  "effectiveFrom": "2026-09-25",
  "filingDayOfMonth": 0
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "supervisorType": "PARENT_UNION",
    "supervisorUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "supervisorName": "string",
    "returnCodes": [
      "CAPITAL_ADEQUACY"
    ],
    "status": "ACTIVE",
    "effectiveFrom": "2026-09-25",
    "effectiveTo": "2026-09-25",
    "filingDayOfMonth": 0
  },
  "description": "Supervisor engaged successfully"
}

Responses

Status	When
`200`	Supervisor engaged successfully

DELETE Revoke a supervisory relationship

DELETE /credit-union/{reference}/supervisor/{supervisionReference}

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`
`supervisionReference`

Query parameters

Name	Default
`reason`	Optional

Example

Response: GenericResponseSupervisoryRelationshipResponse

curl -X DELETE "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/supervisor/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "supervisorType": "PARENT_UNION",
    "supervisorUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "supervisorName": "string",
    "returnCodes": [
      "CAPITAL_ADEQUACY"
    ],
    "status": "ACTIVE",
    "effectiveFrom": "2026-09-25",
    "effectiveTo": "2026-09-25",
    "filingDayOfMonth": 0
  },
  "description": "Supervisor revoked successfully"
}

Responses

Status	When
`200`	Supervisor revoked successfully

GET List this union's supervisors

GET /credit-union/{reference}/supervisors

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`reference`

Example

Response: GenericResponseListSupervisoryRelationshipResponse

curl -X GET "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/supervisors" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "unionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "supervisorType": "PARENT_UNION",
      "supervisorUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "supervisorName": "string",
      "returnCodes": [
        "CAPITAL_ADEQUACY"
      ],
      "status": "ACTIVE",
      "effectiveFrom": "2026-09-25",
      "effectiveTo": "2026-09-25",
      "filingDayOfMonth": 0
    }
  ],
  "description": "Supervisors retrieved successfully"
}

Responses

Status	When
`200`	Supervisors retrieved successfully

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors