API reference · Identity & onboarding

Expected Activity

GET List expected activity records for an account holder

GET /accountholder/{type}/{value}/activities

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
type
value

Example

Response: List<ExpectedActivityResponse>

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

Responses

StatusWhen
200Expected activity records fetched successfully

POST Add expected activity to an account holder

POST /accountholder/{type}/{value}/activity

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Path parameters

Name
type
value

Example

Request body: ExpectedActivityRequest · Response: ExpectedActivityResponse

curl -X POST "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/activity" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "monthlyVolume": 250000.0,
    "currencyCode": "NGN",
    "purpose": "March payroll"
  }'

Responses

StatusWhen
200Expected activity created successfully

GET Fetch an expected activity record by reference

GET /activity/{id}

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live

Path parameters

Name
id

Example

Response: ExpectedActivityResponse

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

Responses

StatusWhen
200Expected activity fetched successfully
404No expected activity record exists for the given reference

PUT Update an expected activity record

PUT /activity/{id}

Partially updates an expected activity record. Only non-null fields in the request body are applied.

Headers

NameNotes
AuthorizationBearer token
X-TenantYour tenant
X-Environmenttest or live
Content-Typeapplication/json

Path parameters

Name
id

Example

Request body: UpdateExpectedActivityRequest · Response: ExpectedActivityResponse

curl -X PUT "https://api.bridgemoni.com/activity/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 '{
    "monthlyVolume": 250000.0,
    "currencyCode": "NGN",
    "purpose": "March payroll"
  }'

Responses

StatusWhen
200Expected activity updated successfully
404No expected activity 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