Object

The onboarding links object

Fields

objectstringrequired
user_idstringrequired: Starts with usr_.
kycobjectrequired
kyc.urlstringrequired
kyc.statusstringrequired: KycStatus for the KYC link, TermsStatus for the terms link.
kyc.expires_attimestamprequired
termsobjectrequired
terms.urlstringrequired
terms.statusstringrequired: KycStatus for the KYC link, TermsStatus for the terms link.
terms.expires_attimestamprequired

Example

{
  "object": "onboarding_links",
  "user_id": "usr_01JA8Z2F5G6H7J8K9M0N1P2Q3R",
  "kyc": {
    "url": "https://onboarding.ndeipi.example/kyc/ol_01JA8ZL2ZV5X0G3E1D8C7B6A5Z",
    "status": "not_started",
    "expires_at": "2026-10-23T09:30:00Z"
  },
  "terms": {
    "url": "https://onboarding.ndeipi.example/terms/ol_01JA8ZL2ZV5X0G3E1D8C7B6A5Z",
    "status": "pending",
    "expires_at": "2026-10-23T09:30:00Z"
  }
}