SIsignalshq
CLIENT

Create or Update Spouse

Create a new spouse or update existing spouse for a client. For updates, only provided fields will be updated (partial update behavior).

put/internal/api/clients/{client_identifier}/spouse

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

Request body

full_namestring nullable

Updated full name

emailstring email nullable

Updated email address

phonestring nullable

Updated phone number

date_of_birthstring date nullable

Updated date of birth

blindboolean nullable

Updated blind status

disabledboolean nullable

Updated disabled status

same_as_taxpayer_addressboolean nullable

Updated same as taxpayer address status

ssnstring nullable

Social Security Number (optional - will be encrypted and stored securely if provided)

Example request

{
  "address": {
    "address_line_2": "Suite 200",
    "city": "Los Angeles",
    "state": "CA",
    "street_address": "456 Oak Avenue",
    "zip_code": "90210"
  },
  "blind": false,
  "disabled": false,
  "email": "jane.smith@example.com",
  "full_name": "Jane Smith",
  "phone": "+1-555-987-6543",
  "same_as_taxpayer_address": false
}

Response

Successful Response

idstring uuid required

Unique identifier for the spouse record

client_idstring uuid required

ID of the client this spouse belongs to

tenant_idstring uuid required

Tenant organization ID

full_namestring required

Full legal name of the spouse

emailstring email nullable

Email address

phonestring nullable

Phone number

date_of_birthstring date nullable

Date of birth

blindboolean required

Is the spouse blind?

disabledboolean required

Is the spouse disabled?

same_as_taxpayer_addressboolean required

Whether the spouse uses the same address as the taxpayer (client)

relationship_typestring

Relationship type (always SPOUSE for spouse records)

Example response

{
  "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"
}

Changes

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