PATCH
/
persons
/
{person_id}
Update person
curl --request PATCH \
  --url https://api-sandbox.synctera.com/v0/persons/{person_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "note": "<string>",
  "ban_status": "ALLOWED",
  "chosen_name": "Annie",
  "dob": "2000-01-01",
  "email": "alice@example.com",
  "first_name": "Jane",
  "is_customer": true,
  "last_name": "Smith",
  "legal_address": {
    "address_line_1": "100 Main St.",
    "address_line_2": "Suite 99",
    "city": "New York",
    "country_code": "US",
    "nickname": "Home",
    "postal_code": "28620",
    "state": "NY"
  },
  "metadata": {},
  "middle_name": "Anne",
  "phone_number": "+14374570680",
  "shipping_address": {
    "address_line_1": "100 Main St.",
    "address_line_2": "Suite 99",
    "city": "New York",
    "country_code": "US",
    "nickname": "Home",
    "postal_code": "28620",
    "state": "NY"
  },
  "ssn": "123-45-6789",
  "status": "ACTIVE",
  "tenant": "abcdef_ghijkl"
}'
{
  "ban_status": "ALLOWED",
  "chosen_name": "Annie",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "dob": "2000-01-01",
  "email": "alice@example.com",
  "first_name": "Jane",
  "has_accounts": true,
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "is_customer": true,
  "last_name": "Smith",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "legal_address": {
    "address_line_1": "100 Main St.",
    "address_line_2": "Suite 99",
    "address_type": "SHIPPING",
    "city": "New York",
    "country_code": "US",
    "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "nickname": "Home",
    "postal_code": "28620",
    "state": "NY"
  },
  "metadata": {},
  "middle_name": "Anne",
  "phone_number": "+14374570680",
  "shipping_address": {
    "address_line_1": "100 Main St.",
    "address_line_2": "Suite 99",
    "address_type": "SHIPPING",
    "city": "New York",
    "country_code": "US",
    "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "nickname": "Home",
    "postal_code": "28620",
    "state": "NY"
  },
  "ssn": "123-45-6789",
  "ssn_source": "MANUAL",
  "status": "ACTIVE",
  "tenant": "abcdef_ghijkl",
  "verification_last_run": "2010-05-06T12:23:34.321Z",
  "verification_status": "ACCEPTED",
  "personal_ids": [
    {
      "country_code": "<string>",
      "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

​
person_id
string<uuid>
required

Person's unique identifier.

Example:

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

Body

application/json

Properties of a person that can be updated

Response

200
application/json

Updated person representation.

Details of a person