List all addresses

get /v1/{tenantName}/wallet

List of all the wallet addresses.

tenantName

string

required

The name of the tenant.

filter

string

limit

number

offset

number

orderBy

string

Response

Examples Schema

Successful operation

[
  {
    "address": "string",
    "alias": "string",
    "createdAt": 123.0,
    "id": 123.0,
    "kind": "EXTERNAL",
    "state": "UNVERIFIED",
    "status": "Blocked",
    "type": "CORPORATE",
    "updatedAt": 123.0,
    "userId": 123.0,
    "verificationMessage": "string"
  }
]

causes:

  • schema not followed properly.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

array[object]

object

address

string

alias

string

createdAt

number

id

number

kind

string

Kind of address stored.

  • "EXTERNAL": The private key is not stored in our system.
  • "PAYER": The private key is securely stored in the system. You can pay for transactions with this kind of address. The address must be charged with sufficient native cryptocurrency to pay for the transactions.
  • "SIGNER": The private key is securely stored in the system. You can sign transactions with it and send using the ERC2771 protocol. Native cryptocurrencies are not mandatory.
Enum
  • EXTERNAL
  • PAYER
  • SIGNER

state

string

The verification type of the address.

  • "UNVERIFIED": Unverified
  • "VERIFIED": Verified
Enum
  • UNVERIFIED
  • VERIFIED

status

string

The current verification status

  • "Blocked": The verification process is blocked.
  • "Pending": The verification is pending.
  • "Rejected": The entity has verification has been rejected.
  • "Started": The verification process has started.
  • "Unknown": The verification status is unknown.
  • "Validated": The entity has been validated.
Enum
  • Blocked
  • Pending
  • Rejected
  • Started
  • Unknown
  • Validated

type

string

The type of the address.

  • "CORPORATE": Corporate address type
  • "INVESTOR": Investor address type
  • "PERSONAL": Personal address type
  • "PRIVATE": Private address type
  • "SMART_CONTRACT": Smart contract address type
Enum
  • CORPORATE
  • INVESTOR
  • PERSONAL
  • PRIVATE
  • SMART_CONTRACT

updatedAt

number

userId

number

verificationMessage

string

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

List user addresses

get /v1/{tenantName}/wallet/{userId}/addresses

List of the wallet addresses associated to the user.

tenantName

string

required

The name of the tenant.

userId

number

required

kind

string

required

Enum
  • EXTERNAL
  • PAYER
  • SIGNER

filter

string

limit

number

offset

number

orderBy

string

Response

Examples Schema

Successful operation

[
  {
    "address": "string",
    "alias": "string",
    "createdAt": 123.0,
    "id": 123.0,
    "kind": "EXTERNAL",
    "state": "UNVERIFIED",
    "status": "Blocked",
    "type": "CORPORATE",
    "updatedAt": 123.0,
    "userId": 123.0,
    "verificationMessage": "string"
  }
]

causes:

  • schema not followed properly.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

array[object]

object

address

string

alias

string

createdAt

number

id

number

kind

string

Kind of address stored.

  • "EXTERNAL": The private key is not stored in our system.
  • "PAYER": The private key is securely stored in the system. You can pay for transactions with this kind of address. The address must be charged with sufficient native cryptocurrency to pay for the transactions.
  • "SIGNER": The private key is securely stored in the system. You can sign transactions with it and send using the ERC2771 protocol. Native cryptocurrencies are not mandatory.
Enum
  • EXTERNAL
  • PAYER
  • SIGNER

state

string

The verification type of the address.

  • "UNVERIFIED": Unverified
  • "VERIFIED": Verified
Enum
  • UNVERIFIED
  • VERIFIED

status

string

The current verification status

  • "Blocked": The verification process is blocked.
  • "Pending": The verification is pending.
  • "Rejected": The entity has verification has been rejected.
  • "Started": The verification process has started.
  • "Unknown": The verification status is unknown.
  • "Validated": The entity has been validated.
Enum
  • Blocked
  • Pending
  • Rejected
  • Started
  • Unknown
  • Validated

type

string

The type of the address.

  • "CORPORATE": Corporate address type
  • "INVESTOR": Investor address type
  • "PERSONAL": Personal address type
  • "PRIVATE": Private address type
  • "SMART_CONTRACT": Smart contract address type
Enum
  • CORPORATE
  • INVESTOR
  • PERSONAL
  • PRIVATE
  • SMART_CONTRACT

updatedAt

number

userId

number

verificationMessage

