API reference · Protection & control

Offboarding

DELETE/accountholder/offboarding/requestCancel the current offboarding request
GET/accountholder/offboarding/requestFetch the current offboarding request
POST/accountholder/offboarding/requestRequest offboarding
POST/accountholder/offboarding/request/otpSend a one-time passcode for an offboarding request

DELETE Cancel the current offboarding request

DELETE /accountholder/offboarding/request

Cancels the calling accountholder's open offboarding request. Cancelling needs only a valid session and no step-up: a false cancel costs a re-request, where a false completion costs an account. It is a clean no-op until the request reaches the point of closing accounts with external providers, after which it is refused.

Headers

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

Example

Response: GenericResponseOffboardingRequestResponse

curl -X DELETE "https://api.bridgemoni.com/accountholder/offboarding/request" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "accepted": true,
    "outcome": "ACCEPTED",
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "state": "REQUESTED",
    "requestedDateTime": "2026-09-25T10:00:00Z",
    "eligibleToStartDateTime": "2026-09-25T10:00:00Z",
    "nextAttemptAt": "2026-09-25T10:00:00Z",
    "coolingOffHoursRemaining": 0,
    "cancellable": true,
    "attemptCount": 0,
    "parkReason": "OPEN_OBLIGATION",
    "rejectionReason": "ACCOUNTS_NOT_EMPTY",
    "rejectedAtCheck": "SUBMISSION",
    "accounts": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "type": "string",
        "currencyCode": "string",
        "action": "EMPTY",
        "availableBalance": 0,
        "reservedBalance": 0,
        "committedBalance": 0,
        "lienedBalance": 0,
        "dailyDebitLimit": 0,
        "estimatedDaysToEmpty": 0,
        "blockedBy": "string"
      }
    ],
    "obligations": [
      {
        "type": "string",
        "description": "string",
        "amount": 0,
        "currencyCode": "string",
        "expectedClearanceDate": "2026-09-25"
      }
    ]
  },
  "description": "Offboarding request cancelled"
}

Responses

Status	When
`200`	Offboarding request cancelled
`404`	No open offboarding request
`409`	The request has already begun closing provider accounts

GET Fetch the current offboarding request

GET /accountholder/offboarding/request

Returns the calling accountholder's open offboarding request, what it is waiting on, and when it will next be looked at. Poll this rather than re-submitting.

Headers

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

Example

Response: GenericResponseOffboardingRequestResponse

curl -X GET "https://api.bridgemoni.com/accountholder/offboarding/request" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "accepted": true,
    "outcome": "ACCEPTED",
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "state": "REQUESTED",
    "requestedDateTime": "2026-09-25T10:00:00Z",
    "eligibleToStartDateTime": "2026-09-25T10:00:00Z",
    "nextAttemptAt": "2026-09-25T10:00:00Z",
    "coolingOffHoursRemaining": 0,
    "cancellable": true,
    "attemptCount": 0,
    "parkReason": "OPEN_OBLIGATION",
    "rejectionReason": "ACCOUNTS_NOT_EMPTY",
    "rejectedAtCheck": "SUBMISSION",
    "accounts": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "type": "string",
        "currencyCode": "string",
        "action": "EMPTY",
        "availableBalance": 0,
        "reservedBalance": 0,
        "committedBalance": 0,
        "lienedBalance": 0,
        "dailyDebitLimit": 0,
        "estimatedDaysToEmpty": 0,
        "blockedBy": "string"
      }
    ],
    "obligations": [
      {
        "type": "string",
        "description": "string",
        "amount": 0,
        "currencyCode": "string",
        "expectedClearanceDate": "2026-09-25"
      }
    ]
  },
  "description": "Offboarding request fetched"
}

Responses

Status	When
`200`	Offboarding request fetched
`404`	No open offboarding request

POST Request offboarding

POST /accountholder/offboarding/request

Queues an offboarding request for the calling accountholder. Every financial account must already be empty - all four balance tiers at zero and no open lien - because offboarding never moves money on the holder's behalf. A request against a funded account is refused with an itemised list of what to withdraw, what to wait for, and roughly how many days the daily debit limit will take. An accepted request waits out a cooling-off window of at least 48 hours before anything happens, is cancellable throughout, and is announced to every verified contact channel. A holder may hold only one open request; submitting a second returns the first. Requires the transaction PIN in the x-secret-value header and a passcode from POST /accountholder/offboarding/request/otp.

Headers

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

Example

Request body: SubmitOffboardingRequest · Response: GenericResponseOffboardingRequestResponse

curl -X POST "https://api.bridgemoni.com/accountholder/offboarding/request" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "NO_LONGER_NEEDED",
  "otpReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "otp": "string"
}'

{
  "reason": "NO_LONGER_NEEDED",
  "otpReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "otp": "string"
}

{
  "data": {
    "accepted": true,
    "outcome": "ACCEPTED",
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "state": "REQUESTED",
    "requestedDateTime": "2026-09-25T10:00:00Z",
    "eligibleToStartDateTime": "2026-09-25T10:00:00Z",
    "nextAttemptAt": "2026-09-25T10:00:00Z",
    "coolingOffHoursRemaining": 0,
    "cancellable": true,
    "attemptCount": 0,
    "parkReason": "OPEN_OBLIGATION",
    "rejectionReason": "ACCOUNTS_NOT_EMPTY",
    "rejectedAtCheck": "SUBMISSION",
    "accounts": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "type": "string",
        "currencyCode": "string",
        "action": "EMPTY",
        "availableBalance": 0,
        "reservedBalance": 0,
        "committedBalance": 0,
        "lienedBalance": 0,
        "dailyDebitLimit": 0,
        "estimatedDaysToEmpty": 0,
        "blockedBy": "string"
      }
    ],
    "obligations": [
      {
        "type": "string",
        "description": "string",
        "amount": 0,
        "currencyCode": "string",
        "expectedClearanceDate": "2026-09-25"
      }
    ]
  },
  "description": "Offboarding request queued"
}

Responses

Status	When
`201`	Offboarding request queued
`409`	Accounts are not empty, a request is already queued, or the caller is not an accountholder

POST Send a one-time passcode for an offboarding request

POST /accountholder/offboarding/request/otp

Sends a passcode to the calling accountholder's verified mobile number, or verified email address if there is no verified number. The passcode and the transaction PIN are both required to submit a request: with no human reviewing offboarding, a session alone must not be enough to start closing somebody's account. A holder with no verified contact channel cannot request offboarding at all, because there would be no way to warn them if somebody else requested it for them.

Headers

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

Example

Response: GenericResponseOffboardingOtpResponse

curl -X POST "https://api.bridgemoni.com/accountholder/offboarding/request/otp" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "otpReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  },
  "description": "Passcode sent"
}

Responses

Status	When
`200`	Passcode sent
`409`	No verified contact channel

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