Skip to content
/v2/provider-with-groups

CertifyOS API

Download OpenAPI description
api.json
api.yaml
Overview
Languages
Servers
Mock server
https://docs.certifyos.com/_mock/reference/application/api/
Production
https://ng-api-production.certifyos.com/
Staging (Test Data)
https://ng-api-stg.certifyos.com/

auth-tokens

Operations

credentialing-workflows

Operations

v2/credentialing-workflows

Operations

providers

Operations

v2/provider

Operations

v2/providers

Operations

v2/flags

Operations

v2/provider-with-groups

Operations

Create Provider With Groups

Request

Add a provider to the organization

Security
BearerAuth
Headers
organization-idstring
Bodyapplication/jsonrequired
first_namestringrequired

First name of the Provider

middle_namestring

Middle name of the Provider

Default ""
last_namestringrequired

Last name of the Provider

degreestringrequired

Type of provider

Enum"AA""ABA""ACU""ADC""APN""AT""ATR""AUD""BCaBA""BCBA"
npistring

NPI of the Provider

Default ""
statesstringrequired

States in which Provider will provide care to patients/enrollees

caqh_provider_idstring

CAQH ID of the Provider

Default ""
last_credentialed_datestring(date-time)

Date Provider was last credentialed

next_credentialing_datestring(date-time)

Date by which Provider needs to be recredentialed

external_idstring

Client’s ID for the provider

primary_emailstring

Provider’s email address

Example: "string@string.com"
genderstring

Provider's gender

Enum"M""F""U"
dobstring(date-time)

Provider’s date of birth

groupsArray of objects(CreateProviderV2GroupDto)

Groups within the Org with which the provider is associated

curl -i -X POST \
  https://docs.certifyos.com/_mock/reference/application/api/v2/provider-with-groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "first_name": "string",
    "middle_name": "",
    "last_name": "string",
    "degree": "AA",
    "npi": "",
    "states": "string",
    "caqh_provider_id": "",
    "last_credentialed_date": "2019-08-24T14:15:22Z",
    "next_credentialing_date": "2019-08-24T14:15:22Z",
    "external_id": "string",
    "primary_email": "string@string.com",
    "gender": "M",
    "dob": "2019-08-24T14:15:22Z",
    "groups": [
      {
        "group_name": "string",
        "group_npi": "2345678901",
        "group_tin": "123456789",
        "location_name": "string",
        "external_group_id": "string"
      }
    ]
  }'

Responses

The record has been successfully created.

Bodyapplication/json
provider_idstring
Example: "sfas12345"
is_createdboolean
Example: false
Response
application/json
{
  "provider_id": "sfas12345",
  "is_created": false
}

flags

Operations

v2/groups

Operations

Webhooks

Operations

forms

Operations

v2/facility-credentialing-workflows

Operations

v2/facilities

Operations