Identities
Profile and employment information.
#The identity object
- idstring (uuid)
Unique ID of the identity.
- accountstring (uuid)
ID of the account associated with the identity.
- addressobject
Object containing the employee's personal home or contact address.
- citystring
Name of the city, town, district, or similar regional entity.
- line1string
Address-Line 1, usually street address or P.O. Box information.
- line2string
Address-Line 2, usually the apartment or unit number.
- statestring
State, county, province, region, or equivalent.
- countrystring
Two-letter country code (ISO 3166-1 alpha-2 format).
- postal_codestring
Zip code, or equivalent.
- first_namestring
First name of the employee. Usually the legal first name.
- last_namestring
Last name of the employee. Usually the legal last name.
- full_namestring
Full name of the employee. Sourced from payroll data if available, otherwise constructed from available names and suffixes.
- birth_datestring (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).
- emailstring
Email address.
- phone_numberstring
Phone number (E.164 international format).
- picture_urlstring
URL location of the user's profile image.
- employment_statusstring (enum)
The employment status relevant to the identity.
- employment_typestring (enum)
Type of employment.
- job_titlestring
Job title.
- ssnstring
Social Security number.
- marital_statusstring
Marital status.
- genderstring
Gender.
- hire_datestring (date)
Timestamp (ISO 8601) of the user's most recent employment start date.
- termination_datestring (date)
Timestamp (ISO 8601) when the user was terminated.
- termination_reasonstring
Reason for termination.
- employerstring
Name of the employer.
- base_payobject
Object containing basic income information for the user.
- amountstring
Defined pay amount per period. Does not include bonus, commission or similar incentive-based income.
- periodstring (enum)
Payment interval that specifically corresponds to the base pay
amount
. - currencystring
Pay currency (ISO 4217 currency code).
- pay_cyclestring (enum)
Payment frequency.
- platform_idsobject
Object containing internal user ID's specific to the employer or payroll system. Distinct from Argyle ID's.
- employee_idstring
Internal user ID assigned by the employer.
- position_idstring
Internal position ID assigned by the employer.
- platform_user_idstring
ID assigned by the payroll system.
- created_atstring (datetime)
Timestamp (ISO 8601) when the identity object was created.
- updated_atstring (datetime)
Timestamp (ISO 8601) when a property value of the identity object most recently changed.
- metadataobject
Additional, non-categorized information.
1{
2 "id": "0153b145-7ab9-bea2-cc16-a8b71328942f",
3 "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
4 "address": {
5 "city": "New York",
6 "line1": "852 North W St",
7 "line2": "Apt 221",
8 "state": "NY",
9 "country": "US",
10 "postal_code": "10014"
11 },
12 "first_name": "Sarah",
13 "last_name": "Longfield",
14 "full_name": "Sarah Longfield",
15 "birth_date": "1980-10-30",
16 "email": "[email protected]",
17 "phone_number": "+12125555555",
18 "picture_url": "www.argyle.com/logofoldername",
19 "employment_status": "active",
20 "employment_type": "full-time",
21 "job_title": "Store Manager",
22 "ssn": "522-09-1191",
23 "marital_status": "Married filing jointly",
24 "gender": "Female",
25 "hire_date": "2020-04-08",
26 "termination_date": null,
27 "termination_reason": null,
28 "employer": "Whole Goods",
29 "base_pay": {
30 "amount": "58024.50",
31 "period": "annual",
32 "currency": "USD"
33 },
34 "pay_cycle": "semimonthly",
35 "platform_ids": {
36 "employee_id": "OB238HDW5",
37 "position_id": "6ELL4O7PM",
38 "platform_user_id": "JLH7B9V6O6YGN9O7"
39 },
40 "created_at": "2023-01-30T12:53:24.561594Z",
41 "updated_at": "2023-01-30T12:55:06.478699Z",
42 "metadata": {}
43}
#Retrieve an identity
Retrieves an identity object.
- idstring (uuid)required
ID of the identity object to be retrieved.
1curl --request GET \
2 --url https://api.argyle.com/v2/identities/{id} \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'
1{
2 "id": "0153b145-7ab9-bea2-cc16-a8b71328942f",
3 "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
4 "address": {
5 "city": "New York",
6 "line1": "852 North W St",
7 "line2": "Apt 221",
8 "state": "NY",
9 "country": "US",
10 "postal_code": "10014"
11 },
12 "first_name": "Sarah",
13 "last_name": "Longfield",
14 "full_name": "Sarah Longfield",
15 "birth_date": "1980-10-30",
16 "email": "[email protected]",
17 "phone_number": "+12125555555",
18 "picture_url": "www.argyle.com/logofoldername",
19 "employment_status": "active",
20 "employment_type": "full-time",
21 "job_title": "Store Manager",
22 "ssn": "522-09-1191",
23 "marital_status": "Married filing jointly",
24 "gender": "Female",
25 "hire_date": "2020-04-08",
26 "termination_date": null,
27 "termination_reason": null,
28 "employer": "Whole Goods",
29 "base_pay": {
30 "amount": "58024.50",
31 "period": "annual",
32 "currency": "USD"
33 },
34 "pay_cycle": "semimonthly",
35 "platform_ids": {
36 "employee_id": "OB238HDW5",
37 "position_id": "6ELL4O7PM",
38 "platform_user_id": "JLH7B9V6O6YGN9O7"
39 },
40 "created_at": "2023-01-30T12:53:24.561594Z",
41 "updated_at": "2023-01-30T12:55:06.478699Z",
42 "metadata": {}
43}
#List all identities
Returns an array of all identity objects.
- accountstring (uuid)optional
Filter by account ID.
- userstring (uuid)optional
Filter by user ID.
- limitintegeroptional
Number of identity objects returned per page. Default: 10. Maximum: 200.
1curl --request GET \
2 --url https://api.argyle.com/v2/identities?limit=2 \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'
1[
2 {
3 "id": "0186da0b-6569-0ea0-eb50-b64e97cb29e9",
4 "account": "0186da0b-9923-0d27-4b05-6ce3b7b07b89",
5 "address": {
6 "city": "San Diego",
7 "line1": "54 N Shea Ridge",
8 "line2": null,
9 "state": "CA",
10 "country": "US",
11 "postal_code": "92092"
12 },
13 "first_name": "Joe",
14 "last_name": "Burnam",
15 "full_name": "Joe Burnam",
16 "birth_date": "1978-08-29",
17 "email": "[email protected]",
18 "phone_number": "+12123338708",
19 "picture_url": "www.argyle.com/logofoldername",
20 "employment_status": "active",
21 "employment_type": "part-time",
22 "job_title": "Hourly staff",
23 "ssn": "301-06-1225",
24 "marital_status": "Married filing jointly",
25 "gender": "Male",
26 "hire_date": "2022-05-18",
27 "termination_date": null,
28 "termination_reason": null,
29 "employer": "Double Double",
30 "base_pay": {
31 "amount": "18.08",
32 "period": "hourly",
33 "currency": "USD"
34 },
35 "pay_cycle": "monthly",
36 "platform_ids": {
37 "employee_id": "32ULINA8",
38 "position_id": "67LKUKA8",
39 "platform_user_id": "332512349952"
40 },
41 "created_at": "2023-01-31T12:13:24.561594Z",
42 "updated_at": "2023-01-31T12:45:06.478699Z",
43 "metadata": {}
44 },
45 {
46 "id": "0353c142-4ab9-baa1-cb44-c8b51225877e",
47 "account": "0185a8b8-60eb-80ca-7482-5f24504573f7",
48 "address": {
49 "city": "Oklahoma City",
50 "line1": "312 Main Ave",
51 "line2": null,
52 "state": "OK",
53 "country": "US",
54 "postal_code": "73008"
55 },
56 "first_name": "Bob",
57 "last_name": "Jones",
58 "full_name": "Bob Jones",
59 "birth_date": "1983-07-02",
60 "email": "[email protected]",
61 "phone_number": "+13228675309",
62 "picture_url": "www.argyle.com/logofoldername",
63 "employment_status": "active",
64 "employment_type": "contractor",
65 "job_title": "Data analyst",
66 "ssn": "507-18-3058",
67 "marital_status": "Single",
68 "gender": "Female",
69 "hire_date": "2021-04-08",
70 "termination_date": null,
71 "termination_reason": null,
72 "employer": "Half Bads",
73 "base_pay": {
74 "amount": "39.72",
75 "period": "hourly",
76 "currency": "USD"
77 },
78 "pay_cycle": "biweekly",
79 "platform_ids": {
80 "employee_id": "bd823Lk",
81 "position_id": "ab3EkU2",
82 "platform_user_id": "832355"
83 },
84 "created_at": "2023-01-30T13:53:24.561594Z",
85 "updated_at": "2023-01-30T13:55:06.478699Z",
86 "metadata": {}
87 }
88]