Skip to content

Personal Profile

Resource representing a user's personal and contact information.

The Personal Profile resource contains sensitive personal information about a user, including their identification details, contact information, and occupation.

Endpoints

MethodUrl
GET/v1.0/users/:user_id/personal-profile
PUT/v1.0/users/:user_id/personal-profile
POST/v1.0/jobs/:job_id/checklist/:supporting_item_id/provide-personal-info
GET/v1.0/jobs/:job_id/personal-profile

Properties

id
string

Unique identifier of the profile.

version
number

Version number of the profile. Any update increments this number.

owner_user_id
string

ID of the user that owns the profile.

create_time
string

Timestamp when the profile was created.

update_time
string

Timestamp when the profile was last updated.

occupation
string

The individual's occupation.

personal_info
PersonalInfo

Object containing the individual's personal information. See the personal info object.

contact_info
ContactInfo

Object containing the user's contact details. See the contact info object.

Copied
1{
2 "id": "3b31f309-93ad-463a-ad1d-c39cac1c0a3d",
3 "version": 1,
4 "owner_user_id": "550e8400-e29b-41d4-a716-446655440000",
5 "create_time": "2024-01-01T00:00:00Z",
6 "update_time": "2024-01-01T00:00:00Z",
7 "occupation": "Software Developer",
8 "personal_info": {
9 "first_name": "John",
10 "middle_initial": "A",
11 "last_name": "Doe",
12 "date_of_birth": "01/01/1990",
13 "personal_taxpayer_identification_number": "XXX-XX-6789"
14 },
15 "contact_info": {
16 "email": "john.doe@example.com",
17 "phone_number": "+1-555-555-5555",
18 "address": {
19 "address_line_1": "123 Main St",
20 "address_line_2": "Apt 4B",
21 "city": "Miami",
22 "region": "FL",
23 "postal_code": "33134",
24 "country": "United States"
25 }
26 }
27}

Personal Info

first_name
string
required

The individual's first name.

middle_initial
string

The individual's middle initial.

last_name
string
required

The individual's last name.

date_of_birth
string

The individual's date of birth (MM/DD/YYYY).

personal_taxpayer_identification_number
string

The individual's SSN or ITIN. This value may be redacted when retrieving a profile.

Contact Info

email
string

The email address.

phone_number
string

The phone number. This will be formatted to include country code if not already included.

address
PhysicalAddress

The physical contact address. See the physical address object.

Physical Address

address_line_1
string

First line of the address.

address_line_2
string

Second line of the address.

city
string

The city.

region
string

The region (state/province/territory).

postal_code
string

The postal code.

country
string

The country.

Last updated on December 9, 2024