Synctera::KYCKYBVerificationsApi

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

Method	HTTP request	Description
create_verification	POST /verifications	Create a verification
get_verification1	GET /verifications/{verification_id}	Get verification
list_verifications1	GET /verifications	List verifications
verify	POST /verifications/verify	Verify a customer's identity
verify_ad_hoc	POST /verifications/adhoc	Check if an individual is on any watchlists

create_verification

create_verification(verification, opts)

Create a verification

Upload evidence of an externally performed KYC/KYB. You may use your own KYC/KYB provider and upload evidence of those results instead of using one of Synctera's providers. Verifying a personal customer requires that the following fields already be set: * first_name * last_name * dob * email or phone_number * legal_address * shippings_address * ssn or at least one other identifier in personal_ids Verifying a business customer requires that the following fields already be set: * entity_name * legal_address * email or phone_number * ein not required for sole proprietorships Please refer to https://learn.synctera.com/docs/using-your-own-kyc-vendor for more details using external KYC/KYB.

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::KYCKYBVerificationsApi.new
verification = Synctera::Verification.new({result: Synctera::VerificationResult::ACCEPTED, verification_time: Time.now, verification_type: Synctera::VerificationType::DOCUMENT_VERIFICATION}) # Verification | Verification result 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 verification
  result = api_instance.create_verification(verification, opts)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling KYCKYBVerificationsApi->create_verification: #{e}"
end

Using the create_verification_with_http_info variant

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

<Array(, Integer, Hash)> create_verification_with_http_info(verification, opts)

begin
  # Create a verification
  data, status_code, headers = api_instance.create_verification_with_http_info(verification, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Verification>
rescue Synctera::ApiError => e
  puts "Error when calling KYCKYBVerificationsApi->create_verification_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
verification	Verification	Verification result 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

Verification

Authorization

bearerAuth

HTTP request headers

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

get_verification1

get_verification1(verification_id)

Get verification

Get customer verification result.

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::KYCKYBVerificationsApi.new
verification_id = '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | Verification's unique identifier.

begin
  # Get verification
  result = api_instance.get_verification1(verification_id)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling KYCKYBVerificationsApi->get_verification1: #{e}"
end

Using the get_verification1_with_http_info variant

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

<Array(, Integer, Hash)> get_verification1_with_http_info(verification_id)

begin
  # Get verification
  data, status_code, headers = api_instance.get_verification1_with_http_info(verification_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Verification>
rescue Synctera::ApiError => e
  puts "Error when calling KYCKYBVerificationsApi->get_verification1_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
verification_id	String	Verification's unique identifier.

Return type

Verification

Authorization

bearerAuth

HTTP request headers

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

list_verifications1

list_verifications1(opts)

List verifications

List customer verification results.

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::KYCKYBVerificationsApi.new
opts = {
  id: ['inner_example'], # Array<String> | Unique identifier for the resource. Multiple IDs can be provided as a comma-separated list. 
  verification_type: [Synctera::VerificationType::DOCUMENT_VERIFICATION], # Array<VerificationType> | The type of verification run. Multiple values can be provided as a comma-separated list. 
  business_id: ['inner_example'], # Array<String> | Unique identifier for the business. Multiple IDs can be provided as a comma-separated list. 
  include_history: true, # Boolean | If true, include old (inactive) records as well.
  page_token: 'a8937a0d', # String | 
  result: [Synctera::VerificationResult::ACCEPTED], # Array<VerificationResult> | The result of the verification that was run on the party. Multiple values can be provided as a comma-separated list. 
  person_id: ['inner_example'], # Array<String> | Unique identifier for the person. Multiple IDs can be provided as a comma-separated list. 
  limit: 100 # Integer | 
}

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

Using the list_verifications1_with_http_info variant

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

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

begin
  # List verifications
  data, status_code, headers = api_instance.list_verifications1_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <VerificationList>
rescue Synctera::ApiError => e
  puts "Error when calling KYCKYBVerificationsApi->list_verifications1_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]
verification_type	Array<VerificationType>	The type of verification run. Multiple values can be provided as a comma-separated list.	[optional]
business_id	Array<String>	Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.	[optional]
include_history	Boolean	If true, include old (inactive) records as well.	[optional][default to false]
page_token	String		[optional]
result	Array<VerificationResult>	The result of the verification that was run on the party. Multiple values can be provided as a comma-separated list.	[optional]
person_id	Array<String>	Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.	[optional]
limit	Integer		[optional][default to 100]

Return type

VerificationList

Authorization

bearerAuth

HTTP request headers

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

verify

verify(verification_request, opts)

Verify a customer's identity

Initiate identity verification and run the specified identity checks. Verifying a personal customer requires that the following fields already be set: * first_name * last_name * dob * email * phone_number * legal_address * ssn Verifying a business customer requires that the following fields already be set: * entity_name * legal_address

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::KYCKYBVerificationsApi.new
verification_request = Synctera::VerificationRequest.new({customer_consent: false}) # VerificationRequest | 
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
  # Verify a customer's identity
  result = api_instance.verify(verification_request, opts)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling KYCKYBVerificationsApi->verify: #{e}"
end

Using the verify_with_http_info variant

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

<Array(, Integer, Hash)> verify_with_http_info(verification_request, opts)

begin
  # Verify a customer's identity
  data, status_code, headers = api_instance.verify_with_http_info(verification_request, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <VerifyResponse>
rescue Synctera::ApiError => e
  puts "Error when calling KYCKYBVerificationsApi->verify_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
verification_request	VerificationRequest
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

VerifyResponse

Authorization

bearerAuth

HTTP request headers

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

verify_ad_hoc

verify_ad_hoc(adhoc_verification_request, opts)

Check if an individual is on any watchlists

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::KYCKYBVerificationsApi.new
adhoc_verification_request = Synctera::AdhocVerificationRequest.new({payee_id: 'payee_id_example', payer_id: 'payer_id_example'}) # AdhocVerificationRequest | 
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
  # Check if an individual is on any watchlists
  result = api_instance.verify_ad_hoc(adhoc_verification_request, opts)
  p result
rescue Synctera::ApiError => e
  puts "Error when calling KYCKYBVerificationsApi->verify_ad_hoc: #{e}"
end

Using the verify_ad_hoc_with_http_info variant

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

<Array(, Integer, Hash)> verify_ad_hoc_with_http_info(adhoc_verification_request, opts)

begin
  # Check if an individual is on any watchlists
  data, status_code, headers = api_instance.verify_ad_hoc_with_http_info(adhoc_verification_request, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AdhocVerificationResponse>
rescue Synctera::ApiError => e
  puts "Error when calling KYCKYBVerificationsApi->verify_ad_hoc_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
adhoc_verification_request	AdhocVerificationRequest
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

AdhocVerificationResponse

Authorization

bearerAuth

HTTP request headers

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

Files

KYCKYBVerificationsApi.md

Latest commit

History

KYCKYBVerificationsApi.md

File metadata and controls

Synctera::KYCKYBVerificationsApi

create_verification

Examples

Using the create_verification_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_verification1

Examples

Using the get_verification1_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

list_verifications1

Examples

Using the list_verifications1_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

verify

Examples

Using the verify_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

verify_ad_hoc

Examples

Using the verify_ad_hoc_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers