People

A record of a person. This is a singular base record that will be used within Binti in multiple capacities. A person can be part of a foster family, a child receiving services from an agency, an agency worker, or a potential connection in a family finding search.

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

  • created-at* (string) - Date Person was created.

  • updated-at* (string) - Date Person was last updated in Binti.

  • first-name* (string) - First or given name, as provided to Binti.

  • middle-name* (string) - Middle name, as provided to Binti.

  • last-name* (string) - Last or family name, as provided to Binti.

  • suffix* (string) - Suffix, as provided to Binti.

  • nickname* (string) - Nickname or preferred name, as provided to Binti.

  • date-of-birth* (string) - Date of birth.

  • estimated-date-of-birth* (string) - Estimated date of birth. Only one of either date_of_birth or estimated_date_of_birth will be populated.

  • is-deceased* (boolean) - A boolean for if the person is deceased. (True: the person is deceased.)

  • date-of-death* (string) - Date of death.

  • gender* (string) - Gender, as selected from the available options.

    Allowed values

    • Female
    • Male
    • Transgender
    • Non-binary
    • Not listed above
    • Prefer not to answer

  • external-identifier* (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

  • 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

  • client-id* (string) - An external identifier signifying a child client of the agency. Equivement to children.client_id

  • primary-phone-number* (string) - Phone number provided to Binti and designated as Primary Phone number for person

  • 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

  • primary-email-address* (string) - Email Address provided to Binti and designated as Primary Email Address for person

• 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) - A reference to the user-agency-profile for the person if present

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

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

        Allowed values

        • user-agency-profiles
  • child (object) - A relationship with a single entry.
    • data* (object) - A reference to the child if a person is a child

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

      • type* (string) - Always children

        Allowed values

        • children
  • email-addresses (object) - A relationship with multiple entries.
    • data* (array) - Array of entries.

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

      • type* (string) - Always email-addresses

        Allowed values

        • email-addresses