TruelayerClient.SignupPlus (truelayer_client v1.0.0)

Copy Markdown View Source

TrueLayer Signup+ API — collect verified user data embedded in a payment or auth flow.

Signup+ lets you request verified identity data (name, email, address, DOB) as part of an existing payment or mandate authorization, without a separate identity verification step.

Summary

Functions

Generate a Signup+ authorization URI (POST /signup-plus/auth-uri).

Get user data via a Data API connected account (GET /signup-plus/data/v1/connected-accounts/{id}).

Get user data associated with a mandate (GET /signup-plus/data/v1/mandates/{id}).

Get verified user data associated with a payment (GET /signup-plus/data/v1/payments/{id}).

Functions

generate_auth_uri(client, params)

@spec generate_auth_uri(TruelayerClient.t(), map()) ::
  {:ok, map()} | {:error, TruelayerClient.Error.t()}

Generate a Signup+ authorization URI (POST /signup-plus/auth-uri).

get_user_data_by_connected_account(client, account_id)

@spec get_user_data_by_connected_account(TruelayerClient.t(), String.t()) ::
  {:ok, map()} | {:error, TruelayerClient.Error.t()}

Get user data via a Data API connected account (GET /signup-plus/data/v1/connected-accounts/{id}).

get_user_data_by_mandate(client, mandate_id)

@spec get_user_data_by_mandate(TruelayerClient.t(), String.t()) ::
  {:ok, map()} | {:error, TruelayerClient.Error.t()}

Get user data associated with a mandate (GET /signup-plus/data/v1/mandates/{id}).

get_user_data_by_payment(client, payment_id)

@spec get_user_data_by_payment(TruelayerClient.t(), String.t()) ::
  {:ok, map()} | {:error, TruelayerClient.Error.t()}

Get verified user data associated with a payment (GET /signup-plus/data/v1/payments/{id}).