Synctera.KYCKYBVerifications (Synctera v1.0.0)

Copy Markdown View Source

Synctera 'KYC/KYB Verifications' endpoints.

Code generated by scripts/generate.py from the Synctera OpenAPI spec. Do not edit by hand — re-run mix generate (or python3 scripts/generate.py) to regenerate.

Summary

Functions

Create a verification — Upload evidence of an externally performed KYC/KYB. You may use your own KYC/KYB provider and upload evidence of that result to Synctera instead of using Synctera's providers.

Like create_verification/2 but returns the value directly and raises on error.

Get verification — Get customer verification result.

Like get_verification1/3 but returns the value directly and raises on error.

List verifications — List customer verification results.

Like list_verifications1/2 but returns the value directly and raises on error.

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

Like verify/2 but returns the value directly and raises on error.

Check if an individual is on any watchlists

Like verify_ad_hoc/2 but returns the value directly and raises on error.

Functions

create_verification(client, opts \\ [])

@spec create_verification(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Create a verification — Upload evidence of an externally performed KYC/KYB. You may use your own KYC/KYB provider and upload evidence of that result to Synctera instead of using Synctera's providers.

Options

  • :body — request body (map), required.
  • :idempotency_key — see Synctera.Idempotency.
  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

create_verification!(client, opts)

@spec create_verification!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like create_verification/2 but returns the value directly and raises on error.

get_verification1(client, verification_id, opts \\ [])

@spec get_verification1(Synctera.Client.t(), String.t(), keyword()) ::
  {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Get verification — Get customer verification result.

Options

  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

get_verification1!(client, verification_id, opts)

@spec get_verification1!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

Like get_verification1/3 but returns the value directly and raises on error.

list_verifications1(client, opts \\ [])

@spec list_verifications1(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

List verifications — List customer verification results.

Options

Query options: :id, :person_id, :business_id, :verification_type, :result, :include_history, :limit, :page_token

  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

list_verifications1!(client, opts)

@spec list_verifications1!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like list_verifications1/2 but returns the value directly and raises on error.

verify(client, opts \\ [])

@spec verify(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

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

Options

  • :body — request body (map), required.
  • :idempotency_key — see Synctera.Idempotency.
  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

verify!(client, opts)

@spec verify!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like verify/2 but returns the value directly and raises on error.

verify_ad_hoc(client, opts \\ [])

@spec verify_ad_hoc(
  Synctera.Client.t(),
  keyword()
) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}

Check if an individual is on any watchlists

Options

  • :body — request body (map), required.
  • :idempotency_key — see Synctera.Idempotency.
  • :device_info — a %Synctera.DeviceInfo{} overriding the client default.

verify_ad_hoc!(client, opts)

@spec verify_ad_hoc!(
  Synctera.Client.t(),
  keyword()
) :: Synctera.JSON.json()

Like verify_ad_hoc/2 but returns the value directly and raises on error.