Skip to content
CertifyOS API
/
v2/provider
/
Create Provider

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

Create Provider

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

initial_credentialing_datestring(date-time)

Date by which Provider was initially credentialed.

external_idstring

Client’s ID for the provider

primary_emailstring

Provider’s email address

Example: "string@string.com"
genderstring

Provider Gender

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

Provider’s date of birth

group_namestring

Name of the group

group_npistring= 10 characters

Group National Provider Identifier (NPI)

Example: "2345678901"
group_tinstring= 9 characters

Group Tax Identification Number (TIN)

Example: "123456789"
location_namestring

Name of group location

external_group_idstring

Client’s ID for the group

is_pcpboolean

Indicates whether the provider is a Primary Care Provider (PCP).

is_specialistboolean

Indicates whether the provider is a specialist.

accepts_new_patientsboolean

Indicates whether the provider is currently accepting new patients.

accepts_new_medicare_patientsboolean

Indicates whether the provider accepts new Medicare patients.

curl -i -X POST \
  https://docs.certifyos.com/_mock/reference/application/api/v2/provider \
  -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",
    "initial_credentialing_date": "2019-08-24T14:15:22Z",
    "external_id": "string",
    "primary_email": "string@string.com",
    "gender": "M",
    "dob": "2019-08-24T14:15:22Z",
    "group_name": "string",
    "group_npi": "2345678901",
    "group_tin": "123456789",
    "location_name": "string",
    "external_group_id": "string",
    "is_pcp": true,
    "is_specialist": true,
    "accepts_new_patients": true,
    "accepts_new_medicare_patients": true
  }'

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
}

Retrieve all available information for a provider.

Request

Security
BearerAuth
Query
npistring
external_idstring
provider_idstring
includeCredentialingWorkflowsbooleanrequired

Include credentialing workflows with PSV url.

Default true
includeFullDatabooleanrequired

Include full data from every section.

Default true
signUrlsbooleanrequired

Sign Document URLs for immediate access.

Default true
includeVerifiedbooleanrequired

Included VerifiedBy User info.

Default true
includeGroupInfobooleanrequired

Include group info.

Default false
includeSanctionItemsbooleanrequired

Include sanction items.

Default false
Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider?npi=string&external_id=string&provider_id=string&includeCredentialingWorkflows=true&includeFullData=true&signUrls=true&includeVerified=true&includeGroupInfo=false&includeSanctionItems=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

Provider Details.

Bodyapplication/json
dataobject(ProviderV2Dto)required
provider_sanctionsArray of objects(ProviderSanctionsDto)required
date_of_reportstringrequired

Date the sanction report was issued

Example: "YYYY-MM-DD"
idstringrequired

Unique identifier for the provider sanction record

sanction_typestringrequired

Type of sanction applied to the provider

Enum"OIG""GSA/SAM/OFAC""OFAC""MOO""State Exclusion List""Preclusion List Check"
type_of_actionstringrequired

Type of action taken against the provider

Enum"No Match Found""Match Found"
verified_bystringrequired

Name of the person or system that verified the sanction

datastringrequired

Additional data or details related to the sanction

verified_datestringrequired

Date the sanction was verified

Example: "YYYY-MM-DD"
malpractice_insuranceArray of objects(MalpracticeInsuranceDto)required
expiry_datestringrequired

Date when the malpractice insurance policy expires

Example: "YYYY-MM-DD"
idstringrequired

Unique identifier for the malpractice insurance record

sourcestringrequired

Source from which the malpractice insurance information was obtained (Copy of Insurance, Application, N/A)

statusstringrequired

Current status of the malpractice insurance policy (active, expired)

policy_numberstringrequired

Policy number of the malpractice insurance

verified_bystringrequired

Name of the person or system that verified the malpractice insurance

verified_datestringrequired

Date the malpractice insurance was verified

Example: "YYYY-MM-DD"
aggregate_coverage_amountnumberrequired

Aggregate coverage amount of the malpractice insurance policy

occurrence_coverage_amountnumberrequired

Occurrence coverage amount of the malpractice insurance policy

policyHolderstringrequired

Name of the policy holder for the malpractice insurance

pliCoverageTypestringrequired

