Bridge
Contact us
API reference · Identity & onboarding

Qualifications

POST Record a qualification for an account holder

POST /accountholder/{type}/{value}/qualification

Headers

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

Path parameters

Name
type
value

Example

Request body: QualificationRequest · Response: GenericResponseQualificationResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/qualification" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "qualificationLevel": "PRIMARY",
  "highest": "true",
  "institutionName": {
    "name": "string"
  },
  "institutionCountryCode": "string",
  "institutionRegistryCode": {
    "name": "string"
  },
  "programme": {
    "name": "string"
  },
  "awardClass": "string",
  "startDate": "2026-09-25",
  "endDate": "2026-09-25",
  "awardDate": "2026-09-25",
  "currentlyEnrolled": "true",
  "certificateDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "transcriptDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

Responses

StatusWhen
200Qualifications created successfully

GET List an account holder's a qualification

GET /accountholder/{type}/{value}/qualifications

Headers

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

Path parameters

Name
type
value

Example

Response: GenericResponseListQualificationResponse

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

Responses

StatusWhen
200Qualifications fetched successfully

GET Fetch one record

GET /qualification/{id}

Headers

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

Path parameters

Name
id

Example

Response: GenericResponseQualificationResponse

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

Responses

StatusWhen
200Qualifications fetched successfully

PUT Update one record

PUT /qualification/{id}

Headers

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

Path parameters

Name
id

Example

Request body: UpdateQualificationRequest · Response: GenericResponseQualificationResponse

curl -X PUT "https://api.bridgemoni.com/qualification/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 '{
  "qualificationLevel": "PRIMARY",
  "highest": "true",
  "institutionName": {
    "name": "string"
  },
  "institutionCountryCode": "string",
  "institutionRegistryCode": {
    "name": "string"
  },
  "programme": {
    "name": "string"
  },
  "awardClass": "string",
  "startDate": "2026-09-25",
  "endDate": "2026-09-25",
  "awardDate": "2026-09-25",
  "currentlyEnrolled": "true",
  "certificateDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "transcriptDocumentReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
}'

Responses

StatusWhen
200Qualifications updated successfully

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