Application Forms

An Application Form is a representation of data provided by an applicant and/or Agency Worker when they complete a custom Binti form. Binti uses this data to generate PDFs to sign. This data is presented "as is" and contains field level access to items not normally accessible in the core data model. Please note: This data is unstructured and only accessible when configured by Binti's technical account managers. Additionally, fields can change over time. We do not guarantee any specific structure within the questionnaire response data. If you are interested in accessing some of the data fields in a configured form please contact your Binti account team.

id* (string) - The primary key for the record.
type* (string) - The JSON:API type specifier.
attributes* (object) - Primary record attributes.
- created-at* (string) - Date the Application Form was created.
- updated-at* (string) - Date the Application Form was last updated in Binti.
- form-slug* (string) - Machine readable form name. This name is set up by Binti during form configuration. Please contact Binti for a list of slugs for your agency.
- form-name* (string) - The Application Form's human readable name as seen on Binti UI.
- form-version* (string) - The version of the form that was completed if avaliable
- signed-at* (string) - Date the Application Form was signed by all parties.
- state* (string) - Status of Application Form. Avaliable values are: completed: all form fields data has been provided. all_signed: all parties have signed the form and a pdf has been generated.
- not-applicable* (boolean) - Application Form was marked as Not Applicable by case worker.
- progress-percentage* (number) - Percentage of form fields completed.
- completed-offline* (boolean) - Application Form was marked as completed offline by case worker.
- sub-forms-completed-offline* (array) - Array of machine readable names of subforms completed offline.
- sub-forms-not-applicable* (array) - Array of machine readable names of subforms marked as not applicable.
- application-id* (number) - Binti generated ID for Application to which the Application Form is associated.
- application-external-identifier* (string) - External system's identifier for the Application to which the Application Form is associated.
- license-external-identifier* (string) - License specific external identifier. Analogous to family_id.
relationships (object) - Related objects. For each relationship, you can find detailed information about the object by issuing another API call to look it up by ID, or for certain endpoints, you will find details in the "included" section.
- user-agency-profile (object) - A relationship with a single entry.
  - data* (object) - User Agency Profile of person completing the Application Form.
    - id* (string) - The ID of the other object.
    - type* (string) - Always user-agency-profiles
      Allowed values
      
      user-agency-profiles
- application (object) - A relationship with a single entry.
  - data* (object) - The Application to which this Application Form is associated.
    - id* (string) - The ID of the other object.
    - type* (string) - Always initial-applications
      Allowed values
      
      initial-applications
- license (object) - A relationship with a single entry.
  - data* (object) - The License to which this Application Form is associated.
    - id* (string) - The ID of the other object.
    - type* (string) - Always licenses
      Allowed values
      
      licenses
- required-signatures (object) - A relationship with multiple entries.
  - data* (array) - Array of entries.
    - id* (string) - The ID of the other object.
    - type* (string) - Always required-signatures
      Allowed values
      
      required-signatures