Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.argyle.com/llms.txt

Use this file to discover all available pages before exploring further.

​
The identity object

​
id
string<uuid>

Unique ID of the identity.

Example:

"0153b145-7ab9-bea2-cc16-a8b71328942f"

​
account
string<uuid>

ID of the account associated with the identity.

Example:

"0187c66e-e7e5-811c-b006-2232f00f426a"

​
address
object
​
first_name
string

First name of the employee. Usually the legal first name.

Example:

"Sarah"

​
last_name
string

Last name of the employee. Usually the legal last name.

Example:

"Longfield"

​
full_name
string

Full name of the employee. Sourced from payroll data if available, otherwise constructed from available names and suffixes.

Example:

"Sarah Longfield"

​
birth_date
string<date>

Date of birth in ISO 8601 format. If values are obfuscated (rare), a dash will replace the value (e.g. --01-31 when the year is obfuscated).

Example:

"1980-10-30"

​
email
string

Email address.

Example:

"[email protected]"

​
phone_number
string

Phone number E.164 international format).

Example:

"+12125555555"

​
picture_url
string

URL location of the user's profile image.

Example:

"www.argyle.com/logofoldername"

​
employment_status
enum<string>

Job status of the employment relevant to the identity.

  • Definitions of inactive and terminated vary by Item and can overlap.
    • inactive typically indicates the employee left voluntarily, is on leave, or has not been active for a certain period of time.
    • terminated typically indicates the employee is no longer employed. Specific reasons for termination, if available, are returned in the termination_reason field.
  • We recommend using data from the /paystubs and /gigs endpoints to construct a more wholistic timeline of employment history.
Available options:
active,
inactive,
terminated
Example:

"active"

​
employment_type
enum<string>

Type of employment.

Employment type enum definitions
  • full-time
    • Employment in which an individual is regularly scheduled to work 30 or more hours per week, or meets the employer's internal threshold for a standard full-time workweek.
    • Examples: full-time employee, 36+ hours weekly
  • part-time
    • Employment in which an individual is regularly scheduled to work fewer than 30 hours per week, or meets the employer's internal threshold for a standard part-time workweek.
    • Examples: PT regular, 20+ hours weekly
  • contractor
    • Work performed by an individual engaged for a specific project or timeframe who is not an employee of the organization.
    • Examples: gig worker, contract employee, contract worker, freelancer
  • military
    • Compensation derived from active-duty or reserve military service.
    • Automatically set for military platforms.
  • benefits
    • Non-wage compensation or government-issued assistance.
    • Automatically set for benefits platforms.
  • seasonal
    • Employment that occurs at approximately the same time each year, typically lasting six months or less.
    • Examples: seasonal on-call, seasonal part-time, peak seasonal
  • temporary
    • Short-term employment with a defined end date, usually lasting one year or less.
    • Examples: internship, substitute employee, temporary full-time, temporary part-time
  • regular
    • Ongoing employment with no specified end date that does not fall into more specialized categories.
    • Examples: permanent, W-2, salaried
  • other
    • Work or income that does not fit standard classifications.
    • Examples: variable, casual, employee, PRN (on-call)
Available options:
full-time,
part-time,
contractor,
military,
benefits,
seasonal,
temporary,
regular,
other
Example:

"full-time"

​
job_title
string

Job title.

Example:

"Store Manager"

​
ssn
string

Social Security number.

Example:

"522-09-1191"

​
marital_status
string

Marital status.

Example:

"Married filing jointly"

​
gender
string

Gender.

Example:

"Female"

​
original_hire_date
string<date>

Timestamp (ISO 8601) of the user's earliest employment start date.

Example:

"2019-01-03"

​
hire_date
string<date>

Timestamp (ISO 8601) of the user's most recent employment start date.

hire_date may differ from original_hire_date due to a promotion, a re-hiring event, or similar.

Example:

"2020-04-08"

​
termination_date
string<date> | null

Timestamp (ISO 8601) when the user was terminated.

​
termination_reason
string | null

Reason for termination.

​
employer
string

Name of the employer.

Example:

"Whole Goods"

​
employment
string

Employment ID. Can be used as a filter when listing identities.

Example:

"0183d52a-d3b2-331d-c753-3662a20e352b"

​
base_pay
object
​
pay_cycle
enum<string>

Payment frequency.

  • daily
  • weekly
  • biweekly - every two weeks
  • semimonthly - twice a month
  • monthly
  • quarterly
Available options:
daily,
weekly,
biweekly,
semimonthly,
monthly,
quarterly
Example:

"semimonthly"

​
platform_ids
object
​
created_at
string<date-time>

Timestamp (ISO 8601) when the identity object was created.

Example:

"2023-01-30T12:53:24.561594Z"

​
updated_at
string<date-time>

Timestamp (ISO 8601) when a property value of the identity object most recently changed.

Example:

"2023-01-30T12:55:06.478699Z"

​
metadata
object

Additional, non-categorized information.

Example:
{}