API reference · Identity & onboarding

Professional licences

POST/accountholder/{type}/{value}/professional/licenceRecord a professional licence for an account holder
GET/accountholder/{type}/{value}/professional/licencesList an account holder's a professional licence
GET/professional/licence/{id}Fetch one record
PUT/professional/licence/{id}Update one record

POST Record a professional licence for an account holder

POST /accountholder/{type}/{value}/professional/licence

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: ProfessionalLicenceRequest · Response: GenericResponseProfessionalLicenceResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/professional/licence" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "bodyCode": "string",
  "bodyName": {
    "name": "string"
  },
  "bodyCountryCode": "string",
  "licenceNumber": "string",
  "licenceStatus": "ACTIVE",
  "speciality": {
    "name": "string"
  },
  "scopeOfPractice": "string",
  "issueDate": "2026-09-25",
  "expiryDate": "2026-09-25",
  "registerUrl": "string"
}'

{
  "bodyCode": "string",
  "bodyName": {
    "name": "string"
  },
  "bodyCountryCode": "string",
  "licenceNumber": "string",
  "licenceStatus": "ACTIVE",
  "speciality": {
    "name": "string"
  },
  "scopeOfPractice": "string",
  "issueDate": "2026-09-25",
  "expiryDate": "2026-09-25",
  "registerUrl": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "bodyCode": "string",
    "bodyName": {
      "name": "string"
    },
    "bodyCountryCode": "string",
    "licenceNumber": "string",
    "licenceStatus": "ACTIVE",
    "speciality": {
      "name": "string"
    },
    "scopeOfPractice": "string",
    "issueDate": "2026-09-25",
    "expiryDate": "2026-09-25",
    "registerUrl": "string",
    "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": "Professional licences created successfully"
}

Responses

Status	When
`200`	Professional licences created successfully

GET List an account holder's a professional licence

GET /accountholder/{type}/{value}/professional/licences

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseListProfessionalLicenceResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "bodyCode": "string",
      "bodyName": {
        "name": "string"
      },
      "bodyCountryCode": "string",
      "licenceNumber": "string",
      "licenceStatus": "ACTIVE",
      "speciality": {
        "name": "string"
      },
      "scopeOfPractice": "string",
      "issueDate": "2026-09-25",
      "expiryDate": "2026-09-25",
      "registerUrl": "string",
      "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": "Professional licences fetched successfully"
}

Responses

Status	When
`200`	Professional licences fetched successfully

GET Fetch one record

GET /professional/licence/{id}

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`id`

Example

Response: GenericResponseProfessionalLicenceResponse

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

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "bodyCode": "string",
    "bodyName": {
      "name": "string"
    },
    "bodyCountryCode": "string",
    "licenceNumber": "string",
    "licenceStatus": "ACTIVE",
    "speciality": {
      "name": "string"
    },
    "scopeOfPractice": "string",
    "issueDate": "2026-09-25",
    "expiryDate": "2026-09-25",
    "registerUrl": "string",
    "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": "Professional licences fetched successfully"
}

Responses

Status	When
`200`	Professional licences fetched successfully

PUT Update one record

PUT /professional/licence/{id}

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`id`

Example

Request body: UpdateProfessionalLicenceRequest · Response: GenericResponseProfessionalLicenceResponse

curl -X PUT "https://api.bridgemoni.com/professional/licence/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 '{
  "bodyCode": "string",
  "bodyName": {
    "name": "string"
  },
  "bodyCountryCode": "string",
  "licenceNumber": "string",
  "licenceStatus": "ACTIVE",
  "speciality": {
    "name": "string"
  },
  "scopeOfPractice": "string",
  "issueDate": "2026-09-25",
  "expiryDate": "2026-09-25",
  "registerUrl": "string"
}'

{
  "bodyCode": "string",
  "bodyName": {
    "name": "string"
  },
  "bodyCountryCode": "string",
  "licenceNumber": "string",
  "licenceStatus": "ACTIVE",
  "speciality": {
    "name": "string"
  },
  "scopeOfPractice": "string",
  "issueDate": "2026-09-25",
  "expiryDate": "2026-09-25",
  "registerUrl": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "bodyCode": "string",
    "bodyName": {
      "name": "string"
    },
    "bodyCountryCode": "string",
    "licenceNumber": "string",
    "licenceStatus": "ACTIVE",
    "speciality": {
      "name": "string"
    },
    "scopeOfPractice": "string",
    "issueDate": "2026-09-25",
    "expiryDate": "2026-09-25",
    "registerUrl": "string",
    "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": "Professional licences updated successfully"
}

Responses

Status	When
`200`	Professional licences updated successfully

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