Skip to main content
PATCH
/
customers
/
{customerId}
Update a customer
curl --request PATCH \
  --url https://api.polygon.technology/v0.9/customers/{customerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "middleName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "birthDate": "<string>",
  "nationality": "<string>",
  "ipAddress": "<string>",
  "externalId": "<string>",
  "signedAgreement": true,
  "residentialAddress": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zipCode": "<string>"
  },
  "identifyingInformation": [
    {
      "issuingCountry": "<string>",
      "number": "<string>"
    }
  ],
  "endorsements": [],
  "metadata": {}
}
'
{
  "id": "cst_01H9Xa8F5dN6mP3q",
  "object": "customer",
  "type": "individual",
  "firstName": "Jane",
  "middleName": null,
  "lastName": "Smith",
  "email": "jane@example.com",
  "phone": "+12125551234",
  "nationality": "US",
  "externalId": "usr_12345",
  "status": "active",
  "signedAgreement": true,
  "signedAgreementAt": "2026-03-20T14:15:22Z",
  "wallets": [
    {
      "id": "wlt_01H9Xb3K7nM2pQ4r",
      "type": "custodial",
      "address": "0x7B3a9F2c4D1eA8bF6390cE5d2B7fA104C8e3D9b1",
      "network": "polygon",
      "asset": "usdc",
      "balance": "1234.56",
      "estimatedValueUsd": "1234.56",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "endorsements": [
    {
      "rejectionReasons": [
        {
          "developerReason": "<string>",
          "reason": "<string>"
        }
      ],
      "requirements": {
        "complete": [
          "<string>"
        ],
        "pending": [
          "<string>"
        ],
        "missing": [
          "<string>"
        ],
        "issues": [
          "<string>"
        ]
      }
    }
  ],
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Token from POST /auth/token

Path Parameters

​
customerId
string
required

Body

application/json

Partial update — only send the fields you want to change. All optional fields from CustomerRequest can be updated (including ipAddress). PII fields are write-only.

​
firstName
string
​
middleName
string
​
lastName
string
​
email
string
​
phone
string
​
birthDate
string
write-only
​
nationality
string
​
ipAddress
string
write-only
​
externalId
string
​
signedAgreement
boolean

One-way operation — cannot be set back to false.

​
residentialAddress
object
write-only
​
identifyingInformation
object[]
write-only

Appends to existing array. To replace an entry, submit the same type with updated fields.

​
endorsements
enum<string>[]

Request additional endorsements. New endorsements are added; existing ones are not removed. Including endorsement names triggers re-evaluation.

Available options:
basic,
cryptoCustody,
usd
​
metadata
object

Response

Customer updated

Customer response object. PII fields (birthDate, residentialAddress, ipAddress, identifyingInformation) are write-only — accepted in POST/PATCH but never returned in responses.

​
id
string
Example:

"cst_01H9Xa8F5dN6mP3q"

​
object
string
Example:

"customer"

​
type
enum<string>

Customer type. Only individual is supported for MVP.

Available options:
individual
Example:

"individual"

​
firstName
string | null
Example:

"Jane"

​
middleName
string | null
Example:

null

​
lastName
string | null
Example:

"Smith"

​
email
string | null
Example:

"jane@example.com"

​
phone
string | null

Primary phone in E.164 format.

Example:

"+12125551234"

​
nationality
string | null

ISO 3166-1 alpha-2 country code.

Example:

"US"

​
externalId
string | null

Developer's own user ID for cross-referencing.

Example:

"usr_12345"

​
status
enum<string>

active or inactive. Inactive customers cannot create new transactions. No intermediate states — all granularity lives in endorsement statuses.

Available options:
active,
inactive
Example:

"active"

​
signedAgreement
boolean

Whether the customer has accepted OMS terms of service.

Example:

true

​
signedAgreementAt
string<date-time> | null

Timestamp when signedAgreement was set to true. Null if not yet signed.

Example:

"2026-03-20T14:15:22Z"

​
wallets
object[]

Simplified flat view: one entry per wallet-asset combination. Use GET /wallets/{id} for the full representation.

​
endorsements
object[]

Endorsements track KYC/compliance status. Types: basic, cryptoCustody, usd. Statuses use SCREAMING_CASE: INACTIVE, PENDING, ISSUES, ACTIVE, REJECTED, REVOKED_ISSUES, OFFBOARDED.

​
metadata
object
​
createdAt
string<date-time>
​
updatedAt
string<date-time>