Customers

Delete customer by ID

Delete a customer by their system-generated ID

delete/customers/{customerId}

Response

Customer deleted successfully

OR

Example response

{
  "id": "Customer:019542f5-b3e7-1d02-0000-000000000001",
  "platformCustomerId": "9f84e0c2a72c4fa",
  "customerType": "INDIVIDUAL",
  "endUserTermsConsent": {
    "ipAddress": "198.51.100.24",
    "termsVersion": "V1",
    "acceptanceMethod": "CHECKBOX"
  },
  "region": "US",
  "currencies": [
    "USD",
    "USDC"
  ],
  "email": "john.doe@example.com",
  "phoneNumber": "+14155551234",
  "umaAddress": "$john.doe@uma.domain.com",
  "createdAt": "2025-07-21T17:32:28Z",
  "updatedAt": "2025-07-21T17:32:28Z",
  "contactVerification": {
    "email": "VERIFIED",
    "phone": "VERIFIED"
  },
  "kycStatus": "APPROVED",
  "fullName": "John Michael Doe",
  "birthDate": "1990-01-15",
  "nationality": "US",
  "address": {
    "line1": "123 Main Street",
    "line2": "Apt 4B",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94105",
    "country": "US"
  },
  "idType": "SSN",
  "identifier": "123-45-6789",
  "countryOfIssuance": "US",
  "sourceOfFundsCategories": [
    "SALARY"
  ],
  "sourceOfFundsOtherDescription": "Contest winnings",
  "sourceOfWealthCategories": [
    "SALARY",
    "INVESTMENTS"
  ],
  "sourceOfWealthOtherDescription": "Royalty income from published works",
  "purposeOfAccount": "CONTRACTOR_PAYOUTS",
  "purposeOfAccountOtherDescription": "Household budgeting between spouses",
  "expectedMonthlyTransactionCount": "COUNT_100_TO_500",
  "expectedMonthlyTransactionVolume": "VOLUME_100K_TO_1M",
  "annualIncomeRange": "RANGE_100K_250K",
  "netWorthRange": "RANGE_500K_1M",
  "pepStatus": "NONE"
}

Changes

Changed in 3 of the 24 revisions of this API.21610

  • 27ff0fdca01c33See the full diff
    • removed the optional property oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/allOf[subschema #1]/taxIdCountryOfIssuance from the response with the 200 status

      response-optional-property-removed

    • removed the optional property oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/allOf[subschema #1]/taxIdType from the response with the 200 status

      response-optional-property-removed

    • removed the optional property oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/allOf[subschema #1]/taxIdentifier from the response with the 200 status

      response-optional-property-removed

    • added the optional property oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/allOf[subschema #1]/countryOfIssuance to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/allOf[subschema #1]/idType to the response with the 200 status

      response-optional-property-added

    • added the optional write-only property oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/allOf[subschema #1]/identifier to the response with the 200 status

      response-optional-write-only-property-added

    • added the optional property oneOf[subschema #1: Individual Customer]/allOf[Customer]/endUserTermsConsent to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: Business Customer]/allOf[BusinessCustomerFields]/businessInfo/primaryContactFirstName to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: Business Customer]/allOf[BusinessCustomerFields]/businessInfo/primaryContactLastName to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: Business Customer]/allOf[Customer]/endUserTermsConsent to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: Business Customer]/allOf[subschema #3]/businessInfo/primaryContactFirstName to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: Business Customer]/allOf[subschema #3]/businessInfo/primaryContactLastName to the response with the 200 status

      response-optional-property-added

  • b21ed434ee6e2131See the full diff
    • the oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the required property oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/customerType from the response with the 200 status

      response-required-property-removed

    • removed the optional property oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/address from the response with the 200 status

      response-optional-property-removed

    • removed the optional property oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/birthDate from the response with the 200 status

      response-optional-property-removed

    • removed the optional property oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/fullName from the response with the 200 status

      response-optional-property-removed

    • removed the optional property oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/kycStatus from the response with the 200 status

      response-optional-property-removed

    • removed the optional property oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/nationality from the response with the 200 status

      response-optional-property-removed

    • added the new CHARITY enum value to the oneOf[subschema #2: Business Customer]/allOf[BusinessCustomerFields]/businessInfo/entityType response property for the response status 200

      response-property-enum-value-added

    • added the new CHARITY enum value to the oneOf[subschema #2: Business Customer]/allOf[subschema #3]/businessInfo/entityType response property for the response status 200

      response-property-enum-value-added

    • added the new PRIVATE_FOUNDATION enum value to the oneOf[subschema #2: Business Customer]/allOf[BusinessCustomerFields]/businessInfo/entityType response property for the response status 200

      response-property-enum-value-added

    • added the new PRIVATE_FOUNDATION enum value to the oneOf[subschema #2: Business Customer]/allOf[subschema #3]/businessInfo/entityType response property for the response status 200

      response-property-enum-value-added

    • added the new PUBLICLY_LISTED_COMPANY enum value to the oneOf[subschema #2: Business Customer]/allOf[BusinessCustomerFields]/businessInfo/entityType response property for the response status 200

      response-property-enum-value-added

    • added the new PUBLICLY_LISTED_COMPANY enum value to the oneOf[subschema #2: Business Customer]/allOf[subschema #3]/businessInfo/entityType response property for the response status 200

      response-property-enum-value-added

    • added the new TRUST enum value to the oneOf[subschema #2: Business Customer]/allOf[BusinessCustomerFields]/businessInfo/entityType response property for the response status 200

      response-property-enum-value-added

    • added the new TRUST enum value to the oneOf[subschema #2: Business Customer]/allOf[subschema #3]/businessInfo/entityType response property for the response status 200

      response-property-enum-value-added

    • added CustomerEdd subschema #1 to the oneOf[subschema #1: Individual Customer]/allOf[IndividualCustomerFields]/ response property allOf list for the response status 200

      response-property-all-of-added