Update a user's details - Palm API

Update a user's details

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    'identity.first_name': 'John',
    'identity.middle_name': 'William',
    'identity.last_name': 'Doe',
    'identity.date_of_birth': '1990-01-15',
    'identity.email': 'john.doe@example.com',
    'identity.phone_number': '+15551234567',
    'identity.ssn': '123-45-6789',
    'identity.passport_number': '123456789',
    'identity.drivers_license': 'D1234567',
    'identity.address_line_1': '123 Main Street',
    'identity.address_line_2': 'Apt 4B',
    'identity.city': 'San Francisco',
    'identity.region': 'CA',
    'identity.postal_code': '94102',
    'identity.country': 'US'
  })
};

fetch('https://api.getpalm.com/v1/user/{user_id}/vault', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.getpalm.com/v1/user/{user_id}/vault"

payload = {
    "identity.first_name": "John",
    "identity.middle_name": "William",
    "identity.last_name": "Doe",
    "identity.date_of_birth": "1990-01-15",
    "identity.email": "john.doe@example.com",
    "identity.phone_number": "+15551234567",
    "identity.ssn": "123-45-6789",
    "identity.passport_number": "123456789",
    "identity.drivers_license": "D1234567",
    "identity.address_line_1": "123 Main Street",
    "identity.address_line_2": "Apt 4B",
    "identity.city": "San Francisco",
    "identity.region": "CA",
    "identity.postal_code": "94102",
    "identity.country": "US"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

curl --request PATCH \
  --url https://api.getpalm.com/v1/user/{user_id}/vault \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identity.first_name": "John",
  "identity.middle_name": "William",
  "identity.last_name": "Doe",
  "identity.date_of_birth": "1990-01-15",
  "identity.email": "john.doe@example.com",
  "identity.phone_number": "+15551234567",
  "identity.ssn": "123-45-6789",
  "identity.passport_number": "123456789",
  "identity.drivers_license": "D1234567",
  "identity.address_line_1": "123 Main Street",
  "identity.address_line_2": "Apt 4B",
  "identity.city": "San Francisco",
  "identity.region": "CA",
  "identity.postal_code": "94102",
  "identity.country": "US"
}
'

{
  "identity.first_name": true,
  "identity.last_name": true,
  "identity.date_of_birth": true,
  "identity.ssn": true
}

PATCH

/

v1

/

user

/

{user_id}

/

vault

Update a user's details

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    'identity.first_name': 'John',
    'identity.middle_name': 'William',
    'identity.last_name': 'Doe',
    'identity.date_of_birth': '1990-01-15',
    'identity.email': 'john.doe@example.com',
    'identity.phone_number': '+15551234567',
    'identity.ssn': '123-45-6789',
    'identity.passport_number': '123456789',
    'identity.drivers_license': 'D1234567',
    'identity.address_line_1': '123 Main Street',
    'identity.address_line_2': 'Apt 4B',
    'identity.city': 'San Francisco',
    'identity.region': 'CA',
    'identity.postal_code': '94102',
    'identity.country': 'US'
  })
};

fetch('https://api.getpalm.com/v1/user/{user_id}/vault', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.getpalm.com/v1/user/{user_id}/vault"

payload = {
    "identity.first_name": "John",
    "identity.middle_name": "William",
    "identity.last_name": "Doe",
    "identity.date_of_birth": "1990-01-15",
    "identity.email": "john.doe@example.com",
    "identity.phone_number": "+15551234567",
    "identity.ssn": "123-45-6789",
    "identity.passport_number": "123456789",
    "identity.drivers_license": "D1234567",
    "identity.address_line_1": "123 Main Street",
    "identity.address_line_2": "Apt 4B",
    "identity.city": "San Francisco",
    "identity.region": "CA",
    "identity.postal_code": "94102",
    "identity.country": "US"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

curl --request PATCH \
  --url https://api.getpalm.com/v1/user/{user_id}/vault \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identity.first_name": "John",
  "identity.middle_name": "William",
  "identity.last_name": "Doe",
  "identity.date_of_birth": "1990-01-15",
  "identity.email": "john.doe@example.com",
  "identity.phone_number": "+15551234567",
  "identity.ssn": "123-45-6789",
  "identity.passport_number": "123456789",
  "identity.drivers_license": "D1234567",
  "identity.address_line_1": "123 Main Street",
  "identity.address_line_2": "Apt 4B",
  "identity.city": "San Francisco",
  "identity.region": "CA",
  "identity.postal_code": "94102",
  "identity.country": "US"
}
'

{
  "identity.first_name": true,
  "identity.last_name": true,
  "identity.date_of_birth": true,
  "identity.ssn": true
}

Authorizations

Authorization

string

header

required

Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx

Path Parameters

user_id

string<uuid>

required

User ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json

identity.first_name

string

Legal first name

Example:

"John"

identity.middle_name

string

Middle name or initial

Example:

"William"

identity.last_name

string

Legal last name

Example:

"Doe"

identity.date_of_birth

string

Date of birth in YYYY-MM-DD format

Example:

"1990-01-15"

identity.email

string

Primary email address

Example:

"john.doe@example.com"

identity.phone_number

string

Phone number (E.164 format recommended)

Example:

"+15551234567"

identity.ssn

string

Social Security Number (format: XXX-XX-XXXX or 9 digits)

Example:

"123-45-6789"

identity.passport_number

string

Passport number

Example:

"123456789"

identity.drivers_license

string

Driver's license number

Example:

"D1234567"

identity.address_line_1

string

Street address line 1

Example:

"123 Main Street"

identity.address_line_2

string

Street address line 2 (apt, suite, etc.)

Example:

"Apt 4B"

identity.city

string

City

Example:

"San Francisco"

identity.region

string

State, province, or region code

Example:

"CA"

identity.postal_code

string

Postal or ZIP code

Example:

"94102"

identity.country

string

Country (ISO 3166-1 alpha-2 code)

Example:

"US"

Response

The fields now set for the user

Every field now set, each mapped to true.

{key}

boolean