API reference · Identity & onboarding

Credit standing

GET Fetch credit standing for an account holder

GET /accountholder/{type}/{value}/credit/standing

Headers

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

Path parameters

Name
type
value

Example

Response: GenericResponseCreditStandingResponse

curl -X GET "https://api.bridgemoni.com/accountholder/value/value/credit/standing" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

Responses

StatusWhen
200Credit standing fetched successfully

POST Set credit standing for an account holder

POST /accountholder/{type}/{value}/credit/standing

Bands and counts only. There is no credit score column and no arrears amount in this module, so there is nothing to ask for and nothing to refuse.

Headers

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

Path parameters

Name
type
value

Example

Request body: CreditStandingRequest · Response: GenericResponseCreditStandingResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/credit/standing" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "bureauCode": "string",
  "bureauCountryCode": "string",
  "bureauReference": {
    "name": "string"
  },
  "standingBand": "string",
  "activeDefault": "true",
  "defaultCount": "1",
  "worstArrearsBand": "string",
  "enquiryCountBand": "string",
  "reportDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

Responses

StatusWhen
200Credit standing saved successfully

PUT Update credit standing for an account holder

PUT /accountholder/{type}/{value}/credit/standing

Headers

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

Path parameters

Name
type
value

Example

Request body: CreditStandingRequest · Response: GenericResponseCreditStandingResponse

curl -X PUT "https://api.bridgemoni.com/accountholder/value/value/credit/standing" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "bureauCode": "string",
  "bureauCountryCode": "string",
  "bureauReference": {
    "name": "string"
  },
  "standingBand": "string",
  "activeDefault": "true",
  "defaultCount": "1",
  "worstArrearsBand": "string",
  "enquiryCountBand": "string",
  "reportDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

Responses

StatusWhen
200Credit standing updated successfully

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors