Schemas
Start typing to search…

Initial Applications

An Application represents one applicant and an optional co-applicant attempting to become licensed for foster care, along with all associated documentation, forms, background checks, and Children.

  • id* (string) - The primary key for the record.
  • type* (string) - The JSON:API type specifier.
  • attributes* (object) - Primary record attributes.

    • owner-agency-slug* (string) - The slug for the agency which owns this data

    • created-at* (string) - Date and time that the Application was created in Binti.

    • updated-at* (string) - Date and time that the Application was last updated. Includes changes to status, assignments, or data on the Application itself. Does not include updates to forms.

    • address* (object) - Object representing an address. Note that any of the keys may be missing or may be set to an empty string. Some addresses have geocoded information, which has been verified against a third party (US Census data, among others) to be accurate.

      • address-street (string) - The street address, as provided
      • address-city (string) - The city of the address, as provided
      • address-state (string) - The two-letter state code of the address
      • address-zipcode (string) - The zip code of the address, as provided
      • address-county (string) - The county of the address, as provided
      • address-additional-directions (string) - Additional directions to the address, as provided
      • address-type (string) - The type of address
      • geocoding-source (string) - The geocoder used to geocode this data
      • geocoded-address-street (string) - The accurate street address, if available
      • geocoded-address-city (string) - The accurate city, if available
      • geocoded-address-state (string) - The accurate state code, if available
      • geocoded-address-zipcode (string) - The accurate zip code, if available

    • adult-children* (array) - Array of arbitrary data.

    • adults-in-home* (array) - Array of arbitrary data.

    • applicant-forms-completed-percentage* (number) - Calculated percentage 0-100 indicating the percentage of applicant forms completed. Calculated based off of the number of questions in forms that need to be completed by the applicant. Note, 1% point will be docked for unsigned forms.

    • applicant-notification-date* (string) - Referral date in Binti.

    • approved-age-lower* (number) - Youngest age of children for which this family is approved to provide care.

    • approved-age-higher* (number) - Highest age of children for which this family is approved to provide care.

    • background-checks-summary* (object) - Summary overview of Background Checks for this Application.

      • percentage-completed* (number) - Percentage of required Background Checks that have been completed.
      • required* (number) - Number of required Background Checks.
      • completed* (number) - Number of completed Background Checks.
      • non-exemptible* (number) - Number of Background Checks in non-exemptible status.
      • exemptions* (object) - Summary overview of Background Check exemptions.

        • summary* (string) - Status of the exemptions of the Application. Indicates whether or not an exemption is needed, denied, completed. If no exemption is needed, this field wil be null.

          Allowed values
          • needs_exemption
          • exemption_denied
          • exemption_completed

        • required* (number) - Number of required exemptions.

        • completed* (number) - Number of completed exemptions.

        • denied* (number) - Number of denied exemptions.

    • capacity* (number) - How many beds are available in the caregiver's home.

    • case-type* (string) - Whether this is a dependency or a probation type, if your agency supports it.

      Allowed values
      • dependency
      • probation

    • casework-completed-percentage* (number) - Percentage of case worker forms that have been completed.

    • caseworker-assigned-date* (string) - Date that the case worker was assigned to the family.

    • child-in-home* (boolean) - Whether or not there is a Child placed in the home.

    • community-foster* (boolean) - Whether or not this caregiver is open to taking in non-relative children from the community. Note that this is always true when family_type is community.

    • confidential* (boolean) - Whether or not this Application has been marked confidential.

    • cws-cms-assigned-worker* (string) - CA-only: Name of the assigned case worker, null if no assignment, as it appears in CWS-CMS.

    • cws-cms-status* (string) - CA only: Status as it appears in CWS-CMS

      Allowed values
      • pending
      • denied
      • approved
      • withdrawn

    • cws-cms-status-date* (string) - CA only: Date the Application was moved to its current status, as it appears in CWS-CMS.

    • expiry-date* (string) - Expiry date of Application as determined by the next renewal due date, only present on approved Applications.

    • external-identifier* (string) - External systems identifier for individual Application. Must be unique for agency.

    • date-application-signed* (string) - Date the Application was signed.

    • date-of-inquiry* (string) - Date of initial inquiry

    • date-of-placement* (string) - Date that placement started, if a pre-approval placement was made.

    • days-since-placement* (number) - Calculated number of days from today, based on the date a pre-approval placement was made.

    • days-since-signed* (number) - Calculated number of days from today, since the initial Application was signed.

    • family-evaluation-completion-summary* (object) - Summary of completion for the family evaluation.

      • description* (string) - A description of the evaluation.
      • percentage* (number) - Percent 0-100, indicating % of questions completed in the family evaluation.
      • complete* (boolean) - Whether or not the family evaluation is complete.

    • family-type* (string) - Whether the family is a relative, non-relative, fictive kin (nrefm), community, or a guardian family.

    • home-info* (array) - Array of arbitrary data.

    • how-did-you-hear-about-us-details* (string) - Details on how the family heard about the agency, as selected in signup questionnaire, or filled out by a case worker.

    • how-did-you-hear-about-us-label* (string) - The family's answer to 'how did you hear about us?'. The tiered answers are joined into a single string, separated by ' - ' characters.

    • in-person-orientation-date* (string) - Date of the in-person orientation.

    • intake-completed-percentage* (number) - Percentage of the intake forms that have been completed.

    • intake-forms-complete* (boolean) - Whether or not the intake forms are complete.

    • intake-inbox-date* (string) - Date that the intake occurred.

    • intake-incomplete-date* (string) - TO DO: intake-incomplete-date

    • intake-incomplete-reason* (string) - TO DO: intake-incomplete-reason

    • intake-inter-county-case* (boolean) - TO DO: intake-inter-county-case

    • intake-receiving-county* (string) - TO DO: intake-receiving-county

    • intake-receiving-icpc* (string) - TO DO: intake-receiving-icpc

    • intake-referring-county* (string) - TO DO: intake-referring-county

    • intake-referring-icpc* (string) - TO DO: intake-referring-icpc

    • inter-county-request* (boolean) - Whether or not this is an out-of-county family.

    • inter-state-request* (boolean) - Whether or not this an ICPC family.

    • license-external-identifier* (string) - External systems identifier for a License or collection of Applications per family. Must be unique for agency.

    • mailing-address* (object) - Object representing an address. Note that any of the keys may be missing or may be set to an empty string. Some addresses have geocoded information, which has been verified against a third party (US Census data, among others) to be accurate.

      • mailing-address-street (string) - The street address, as provided
      • mailing-address-city (string) - The city of the address, as provided
      • mailing-address-state (string) - The two-letter state code of the address
      • mailing-address-zipcode (string) - The zip code of the address, as provided
      • mailing-address-county (string) - The county of the address, as provided
      • mailing-address-additional-directions (string) - Additional directions to the address, as provided
      • address-type (string) - The type of address
      • mailing-geocoding-source (string) - The geocoder used to geocode this data
      • mailing-geocoded-address-street (string) - The accurate street address, if available
      • mailing-geocoded-address-city (string) - The accurate city, if available
      • mailing-geocoded-address-state (string) - The accurate state code, if available
      • mailing-geocoded-address-zipcode (string) - The accurate zip code, if available

    • medically-trained* (boolean) - Whether or not this family is medically trained.

    • medical-summary* (object) - Medical summary information.

      • percentage* (number) - Percentage complete.
      • completed* (number) - Number of records completed.
      • required* (number) - Number of records required.

    • minor-children-in-home* (array) - Array of arbitrary data.

    • online-orientation-date* (string) - Date online orientation was completed.

    • pets* (array) - Array of arbitrary data.

    • reference-summary* (object) - Summary of references on the Application.

      • status* (string) - Status of references on the family - can be complete, incomplete, or unknown number needed.

        Allowed values
        • complete
        • unknown_number_required
        • incomplete

      • completed* (number) - Number of completed references on the family.

      • required* (number) - Number of required references on the family.

    • referring-caseworker* (string) - Name of case worker who referred the family.

    • referring-office* (string) - Name of office or case worker who referred the family.

    • referring-supervisor-caseworker* (string) - Name of supervisor or case worker who referred the family.

    • renewal-due-date* (string) - Due date of the renewal Application, only available on renewal Applications.

    • respite-provider* (boolean) - Whether or not the caregiver is open to being a respite provider.

    • spa* (string) - CA only: Service Provider Area.

    • status* (string) - Status of the Application in Binti.

      Allowed values
      • applying
      • approved
      • awaiting_referral
      • closed
      • denied
      • in_adoption_process
      • inactive
      • eligible_for_conversion
      • recruiting_dropout
      • recruiting
      • withdrawn
      • ready_for_review

    • status-date* (string) - Date that the Application moved to the current status.

    • status-explanation* (string) - Free-text explanation for the current status, recorded at time of status change.

    • status-reason* (string) - Reason code for current status, as selected by dropdown.

      Allowed values
      • Caregiver chose to withdraw themselves
      • Minor was placed or seems like will be placed with another applicant
      • Reunification with parent(s)
      • Placement moved to permanency
      • Caregiver withdrew due to complaints/delays with the process
      • Caregiver withdrew because of criminal background
      • Life circumstance change
      • Buildings and Grounds standards not met
      • Non-exemptible conviction
      • Inimical/hostile/unfriendly conduct during process
      • Binti application created in error
      • Not enough capacity
      • Not ready yet
      • Not located in county
      • No longer interested
      • Unresponsive
      • Specific child no longer needs placement
      • Adoption/Permanency finalized
      • Change in family dynamic/structure
      • Dissatisfied with agency support
      • Financial reasons
      • Health reasons
      • Approval revoked
      • Moved
      • Negative parenting experience
      • Retiring
      • Specific child left
      • Unwilling to comply with regulations
      • Surrendered
      • Rescinded
      • Declined conversion
      • Caregiver was uncooperative/non-responsive
      • Referred/Applying with another agency
      • Adoption
      • Ineligible
      • Legal Guardianship
      • Not interested
      • Binti application created in error / duplicate
      • Provider was uncooperative/non-reponsive (application ceased)
      • Leadership did not pass background checks
      • Provider chose to withdraw themselves
      • Provider was uncooperative/non-responsive (application ceased)
      • Provider withdrew because of leadership challenges
      • Provider withdrew due to complaints/delays with the process
      • Other

    • status-overridden* (boolean) - Whether the Application's status has been overridden. This is a read-only field. In order to override an Application's status, provide a status-overridden-reason and status-overridden-explanation.

    • status-overridden-reason* (string) - If the Application's status has been overridden, the reason provided. Empty otherwise.

    • status-overridden-explanation* (string) - If the Application's status has been overridden, the freeform text explanation provided. Empty otherwise.

    • supporting-docs-completed-percentage* (number) - Percentage of supporting documents that are completed.

    • trainings-completed-percentage* (number) - Percentage of trainings that are completed.

    • type* (string) - Available Application types.

      Allowed values
      • InitialApplication
      • RenewalApplication
      • CaliforniaConversionApplication

    • template-slug* (string) - A string that describes the blueprint for this Application's forms, required documents, and trainings. All Applications of the same "type" will share the same value for this string. Contact your account manager for the possible values for this field.

  • 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.
    • applicant-agency-profile (object) - A relationship with a single entry.
      • data* (object) - A reference to the user-agency-profile of the primary applicant.

        • id* (string) - The ID of the other object.

        • type* (string) - Always user-agency-profiles

          Allowed values
          • user-agency-profiles
    • co-applicant-agency-profile (object) - A relationship with a single entry.
      • data* (object) - A reference to the user-agency-profile of the co-applicant.

        • id* (string) - The ID of the other object.

        • type* (string) - Always user-agency-profiles

          Allowed values
          • user-agency-profiles
    • other-adult-profiles (object) - A relationship with multiple entries.
      • data* (array) - Array of entries.

        • id* (string) - The ID of the other object.

        • type* (string) - Always other-adult-profiles

          Allowed values
          • other-adult-profiles
    • children-in-home-profiles (object) - A relationship with multiple entries.
      • data* (array) - Array of entries.

        • id* (string) - The ID of the other object.

        • type* (string) - Always other-adult-profiles

          Allowed values
          • other-adult-profiles
    • worker-assignments (object) - A relationship with multiple entries.
      • data* (array) - Array of entries.

        • id* (string) - The ID of the other object.

        • type* (string) - Always worker-assignments

          Allowed values
          • worker-assignments
    • sub-agencies (object) - A relationship with multiple entries.
      • data* (array) - Array of entries.

        • id* (string) - The ID of the other object.

        • type* (string) - Always agencies

          Allowed values
          • agencies
    • license (object) - A relationship with a single entry.
      • data* (object) - A reference to the license assosiated with this application

        • id* (string) - The ID of the other object.

        • type* (string) - Always licenses

          Allowed values
          • licenses
    • good-causes (object) - A relationship with multiple entries.
      • data* (array) - Array of entries.

        • id* (string) - The ID of the other object.

        • type* (string) - Always good-causes

          Allowed values
          • good-causes
    • agency-placement (object) - A relationship with a single entry.
      • data* (object) - A refrence to the agency-placement associated with this application.

        • id* (string) - The ID of the other object.

        • type* (string) - Always agency-placements

          Allowed values
          • agency-placements
    • application-key-dates (object) - A relationship with a single entry.
      • data* (object) - A reference to the application-key-dates associated with this application.

        • id* (string) - The ID of the other object.

        • type* (string) - Always application-key-dates

          Allowed values
          • application-key-dates

Updated 6 days ago