Skip to main content
GET
/
accounts
/
customers
Search customers
curl --request GET \
  --url https://api-sb.meld.io/accounts/customers \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "customers": [
    {
      "accountId": "<string>",
      "addresses": [
        {
          "addressDetails": {
            "city": "<string>",
            "country": "<string>",
            "lineOne": "<string>",
            "lineTwo": "<string>",
            "postalCode": "<string>",
            "region": "<string>"
          },
          "customerId": "<string>",
          "id": "<string>"
        }
      ],
      "dateOfBirth": "<string>",
      "email": "<string>",
      "externalId": "<string>",
      "id": "<string>",
      "key": "<string>",
      "name": {
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "phone": "<string>",
      "previouslyUsedOnramps": [
        {
          "previouslyUsed": "2023-11-07T05:31:56Z"
        }
      ],
      "serviceProviderCustomers": [
        {
          "createdAt": "2023-11-07T05:31:56Z",
          "customerId": "<string>",
          "deletedAt": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "kyc": {
            "additionalInfo": {},
            "onboardingMethod": {
              "kycProvider": "<string>",
              "onboardingType": "<string>"
            },
            "updatedAt": "2023-11-07T05:31:56Z"
          },
          "serviceProviderAccessProfileId": "<string>",
          "serviceProviderDetails": {
            "type": "<string>",
            "customerType": "<string>"
          },
          "status": "<string>",
          "wallets": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "remaining": 123
}

Authorizations

Authorization
string
header
default:BASIC <Meld API Key>
required

Query Parameters

customerIds
string

Meld generated unique identifier for your customer. This should be used to track customer activity. This takes a comma separated list of customer ids.

externalCustomerId
string

Your unique identifier for your customer. If maintaining your own customer management system this can also be used for tracking customer activity.

email
string

Customer's email

phone
string

Customer's phone

status
enum<string>

Customer's status

Available options:
ACTIVE,
INACTIVE
type
enum<string>

Customer type

Available options:
INDIVIDUAL,
BUSINESS
before
string

Key of customer to get before. The next batch of results will be immediately before this customer.

after
string

Key of customer to get after. The next batch of results will be immediately after this customer.

limit
integer<int32>

Limits number of returned customers.

Default value: 10 or the number of customer ids provided

Minimum value: 1

Maximum value: 100

Response

Customers are returned

count
integer<int32>

Number of customers returned.

customers
object[]

Customers

remaining
integer<int32>

Number of remaining customers before/after this page, depending the direction this page was selected.