SyncteraRubySdk::CustomersApi

All URIs are relative to https://api.synctera.com/v0

Method	HTTP request	Description
create_customer	POST /customers	Create a Customer
create_customer_employment	POST /customers/customer_id/employment	Create employment record
create_customer_risk_rating	POST /customers/customer_id/risk_ratings	Create customer risk rating
get_all_customer_employment	GET /customers/customer_id/employment	List customer employment records
get_all_customer_risk_ratings	GET /customers/customer_id/risk_ratings	List customer risk ratings
get_customer	GET /customers/customer_id	Get Customer
get_customer_risk_rating	GET /customers/customer_id/risk_ratings/risk_rating_id	Get customer risk rating
get_party_employment	GET /customers/customer_id/employment/employment_id	Get customer employment record
list_customers	GET /customers	List Customers
patch_customer	PATCH /customers/customer_id	Patch Customer
update_customer	PUT /customers/customer_id	Update Customer
update_party_employment	PUT /customers/customer_id/employment/employment_id	Update customer employment record

create_customer

create_customer(customer_in_body, opts)

Create a Customer

The customer object represents your customer's identity. You can then verify the identity of this customer and associate them with other people and accounts. Note that if no shipping_address attribute is provided in the request, the shipping_address will be set to a copy of the legal_address.

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::CustomersApi.new
customer_in_body = SyncteraRubySdk::Customer.new({status: 'ACTIVE'}) # CustomerInBody | Customer to create
opts = {
  idempotency_key: '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | 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.
}

