SyncteraRubySdk::Prospect
Properties
| Name |
Type |
Description |
Notes |
| dob |
Date |
Customer's date of birth in RFC 3339 full-date format (YYYY-MM-DD) |
[optional] |
| first_name |
String |
Customer's first name |
[optional] |
| last_name |
String |
Customer's last name |
[optional] |
| status |
String |
Customer's status |
|
| ban_status |
BanStatus |
|
[optional] |
| creation_time |
Time |
The date and time the resource was created. |
[optional][readonly] |
| email |
String |
Customer's email |
[optional] |
| has_accounts |
Boolean |
This flag indicates whether the person or business has accounts. |
[optional][readonly] |
| id |
String |
Customer unique identifier |
[optional][readonly] |
| kyc_exempt |
Boolean |
Customer's KYC exemption |
[optional][readonly] |
| kyc_last_run |
Time |
Date and time KYC was last run on the customer |
[optional][readonly] |
| kyc_status |
CustomerKycStatus |
|
[optional] |
| last_updated_time |
Time |
The date and time the resource was last updated. |
[optional][readonly] |
| legal_address |
LegalAddress |
|
[optional] |
| metadata |
Object |
User-supplied 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] |
| related_customers |
Array<Relationship1> |
Customer's relationships with other accounts eg. guardian. This property is no longer supported. Setting it will return an error. |
[optional] |
| shipping_address |
ShippingAddress |
|
[optional] |
| ssn |
String |
Customer's full tax ID eg SSN formatted with hyphens. This optional parameter is required when running KYC on a customer. Input must match the pattern ^\d3-\d2-\d4$. The response contains the last 4 digits only (e.g. 6789). |
[optional] |
| ssn_source |
SsnSource |
|
[optional] |
| tenant |
String |
The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces. |
[optional] |
Example
require 'synctera_ruby_sdk'
instance = SyncteraRubySdk::Prospect.new(
dob: Sat Jan 01 02:00:00 EET 2000,
first_name: Jane,
last_name: Smith,
status: null,
ban_status: null,
creation_time: 2010-05-06T12:23:34.321Z,
email: alice@example.com,
has_accounts: null,
id: 7d943c51-e4ff-4e57-9558-08cab6b963c7,
kyc_exempt: null,
kyc_last_run: 2010-05-06T12:23:34.321Z,
kyc_status: null,
last_updated_time: 2010-05-06T12:23:34.321Z,
legal_address: null,
metadata: null,
middle_name: Anne,
note: null,
phone_number: +14374570680,
related_customers: null,
shipping_address: null,
ssn: 123-45-6789,
ssn_source: null,
tenant: abcdef_ghijkl
)