SyncteraRubySdk::PersonsApi

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

Method	HTTP request	Description
create_person	POST /persons	Create a person
create_personal_id	POST /persons/personal_ids	Create a personal identifier (beta)
delete_personal_id	DELETE /persons/personal_ids/personal_id_id	Delete a personal identifier (beta)
get_person	GET /persons/person_id	Get person
list_persons	GET /persons	List persons
update_person	PATCH /persons/person_id	Update person
update_personal_id	PATCH /persons/personal_ids/personal_id_id	Update a personal identifier (beta)

create_person

create_person(post_person, opts)

Create a person

Create a person who may act as a personal customer or a director/officer/owner of a business. You can then verify the identity of this customer and associate them with other people and accounts.

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::PersonsApi.new
post_person = SyncteraRubySdk::PostPerson.new({is_customer: true, status: SyncteraRubySdk::Status2::ACTIVE}) # PostPerson | 
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 person
  result = api_instance.create_person(post_person, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling PersonsApi->create_person: #{e}"
end

Using the create_person_with_http_info variant

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

, Integer, Hash)> create_person_with_http_info(post_person, opts)

begin
  # Create a person
  data, status_code, headers = api_instance.create_person_with_http_info(post_person, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ResponsePerson>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling PersonsApi->create_person_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
post_person	PostPerson
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

ResponsePerson

Authorization

bearerAuth

HTTP request headers

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

create_personal_id

create_personal_id(post_personal_id_w_cust, opts)

Create a personal identifier (beta)

🚧 Beta > This is an Beta endpoint. Feedback from the community is welcome. We may make breaking changes to this endpoint. Create a personal identifier, e.g. SSN, for this customer

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::PersonsApi.new
post_personal_id_w_cust = SyncteraRubySdk::PostPersonalIdWCust.new({id_type: SyncteraRubySdk::PersonalIdType::ITIN, identifier: '123-45-6789', customer_id: '21943c51-e4ff-4e57-9558-08cab6b963fe'}) # PostPersonalIdWCust | 
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 personal identifier (beta)
  result = api_instance.create_personal_id(post_personal_id_w_cust, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling PersonsApi->create_personal_id: #{e}"
end

Using the create_personal_id_with_http_info variant

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

, Integer, Hash)> create_personal_id_with_http_info(post_personal_id_w_cust, opts)

begin
  # Create a personal identifier (beta)
  data, status_code, headers = api_instance.create_personal_id_with_http_info(post_personal_id_w_cust, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ResponsePersonalIdWCust>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling PersonsApi->create_personal_id_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
post_personal_id_w_cust	PostPersonalIdWCust
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

ResponsePersonalIdWCust

Authorization

bearerAuth

HTTP request headers

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

delete_personal_id

delete_personal_id(personal_id_id)

Delete a personal identifier (beta)

🚧 Beta > This is a Beta endpoint. Feedback from the community is welcome. We may make breaking changes to this endpoint. Delete personal identifier

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::PersonsApi.new
personal_id_id = '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | UUID for a personal identifier.

begin
  # Delete a personal identifier (beta)
  result = api_instance.delete_personal_id(personal_id_id)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling PersonsApi->delete_personal_id: #{e}"
end

Using the delete_personal_id_with_http_info variant

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

, Integer, Hash)> delete_personal_id_with_http_info(personal_id_id)

begin
  # Delete a personal identifier (beta)
  data, status_code, headers = api_instance.delete_personal_id_with_http_info(personal_id_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DeleteResponse>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling PersonsApi->delete_personal_id_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
personal_id_id	String	UUID for a personal identifier.

Return type

DeleteResponse

Authorization

bearerAuth

HTTP request headers

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

get_person

get_person(person_id)

Get person

Get person by 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::PersonsApi.new
person_id = '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | Person's unique identifier.

begin
  # Get person
  result = api_instance.get_person(person_id)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling PersonsApi->get_person: #{e}"
end

Using the get_person_with_http_info variant

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

, Integer, Hash)> get_person_with_http_info(person_id)

begin
  # Get person
  data, status_code, headers = api_instance.get_person_with_http_info(person_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ResponsePerson>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling PersonsApi->get_person_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
person_id	String	Person's unique identifier.

Return type

ResponsePerson

Authorization

bearerAuth

HTTP request headers

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

list_persons

list_persons(opts)

List persons

Retrieves paginated list of persons 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::PersonsApi.new
opts = {
  id: ['inner_example'], # Array<String> | Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list. 
  first_name: 'Alice', # String | 
  last_name: 'Smith', # String | 
  phone_number: '+12065550100', # String | 
  email: 'john.doe@example.com', # String | 
  ssn_last_4: '6789', # String | 
  ban_status: [SyncteraRubySdk::BanStatus::ALLOWED], # Array<BanStatus> | (alpha) Ban status of the person. Multiple values can be provided as a comma-seperated list of the following: * `ALLOWED` – person is not banned or suspended * `SUSPENDED` - person is suspended * `BANNED` – person is banned 
  status: SyncteraRubySdk::Status2::ACTIVE, # Status2 | 
  is_customer: true, # Boolean | If true, show only customers. If false, show non-customer parties.
  limit: 100, # Integer | 
  page_token: 'a8937a0d', # String | 
  sort_by: ['first_name:asc'], # Array<String> | Specifies the sort order for the returned persons. 
  has_accounts: true # Boolean | Filter on resources that have an account(s) 
}

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

Using the list_persons_with_http_info variant

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

, Integer, Hash)> list_persons_with_http_info(opts)

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

Parameters

Name	Type	Description	Notes
id	Array<String>	Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list.	[optional]
first_name	String		[optional]
last_name	String		[optional]
phone_number	String		[optional]
email	String		[optional]
ssn_last_4	String		[optional]
ban_status	Array<BanStatus>	(alpha) Ban status of the person. Multiple values can be provided as a comma-seperated list of the following: * `ALLOWED` – person is not banned or suspended * `SUSPENDED` - person is suspended * `BANNED` – person is banned	[optional]
status	Status2		[optional]
is_customer	Boolean	If true, show only customers. If false, show non-customer parties.	[optional]
limit	Integer		[optional][default to 100]
page_token	String		[optional]
sort_by	Array<String>	Specifies the sort order for the returned persons.	[optional]
has_accounts	Boolean	Filter on resources that have an account(s)	[optional]

Return type

PersonList

Authorization

bearerAuth

HTTP request headers

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

update_person

update_person(person_id, patch_person, opts)

Update person

Update person by 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::PersonsApi.new
person_id = '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | Person's unique identifier.
patch_person = SyncteraRubySdk::PatchPerson.new # PatchPerson | 
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
  # Update person
  result = api_instance.update_person(person_id, patch_person, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling PersonsApi->update_person: #{e}"
end

Using the update_person_with_http_info variant

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

, Integer, Hash)> update_person_with_http_info(person_id, patch_person, opts)

begin
  # Update person
  data, status_code, headers = api_instance.update_person_with_http_info(person_id, patch_person, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ResponsePerson>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling PersonsApi->update_person_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
person_id	String	Person's unique identifier.
patch_person	PatchPerson
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

ResponsePerson

Authorization

bearerAuth

HTTP request headers

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

update_personal_id

update_personal_id(personal_id_id, patch_personal_id, opts)

Update a personal identifier (beta)

🚧 Beta > This is a Beta endpoint. Feedback from the community is welcome. We may make breaking changes to this endpoint. Update a personal identifier, e.g. SSN, for this customer

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::PersonsApi.new
personal_id_id = '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | UUID for a personal identifier.
patch_personal_id = SyncteraRubySdk::PatchPersonalId.new({id_type: SyncteraRubySdk::PersonalIdType::ITIN}) # PatchPersonalId | 
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
  # Update a personal identifier (beta)
  result = api_instance.update_personal_id(personal_id_id, patch_personal_id, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling PersonsApi->update_personal_id: #{e}"
end

Using the update_personal_id_with_http_info variant

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

, Integer, Hash)> update_personal_id_with_http_info(personal_id_id, patch_personal_id, opts)

begin
  # Update a personal identifier (beta)
  data, status_code, headers = api_instance.update_personal_id_with_http_info(personal_id_id, patch_personal_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ResponsePersonalIdWCust>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling PersonsApi->update_personal_id_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
personal_id_id	String	UUID for a personal identifier.
patch_personal_id	PatchPersonalId
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

ResponsePersonalIdWCust

Authorization

bearerAuth

HTTP request headers

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