Skip to main content
Package: com.coinbase.cdp.resources.enduseraccountmanagement

Constructor Details

EndUserAccountManagementClient

Parameters: clientOptions - ClientOptions

Method Details

withRawResponse

Get responses with HTTP metadata like headers Returns: WithRawResponseEndUserAccountManagementClient

listEndUsers

Overload 1
Lists the end users belonging to the developer’s CDP Project. By default, the response is sorted by creation date in ascending order and paginated to 20 users per page. Returns: ListEndUsersResponse Overload 2
Lists the end users belonging to the developer’s CDP Project. By default, the response is sorted by creation date in ascending order and paginated to 20 users per page. Parameters: request - ListEndUsersRequest Returns: ListEndUsersResponse Overload 3
Lists the end users belonging to the developer’s CDP Project. By default, the response is sorted by creation date in ascending order and paginated to 20 users per page. Parameters: requestOptions - RequestOptions Returns: ListEndUsersResponse Overload 4
Lists the end users belonging to the developer’s CDP Project. By default, the response is sorted by creation date in ascending order and paginated to 20 users per page. Parameters: request - ListEndUsersRequest requestOptions - RequestOptions Returns: ListEndUsersResponse

createEndUser

Overload 1
Creates an end user. An end user is an entity that can own CDP EVM accounts, EVM smart accounts, and/or Solana accounts. 1 or more authentication methods must be associated with an end user. By default, no accounts are created unless the optional evmAccount and/or solanaAccount fields are provided. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: request - CreateEndUserRequest Returns: EndUser Overload 2
Creates an end user. An end user is an entity that can own CDP EVM accounts, EVM smart accounts, and/or Solana accounts. 1 or more authentication methods must be associated with an end user. By default, no accounts are created unless the optional evmAccount and/or solanaAccount fields are provided. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: request - CreateEndUserRequest requestOptions - RequestOptions Returns: EndUser

validateEndUserAccessToken

Overload 1
Validates the end user’s access token and returns the end user’s information. Returns an error if the access token is invalid or expired. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: request - ValidateEndUserAccessTokenRequest Returns: EndUser Overload 2
Validates the end user’s access token and returns the end user’s information. Returns an error if the access token is invalid or expired. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: request - ValidateEndUserAccessTokenRequest requestOptions - RequestOptions Returns: EndUser

getEndUser

Overload 1
Gets an end user by ID. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: userId - String Returns: EndUser Overload 2
Gets an end user by ID. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: userId - String request - GetEndUserRequest Returns: EndUser Overload 3
Gets an end user by ID. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: userId - String requestOptions - RequestOptions Returns: EndUser Overload 4
Gets an end user by ID. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: userId - String request - GetEndUserRequest requestOptions - RequestOptions Returns: EndUser

lookupEndUser

Overload 1
Looks up end users. Exactly one lookup type must be provided per request: email: searches across all email-based authentication methods (email, Google, Apple, GitHub). May return multiple end users if the same email address appears across different auth methods. oauthProvider + oauthSubject: looks up a user by their OAuth provider and subject (the sub claim from the provider’s ID token). Both params must be provided together. phoneNumber: looks up a user by their SMS-verified phone number. siweAddress: looks up a user by the Ethereum address they authenticated with via Sign In With Ethereum (EIP-4361). Returns all matching end users. If no end users match, an empty array is returned. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Returns: LookupEndUserResponse Overload 2
Looks up end users. Exactly one lookup type must be provided per request: email: searches across all email-based authentication methods (email, Google, Apple, GitHub). May return multiple end users if the same email address appears across different auth methods. oauthProvider + oauthSubject: looks up a user by their OAuth provider and subject (the sub claim from the provider’s ID token). Both params must be provided together. phoneNumber: looks up a user by their SMS-verified phone number. siweAddress: looks up a user by the Ethereum address they authenticated with via Sign In With Ethereum (EIP-4361). Returns all matching end users. If no end users match, an empty array is returned. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: request - LookupEndUserRequest Returns: LookupEndUserResponse Overload 3
Looks up end users. Exactly one lookup type must be provided per request: email: searches across all email-based authentication methods (email, Google, Apple, GitHub). May return multiple end users if the same email address appears across different auth methods. oauthProvider + oauthSubject: looks up a user by their OAuth provider and subject (the sub claim from the provider’s ID token). Both params must be provided together. phoneNumber: looks up a user by their SMS-verified phone number. siweAddress: looks up a user by the Ethereum address they authenticated with via Sign In With Ethereum (EIP-4361). Returns all matching end users. If no end users match, an empty array is returned. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: requestOptions - RequestOptions Returns: LookupEndUserResponse Overload 4
Looks up end users. Exactly one lookup type must be provided per request: email: searches across all email-based authentication methods (email, Google, Apple, GitHub). May return multiple end users if the same email address appears across different auth methods. oauthProvider + oauthSubject: looks up a user by their OAuth provider and subject (the sub claim from the provider’s ID token). Both params must be provided together. phoneNumber: looks up a user by their SMS-verified phone number. siweAddress: looks up a user by the Ethereum address they authenticated with via Sign In With Ethereum (EIP-4361). Returns all matching end users. If no end users match, an empty array is returned. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: request - LookupEndUserRequest requestOptions - RequestOptions Returns: LookupEndUserResponse

