Schemas
Start typing to search…

Social Connections

An object representing a Social Connection between two people

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

    • lineage-type* (string) - Type of lineage

      Allowed values
      • biological
      • adopted
      • step
      • half
      • marriage
      • alleged
      • presumed
      • unknown

    • emotional-relationship-statuses* (array) - Array showing a specific list of emotional relationship statuses

      Allowed values
      • close
      • cordial
      • distant
      • contentious
      • no_prior_interaction

    • kinship-relationship* (string) - Type of kinship or relationship.

      Allowed values
      • mother
      • father
      • parent
      • aunt
      • uncle
      • first_cousin_once_removed
      • grandmother
      • grandfather
      • grandparent
      • great_aunt
      • great_uncle
      • great_grandmother
      • great_grandfather
      • great_grandparent
      • great_great_grandmother
      • great_great_grandfather
      • great_great_grandparent
      • great_great_great_grandmother
      • great_great_great_grandfather
      • great_great_great_grandparent
      • daughter
      • son
      • child
      • niece
      • nephew
      • granddaughter
      • grandson
      • grandchild
      • great_granddaughter
      • great_grandson
      • great_grandchild
      • great_great_granddaughter
      • great_great_grandson
      • great_great_grandchild
      • great_great_great_granddaughter
      • great_great_great_grandson
      • great_great_great_grandchild
      • sibling
      • partner
      • cousin
      • first_cousin
      • second_cousin
      • unknown_kinship_relationship
      • other
      • married
      • divorced
      • engaged
      • dating
      • cohabitating
      • exes
      • other_partner_status
      • relative
      • fictive_kin
      • no_relationship
      • unknown

    • kinship-relationship-other-description* (string) - Relationship description for other.

    • fictive-kin-description* (string) - Relationship description for fictive kin.

    • parental-line* (string) - The parental line this connection is associated with.

      Allowed values
      • maternal
      • paternal
      • parental
      • maternal_and_paternal
      • maternal_and_parental
      • parental_and_paternal

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

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

    • updated-at* (string) - Date and time that the Social Connection was last updated in Binti.

    • levels-of-support* (array) - An array showing levels of support provided.

      • option* (string) - An option key representing a particular type of support

        Allowed values
        • placement
        • placement.placement_provider
        • placement.emergency_caregiver
        • placement.respite_caregiver
        • non_placement
        • non_placement.visitation_regular
        • non_placement.visitation_special_occasions
        • non_placement.visitation_supervision
        • non_placement.transportation
        • non_placement.calls
        • non_placement.childcare
        • non_placement.cultural_support
        • non_placement.financial_support
        • non_placement.educational_support
        • non_placement.mentorship
        • non_placement.family_meeting_participant
        • non_placement.support_for_caregiver
        • non_placement.transitional_age_support
        • do_not_contact
        • not_applicable
        • other

      • details* (string) - Details if an "other" option has been selected

    • placement-provider-eligibilities* (array) - Array showing a specific list of placement provider eligibilities

      Allowed values
      • current_placement
      • recommended
      • willing
      • unwilling
      • unable
      • not_recommended
      • prohibited
      • not_applicable

    • placement-provider-eligibilities-details* (string) - Additional details about placement provider eligibilities

    • worker-confirmed-at* (string) - Date and time that the Social Connection was marked as confirmed by a worker.

    • worker-confirmed* (boolean) - Whether the Social Connection has been confirmed by a worker.

    • related-attributes* (object) - Properties from the two connected people. 'child' properties correspond to the Child in the Social Connection, or in the case of a connection between children, to the Child with the lowest person id. 'phone-number', 'primary-address', and 'connection' properties correspond to the Person pertaining to this social connection.

      • child-first-name* (string) - Child's first name.
      • child-middle-name* (string) - Child's middle name.
      • child-last-name* (string) - Child's last name.
      • child-suffix* (string) - Child's suffix.
      • child-client-id* (string) - Identifier used in external system that can be used to match a singular child in Binti with a child record in another system. Must be unique for each child at an agency.
      • connection-first-name* (string) - First or given name, as provided to Binti.
      • connection-middle-name* (string) - Middle name, as provided to Binti.
      • connection-last-name* (string) - Last or family name, as provided to Binti.
      • connection-suffix* (string) - Suffix, as provided to Binti.
      • connection-nickname* (string) - Nickname or preferred name, as provided to Binti.
      • connection-person-id* (string) - If the person is part of a foster family application they may be assigned an external identifier. Equivelent to user-agency-profiles.external-identifier
      • connection-date-of-birth (string) - Date of birth.
      • connection-estimated-date-of-birth (string) - Estimated date of birth. Only one of either date_of_birth or estimated_date_of_birth will be populated.
      • connection-is-deceased* (boolean) - A boolean for if the person is deceased. (True: the person is deceased.)
      • connection-date-of-death (string) - Date of death.
      • connection-primary-phone-number* (string) - Phone number provided to Binti and designated as Primary Phone number for person
      • connection-primary-address* (object) - Address listed as primary for person within family finding.

        • address-line-1* (string) - Street Address line 1.

        • address-line-2 (string) - Street Address line 2.

        • city* (string) - Address City

        • state* (string) - Address State/Province. Uses the full name. For example: "California" or "Puerto Rico".

        • postal-code* (string) - Address Postal Code

        • country-code (string) - ISO 3166-1 alpha-2 two letter country code. For example: "US", "CA", or "MX".

        • county (string) - Address County

        • start-date (string) - Address Start Date

        • address-type (array) - An array of address type keys

          Allowed values
          • physical_home_of_origin
          • physical_placement
          • physical_home
          • physical_work
          • mailing
          • physical_incarcerated

    • locked* (boolean) - Whether the Social Connection is locked.

  • 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.
    • child (object) - A relationship with a single entry.
      • data* (object) - The child pertaining to this social connection. In the case of a connection between two children, this will be the child with the smallest person id.

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

        • type* (string) - Always children

          Allowed values
          • children
    • connection-person (object) - The existing Person connected to the Child.
      • data* (object) - The Person pertaining to this social connection. In the case of a connection between two children, this will be the person record corresponding to the child with the greater person id.

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

        • type* (string) - Always people

          Allowed values
          • people
    • connection-child (object) - A relationship with a single entry.
      • data* (object) - If the Social Connection involves two Children, this is the second Child record.

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

        • type* (string) - Always children

          Allowed values
          • children

Updated 6 days ago