API reference · Identity & onboarding
Credit standing
- GET
/accountholder/{type}/{value}/credit/standingFetch credit standing for an account holder - POST
/accountholder/{type}/{value}/credit/standingSet credit standing for an account holder - PUT
/accountholder/{type}/{value}/credit/standingUpdate credit standing for an account holder
GET Fetch credit standing for an account holder
GET /accountholder/{type}/{value}/credit/standing
Headers
| Name | Notes |
|---|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test 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" {
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"bureauCode": "string",
"bureauCountryCode": "string",
"bureauReference": {
"name": "string"
},
"standingBand": "string",
"activeDefault": "true",
"defaultCount": "1",
"worstArrearsBand": "string",
"enquiryCountBand": "string",
"reportDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"lastCheckedDateTime": "2026-09-25T10:00:00Z",
"assuranceGrade": "SELF",
"verificationStatus": "PENDING",
"verificationMethod": "string",
"verifierName": {
"name": "string"
},
"verificationDateTime": "2026-09-25T10:00:00Z",
"expiryDateTime": "2026-09-25T10:00:00Z",
"disputeStatus": "NONE"
},
"description": "Credit standing fetched successfully"
} Responses
| Status | When |
|---|---|
200 | Credit 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
| 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: 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"
}' {
"bureauCode": "string",
"bureauCountryCode": "string",
"bureauReference": {
"name": "string"
},
"standingBand": "string",
"activeDefault": "true",
"defaultCount": "1",
"worstArrearsBand": "string",
"enquiryCountBand": "string",
"reportDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
} {
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"bureauCode": "string",
"bureauCountryCode": "string",
"bureauReference": {
"name": "string"
},
"standingBand": "string",
"activeDefault": "true",
"defaultCount": "1",
"worstArrearsBand": "string",
"enquiryCountBand": "string",
"reportDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"lastCheckedDateTime": "2026-09-25T10:00:00Z",
"assuranceGrade": "SELF",
"verificationStatus": "PENDING",
"verificationMethod": "string",
"verifierName": {
"name": "string"
},
"verificationDateTime": "2026-09-25T10:00:00Z",
"expiryDateTime": "2026-09-25T10:00:00Z",
"disputeStatus": "NONE"
},
"description": "Credit standing saved successfully"
} Responses
| Status | When |
|---|---|
200 | Credit standing saved successfully |
PUT Update credit standing for an account holder
PUT /accountholder/{type}/{value}/credit/standing
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: 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"
}' {
"bureauCode": "string",
"bureauCountryCode": "string",
"bureauReference": {
"name": "string"
},
"standingBand": "string",
"activeDefault": "true",
"defaultCount": "1",
"worstArrearsBand": "string",
"enquiryCountBand": "string",
"reportDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
} {
"data": {
"reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"bureauCode": "string",
"bureauCountryCode": "string",
"bureauReference": {
"name": "string"
},
"standingBand": "string",
"activeDefault": "true",
"defaultCount": "1",
"worstArrearsBand": "string",
"enquiryCountBand": "string",
"reportDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
"lastCheckedDateTime": "2026-09-25T10:00:00Z",
"assuranceGrade": "SELF",
"verificationStatus": "PENDING",
"verificationMethod": "string",
"verifierName": {
"name": "string"
},
"verificationDateTime": "2026-09-25T10:00:00Z",
"expiryDateTime": "2026-09-25T10:00:00Z",
"disputeStatus": "NONE"
},
"description": "Credit standing updated successfully"
} Responses
| Status | When |
|---|---|
200 | Credit standing updated successfully |
Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors