API reference · Identity & onboarding

Tier

POST/accountholder/{type}/{value}/tierAssign a tier to an account holder
GET/accountholder/{type}/{value}/tiersList tier records for an account holder
GET/tier/{id}Fetch a tier record by reference
PUT/tier/{id}Update a tier record

POST Assign a tier to an account holder

POST /accountholder/{type}/{value}/tier

Headers

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

Path parameters

Name
`type`
`value`

Example

Request body: TierRequest · Response: TierResponse

curl -X POST "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/tier" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "tierLevel": 1,
    "tierDateTime": "2027-03-14T14:30:01",
    "upgradeEligible": true,
    "pendingUpgrade": 1,
    "missingUpgrades": [
      "category"
    ],
    "restrictions": [
      "category"
    ]
  }'

{
  "tierLevel": 1,
  "tierDateTime": "2027-03-14T14:30:01",
  "upgradeEligible": true,
  "pendingUpgrade": 1,
  "missingUpgrades": [
    "category"
  ],
  "restrictions": [
    "category"
  ]
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tierLevel": 1,
    "tierDateTime": "2027-03-14T14:30:01",
    "upgradeEligible": true,
    "pendingUpgrade": 1,
    "missingUpgrades": [
      "category"
    ],
    "restrictions": [
      "category"
    ]
  },
  "description": "Assign a tier to an account holder"
}

Responses

Status	When
`200`	Tier created successfully

GET List tier records for an account holder

GET /accountholder/{type}/{value}/tiers

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: List<TierResponse>

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "tierLevel": 1,
      "tierDateTime": "2027-03-14T14:30:01",
      "upgradeEligible": true,
      "pendingUpgrade": 1,
      "missingUpgrades": [
        "category"
      ],
      "restrictions": [
        "category"
      ]
    }
  ],
  "description": "List tier records for an account holder"
}

Responses

Status	When
`200`	Tier records fetched successfully

GET Fetch a tier record by reference

GET /tier/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: TierResponse

curl -X GET "https://api.bridgemoni.com/tier/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",
    "tierLevel": 1,
    "tierDateTime": "2027-03-14T14:30:01",
    "upgradeEligible": true,
    "pendingUpgrade": 1,
    "missingUpgrades": [
      "category"
    ],
    "restrictions": [
      "category"
    ]
  },
  "description": "Fetch a tier record by reference"
}

Responses

Status	When
`200`	Tier fetched successfully
`404`	No tier record exists for the given reference

PUT Update a tier record

PUT /tier/{id}

Partially updates a tier record. Only non-null fields in the request body are applied.

Headers

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

Path parameters

Name
`id`

Example

Request body: UpdateTierRequest · Response: TierResponse

curl -X PUT "https://api.bridgemoni.com/tier/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "tierLevel": 1,
    "tierDateTime": "2027-03-14T14:30:01",
    "upgradeEligible": true,
    "pendingUpgrade": 1,
    "missingUpgrades": [
      "category"
    ],
    "restrictions": [
      "category"
    ]
  }'

{
  "tierLevel": 1,
  "tierDateTime": "2027-03-14T14:30:01",
  "upgradeEligible": true,
  "pendingUpgrade": 1,
  "missingUpgrades": [
    "category"
  ],
  "restrictions": [
    "category"
  ]
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "tierLevel": 1,
    "tierDateTime": "2027-03-14T14:30:01",
    "upgradeEligible": true,
    "pendingUpgrade": 1,
    "missingUpgrades": [
      "category"
    ],
    "restrictions": [
      "category"
    ]
  },
  "description": "Update a tier record"
}

Responses

Status	When
`200`	Tier updated successfully
`404`	No tier record exists for the given reference

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