The Provider Import POST Endpoint allows clients to upload their provider data programmatically to the androsCredentialing platform and provides immediate feedback on successful record creation or any errors identified with submitted data.

Overview

The andros Provider Import POST Endpoint is used to:

Create new Providers for Credentialing, Recredentialing or Monitoring
Schedule a Credential or Recredential process
Update existing Providers

API Documentation

The androsCredentialing API documentation provides detailed parameter, schema, request, response and error details for all API endpoints.

The API documentation is automatically updated when changes are made to the underlying schema or functionality, so it is an up to date guide for interacting with the API.

This documentation can be found at https://api.credsimple.com/v1/docs.html.

For the provider import POST endpoint specifically, please see https://api.credsimple.com/v1/docs.html#tag/Provider/paths/~1v1~1providers~1import/post

Provider Import Data Requirements

Field requirements to import a provider and conditionally schedule an initial credential

Field	Required / Optional	Data Type	Example	Description	Possible Error Responses
import_type	required	String	Direct	This defines a provider as Direct (credentialing + monitoring) or Delegated (monitoring only)	title: 'import_type', details: 'import_type is missing', code: '400', status: '400'
application_type	required	String	CAQH	This defines a provider as CAQH, CredSimple, Paper, or None application type. CAQH providers must have a CAQH ID	title: 'application_type', details: 'application_type is missing', code: '400', status: '400'
provider_type	required	String.	MD	Must be a 2-4 character abbreviation of an accepted type or degree.	“Missing Provider Type.", “Provider Type abbreviation not accepted. Please refer to the Help Center for accepted values.”
provider_email	optional	String. Must be unique to provider	amurphy@healthplan.com	Standard email format validation	“Provider Email conflicts with existing records. Please contact support@andros.co.”, "Invalid Provider Email."
first_name	required	String	Ashley	Must be alpha string with less than or equal to 30 characters	“Missing First Name”, ”Invalid First Name”
middle_name	optional	String	Randall	Must be alpha string with less than or equal to 30 characters	“Invalid Middle Name”
last_name	required	String	Murphy	Must be alpha string with less than or equal to 30 characters	“Missing Last Name”, “Invalid Last Name”
npi	required	String	1437690559	10 digit number that passes Luhn Check, must be “Type 1 - Individual” NPI.	“Missing NPI.”, “Invalid NPI.", “NPI must be Type 1 - Individual.", “Unable to validate NPI due to a service issue with the NPI registry. Please retry and contact support@andros.co if the problem persists."
cred_event	required	String	Initial	‘initial’	“Missing Cred Event.”, "Cred Event must be 'initial,' 'recred,' or 'recredential'."
cred_due_date	optional	String	03/02/2024	MM/DD/YYYY, YYYY-MM-DD	"Invalid Cred Due Date.", "Cred Due Date must be in the future.", "Cred Due Date must be less than 5 years in the future."
date_of_birth	preferred	String	10/20/1970	Must be later than 01/01/1930; preferred format MM/DD/YYYY; YYYY-MM-DD	“Unaccepted Date of Birth format. Please refer to the Help Center for accepted formats.”, “Date of Birth conflicts with existing records. Please verify your data and contact support@andros.co if you have additional questions.”
gender	optional	String	Female	Female, Male, female, male, FEMALE, MALE, f, m, F, M	“Invalid Gender."
external_id	optional	String	12345	Client’s ID for the Provider. Must be an alphanumeric string with less than or equal to 255 characters.	“Invalid External ID”
primary_practice_state	preferred	String	NY	Standard state abbreviations. Only states and the District of Columbia are supported	"Invalid Primary Practice State."
participating_networks	optional	Array of strings; One or more per provider.	(client-dependent)	(client-dependent)	“Missing Participating Network”, "Invalid Participating Network."
contact_email	required	String	credentialing@healthclinic.com	Standard email format validation	“Missing Contact Email”, “Invalid Email.”
contact_fax	preferred	String	8013529500	Ensure non-numeric (spaces, hyphens, parentheses and any other special characters) are removed; if there is a leading “1”, making the value 11 digits, strip this out before validating; validate that the value is 10 digits	“Invalid Contact Fax.”
contact_phones	preferred	Array of strings	8013529500 ext 1811	10 or 11 digits; extension accepted in the following formats: 8013529500 ext 1811, 8013529500, ext 1811, 8013529500 ext1811, 8013529500 ext. 1811, 8013529500 ext.1811, 8013529500 EXT: 1811, 8013529500 x 1811, 8013529500 x1811	“Invalid Contact Phone.”
dea_number	optional	String	H93456781	Two capital letters followed by 7 digits	"Invalid DEA Number."
caqh_id	optional	String	12345678	Required for CAQH Application Types	“Missing CAQH ID”, “Invalid CAQH ID”
ssn	preferred	String	123456789	Must be 9 digits, optionally including hyphens	“A valid SSN or School with Graduation Year is required for NPDB enrollment.”, “Invalid SSN.”
school	optional	String
graduation_year	optional	String
board_certified	optional	String	True	true, false, TRUE, FALSE, True, False, t, f, T, F, yes, no, YES, NO, Yes, No, y, n, Y, N, 1, 0, ON, OFF, on, off	"Board Certified value is invalid. Please refer to the Help Center for accepted formats."
board_names	optional	Array of strings
mailing_addresses		Array of objects
mailing_addresses[].address1	preferred	String	400 East End Avenue	Do not include Ampersand (&) as it will error. Max character length 100.	“Invalid Mailing Address 1.”
mailing_addresses[].address2	preferred	String		Do not include Ampersand (&) as it will error. Max character length 100.	“Invalid Mailing Address 2.”
mailing_addresses[].city	preferred	String	New York	Non-zero length string of word characters; max character length 100. Multiple address can be inserted using multiple records	“Invalid Mailing City.”
mailing_addresses[].state	preferred	String	NY	State abbreviation found in https://en.wikipedia.org/wiki/ISO_3166-2:US ; only states and the District of Columbia are supported Multiple address can be inserted using multiple records	“Invalid Mailing State.”
mailing_addresses[].zip	preferred	String	10001	Five digits with optional hyphen-separated zip+4 digits, e.g. 12345 or 12345-1234 Multiple address can be inserted using multiple records	“Invalid Mailing Zip Code.”
practice_states	optional	Array of strings	[“NJ”,”CT”]	If the provider practices in more than the Primary Practice State on behalf of the organization, list additional states in this field. Comma separated list of two-character state abbreviation using same abbreviate as Primary Practice State above	"Invalid Practice State."
specialties	optional	Array of strings	Acupuncture	Must be a string matching an accepted value.	“Provider Specialty not accepted. Please refer to the Help Center for accepted values.”, “Provider Specialty not found.”
state_licenses	optional	Array of objects
state_licenses[].license_number	optional	String		Non-zero length string of alphanumeric characters; allow for special characters; max character length 20. Multiple licenses can be inserted using multiple records	“Missing License Number”, “License Number is required for NPDB enrollment.”, “Invalid License Number.”
state_licenses[].license_state	optional	String	NY	Must be one, two-characters. Standard state abbreviations. Only states and the District of Columbia are supported. Multiple licenses can be inserted using multiple records	“Missing License State”, “License State is required for NPDB enrollment”, "Invalid License State."
application_received_date	optional	String	01/01/2021, 2021-01-01	preferred format MM/DD/YYYY; YYYY-MM-DD	“Unaccepted Application Received Date format. Please refer to the Help Center for accepted formats”

