Sha256: 0bf5a232a1c87277c7c1e7e6a002a33f9fb35db57f962a9d05eae372f7049c4f

Contents?: true

Size: 1.93 KB

Versions: 4

Compression:

Stored size: 1.93 KB

Contents

# SyncteraRubySdk::PatchCustomer

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **ban_status** | [**BanStatus**](BanStatus.md) |  | [optional] |
| **dob** | **Date** | Customer's date of birth in RFC 3339 full-date format (YYYY-MM-DD) | [optional] |
| **email** | **String** | Customer's email | [optional] |
| **first_name** | **String** | Customer's first name | [optional] |
| **last_name** | **String** | Customer's last name | [optional] |
| **legal_address** | [**LegalAddress**](LegalAddress.md) |  | [optional] |
| **metadata** | **Object** | User-supplied JSON format metadata. Do not use to store PII. | [optional] |
| **middle_name** | **String** | Customer's middle name | [optional] |
| **note** | **String** | 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. | [optional] |
| **phone_number** | **String** | 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. | [optional] |
| **shipping_address** | [**ShippingAddress**](ShippingAddress.md) |  | [optional] |
| **ssn** | **String** | 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). | [optional] |
| **status** | **String** | Customer's status | [optional] |

## Example

```ruby
require 'synctera_ruby_sdk'

instance = SyncteraRubySdk::PatchCustomer.new(
  ban_status: null,
  dob: Sat Jan 01 02:00:00 EET 2000,
  email: alice@example.com,
  first_name: Jane,
  last_name: Smith,
  legal_address: null,
  metadata: null,
  middle_name: Anne,
  note: null,
  phone_number: +14374570680,
  shipping_address: null,
  ssn: 123-45-6789,
  status: null
)
```

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
synctera_ruby_sdk-1.1.3 docs/PatchCustomer.md
synctera_ruby_sdk-1.1.2 docs/PatchCustomer.md
synctera_ruby_sdk-1.1.1 docs/PatchCustomer.md
synctera_ruby_sdk-1.0.0 docs/PatchCustomer.md