Skip to content

Latest commit

 

History

History
233 lines (167 loc) · 7.35 KB

DisclosuresApi.md

File metadata and controls

233 lines (167 loc) · 7.35 KB

Synctera::DisclosuresApi

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

Method HTTP request Description
create_disclosure POST /disclosures Create disclosure record
get_disclosure GET /disclosures/{disclosure_id} Get disclosure
list_disclosures GET /disclosures List disclosures

create_disclosure

create_disclosure(disclosure, opts)

Create disclosure record

Record the fact that a regulatory document was disclosed to a customer.

Examples

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

api_instance = Synctera::DisclosuresApi.new
disclosure = Synctera::Disclosure.new({disclosure_date: Time.parse('2010-05-06T12:23:34.321Z'), event_type: 'ACKNOWLEDGED', type: Synctera::DisclosureType::ACH_AUTHORIZATION, version: '1.0'}) # Disclosure | Disclosure 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 disclosure record
  result = api_instance.create_disclosure(disclosure, opts)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling DisclosuresApi->create_disclosure: #{e}"
end

Using the create_disclosure_with_http_info variant

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

<Array(, Integer, Hash)> create_disclosure_with_http_info(disclosure, opts)

begin
  # Create disclosure record
  data, status_code, headers = api_instance.create_disclosure_with_http_info(disclosure, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Disclosure>
rescue Synctera::ApiError => e
  puts "Error when calling DisclosuresApi->create_disclosure_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
disclosure Disclosure Disclosure 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

Disclosure

Authorization

bearerAuth

HTTP request headers

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

get_disclosure

get_disclosure(disclosure_id)

Get disclosure

Get disclosure by ID.

Examples

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

api_instance = Synctera::DisclosuresApi.new
disclosure_id = '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | The unique identifier for the disclosure.

begin
  # Get disclosure
  result = api_instance.get_disclosure(disclosure_id)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling DisclosuresApi->get_disclosure: #{e}"
end

Using the get_disclosure_with_http_info variant

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

<Array(, Integer, Hash)> get_disclosure_with_http_info(disclosure_id)

begin
  # Get disclosure
  data, status_code, headers = api_instance.get_disclosure_with_http_info(disclosure_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Disclosure>
rescue Synctera::ApiError => e
  puts "Error when calling DisclosuresApi->get_disclosure_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
disclosure_id String The unique identifier for the disclosure.

Return type

Disclosure

Authorization

bearerAuth

HTTP request headers

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

list_disclosures

list_disclosures(opts)

List disclosures

Retrieves paginated list of disclosures associated with the authorized requester.

Examples

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

api_instance = Synctera::DisclosuresApi.new
opts = {
  business_id: ['inner_example'], # Array<String> | Unique identifier for the business. Multiple IDs can be provided as a comma-separated list. 
  page_token: 'a8937a0d', # String | 
  id: ['7d943c51-e4ff-4e57-9558-08cab6b963c7'], # Array<String> | Unique resource identifier
  person_id: ['inner_example'], # Array<String> | Unique identifier for the person. Multiple IDs can be provided as a comma-separated list. 
  acknowledging_person_id: ['inner_example'], # Array<String> | Return only disclosures that have the specified acknowledging_person_id. Multiple IDs can be provided as a comma-separated list. 
  limit: 100 # Integer | 
}

begin
  # List disclosures
  result = api_instance.list_disclosures(opts)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling DisclosuresApi->list_disclosures: #{e}"
end

Using the list_disclosures_with_http_info variant

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

<Array(, Integer, Hash)> list_disclosures_with_http_info(opts)

begin
  # List disclosures
  data, status_code, headers = api_instance.list_disclosures_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DisclosureList>
rescue Synctera::ApiError => e
  puts "Error when calling DisclosuresApi->list_disclosures_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
business_id Array<String> Unique identifier for the business. Multiple IDs can be provided as a comma-separated list. [optional]
page_token String [optional]
id Array<String> Unique resource identifier [optional]
person_id Array<String> Unique identifier for the person. Multiple IDs can be provided as a comma-separated list. [optional]
acknowledging_person_id Array<String> Return only disclosures that have the specified acknowledging_person_id. Multiple IDs can be provided as a comma-separated list. [optional]
limit Integer [optional][default to 100]

Return type

DisclosureList

Authorization

bearerAuth

HTTP request headers

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