Skip to main content
POST
Request limit upgrade

Authorizations

Authorization
string
header
required

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

application/json

Request to request a limits upgrade for a user.

userId
string
required

The user identifier value. For phone_number type, this must be in E.164 format.

Example:

"+12055555555"

userIdType
enum<string>
required

The type of user identifier:

  • phone_number: A phone number in E.164 format associated with an onramp user.
Available options:
phone_number
Example:

"phone_number"

interactionMode
enum<string>
default:api

The interaction mode for the limit upgrade request. Defaults to api.

Available options:
api,
embedded
Example:

"api"

fields
object

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.

Example:

Response

Embedded limit upgrade URL created.

A Coinbase-hosted URL for collecting limit upgrade identity fields.

upgradeUrl
string<uri>
required

The Coinbase-hosted URL where the user enters identity information for the limit upgrade. Treat the session token in this URL as opaque.

Required string length: 11 - 2048
Pattern: ^https?://.*$
Example:

"https://pay.coinbase.com/v2/api-onramp/upgrade-limits?sessionToken=MWYwNWQwODktZTZlYy02OTdlLTgzZTYtMTI3NzcyOWJhNjM3"

expiresAt
string<date-time>
required

The time at which the hosted limit upgrade URL expires. Request a new upgrade URL after this time.

Example:

"2026-06-21T00:05:00Z"