createUserPinWithWalletsNode.js,latest
Go to NPMCreate a challenge for PIN setup and create wallet(s).
Parameters
input
object
Required
Represents the input for creating a challenge for PIN setup and create wallet(s).
option 1:
userId
string
Required
Unique system-generated identifier for the user.
accountType
string
An account can be a Smart Contract Account (SCA) or an Externally Owned Account (EOA). To learn more, see the account types guide. If an account type is not specified during the creation of a wallet, it defaults to EOA (Externally Owned Account). Note that Solana doesn't support Smart Contract Account (SCA).
Allowed valuesEOASCA
blockchains
array of strings
Required
Blockchain(s) the requested wallets will be created on.
Allowed valuesARBARB-SEPOLIAAVAXAVAX-FUJIBASEBASE-SEPOLIAETHETH-SEPOLIAEVMEVM-TESTNETMATICMATIC-AMOYNEARNEAR-TESTNETOPOP-SEPOLIASOLSOL-DEVNETUNIUNI-SEPOLIA
metadata
array of objects
List of metadata fields to associate with the corresponding wallet.
name
string
Name or description associated with the wallet or walletSet.
refId
string
Reference or description used to identify the object.
idempotencyKey
string
The optional idempotency key. An idempotency key is a unique identifier used to identify and handle duplicate requests in order to ensure idempotent behavior, where multiple identical requests have the same effect as a single request.
We will generate one if you do not provide it.
option 2:
userToken
string
Required
The JSON Web Token (JWT) representing the user.
accountType
string
An account can be a Smart Contract Account (SCA) or an Externally Owned Account (EOA). To learn more, see the account types guide. If an account type is not specified during the creation of a wallet, it defaults to EOA (Externally Owned Account). Note that Solana doesn't support Smart Contract Account (SCA).
Allowed valuesEOASCA
blockchains
array of strings
Required
Blockchain(s) the requested wallets will be created on.
Allowed valuesARBARB-SEPOLIAAVAXAVAX-FUJIBASEBASE-SEPOLIAETHETH-SEPOLIAEVMEVM-TESTNETMATICMATIC-AMOYNEARNEAR-TESTNETOPOP-SEPOLIASOLSOL-DEVNETUNIUNI-SEPOLIA
metadata
array of objects
List of metadata fields to associate with the corresponding wallet.
name
string
Name or description associated with the wallet or walletSet.
refId
string
Reference or description used to identify the object.
idempotencyKey
string
The optional idempotency key. An idempotency key is a unique identifier used to identify and handle duplicate requests in order to ensure idempotent behavior, where multiple identical requests have the same effect as a single request.
We will generate one if you do not provide it.
Responses
Example
1const response = await client.createUserPinWithWallets({
2 userToken: 'dummy-user-token',
3 blockchains: ['ETH'],
4})
5console.log(response.data?.challengeId)ResponseChoose an example
1{
2 "data": {
3 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
4 "createDate": "2023-01-01T12:04:05Z",
5 "pinStatus": "ENABLED",
6 "status": "ENABLED",
7 "securityQuestionStatus": "ENABLED",
8 "pinDetails": {
9 "failedAttempts": 0,
10 "lockedDate": "2023-01-01T12:04:05Z",
11 "lockedExpiryDate": "2023-01-01T12:04:05Z",
12 "lastLockOverrideDate": "2023-01-01T12:04:05Z"
13 },
14 "securityQuestionDetails": {
15 "failedAttempts": 0,
16 "lockedDate": "2023-01-01T12:04:05Z",
17 "lockedExpiryDate": "2023-01-01T12:04:05Z",
18 "lastLockOverrideDate": "2023-01-01T12:04:05Z"
19 }
20 }
21}Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.
