Request limit upgrade
Requests a limit upgrade for an onramp user. Only phone number is currently supported as a userId.
The default API mode submits identity information directly and returns HTTP 202 when the request is accepted. Embedded mode (interactionMode: embedded) returns a Coinbase-hosted upgradeUrl where the user enters identity information.
The verification process is asynchronous. After calling this endpoint, use the Get Onramp User Limits endpoint to check the status in the limitUpgradeOptions array.
Prerequisites:
- The phone number must have been previously verified by your app via OTP. - Upgrades may not be available until a certain number of successful transactions by the user.
Supported fields:
ssnLast4: Last 4 digits of the Social Security Number (no dashes or spaces).dateOfBirth: Date of birth (day, month, year as zero-padded strings).
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.
Body
Request to request a limits upgrade for a user.
The user identifier value. For phone_number type, this must be in E.164 format.
"+12055555555"
The type of user identifier:
phone_number: A phone number in E.164 format associated with an onramp user.
phone_number "phone_number"
The interaction mode for the limit upgrade request. Defaults to api.
api, embedded "api"
Populate the properties that correspond to the fields array from the user's OnrampLimitUpgradeOption. Required in api mode. Omit in embedded mode — the user enters their identity information on the Coinbase-hosted upgrade page (see interactionMode), so any value sent here is rejected.
Response
Embedded limit upgrade URL created.
A Coinbase-hosted URL for collecting limit upgrade identity fields.
The Coinbase-hosted URL where the user enters identity information for the limit upgrade. Treat the session token in this URL as opaque.
11 - 2048^https?://.*$"https://pay.coinbase.com/v2/api-onramp/upgrade-limits?sessionToken=MWYwNWQwODktZTZlYy02OTdlLTgzZTYtMTI3NzcyOWJhNjM3"
The time at which the hosted limit upgrade URL expires. Request a new upgrade URL after this time.
"2026-06-21T00:05:00Z"