Type of Professional Liability Insurance (PLI) coverage

policyEffectiveDatestringrequired

Effective date of the malpractice insurance policy

Example: "YYYY-MM-DD"
policyExpirationDatestringrequired

Expiration date of the malpractice insurance policy

Example: "YYYY-MM-DD"
policyCurrentEffectiveDatestringrequired

Current effective date of the malpractice insurance policy

Example: "YYYY-MM-DD"
individualCoverageFlagbooleanrequired

Indicates if the policy provides individual coverage (true/false)

insuranceTypestringrequired

Type of insurance.

npdb_dataArray of objects(NpdbDataDto)required
idstringrequired

Unique identifier for the NPDB data.

type_of_actionstringrequired

Type of action taken.

Enum"No Action""Medical Malpractice Payment""Health Plan""State Licensure/Certification""Professional Society""Exclusion/Debarment""DEA/Federal Licensure""Government Administrative""Judgement/Conviction""Clinical Privileges"
report_datestringrequired

Date the report was created

Example: "YYYY-MM-DD"
process_datestringrequired

Date the report was processed

Example: "YYYY-MM-DD"
verified_bystringrequired

Name of the individual who verified the report

verified_datestringrequired

Date the report was verified

Example: "YYYY-MM-DD"
created_datestringrequired

Date the report entry was created

Example: "YYYY-MM-DD"
payment_datestringrequired

Date the payment was made (if applicable)

Example: "YYYY-MM-DD"
specific_allegation_datestringrequired

Date of the specific allegation (if applicable)

Example: "YYYY-MM-DD"
sourcestringrequired

Source of the report (NPDB)

report_typestringrequired

Type of report (e.g., disciplinary, administrative)

Enum"Adverse Action Report""Medical Malpractice Payment Report""No Report Found"
first_namestringrequired

First name of the subject of the report

last_namestringrequired

Last name of the subject of the report

genderstringrequired

Gender of the subject

npistringrequired

National Provider Identifier (NPI)

home_addressstringrequired

Home address of the subject

home_citystringrequired

Home city of the subject

home_statestringrequired

Home state of the subject

home_zipstringrequired

Home ZIP code of the subject

dcnstringrequired

Document Control Number (DCN)

birth_datestringrequired

Birth date of the subject

Example: "1980-05-21"
databank_subject_idstringrequired

Databank Subject ID, unique identifier from NPDB

performance_indicatorArray of objects(PerformanceIndicatorDto)required
access_issuestringrequired
benefitsstringrequired
claimsstringrequired
clinicalstringrequired
complaintsstringrequired
idstringrequired
servicestringrequired
application_verificationArray of objects(ApplicationVerificationDto)required
explanationstringrequired
idstringrequired
verification_typestringrequired
verified_bystringrequired
verified_datestringrequired
Example: "YYYY-MM-DD"
board_certifications_dataArray of objects(BoardCertificationDto)required
idstringrequired

Unique identifier for the board certification record

certificate_idstringrequired

Certificate ID assigned by the certifying board

expire_datestringrequired

Date the certification expires

Example: "YYYY-MM-DD"
issue_datestringrequired

Date the certification was issued

Example: "YYYY-MM-DD"
specialtystringrequired

Specialty for which the certification was awarded

Enum"Acupuncture""Acute Care""Acute Care Nurse Practitioner""Acute/Critical Care Nursing""Addiction Medicine""Addiction Psychology""Administrative Medicine""Adult-Gerontology Acute Care""Adult-Gerontology Acute Care Clinical Nurse Specialist""Adult-Gerontology Acute Care Nurse Practitioner"
subspecialtystringrequired

Subspecialty for which the certification was awarded

Enum"None""N/A""Addiction Medicine""Addiction Psychiatry""Adolescent Medicine""Adolescent Medicine (Family Medicine)""Adolescent Medicine (Internal Medicine)""Adolescent Medicine (Pediatrics)""Adult Cardiac Anesthesiology""Adult Congenital Heart Disease"
verified_bystringrequired

Name of the person or system that verified the certification

verified_datestringrequired

Date the certification was verified

Example: "YYYY-MM-DD"
mocstringrequired

