Dependent Profile
Resource representing a user's dependent's personal information.
The Dependent Profile resource contains sensitive personal information about a user's dependent, including their identification details and relationship to the user.
Endpoints
| Method | Url |
|---|---|
GET | /v1.0/dependent-profiles/:dependent_id |
GET | /v1.0/jobs/:job_id/checklist/:supporting_item_id/dependent-profiles/:dependent_id |
POST | /v1.0/dependent-profiles |
POST | /v1.0/dependent-profiles/:dependent_id |
POST | /v1.0/jobs/:job_id/checklist/:supporting_item_id/provide-dependent-info |
POST | /v1.0/jobs/:job_id/checklist/:supporting_item_id/remove-dependent-info |
Properties
Unique identifier of the profile.
Version number of the profile. Any update increments this number.
ID of the user that owns the profile.
Timestamp when the profile was created.
Timestamp when the profile was last updated.
The dependent's relationship to the user (e.g., "Child", "Parent", etc.).
Object containing the dependent's personal information. See the personal info object.
Copied1{2 "id": "e7b513b9-d795-4475-9382-96710ca61622",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 "relationship": "Child",8 "personal_info": {9 "first_name": "Alice",10 "middle_initial": "R",11 "last_name": "Doe",12 "date_of_birth": "01/01/2010",13 "personal_taxpayer_identification_number": "XXX-XX-6789"14 }15}
Personal Info
The dependent's first name.
The dependent's middle initial.
The dependent's last name.
The dependent's date of birth (MM/DD/YYYY).
The dependent's SSN or ITIN. This value may be redacted when retrieving a profile.