Skip to content

CreatePhoneNumberKycLinkRequest.md

Latest commit

 

History

History
26 lines (20 loc) · 1.14 KB

CreatePhoneNumberKycLinkRequest.md

File metadata and controls

26 lines (20 loc) · 1.14 KB
Raw

Zernio::CreatePhoneNumberKycLinkRequest

Properties

Name Type Description Notes
profile_id String
country String ISO 3166-1 alpha-2 country code (must be a regulated/KYC country).
area_code String Area code (NDC) the eventual number must be in. Hard constraint carried by the link; the end customer filling the form makes no area choice. Options come from GET /v1/phone-numbers/availability (areaOptions). [optional]
branding CreatePhoneNumberKycLinkRequestBranding [optional]
redirect_url String Where to send the end customer's browser after a successful submit. On completion Zernio appends `kyc=submitted` and `country=<ISO-2>` as query params. When omitted, the hosted page shows a built-in confirmation screen instead. [optional]

Example

require 'zernio-sdk'

instance = Zernio::CreatePhoneNumberKycLinkRequest.new(
  profile_id: null,
  country: null,
  area_code: null,
  branding: null,
  redirect_url: null
)