string

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Register address

post /v1/{tenantName}/wallet/{userId}/addresses

Register a wallet address.

tenantName

string

required

The name of the tenant.

userId

number

required

address

string

alias

string

type

string

The type of the address.

  • "CORPORATE": Corporate address type
  • "INVESTOR": Investor address type
  • "PERSONAL": Personal address type
  • "PRIVATE": Private address type
  • "SMART_CONTRACT": Smart contract address type
Enum
  • CORPORATE
  • INVESTOR
  • PERSONAL
  • PRIVATE
  • SMART_CONTRACT

Request

{
  "address": "string",
  "alias": "string",
  "type": "CORPORATE"
}

Response

Examples Schema

Successful operation

{
  "address": "string",
  "alias": "string",
  "createdAt": 123.0,
  "id": 123.0,
  "kind": "EXTERNAL",
  "state": "UNVERIFIED",
  "status": "Blocked",
  "type": "CORPORATE",
  "updatedAt": 123.0,
  "userId": 123.0,
  "verificationMessage": "string"
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

address

string

alias

string

createdAt

number

id

number

kind

string

Kind of address stored.

  • "EXTERNAL": The private key is not stored in our system.
  • "PAYER": The private key is securely stored in the system. You can pay for transactions with this kind of address. The address must be charged with sufficient native cryptocurrency to pay for the transactions.
  • "SIGNER": The private key is securely stored in the system. You can sign transactions with it and send using the ERC2771 protocol. Native cryptocurrencies are not mandatory.
Enum
  • EXTERNAL
  • PAYER
  • SIGNER

state

string

The verification type of the address.

  • "UNVERIFIED": Unverified
  • "VERIFIED": Verified
Enum
  • UNVERIFIED
  • VERIFIED

status

string

The current verification status

  • "Blocked": The verification process is blocked.
  • "Pending": The verification is pending.
  • "Rejected": The entity has verification has been rejected.
  • "Started": The verification process has started.
  • "Unknown": The verification status is unknown.
  • "Validated": The entity has been validated.
Enum
  • Blocked
  • Pending
  • Rejected
  • Started
  • Unknown
  • Validated

type

string

The type of the address.

  • "CORPORATE": Corporate address type
  • "INVESTOR": Investor address type
  • "PERSONAL": Personal address type
  • "PRIVATE": Private address type
  • "SMART_CONTRACT": Smart contract address type
Enum
  • CORPORATE
  • INVESTOR
  • PERSONAL
  • PRIVATE
  • SMART_CONTRACT

updatedAt

number

userId

number

verificationMessage

string

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Get address by id

get /v1/{tenantName}/wallet/{userId}/addresses/{addressId}

Get address information by the given id.

tenantName

string

required

The name of the tenant.

userId

number

required

addressId

number

required

Response

Examples Schema

Successful operation

{
  "address": "string",
  "alias": "string",
  "createdAt": 123.0,
  "id": 123.0,
  "kind": "EXTERNAL",
  "state": "UNVERIFIED",
  "status": "Blocked",
  "type": "CORPORATE",
  "updatedAt": 123.0,
  "userId": 123.0,
  "verificationMessage": "string"
}

causes:

  • schema not followed properly.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

address

string

alias

string

createdAt

number

id

number

kind

string

Kind of address stored.

  • "EXTERNAL": The private key is not stored in our system.
  • "PAYER": The private key is securely stored in the system. You can pay for transactions with this kind of address. The address must be charged with sufficient native cryptocurrency to pay for the transactions.
  • "SIGNER": The private key is securely stored in the system. You can sign transactions with it and send using the ERC2771 protocol. Native cryptocurrencies are not mandatory.
Enum
  • EXTERNAL
  • PAYER
  • SIGNER

state

string

The verification type of the address.

  • "UNVERIFIED": Unverified
  • "VERIFIED": Verified
Enum
  • UNVERIFIED
  • VERIFIED

status

string

The current verification status

  • "Blocked": The verification process is blocked.
  • "Pending": The verification is pending.
  • "Rejected": The entity has verification has been rejected.
  • "Started": The verification process has started.
  • "Unknown": The verification status is unknown.
  • "Validated": The entity has been validated.
Enum
  • Blocked
  • Pending
  • Rejected
  • Started
  • Unknown
  • Validated

type

string

The type of the address.

  • "CORPORATE": Corporate address type
  • "INVESTOR": Investor address type
  • "PERSONAL": Personal address type
  • "PRIVATE": Private address type
  • "SMART_CONTRACT": Smart contract address type
Enum
  • CORPORATE
  • INVESTOR
  • PERSONAL
  • PRIVATE
  • SMART_CONTRACT

updatedAt

number

userId

number

verificationMessage

string

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Update address

put /v1/{tenantName}/wallet/{userId}/addresses/{addressId}

Update wallet address information.

tenantName

string

required

The name of the tenant.

userId

number

required

addressId

number

required

properties

object (properties)

Represents a dynamic key value object.

Example
{ "property1": "value1", "property2": "value2", "property3": 100, "property4": true }

Request

{
  "properties": {
    "property1": "value1",
    "property2": "value2",
    "property3": 100,
    "property4": true
  }
}

Response

Examples Schema

Successful operation

{
  "success": true
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

success

boolean

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Delete address

delete /v1/{tenantName}/wallet/{userId}/addresses/{addressId}

Remove a wallet address. Does not blacklist the address.

tenantName

string

required

The name of the tenant.

userId

number

required

addressId

number

required

Response

Examples Schema

Successful operation

{
  "success": true
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

success

boolean

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Get address properties

get /v1/{tenantName}/wallet/{userId}/addresses/{addressId}/properties

Get address information related to the verification process.

tenantName

string

required

The name of the tenant.

userId

number

required

addressId

number

required

Response

Examples Schema

Successful operation

{
  "property1": "value1",
  "property2": "value2",
  "property3": 100,
  "property4": true
}

causes:

  • schema not followed properly.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

No schema

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Validate address

put /v1/{tenantName}/wallet/{userId}/addresses/{addressId}/validate

Validates the wallet address against AML process.

tenantName

string

required

The name of the tenant.

userId

number

required

addressId

number

required

Request

{}

Response

Examples Schema

Successful operation

{
  "address": "string",
  "alias": "string",
  "createdAt": 123.0,
  "id": 123.0,
  "kind": "EXTERNAL",
  "state": "UNVERIFIED",
  "status": "Blocked",
  "type": "CORPORATE",
  "updatedAt": 123.0,
  "userId": 123.0,
  "verificationMessage": "string"
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

address

string

alias

string

createdAt

number

id

number

kind

string

Kind of address stored.

  • "EXTERNAL": The private key is not stored in our system.
  • "PAYER": The private key is securely stored in the system. You can pay for transactions with this kind of address. The address must be charged with sufficient native cryptocurrency to pay for the transactions.
  • "SIGNER": The private key is securely stored in the system. You can sign transactions with it and send using the ERC2771 protocol. Native cryptocurrencies are not mandatory.
Enum
  • EXTERNAL
  • PAYER
  • SIGNER

state

string

The verification type of the address.

  • "UNVERIFIED": Unverified
  • "VERIFIED": Verified
Enum
  • UNVERIFIED
  • VERIFIED

status

string

The current verification status

  • "Blocked": The verification process is blocked.
  • "Pending": The verification is pending.
  • "Rejected": The entity has verification has been rejected.
  • "Started": The verification process has started.
  • "Unknown": The verification status is unknown.
  • "Validated": The entity has been validated.
Enum
  • Blocked
  • Pending
  • Rejected
  • Started
  • Unknown
  • Validated

type

string

The type of the address.

  • "CORPORATE": Corporate address type
  • "INVESTOR": Investor address type
  • "PERSONAL": Personal address type
  • "PRIVATE": Private address type
  • "SMART_CONTRACT": Smart contract address type
Enum
  • CORPORATE
  • INVESTOR
  • PERSONAL
  • PRIVATE
  • SMART_CONTRACT

updatedAt

number

userId

number

verificationMessage

string

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Verify address

put /v1/{tenantName}/wallet/{userId}/addresses/{addressId}/verify

Verify ownership of the wallet address by submitting the signature of the provided verification message.

tenantName

string

required

The name of the tenant.

userId

number

required

addressId

number

required

signature

string

Request

{
  "signature": "string"
}

Response

Examples Schema

Successful operation

{
  "address": "string",
  "alias": "string",
  "createdAt": 123.0,
  "id": 123.0,
  "kind": "EXTERNAL",
  "state": "UNVERIFIED",
  "status": "Blocked",
  "type": "CORPORATE",
  "updatedAt": 123.0,
  "userId": 123.0,
  "verificationMessage": "string"
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

address

string

alias

string

createdAt

number

id

number

kind

string

Kind of address stored.

  • "EXTERNAL": The private key is not stored in our system.
  • "PAYER": The private key is securely stored in the system. You can pay for transactions with this kind of address. The address must be charged with sufficient native cryptocurrency to pay for the transactions.
  • "SIGNER": The private key is securely stored in the system. You can sign transactions with it and send using the ERC2771 protocol. Native cryptocurrencies are not mandatory.
Enum
  • EXTERNAL
  • PAYER
  • SIGNER

state

string

The verification type of the address.

  • "UNVERIFIED": Unverified
  • "VERIFIED": Verified
Enum
  • UNVERIFIED
  • VERIFIED

status

string

The current verification status

  • "Blocked": The verification process is blocked.
  • "Pending": The verification is pending.
  • "Rejected": The entity has verification has been rejected.
  • "Started": The verification process has started.
  • "Unknown": The verification status is unknown.
  • "Validated": The entity has been validated.
Enum
  • Blocked
  • Pending
  • Rejected
  • Started
  • Unknown
  • Validated

type

string

The type of the address.

  • "CORPORATE": Corporate address type
  • "INVESTOR": Investor address type
  • "PERSONAL": Personal address type
  • "PRIVATE": Private address type
  • "SMART_CONTRACT": Smart contract address type
Enum
  • CORPORATE
  • INVESTOR
  • PERSONAL
  • PRIVATE
  • SMART_CONTRACT

updatedAt

number

userId

number

verificationMessage

string

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Get user whitelisted addresses

get /v1/{tenantName}/wallet/{userId}/addresses/{userId}/modules/{module}/whitelist

List all the whitelisted addresses in a module.

tenantName

string

required

The name of the tenant.

userId

number

required

module

string

required

filter

string

limit

number

offset

number

orderBy

string

Response

Examples Schema

Successful operation

[
  {
    "address": "string",
    "alias": "string",
    "createdAt": 123.0,
    "id": 123.0,
    "kind": "EXTERNAL",
    "state": "UNVERIFIED",
    "status": "Blocked",
    "type": "CORPORATE",
    "updatedAt": 123.0,
    "userId": 123.0,
    "verificationMessage": "string"
  }
]

causes:

  • schema not followed properly.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

array[object]

object

address

string

alias

string

createdAt

number

id

number

kind

string

Kind of address stored.

  • "EXTERNAL": The private key is not stored in our system.
  • "PAYER": The private key is securely stored in the system. You can pay for transactions with this kind of address. The address must be charged with sufficient native cryptocurrency to pay for the transactions.
  • "SIGNER": The private key is securely stored in the system. You can sign transactions with it and send using the ERC2771 protocol. Native cryptocurrencies are not mandatory.
Enum
  • EXTERNAL
  • PAYER
  • SIGNER

state

string

The verification type of the address.

  • "UNVERIFIED": Unverified
  • "VERIFIED": Verified
Enum
  • UNVERIFIED
  • VERIFIED

status

string

The current verification status

  • "Blocked": The verification process is blocked.
  • "Pending": The verification is pending.
  • "Rejected": The entity has verification has been rejected.
  • "Started": The verification process has started.
  • "Unknown": The verification status is unknown.
  • "Validated": The entity has been validated.
Enum
  • Blocked
  • Pending
  • Rejected
  • Started
  • Unknown
  • Validated

type

string

The type of the address.

  • "CORPORATE": Corporate address type
  • "INVESTOR": Investor address type
  • "PERSONAL": Personal address type
  • "PRIVATE": Private address type
  • "SMART_CONTRACT": Smart contract address type
Enum
  • CORPORATE
  • INVESTOR
  • PERSONAL
  • PRIVATE
  • SMART_CONTRACT

updatedAt

number

userId

number

verificationMessage

string

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Get address by hex

get /v1/{tenantName}/wallet/{userId}/addresses/hex/{hexAddress}

Get address information by the given hexadecimal direction.

tenantName

string

required

The name of the tenant.

userId

number

required

hexAddress

string

required

Response

Examples Schema

Successful operation

{
  "address": "string",
  "alias": "string",
  "createdAt": 123.0,
  "id": 123.0,
  "kind": "EXTERNAL",
  "state": "UNVERIFIED",
  "status": "Blocked",
  "type": "CORPORATE",
  "updatedAt": 123.0,
  "userId": 123.0,
  "verificationMessage": "string"
}

causes:

  • schema not followed properly.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

address

string

alias

string

createdAt

number

id

number

kind

string

Kind of address stored.

  • "EXTERNAL": The private key is not stored in our system.
  • "PAYER": The private key is securely stored in the system. You can pay for transactions with this kind of address. The address must be charged with sufficient native cryptocurrency to pay for the transactions.
  • "SIGNER": The private key is securely stored in the system. You can sign transactions with it and send using the ERC2771 protocol. Native cryptocurrencies are not mandatory.
Enum
  • EXTERNAL
  • PAYER
  • SIGNER

state

string

The verification type of the address.

  • "UNVERIFIED": Unverified
  • "VERIFIED": Verified
Enum
  • UNVERIFIED
  • VERIFIED

status

string

The current verification status

  • "Blocked": The verification process is blocked.
  • "Pending": The verification is pending.
  • "Rejected": The entity has verification has been rejected.
  • "Started": The verification process has started.
  • "Unknown": The verification status is unknown.
  • "Validated": The entity has been validated.
Enum
  • Blocked
  • Pending
  • Rejected
  • Started
  • Unknown
  • Validated

type

string

The type of the address.

  • "CORPORATE": Corporate address type
  • "INVESTOR": Investor address type
  • "PERSONAL": Personal address type
  • "PRIVATE": Private address type
  • "SMART_CONTRACT": Smart contract address type
Enum
  • CORPORATE
  • INVESTOR
  • PERSONAL
  • PRIVATE
  • SMART_CONTRACT

updatedAt

number

userId

number

verificationMessage

string

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Generate custody address

post /v1/{tenantName}/wallet/{userId}/custody

Generate a wallet address with a secure custodian.

tenantName

string

required

The name of the tenant.

userId

number

required

alias

string

kind

string

Kind of address stored.

  • "EXTERNAL": The private key is not stored in our system.
  • "PAYER": The private key is securely stored in the system. You can pay for transactions with this kind of address. The address must be charged with sufficient native cryptocurrency to pay for the transactions.
  • "SIGNER": The private key is securely stored in the system. You can sign transactions with it and send using the ERC2771 protocol. Native cryptocurrencies are not mandatory.
Enum
  • EXTERNAL
  • PAYER
  • SIGNER

type

string

The type of the address.

  • "CORPORATE": Corporate address type
  • "INVESTOR": Investor address type
  • "PERSONAL": Personal address type
  • "PRIVATE": Private address type
  • "SMART_CONTRACT": Smart contract address type
Enum
  • CORPORATE
  • INVESTOR
  • PERSONAL
  • PRIVATE
  • SMART_CONTRACT

Request

{
  "alias": "string",
  "kind": "EXTERNAL",
  "type": "CORPORATE"
}

Response

Examples Schema

Successful operation

{
  "address": "string",
  "alias": "string",
  "createdAt": 123.0,
  "id": 123.0,
  "kind": "EXTERNAL",
  "state": "UNVERIFIED",
  "status": "Blocked",
  "type": "CORPORATE",
  "updatedAt": 123.0,
  "userId": 123.0,
  "verificationMessage": "string"
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

address

string

alias

string

createdAt

number

id

number

kind

string

Kind of address stored.

  • "EXTERNAL": The private key is not stored in our system.
  • "PAYER": The private key is securely stored in the system. You can pay for transactions with this kind of address. The address must be charged with sufficient native cryptocurrency to pay for the transactions.
  • "SIGNER": The private key is securely stored in the system. You can sign transactions with it and send using the ERC2771 protocol. Native cryptocurrencies are not mandatory.
Enum
  • EXTERNAL
  • PAYER
  • SIGNER

state

string

The verification type of the address.

  • "UNVERIFIED": Unverified
  • "VERIFIED": Verified
Enum
  • UNVERIFIED
  • VERIFIED

status

string

The current verification status

  • "Blocked": The verification process is blocked.
  • "Pending": The verification is pending.
  • "Rejected": The entity has verification has been rejected.
  • "Started": The verification process has started.
  • "Unknown": The verification status is unknown.
  • "Validated": The entity has been validated.
Enum
  • Blocked
  • Pending
  • Rejected
  • Started
  • Unknown
  • Validated

type

string

The type of the address.

  • "CORPORATE": Corporate address type
  • "INVESTOR": Investor address type
  • "PERSONAL": Personal address type
  • "PRIVATE": Private address type
  • "SMART_CONTRACT": Smart contract address type
Enum
  • CORPORATE
  • INVESTOR
  • PERSONAL
  • PRIVATE
  • SMART_CONTRACT

updatedAt

number

userId

number

verificationMessage

string

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Was this page helpful?