Field requirements to import a provider and conditionally schedule a recredential

Field	Required / Optional	Data Type	Example	Description	Possible Error Responses
import_type	required	String	Direct	This defines a provider as Direct (credentialing + monitoring) or Delegated (monitoring only)	title: 'import_type', details: 'import_type is missing', code: '400', status: '400'
application_type	required	String	CAQH	This defines a provider as CAQH, CredSimple, Paper, or None application type. CAQH providers must have a CAQH ID	title: 'application_type', details: 'application_type is missing', code: '400', status: '400'
provider_type	required	String	MD	Must be a 2-4 character abbreviation of an accepted type or degree.	“Missing Provider Type.", “Provider Type abbreviation not accepted. Please refer to the Help Center for accepted values.”
provider_email	optional	String. Must be unique to provider	amurphy@healthplan.com	Standard email format validation	“Provider Email conflicts with existing records. Please contact support@andros.co.”, "Invalid Provider Email."
first_name	required	String	Ashley	Must be alpha string with less than or equal to 30 characters	“Missing First Name”, ”Invalid First Name”
middle_name	optional	String	Randall	Must be alpha string with less than or equal to 30 characters	“Invalid Middle Name”
last_name	required	String	Murphy	Must be alpha string with less than or equal to 30 characters	“Missing Last Name”, “Invalid Last Name”
npi	required	String	1437690559	10 digit number, must be “Type 1 - Individual” NPI.	“Missing NPI.”, “Invalid NPI.", “NPI must be Type 1 - Individual.", “Unable to validate NPI due to a service issue with the NPI registry. Please retry and contact support@andros.co if the problem persists."
cred_event	required	String	recred	‘recred’ or ‘recredential’	“Missing Cred Event.”, "Cred Event must be 'initial,' 'recred,' or 'recredential'."
cred_due_date	required for recreds;	String	03/02/2024	MM/DD/YYYY, YYYY-MM-DD	“Missing Cred Due Date”, "Cred Due Date is required for recredentialing events.", "Invalid Cred Due Date.", "Cred Due Date must be in the future.", "Cred Due Date must be less than 5 years in the future."
date_of_birth	required to schedule future credentials	String	10/20/1970	Must be later than 01/01/1930; preferred format MM/DD/YYYY; YYYY-MM-DD	“Missing Date of Birth”, “Unaccepted Date of Birth format. Please refer to the Help Center for accepted formats.”, “Date of Birth conflicts with existing records. Please verify your data and contact support@andros.co if you have additional questions.”
gender	required to schedule future credentials	String	Female	Female, Male, female, male, FEMALE, MALE, f, m, F, M	“Missing Gender”, “Invalid Gender."
external_id	optional	String	123456789	Client’s ID for the Provider. Must be an alphanumeric string with less than or equal to 255 characters.	“Invalid External ID”
primary_practice_state	preferred	String	NY	Standard state abbreviations. Only states and the District of Columbia are supported	"Invalid Primary Practice State."
participating_networks	optional	Array of strings	(client-dependent)	(client-dependent)	“Missing Participating Network”, "Invalid Participating Network."
contact_email	preferred	String	credentialing@healthclinic.com	Standard email format validation	“Invalid Email.”
contact_fax	preferred	String	8013529500	Ensure non-numeric (spaces, hyphens, parentheses and any other special characters) are removed; if there is a leading “1”, making the value 11 digits, strip this out before validating; validate that the value is 10 digits	“Invalid Contact Fax.”
contact_phones	preferred	Array of strings	8013529500 ext 1811	10 or 11 digits; extension accepted in the following formats: 8013529500 ext 1811, 8013529500, ext 1811, 8013529500 ext1811, 8013529500 ext. 1811, 8013529500 ext.1811, 8013529500 EXT: 1811, 8013529500 x 1811, 8013529500 x1811	“Invalid Contact Phone.”
dea_number	optional	String	H93456781	Two capital letters followed by 7 digits	"Invalid DEA Number."
caqh_id	optional	String	12345678	Required for CAQH Application Types	“Missing CAQH ID”, “Invalid CAQH ID”
ssn	required to schedule future credentials; only if school and graduation year not provided	String	123456789	Must be 9 digits, optionally including hyphens	“A valid SSN or School with Graduation Year is required for NPDB enrollment.”, “Invalid SSN.”
school	required to schedule future credentials; only if SSN not provided	String	Duke University	Non-zero length string of word characters; max character length 100; following special characters are permitted: ( ) & . , ‘ -	“A valid SSN or School with Graduation Year is required for NPDB enrollment.”, "Invalid School.", "Invalid School. School contains unacceptable characters."
graduation_year	required to schedule future credentials; only if SSN not provided	String	1960	Must be 4 digits; no earlier than 1950; no later than <= current year + 1	“A valid SSN or School with Graduation Year is required for NPDB enrollment.”, “Graduation Year must be 4 digits.”, “Invalid Graduation Year.”
board_certified	optional	String	True	true, false, TRUE, FALSE, True, False, t, f, T, F, yes, no, YES, NO, Yes, No, y, n, Y, N, 1, 0, ON, OFF, on, off	"Board Certified value is invalid. Please refer to the Help Center for accepted formats."
board_names	optional	Array of strings		Non-zero length string of word characters; max character length 100	"Invalid Board Name."
mailing_addresses	optional	Array of objects
mailing_addresses[].address1	optional	String	400 East End Avenue	Do not include Ampersand (&) as it will error	“Invalid Mailing Address 1.”
mailing_addresses[].address2	optional	String		Do not include Ampersand (&) as it will error	“Invalid Mailing Address 2.”
mailing_addresses[].city	optional	String	New York	Non-zero length string of word characters; max character length 100 Multiple address can be inserted using multiple records	“Invalid Mailing City.”
mailing_addresses[].county	optional	String	New York	Non-zero length string of word characters; max character length 100 Multiple address can be inserted using multiple records	"Invalid Mailing County."
mailing_addresses[].state	optional	String	NY	State abbreviation found https://en.wikipedia.org/wiki/ISO_3166-2:US ; only states and the District of Columbia are supported Multiple address can be inserted using multiple records	“Invalid Mailing State.”
mailing_addresses[].zip	optional	String	10001	Five digits with optional hyphen-separated zip+4 digits, e.g. 12345 or 12345-1234 Multiple address can be inserted using multiple records	“Invalid Mailing Zip Code.”
practice_states	preferred	Array of strings	[“NJ”,”CT”]	If the provider practices in more than the Primary Practice State on behalf of the organization, list additional states in this field. Comma separated list of two-character state abbreviation using same abbreviate as Primary Practice State above	"Invalid Practice State."
specialties	optional	Array of strings	Acupuncture	Must be a string matching an accepted value.	“Provider Specialty not accepted. Please refer to the Help Center for accepted values.”, “Provider Specialty not found.”
state_licenses	required to schedule future credentials	Array of objects
state_licenses[].license_number	required to schedule future credentials	String		Non-zero length string of alphanumeric characters; allow for special characters; max character length 20. Multiple licenses can be inserted using multiple records	“Missing License Number”, “License Number is required for NPDB enrollment.”, “Invalid License Number.”
state_licenses[].license_state	required to schedule future credentials	String	NY	Must be one, two-characters. Standard state abbreviations. Only states and the District of Columbia are supported. Multiple licenses can be inserted using multiple records	“Missing License State”, “License State is required for NPDB enrollment”, "Invalid License State."
application_received_date	optional	String	01/01/2021, 2021-01-01	preferred format MM/DD/YYYY; YYYY-MM-DD	“Unaccepted Application Received Date format. Please refer to the Help Center for accepted formats”