Maintenance of Certification (MOC) status or details (Yes, No, Not Required)

statusstringrequired

Current status of the board certification (Certified, Expired, Not Certified)

duration_typestringrequired

Type of duration for the certification (Time-Limited, Lifetime, MOC)

credentialing_timelineArray of objects(CredentialingTimelineDto)required
medical_directorstringrequired
attestation_datestringrequired
Example: "YYYY-MM-DD"
initial_credentialed_datestring
Example: "YYYY-MM-DD"
last_credentialed_datestringrequired
Example: "YYYY-MM-DD"
psv_complete_datestringrequired
Example: "YYYY-MM-DD"
credentialing_decision_datestringrequired
Example: "YYYY-MM-DD"
next_credentialing_datestringrequired
Example: "YYYY-MM-DD"
received_for_credentialing_datestringrequired
Example: "YYYY-MM-DD"
education_trainingArray of objects(EducationTrainingDto)required
idstringrequired

Unique identifier for the education or training record

sourcestringrequired

Source from which the education training information was obtained (e.g., Application, Primary Source Verification)

Enum"Verified through Licensing Board/Agency""Verified through Board Certification""Verified by Educational Institution""Verified through the AMA""Verified by Student Clearinghouse"
typestringrequired

Type of education training.

Enum"Fellowship""Residency""Professional""Internship"
degreestringrequired

Degree awarded

Enum"Bachelor of Arts (BA)""Bachelor of Accountancy (BAcc)""Bachelor of Architecture (BArch)""Bachelor of Business Administration (BBA)""Bachelor of Commerce (BComm)""Bachelor of Computer Science (BCS)""Bachelor of Computer Application (BCA)""Bachelor of Divinity (BDiv)""Bachelor of Economics (BEc)""Bachelor of Education (BEd)"
specialtystringrequired

Specialty or field of study for the education training

Enum"Acupuncture""Acute Care""Acute Care Nurse Practitioner""Acute/Critical Care Nursing""Addiction Medicine""Addiction Psychology""Administrative Medicine""Adult-Gerontology Acute Care""Adult-Gerontology Acute Care Clinical Nurse Specialist""Adult-Gerontology Acute Care Nurse Practitioner"
institutionstringrequired

Name of the institution where the education training was completed

licensing_board_referencestringrequired

Reference or identifier from the licensing board, if applicable

verified_bystringrequired

Name of the person or system that verified the education training

verified_datestringrequired

Date the education training was verified

Example: "YYYY-MM-DD"
licensesArray of objects(LicenseDto)required
typestringrequired

Type of license (e.g., medical, nursing, etc.)

expirationstringrequired

Date the license expires

Example: "YYYY-MM-DD"
issue_datestringrequired

Date the license was issued

Example: "YYYY-MM-DD"
license_numberstringrequired

Unique license number assigned by the issuing authority

statestringrequired

State or jurisdiction where the license is issued

statusstringrequired

Current status of the license (e.g., active, expired, suspended)

idstringrequired

Unique identifier for the license record

license_typestringrequired

Type/category of the license (e.g., MD, RN, DO)

license_statusstringrequired

Status of the license (e.g., valid, invalid, pending)

sourcestringrequired

Source from which the license information was obtained

report_datestringrequired

Date the license report was generated

Example: "YYYY-MM-DD"
verified_bystringrequired

Name of the person or system that verified the license

verified_datestringrequired

The date at which the license was verified.

Example: "YYYY-MM-DD"
first_namestring

First name of the license holder (if available)

last_namestring

Last name of the license holder (if available)

middle_namestring

Middle name of the license holder (if available)

deasArray of objects(DeaDto)required
expire_datestringrequired
Example: "YYYY-MM-DD"
dea_numberstringrequired
idstringrequired
statestringrequired
statusstringrequired
provider_typestringrequired

Type of provider

Enum"AA""ABA""ACU""ADC""APN""AT""ATR""AUD""BCaBA""BCBA"
verified_bystringrequired
verified_datestringrequired
Example: "YYYY-MM-DD"
sourcestringrequired
typestringrequired
hospital_affiliationsArray of objects(HospitalAffiliationDto)required
namestringrequired

Name of the affiliated hospital

specialtystringrequired