begin
  # Create a Customer
  result = api_instance.create_customer(customer_in_body, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->create_customer: #{e}"
end

Using the create_customer_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> create_customer_with_http_info(customer_in_body, opts)

begin
  # Create a Customer
  data, status_code, headers = api_instance.create_customer_with_http_info(customer_in_body, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomerInBody>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->create_customer_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
customer_in_body	CustomerInBody	Customer to create
idempotency_key	String	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.	[optional]

Return type

CustomerInBody

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json, application/problem+json

create_customer_employment

create_customer_employment(customer_id, employment, opts)

Create employment record

Create a customer employment record.

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::CustomersApi.new
customer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The customer's unique identifier
employment = SyncteraRubySdk::Employment.new({employer_name: 'ABC, Inc.'}) # Employment | Customer employment record to create.
opts = {
  idempotency_key: '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | 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.
}

begin
  # Create employment record
  result = api_instance.create_customer_employment(customer_id, employment, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->create_customer_employment: #{e}"
end

Using the create_customer_employment_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> create_customer_employment_with_http_info(customer_id, employment, opts)

begin
  # Create employment record
  data, status_code, headers = api_instance.create_customer_employment_with_http_info(customer_id, employment, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Employment>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->create_customer_employment_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
customer_id	String	The customer's unique identifier
employment	Employment	Customer employment record to create.
idempotency_key	String	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.	[optional]

Return type

Employment

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json, application/problem+json

create_customer_risk_rating

create_customer_risk_rating(customer_id, opts)

Create customer risk rating

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::CustomersApi.new
customer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The customer's unique identifier
opts = {
  idempotency_key: '7d943c51-e4ff-4e57-9558-08cab6b963c7', # String | 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.
  risk_rating: SyncteraRubySdk::RiskRating.new # RiskRating | Create a customer risk rating. With a risk rating in request body, Synctera validates the data and saves it. With no request body, Synctera runs an automated risk analysis and saves the result. 
}

begin
  # Create customer risk rating
  result = api_instance.create_customer_risk_rating(customer_id, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->create_customer_risk_rating: #{e}"
end

Using the create_customer_risk_rating_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> create_customer_risk_rating_with_http_info(customer_id, opts)

begin
  # Create customer risk rating
  data, status_code, headers = api_instance.create_customer_risk_rating_with_http_info(customer_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RiskRating>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->create_customer_risk_rating_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
customer_id	String	The customer's unique identifier
idempotency_key	String	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.	[optional]
risk_rating	RiskRating	Create a customer risk rating. With a risk rating in request body, Synctera validates the data and saves it. With no request body, Synctera runs an automated risk analysis and saves the result.	[optional]

Return type

RiskRating

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json, application/problem+json

get_all_customer_employment

get_all_customer_employment(customer_id, opts)

List customer employment records

Get a list of customer's current employment records. To see historic employment pass the include_history flag.

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::CustomersApi.new
customer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The customer's unique identifier
opts = {
  include_history: true # Boolean | If true, include old (inactive) records as well.
}

begin
  # List customer employment records
  result = api_instance.get_all_customer_employment(customer_id, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->get_all_customer_employment: #{e}"
end

Using the get_all_customer_employment_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> get_all_customer_employment_with_http_info(customer_id, opts)

begin
  # List customer employment records
  data, status_code, headers = api_instance.get_all_customer_employment_with_http_info(customer_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EmploymentList>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->get_all_customer_employment_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
customer_id	String	The customer's unique identifier
include_history	Boolean	If true, include old (inactive) records as well.	[optional][default to false]

Return type

EmploymentList

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/problem+json

get_all_customer_risk_ratings

get_all_customer_risk_ratings(customer_id, opts)

List customer risk ratings

Get list of customer risk ratings

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::CustomersApi.new
customer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The customer's unique identifier
opts = {
  include_history: true # Boolean | If true, include old (inactive) records as well.
}

begin
  # List customer risk ratings
  result = api_instance.get_all_customer_risk_ratings(customer_id, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->get_all_customer_risk_ratings: #{e}"
end

Using the get_all_customer_risk_ratings_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> get_all_customer_risk_ratings_with_http_info(customer_id, opts)

begin
  # List customer risk ratings
  data, status_code, headers = api_instance.get_all_customer_risk_ratings_with_http_info(customer_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RiskRatingList>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->get_all_customer_risk_ratings_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
customer_id	String	The customer's unique identifier
include_history	Boolean	If true, include old (inactive) records as well.	[optional][default to false]

Return type

RiskRatingList

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/problem+json

get_customer

get_customer(customer_id)

Get Customer

Get Customer based on ID

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::CustomersApi.new
customer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The customer's unique identifier

begin
  # Get Customer
  result = api_instance.get_customer(customer_id)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->get_customer: #{e}"
end

Using the get_customer_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> get_customer_with_http_info(customer_id)

begin
  # Get Customer
  data, status_code, headers = api_instance.get_customer_with_http_info(customer_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomerInBody>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->get_customer_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
customer_id	String	The customer's unique identifier

Return type

CustomerInBody

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/problem+json

get_customer_risk_rating

get_customer_risk_rating(customer_id, risk_rating_id)

Get customer risk rating

Get a customer risk rating

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::CustomersApi.new
customer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The customer's unique identifier
risk_rating_id = '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | Risk Rating ID

begin
  # Get customer risk rating
  result = api_instance.get_customer_risk_rating(customer_id, risk_rating_id)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->get_customer_risk_rating: #{e}"
end

Using the get_customer_risk_rating_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> get_customer_risk_rating_with_http_info(customer_id, risk_rating_id)

begin
  # Get customer risk rating
  data, status_code, headers = api_instance.get_customer_risk_rating_with_http_info(customer_id, risk_rating_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RiskRating>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->get_customer_risk_rating_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
customer_id	String	The customer's unique identifier
risk_rating_id	String	Risk Rating ID

Return type

RiskRating

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/problem+json

get_party_employment

get_party_employment(customer_id, employment_id)

Get customer employment record

Get a single record of customer employment

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::CustomersApi.new
customer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The customer's unique identifier
employment_id = '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | Unique ID for the employment record.

begin
  # Get customer employment record
  result = api_instance.get_party_employment(customer_id, employment_id)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->get_party_employment: #{e}"
end

Using the get_party_employment_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> get_party_employment_with_http_info(customer_id, employment_id)

begin
  # Get customer employment record
  data, status_code, headers = api_instance.get_party_employment_with_http_info(customer_id, employment_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Employment>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->get_party_employment_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
customer_id	String	The customer's unique identifier
employment_id	String	Unique ID for the employment record.

Return type

Employment

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/problem+json

list_customers

list_customers(opts)

List Customers

Retrieves paginated list of Customers associated with the authorized requester

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::CustomersApi.new
opts = {
  id: ['7d943c51-e4ff-4e57-9558-08cab6b963c7'], # Array<String> | Unique resource identifier
  first_name: 'Alice', # String | 
  last_name: 'Smith', # String | 
  phone_number: '+12065550100', # String | 
  email: '[email protected]', # String | 
  ssn_last_4: '6789', # String | 
  status: 'ACTIVE', # String | 
  limit: 100, # Integer | 
  page_token: 'a8937a0d', # String | 
  sort_by: ['creation_time:asc'], # Array<String> | Specifies the sort order for the returned customers. 
  has_accounts: true # Boolean | Filter on resources that have an account(s) 
}

begin
  # List Customers
  result = api_instance.list_customers(opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->list_customers: #{e}"
end

Using the list_customers_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> list_customers_with_http_info(opts)

begin
  # List Customers
  data, status_code, headers = api_instance.list_customers_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomerList>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->list_customers_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Array<String>	Unique resource identifier	[optional]
first_name	String		[optional]
last_name	String		[optional]
phone_number	String		[optional]
email	String		[optional]
ssn_last_4	String		[optional]
status	String		[optional]
limit	Integer		[optional][default to 100]
page_token	String		[optional]
sort_by	Array<String>	Specifies the sort order for the returned customers.	[optional]
has_accounts	Boolean	Filter on resources that have an account(s)	[optional]

Return type

CustomerList

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/problem+json

patch_customer

patch_customer(customer_id, patch_customer, opts)

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.

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::CustomersApi.new
customer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The customer's unique identifier
patch_customer = SyncteraRubySdk::PatchCustomer.new # PatchCustomer | Customer to be patched
opts = {
  idempotency_key: '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | 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.
}

begin
  # Patch Customer
  result = api_instance.patch_customer(customer_id, patch_customer, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->patch_customer: #{e}"
end

Using the patch_customer_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> patch_customer_with_http_info(customer_id, patch_customer, opts)

begin
  # Patch Customer
  data, status_code, headers = api_instance.patch_customer_with_http_info(customer_id, patch_customer, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomerInBody>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->patch_customer_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
customer_id	String	The customer's unique identifier
patch_customer	PatchCustomer	Customer to be patched
idempotency_key	String	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.	[optional]

Return type

CustomerInBody

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json, application/problem+json

update_customer

update_customer(customer_id, customer_in_body)

Update Customer

Update customer based on ID Note that if no shipping_address attribute is provided in the request, the shipping_address will be set to a copy of the legal_address.

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::CustomersApi.new
customer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The customer's unique identifier
customer_in_body = SyncteraRubySdk::Customer.new({status: 'ACTIVE'}) # CustomerInBody | Customer to be updated

begin
  # Update Customer
  result = api_instance.update_customer(customer_id, customer_in_body)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->update_customer: #{e}"
end

Using the update_customer_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> update_customer_with_http_info(customer_id, customer_in_body)

begin
  # Update Customer
  data, status_code, headers = api_instance.update_customer_with_http_info(customer_id, customer_in_body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CustomerInBody>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->update_customer_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
customer_id	String	The customer's unique identifier
customer_in_body	CustomerInBody	Customer to be updated

Return type

CustomerInBody

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json, application/problem+json

update_party_employment

update_party_employment(customer_id, employment_id, employment)

Update customer employment record

Update a single record of customer employment.

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::CustomersApi.new
customer_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The customer's unique identifier
employment_id = '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | Unique ID for the employment record.
employment = SyncteraRubySdk::Employment.new({employer_name: 'ABC, Inc.'}) # Employment | Customer employment to update.

begin
  # Update customer employment record
  result = api_instance.update_party_employment(customer_id, employment_id, employment)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->update_party_employment: #{e}"
end

Using the update_party_employment_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> update_party_employment_with_http_info(customer_id, employment_id, employment)

begin
  # Update customer employment record
  data, status_code, headers = api_instance.update_party_employment_with_http_info(customer_id, employment_id, employment)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Employment>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling CustomersApi->update_party_employment_with_http_info: #{e}"
end

Parameters

Name	Type	Description
customer_id	String	The customer's unique identifier
employment_id	String	Unique ID for the employment record.
employment	Employment	Customer employment to update.

Return type

Employment

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json, application/problem+json