Jump to

• Request
• Response

Create Wallet

post

{baseUrl}/v1/uwaas/wallets/provision

Creates a wallet and its required UWaaS dependencies.

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

• instanceId(required): string
• org(required): object Org
  Additional Properties Allowed: true
• wallet(required): object Wallet
  Additional Properties Allowed: true

{
    "type":"object",
    "properties":{
        "org":{
            "$ref":"#/components/schemas/Org"
        },
        "instanceId":{
            "type":"string"
        },
        "wallet":{
            "$ref":"#/components/schemas/Wallet"
        }
    },
    "required":[
        "org",
        "instanceId",
        "wallet"
    ],
    "additionalProperties":false
}

Nested Schema : Org

Type: object

Additional Properties Allowed: true

Show Source

• description: string
• organizationName: string
• orgId: string
• status: string
• tags: array tags

{
    "type":"object",
    "properties":{
        "orgId":{
            "type":"string"
        },
        "organizationName":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "tags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":true
}

Nested Schema : Wallet

Type: object

Additional Properties Allowed: true

Show Source

• status: string
• user: object WalletUser
  Additional Properties Allowed: true
• walletLabel: string
• walletTags: array walletTags
• walletType: string

{
    "type":"object",
    "properties":{
        "user":{
            "$ref":"#/components/schemas/WalletUser"
        },
        "walletLabel":{
            "type":"string"
        },
        "walletType":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "walletTags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":true
}

Nested Schema : tags

Type: array

Show Source

• Array of: string

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

Nested Schema : WalletUser

Type: object

Additional Properties Allowed: true

Show Source

• displayName: string
• email: string (email)
• roleId: integer
• status: string
• userId: string

{
    "type":"object",
    "properties":{
        "userId":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "email":{
            "type":"string",
            "format":"email"
        },
        "roleId":{
            "type":"integer"
        },
        "status":{
            "type":"string"
        }
    },
    "additionalProperties":true
}

Nested Schema : walletTags

Type: array

Show Source

• Array of: string

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

Back to Top

Response

Supported Media Types

• application/json

201 Response

Dependencies were created or reused and the wallet was created successfully.

Body ()

Root Schema : UWAAS_ProvisionWalletResponse

Type: object

Show Source

• network(required): object UWAAS_ProvisionWalletNetworkResponse
• org(required): object UWAAS_ProvisionWalletOrganizationResponse
• user(required): object UWAAS_ProvisionWalletUserResponse
• wallet(required): object UWAAS_ProvisionedWalletResponse

{
    "type":"object",
    "required":[
        "org",
        "network",
        "user",
        "wallet"
    ],
    "properties":{
        "org":{
            "$ref":"#/components/schemas/UWAAS_ProvisionWalletOrganizationResponse"
        },
        "network":{
            "$ref":"#/components/schemas/UWAAS_ProvisionWalletNetworkResponse"
        },
        "user":{
            "$ref":"#/components/schemas/UWAAS_ProvisionWalletUserResponse"
        },
        "wallet":{
            "$ref":"#/components/schemas/UWAAS_ProvisionedWalletResponse"
        }
    }
}

Nested Schema : UWAAS_ProvisionWalletNetworkResponse

Type: object

Show Source

• blockchainType(required): string
• chainId(required): string
• created(required): boolean
• instanceId(required): string
• orgNetworkId(required): integer (int64)

{
    "type":"object",
    "required":[
        "orgNetworkId",
        "instanceId",
        "blockchainType",
        "chainId",
        "created"
    ],
    "properties":{
        "orgNetworkId":{
            "type":"integer",
            "format":"int64"
        },
        "instanceId":{
            "type":"string"
        },
        "blockchainType":{
            "type":"string"
        },
        "chainId":{
            "type":"string"
        },
        "created":{
            "type":"boolean"
        }
    }
}

Nested Schema : UWAAS_ProvisionWalletOrganizationResponse

Type: object

Show Source

• created(required): boolean
• orgId(required): string
• status(required): string

{
    "type":"object",
    "required":[
        "orgId",
        "status",
        "created"
    ],
    "properties":{
        "orgId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "created":{
            "type":"boolean"
        }
    }
}

Nested Schema : UWAAS_ProvisionWalletUserResponse

Type: object

Show Source

• created(required): boolean
• userId(required): string

{
    "type":"object",
    "required":[
        "userId",
        "created"
    ],
    "properties":{
        "userId":{
            "type":"string"
        },
        "created":{
            "type":"boolean"
        }
    }
}

Nested Schema : UWAAS_ProvisionedWalletResponse

Type: object

Show Source

• address(required): string
• blockchainType(required): string
• created(required): boolean
• createdBy(required): string
• createdDate(required): string (date-time)
• instanceId(required): string
• label(required): string
• orgId(required): string
• orgNetworkId(required): integer (int64)
• ownershipType(required): string
  Default Value: USER

  Allowed Values: [ "USER", "SERVICE" ]
• status(required): string
• type(required): string
• typeLabel(required): string
• updatedDate: string (date-time)
• userId(required): string
• walletId(required): string
• walletTags(required): array walletTags

{
    "type":"object",
    "required":[
        "walletId",
        "orgId",
        "orgNetworkId",
        "instanceId",
        "blockchainType",
        "userId",
        "status",
        "label",
        "type",
        "typeLabel",
        "ownershipType",
        "address",
        "createdDate",
        "createdBy",
        "walletTags",
        "created"
    ],
    "properties":{
        "walletId":{
            "type":"string"
        },
        "orgId":{
            "type":"string"
        },
        "orgNetworkId":{
            "type":"integer",
            "format":"int64"
        },
        "instanceId":{
            "type":"string"
        },
        "blockchainType":{
            "type":"string"
        },
        "userId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "label":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "typeLabel":{
            "type":"string"
        },
        "ownershipType":{
            "$ref":"#/components/schemas/UWAAS_OwnershipType"
        },
        "address":{
            "type":"string"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time"
        },
        "updatedDate":{
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "walletTags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "created":{
            "type":"boolean"
        }
    }
}

Nested Schema : walletTags

Type: array

Show Source

• Array of: string

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

400 Response

Missing required field, malformed JSON, or invalid request value.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

• error(required): string
• status(required): integer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    },
    "required":[
        "status",
        "error"
    ]
}

405 Response

Only POST is supported.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

• error(required): string
• status(required): integer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    },
    "required":[
        "status",
        "error"
    ]
}

415 Response

Content-Type must be application/json.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

• error(required): string
• status(required): integer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    },
    "required":[
        "status",
        "error"
    ]
}

502 Response

The wrapper could not complete the downstream call.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

• error(required): string
• status(required): integer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    },
    "required":[
        "status",
        "error"
    ]
}

Back to Top