SIsignalshq
CLIENT

List Client Dependents

Retrieve all dependents for a specific client.

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

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

Response

Successful Response

total_countinteger required

Total number of dependents for this client

Example response

{
  "dependents": [
    {
      "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"
    }
  ],
  "total_count": 1
}

Changes

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