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.
Table of Contents
- Overview
- Swagger Documentation
- Provider Import POST Request Body
- Provider Import Data Requirements
- Provider Updates
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
Swagger Documentation
The androsAPI* Swagger documentation provides detailed Parameter, Schema, Request, Response and Error details for all androsAPI Endpoints.
Swagger documentation is automatically updated when changes are made to the underlying API schema or functionality, so it is an up to the minute guide for interacting with androsAPI endpoints.
https://api.credsimple.com/api-docs/index.html
Provider Import: POST /v1/providers/import

Provider Import POST Request Body
The Request Body is the data sent by the client to the androsAPI*. Below is the JSON request body format for sending a Provider for import into the androsCredentialing platform.
{
"application_type": "string",
"import_type": "string",
"provider": {
"provider_type": "string",
"provider_email": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"npi": 0,
"cred_event": "string",
"cred_due_date": "string",
"date_of_birth": "string",
"gender": "string",
"external_id": "string",
"primary_practice_state": "string",
"participating_networks": [
"string"
],
"contact_email": "string",
"contact_fax": "string",
"contact_phones": [
"string"
],
"dea_number": "string",
"caqh_id": "string",
"ssn": "string",
"school": "string",
"graduation_year": "string",
"board_certified": true,
"board_names": [
"string"
],
"mailing_addresses": [
{
"address1": "123 Fake St",
"address2": "Apt 2",
"city": "Townville",
"state": "NY",
"zip": "11215",
"county": "Brown"
}
],
"practice_states": [
"string"
],
"specialties": [
"string"
],
"state_licenses": [
{
"license_number": "string",
"license_state": "string"
}
],
"application_received_date": "2021-08-31"
}
}
Provider Import Data Requirements
Fields used to create a new Provider and schedule the Initial Credentialing process:
Field* = updated via CAQH
|
Field |
Required / Optional |
Multiple Values? |
Example |
Notes |
Possible Error Responses |
|
import_type |
required |
String; One per provider |
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; One per provider |
CAQH |
This defines a provider as CAQH or Paper Application. CAQH providers must have a CAQH ID |
title: 'application_type', details: 'application_type is missing', code: '400', status: '400' |
|
provider_type* |
required |
String; One per provider. |
MD |
Must be one of the following 2-4 character abbreviations. See CAQH Degree Mapping file - “CS_Degree_Mapping” for a list of current provider types that we credential. |
“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; One per provider. 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; One per provider |
Ashley |
Must be alpha string with less than or equal to 30 characters |
“Missing First Name”, ”Invalid First Name” |
|
middle_name |
optional |
String; One per provider |
Randall |
Must be alpha string with less than or equal to 30 characters |
“Invalid Middle Name” |
|
last_name |
required |
String; One per provider |
Murphy |
Must be alpha string with less than or equal to 30 characters |
“Missing Last Name”, “Invalid Last Name” |
|
npi |
required |
String; One per provider |
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; One per provider |
Initial |
Initial, Recred or Recredential |
“Missing Cred Event.”, "Cred Event must be 'initial,' 'recred,' or 'recredential'." |
|
date_of_birth* |
preferred |
String; One per provider |
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; One per provider. |
Male |
Female, Male, female, male, FEMALE, MALE, f, m, F, M |
“Invalid Gender." |
|
external_id |
optional |
String; One per provider |
12345 |
Horizon Prac ID. Must be an alphanumeric string with less than or equal to 255 characters. |
“Invalid External ID” |
|
primary_practice_state |
preferred |
String; One per provider |
NY |
Standard state abbreviations. Only states and the District of Columbia are supported |
"Invalid Primary Practice State." |
|
participating_networks |
Optional |
Array; One or more per provider. |
GP |
‘GP' or 'Com' |
“Missing Participating Network”, "Invalid Participating Network." |
|
contact_email |
required |
String; One per provider. |
credentialing@healthclinic.com |
Standard email format validation |
“Missing Contact Email”, “Invalid Email.” |
|
contact_phone |
preferred |
Array; zero to many per provider |
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.” |
|
contact_fax |
preferred |
String; One per provider. |
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.” |
|
caqh_id* |
optional |
String; One per provider |
12345678 |
Required for CAQH Application Types |
“Missing CAQH ID”, “Invalid CAQH ID” |
|
ssn |
preferred |
String; One per provider |
123456789 |
Must be 9 digits, optionally including hyphens |
“A valid SSN or School with Graduation Year is required for NPDB enrollment.”, “Invalid SSN.” |
|
specialties |
optional |
Array; one to multiple per provider |
Acupuncture |
Must be on Horizon’s Specialty matrix |
“Provider Specialty not accepted. Please refer to the Help Center for accepted values.”, “Provider Specialty not found.” |
|
mailing_address_1 |
preferred |
Array; one to multiple per provider |
400 East End Avenue |
Do not include Ampersand (&) as it will error. Max character length 100. |
“Invalid Mailing Address 1.” |
|
mailing_address_2 |
preferred |
Array; one to multiple per provider |
Do not include Ampersand (&) as it will error. Max character length 100. |
“Invalid Mailing Address 2.” |
|
|
mailing_city |
preferred |
Array; one to multiple per provider |
New York |
Non-zero length string of word characters; max character length 100. Multiple address can be inserted using multiple rows |
“Invalid Mailing City.” |
|
mailing_state |
preferred |
Array; one to multiple per provider |
New York |
State abbreviation foundhttps://en.wikipedia.org/wiki/ISO_3166-2:US ; only states and the District of Columbia are supported Multiple address can be inserted using multiple rows |
“Invalid Mailing State.” |
|
mailing_zip |
preferred |
Array; one to multiple per provider |
10001 |
Five digits with optional hyphen-separated zip+4 digits, e.g. 12345 or 12345-1234 Multiple address can be inserted using multiple rows |
“Invalid Mailing Zip Code.” |
|
practice_states |
optional |
Array; one to multiple per provider |
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." |
|
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” |
Fields used to create a new Recredential Provider and schedule the Recredential process:
Field* = updated via CAQH
|
Field |
Required / Optional |
Multiple Values? |
Example |
Notes |
Possible Error Responses |
|
import_type |
required |
String; One per provider |
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; One per provider |
CAQH |
This defines a provider as CAQH or Paper Application. CAQH providers must have a CAQH ID |
title: 'application_type', details: 'application_type is missing', code: '400', status: '400' |
|
npi |
required |
String; One per provider |
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." |
|
first_name |
required |
String; One per provider |
Ashley |
Must be alpha string with less than or equal to 30 characters |
“Missing First Name”, ”Invalid First Name” |
|
middle_name |
optional |
String; One per provider |
Randall |
Must be alpha string with less than or equal to 30 characters |
“Invalid Middle Name” |
|
last_name |
required |
String; One per provider |
Murphy |
Must be alpha string with less than or equal to 30 characters |
“Missing Last Name”, “Invalid Last Name” |
|
provider_type* |
required |
String; One per provider |
MD |
Must be one of the following 2-4 character abbreviations. See CAQH Degree Mapping file - “CS_Degree_Mapping” for a list of current provider types that we credential. |
“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.” |
|
cred_event |
required |
String; One per provider |
recred |
Initial, Recred or Recredential |
“Missing Cred Event.”, "Cred Event must be 'initial,' 'recred,' or 'recredential'." |
|
cred_due_date |
required for recreds; |
String; One per provider |
03/02/2021 |
MM/DD/YYYY, YYYY-MM-DD |
“Missing Cred Due Date”, "Cred Due Date is required for recredentialing events." |
|
caqh_id* |
optional |
String; One per provider |
12345678 |
Required for CAQH Application Types |
“Missing CAQH ID”, “Invalid CAQH ID” |
|
participating_networks |
required |
Array; one to multiple per provider |
GP |
‘GP’ or ‘COM’ |
“Missing Participating Network”, "Invalid Participating Network." |
|
specialties |
required |
Array; one to multiple per provider |
Acupuncture |
Must be on Horizon’s Recognized Specialty Matrix |
“Missing Specialty”, “Provider Specialty not accepted. Please refer to the Help Center for accepted values.”, “Provider Specialty not found.” |
|
contact_email |
preferred |
String; One per provider |
credentialing@healthclinic.com |
Standard email format validation |
“Invalid Email.” |
|
contact_phone |
preferred |
Array |
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.” |
|
contact_fax |
preferred |
String; One per provider |
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.” |
|
provider_email |
optional |
String; One per provider. 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." |
|
primary_practice_state |
preferred |
String; One per provider |
NY |
Standard state abbreviations. Only states and the District of Columbia are supported |
"Invalid Primary Practice State." |
|
practice_states |
preferred |
Array; one to multiple per provider |
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." |
|
license_number |
required to schedule future credentials |
Array; one to multiple per provider |
Non-zero length string of alphanumeric characters; allow for special characters; max character length 20. Multiple licenses can be inserted using multiple rows |
“Missing License Number”, “License Number is required for NPDB enrollment.”, “Invalid License Number.” |
|
|
license_state |
required to schedule future credentials |
Array; one to multiple per provider |
Must be one, two-characters. Standard state abbreviations. Only states and the District of Columbia are supported. Multiple licenses can be inserted using multiple rows |
“Missing License State”, “License State is required for NPDB enrollment”, "Invalid License State." |
|
|
date_of_birth* |
required to schedule future credentials |
String; One per provider |
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; One per provider |
Female, Male, female, male, FEMALE, MALE, f, m, F, M |
“Missing Gender”, “Invalid Gender." |
|
|
ssn* |
required to schedule future credentials; only if school and graduation year not provided |
String; One per provider |
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; One per provider |
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; One per provider |
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: one per provider |
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; one to multiple per provider |
Non-zero length string of word characters; max character length 100 |
"Invalid Board Name." |
|
|
dea_number |
optional |
String; One per provider |
Two capital letters followed by 7 digits |
"Invalid DEA Number." |
|
|
mailing_address_1 |
optional |
Array; one to multiple per provider |
Do not include Ampersand (&) as it will error |
“Invalid Mailing Address 1.” |
|
|
mailing_address_2 |
optional |
Array; one to multiple per provider |
Do not include Ampersand (&) as it will error |
“Invalid Mailing Address 2.” |
|
|
mailing_city |
optional |
Array; one to multiple per provider |
Non-zero length string of word characters; max character length 100 Multiple address can be inserted using multiple rows |
“Invalid Mailing City.” |
|
|
county |
optional |
Array; One to multiple per provider |
Non-zero length string of word characters; max character length 100 Multiple address can be inserted using multiple rows |
"Invalid Mailing County." |
|
|
mailing_state |
optional |
Array; one to multiple per provider |
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 rows |
“Invalid Mailing State.” |
|
|
mailing_zip_code |
optional |
Array; one to multiple per provider |
Five digits with optional hyphen-separated zip+4 digits, e.g. 12345 or 12345-1234 Multiple address can be inserted using multiple rows |
“Invalid Mailing Zip Code.” |
|
|
external_id |
optional |
String; One per provider |
Horizon Prac ID |
“Invalid External ID” |
Fields used to create a new Ongoing Monitoring Provider:
Field* = updated via CAQH
|
Field |
Required / Optional |
Multiple Values? |
Example |
Notes |
Possible Error Responses |
|
import_type |
required |
String; One per provider |
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; One per provider |
CAQH |
This defines a provider as CAQH or Paper Application |
title: 'application_type', details: 'application_type is missing', code: '400', status: '400' |
|
first_name |
required |
String; One per provider |
Ashley |
Must be alpha string with less than or equal to 30 characters |
“Missing First Name”, ”Invalid First Name” |
|
middle_name |
optional |
String; One per provider |
Randall |
Must be alpha string with less than or equal to 30 characters |
“Invalid Middle Name” |
|
last_name |
required |
String; One per provider |
Murphy |
Must be alpha string with less than or equal to 30 characters |
“Missing Last Name”, “Invalid Last Name” |
|
provider_type* |
required |
String; One per provider. |
MD |
Must be one of the following 2-4 character abbreviations. See CAQH Degree Mapping file - “CS_Degree_Mapping” for a list of current provider types that we credential. |
“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”. |
|
gender* |
required to schedule future credentials |
String; One per provider. |
Male |
Female, Male, female, male, FEMALE, MALE, f, m, F, M |
“Missing Gender”, “Invalid Gender." |
|
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.” |
|
ssn |
required |
String; One per provider |
123456789 |
Must be 9 digits, optionally including hyphens |
“A valid SSN or School with Graduation Year is required for NPDB enrollment.”, “Invalid SSN.” |
|
npi |
required |
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." |
||
|
mailing_address_1 |
optional |
Array; one to multiple per provider |
Do not include Ampersand (&) as it will error |
“Invalid Mailing Address 1.” |
|
|
mailing_address_2 |
optional |
Array; one to multiple per provider |
Do not include Ampersand (&) as it will error |
“Invalid Mailing Address 2.” |
|
|
mailing_city |
optional |
Array; one to multiple per provider |
Non-zero length string of word characters; max character length 100 Multiple address can be inserted using multiple rows |
“Invalid Mailing City.” |
|
|
mailing_state |
optional |
Array; one to multiple per provider |
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 rows |
“Invalid Mailing State.” |
|
|
mailing_zip_code |
optional |
Array; one to multiple per provider |
Five digits with optional hyphen-separated zip+4 digits, e.g. 12345 or 12345-1234 Multiple address can be inserted using multiple rows |
“Invalid Mailing Zip Code.” |
|
|
county |
optional |
Array; one to multiple per provider |
Non-zero length string of alphanumeric characters with special characters; max character length 100 Multiple counties can be inserted using multiple rows |
"Invalid Mailing County." |
|
|
contact_phone |
preferred |
Array; zero to many per provider |
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.” |
|
contact_fax |
preferred |
String; One per provider |
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.” |
|
school |
required to schedule future credentials; only if SSN not provided |
String; One per provider |
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; One per provider |
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.” |
|
license_state |
required to schedule future credentials |
Array; one to multiple per provider |
Must be one, two-characters. Standard state abbreviations. Only states and the District of Columbia are supported. Multiple licenses can be inserted using multiple rows |
“Missing License State”, “License State is required for NPDB enrollment”, "Invalid License State." |
|
|
license_number |
required to schedule future credentials |
Array; one to multiple per provider |
Non-zero length string of alphanumeric characters; allow for special characters; max character length 20. Multiple licenses can be inserted using multiple rows |
“Missing License Number”, “License Number is required for NPDB enrollment.”, “Invalid License Number.” |
|
|
dea_number |
optional |
String; One per provider |
Two capital letters followed by 7 digits |
"Invalid DEA Number." |
|
|
specialties |
optional |
Array; one to multiple per provider |
Acupuncture |
Must be on Horizon’s Recognized Specialty Matrix |
“Provider Specialty not accepted. Please refer to the Help Center for accepted values.”, “Provider Specialty not found.” |
|
caqh_id* |
optional |
String; One per provider |
12345678 |
Required for CAQH Application Types |
“Invalid CAQH ID” |
|
external_id |
optional |
String; One per provider |
Horizon Prac ID |
“Invalid External ID” |
|
|
participating_networks |
optional |
String; One per provider |
GP |
GP' or 'Com' |
"Invalid Participating Network." |
|
contact_email |
preferred |
String; One per provider |
credentialing@healthclinic.com |
Standard email format validation |
“Invalid Email.” |
|
provider_email |
optional |
String; One per provider. 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." |
|
primary_practice_state |
preferred |
String; One per provider |
NY |
Standard state abbreviations. Only states and the District of Columbia are supported |
"Invalid Primary Practice State." |
|
practice_states |
preferred |
Array; one to multiple per provider |
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." |
|
board_certified* |
optional |
String; one per provider |
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; one to multiple per provider |
Non-zero length string of word characters; max character length 100 |
"Invalid Board Name." |
5. 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
- Deactivate an active provider
- 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
Comments
0 comments
Article is closed for comments.