Initiate onramp verification
Initiates OTP verification by sending a 6-digit code to the user via the specified channel (SMS or email). Returns a verificationId that must be passed to the Submit Onramp Verification endpoint along with the OTP code within 10 minutes.
Access to this API requires allowlisting. During Onramp Headless API onboarding, contact the Onramp team to enable Onramp-managed verification for your application.
Authorizations
A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Generate Bearer Token section of our Authentication docs for information on how to generate your Bearer Token.
Headers
An optional string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our Idempotency docs for more information on using idempotency keys.
1 - 128Body
Response
Successfully initiated onramp verification.
The result of initiating an onramp OTP verification.
Identifier returned by this endpoint. Pass to the Submit Onramp Verification endpoint along with the OTP code within 10 minutes.
^onramp_verification_[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$"onramp_verification_a1b2c3d4-e5f6-7890-abcd-ef1234567890"
The deadline for submitting the OTP code (10 minutes from now).
"2025-04-24T00:10:00Z"