addEndUserEvmAccount

Overload 1
Adds a new EVM EOA account to an existing end user. End users can have up to 10 EVM accounts. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: userId - String request - AddEndUserEvmAccountRequest Returns: AddEndUserEvmAccountResponse Overload 2
Adds a new EVM EOA account to an existing end user. End users can have up to 10 EVM accounts. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: userId - String body - Map<String,Object> Returns: AddEndUserEvmAccountResponse Overload 3
Adds a new EVM EOA account to an existing end user. End users can have up to 10 EVM accounts. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: userId - String request - AddEndUserEvmAccountRequest requestOptions - RequestOptions Returns: AddEndUserEvmAccountResponse Overload 4
Adds a new EVM EOA account to an existing end user. End users can have up to 10 EVM accounts. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: userId - String body - Map<String,Object> requestOptions - RequestOptions Returns: AddEndUserEvmAccountResponse

addEndUserEvmSmartAccount

Overload 1
Creates an EVM smart account for an existing end user. The backend will create a new EVM EOA account to serve as the owner of the smart account. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: userId - String Returns: AddEndUserEvmSmartAccountResponse Overload 2
Creates an EVM smart account for an existing end user. The backend will create a new EVM EOA account to serve as the owner of the smart account. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: userId - String request - AddEndUserEvmSmartAccountRequest Returns: AddEndUserEvmSmartAccountResponse Overload 3
Creates an EVM smart account for an existing end user. The backend will create a new EVM EOA account to serve as the owner of the smart account. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: userId - String requestOptions - RequestOptions Returns: AddEndUserEvmSmartAccountResponse Overload 4
Creates an EVM smart account for an existing end user. The backend will create a new EVM EOA account to serve as the owner of the smart account. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: userId - String request - AddEndUserEvmSmartAccountRequest requestOptions - RequestOptions Returns: AddEndUserEvmSmartAccountResponse

addEndUserSolanaAccount

Overload 1
Adds a new Solana account to an existing end user. End users can have up to 10 Solana accounts. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: userId - String request - AddEndUserSolanaAccountRequest Returns: AddEndUserSolanaAccountResponse Overload 2
Adds a new Solana account to an existing end user. End users can have up to 10 Solana accounts. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: userId - String body - Map<String,Object> Returns: AddEndUserSolanaAccountResponse Overload 3
Adds a new Solana account to an existing end user. End users can have up to 10 Solana accounts. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: userId - String request - AddEndUserSolanaAccountRequest requestOptions - RequestOptions Returns: AddEndUserSolanaAccountResponse Overload 4
Adds a new Solana account to an existing end user. End users can have up to 10 Solana accounts. This API is intended to be used by the developer’s own backend, and is authenticated using the developer’s CDP API key. Parameters: userId - String body - Map<String,Object> requestOptions - RequestOptions Returns: AddEndUserSolanaAccountResponse

importEndUser

Overload 1
Imports an existing private key for an end user into the developer’s CDP Project. The private key must be encrypted using the CDP SDK’s encryption scheme before being sent to this endpoint. This API should be called from the CDP SDK to ensure that the associated private key is properly encrypted. This endpoint allows developers to import existing keys for their end users, supporting both EVM and Solana key types. The end user must have at least one authentication method configured. Parameters: request - ImportEndUserRequest Returns: EndUser Overload 2
Imports an existing private key for an end user into the developer’s CDP Project. The private key must be encrypted using the CDP SDK’s encryption scheme before being sent to this endpoint. This API should be called from the CDP SDK to ensure that the associated private key is properly encrypted. This endpoint allows developers to import existing keys for their end users, supporting both EVM and Solana key types. The end user must have at least one authentication method configured. Parameters: request - ImportEndUserRequest requestOptions - RequestOptions Returns: EndUser