List all accounts - Equals Documentation

GET

accounts

List all accounts

curl --request GET \
  --url https://api.equalsmoney.com/v2/accounts \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.equalsmoney.com/v2/accounts"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.equalsmoney.com/v2/accounts', 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.equalsmoney.com/v2/accounts",
  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.equalsmoney.com/v2/accounts"

	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.equalsmoney.com/v2/accounts")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.equalsmoney.com/v2/accounts")

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

{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "rows": [
    {
      "id": "F50091",
      "type": "Business",
      "status": "applicationPending",
      "termsAccepted": true,
      "correlationId": "16700261790",
      "privacyAccepted": true,
      "salesperson": "Lester Spinka",
      "accountManager": "Kerry McDermott",
      "bankEntity": "BARC",
      "configurationId": "12345678901",
      "currentRiskLevel": "Low",
      "tier": "BRONZE",
      "features": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "accountId": "F50091",
        "payments": true,
        "batchPayments": true,
        "cards": true,
        "virtualCards": "active",
        "physicalCards": "active",
        "microCorp": true,
        "sharedCardProductId": "554bab88-15af-49ca-bd53-d0bd3aeab002",
        "individualVirtualCardProductId": "78da7405-b96f-4404-8bdc-b2af36413bed",
        "individualPhysicalCardProductId": "d92913b7-2f88-490c-84d3-4293ec0b3472",
        "useBalanceName": true,
        "forwardContracts": true,
        "sourceOfBalance": "boxes",
        "cardsSharedType": "prepaid",
        "cardsIndividualType": "prepaid",
        "selfApprove": true,
        "apiIgnorePaymentApproval": true,
        "moveMoneyRequests": true,
        "subBalances": true,
        "autoCreditToFundsHeld": true,
        "dualAuthorise": true,
        "freeInternalTransfers": true,
        "expediteCardProcessingEnabled": true,
        "enforceMFAVerification": false,
        "pinForVirtualCardsEnabled": false,
        "sharedCardsEnabled": true,
        "individualCardsEnabled": true,
        "lowBalanceAlertsEnabled": false,
        "minimumCardOrderTopUpAmount": 0,
        "minimumCardOrderTopUpAmountReached": true,
        "statementsFrom": "2019-08-24T14:15:22Z",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "productId": "3ef24d53-6e22-4103-a16b-d268e4f7346d",
      "primaryOwner": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "firstName": "Dolly",
        "lastName": "Parton",
        "title": "Master",
        "middleInitials": "R",
        "dob": "1946-01-19",
        "gender": "Female",
        "nationality": "US",
        "nationalities": [
          "GB"
        ],
        "countryOfResidence": "US",
        "primaryMobileNumber": "+447798121212",
        "primaryEmailAddress": "test@equalsqa.com",
        "avatar": {
          "url": "string",
          "fileName": "string"
        },
        "sendInvite": true,
        "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",
        "verifyEmailAddress": true,
        "verifyMobileNumber": true,
        "sub": "8e214819-5c83-429f-a976-eb127a0a8a88 or auth0|12345a6b7890c1def1234dg5",
        "hasPeopleCard": true,
        "card": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        },
        "status": "active",
        "locale": "en-GB",
        "productId": "3ef24d53-6e22-4103-a16b-d268e4f7346d",
        "avatarId": "ac572b6e-802b-4b9e-a602-0786d4441e67",
        "avatarCdnUrl": "string",
        "emailTheme": "string",
        "preferred2FAMethod": "whatsapp",
        "persona": {},
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "primaryOwnerPersonaId": "8e214819-5c83-429f-a976-eb127a0a8a88",
      "business": {
        "accountId": "F50091",
        "name": "FairFX",
        "countryOfRegistration": "United Kingdom",
        "companyType": "Limited",
        "companiesHouseId": "05539698",
        "telephoneNumber": "020 122 123",
        "timezone": "Europe/London",
        "registeredName": "FairFX",
        "tradingName": "FairFX Group",
        "website": "https://fairfx.com",
        "industry": "Financial Services",
        "fourthLine": "FairFX",
        "logo": {
          "url": "string",
          "fileName": "string"
        },
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "personal": {
        "accountId": "F50091",
        "name": "FairFX",
        "countryOfRegistration": "United Kingdom",
        "companyType": "companyType",
        "companiesHouseId": "05539698",
        "telephoneNumber": "020 122 123",
        "timezone": "Europe/London",
        "registeredName": "FairFX",
        "tradingName": "FairFX Group",
        "website": "https://fairfx.com",
        "industry": "Financial Services",
        "logo": {
          "url": "string",
          "fileName": "string"
        },
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "addresses": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "type": "office",
          "nickName": "office",
          "addressLine1": "Great Building",
          "addressLine2": "Four Maple Street",
          "addressLine3": "Southwark",
          "addressContact": "Brian May",
          "city": "string",
          "postcode": "SE13UB",
          "country": "England",
          "countryCode": "GB",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z"
        }
      ],
      "currencies": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "code": "GBP",
          "name": "Pound Sterling",
          "status": {
            "enabled": true
          }
        }
      ],
      "payments": {
        "id": "string",
        "active": true,
        "maxLength": 42,
        "depositRequired": 5,
        "maxAmount": 500000,
        "accountId": "F50091"
      },
      "solutions": true,
      "maxCardsAndBudgets": {
        "maxIndividualCards": 0,
        "maxSharedCards": 0,
        "maxBudgets": 0,
        "maxIndividualCardsPerPerson": 0
      },
      "locale": "en-GB",
      "preferredLanguage": "EN",
      "details": {
        "accountId": "F50091",
        "name": "FairFX",
        "countryOfRegistration": "United Kingdom",
        "companyType": "Limited",
        "companiesHouseId": "05539698",
        "telephoneNumber": "020 122 123",
        "timezone": "Europe/London",
        "registeredName": "FairFX",
        "tradingName": "FairFX Group",
        "website": "https://fairfx.com",
        "industry": "Financial Services",
        "fourthLine": "FairFX",
        "logo": {
          "url": "string",
          "fileName": "string"
        },
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "marketId": "3ef24d53-6e22-4103-a16b-d268e4f7346d",
      "market": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "UK",
        "bank": "string",
        "baseCurrencyId": "7188015d-0ba6-4f9a-a255-5c3b5aa06eca",
        "atmWithdrawalFee": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

Query Parameters

limit

integer

default:100

The maximum number of results to return.

Required range: 1 <= x <= 1000

Example:

200

offset

integer

default:0

The number of items to skip before returning results.

Example:

100

primaryEmailAddress

string<email>

Example:

"test@example.com"

string

include

enum<string>

Optional embeds to include when returning accounts

Available options:

market

Example:

"market"

Response

200 - application/json

count

integer

required

The total amount of records matching the querying when "limit" is ignored.

Example:

67

rows

object[]

required

Show child attributes

limit

integer

default:100

The maximum number of results to return.

Required range: 1 <= x <= 1000

Example:

200

offset

integer

default:0

The number of items to skip before returning results.

Example:

100

⌘I

List all accounts

curl --request GET \
  --url https://api.equalsmoney.com/v2/accounts \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.equalsmoney.com/v2/accounts"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.equalsmoney.com/v2/accounts', 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.equalsmoney.com/v2/accounts",
  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.equalsmoney.com/v2/accounts"

	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.equalsmoney.com/v2/accounts")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.equalsmoney.com/v2/accounts")

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

