Profiles

Profile objects contain information related to the identity of the user: name, address, contact details, etc. The data in a profile is tied to a particular data partner account that the user has connected to via Argyle Link.

Attributes

id string uuid

Attribute	Type	Description
id	string uuid	Unique ID of the profile associated with a user's data partner account.
account	string uuid	ID of the account associated with the profile.
employer	string	The name of the company or entity that employs the user.
first_name	string	The legal first name of the user.
last_name	string	The legal last name of the user.
full_name	string	The full legal name of the user.
email	string	Email address.
phone_number	string	Phone number. Value is returned in the E.164 international phone number format.
birth_date	string	Date of birth. Timestamps follow the ISO 8601 standard. In some rare cases, the Link item platform will obfuscate the birth year and the returned value will be formatted with having a dash instead of the year number: `--01-20`.
picture_url	string	Profile picture of the user (if available from the Link item). The value is a URL pointing to the internal storage where the image is held.
address.line1	string	Address line 1—for example, street, PO Box, or company name.
address.line2	string	Address line 2—for example, apartment, suite, unit, or building.
address.city	string	City, district, suburb, town, or village.
address.state	string	State, county, province, or region.
address.postal_code	string	ZIP or postal code.
address.country	string	Two-letter country code returned in the ISO 3166-1 alpha-2 format.
ssn	string	Social Security Number.
marital_status	string	Marital status of the user.
gender	string	Gender of the user.
metadata	string	Metadata holds additional available, often unstructured, information about this data resource.

Endpoints

Endpoints
Retrieve a profile - `GET /profiles/:id`
List profiles - `GET /profiles`

Sample object

{
   "id":"47b216e2-d334-4235-bc1e-185d15ab18d0",
   "account":"010db8b4-a724-47fc-a17e-733b656312a2",
   "employer":"walmart",
   "created_at":"2019-11-29T09:00:16.384575Z",
   "updated_at":"2019-11-29T09:00:16.384624Z",
   "first_name":"John",
   "last_name":"Smith",
   "full_name":"John Smith",
   "email":"[email protected]",
   "phone_number":"+11234567890",
   "birth_date":"1990-04-28",
   "picture_url":"https://profile.picture.com/picture.jpeg",
   "address":{
      "line1":"4 Jackson St",
      "line2":"Apt C",
      "city":"Norton",
      "state":"MA",
      "postal_code":"27660",
      "country":"US"
   },
   "ssn":"***-**-**15",
   "marital_status":"married",
   "gender":"male",
   "metadata":{}
}