Skip to main content
POST
/
customer
{
  "id": "customer_c7a968e665d9",
  "object": "customer",
  "name": "John Doe",
  "email": "[email protected]",
  "phone": "+1234567890",
  "metadata": {
    "userId": "2b634b51-7f4a-470b-9bd6-c7a968e665d9"
  },
  "address": {
    "line1": "1234 Main St",
    "line2": "Suite 200",
    "city": "Anytown",
    "state": "CA",
    "postalCode": "12345",
    "countryCode": "US"
  },
  "verificationStatus": "IN_PROGRESS",
  "wallets": [
    {
      "address": "0x1234567890123456789012345678901234567890",
      "object": "wallet",
      "balances": {
        "token": "0x4dad19801eff64eaaa7c78e466ce3678d0b1fd94",
        "total": "1000",
        "available": {
          "amount": "0"
        },
        "frozen": {
          "amount": "1000"
        }
      }
    }
  ],
  "type": "INDIVIDUAL",
  "countryCode": "US",
  "hasCompletedMoneriumSetup": true,
  "referralCode": "REF123456",
  "createdAt": "2023-10-01T12:00:00Z",
  "username": "john_doe"
}

Body

application/json
​
wallets
object[]
required

The wallet associated with the customer

Example:
[
  {
    "address": "0x1234567890123456789012345678901234567890"
  }
]
​
type
enum<string>
required

This is the type of the customer

Available options:
INDIVIDUAL,
ORGANIZATION
Example:

"INDIVIDUAL"

​
countryCode
object
required

The country code of the address, following the ISO 3166-1 alpha-2 standard

Example:

"US"

​
username
string
required

Username of the customer

Example:

"john_doe"

​
name
string

The name of the customer

Example:

"John Doe"

​
email
string

The email of the customer

Example:

"[email protected]"

​
phone
string

The phone number of the customer

Example:

"+1234567890"

​
metadata
object

The metadata of the customer

Example:
{
  "userId": "2b634b51-7f4a-470b-9bd6-c7a968e665d9"
}
​
address
object

The address of the customer

Example:
{
  "line1": "1234 Main St",
  "line2": "Suite 200",
  "city": "Anytown",
  "state": "CA",
  "postalCode": "12345"
}

Response

The customer has been successfully onboarded

​
id
string
required

Unique identifier for the customer object.

Example:

"customer_c7a968e665d9"

​
object
string
required

A string that specifies the type of the object. All objects of the same type share this value.

Example:

"customer"

​
verificationStatus
enum<string>
required

The verification status of the customer

Available options:
INCOMPLETE,
IN_PROGRESS,
COMPLETED
Example:

"IN_PROGRESS"

​
wallets
object[]
required

The wallet associated with the customer

​
type
enum<string>
required

This is the type of the customer

Available options:
INDIVIDUAL,
ORGANIZATION
Example:

"INDIVIDUAL"

​
countryCode
object
required

The country code of the address, following the ISO 3166-1 alpha-2 standard

Example:

"US"

​
hasCompletedMoneriumSetup
boolean
required

Indicates whether the customer has completed the Monerium setup

Example:

true

​
referralCode
string
required

The unique referral code associated with the customer

Example:

"REF123456"

​
createdAt
string<date-time>
required

The date and time when the customer was created

Example:

"2023-10-01T12:00:00Z"

​
username
string
required

The username of the customer

Example:

"john_doe"

​
name
string

The name of the customer

Example:

"John Doe"

​
email
string

The email of the customer

Example:

"[email protected]"

​
phone
string

The phone number of the customer

Example:

"+1234567890"

​
metadata
object

The metadata of the customer

Example:
{
  "userId": "2b634b51-7f4a-470b-9bd6-c7a968e665d9"
}
​
address
object

The address of the customer

Example:
{
  "line1": "1234 Main St",
  "line2": "Suite 200",
  "city": "Anytown",
  "state": "CA",
  "postalCode": "12345",
  "countryCode": "US"
}