Delete a customer

curl --request DELETE \
  --url https://sandbox-api.polygon.technology/v0.13/customers/{customerId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox-api.polygon.technology/v0.13/customers/{customerId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox-api.polygon.technology/v0.13/customers/{customerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.polygon.technology/v0.13/customers/{customerId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.polygon.technology/v0.13/customers/{customerId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.polygon.technology/v0.13/customers/{customerId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "cst_01H9Xa8F5dN6mP3q",
  "type": "individual",
  "name": "Jane Smith",
  "firstName": "Jane",
  "middleName": null,
  "lastName": "Smith",
  "email": "jane@example.com",
  "phone": "+12125551234",
  "nationality": "US",
  "externalId": "crm-12345",
  "status": "active",
  "hold": {
    "code": "verificationRequired",
    "message": "<string>"
  },
  "failure": {
    "code": "onboardingRejected",
    "message": "<string>",
    "retryable": true
  },
  "signedAgreement": true,
  "signedAgreementAt": "2026-03-20T14:15:22Z",
  "totalBalance": {
    "totalUsd": "1250.00",
    "fiatUsd": "1000.00",
    "cryptoUsd": "250.00",
    "updatedAt": "2026-03-20T14:15:22Z"
  },
  "endorsements": [
    {
      "type": "basic",
      "status": "pending",
      "requirements": {
        "complete": [
          "<string>"
        ],
        "pending": [
          "<string>"
        ],
        "missing": [
          "<string>"
        ],
        "issues": [
          "<string>"
        ]
      },
      "failure": {
        "code": "onboardingRejected",
        "message": "<string>",
        "retryable": true
      }
    }
  ],
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "companyLegalName": "<string>",
  "dbaName": "<string>",
  "formationDate": "<string>",
  "registrationCountry": "<string>",
  "registrationNumber": "<string>",
  "legalEntityType": "corporation",
  "ownershipType": "exempt",
  "taxIdType": "ein",
  "incorporationAddress": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>"
  },
  "physicalAddress": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>"
  },
  "websiteUrl": "<string>",
  "businessDescription": "<string>",
  "industry": "<string>",
  "industryFinancialServicesSubtype": "<string>",
  "industryCryptoSubtype": "<string>",
  "industryOtherDescription": "<string>",
  "sourceOfFundsOtherDescription": "<string>",
  "accountPurposesOtherDescription": "<string>",
  "primaryTargetMarketOtherDescription": "<string>",
  "sourceOfFunds": [
    "<string>"
  ],
  "accountPurposes": [
    "<string>"
  ],
  "primaryTargetMarket": "<string>",
  "expectedFiatMonthlyVolume": "<string>",
  "expectedCryptoMonthlyVolume": "<string>",
  "isMsb": true,
  "disclosureAccepted": true,
  "disclosureAcceptedAt": "2023-11-07T05:31:56Z",
  "disclosureVersion": "<string>",
  "disclosureIpAddress": "<string>",
  "hasBusinessTaxId": true
}

{
  "error": "Unauthorized",
  "code": 1000,
  "msg": "unauthorized access",
  "status": 401,
  "cause": "signature"
}

{
  "error": "Unauthorized",
  "code": 1000,
  "msg": "unauthorized access",
  "status": 401,
  "cause": "signature"
}

DELETE

customers

{customerId}

Delete a customer

