Skip to main content
PATCH
Update a user

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Path Parameters

id
string<uuid>
required

ID of the user object to be updated.

Body

application/json
first_name
string

User first name.

last_name
string

User last name.

email
string

User email address.

phone_number
string

User phone number.

ssn
string

User Social Security number.

address
object

Address of the user.

birth_date
object

Date of birth in year-month-day format.

external_metadata
object

Additional metadata for internal partner workflows.

open_banking
object

Banking-specific user metadata.

external_id
string | null

External identifier for your internal mapping.

Response

200 - application/json

Partner user object.

id
string<uuid>

Unique ID of the user.

created_at
string<date-time>

Timestamp (ISO 8601) when the user was created.

items_connected
string[]

Items the user has connected through Link.

employers_connected
string[]

Employers associated with the connected items.

first_name
string

User first name.

last_name
string

User last name.

email
string

User email address.

phone_number
string

User phone number.

ssn
string

User Social Security number.

address
object

Address of the user.

birth_date
object

Date of birth in year-month-day format.

external_metadata
object

Additional metadata for internal partner workflows.

external_id
string | null

External identifier for your internal mapping.