Skip to main content
PUT
Create or update a user

Authorizations

Authorization
string
header
required

Cognito-issued JWT access token. Send it as Authorization: Bearer <token>.

Path Parameters

userId
string
required

The user's unique ID.

Body

application/json

Creates or updates a user. signatureKey / notarySealKey are the keys returned by POST /v1/users/{userId}/images for images that have already been uploaded; when present, the stored image references are updated.

name
string
required
title
string
required
phoneNumber
string
country
string
jurisdiction
string
county
string
commissionNumber
string
notaryExpirationDate
string<date-time>
notaryExpires
boolean
signatureKey
string

Key of a signature image previously uploaded via POST /v1/users/{userId}/images. Takes precedence over signatureFilename.

notarySealKey
string

Key of a notary seal image previously uploaded via POST /v1/users/{userId}/images. Takes precedence over notarySealFilename.

signatureFilename
string
deprecated

Deprecated — use signatureKey. Original filename of a signature image to upload; its presence requests an upload URL in uploadImageUrls.

notarySealFilename
string
deprecated

Deprecated — use notarySealKey. Original filename of a notary seal image to upload; its presence requests an upload URL in uploadImageUrls.

Response

The updated profile, including any presigned upload URLs.

A user. List responses populate the lean fields by default and add notary fields and image URLs when requested via the fields mask; the detail views (GET/PUT /v1/users/{userId}) always populate notary fields and image URLs.

id
string<uuid>
required

The user's unique ID.

name
string

The user's display name.

email
string

The user's email address.

title
string

The user's job title.

phoneNumber
string

The user's phone number.

country
string
jurisdiction
string
county
string
commissionNumber
string
notaryExpirationDate
string<date-time>
notaryExpires
boolean
deactivatedAt
string<date-time>

When the user was deactivated. Absent or null means the user is active.

getImageUrls
object[]

Download URLs for the user's signature and notary seal images (detail views only).

isNotary
boolean

Whether the user is a notary.

uploadImageUrls
object[]
deprecated

Upload (PUT) URLs returned when an image upload was requested (detail views only). Deprecated — request upload URLs via POST /v1/users/{userId}/images and upload before saving the profile.