curl --request DELETE \
  --url https://sandbox-api.polygon.technology/v0.13/customers/{customerId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox-api.polygon.technology/v0.13/customers/{customerId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox-api.polygon.technology/v0.13/customers/{customerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.polygon.technology/v0.13/customers/{customerId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.polygon.technology/v0.13/customers/{customerId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.polygon.technology/v0.13/customers/{customerId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "cst_01H9Xa8F5dN6mP3q",
  "type": "individual",
  "name": "Jane Smith",
  "firstName": "Jane",
  "middleName": null,
  "lastName": "Smith",
  "email": "jane@example.com",
  "phone": "+12125551234",
  "nationality": "US",
  "externalId": "crm-12345",
  "status": "active",
  "hold": {
    "code": "verificationRequired",
    "message": "<string>"
  },
  "failure": {
    "code": "onboardingRejected",
    "message": "<string>",
    "retryable": true
  },
  "signedAgreement": true,
  "signedAgreementAt": "2026-03-20T14:15:22Z",
  "totalBalance": {
    "totalUsd": "1250.00",
    "fiatUsd": "1000.00",
    "cryptoUsd": "250.00",
    "updatedAt": "2026-03-20T14:15:22Z"
  },
  "endorsements": [
    {
      "type": "basic",
      "status": "pending",
      "requirements": {
        "complete": [
          "<string>"
        ],
        "pending": [
          "<string>"
        ],
        "missing": [
          "<string>"
        ],
        "issues": [
          "<string>"
        ]
      },
      "failure": {
        "code": "onboardingRejected",
        "message": "<string>",
        "retryable": true
      }
    }
  ],
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "companyLegalName": "<string>",
  "dbaName": "<string>",
  "formationDate": "<string>",
  "registrationCountry": "<string>",
  "registrationNumber": "<string>",
  "legalEntityType": "corporation",
  "ownershipType": "exempt",
  "taxIdType": "ein",
  "incorporationAddress": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>"
  },
  "physicalAddress": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>"
  },
  "websiteUrl": "<string>",
  "businessDescription": "<string>",
  "industry": "<string>",
  "industryFinancialServicesSubtype": "<string>",
  "industryCryptoSubtype": "<string>",
  "industryOtherDescription": "<string>",
  "sourceOfFundsOtherDescription": "<string>",
  "accountPurposesOtherDescription": "<string>",
  "primaryTargetMarketOtherDescription": "<string>",
  "sourceOfFunds": [
    "<string>"
  ],
  "accountPurposes": [
    "<string>"
  ],
  "primaryTargetMarket": "<string>",
  "expectedFiatMonthlyVolume": "<string>",
  "expectedCryptoMonthlyVolume": "<string>",
  "isMsb": true,
  "disclosureAccepted": true,
  "disclosureAcceptedAt": "2023-11-07T05:31:56Z",
  "disclosureVersion": "<string>",
  "disclosureIpAddress": "<string>",
  "hasBusinessTaxId": true
}

{
  "error": "Unauthorized",
  "code": 1000,
  "msg": "unauthorized access",
  "status": 401,
  "cause": "signature"
}

{
  "error": "Unauthorized",
  "code": 1000,
  "msg": "unauthorized access",
  "status": 401,
  "cause": "signature"
}

Authorizations

Authorization

string

header

required

Token from POST /auth/token

Path Parameters

customerId

string

required

Response

Customer soft-deleted (status offboarded)

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

string

Example:

"cst_01H9Xa8F5dN6mP3q"

type

enum<string>

Customer type. Individuals are subject to the project's KYC policy, businesses to its KYB policy.

Available options:

individual,

business

Example:

"individual"

name

string

An individual's first, middle and last names joined by spaces, or a business's legal name. Left out when the customer has no name.

Example:

"Jane Smith"

firstName

string | null

Example:

"Jane"

middleName

string | null

Example:

null

lastName

string | null

Example:

"Smith"

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 customer ID for cross-referencing.

Example:

"crm-12345"

status

enum<string>

Where the customer is in onboarding. actionRequired carries a hold saying what to do, and rejected carries a failure. offboarded is a deleted or deactivated customer.

Available options:

pending,

actionRequired,

active,

rejected,

offboarded

Example:

"active"

hold

object

What you must do for a customer in actionRequired.

Hide child attributes

hold.code

string

required

Example:

"verificationRequired"

hold.message

string

required

failure

object

Why a customer or an endorsement was rejected.

Hide child attributes

failure.code

string

required

Example:

"onboardingRejected"

failure.message

string

required

failure.retryable

boolean

required

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"

totalBalance

object

