Get customer list

GET

https://api-sandbox.coinflow.cash/api/merchant/customers

GET

/api/merchant/customers

$ curl https://api-sandbox.coinflow.cash/api/merchant/customers \
>      -H "Authorization: <apiKey>"

200Retrieved

1 [
2   {
3     "_id": "string",
4     "email": "string",
5     "createdAt": "2024-01-15T09:30:00Z",
6     "merchant": "string",
7     "availability": {
8       "status": "Functional",
9       "reason": "string",
10       "editor": "string",
11       "updatedAt": "2024-01-15T09:30:00Z"
12     },
13     "chargebackProtectionEnabled": true,
14     "failedAttemptSetting": "Standard",
15     "verificationSetting": "Enforced",
16     "wallet": "string",
17     "verification": {
18       "reference": "string",
19       "status": "pending",
20       "vendor": "middesk",
21       "name": "string",
22       "attested": true,
23       "shareToken": "string",
24       "shareTokenStatus": "string",
25       "sessionToken": "string"
26     },
27     "ubos": [
28       {
29         "reference": "string",
30         "status": "pending",
31         "vendor": "middesk",
32         "name": "string",
33         "attested": true,
34         "shareToken": "string",
35         "shareTokenStatus": "string",
36         "sessionToken": "string"
37       }
38     ],
39     "customerInfo": {
40       "verificationId": "string",
41       "displayName": "string",
42       "address": "string",
43       "city": "string",
44       "state": "string",
45       "zip": "string",
46       "country": "string",
47       "ip": "string",
48       "lat": "string",
49       "lng": "string",
50       "dob": "string",
51       "email": "string",
52       "firstName": "string",
53       "lastName": "string"
54     },
55     "blockchain": "solana",
56     "exempt3DS": true,
57     "chargebackProtectionOverrideLog": {
58       "reason": "customer_override",
59       "editor": "string",
60       "editorType": "Coinflow",
61       "overriddenAt": "2024-01-15T09:30:00Z",
62       "ipAddress": "string",
63       "nsureOverrideReason": "internalTesting"
64     },
65     "geoBlockOverride": {
66       "reason": "string",
67       "setBy": "string",
68       "setAt": "2024-01-15T09:30:00Z",
69       "expiresAt": "2024-01-15T09:30:00Z"
70     },
71     "blockConfigOverride": {
72       "maxDistinctTokensPer30Days": 1.1
73     },
74     "customerOverrideLimit": {
75       "cents": 1
76     }
77   }
78 ]

List customers for a merchant

Authentication

Authorizationstring

The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Authorizationstring

API Key authentication via header

Query parameters

limitdoubleOptional

pagedoubleOptional

blockedstringOptional

searchstringOptional

sortByenumOptional

Allowed values:

sortDirectiondoubleOptional

protectionstringOptional

Response

_idstring

emailstring

createdAtdatetime

merchantstring or object

availabilityobject

chargebackProtectionEnabledboolean

failedAttemptSettingenum

verificationSettingenum

walletstring

verificationobject

uboslist of objects

customerInfoobject

blockchainenum

exempt3DSboolean

chargebackProtectionOverrideLogobject

geoBlockOverrideobject

Per-customer exemption from real-time geographic enforcement.

When set and not expired, withdrawal blocking rules with method GEOLOCATION or IP are skipped for this withdrawer. KYC_ADDRESS rules still apply — KYC is the compliance floor and must remain enforceable.

Auditable by construction: reason and setBy are required so admins can review why a specific user was exempted. expiresAt is optional but strongly recommended; long-lived overrides should be avoided.

blockConfigOverrideobject

Per-customer overrides of merchant blockConfig. Only honored when they raise the effective limit.

customerOverrideLimitobject