List onboarding applications

GET

applications

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

import requests

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

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/applications', 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/applications",
  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/applications"

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

require 'uri'
require 'net/http'

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

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": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
      "status": "DRAFT",
      "accountId": "F50091",
      "configurationId": "12345678901",
      "market": "UK",
      "isActionRequired": false,
      "consents": {
        "marketReport": true,
        "productUpdates": true,
        "accountUsage": false
      },
      "preferredLanguage": "EN",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "type": "PRIVATE_COMPANY",
      "countryOfIncorporation": "GB",
      "regionOfIncorporation": "string",
      "registeredName": "Equals Money Plc",
      "registrationNumber": "05539698",
      "tradingNames": [
        "Equals Railsr"
      ],
      "businessOverview": "We are a small business that provides financial services to small businesses.",
      "industry": {
        "main": "ACCOMMODATION_FOOD",
        "sub": "ACCOMMODATION"
      },
      "employeeCount": "ONE_TO_TEN",
      "incorporationDate": "2020-01-01",
      "phoneNumber": "+447911123456",
      "taxId": "GB123456789",
      "website": "https://equals.money",
      "businessPromotionDescription": "We send out leaflets in the post.",
      "associatedPeople": [
        {
          "associatedPersonId": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
          "associationType": "APPLICANT",
          "jobTitle": "Director"
        }
      ],
      "featureInformation": {
        "requestedFeatures": [
          "PAYMENTS"
        ],
        "cardsInformation": {
          "businessDisplayName": "CUSTOMER",
          "purposes": [
            "ADVERTISING_AND_MARKETING"
          ],
          "estimatedAnnualSpend": "0-10000",
          "numberOfCardsRequired": "0-10",
          "cardsAreForEmployees": true,
          "atmWithdrawalsRequired": true,
          "cardProducts": {
            "individualVirtual": "03e9e3df-ad27-4bfc-9e97-a3ba3d537580",
            "individualPhysical": "f90df540-a102-4876-bf01-8594cf50af5c",
            "shared": "2310830e-60d4-4930-8ee5-c729d2ce8303"
          }
        },
        "paymentsInformation": {
          "purposes": [
            "PAYING_SUPPLIERS"
          ],
          "accountFundingSource": [
            "RECEIVING_FUNDS_FROM_OWN_ACCOUNTS"
          ],
          "estimatedPaymentCount": "5-20",
          "estimatedPaymentVolume": "0-10000",
          "inboundCurrencies": [
            "USD"
          ],
          "outboundCurrencies": [
            "USD"
          ],
          "receivingCountries": [
            "GB"
          ],
          "sendingCountries": [
            "GB"
          ]
        }
      },
      "addresses": [
        {
          "addressType": "REGISTERED",
          "streetName": "Upper Thames Street",
          "buildingNumber": "68",
          "buildingName": "Vintners Place",
          "postcode": "EC4V 3BJ",
          "city": "London",
          "region": "Greater London",
          "countryCode": "GB"
        }
      ]
    }
  ]
}

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

status

enum<string>

Filter by application status. Use commas to pass multiple values. Has to be URL encoded.

Available options:

DRAFT,

SUBMITTED,

APPROVED,

REJECTED

Example:

"DRAFT%2CSUBMITTED"

type

enum<string>

Filter by application type. Use commas to pass multiple values. Has to be URL encoded.

Available options:

PRIVATE_COMPANY,

SOLE_TRADER,

PUBLIC_COMPANY_LISTED,

PUBLIC_COMPANY_UNLISTED,

PARTNERSHIP,

CHARITY,

NON_PROFIT,

SOCIAL_ENTERPRISE,

PENSION,

FUND,

TRUST,

SEGREGATED_PORTFOLIO_COMPANY,

COOPERATIVE,

OTHER,

INDIVIDUAL

Example:

"PRIVATE_COMPANY%2CINDIVIDUAL"

string

Search applications by registered name, registration number, first name, last name, or email.

Example:

"Equals Money"

isActionRequired

enum<string>

Filter applications by whether they are awaiting customer action. Omit to disable the filter.

Available options:

true,

false

Response

200 - application/json

count

integer

required

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

Example:

67

rows

(BusinessApplication · object | PersonalApplication · object)[]

required

List of applications matching the query criteria.

BusinessApplication
PersonalApplication

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 onboarding applications

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

import requests

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

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/applications', 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/applications",
  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/applications"

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

require 'uri'
require 'net/http'

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

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": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
      "status": "DRAFT",
      "accountId": "F50091",
      "configurationId": "12345678901",
      "market": "UK",
      "isActionRequired": false,
      "consents": {
        "marketReport": true,
        "productUpdates": true,
        "accountUsage": false
      },
      "preferredLanguage": "EN",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "type": "PRIVATE_COMPANY",
      "countryOfIncorporation": "GB",
      "regionOfIncorporation": "string",
      "registeredName": "Equals Money Plc",
      "registrationNumber": "05539698",
      "tradingNames": [
        "Equals Railsr"
      ],
      "businessOverview": "We are a small business that provides financial services to small businesses.",
      "industry": {
        "main": "ACCOMMODATION_FOOD",
        "sub": "ACCOMMODATION"
      },
      "employeeCount": "ONE_TO_TEN",
      "incorporationDate": "2020-01-01",
      "phoneNumber": "+447911123456",
      "taxId": "GB123456789",
      "website": "https://equals.money",
      "businessPromotionDescription": "We send out leaflets in the post.",
      "associatedPeople": [
        {
          "associatedPersonId": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
          "associationType": "APPLICANT",
          "jobTitle": "Director"
        }
      ],
      "featureInformation": {
        "requestedFeatures": [
          "PAYMENTS"
        ],
        "cardsInformation": {
          "businessDisplayName": "CUSTOMER",
          "purposes": [
            "ADVERTISING_AND_MARKETING"
          ],
          "estimatedAnnualSpend": "0-10000",
          "numberOfCardsRequired": "0-10",
          "cardsAreForEmployees": true,
          "atmWithdrawalsRequired": true,
          "cardProducts": {
            "individualVirtual": "03e9e3df-ad27-4bfc-9e97-a3ba3d537580",
            "individualPhysical": "f90df540-a102-4876-bf01-8594cf50af5c",
            "shared": "2310830e-60d4-4930-8ee5-c729d2ce8303"
          }
        },
        "paymentsInformation": {
          "purposes": [
            "PAYING_SUPPLIERS"
          ],
          "accountFundingSource": [
            "RECEIVING_FUNDS_FROM_OWN_ACCOUNTS"
          ],
          "estimatedPaymentCount": "5-20",
          "estimatedPaymentVolume": "0-10000",
          "inboundCurrencies": [
            "USD"
          ],
          "outboundCurrencies": [
            "USD"
          ],
          "receivingCountries": [
            "GB"
          ],
          "sendingCountries": [
            "GB"
          ]
        }
      },
      "addresses": [
        {
          "addressType": "REGISTERED",
          "streetName": "Upper Thames Street",
          "buildingNumber": "68",
          "buildingName": "Vintners Place",
          "postcode": "EC4V 3BJ",
          "city": "London",
          "region": "Greater London",
          "countryCode": "GB"
        }
      ]
    }
  ]
}

Group placeholder

Group

Group

Authorizations

Query Parameters

Response