Field requirements to import a provider for ongoing monitoring

Field	Required / Optional	Data Type	Example	Description	Possible Error Responses
import_type	required	String	Delegated	This defines a provider as Direct (credentialing + monitoring) or Delegated (monitoring only)	title: 'import_type', details: 'import_type is missing', code: '400', status: '400'
application_type	required	String	CAQH	This defines a provider as CAQH, CredSimple, Paper, or None application type. CAQH providers must have a CAQH ID	title: 'application_type', details: 'application_type is missing', code: '400', status: '400'
provider_type	required	String	MD	Must be a 2-4 character abbreviation of an accepted type or degree.	“Missing Provider Type”, “Provider Type abbreviation not accepted. Please refer to the Help Center for accepted values.”, “Provider Email conflicts with existing records. Please contact support@andros.co”.
provider_email	optional	String. Must be unique to provider	amurphy@healthplan.com	Standard email format validation	“Provider Email conflicts with existing records. Please contact support@andros.co.”, "Invalid Provider Email."
first_name	required	String	Ashley	Must be alpha string with less than or equal to 30 characters	“Missing First Name”, ”Invalid First Name”
middle_name	optional	String	Randall	Must be alpha string with less than or equal to 30 characters	“Invalid Middle Name”
last_name	required	String	Murphy	Must be alpha string with less than or equal to 30 characters	“Missing Last Name”, “Invalid Last Name”
npi	required		1437690559	10 digit number, must be “Type 1 - Individual” NPI.	“Missing NPI.”, “Invalid NPI.", “NPI must be Type 1 - Individual.", “Unable to validate NPI due to a service issue with the NPI registry. Please retry and contact support@andros.coif the problem persists."
cred_event	N/A
cred_due_date	N/A
date_of_birth	required	required to schedule future credentials	10/20/1970	Must be later than 01/01/1930; preferred format MM/DD/YYYY; YYYY-MM-DD	“Missing Date of Birth”, “Unaccepted Date of Birth format. Please refer to the Help Center for accepted formats.”, “Date of Birth conflicts with existing records. Please verify your data and contact support@andros.co if you have additional questions.”
gender	required to schedule future credentials	String	Female	Female, Male, female, male, FEMALE, MALE, f, m, F, M	“Missing Gender”, “Invalid Gender."
external_id	optional	String	12345678	Client’s ID for the Provider. Must be an alphanumeric string with less than or equal to 255 characters.	“Invalid External ID”
primary_practice_state	preferred	String	NY	Standard state abbreviations. Only states and the District of Columbia are supported	"Invalid Primary Practice State."
participating_networks	optional	Array of strings	(client-dependent)	(client-dependent)	"Invalid Participating Network."
contact_email	preferred	String	credentialing@healthclinic.com	Standard email format validation	“Invalid Email.”
contact_fax	preferred	String	8013529500	Ensure non-numeric (spaces, hyphens, parentheses and any other special characters) are removed; if there is a leading “1”, making the value 11 digits, strip this out before validating; validate that the value is 10 digits	“Invalid Contact Fax.”
contact_phones	preferred	Array of strings	8013529500 ext 1811	10 or 11 digits; extension accepted in the following formats: 8013529500 ext 1811, 8013529500, ext 1811, 8013529500 ext1811, 8013529500 ext. 1811, 8013529500 ext.1811, 8013529500 EXT: 1811, 8013529500 x 1811, 8013529500 x1811	“Invalid Contact Phone.”
dea_number	optional	String	H93456781	Two capital letters followed by 7 digits	"Invalid DEA Number."
caqh_id	optional	String	12345678	Required for CAQH Application Types	“Invalid CAQH ID”
ssn	Required for NPDB verification if School and Graduation Year not submitted. Optional otherwise.	String	123456789	Must be 9 digits, optionally including hyphens	“A valid SSN or School with Graduation Year is required for NPDB enrollment.”, “Invalid SSN.”
school	required for NPDB verification if SSN not provided. Optional otherwise.	String	Duke University	Non-zero length string of word characters; max character length 100; following special characters are permitted: ( ) & . , ‘ -	“A valid SSN or School with Graduation Year is required for NPDB enrollment.”, "Invalid School.", "Invalid School. School contains unacceptable characters."
graduation_year	required for NPDB verification if SSN not provided. Optional otherwise.	String	1960	Must be 4 digits; no earlier than 1950; no later than <= current year + 1	“A valid SSN or School with Graduation Year is required for NPDB enrollment.”, “Graduation Year must be 4 digits.”, “Invalid Graduation Year.”
board_certified	optional	String	True	true, false, TRUE, FALSE, True, False, t, f, T, F, yes, no, YES, NO, Yes, No, y, n, Y, N, 1, 0, ON, OFF, on, off	"Board Certified value is invalid. Please refer to the Help Center for accepted formats."
board_names	optional	Array of strings		Non-zero length string of word characters; max character length 100	"Invalid Board Name."
mailing_addresses	optional	Array of objects
mailing_addresses[]address1	optional	String	400 East End Avenue	Do not include Ampersand (&) as it will error	“Invalid Mailing Address 1.”
mailing_addresses[].address2	optional	String		Do not include Ampersand (&) as it will error	“Invalid Mailing Address 2.”
mailing_addresses[].city	optional	String	New York	Non-zero length string of word characters; max character length 100 Multiple address can be inserted using multiple records	“Invalid Mailing City.”
mailing_addresses[].state	optional	String	NY	State abbreviation found https://en.wikipedia.org/wiki/ISO_3166-2:US ; only states and the District of Columbia are supported Multiple address can be inserted using multiple records	“Invalid Mailing State.”
mailing_addresses[].zip	optional	String	10001	Five digits with optional hyphen-separated zip+4 digits, e.g. 12345 or 12345-1234 Multiple address can be inserted using multiple records	“Invalid Mailing Zip Code.”
mailing_addresses[].county	optional	String	New York	Non-zero length string of alphanumeric characters with special characters; max character length 100 Multiple counties can be inserted using multiple records	"Invalid Mailing County."
practice_states	optional	Array of strings	[“NJ”,”CT”]	If the provider practices in more than the Primary Practice State on behalf of the organization, list additional states in this field. Comma separated list of two-character state abbreviation using same abbreviate as Primary Practice State above	"Invalid Practice State."
specialties	optional	Array of strings	Acupuncture	Must be a string matching an accepted value.	“Provider Specialty not accepted. Please refer to the Help Center for accepted values.”, “Provider Specialty not found.”
state_licenses	required to schedule future credentials	Array of objects
state_licenses[].license_state	required to schedule future credentials	String	NY	Must be one, two-characters. Standard state abbreviations. Only states and the District of Columbia are supported. Multiple licenses can be inserted using multiple records	“Missing License State”, “License State is required for NPDB enrollment”, "Invalid License State."
state_licenses[].license_number	required to schedule future credentials	String		Non-zero length string of alphanumeric characters; allow for special characters; max character length 20. Multiple licenses can be inserted using multiple records	“Missing License Number”, “License Number is required for NPDB enrollment.”, “Invalid License Number.”
application_received_date	optional	String	01/01/2021, 2021-01-01	preferred format MM/DD/YYYY; YYYY-MM-DD	“Unaccepted Application Received Date format. Please refer to the Help Center for accepted formats”

Update an existing provider

The following updates can be made for an existing provider on the client’s roster:

Reactivate an inactive provider and create a new credential event
Create a new credential event for an already active, direct provider
Switch a provider from direct to delegated and cancel any future credential events
Switch a provider from delegated to direct to create a new credential event

API Provider Import

Table of Contents

Overview

The andros Provider Import POST Endpoint is used to:

API Documentation

Provider Import Data Requirements

Field requirements to import a provider and conditionally schedule an initial credential

Field requirements to import a provider and conditionally schedule a recredential

Field requirements to import a provider for ongoing monitoring

Update an existing provider

Comments

Table of Contents

Overview

The andros Provider Import POST Endpoint is used to:

API Documentation

Provider Import Data Requirements

Field requirements to import a provider and conditionally schedule an initial credential

Field requirements to import a provider and conditionally schedule a recredential

Field requirements to import a provider for ongoing monitoring

Update an existing provider

Related articles