User Agency Profiles

User Agency Profiles represent any individuals related to an application - this includes applicants, co-applicants, other adults, and references.

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

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

  • updated-at* (unknown) - Date and time that the user's information was last updated.

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

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

  • middle-name* (["string", "null"]) - Middle name, as provided to Binti.

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

  • suffix* (["string", "null"]) - Suffix, as provided to Binti.

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

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

    Allowed values

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

  • email* (["string", "null"]) - Email address.

  • phone-number* (["string", "null"]) - Phone number, provided as freeform text to Binti without formatting constraints.

  • phone-type* (["string", "null"]) - Phone number category. One of: home, mobile, work.

    Allowed values

    • home
    • mobile
    • work

  • other-phone-numbers* (["array", "null"]) - Additional phone numbers associated with the User Agency Profile.

  • 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

  • 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

  • family-id* (["string", "null"]) - State-specific family identifier - analogous to RFAID. This should only be set on applicants during creation. Attempts to create a UserAgencyProfile with a family_id for co-applicants will fail.

  • primary-language* (string) - Primary language spoken. May be an empty string.

  • additional-languages* (string) - Additional languages spoken. May be an empty string.

  • ethnicities* (array) - A person's collective ethnicity. Multiple options can be selected.

    • ethnicity* (string) - Available race/ethnicity values.

      Allowed values

      • american-indian-or-alaska-native-or-first-nations
      • american-indian-or-alaska-native-or-first-nations.american-indian
      • american-indian-or-alaska-native-or-first-nations.alaska-native
      • asian
      • asian.south-asian
      • asian.south-asian.asian-indian
      • asian.south-asian.bangladeshi
      • asian.south-asian.pakistani
      • asian.south-asian.other-south-asian
      • asian.east-asian
      • asian.east-asian.chinese
      • asian.east-asian.japanese
      • asian.east-asian.korean
      • asian.east-asian.other-east-asian
      • asian.south-east-asian
      • asian.south-east-asian.cambodian
      • asian.south-east-asian.filipino
      • asian.south-east-asian.hmong
      • asian.south-east-asian.indonesian
      • asian.south-east-asian.laotian
      • asian.south-east-asian.thai
      • asian.south-east-asian.vietnamese
      • asian.south-east-asian.other-south-east-asian
      • asian.other-asian
      • black-or-african-american
      • black-or-african-american.ethiopian
      • black-or-african-american.caribbean
      • black-or-african-american.haitian
      • black-or-african-american.jamaican
      • black-or-african-american.nigerian
      • black-or-african-american.somalian
      • black-or-african-american.other-black-or-african-american
      • hispanic-or-latinx
      • hispanic-or-latinx.central-american
      • hispanic-or-latinx.central-american.cuban
      • hispanic-or-latinx.central-american.dominican
      • hispanic-or-latinx.central-american.ecuadorian
      • hispanic-or-latinx.central-american.mexican
      • hispanic-or-latinx.central-american.puerto-rican
      • hispanic-or-latinx.central-american.salvadoran
      • hispanic-or-latinx.central-american.other-central-american
      • hispanic-or-latinx.south-american
      • hispanic-or-latinx.south-american.brazilian
      • hispanic-or-latinx.south-american.colombian
      • hispanic-or-latinx.south-american.guatemalan
      • hispanic-or-latinx.south-american.peruvian
      • hispanic-or-latinx.south-american.other-south-american
      • hispanic-or-latinx.other-hispanic-or-latinx
      • middle-eastern-or-north-african
      • middle-eastern-or-north-african.middle-eastern
      • middle-eastern-or-north-african.middle-eastern.armenian
      • middle-eastern-or-north-african.middle-eastern.lebanese
      • middle-eastern-or-north-african.middle-eastern.other-middle-eastern
      • middle-eastern-or-north-african.northern-african
      • middle-eastern-or-north-african.northern-african.egyptian
      • middle-eastern-or-north-african.northern-african.other-northern-african
      • middle-eastern-or-north-african.other-middle-eastern-or-northern-african
      • native-hawaiian-or-other-pacific-islander
      • native-hawaiian-or-other-pacific-islander.guamanian-chamorro
      • native-hawaiian-or-other-pacific-islander.chuukese
      • native-hawaiian-or-other-pacific-islander.fijian
      • native-hawaiian-or-other-pacific-islander.native-hawaiian
      • native-hawaiian-or-other-pacific-islander.kosraean
      • native-hawaiian-or-other-pacific-islander.marshallese
      • native-hawaiian-or-other-pacific-islander.mixed
      • native-hawaiian-or-other-pacific-islander.palauan
      • native-hawaiian-or-other-pacific-islander.pohnpeian
      • native-hawaiian-or-other-pacific-islander.polynesian
      • native-hawaiian-or-other-pacific-islander.samoan
      • native-hawaiian-or-other-pacific-islander.tongan
      • native-hawaiian-or-other-pacific-islander.yapese
      • native-hawaiian-or-other-pacific-islander.other-pacific-islander
      • white
      • white.central-american
      • white.european
      • white.european.english
      • white.european.italian
      • white.european.german
      • white.european.irish
      • white.european.scottish
      • white.european.romanian
      • white.european.other-european
      • white.middle-eastern
      • white.russian
      • white.other-white-or-caucasian
      • other
      • prefer-not-to-answer
      • unknown
      • hispanic-origin-yes
      • hispanic-origin-yes.cuban
      • hispanic-origin-yes.dominican
      • hispanic-origin-yes.mexican-mexican-american-chicano
      • hispanic-origin-yes.puerto-rican
      • hispanic-origin-yes.central-american
      • hispanic-origin-yes.central-american.guatemalan
      • hispanic-origin-yes.central-american.salvadoran
      • hispanic-origin-yes.central-american.other-central-american
      • hispanic-origin-yes.south-american
      • hispanic-origin-yes.south-american.brazilian
      • hispanic-origin-yes.south-american.colombian
      • hispanic-origin-yes.south-american.ecuadorian
      • hispanic-origin-yes.south-american.peruvian
      • hispanic-origin-yes.south-american.other-south-american
      • hispanic-origin-yes.other-hispanic-or-latinx-origin
      • hispanic-origin-no
      • hispanic-origin-prefer-not-to-answer
      • hispanic-origin-unknown

    • details* (["string", "null"]) - Ethnicities details.

  • races* (array) - A person's collective race. Multiple options can be selected.

    • race* (string) - Available race values.

      Allowed values

      • american-indian-or-alaska-native-or-first-nations
      • american-indian-or-alaska-native-or-first-nations.american-indian
      • american-indian-or-alaska-native-or-first-nations.alaska-native
      • asian
      • asian.south-asian
      • asian.south-asian.asian-indian
      • asian.south-asian.bangladeshi
      • asian.south-asian.pakistani
      • asian.south-asian.other-south-asian
      • asian.east-asian
      • asian.east-asian.chinese
      • asian.east-asian.japanese
      • asian.east-asian.korean
      • asian.east-asian.other-east-asian
      • asian.south-east-asian
      • asian.south-east-asian.cambodian
      • asian.south-east-asian.filipino
      • asian.south-east-asian.hmong
      • asian.south-east-asian.indonesian
      • asian.south-east-asian.laotian
      • asian.south-east-asian.thai
      • asian.south-east-asian.vietnamese
      • asian.south-east-asian.other-south-east-asian
      • asian.other-asian
      • black-or-african-american
      • black-or-african-american.ethiopian
      • black-or-african-american.caribbean
      • black-or-african-american.caribbean.haitian
      • black-or-african-american.caribbean.jamaican
      • black-or-african-american.caribbean.other-caribbean
      • black-or-african-american.nigerian
      • black-or-african-american.somali
      • black-or-african-american.other-black-or-african-american
      • native-hawaiian-or-other-pacific-islander
      • native-hawaiian-or-other-pacific-islander.guamanian-chamorro
      • native-hawaiian-or-other-pacific-islander.chuukese
      • native-hawaiian-or-other-pacific-islander.fijian
      • native-hawaiian-or-other-pacific-islander.native-hawaiian
      • native-hawaiian-or-other-pacific-islander.kosraean
      • native-hawaiian-or-other-pacific-islander.marshallese
      • native-hawaiian-or-other-pacific-islander.palauan
      • native-hawaiian-or-other-pacific-islander.pohnpeian
      • native-hawaiian-or-other-pacific-islander.polynesian
      • native-hawaiian-or-other-pacific-islander.samoan
      • native-hawaiian-or-other-pacific-islander.tongan
      • native-hawaiian-or-other-pacific-islander.yapese
      • native-hawaiian-or-other-pacific-islander.other-pacific-islander
      • white
      • white.european
      • white.european.english
      • white.european.italian
      • white.european.german
      • white.european.irish
      • white.european.scottish
      • white.european.romanian
      • white.european.other-european
      • white.middle-eastern-or-north-african
      • white.middle-eastern-or-north-african.middle-eastern
      • white.middle-eastern-or-north-african.middle-eastern.lebanese
      • white.middle-eastern-or-north-african.middle-eastern.other-middle-eastern
      • white.middle-eastern-or-north-african.northern-african
      • white.middle-eastern-or-north-african.northern-african.egyptian
      • white.middle-eastern-or-north-african.northern-african.other-northern-african
      • white.middle-eastern-or-north-african.other-middle-eastern-or-northern-african
      • white.armenian
      • white.russian
      • white.other-white-or-caucasian
      • other
      • prefer-not-to-answer
      • unknown-race
      • imported-data

    • details* (["string", "null"]) - Race option details.

  • hispanic-or-latino-ethnicity* (array) - A person's hispanic or lation ethnicity status. Multiple options can be selected.

    • ethnicity* (string) - Available hispanic or latino ethnicity values.

      Allowed values

      • hispanic-origin-yes
      • hispanic-origin-yes.cuban
      • hispanic-origin-yes.dominican
      • hispanic-origin-yes.mexican-mexican-american-chicano
      • hispanic-origin-yes.puerto-rican
      • hispanic-origin-yes.central-american
      • hispanic-origin-yes.central-american.guatemalan
      • hispanic-origin-yes.central-american.salvadoran
      • hispanic-origin-yes.central-american.other-central-american
      • hispanic-origin-yes.south-american
      • hispanic-origin-yes.south-american.brazilian
      • hispanic-origin-yes.south-american.colombian
      • hispanic-origin-yes.south-american.ecuadorian
      • hispanic-origin-yes.south-american.peruvian
      • hispanic-origin-yes.south-american.other-south-american
      • hispanic-origin-yes.other-hispanic-or-latinx-origin
      • hispanic-origin-no
      • hispanic-origin-prefer-not-to-answer
      • hispanic-origin-unknown

    • details* (["string", "null"]) - Ethnicity option details.

  • confidential* (boolean) - Boolean flag designating a family is considered confidential in Binti.

  • cws-cms-address-street* (["string", "null"]) - Street of residence as reflected in CWS-CMS.

  • cws-cms-address-city* (["string", "null"]) - City of residence as reflected in CWS-CMS.

  • cws-cms-address-state* (["string", "null"]) - State of residence as reflected in CWS-CMS.

  • cws-cms-address-zipcode* (["string", "null"]) - Zip code of residence as reflected in CWS-CMS.

  • cws-cms-caregiver-id* (["string", "null"]) - Caregiver ID as reflected in CWS-CMS.

  • cws-cms-touch-date* (["string", "null"]) - CWS-CMS touch date.

  • cws-cms-home-id* (["string", "null"]) - Home ID as reflected in CWS-CMS.

  • external-identifier* (["string", "null"]) - Identifier for the user model in an external system.

  • license-external-identifier* (["string", "null"]) - License specific external identifier. Analogous to family id and present on all User Agency Profiles.

  • roles* (array) - Array of roles the User has on associated Applications.

  • sign-in-count* (number) - Number of times this user has signed into the Binti system.

  • ssn* (["string", "null"]) - Social Security Number associated with the User Agency Profile.

  • protected-tribe* (["boolean", "null"]) - A boolean for if the User is a member of a protected Native American tribe. (true: the User is in a protected tribe.)

  • protected-tribe-names* (["array", "null"]) - An array of the protected tribe(s) of which the User is a member.

• 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.
  • worker-assignments (object) - A relationship with multiple entries.
    • data* (array) - Array of entries.
  • agency-workers (object) - A relationship with multiple entries.
    • data* (array) - Array of entries.