Skip to content

CertifyOS API

Download OpenAPI description
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

v2/providers

Operations

v2/flags

Operations

v2/provider-with-groups

Operations

flags

Operations

v2/groups

Operations

Webhooks

Operations

forms

Operations

Create a new form submission.

Request

Creates a new form submission.

Security
BearerAuth
Headers
organization-idstring
Bodyapplication/jsonrequired

Form submission payload.

dataobjectrequired

A flexible object for storing any data related to a form submission. This can include details about the form, the submitted data, and metadata about the submission process.

curl -i -X POST \
  https://docs.certifyos.com/_mock/reference/application/api/forms/submissions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "data": {}
  }'

Responses

Form submission created successfully.

Bodyapplication/json
idstring

The unique identifier for the form submission.

Example: "d453006f-30e2-4a01-841d-962579531c25"
organizationIdstring

The unique identifier for the client organization within Certify.

mappedDataobject

The mapped responses for the form submission. The structure of this object is flexible and can vary based on the form and its fields. Please request the specific structure from the Certify team if needed.

Example: {"personalInformation":{"lastName":"Smith","firstName":"Karen","middleName":"Ann","suffix":"Jr.","npi":1010000226,"caqhId":12345678,"dateOfBirth":"1961-04-26","highmarkId":"123456789","practitionerType":"Medical Doctor","degree":"Medical Doctor","primarySpecialty":"Internal Medicine","primarySpecialtyRole":"PCP","secondarySpecialty":"Infectious Disease","secondarySpecialtyRole":"Specialist","credentialingContactEmailAddress":"credentialing@altoonaprimarycare.com","credentialingContactName":"John Doe"},"primaryPracticeLocation":{"buildingLocation":"Altoona Medical Suites","groupNpi":1010000655,"addressLine1":"Address Line 1","addressLine2":"Address Line 2","city":"Altoona","state":"PA","zip":"16601","zipExt":"1234","county":"Blair County","fips":"42013"},"credentialingAddress":{"sameAsPrimaryPracticeLocation":true,"buildingLocation":"Altoona Medical Suites","addressLine1":"Address Line 1","addressLine2":"Address Line 2","city":"Altoona","state":"PA","zip":"16601","zipExt":"1234","county":"Blair County","fips":"42013","phoneNumber":"555-555-5555","phoneExtension":"123"}}
submissionDataobject

The raw responses for the form submission. The structure of this object is flexible and can vary based on the form and its fields. Please request the specific structure from the Certify team if needed.

submissionPdfobject

The PDF document of the form submission, if available.

submittedByobject

The flexible data object containing the submitted by information.

formobject

Information about the form associated with the submission.

formVersionIdstring

The id of the version of the form used for this submission.

Example: "e4dea7d7-6023-4c64-b0f1-777dd0266a02"
createdAtstringrequired

The date and time when the form submission was created

Example: "2025-01-01T12:00:00Z"
createdBystringrequired

The identifier of the user or system that created the submission.

updatedAtstringrequired

The date and time when the form submission was last updated

Example: "2025-01-01T12:00:00Z"
Response
application/json
{ "id": "d453006f-30e2-4a01-841d-962579531c25", "organizationId": "string", "mappedData": { "personalInformation": {}, "primaryPracticeLocation": {}, "credentialingAddress": {} }, "submissionData": {}, "submissionPdf": {}, "submittedBy": { "email": "string", "user": {} }, "form": {}, "formVersionId": "e4dea7d7-6023-4c64-b0f1-777dd0266a02", "createdAt": "2025-01-01T12:00:00Z", "createdBy": "string", "updatedAt": "2025-01-01T12:00:00Z" }

Get a form submission by ID.

Request

Retrieves a single form submission by its unique ID.

Security
BearerAuth
Path
idstringrequired

Form submission ID.

Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/forms/submissions/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

Form submission found.

Bodyapplication/json
idstring

The unique identifier for the form submission.

Example: "d453006f-30e2-4a01-841d-962579531c25"
organizationIdstring

The unique identifier for the client organization within Certify.

mappedDataobject

The mapped responses for the form submission. The structure of this object is flexible and can vary based on the form and its fields. Please request the specific structure from the Certify team if needed.

Example: {"personalInformation":{"lastName":"Smith","firstName":"Karen","middleName":"Ann","suffix":"Jr.","npi":1010000226,"caqhId":12345678,"dateOfBirth":"1961-04-26","highmarkId":"123456789","practitionerType":"Medical Doctor","degree":"Medical Doctor","primarySpecialty":"Internal Medicine","primarySpecialtyRole":"PCP","secondarySpecialty":"Infectious Disease","secondarySpecialtyRole":"Specialist","credentialingContactEmailAddress":"credentialing@altoonaprimarycare.com","credentialingContactName":"John Doe"},"primaryPracticeLocation":{"buildingLocation":"Altoona Medical Suites","groupNpi":1010000655,"addressLine1":"Address Line 1","addressLine2":"Address Line 2","city":"Altoona","state":"PA","zip":"16601","zipExt":"1234","county":"Blair County","fips":"42013"},"credentialingAddress":{"sameAsPrimaryPracticeLocation":true,"buildingLocation":"Altoona Medical Suites","addressLine1":"Address Line 1","addressLine2":"Address Line 2","city":"Altoona","state":"PA","zip":"16601","zipExt":"1234","county":"Blair County","fips":"42013","phoneNumber":"555-555-5555","phoneExtension":"123"}}
submissionDataobject

The raw responses for the form submission. The structure of this object is flexible and can vary based on the form and its fields. Please request the specific structure from the Certify team if needed.

submissionPdfobject

The PDF document of the form submission, if available.

submittedByobject

The flexible data object containing the submitted by information.

formobject

Information about the form associated with the submission.

formVersionIdstring

The id of the version of the form used for this submission.

Example: "e4dea7d7-6023-4c64-b0f1-777dd0266a02"
createdAtstringrequired

The date and time when the form submission was created

Example: "2025-01-01T12:00:00Z"
createdBystringrequired

The identifier of the user or system that created the submission.

updatedAtstringrequired

The date and time when the form submission was last updated

Example: "2025-01-01T12:00:00Z"
Response
application/json
{ "id": "d453006f-30e2-4a01-841d-962579531c25", "organizationId": "string", "mappedData": { "personalInformation": {}, "primaryPracticeLocation": {}, "credentialingAddress": {} }, "submissionData": {}, "submissionPdf": {}, "submittedBy": { "email": "string", "user": {} }, "form": {}, "formVersionId": "e4dea7d7-6023-4c64-b0f1-777dd0266a02", "createdAt": "2025-01-01T12:00:00Z", "createdBy": "string", "updatedAt": "2025-01-01T12:00:00Z" }

v2/facility-credentialing-workflows

Operations

v2/facilities

Operations