---
title: "Update a personal identifier"
method: PATCH
path: "/persons/personal_ids/{personal_id_id}"
tags: ["Persons"]
---

# Update a personal identifier

`PATCH /persons/personal_ids/{personal_id_id}`

Update a personal identifier, e.g. SSN, for this customer

## Path parameters

- `personal_id_id` string, uuid, required

## Headers

- `Idempotency-Key` string

## Request body

- PatchPersonalId
  - `country_code` string — The updated ISO 3166 Alpha-2 country code for the country that issued the personal identifier. The country code cannot be modified for personal identifier types that have an implicit country, e.g. SSN.
  - `expiry_date` string, date — The date the associated document is set to expire on set by the governing authority.
  - `id_type` 'CITIZENSHIP_CARD' | 'DRIVER_LICENSE' | 'ITIN' | 'NATIONAL_ID' | 'PASSPORT_NUMBER' | 'PROVINCIAL_ID' | 'PR_CARD' | 'SECURE_STATUS_CARD' | 'SIN' | 'SSN' | 'STATE_ID' | 'TAX_ID', required — The type of the personal identifier. This cannot be changed once the personal identifier is created. One of the following: * `ITIN` - US Individual Tax Identification Number. Format is 987-65-4321. Country code will default to US. * `PASSPORT_NUMBER` - Passport Number. Format varies by country. Country code is required. * `SIN` - Canadian Social Insurance Number. Format is 123-456-789. Country code will default to CA. * `SSN` - US Social Security Number. Format is 123-45-6789. Country code will default to US. * `DRIVER_LICENSE` - Driver License Number. Format varies by country and state. * `STATE_ID` - US State ID Number. Format varies by state. * `NATIONAL_ID` - National ID Number. Format varies by country. * `TAX_ID` - Tax ID Number. Format varies by country. * `CITIZENSHIP_CARD` - Canadian Citizenship Card Number. Format is A1234567. * `PR_CARD` - Permanent Resident Card Number. Format varies by country. * `PROVINCIAL_ID` - Canadian Provincial ID Number. Format varies by province. * `SECURE_STATUS_CARD` - Canadian Secure Status Card Number. Format is 1998-12-123456.
  - `identifier` string — The updated personal identifier
  - `issue_date` string, date — The date the associated document was issued by the governing authority.
  - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

## Response `201`

Created personal identifier.

- ResponsePersonalIdWCust
  - `customer_id` string, uuid, required — Id of the customer having this personal identifier
  - `country_code` string, US, required — The ISO 3166 Alpha-2 country code for the country that issued the personal identifier.
  - `tenant` string, required — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
  - `id` string, uuid, required — UUID for the personal identifier for subsequent changes and deletion
  - `id_type` 'CITIZENSHIP_CARD' | 'DRIVER_LICENSE' | 'ITIN' | 'NATIONAL_ID' | 'PASSPORT_NUMBER' | 'PROVINCIAL_ID' | 'PR_CARD' | 'SECURE_STATUS_CARD' | 'SIN' | 'SSN' | 'STATE_ID' | 'TAX_ID', required — The type of the personal identifier. This cannot be changed once the personal identifier is created. One of the following: * `ITIN` - US Individual Tax Identification Number. Format is 987-65-4321. Country code will default to US. * `PASSPORT_NUMBER` - Passport Number. Format varies by country. Country code is required. * `SIN` - Canadian Social Insurance Number. Format is 123-456-789. Country code will default to CA. * `SSN` - US Social Security Number. Format is 123-45-6789. Country code will default to US. * `DRIVER_LICENSE` - Driver License Number. Format varies by country and state. * `STATE_ID` - US State ID Number. Format varies by state. * `NATIONAL_ID` - National ID Number. Format varies by country. * `TAX_ID` - Tax ID Number. Format varies by country. * `CITIZENSHIP_CARD` - Canadian Citizenship Card Number. Format is A1234567. * `PR_CARD` - Permanent Resident Card Number. Format varies by country. * `PROVINCIAL_ID` - Canadian Provincial ID Number. Format varies by province. * `SECURE_STATUS_CARD` - Canadian Secure Status Card Number. Format is 1998-12-123456.
  - `identifier` string, required — The personal identifier. Format varies by personal identifier type.
  - `system_provided` boolean, required — True if the identifier was provided by the system, e.g. via SSN Prefill.
  - `expiry_date` string, date — The date the associated document is set to expire on set by the governing authority.
  - `issue_date` string, date — The date the associated document was issued by the governing authority.

## Other responses

- `400` — BadRequest
- `401` — Unauthorized
- `403` — Forbidden error
- `500` — Internal server error

---

[API](https://skmtc.net/synctera/apis/synctera-api.md) · [All operations](https://skmtc.net/synctera/apis/synctera-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/synctera/synctera-api/revisions/b0d812e6cdd0/schema)