API reference · Identity & onboarding
Income sources
POST Record an income source for an account holder
POST /accountholder/{type}/{value}/income/source
Headers
| Name | Notes |
|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Content-Type | application/json |
Path parameters
Example
Request body: IncomeSourceRequest · Response: GenericResponseIncomeSourceResponse
curl -X POST "https://api.bridgemoni.com/accountholder/value/value/income/source" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" \
-H "Content-Type: application/json" \
-d '{
"sourceType": "SALARY",
"description": "string",
"shareBand": "string",
"declaredDate": "2026-09-25"
}'
{
"sourceType": "SALARY",
"description": "string",
"shareBand": "string",
"declaredDate": "2026-09-25"
}
{
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"sourceType": "SALARY",
"description": "string",
"shareBand": "string",
"declaredDate": "2026-09-25"
},
"description": "An income source recorded successfully"
}
Responses
| Status | When |
|---|
200 | An income source recorded successfully |
GET List an income source for an account holder
GET /accountholder/{type}/{value}/income/sources
Headers
| Name | Notes |
|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Path parameters
Example
Response: GenericResponseListIncomeSourceResponse
curl -X GET "https://api.bridgemoni.com/accountholder/value/value/income/sources" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV"
{
"data": [
{
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"sourceType": "SALARY",
"description": "string",
"shareBand": "string",
"declaredDate": "2026-09-25"
}
],
"description": "An income source fetched successfully"
}
Responses
| Status | When |
|---|
200 | An income source fetched successfully |
GET Fetch one record
GET /income/source/{id}
Headers
| Name | Notes |
|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Path parameters
Example
Response: GenericResponseIncomeSourceResponse
curl -X GET "https://api.bridgemoni.com/income/source/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",
"sourceType": "SALARY",
"description": "string",
"shareBand": "string",
"declaredDate": "2026-09-25"
},
"description": "An income source fetched successfully"
}
Responses
| Status | When |
|---|
200 | An income source fetched successfully |
PUT Update one record
PUT /income/source/{id}
Headers
| Name | Notes |
|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Content-Type | application/json |
Path parameters
Example
Request body: UpdateIncomeSourceRequest · Response: GenericResponseIncomeSourceResponse
curl -X PUT "https://api.bridgemoni.com/income/source/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 '{
"sourceType": "SALARY",
"description": "string",
"shareBand": "string",
"declaredDate": "2026-09-25"
}'
{
"sourceType": "SALARY",
"description": "string",
"shareBand": "string",
"declaredDate": "2026-09-25"
}
{
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"sourceType": "SALARY",
"description": "string",
"shareBand": "string",
"declaredDate": "2026-09-25"
},
"description": "An income source updated successfully"
}
Responses
| Status | When |
|---|
200 | An income source updated successfully |
Bridge