Skip to main content
GET
/
accounts
/
customers
Search customers
curl --request GET \
  --url https://api-sb.meld.io/accounts/customers \
  --header 'Authorization: <api-key>'
import requests

url = "https://api-sb.meld.io/accounts/customers"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api-sb.meld.io/accounts/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sb.meld.io/accounts/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api-sb.meld.io/accounts/customers"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api-sb.meld.io/accounts/customers")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-sb.meld.io/accounts/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "count": 123,
  "customers": [
    {
      "accountId": "<string>",
      "addresses": [
        null
      ],
      "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
default:""

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
default:""

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

email
string
default:""

Customer's email

phone
string
default:""

Customer's phone

status
enum<string>
default:""

Customer's status

Available options:
ACTIVE,
INACTIVE
type
enum<string>
default:""

Customer type

Available options:
INDIVIDUAL,
BUSINESS
before
string
default:""

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

after
string
default:""

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

limit
string
default:""

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.