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

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.

Options

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

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

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

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

Create employment record — Create a customer employment record.

Options

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

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

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

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

Create customer risk rating — Create customer risk rating

Options

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

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

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

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

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

Options

Query options: :include_history

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

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

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

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

List customer risk ratings — Get list of customer risk ratings

Options

Query options: :include_history

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

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

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

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

Get Customer — Get Customer based on ID

Options

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

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

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

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

Get customer risk rating — Get a customer risk rating

Options

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

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

Like get_customer_risk_rating/4 but returns the value directly and raises on error.

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

Get customer employment record — Get a single record of customer employment

Options

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

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

Like get_party_employment/4 but returns the value directly and raises on error.

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

List Customers — Retrieves paginated list of Customers associated with the authorized requester

Options

Query options: :id, :first_name, :last_name, :phone_number, :email, :ssn_last_4, :status, :limit, :page_token, :sort_by

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

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

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

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

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.

Options

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

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

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

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

Prefill customer — Prefill takes a subset of a person's information and automatically fills personally identifiable information (PII) required for know your customer (KYC) verification.

Options

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

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

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

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

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.

Options

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

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

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

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

Update customer employment record — Update a single record of customer employment.

Options

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

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

Like update_party_employment/4 but returns the value directly and raises on error.