API reference · Communities & institutions

Credit union affiliations

GET/credit-union/affiliation/{affiliationReference}Read an affiliation
POST/credit-union/affiliation/{affiliationReference}/terminateTerminate an affiliation
POST/credit-union/{reference}/affiliationApply to affiliate to a parent union
POST/credit-union/{reference}/affiliation/{affiliationReference}/approveApprove an affiliation
POST/credit-union/{reference}/affiliation/{affiliationReference}/rejectReject an affiliation
GET/credit-union/{reference}/affiliationsList the societies affiliated to this union

GET Read an affiliation

GET /credit-union/affiliation/{affiliationReference}

Headers

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

Path parameters

Name
`affiliationReference`

Example

Response: GenericResponseAffiliationResponse

curl -X GET "https://api.bridgemoni.com/credit-union/affiliation/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",
    "childUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "ACTIVE",
    "onboardingStage": "AFFILIATED",
    "formationRoute": "INDEPENDENT",
    "sponsorReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "supervisionMandateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "charteredAt": "2026-09-25T10:00:00Z",
    "incubationEndsOn": "2026-09-25",
    "probationEndsOn": "2026-09-25",
    "graduatedAt": "2026-09-25T10:00:00Z",
    "duesModel": "FLAT",
    "duesAmount": 0,
    "duesBasisPoints": 0,
    "duesFrequency": "string",
    "duesCurrencyCode": "string",
    "nextDuesDueOn": "2026-09-25",
    "placementAllowed": true,
    "placementCeiling": 0,
    "minimumPlacementAmount": 0,
    "refinanceCeiling": 0,
    "votingWeight": 0,
    "returnLeadDays": 0,
    "appliedAt": "2026-09-25T10:00:00Z",
    "approvedAt": "2026-09-25T10:00:00Z",
    "approvedByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "exitRoute": "RELEASED",
    "transferredToUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "terminatedAt": "2026-09-25T10:00:00Z",
    "terminationReason": "string"
  },
  "description": "Affiliation retrieved successfully"
}

Responses

Status	When
`200`	Affiliation retrieved successfully

POST Terminate an affiliation

POST /credit-union/affiliation/{affiliationReference}/terminate

RELEASED leaves the society independent and detaches the community edge; TRANSFERRED moves it to another parent.

Headers

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

Path parameters

Name
`affiliationReference`

Example

Request body: TerminateAffiliationRequest · Response: GenericResponseAffiliationResponse

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

{
  "exitRoute": "RELEASED",
  "transferToUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "reason": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "childUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "ACTIVE",
    "onboardingStage": "AFFILIATED",
    "formationRoute": "INDEPENDENT",
    "sponsorReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "supervisionMandateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "charteredAt": "2026-09-25T10:00:00Z",
    "incubationEndsOn": "2026-09-25",
    "probationEndsOn": "2026-09-25",
    "graduatedAt": "2026-09-25T10:00:00Z",
    "duesModel": "FLAT",
    "duesAmount": 0,
    "duesBasisPoints": 0,
    "duesFrequency": "string",
    "duesCurrencyCode": "string",
    "nextDuesDueOn": "2026-09-25",
    "placementAllowed": true,
    "placementCeiling": 0,
    "minimumPlacementAmount": 0,
    "refinanceCeiling": 0,
    "votingWeight": 0,
    "returnLeadDays": 0,
    "appliedAt": "2026-09-25T10:00:00Z",
    "approvedAt": "2026-09-25T10:00:00Z",
    "approvedByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "exitRoute": "RELEASED",
    "transferredToUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "terminatedAt": "2026-09-25T10:00:00Z",
    "terminationReason": "string"
  },
  "description": "Affiliation terminated successfully"
}

Responses

Status	When
`200`	Affiliation terminated successfully

POST Apply to affiliate to a parent union

POST /credit-union/{reference}/affiliation

An existing, independently registered society applies upward. The parent's tier must be strictly higher, it may not be a descendant of the applicant, neither may be a branch, and the applicant may not already be affiliated elsewhere.

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: AffiliationRequest · Response: GenericResponseAffiliationResponse

curl -X POST "https://api.bridgemoni.com/credit-union/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/affiliation" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "duesModel": "PER_MEMBER",
  "duesAmount": 250.0,
  "duesBasisPoints": 25,
  "duesFrequency": "ANNUAL",
  "duesCurrencyCode": "string",
  "placementAllowed": true,
  "placementCeiling": 50000000.0,
  "minimumPlacementAmount": 5000000.0,
  "refinanceCeiling": 25000000.0,
  "votingWeight": 1,
  "returnLeadDays": 10
}'

{
  "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "duesModel": "PER_MEMBER",
  "duesAmount": 250.0,
  "duesBasisPoints": 25,
  "duesFrequency": "ANNUAL",
  "duesCurrencyCode": "string",
  "placementAllowed": true,
  "placementCeiling": 50000000.0,
  "minimumPlacementAmount": 5000000.0,
  "refinanceCeiling": 25000000.0,
  "votingWeight": 1,
  "returnLeadDays": 10
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "childUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "ACTIVE",
    "onboardingStage": "AFFILIATED",
    "formationRoute": "INDEPENDENT",
    "sponsorReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "supervisionMandateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "charteredAt": "2026-09-25T10:00:00Z",
    "incubationEndsOn": "2026-09-25",
    "probationEndsOn": "2026-09-25",
    "graduatedAt": "2026-09-25T10:00:00Z",
    "duesModel": "FLAT",
    "duesAmount": 0,
    "duesBasisPoints": 0,
    "duesFrequency": "string",
    "duesCurrencyCode": "string",
    "nextDuesDueOn": "2026-09-25",
    "placementAllowed": true,
    "placementCeiling": 0,
    "minimumPlacementAmount": 0,
    "refinanceCeiling": 0,
    "votingWeight": 0,
    "returnLeadDays": 0,
    "appliedAt": "2026-09-25T10:00:00Z",
    "approvedAt": "2026-09-25T10:00:00Z",
    "approvedByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "exitRoute": "RELEASED",
    "transferredToUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "terminatedAt": "2026-09-25T10:00:00Z",
    "terminationReason": "string"
  },
  "description": "Affiliation applied for successfully"
}

