API reference · Identity & onboarding
Risk Factors
POST Add a risk factor to an account holder
POST /accountholder/{type}/{value}/risk/factor
Headers
| Name | Notes |
|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Content-Type | application/json |
Path parameters
Example
Request body: RiskFactorRequest · Response: RiskFactorResponse
curl -X POST "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/risk/factor" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" \
-H "Content-Type: application/json" \
-d '{
"category": "category",
"description": "March payroll",
"weight": 1
}'
{
"category": "category",
"description": "March payroll",
"weight": 1
}
{
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"category": "category",
"description": "March payroll",
"weight": 1
},
"description": "Add a risk factor to an account holder"
}
Responses
| Status | When |
|---|
200 | Risk factor created successfully |
GET List risk factors for an account holder
GET /accountholder/{type}/{value}/risk/factors
Headers
| Name | Notes |
|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Path parameters
Example
Response: List<RiskFactorResponse>
curl -X GET "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/risk/factors" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV"
{
"data": [
{
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"category": "category",
"description": "March payroll",
"weight": 1
}
],
"description": "List risk factors for an account holder"
}
Responses
| Status | When |
|---|
200 | Risk factors fetched successfully |
GET Fetch a risk factor by reference
GET /risk/factor/{id}
Headers
| Name | Notes |
|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Path parameters
Example
Response: RiskFactorResponse
curl -X GET "https://api.bridgemoni.com/risk/factor/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",
"category": "category",
"description": "March payroll",
"weight": 1
},
"description": "Fetch a risk factor by reference"
}
Responses
| Status | When |
|---|
200 | Risk factor fetched successfully |
404 | No risk factor exists for the given reference |
PUT Update a risk factor
PUT /risk/factor/{id}
Partially updates a risk factor. 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
Example
Request body: UpdateRiskFactorRequest · Response: RiskFactorResponse
curl -X PUT "https://api.bridgemoni.com/risk/factor/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 '{
"category": "category",
"description": "March payroll",
"weight": 1
}'
{
"category": "category",
"description": "March payroll",
"weight": 1
}
{
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"category": "category",
"description": "March payroll",
"weight": 1
},
"description": "Update a risk factor"
}
Responses
| Status | When |
|---|
200 | Risk factor updated successfully |
404 | No risk factor exists for the given reference |
Bridge