Jump to

• Request
• Response

Create Wallet

post

/v1/uwaas/wallets

Create a wallet for a user in an organization network.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• orgId(required): string
  External organization identifier from orgId.

  Example: org-founder-bank
• orgNetworkId(required): integer (int64)
  Example: 1
• ownershipType: string
  Default Value: USER

  Allowed Values: [ "USER", "SERVICE" ]

  Type of wallet ownership. Defaults to USER
• status(required): string
  Allowed Values: [ "ACTIVE", "INACTIVE", "CLOSED" ]

  Wallet status values allowed at creation time.

  Example: ACTIVE
• userId(required): string (uuid)
  Example: 3833bcfc-3b52-4705-b079-29947cf1cbe5
• walletLabel(required): string
  Example: Founder-mobile
• walletTags: array walletTags
  Optional tags to assign to the wallet. Tags are normalized before persistence.
• walletType(required): string
  Allowed Values: [ "1" ]

  Wallet type used by Wallet Admin UI. "1" = Custodial.

  Example: 1

{
    "type":"object",
    "properties":{
        "orgId":{
            "type":"string",
            "description":"External organization identifier from orgId.",
            "example":"org-founder-bank"
        },
        "orgNetworkId":{
            "type":"integer",
            "format":"int64",
            "example":1
        },
        "userId":{
            "type":"string",
            "format":"uuid",
            "example":"3833bcfc-3b52-4705-b079-29947cf1cbe5"
        },
        "walletLabel":{
            "type":"string",
            "example":"Founder-mobile"
        },
        "status":{
            "$ref":"#/components/schemas/CreateWalletStatus"
        },
        "walletType":{
            "$ref":"#/components/schemas/WalletType"
        },
        "ownershipType":{
            "$ref":"#/components/schemas/OwnershipType"
        },
        "walletTags":{
            "type":"array",
            "description":"Optional tags to assign to the wallet. Tags are normalized before persistence.",
            "items":{
                "type":"string"
            },
            "example":[
                "internal",
                "hot"
            ]
        }
    },
    "required":[
        "orgId",
        "orgNetworkId",
        "userId",
        "walletLabel",
        "status",
        "walletType"
    ]
}

Nested Schema : walletTags

Type: array

Optional tags to assign to the wallet. Tags are normalized before persistence.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Optional tags to assign to the wallet. Tags are normalized before persistence.",
    "items":{
        "type":"string"
    },
    "example":[
        "internal",
        "hot"
    ]
}

Example:

[
    "internal",
    "hot"
]

Back to Top

Response

Supported Media Types

• application/json

201 Response

Wallet created successfully.

Body ()

Root Schema : CreateWalletResponse

Type: object

Show Source

• address(required): string
  Example: 0x599f59e794c88a108e0cc2072b7a52fa3576cea4
• label(required): string
  Example: Founder-bluetooth
• ownershipType: string
  Default Value: USER

  Allowed Values: [ "USER", "SERVICE" ]

  Type of wallet ownership. Defaults to USER
• providerType(required): string
  Example: ADAPTER_HTTP
• providerWalletRef(required): string
  Example: 0x599f59e794c88a108e0cc2072b7a52fa3576cea4
• status(required): string
  Allowed Values: [ "ACTIVE", "INACTIVE", "CLOSED" ]

  Wallet lifecycle status.

  Example: ACTIVE
• userId: string
  Example: alice
• walletId(required): string
  Example: 62d00d4f-1851-4126-aa77-dcef4f816c78
• walletType(required): string
  Allowed Values: [ "1" ]

  Wallet type used by Wallet Admin UI. "1" = Custodial.

  Example: 1
• walletTypeLabel(required): string
  Example: Custodial

{
    "type":"object",
    "properties":{
        "walletId":{
            "type":"string",
            "example":"62d00d4f-1851-4126-aa77-dcef4f816c78"
        },
        "address":{
            "type":"string",
            "example":"0x599f59e794c88a108e0cc2072b7a52fa3576cea4"
        },
        "userId":{
            "type":"string",
            "example":"alice"
        },
        "label":{
            "type":"string",
            "example":"Founder-bluetooth"
        },
        "status":{
            "$ref":"#/components/schemas/WalletStatus"
        },
        "walletType":{
            "$ref":"#/components/schemas/WalletType"
        },
        "walletTypeLabel":{
            "type":"string",
            "example":"Custodial"
        },
        "ownershipType":{
            "$ref":"#/components/schemas/OwnershipType"
        },
        "providerType":{
            "type":"string",
            "example":"ADAPTER_HTTP"
        },
        "providerWalletRef":{
            "type":"string",
            "example":"0x599f59e794c88a108e0cc2072b7a52fa3576cea4"
        }
    },
    "required":[
        "walletId",
        "address",
        "label",
        "status",
        "walletType",
        "walletTypeLabel",
        "providerType",
        "providerWalletRef"
    ]
}

