Skip to main content
GET
/
v1
/
deposits
/
{depositId}
/
customer
/
{customerId}
/
api-key
Get a Deposit Customer (by customerId)
curl --request GET \
  --url https://api.hel.io/v1/deposits/{depositId}/customer/{customerId}/api-key \
  --header 'Authorization: Bearer <token>'
{
  "id": "695becf08afd9fceb3767369",
  "deposit": "695beb0732b11192df71015b",
  "token": "984a783c-d246-4199-9cc3-bdffab9e6ada",
  "customerId": "test12",
  "customerEmail": "jesse@helio.io",
  "recipientPublicKeys": [
    "7YancRyNQyp9s6G7YNwx9H93UqswoKWqF9GuNJPufyvW"
  ],
  "disabled": false
}
Note: When using the production environment at moonpay.hel.io, set your API endpoint to api.hel.io/v1 and generate API keys there. For the development environment, use api.dev.hel.io/v1 and generate API keys from moonpay.dev.hel.io.

Authorizations

​
Authorization
string
header
required

Authentication using JWT token

Path Parameters

​
depositId
string
required

The unique ID of the deposit.

​
customerId
string
required

The unique ID of the customer associated with the deposit.

Query Parameters

​
apiKey
string
required

Your API key, which can be generated from the Helio Dashboard settings page.

Response

The deposit customer was retrieved successfully

​
recipientPublicKeys
string[]

List of recipient public keys.

​
disabled
boolean

Indicates whether the deposit customer is enabled or disabled. Set to true to disable, or false to enable.

​
additionalJSON
string

Optional JSON string containing metadata.