PUT
/
onboarding
/
api
/
v1
/
users
/
{user_id}
Update User
curl --request PUT \
  --url https://api.carbnconnect.com/onboarding/api/v1/users/{user_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "first_name": "John",
  "last_name": "Doe",
  "email_address": "user@example.com",
  "phone_number": "+1XXXXXXXXXX",
  "user_type": "individual",
  "date_of_birth": "YYYY-MM-DD",
  "consent_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "metadata": "{}",
  "sharing_consent": true,
  "identity": {
    "identity_country_code": "DEU",
    "identity_number": "XXXXXXXXXXXX",
    "identity_document_name": "permanent_residency_id"
  },
  "documents": [
    {
      "name": "steuer_id",
      "type": "tax_document",
      "issuing_country": "DEU",
      "document_number": "<string>"
    }
  ],
  "address": {
    "line1": "123 Main Street",
    "city": "City Name",
    "sub_division": "ST",
    "country": "DEU",
    "postal_code": "12345"
  }
}'
{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "under_review",
  "documents": [
    {
      "name": "national_id",
      "type": "identity_front"
    },
    {
      "name": "national_id",
      "type": "identity_back"
    },
    {
      "name": "steuer_id",
      "type": "tax_document"
    }
  ],
  "address": {
    "line1": "123 Main Street",
    "line2": null,
    "city": "City Name",
    "country": "DEU",
    "region": null,
    "sub_division": "ST",
    "postal_code": "12345"
  },
  "first_name": "John",
  "last_name": "Doe",
  "email_address": "user@example.com",
  "phone_number": "+1XXXXXXXXXX",
  "date_of_birth": "YYYY-MM-DD",
  "rejection_reasons": null,
  "requirements": null
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Must be included in the x-api-key header.

Path Parameters

​
user_id
string<uuid>
required

Unique identifier of the user to update

Body

application/json

User update request - all fields are optional, only include fields that need to be updated

​
first_name
string
Example:

"John"

​
last_name
string
Example:

"Doe"

​
email_address
string<email>
Example:

"user@example.com"

​
phone_number
string
Example:

"+1XXXXXXXXXX"

​
user_type
enum<string>
Available options:
individual
Example:

"individual"

​
date_of_birth
string<date>
Example:

"YYYY-MM-DD"

​
consent_id
string<uuid>
Example:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

​
metadata
string
Example:

"{}"

​
sharing_consent
boolean
Example:

true

​
identity
object
​
documents
AdditionalDocuments · object[]

Additional supporting documents for user onboarding. Can include various document types such as proof of address, source of funds, etc.

​
address
object

Response

User updated successfully

​
id
string<uuid>

Unique user identifier

Example:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

​
status
enum<string>

Current user status. under_review: Initial status when user is created (default). active: User has been approved and verified. paused: User account is temporarily paused. rejected: User has been rejected during KYC process. offboarded: User has been removed/offboarded from the system. incomplete: User profile is missing required information.

Available options:
under_review,
active,
rejected,
offboarded,
incomplete
Example:

"under_review"

​
documents
object[]

List of uploaded documents (both identity and supporting documents)

Example:
[
  {
    "name": "national_id",
    "type": "identity_front"
  },
  {
    "name": "national_id",
    "type": "identity_back"
  },
  {
    "name": "steuer_id",
    "type": "tax_document"
  }
]
​
address
object
​
first_name
string

User's first name

Example:

"John"

​
last_name
string

User's last name

Example:

"Doe"

​
email_address
string<email>

User's email address

Example:

"user@example.com"

​
phone_number
string

User's phone number

Example:

"+1XXXXXXXXXX"

​
date_of_birth
string<date>

User's date of birth

Example:

"YYYY-MM-DD"

​
rejection_reasons
object[] | null

Array of rejection reason objects (only populated for rejected users, null otherwise). Each object contains customer-facing reason, timestamp, and internal developer reason.

Example:

null

​
requirements
string[] | null

List of missing requirements for incomplete users (null when no requirements are missing)

Example:

null