Responses

Status	When
`200`	Affiliation applied for successfully

POST Approve an affiliation

POST /credit-union/{reference}/affiliation/{affiliationReference}/approve

Reparents the community in the same transaction, so the tree and the terms can never disagree.

Headers

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

Path parameters

Name
`reference`
`affiliationReference`

Example

Request body: AffiliationDecisionRequest · Response: GenericResponseAffiliationResponse

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

{
  "rationale": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "childUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "ACTIVE",
    "onboardingStage": "AFFILIATED",
    "formationRoute": "INDEPENDENT",
    "sponsorReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "supervisionMandateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "charteredAt": "2026-09-25T10:00:00Z",
    "incubationEndsOn": "2026-09-25",
    "probationEndsOn": "2026-09-25",
    "graduatedAt": "2026-09-25T10:00:00Z",
    "duesModel": "FLAT",
    "duesAmount": 0,
    "duesBasisPoints": 0,
    "duesFrequency": "string",
    "duesCurrencyCode": "string",
    "nextDuesDueOn": "2026-09-25",
    "placementAllowed": true,
    "placementCeiling": 0,
    "minimumPlacementAmount": 0,
    "refinanceCeiling": 0,
    "votingWeight": 0,
    "returnLeadDays": 0,
    "appliedAt": "2026-09-25T10:00:00Z",
    "approvedAt": "2026-09-25T10:00:00Z",
    "approvedByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "exitRoute": "RELEASED",
    "transferredToUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "terminatedAt": "2026-09-25T10:00:00Z",
    "terminationReason": "string"
  },
  "description": "Affiliation approved successfully"
}

Responses

Status	When
`200`	Affiliation approved successfully

POST Reject an affiliation

POST /credit-union/{reference}/affiliation/{affiliationReference}/reject

Leaves the tree untouched.

Headers

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

Path parameters

Name
`reference`
`affiliationReference`

Example

Request body: AffiliationDecisionRequest · Response: GenericResponseAffiliationResponse

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

{
  "rationale": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "childUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "status": "ACTIVE",
    "onboardingStage": "AFFILIATED",
    "formationRoute": "INDEPENDENT",
    "sponsorReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "supervisionMandateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "charteredAt": "2026-09-25T10:00:00Z",
    "incubationEndsOn": "2026-09-25",
    "probationEndsOn": "2026-09-25",
    "graduatedAt": "2026-09-25T10:00:00Z",
    "duesModel": "FLAT",
    "duesAmount": 0,
    "duesBasisPoints": 0,
    "duesFrequency": "string",
    "duesCurrencyCode": "string",
    "nextDuesDueOn": "2026-09-25",
    "placementAllowed": true,
    "placementCeiling": 0,
    "minimumPlacementAmount": 0,
    "refinanceCeiling": 0,
    "votingWeight": 0,
    "returnLeadDays": 0,
    "appliedAt": "2026-09-25T10:00:00Z",
    "approvedAt": "2026-09-25T10:00:00Z",
    "approvedByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "exitRoute": "RELEASED",
    "transferredToUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "terminatedAt": "2026-09-25T10:00:00Z",
    "terminationReason": "string"
  },
  "description": "Affiliation rejected successfully"
}

Responses

Status	When
`200`	Affiliation rejected successfully

GET List the societies affiliated to this union

GET /credit-union/{reference}/affiliations

Headers

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

Path parameters

Name
`reference`

Example

Response: GenericResponseListAffiliationResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "childUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "parentUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "status": "ACTIVE",
      "onboardingStage": "AFFILIATED",
      "formationRoute": "INDEPENDENT",
      "sponsorReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "supervisionMandateReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "charteredAt": "2026-09-25T10:00:00Z",
      "incubationEndsOn": "2026-09-25",
      "probationEndsOn": "2026-09-25",
      "graduatedAt": "2026-09-25T10:00:00Z",
      "duesModel": "FLAT",
      "duesAmount": 0,
      "duesBasisPoints": 0,
      "duesFrequency": "string",
      "duesCurrencyCode": "string",
      "nextDuesDueOn": "2026-09-25",
      "placementAllowed": true,
      "placementCeiling": 0,
      "minimumPlacementAmount": 0,
      "refinanceCeiling": 0,
      "votingWeight": 0,
      "returnLeadDays": 0,
      "appliedAt": "2026-09-25T10:00:00Z",
      "approvedAt": "2026-09-25T10:00:00Z",
      "approvedByUserReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "exitRoute": "RELEASED",
      "transferredToUnionReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "terminatedAt": "2026-09-25T10:00:00Z",
      "terminationReason": "string"
    }
  ],
  "description": "Affiliations retrieved successfully"
}

Responses

Status	When
`200`	Affiliations retrieved successfully

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