SetuClient.Data.KYC.EKYC (Setu Client v1.0.0)

Copy Markdown View Source

Setu Aadhaar eKYC API client.

Flow

  1. create/2 — initiate request, receive kycURL
  2. Redirect customer to kycURL for Aadhaar OTP verification
  3. Poll get/2 or receive webhook until complete?/1 is true

Status lifecycle: CREATED → KYC_REQUESTED → SUCCESS | ERROR

Setu docs: https://docs.setu.co/data/kyc (eKYC section)

Summary

Functions

complete?(arg1)

Returns true when the eKYC request has completed successfully.

create(cfg, params \\ %{})

Initiates an eKYC request. Redirect the customer to the returned kycURL.

get(cfg, id)

Retrieves status and Aadhaar data. Poll until complete?/1 returns true.

Functions

complete?(arg1)

@spec complete?(map()) :: boolean()

Returns true when the eKYC request has completed successfully.

create(cfg, params \\ %{})

@spec create(SetuClient.Config.t(), map()) ::
  {:ok, map()} | {:error, SetuClient.Error.t()}

Initiates an eKYC request. Redirect the customer to the returned kycURL.

Optional params

  • :webhook_url, :redirection_url

POST /api/ekyc/

get(cfg, id)

@spec get(SetuClient.Config.t(), String.t()) ::
  {:ok, map()} | {:error, SetuClient.Error.t()}

Retrieves status and Aadhaar data. Poll until complete?/1 returns true.

GET /api/ekyc/:id