Specialty associated with the hospital affiliation

Enum"Acupuncture""Acute Care""Acute Care Nurse Practitioner""Acute/Critical Care Nursing""Addiction Medicine""Addiction Psychology""Administrative Medicine""Adult-Gerontology Acute Care""Adult-Gerontology Acute Care Clinical Nurse Specialist""Adult-Gerontology Acute Care Nurse Practitioner"
statestring

State where the hospital is located (if applicable)

typestringrequired

Type of hospital affiliation (Hospital Privileges, Hospital Admitting Arrangements, Non-hospital Admitting Arrangements, Exempt)

sourcestring

Source from which the hospital affiliation information was obtained (if applicable)

start_datestringrequired

Date when the hospital affiliation started

Example: "YYYY-MM-DD"
end_datestring(date-time)required

Date when the hospital affiliation ended/ends

verified_bystringrequired

Name of the person or system that verified the hospital affiliation

verified_datestringrequired

Date the hospital affiliation was verified

Example: "YYYY-MM-DD"
licensure_actionsobject(LicensureActionsDto)required
date_of_last_actionstringrequired
date_of_reportstringrequired
detailsstringrequired
statestringrequired
type_of_actionstringrequired
idstringrequired
first_namestringrequired
middle_namestringrequired
last_namestringrequired
npistringrequired
provider_typestringrequired

Type of provider

Enum"AA""ABA""ACU""ADC""APN""AT""ATR""AUD""BCaBA""BCBA"
caqh_provider_idstringrequired
provider_idstringrequired
statusstringrequired

Current status of the provider

Enum"Terminated""Active""Denied""New""In Progress"
organization_idstringrequired
file_typestringrequired
psv_urlstringrequired
dobstringrequired
genderstringrequired
verified_bystringrequired
monitoring_statusstringrequired
last_monitoring_datestringrequired
Example: "YYYY-MM-DD"
provider_created_datestringrequired
Example: "YYYY-MM-DD"
verified_datestringrequired
Example: "YYYY-MM-DD"
file_completion_datestringrequired
Example: "YYYY-MM-DD"
file_statusstringrequired
raceArray of objects(RaceTypeDto)required
raceEthnicityLevel1stringrequired
raceEthnicityLevel2Array of objects(RaceEthnicityLevel2Dto)required
raceEthnicityLevel2Namestringrequired
raceEthnicityLevel3Array of objects(RaceEthnicityLevel3Dto)required
raceEthnicityLevel3Namestringrequired
ethnicitystringrequired
other_languagesstringrequired
supporting_documentsArray of objects(SupportingDocumentV2Dto)required
created_atstring(date-time)required
file_typestringrequired
file_urlstringrequired
original_file_namestringrequired
idstringrequired
external_idstringrequired
professional_idsArray of objects(ProfessionalIdV2Dto)required

Professional IDs associated with the provider

typestringrequired

Type of professional ID

Enum"Medicare Number""Medicaid Number""ECFMG Number""Foreign National Identification Number""Unique Physician Identification Number""CLIA""DEA"
numberstringrequired

Professional ID number

issue_datestringrequired

Issue date of the professional ID

expiration_datestringrequired

Expiration date of the professional ID

notestring

Notes about the professional ID

statestring

State associated with the professional ID

sourcestring

Source of the professional ID

practitioner_medicaidobject(PractitionerMedicaidDto)required
medicaidNumberstringrequired
medicaidStatestringrequired
practitioner_practice_locationobject(PractitionerPracticeActiveLocationDto)required
addressobject(CaqhAddressDto)required
address1stringrequired
address2stringrequired
citystringrequired
statestringrequired
zipCodestringrequired
countrystringrequired
healthcareServiceNamestringrequired
practice_locationArray of objects(PracticeLocationDto)required

Practice locations associated with the provider

idstringrequired
provider_idstringrequired
organization_idstringrequired
namestringrequired
tinstring
start_datestring
Example: "YYYY-MM-DD"
drawing_bloodboolean
laboratory_servicesboolean
clia_numberstring
clia_expiration_datestring
Example: "YYYY-MM-DD"
address1string
citystring
statestring
zipstring
countrystring
npistring
phoneCoverage24x7boolean
totalLocationHoursnumber
locationHoursArray of objects(LocationHourDto)
verified_bystring
verified_datestring
Example: "YYYY-MM-DD"
credentialing_statusstring

