API reference · Identity & onboarding

Income profile

GET/accountholder/{type}/{value}/income/profileFetch an account holder's income profile
POST/accountholder/{type}/{value}/income/profileSet an account holder's income profile
PUT/accountholder/{type}/{value}/income/profileUpdate an account holder's income profile

GET Fetch an account holder's income profile

GET /accountholder/{type}/{value}/income/profile

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseIncomeProfileResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "incomeBand": "string",
    "currencyCode": "string",
    "incomeFrequency": "WEEKLY",
    "obligationsBand": "string",
    "debtToIncomeBand": "string",
    "source": {
      "name": "string"
    },
    "effectiveDate": "2026-09-25",
    "expiresDate": "2026-09-25",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Income profile fetched successfully"
}

Responses

Status	When
`200`	Income profile fetched successfully

POST Set an account holder's income profile

POST /accountholder/{type}/{value}/income/profile

Bands only. There is no income amount column in this module, so there is no amount to ask for and nothing to refuse. incomeOver on the eligibility resource is answered from the band's floor.

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: IncomeProfileRequest · Response: GenericResponseIncomeProfileResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/income/profile" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "incomeBand": "string",
  "currencyCode": "string",
  "incomeFrequency": "WEEKLY",
  "obligationsBand": "string",
  "debtToIncomeBand": "string",
  "source": {
    "name": "string"
  },
  "effectiveDate": "2026-09-25",
  "expiresDate": "2026-09-25"
}'

{
  "incomeBand": "string",
  "currencyCode": "string",
  "incomeFrequency": "WEEKLY",
  "obligationsBand": "string",
  "debtToIncomeBand": "string",
  "source": {
    "name": "string"
  },
  "effectiveDate": "2026-09-25",
  "expiresDate": "2026-09-25"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "incomeBand": "string",
    "currencyCode": "string",
    "incomeFrequency": "WEEKLY",
    "obligationsBand": "string",
    "debtToIncomeBand": "string",
    "source": {
      "name": "string"
    },
    "effectiveDate": "2026-09-25",
    "expiresDate": "2026-09-25",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Income profile saved successfully"
}

Responses

Status	When
`200`	Income profile saved successfully

PUT Update an account holder's income profile

PUT /accountholder/{type}/{value}/income/profile

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: IncomeProfileRequest · Response: GenericResponseIncomeProfileResponse

curl -X PUT "https://api.bridgemoni.com/accountholder/value/value/income/profile" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "incomeBand": "string",
  "currencyCode": "string",
  "incomeFrequency": "WEEKLY",
  "obligationsBand": "string",
  "debtToIncomeBand": "string",
  "source": {
    "name": "string"
  },
  "effectiveDate": "2026-09-25",
  "expiresDate": "2026-09-25"
}'

{
  "incomeBand": "string",
  "currencyCode": "string",
  "incomeFrequency": "WEEKLY",
  "obligationsBand": "string",
  "debtToIncomeBand": "string",
  "source": {
    "name": "string"
  },
  "effectiveDate": "2026-09-25",
  "expiresDate": "2026-09-25"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "incomeBand": "string",
    "currencyCode": "string",
    "incomeFrequency": "WEEKLY",
    "obligationsBand": "string",
    "debtToIncomeBand": "string",
    "source": {
      "name": "string"
    },
    "effectiveDate": "2026-09-25",
    "expiresDate": "2026-09-25",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "Income profile updated successfully"
}

Responses

Status	When
`200`	Income profile updated successfully

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