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

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.

Options

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

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

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

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

Get person — Get person by ID.

Options

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

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

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

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

List persons — Retrieves paginated list of persons associated with the authorized requester.

Options

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

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

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

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

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

Prefill person — 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_person!(Synctera.Client.t(), String.t(), keyword()) ::
  Synctera.JSON.json()

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

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

Update person — Update person by ID.

Options

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

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

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