400 Response

Bad request.

Body ()

Root Schema : Error

Type: object

Show Source

• details(required): array details
• error(required): string
  Example: Wallet Not Found
• errorCode(required): string
  Example: WALLET_NOT_FOUND
• message(required): string
  Example: Wallet with id 123 was not found.
• path(required): string
  Example: /v1/uwaas/wallets/123
• status(required): integer
  Example: 404
• timestamp(required): string (date-time)
  Example: 2026-07-16T14:23:11.123Z

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "example":"2026-07-16T14:23:11.123Z"
        },
        "status":{
            "type":"integer",
            "example":404
        },
        "error":{
            "type":"string",
            "example":"Wallet Not Found"
        },
        "path":{
            "type":"string",
            "example":"/v1/uwaas/wallets/123"
        },
        "errorCode":{
            "type":"string",
            "example":"WALLET_NOT_FOUND"
        },
        "message":{
            "type":"string",
            "example":"Wallet with id 123 was not found."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "timestamp",
        "status",
        "error",
        "path",
        "errorCode",
        "message",
        "details"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

401 Response

Unauthorized.

Body ()

Root Schema : Error

Type: object

Show Source

• details(required): array details
• error(required): string
  Example: Wallet Not Found
• errorCode(required): string
  Example: WALLET_NOT_FOUND
• message(required): string
  Example: Wallet with id 123 was not found.
• path(required): string
  Example: /v1/uwaas/wallets/123
• status(required): integer
  Example: 404
• timestamp(required): string (date-time)
  Example: 2026-07-16T14:23:11.123Z

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "example":"2026-07-16T14:23:11.123Z"
        },
        "status":{
            "type":"integer",
            "example":404
        },
        "error":{
            "type":"string",
            "example":"Wallet Not Found"
        },
        "path":{
            "type":"string",
            "example":"/v1/uwaas/wallets/123"
        },
        "errorCode":{
            "type":"string",
            "example":"WALLET_NOT_FOUND"
        },
        "message":{
            "type":"string",
            "example":"Wallet with id 123 was not found."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "timestamp",
        "status",
        "error",
        "path",
        "errorCode",
        "message",
        "details"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

404 Response

Requested resource was not found.

Body ()

Root Schema : Error

Type: object

Show Source

• details(required): array details
• error(required): string
  Example: Wallet Not Found
• errorCode(required): string
  Example: WALLET_NOT_FOUND
• message(required): string
  Example: Wallet with id 123 was not found.
• path(required): string
  Example: /v1/uwaas/wallets/123
• status(required): integer
  Example: 404
• timestamp(required): string (date-time)
  Example: 2026-07-16T14:23:11.123Z

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "example":"2026-07-16T14:23:11.123Z"
        },
        "status":{
            "type":"integer",
            "example":404
        },
        "error":{
            "type":"string",
            "example":"Wallet Not Found"
        },
        "path":{
            "type":"string",
            "example":"/v1/uwaas/wallets/123"
        },
        "errorCode":{
            "type":"string",
            "example":"WALLET_NOT_FOUND"
        },
        "message":{
            "type":"string",
            "example":"Wallet with id 123 was not found."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "timestamp",
        "status",
        "error",
        "path",
        "errorCode",
        "message",
        "details"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

500 Response

Internal server error.

Body ()

Root Schema : Error

Type: object

Show Source

• details(required): array details
• error(required): string
  Example: Wallet Not Found
• errorCode(required): string
  Example: WALLET_NOT_FOUND
• message(required): string
  Example: Wallet with id 123 was not found.
• path(required): string
  Example: /v1/uwaas/wallets/123
• status(required): integer
  Example: 404
• timestamp(required): string (date-time)
  Example: 2026-07-16T14:23:11.123Z

{
    "type":"object",
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "example":"2026-07-16T14:23:11.123Z"
        },
        "status":{
            "type":"integer",
            "example":404
        },
        "error":{
            "type":"string",
            "example":"Wallet Not Found"
        },
        "path":{
            "type":"string",
            "example":"/v1/uwaas/wallets/123"
        },
        "errorCode":{
            "type":"string",
            "example":"WALLET_NOT_FOUND"
        },
        "message":{
            "type":"string",
            "example":"Wallet with id 123 was not found."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "timestamp",
        "status",
        "error",
        "path",
        "errorCode",
        "message",
        "details"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top