{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "rows": [
    {
      "id": "F50091",
      "type": "Business",
      "status": "applicationPending",
      "termsAccepted": true,
      "correlationId": "16700261790",
      "privacyAccepted": true,
      "salesperson": "Lester Spinka",
      "accountManager": "Kerry McDermott",
      "bankEntity": "BARC",
      "configurationId": "12345678901",
      "currentRiskLevel": "Low",
      "tier": "BRONZE",
      "features": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "accountId": "F50091",
        "payments": true,
        "batchPayments": true,
        "cards": true,
        "virtualCards": "active",
        "physicalCards": "active",
        "microCorp": true,
        "sharedCardProductId": "554bab88-15af-49ca-bd53-d0bd3aeab002",
        "individualVirtualCardProductId": "78da7405-b96f-4404-8bdc-b2af36413bed",
        "individualPhysicalCardProductId": "d92913b7-2f88-490c-84d3-4293ec0b3472",
        "useBalanceName": true,
        "forwardContracts": true,
        "sourceOfBalance": "boxes",
        "cardsSharedType": "prepaid",
        "cardsIndividualType": "prepaid",
        "selfApprove": true,
        "apiIgnorePaymentApproval": true,
        "moveMoneyRequests": true,
        "subBalances": true,
        "autoCreditToFundsHeld": true,
        "dualAuthorise": true,
        "freeInternalTransfers": true,
        "expediteCardProcessingEnabled": true,
        "enforceMFAVerification": false,
        "pinForVirtualCardsEnabled": false,
        "sharedCardsEnabled": true,
        "individualCardsEnabled": true,
        "lowBalanceAlertsEnabled": false,
        "minimumCardOrderTopUpAmount": 0,
        "minimumCardOrderTopUpAmountReached": true,
        "statementsFrom": "2019-08-24T14:15:22Z",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "productId": "3ef24d53-6e22-4103-a16b-d268e4f7346d",
      "primaryOwner": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "firstName": "Dolly",
        "lastName": "Parton",
        "title": "Master",
        "middleInitials": "R",
        "dob": "1946-01-19",
        "gender": "Female",
        "nationality": "US",
        "nationalities": [
          "GB"
        ],
        "countryOfResidence": "US",
        "primaryMobileNumber": "+447798121212",
        "primaryEmailAddress": "test@equalsqa.com",
        "avatar": {
          "url": "string",
          "fileName": "string"
        },
        "sendInvite": true,
        "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391",
        "verifyEmailAddress": true,
        "verifyMobileNumber": true,
        "sub": "8e214819-5c83-429f-a976-eb127a0a8a88 or auth0|12345a6b7890c1def1234dg5",
        "hasPeopleCard": true,
        "card": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        },
        "status": "active",
        "locale": "en-GB",
        "productId": "3ef24d53-6e22-4103-a16b-d268e4f7346d",
        "avatarId": "ac572b6e-802b-4b9e-a602-0786d4441e67",
        "avatarCdnUrl": "string",
        "emailTheme": "string",
        "preferred2FAMethod": "whatsapp",
        "persona": {},
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "primaryOwnerPersonaId": "8e214819-5c83-429f-a976-eb127a0a8a88",
      "business": {
        "accountId": "F50091",
        "name": "FairFX",
        "countryOfRegistration": "United Kingdom",
        "companyType": "Limited",
        "companiesHouseId": "05539698",
        "telephoneNumber": "020 122 123",
        "timezone": "Europe/London",
        "registeredName": "FairFX",
        "tradingName": "FairFX Group",
        "website": "https://fairfx.com",
        "industry": "Financial Services",
        "fourthLine": "FairFX",
        "logo": {
          "url": "string",
          "fileName": "string"
        },
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "personal": {
        "accountId": "F50091",
        "name": "FairFX",
        "countryOfRegistration": "United Kingdom",
        "companyType": "companyType",
        "companiesHouseId": "05539698",
        "telephoneNumber": "020 122 123",
        "timezone": "Europe/London",
        "registeredName": "FairFX",
        "tradingName": "FairFX Group",
        "website": "https://fairfx.com",
        "industry": "Financial Services",
        "logo": {
          "url": "string",
          "fileName": "string"
        },
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "addresses": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "type": "office",
          "nickName": "office",
          "addressLine1": "Great Building",
          "addressLine2": "Four Maple Street",
          "addressLine3": "Southwark",
          "addressContact": "Brian May",
          "city": "string",
          "postcode": "SE13UB",
          "country": "England",
          "countryCode": "GB",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z"
        }
      ],
      "currencies": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "code": "GBP",
          "name": "Pound Sterling",
          "status": {
            "enabled": true
          }
        }
      ],
      "payments": {
        "id": "string",
        "active": true,
        "maxLength": 42,
        "depositRequired": 5,
        "maxAmount": 500000,
        "accountId": "F50091"
      },
      "solutions": true,
      "maxCardsAndBudgets": {
        "maxIndividualCards": 0,
        "maxSharedCards": 0,
        "maxBudgets": 0,
        "maxIndividualCardsPerPerson": 0
      },
      "locale": "en-GB",
      "preferredLanguage": "EN",
      "details": {
        "accountId": "F50091",
        "name": "FairFX",
        "countryOfRegistration": "United Kingdom",
        "companyType": "Limited",
        "companiesHouseId": "05539698",
        "telephoneNumber": "020 122 123",
        "timezone": "Europe/London",
        "registeredName": "FairFX",
        "tradingName": "FairFX Group",
        "website": "https://fairfx.com",
        "industry": "Financial Services",
        "fourthLine": "FairFX",
        "logo": {
          "url": "string",
          "fileName": "string"
        },
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "marketId": "3ef24d53-6e22-4103-a16b-d268e4f7346d",
      "market": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "UK",
        "bank": "string",
        "baseCurrencyId": "7188015d-0ba6-4f9a-a255-5c3b5aa06eca",
        "atmWithdrawalFee": 0,
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}