API reference · Identity & onboarding

Sanctions

POST Record a sanctions screening result for an account holder

POST /accountholder/{type}/{value}/sanction

Headers

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

Path parameters

Name
type
value

Example

Request body: SanctionRequest · Response: SanctionResponse

curl -X POST "https://api.bridgemoni.com/accountholder/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e/sanction" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "politicallyExposureStatus": true,
    "sanctionMatchStatus": true,
    "sanctionSources": [
      "Ada Obi"
    ],
    "adverseMediaFound": true,
    "lastScreenDateTime": "2027-03-14T14:30:01",
    "nextScreenDateTime": "2027-03-14T14:30:01"
  }'

Responses

StatusWhen
200Sanction record created successfully

GET List sanction records for an account holder

GET /accountholder/{type}/{value}/sanctions

Headers

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

Path parameters

Name
type
value

Example

Response: List<SanctionResponse>

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

Responses

StatusWhen
200Sanction records fetched successfully

GET Fetch a sanction record by reference

GET /sanction/{id}

Headers

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

Path parameters

Name
id

Example

Response: SanctionResponse

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

Responses

StatusWhen
200Sanction record fetched successfully
404No sanction record exists for the given reference

PUT Update a sanction record

PUT /sanction/{id}

Partially updates a sanction 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: UpdateSanctionRequest · Response: SanctionResponse

curl -X PUT "https://api.bridgemoni.com/sanction/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 '{
    "politicallyExposureStatus": true,
    "sanctionMatchStatus": true,
    "sanctionSources": [
      "Ada Obi"
    ],
    "adverseMediaFound": true,
    "lastScreenDateTime": "2027-03-14T14:30:01",
    "nextScreenDateTime": "2027-03-14T14:30:01"
  }'

Responses

StatusWhen
200Sanction record updated successfully
404No sanction 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