Get Complete Client Profile

Retrieve comprehensive client profile including Basic & Tax Information, Identification & Address details, and Family Information (spouse and dependents).

get/internal/api/clients/{client_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_idstring uuid required

Response

Successful Response

idstring uuid required

readable_idstring required

external_idstring nullable required

tenant_idstring uuid required

full_namestring required

blindboolean required

disabledboolean required

emailstring nullable required

phonestring nullable required

date_of_birthstring date nullable required

status'DRAFT' | 'ACTIVE' | 'INACTIVE' required

created_atstring date-time required

updated_atstring date-time required

Example response

{
  "filing_type": {
    "label": "Individual (Form 1040)",
    "value": "INDIVIDUAL_1040"
  },
  "filing_status": {
    "label": "Single",
    "value": "SINGLE"
  },
  "ssn_info": {
    "entity_type": "CLIENT",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "ssn_masked": "XXX-XX-1234",
    "ssn_type": "SSN"
  },
  "spouse": {
    "address": {
      "address_line_2": "Apt 4B",
      "city": "New York",
      "id": "660f9511-f39c-52e5-b827-557766551111",
      "state": "NY",
      "street_address": "123 Main Street",
      "zip_code": "10001"
    },
    "blind": false,
    "client_id": "550e8400-e29b-41d4-a716-446655440000",
    "date_of_birth": "1992-03-20",
    "disabled": false,
    "email": "jane.doe@example.com",
    "full_name": "Jane Doe",
    "id": "770f9511-f39c-52e5-b827-557766551111",
    "phone": "+1-555-987-6543",
    "same_as_taxpayer_address": false,
    "ssn_info": {
      "entity_type": "SPOUSE",
      "id": "880f9622-f49d-63f6-c938-668877662222",
      "ssn_masked": "XXX-XX-4321",
      "ssn_type": "SSN"
    },
    "tenant_id": "440d7300-d18b-31c3-9605-335544330000"
  },
  "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"
    }
  ]
}

Changes

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