v1

latestOpenAPI 3.1.02026-08-063776831.4 MB

Form Submissions

Get a form submission by ID

Retrieves a single form submission by its unique ID. The response includes organizationId (from tenant), flattened data fields, and standard form submission metadata. Requires tenant-id header and valid JWT.

get/forms/submissions/{id}

Path parameters

idstring required

Unique identifier of the form submission (UUID)

Headers

tenant-idstring required

Tenant (organization) identifier

Response

Form submission found. Returns the form submission with organizationId and flattened data.

idstring

The unique identifier for the form submission

organizationIdstring

The unique identifier for the client organization within Certify

{"stackTrail":"components:schemas:FormSubmissionResponseDto:properties:mappedData","oasType":"schema","type":"unknown","description":"The mapped responses for the form submission. The structure of this object is flexible and can vary based on the form and its fields.","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"}}}

{"stackTrail":"components:schemas:FormSubmissionResponseDto:properties:submissionData","oasType":"schema","type":"unknown","description":"The raw responses for the form submission. The structure of this object is flexible and can vary based on the form and its fields.","example":{}}

{"stackTrail":"components:schemas:FormSubmissionResponseDto:properties:submissionPdf","oasType":"schema","type":"unknown","description":"The PDF document of the form submission, if available","example":{}}

{"stackTrail":"components:schemas:FormSubmissionResponseDto:properties:form","oasType":"schema","type":"unknown","description":"Information about the form associated with the submission","example":{}}

formVersionIdstring

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

createdAtstring

The date and time when the form submission was created

createdBystring

The identifier of the user or system that created the submission

updatedAtstring

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"
    }
  },
  "submissionData": {},
  "submissionPdf": {},
  "submittedBy": {
    "email": "user@example.com",
    "user": {}
  },
  "form": {},
  "formVersionId": "e4dea7d7-6023-4c64-b0f1-777dd0266a02",
  "createdAt": "2025-01-01T12:00:00Z",
  "updatedAt": "2025-01-01T12:00:00Z"
}