Skip to content
CertifyOS API
/
/
Fetch attested provider d...

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

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"
}

Fetch attested provider data

Request

Security
BearerAuth
Path
providerIdstringrequired
Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/attested-data' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

Bodyapplication/json
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
Response
application/json
{
  "purpose": "string",
  "organization_id": "string",
  "workflow_id": "string",
  "date_complete": "2019-08-24T14:15:22Z",
  "attestation_metadata": [
    { … }
  ],
  "data_snapshot": {
    "first_name": { … },
    "middle_name": { … },
    "last_name": { … },
    "suffix_name": { … },
    "npi": { … },
    "other_name": [ … ],
    "email": [ … ],
    "caqh_id": { … },
    "provider_type": { … },
    "education": [ … ],
    "licenses": [ … ],
    "speciality_board_certification": [ … ],
    "dea": [ … ],
    "addresses": [ … ],
    "dob": { … },
    "gender": { … },
    "sex": { … },
    "ssn": { … },
    "document": [ … ],
    "employment_history": [ … ],
    "liability_insurance": [ … ]
  },
  "question": [
    { … }
  ]
}

Upload Provider Attested Data Document

Request

Security
BearerAuth
Path
providerIdstringrequired
Headers
organization-idstring
Bodymultipart/form-datarequired
fileTypestringrequired

Type of the file uploading

organizationIdstringrequired

ID assigned to Client Organization

workflowIdstringrequired

ID assigned to Workflow

filestring(binary)

Provider Document

curl -i -X POST \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/attested-data/documents' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -H 'organization-id: string' \
  -F fileType=string \
  -F organizationId=string \
  -F workflowId=string \
  -F file=string

Responses

The record has been successfully created.

v2/providers

Operations

v2/flags

Operations

v2/provider-with-groups

Operations

flags

Operations

v2/groups

Operations

Webhooks

Operations

forms

Operations

v2/facility-credentialing-workflows

Operations

v2/facilities

Operations