USD rollup of a customer's balances. Returned on GET /customers/{id} only — never on list, create, or update. Covers fiat wallets and custodial crypto wallets; noncustodial wallets are not yet valued, so a customer holding one reads an undercount here. Omitted entirely when the rollup cannot be read; a partial total is never returned, so treat an absent field as "unknown", not as zero.

Hide child attributes

totalBalance.totalUsd

string

fiatUsd + cryptoUsd, 2 decimal places, sign preserved.

Example:

"1250.00"

totalBalance.fiatUsd

string

Sum of the customer's USD fiat wallet balances as last reported by the holding bank. Can be negative — an ACH clawback can overdraw a deposit account — so render the sign verbatim and never clamp.

Example:

"1000.00"

totalBalance.cryptoUsd

string

Sum of the customer's custodial crypto wallet balances at the custodian's own per-asset USD estimate. "0.00" for a customer with no custodial crypto account.

Example:

"250.00"

totalBalance.updatedAt

string<date-time>

When the custodial wallet provider last updated the crypto balances in cryptoUsd: the newest per-asset timestamp the provider reports across those balances, read live with this request. Fiat balances do not affect it. Omitted when the provider reports no timestamp, for example when the customer holds no custodial crypto wallet.

Example:

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

endorsements

object[]

What the customer is endorsed for. An endorsement never reads further along than its customer, and one that was not requested is left out.

Hide child attributes

endorsements.type

enum<string>

required

Available options:

basic,

cryptoCustody,

usd

endorsements.status

enum<string>

required

Available options:

pending,

actionRequired,

active,

rejected,

offboarded

endorsements.requirements

object

Tracks what is complete, pending, missing, or has issues for this endorsement.

Hide child attributes

endorsements.requirements.complete

string[]

endorsements.requirements.pending

string[]

endorsements.requirements.missing

string[] | null

endorsements.requirements.issues

string[]

endorsements.failure

object

Why a customer or an endorsement was rejected.

Hide child attributes

endorsements.failure.code

string

required

Example:

"onboardingRejected"

endorsements.failure.message

string

required

endorsements.failure.retryable

boolean

required

metadata

object | null

Hide child attributes

metadata.{key}

string

createdAt

string<date-time>

updatedAt

string<date-time>

companyLegalName

string

Maximum string length: 255

dbaName

string

formationDate

string

registrationCountry

string

registrationNumber

string

legalEntityType

enum<string>

Available options:

corporation,

llc,

nonProfit,

partnership,

soleProprietorship,

trust

ownershipType

enum<string>

Available options:

exempt,

excluded,

nonProfit,

legalEntity

taxIdType

enum<string>

Available options:

ein,

vat,

foreign,

ssn,

itin,

foreignTin

incorporationAddress

object

Hide child attributes

incorporationAddress.line1

string

incorporationAddress.line2

string

incorporationAddress.city

string

incorporationAddress.state

string

incorporationAddress.postalCode

string

incorporationAddress.country

string

physicalAddress

object

Hide child attributes

physicalAddress.line1

string

physicalAddress.line2

string

physicalAddress.city

string

physicalAddress.state

string

physicalAddress.postalCode

string

physicalAddress.country

string

websiteUrl

string

businessDescription

string

industry

string

industryFinancialServicesSubtype

string

industryCryptoSubtype

string

industryOtherDescription

string

sourceOfFundsOtherDescription

string

accountPurposesOtherDescription

string

primaryTargetMarketOtherDescription

string

sourceOfFunds

string[]

accountPurposes

string[]

primaryTargetMarket

string

expectedFiatMonthlyVolume

string

expectedCryptoMonthlyVolume

string

isMsb

boolean

disclosureAccepted

boolean

disclosureAcceptedAt

string<date-time>

disclosureVersion

string

disclosureIpAddress

string

hasBusinessTaxId

boolean

Overview

Move money

Routes

External Payment Methods

Platform

Read onchain data

Delete a customer

Authorizations

Path Parameters

Response