PATCH
/
persons
/
personal_ids
/
{personal_id_id}
Update a personal identifier
curl --request PATCH \
  --url https://api-sandbox.synctera.com/v0/persons/personal_ids/{personal_id_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "country_code": "US",
  "id_type": "SSN",
  "identifier": "123-45-6789",
  "tenant": "abcdef_ghijkl"
}'
{
  "customer_id": "21943c51-e4ff-4e57-9558-08cab6b963fe",
  "country_code": "<string>",
  "tenant": "abcdef_ghijkl",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "id_type": "SSN",
  "identifier": "123-45-6789",
  "system_provided": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Path Parameters

​
personal_id_id
string<uuid>
required

UUID for a personal identifier.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json
​
id_type
enum<string>
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.
Available options:
CITIZENSHIP_CARD,
DRIVER_LICENSE,
ITIN,
NATIONAL_ID,
PASSPORT_NUMBER,
PROVINCIAL_ID,
PR_CARD,
SECURE_STATUS_CARD,
SIN,
SSN,
STATE_ID,
TAX_ID
Example:

"SSN"

​
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.

Example:

"US"

​
identifier
string

The updated personal identifier

Example:

"123-45-6789"

​
tenant
string

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

Response

Created personal identifier.

​
customer_id
string<uuid>
required

Id of the customer having this personal identifier

Example:

"21943c51-e4ff-4e57-9558-08cab6b963fe"

​
id
string<uuid>
required

UUID for the personal identifier for subsequent changes and deletion

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
id_type
enum<string>
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.
Available options:
CITIZENSHIP_CARD,
DRIVER_LICENSE,
ITIN,
NATIONAL_ID,
PASSPORT_NUMBER,
PROVINCIAL_ID,
PR_CARD,
SECURE_STATUS_CARD,
SIN,
SSN,
STATE_ID,
TAX_ID
Example:

"SSN"

​
identifier
string
required

The personal identifier. Format varies by personal identifier type.

Example:

"123-45-6789"

​
system_provided
boolean
required

True if the identifier was provided by the system, e.g. via SSN Prefill.

​
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.

Example:

"abcdef_ghijkl"