API reference · Identity & onboarding

Risk

POST/accountholder/{type}/{value}/riskCreate a risk assessment for an account holder
GET/risk/{id}Fetch a risk assessment by reference
PUT/risk/{id}Update a risk assessment

POST Create a risk assessment for an account holder

POST /accountholder/{type}/{value}/risk

Creates a risk assessment, cascading creation of any supplied risk factors.

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: RiskRequest · Response: RiskResponse

curl -X POST "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/risk" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "level": "category",
    "score": 1,
    "cddLevel": "category",
    "riskFactors": [
      {
        "category": "category",
        "description": "March payroll",
        "weight": 1
      }
    ],
    "accessedDateTime": "2027-03-14T14:30:01",
    "reviewDate": "2027-03-14"
  }'

{
  "level": "category",
  "score": 1,
  "cddLevel": "category",
  "riskFactors": [
    {
      "category": "category",
      "description": "March payroll",
      "weight": 1
    }
  ],
  "accessedDateTime": "2027-03-14T14:30:01",
  "reviewDate": "2027-03-14"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "level": "category",
    "score": 1,
    "cddLevel": "category",
    "riskFactors": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "category": "category",
        "description": "March payroll",
        "weight": 1
      }
    ],
    "accessedDateTime": "2027-03-14T14:30:01",
    "reviewDate": "2027-03-14"
  },
  "description": "Create a risk assessment for an account holder"
}

Responses

Status	When
`200`	Risk assessment created successfully

GET Fetch a risk assessment by reference

GET /risk/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: RiskResponse

curl -X GET "https://api.bridgemoni.com/risk/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",
    "level": "category",
    "score": 1,
    "cddLevel": "category",
    "riskFactors": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "category": "category",
        "description": "March payroll",
        "weight": 1
      }
    ],
    "accessedDateTime": "2027-03-14T14:30:01",
    "reviewDate": "2027-03-14"
  },
  "description": "Fetch a risk assessment by reference"
}

Responses

Status	When
`200`	Risk assessment fetched successfully
`404`	No risk assessment exists for the given reference

PUT Update a risk assessment

PUT /risk/{id}

Partially updates a risk assessment's own scalar fields (level, score, cdd level, accessed date/time, review date). Only non-null fields in the request body are applied. Risk factors are managed independently via the Risk Factors endpoints.

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: UpdateRiskRequest · Response: RiskResponse

curl -X PUT "https://api.bridgemoni.com/risk/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 '{
    "level": "category",
    "score": 1,
    "cddLevel": "category",
    "accessedDateTime": "2027-03-14T14:30:01",
    "reviewDate": "2027-03-14"
  }'

{
  "level": "category",
  "score": 1,
  "cddLevel": "category",
  "accessedDateTime": "2027-03-14T14:30:01",
  "reviewDate": "2027-03-14"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "level": "category",
    "score": 1,
    "cddLevel": "category",
    "riskFactors": [
      {
        "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
        "category": "category",
        "description": "March payroll",
        "weight": 1
      }
    ],
    "accessedDateTime": "2027-03-14T14:30:01",
    "reviewDate": "2027-03-14"
  },
  "description": "Update a risk assessment"
}

Responses

Status	When
`200`	Risk assessment updated successfully
`404`	No risk assessment 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