Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Customers

Patch Customer

Patch fields of customer based on ID Note that if:

  • legal address is provided in the request, AND
  • shipping_address is not provided in the request, AND
  • the customer resource does not have shipping_address then shipping_address will be set to a copy of the legal_address.
patch/customers/{customer_id}

Path parameters

customer_idstring uuid required
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

The customer's unique identifier

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Request body

ban_status'ALLOWED' | 'BANNED' | 'SUSPENDED'

(beta) Ban status of the person. One of the following:

  • ALLOWED – person is not banned or suspended
  • SUSPENDED - person is manually suspended due to fraud
  • BANNED – person is banned due to matching ban rules Note: changing the ban status to or from BANNED can only be performed by the Synctera platform based on ban rules.
dobstring date

Customer's date of birth in RFC 3339 full-date format (YYYY-MM-DD)

emailstring

Customer's email

first_namestring

Customer's first name

last_namestring

Customer's last name

metadataobject

User-supplied JSON format metadata. Do not use to store PII.

middle_namestring

Customer's middle name

notestring

Add an optional note when creating or updating a customer. A note is required when updating a customers's ban_status between SUSPENDED and ALLOWED.

phone_numberstring

Customer's mobile phone number with country code in E.164 format. Must have a valid country code. Area code and local phone number are not validated.

spend_control_idsstring[]

List of spend control IDs to control spending for the customer

ssnstring

Customer's full tax ID eg SSN formatted with hyphens. This optional parameter is required when running KYC on a customer. Must be compiled with ^\d{3}-\d{2}-\d{4}$. Response contains the last 4 digits only (e.g. 6789).

status'ACTIVE' | 'DECEASED' | 'DENIED' | 'DORMANT' | 'ESCHEAT' | 'FROZEN' | 'INACTIVE' | 'PROSPECT' | 'SANCTION'

Customer's status

Example request

{
  "ban_status": "ALLOWED",
  "dob": "2000-01-01",
  "email": "alice@example.com",
  "first_name": "Jane",
  "last_name": "Smith",
  "legal_address": {
    "address_line_1": "100 Main St.",
    "address_line_2": "Suite 99",
    "address_type": "SHIPPING",
    "city": "New York",
    "country_code": "US",
    "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "is_registered_agent": true,
    "nickname": "Home",
    "postal_code": "28620",
    "state": "NY"
  },
  "middle_name": "Anne",
  "phone_number": "+14374570680",
  "shipping_address": {
    "address_line_1": "100 Main St.",
    "address_line_2": "Suite 99",
    "address_type": "SHIPPING",
    "city": "New York",
    "country_code": "US",
    "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "is_registered_agent": true,
    "nickname": "Home",
    "postal_code": "28620",
    "state": "NY"
  },
  "spend_control_ids": [
    "7d943c51-e4ff-4e57-9558-08cab6b963c7"
  ],
  "ssn": "123-45-6789",
  "vendor_info": {
    "vendor_data": {
      "loanpro": {
        "customer_id": 12345
      }
    }
  }
}

Response

Patched customer

OR

Example response

{
  "vendor_info": {
    "vendor_data": {
      "loanpro": {
        "customer_id": 12345
      }
    }
  },
  "addresses": [
    {
      "address_line_1": "100 Main St.",
      "address_line_2": "Suite 99",
      "address_type": "SHIPPING",
      "city": "New York",
      "country_code": "US",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "is_registered_agent": true,
      "nickname": "Home",
      "postal_code": "28620",
      "state": "NY"
    }
  ],
  "ban_status": "ALLOWED",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "email": "alice@example.com",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "kyc_last_run": "2010-05-06T12:23:34.321Z",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "legal_address": {
    "address_line_1": "100 Main St.",
    "address_line_2": "Suite 99",
    "address_type": "SHIPPING",
    "city": "New York",
    "country_code": "US",
    "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "is_registered_agent": true,
    "nickname": "Home",
    "postal_code": "28620",
    "state": "NY"
  },
  "middle_name": "Anne",
  "phone_number": "+14374570680",
  "related_customers": [
    {
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "relationship_role": "CUSTODIAN"
    }
  ],
  "shipping_address": {
    "address_line_1": "100 Main St.",
    "address_line_2": "Suite 99",
    "address_type": "SHIPPING",
    "city": "New York",
    "country_code": "US",
    "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "is_registered_agent": true,
    "nickname": "Home",
    "postal_code": "28620",
    "state": "NY"
  },
  "spend_control_ids": [
    "7d943c51-e4ff-4e57-9558-08cab6b963c7"
  ],
  "ssn": "123-45-6789",
  "tenant": "abcdef_ghijkl",
  "dob": "2000-01-01",
  "first_name": "Jane",
  "last_name": "Smith"
}