POST /verifyProviderCBOCredentialing
- Purpose: Check whether a tele-health provider is credentialed with a given CBO.
- Auth:
Authorization: Bearer <access_token> - Content-Type:
application/json - Idempotent: Yes – the same input always yields the same credentialing result.
Request body
| Field | Type | Required | Notes |
|---|---|---|---|
prescriberID |
integer | Yes | Internal ID of the provider requesting enrolment. |
cboID |
integer | Yes | Target CBO. |
{
"prescriberID": 1,
"cboID": 1,
}
Success 200 OK — Provider is credentialed
{
"data": [
{
"NPI": "NPI001",
"name": "Jane Credentialed",
"prescriberID": 1
},
{
"NPI": "NPI002",
"name": "Jane Smith",
"prescriberID": 2
}
],
"message": "Provider is credentialed with CBO",
"success": true
}
data is an array of CredentialedPrescriberNPI objects for all providers credentialed with the CBO, including the requester.
Success 200 OK — Provider is not credentialed
{
"data": {
"credentialedPrescriberNPIs": [
{
"NPI": "NPI001",
"name": "Jane Credentialed",
"prescriberID": 1
},
{
"NPI": "NPI002",
"name": "Jane Smith",
"prescriberID": 2
}
]
},
"message": "Provider is not credentialed with CBO",
"success": true
}
| Field | Type | Notes |
|---|---|---|
data.credentialedPrescriberNPIs |
array |
List of providers who are credentialed with the CBO so the caller can select an alternative. |
## Error Responses for POST /verifyProviderCBOCredentialing |
400 Bad Request
This error occurs when one or more required fields are missing/invalid
{
"error": {
"code": "BAD_REQUEST",
"details": "Missing required fields: TH Co ID, thcoPatientID, cbo_id are mandatory."
},
"message": "Bad request",
"success": false
}
401 Unauthorized
This error occurs when there is a missing/invalid bearer token (see global Auth section).
404 Not Found
This error occurs when the endpoint path is incorrect and is presented as a standard 404 HTML/JSON response from the gateway.