Get Customer | Coinflow

curl https://api-sandbox.coinflow.cash/api/customer/v2 \
     -H "x-coinflow-auth-session-key: <apiKey>"

{
  "customer": {
    "_id": "string",
    "email": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "merchant": "string",
    "customerId": "string",
    "bankAccounts": [
      {
        "last4": "string",
        "accountHash": "string",
        "alias": "string",
        "token": "string",
        "reference": "string",
        "accountNumberOnlyHash": "string",
        "isDeleted": true,
        "isTokenized": true,
        "accountNumber": "string"
      }
    ],
    "cards": [
      {
        "last4": "string",
        "token": "string",
        "type": "VISA",
        "disbursementStatus": "Immediate",
        "createdAt": "2024-01-15T09:30:00Z",
        "hasAddress": true,
        "isDeleted": true,
        "currency": "USD",
        "nameOnCard": "string",
        "expMonth": "string",
        "expYear": "string"
      }
    ],
    "sepas": [
      {
        "last4": "string",
        "accountHash": "string",
        "alias": "string",
        "token": "string",
        "reference": "string",
        "sortCode": "string",
        "bic": "string"
      }
    ],
    "fasterPayments": [
      {
        "last4": "string",
        "accountHash": "string",
        "alias": "string",
        "token": "string",
        "reference": "string",
        "sortCode": "string",
        "bic": "string"
      }
    ],
    "blockchain": "solana",
    "geoBlockOverride": {
      "reason": "string",
      "setBy": "string",
      "setAt": "2024-01-15T09:30:00Z",
      "expiresAt": "2024-01-15T09:30:00Z"
    }
  },
  "kycApproved": true
}

Gets the Customer record for a particular user.

Authentication

x-coinflow-auth-session-keystring

The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

x-coinflow-auth-walletstring

The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

x-coinflow-auth-blockchainstring

The blockchain associated with the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Response

customerobject or null

The object representing the customer, will be null on the first purchase.

kycApprovedboolean

True when the customer (or the wallet’s linked withdrawer/business) has an Approved KYC, the UI uses to decide whether to show the KYC gate

Errors

412

Precondition Failed Error

451

Unavailable for Legal Reasons Error