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

Response

201
application/json

Created personal identifier.

The response is of type object.