SIsignalshq
CLIENT

Get Specific Dependent

Retrieve a specific dependent by ID.

get/internal/api/clients/{client_identifier}/dependents/{dependent_id}

Request

  • Base URL
    https://api.signalshq.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /auth/login

Path parameters

client_identifierstring required
dependent_idstring uuid required

Response

Successful Response

idstring uuid required

Unique identifier for the dependent record

client_idstring uuid required

ID of the client this dependent belongs to

tenant_idstring uuid required

Tenant organization ID

full_namestring required

Full legal name of the dependent

date_of_birthstring date nullable

Date of birth

blindboolean required

Blind status

disabledboolean required

Disabled status

relationship_type'SON' | 'DAUGHTER' | 'FOSTER_CHILD' | 'GRANDCHILD' | 'STEPCHILD' | 'GRANDPARENT' | 'PARENT' | 'BROTHER' | 'HALF_BROTHER' | 'STEP_BROTHER' | 'SISTER' | 'HALF_SISTER' | 'STEP_SISTER' | 'AUNT' | 'UNCLE' | 'NIECE' | 'NEPHEW' | 'NONE' | 'OTHER' required

Enumeration of possible relationships for dependents.

Used to classify the relationship between the client and their dependent for tax filing purposes.

relationship_otherstring nullable

Custom relationship description

months_in_homeinteger nullable

Number of months in home during tax year

full_time_studentboolean required

Full-time student status

Example response

{
  "blind": false,
  "client_id": "550e8400-e29b-41d4-a716-446655440000",
  "date_of_birth": "2010-05-15",
  "disabled": false,
  "full_name": "John Doe Jr.",
  "full_time_student": false,
  "id": "990f9622-f49d-63f6-c938-668877662222",
  "months_in_home": 12,
  "relationship_type": "SON",
  "ssn_info": {
    "entity_type": "DEPENDENT",
    "id": "aa0f9622-f49d-63f6-c938-668877662444",
    "ssn_masked": "XXX-XX-3333",
    "ssn_type": "SSN"
  },
  "tenant_id": "440d7300-d18b-31c3-9605-335544330000"
}

Changes

No recorded changes to this operation across all 1 revision of this API.