Synctera 'KYC Verification' 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 customer verification result — Create a verification result for a customer. This
endpoint will be removed in API v1. Use POST /v0/verifications instead.
Like create_customer_verification_result/3 but returns the value directly and raises on error.
Get verification result — Get verification result by ID. This endpoint will be removed in API
v1. Use GET /v0/verifications/{verification_id} instead.
Like get_verification/4 but returns the value directly and raises on error.
List verification results — List verification results. This endpoint will be removed in API v1.
Use GET /v0/verifications?customer_id={customer_id} instead.
Like list_verifications/3 but returns the value directly and raises on error.
Verify a customer's identity — Initiate identity verification for a customer 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 This endpoint will be removed in API v1. Use POST /v0/verifications/verify instead.
Like verify_customer/3 but returns the value directly and raises on error.
Functions
@spec create_customer_verification_result(Synctera.Client.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Create a customer verification result — Create a verification result for a customer. This
endpoint will be removed in API v1. Use POST /v0/verifications instead.
Options
:body— request body (map), required.:idempotency_key— seeSynctera.Idempotency.:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec create_customer_verification_result!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like create_customer_verification_result/3 but returns the value directly and raises on error.
@spec get_verification(Synctera.Client.t(), String.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Get verification result — Get verification result by ID. This endpoint will be removed in API
v1. Use GET /v0/verifications/{verification_id} instead.
Options
:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec get_verification!(Synctera.Client.t(), String.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like get_verification/4 but returns the value directly and raises on error.
@spec list_verifications(Synctera.Client.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
List verification results — List verification results. This endpoint will be removed in API v1.
Use GET /v0/verifications?customer_id={customer_id} instead.
Options
Query options: :include_history, :limit, :page_token
:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec list_verifications!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like list_verifications/3 but returns the value directly and raises on error.
@spec verify_customer(Synctera.Client.t(), String.t(), keyword()) :: {:ok, Synctera.JSON.json()} | {:error, Synctera.Error.t()}
Verify a customer's identity — Initiate identity verification for a customer 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 This endpoint will be removed in API v1. Use POST /v0/verifications/verify instead.
Options
:body— request body (map), required.:idempotency_key— seeSynctera.Idempotency.:device_info— a%Synctera.DeviceInfo{}overriding the client default.
@spec verify_customer!(Synctera.Client.t(), String.t(), keyword()) :: Synctera.JSON.json()
Like verify_customer/3 but returns the value directly and raises on error.