Credentialing status of the provider

Enum"Not sent to credentialing""Not Started""In Progress""Recredentialing in progress""Data missing""Outreach in progress""PSV Complete""PSV ready""Hold for Cred Comm""Tabled"
credentialing_cyclestring
statesArray of strings
assigned_statesArray of strings
sanction_itemsArray of objects(BaseSanctionItemResponseDto)required

Sanction items associated with the provider

idstringrequired
first_namestring
last_namestring
npistring

National Provider Identifier (NPI)

address1string
address2string
address3string
address4string
citystring
statestring
zip_codestring
sourcestringrequired
sanction_typestringrequired
middle_namestring
full_namestring
business_namestring
countrystring
data_acquire_datestring
Example: "YYYY-MM-DD"
source_update_datestring
Example: "YYYY-MM-DD"
data_fetch_methodstring
Example: "YYYY-MM-DD"
data_issuing_sourcestring
Example: "YYYY-MM-DD"
data_source_urlstring
Example: "YYYY-MM-DD"
data_fetch_sourcestring
Example: "YYYY-MM-DD"
date_processedstring
Example: "YYYY-MM-DD"
processed_bystring
start_datestring
Example: "YYYY-MM-DD"
end_datestring
Example: "YYYY-MM-DD"
license_jurisdictionstring
organization_idstring
provider_idstring
created_bystring
updated_bystring
created_atstring
Example: "YYYY-MM-DD"
updated_atstring
Example: "YYYY-MM-DD"
created_by_namestring
updated_by_namestring
flagstring
verified_bystring
verified_atstring
Example: "YYYY-MM-DD"
action_sourcestring
isPCPboolean
isSpecialistboolean
acceptsNewPatientsboolean
acceptsNewMedicarePatientsboolean
primaryEmailstring
successbooleanrequired
Response
application/json
{
  "data": {
    "provider_sanctions": [ … ],
    "malpractice_insurance": [ … ],
    "npdb_data": [ … ],
    "performance_indicator": [ … ],
    "application_verification": [ … ],
    "board_certifications_data": [ … ],
    "credentialing_timeline": [ … ],
    "education_training": [ … ],
    "licenses": [ … ],
    "deas": [ … ],
    "hospital_affiliations": [ … ],
    "licensure_actions": { … },
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "npi": "string",
    "provider_type": "AA",
    "caqh_provider_id": "string",
    "provider_id": "string",
    "status": "Terminated",
    "organization_id": "string",
    "file_type": "string",
    "psv_url": "string",
    "dob": "string",
    "gender": "string",
    "verified_by": "string",
    "monitoring_status": "string",
    "last_monitoring_date": "YYYY-MM-DD",
    "provider_created_date": "YYYY-MM-DD",
    "verified_date": "YYYY-MM-DD",
    "file_completion_date": "YYYY-MM-DD",
    "file_status": "string",
    "race": [ … ],
    "ethnicity": "string",
    "other_languages": "string",
    "supporting_documents": [ … ],
    "external_id": "string",
    "professional_ids": [ … ],
    "practitioner_medicaid": { … },
    "practitioner_practice_location": { … },
    "practice_location": [ … ],
    "credentialing_status": "Not sent to credentialing",
    "credentialing_cycle": "string",
    "states": [ … ],
    "assigned_states": [ … ],
    "sanction_items": [ … ],
    "isPCP": true,
    "isSpecialist": true,
    "acceptsNewPatients": true,
    "acceptsNewMedicarePatients": true,
    "primaryEmail": "string"
  },
  "success": true
}

Save attested provider data

Request

