Telehealth Public APIs
  1. General APIs
Telehealth Public APIs
  • Introduction
  • SSO Login
    • Generate SSO token
      POST
    • SSO Login
      GET
  • General APIs
    • Create Patient
      POST
    • Upload Patient File
      POST
    • Submit Patient's Form Response
      POST
    • Lab readings
      POST
    • Assign Service to Patient
      POST
    • Create Patient's Chart Note
      POST
    • Get Provider's Appointment Slots
      POST
    • Provider Sign Up
      POST
    • GraphQL Get Patient(s)
      POST
  1. General APIs

Provider Sign Up

POST
/api/service/v1/provider/register

Register Provider#

This endpoint allows the registration of a provider by sending a POST request to /api/service/v1/provider/signup.
Provider can sign up using either email address or phone number OR both.

Request Body#

signup_code (text): Required. The signup code for registration. You can get it from practice configuration.
first_name (text): Required. The first name of the provider.
middle_name (text): Optional. The middle name of the provider.
last_name (text): Optional. The last name of the provider.
email_id (text): The email address of the provider. Required if phone1 is not present in request body.
email_id_alt (text): Optional. The alternative email address of the provider.
password (text): Required. The password of the provider.
country_code_phone1 (text): The country code for the provider's phone number. Required if phone1 field is present in the request body.
phone1 (text): The phone number of the provider. Required if email_id is not present in the request.
country_code_phone2 (text): Optional. The country code for the provider's alternative phone number. Required if phone2 is present in the request.
phone2 (text): Optional. The alternative phone number of the provider.
gender (text): Optional. Gender of the provider. Must be In "male" or "female" or "prefer_not_to_say".
birth_date (date): Optional. The birth date of the provider. Must be in "YYYY-MM-DD" format if present.
language (text): Optional. The locale code (must be in "en", "es", "it", "pt-BR", "fr-ca", "ar", "gu") of the provider's language.
addr1 (text): Optional. Address line 1 of the provider.
addr2 (text): Optional. Address line 2 of the provider.
city (text): Optional. City of the provider.
state (text): Optional. State of the provider.
post_code (text): Optional. Zip code or postal code of the provider.
Example request body:
{
    "signup_code": "ABCD123",
    "first_name": "John",
    "middle_name": "Richard",
    "last_name": "Doe",
    "email_id": "john.doe@example.com",
    "email_id_alt": "john.richard@example.com",
    "country_code_phone1": "+1",
    "phone1": "1234567890",
    "country_code_phone2": "+1",
    "phone2": "9876543210",
    "password": "Any@Random$String",
    "gender": "male",
    "birth_date": "1980-01-01",
    "language": "en",
    "addr1": "123",
    "addr2": "My Street",
    "city": "Kingston",
    "state": "New York",
    "country": "USA",
    "post_code": "12401"
}

Response#

error (boolean): Indicates if there was an error in the request.
input_data (object): Information related to provider, such as id and email_id etc.
Example response:
{
    "error": false,
    "input_data": {
        "message": "Provider created successfully",
        "id": "202400001710",
        "user_type": "provider",
        "first_name": "John",
        "middle_name": "Richard",
        "last_name": "Doe",
        "email_id": "john.doe@example.com",
        "email_id_alt": "john.richard@example.com",
        "country_code_phone1": "+1",
        "phone1": "1234567890",
        "country_code_phone2": "+1",
        "phone2": "9876543210",
        "gender": "male",
        "birth_date": "1980-01-01",
        "addr1": "123",
        "addr2": "My Street",
        "city": "Kingston",
        "state": "New York",
        "country": "USA",
        "post_code": "12401"
    }
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params

Body Params application/json

Example
{
	"signup_code": {{signup_code}},
	"first_name": {{first_name}},
    "middle_name": {{middle_name}},
	"last_name": {{last_name}},
	"email_id": {{email_id}},
    "email_id_alt": {{email_id_alt}},
    "password": {{password}},
	"country_code_phone1": {{country_code_phone1}},
	"phone1": {{phone1}},
    "country_code_phone2" : {{country_code_phone2}},
	"phone2": {{phone2}},
    "gender": {{gender}},
    "birth_date": {{birth_date}},
    "language": {{language}},
    "addr1": {{addr1}},
    "addr2": {{addr2}},
    "city": {{city}},
    "state": {{state}},
    "country": {{country}},
	"post_code": {{post_code}}
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/service/v1/provider/register' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
	"signup_code": {{signup_code}},
	"first_name": {{first_name}},
    "middle_name": {{middle_name}},
	"last_name": {{last_name}},
	"email_id": {{email_id}},
    "email_id_alt": {{email_id_alt}},
    "password": {{password}},
	"country_code_phone1": {{country_code_phone1}},
	"phone1": {{phone1}},
    "country_code_phone2" : {{country_code_phone2}},
	"phone2": {{phone2}},
    "gender": {{gender}},
    "birth_date": {{birth_date}},
    "language": {{language}},
    "addr1": {{addr1}},
    "addr2": {{addr2}},
    "city": {{city}},
    "state": {{state}},
    "country": {{country}},
	"post_code": {{post_code}}
}'

Responses

🟢200Example
application/json
Body

Example
{
	"error": false,
	"input_data": {
		"message": "Provider created successfully",
		"id": "202400001710",
		"user_type": "provider",
		"first_name": "Devendra",
		"middle_name": "Gohil",
		"last_name": "Pr 92",
		"email_id": "devendra.gohil+pr92@plenartech.com",
		"email_id_alt": "devendra.gohil+pr92alt@plenartech.com",
		"country_code_phone1": "+91",
		"phone1": "9879794002",
		"country_code_phone2": "+91",
		"phone2": "9879794002",
		"gender": "male",
		"birth_date": "1980-01-01",
		"addr1": "Campus Corner Building",
		"addr2": "Navrangpura",
		"city": "Ahmedabad",
		"state": "Gujarat",
		"country": "India",
		"post_code": "380001"
	}
}
Modified at 2024-10-16 09:05:40
Previous
Get Provider's Appointment Slots
Next
GraphQL Get Patient(s)
Built with