Profiles

Learn about the /profiles endpoint.

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 payroll account that the user has connected via Argyle Link.

The profile object

AttributeTypeDescription
idstring uuidUnique ID of the profile associated with a user's payroll account.
accountstring uuidID of the payroll account associated with the profile.
employerstringThe name of the company or entity that employs the user.
first_namestringThe legal first name of the user.
last_namestringThe legal last name of the user.
full_namestringThe full legal name of the user.
emailstringEmail address.
phone_numberstringPhone number. Value is returned in the E.164 international phone number format.
birth_datestringDate of birth. Timestamps follow the ISO 8601 standard.

In some rare cases, the payroll provider will obfuscate the birth year and the returned value will be formatted with having a dash instead of the year number: --01-20.
picture_urlstringProfile 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.line1stringAddress line 1—for example, street, PO Box, or company name.
address.line2stringAddress line 2—for example, apartment, suite, unit, or building.
address.citystringCity, district, suburb, town, or village.
address.statestringState, county, province, or region.
address.postal_codestringZIP or postal code.
address.countrystringTwo-letter country code returned in the ISO 3166-1 alpha-2 format.
ssnstringSocial Security Number.
marital_statusstringMarital status of the user.
genderstringGender of the user.
metadatastringMetadata holds additional available, often unstructured, information about this data resource.
created_atstring
timestamp
Time at which the profile object was created. Timestamps follow the ISO 8601 standard.
updated_atstring
timestamp
Time at which the profile object was last updated. Timestamps follow the ISO 8601 standard.
employment_status
*deprecated
stringStatus of employment.

Deprecated in favor of /employments.status
employment_type
*deprecated
stringType of employment (e.g. contractor, part-time, full-time).

Deprecated in favor of /employments.type
job_title
*deprecated
stringThe current job title of the user.

Deprecated in favor of /employments.job_title
platform_user_id
*deprecated
stringA unique ID assigned to a user by a payroll provider.

Deprecated in favor of /employments.platform_ids.platform_user_id
hire_dates
*deprecated
array of stringsThe dates when the user was hired by the employer.

Deprecated in favor of /employments.hire_datetime
terminations
*deprecated
array of objectsObjects contain date and reason for termination.

Deprecated in favor of /employments.termination_datetime and /employments.termination_reason

Endpoints

These are the endpoints available for profiles.

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": {}
}