Security
BearerAuth
Path
providerIdstringrequired
Headers
organization-idstring
Bodyapplication/jsonrequired
purposestringrequired
organization_idstringrequired
workflow_idstringrequired
date_completestring(date-time)required
attestation_metadataArray of objects(AttestationMetadata)required
attestation_languagestring
attestation_signature_imagestring
attestation_namestring
date_attestedstring(date-time)
data_snapshotobject(DataSnapshot)required
first_nameobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
middle_nameobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
last_nameobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
suffix_nameobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
npiobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
other_nameArray of objects(OtherName)required
first_nameobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
middle_nameobject(FieldValueWithDescription)
last_nameobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
suffix_nameobject(FieldValueWithDescription)
name_typeobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
emailArray of objects(Email)required
typeobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
emailobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
caqh_idobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
provider_typeobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
educationArray of objects(Education)required
institution_nameobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
degreeobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
documentstring
start_dateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
graduation_dateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
end_dateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
licensesArray of objects(License)required
typeobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
stateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
license_numberobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
issuing_boardobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
documentstringrequired
expiration_dateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
issue_dateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
renewal_dateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
speciality_board_certificationArray of objects(SpecialityBoardCertificate)required
specialtyobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
sub_specialtyobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
board_certifiedobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
certifying_boardobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
cert_numberobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
documentstringrequired
issue_dateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
renewal_dateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
expiration_dateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
deaArray of objects(DEA)required
dea_numberobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
stateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
documentstringrequired
issue_dateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
expiration_dateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
renewal_dateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
addressesArray of objects(ProviderAddress)required
typeobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
address_line_1object(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
address_line_2object(FieldValueWithDescription)
zipobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
cityobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
stateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
countryobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
dobobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
genderobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
sexobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
ssnobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
documentArray of objects(DocumentInfo)required
typeobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
urlstringrequired
employment_historyArray of objects(EmploymentHistory)required
typeobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
employerobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
titleobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
specialityobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
start_dateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
end_dateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
address_line_1object(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
address_line_2object(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
countryobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
cityobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
stateobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
zipobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
gap_explanationobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
liability_insuranceArray of objects(LiabilityInsurance)required
carrier_nameobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
policy_numberobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
policy_expirationobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
occurence_amountobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
general_aggregate_amountobject(FieldValueWithDescription)required
valuestringrequired
descriptionstringrequired
documentstringrequired
questionArray of objects(Question)required
question_textstringrequired
question_responseArray of objects(QuestionResponse)required
response_textstringrequired
curl -i -X POST \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/attested-data' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "purpose": "string",
    "organization_id": "string",
    "workflow_id": "string",
    "date_complete": "2019-08-24T14:15:22Z",
    "attestation_metadata": [
      {
        "attestation_language": "string",
        "attestation_signature_image": "string",
        "attestation_name": "string",
        "date_attested": "2019-08-24T14:15:22Z"
      }
    ],
    "data_snapshot": {
      "first_name": {
        "value": "string",
        "description": "string"
      },
      "middle_name": {
        "value": "string",
        "description": "string"
      },
      "last_name": {
        "value": "string",
        "description": "string"
      },
      "suffix_name": {
        "value": "string",
        "description": "string"
      },
      "npi": {
        "value": "string",
        "description": "string"
      },
      "other_name": [
        {
          "first_name": {
            "value": "string",
            "description": "string"
          },
          "middle_name": {
            "value": "string",
            "description": "string"
          },
          "last_name": {
            "value": "string",
            "description": "string"
          },
          "suffix_name": {
            "value": "string",
            "description": "string"
          },
          "name_type": {
            "value": "string",
            "description": "string"
          }
        }
      ],
      "email": [
        {
          "type": {
            "value": "string",
            "description": "string"
          },
          "email": {
            "value": "string",
            "description": "string"
          }
        }
      ],
      "caqh_id": {
        "value": "string",
        "description": "string"
      },
      "provider_type": {
        "value": "string",
        "description": "string"
      },
      "education": [
        {
          "institution_name": {
            "value": "string",
            "description": "string"
          },
          "degree": {
            "value": "string",
            "description": "string"
          },
          "document": "string",
          "start_date": {
            "value": "string",
            "description": "string"
          },
          "graduation_date": {
            "value": "string",
            "description": "string"
          },
          "end_date": {
            "value": "string",
            "description": "string"
          }
        }
      ],
      "licenses": [
        {
          "type": {
            "value": "string",
            "description": "string"
          },
          "state": {
            "value": "string",
            "description": "string"
          },
          "license_number": {
            "value": "string",
            "description": "string"
          },
          "issuing_board": {
            "value": "string",
            "description": "string"
          },
          "document": "string",
          "expiration_date": {
            "value": "string",
            "description": "string"
          },
          "issue_date": {
            "value": "string",
            "description": "string"
          },
          "renewal_date": {
            "value": "string",
            "description": "string"
          }
        }
      ],
      "speciality_board_certification": [
        {
          "specialty": {
            "value": "string",
            "description": "string"
          },
          "sub_specialty": {
            "value": "string",
            "description": "string"
          },
          "board_certified": {
            "value": "string",
            "description": "string"
          },
          "certifying_board": {
            "value": "string",
            "description": "string"
          },
          "cert_number": {
            "value": "string",
            "description": "string"
          },
          "document": "string",
          "issue_date": {
            "value": "string",
            "description": "string"
          },
          "renewal_date": {
            "value": "string",
            "description": "string"
          },
          "expiration_date": {
            "value": "string",
            "description": "string"
          }
        }
      ],
      "dea": [
        {
          "dea_number": {
            "value": "string",
            "description": "string"
          },
          "state": {
            "value": "string",
            "description": "string"
          },
          "document": "string",
          "issue_date": {
            "value": "string",
            "description": "string"
          },
          "expiration_date": {
            "value": "string",
            "description": "string"
          },
          "renewal_date": {
            "value": "string",
            "description": "string"
          }
        }
      ],
      "addresses": [
        {
          "type": {
            "value": "string",
            "description": "string"
          },
          "address_line_1": {
            "value": "string",
            "description": "string"
          },
          "address_line_2": {
            "value": "string",
            "description": "string"
          },
          "zip": {
            "value": "string",
            "description": "string"
          },
          "city": {
            "value": "string",
            "description": "string"
          },
          "state": {
            "value": "string",
            "description": "string"
          },
          "country": {
            "value": "string",
            "description": "string"
          }
        }
      ],
      "dob": {
        "value": "string",
        "description": "string"
      },
      "gender": {
        "value": "string",
        "description": "string"
      },
      "sex": {
        "value": "string",
        "description": "string"
      },
      "ssn": {
        "value": "string",
        "description": "string"
      },
      "document": [
        {
          "type": {
            "value": "string",
            "description": "string"
          },
          "url": "string"
        }
      ],
      "employment_history": [
        {
          "type": {
            "value": "string",
            "description": "string"
          },
          "employer": {
            "value": "string",
            "description": "string"
          },
          "title": {
            "value": "string",
            "description": "string"
          },
          "speciality": {
            "value": "string",
            "description": "string"
          },
          "start_date": {
            "value": "string",
            "description": "string"
          },
          "end_date": {
            "value": "string",
            "description": "string"
          },
          "address_line_1": {
            "value": "string",
            "description": "string"
          },
          "address_line_2": {
            "value": "string",
            "description": "string"
          },
          "country": {
            "value": "string",
            "description": "string"
          },
          "city": {
            "value": "string",
            "description": "string"
          },
          "state": {
            "value": "string",
            "description": "string"
          },
          "zip": {
            "value": "string",
            "description": "string"
          },
          "gap_explanation": {
            "value": "string",
            "description": "string"
          }
        }
      ],
      "liability_insurance": [
        {
          "carrier_name": {
            "value": "string",
            "description": "string"
          },
          "policy_number": {
            "value": "string",
            "description": "string"
          },
          "policy_expiration": {
            "value": "string",
            "description": "string"
          },
          "occurence_amount": {
            "value": "string",
            "description": "string"
          },
          "general_aggregate_amount": {
            "value": "string",
            "description": "string"
          },
          "document": "string"
        }
      ]
    },
    "question": [
      {
        "question_text": "string",
        "question_response": [
          {
            "response_text": "string"
          }
        ]
      }
    ]
  }'

Responses

The record has been successfully created.

Bodyapplication/json
idstring
Response
application/json
{
  "id": "string"
}

v2/providers

Operations

v2/flags

Operations

v2/provider-with-groups

Operations

flags

Operations

v2/groups

Operations

Webhooks

Operations

forms

Operations

v2/facilities

Operations

v2/facility-credentialing-workflows

Operations