v1

latestOpenAPI 3.0.02026-08-0679302767.4 KB

forms

Create a new form submission.

Creates a new form submission.

post/forms/submissions

Headers

organization-idstring

Request body

dataobject required

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.

Response

Form submission created successfully.

idstring

The unique identifier for the form submission.

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.

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.

formobject

Information about the form associated with the submission.

formVersionIdstring

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

createdAtstring required

The date and time when the form submission was created

createdBystring required

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

updatedAtstring required

The date and time when the form submission was last updated

Example response

{
  "id": "d453006f-30e2-4a01-841d-962579531c25",
  "mappedData": {
    "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"
    }
  },
  "formVersionId": "e4dea7d7-6023-4c64-b0f1-777dd0266a02",
  "createdAt": "2025-01-01T12:00:00Z",
  "updatedAt": "2025-01-01T12:00:00Z"
}