Retrieve an onboarding application

GET

applications

{applicationId}

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

import requests

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

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/{applicationId}', 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/{applicationId}",
  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/{applicationId}"

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

require 'uri'
require 'net/http'

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

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

{
  "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

Path Parameters

applicationId

string<uuid>

required

The ID of the application to work with.

Maximum string length: 36

Example:

"e9293471-5eb3-4dbc-916c-dbaf9e2deefd"

Response

200 - application/json

BusinessApplication
PersonalApplication

string<uuid>

required

The ID of the application to work with.

Maximum string length: 36

Example:

"e9293471-5eb3-4dbc-916c-dbaf9e2deefd"

status

enum<string>

required

Available options:

DRAFT,

SUBMITTED,

APPROVED,

REJECTED

accountId

string | null

required

The ID of the account to work with.

Example:

"F50091"

configurationId

string | null

required

The configuration ID used for billing configuration. Links the account to a specific fee structure. Set when the account is created, cannot be modified afterwards.

Maximum string length: 36

Example:

"12345678901"

market

enum<string>

required

Available options:

UK,

EU,

US,

UP

isActionRequired

boolean | null

required

Whether this application is awaiting customer action before it can progress.

Example:

false

consents

object | null

required

Marketing email consents collected from the applicant at onboarding. Each consent defaults to false when not provided.

Show child attributes

preferredLanguage

enum<string> | null

required

The preferred language for business correspondence. ISO 639-1 uppercase.

Available options:

EN,

FR,

DE,

ES,

IT,

NL,

PT

createdAt

string<date-time>

required

The date the Resource was initially created. ISO 8601 format without milliseconds.

updatedAt

string<date-time>

required

The date the Resource was last modified. ISO 8601 format without milliseconds.

type

enum<string>

required

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

countryOfIncorporation

enum<string>

required

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

XK,

YE,

YT,

ZA,

ZM,

ZW

Example:

"GB"

regionOfIncorporation

string | null

required

State, region, or municipality where the company was legally incorporated within the specified countryOfIncorporation. Required when countryOfIncorporation is US or DE.

Required string length: 2 - 255

registeredName

string

required

Required string length: 1 - 255

Example:

"Equals Money Plc"

registrationNumber

string | null

required

Required string length: 1 - 255

Example:

"05539698"

tradingNames

string[]

required

Required string length: 1 - 255

businessOverview

string

required

Required string length: 1 - 1000

Example:

"We are a small business that provides financial services to small businesses."

industry

Accommodation and Food Service Activities · object

required

Accommodation and Food Service Activities
Activities of Extraterritorial Organisations and Bodies
Activities of Households as Employers; Undifferentiated Goods- and Services-Producing Activities of Households for Own Use
Administrative and Support Service Activities
Adult & Dating Services/Adult Products
Agriculture, Forestry, and Fishing
Arts, Entertainment, and Recreation
CFD and spreadbetting
Charities
Construction
Crypto Currency & Digital Assets
Education
Electricity, Gas, Steam, and Air Conditioning Supply
Energy & Fossil Fuels
Financial and Insurance Activities
Government
Human Health and Social Work Activities
Information and Communication
Manufacturing
Marine Vessels & Watercraft
Mining and Quarrying
Motor Vehicles and Motorcycles
Other Services Activities
Pharmaceuticals
Professional, Scientific, and Technical Activities
Public Administration and Defence; Compulsory Social Security
Real Estate Activities
Trade / Commerce
Transportation and Storage
Water Supply; Sewerage, Waste Management, and Remediation Activities
Weapons, Blades, Self-Defence and Military

Show child attributes

employeeCount

enum<string>

required

Available options:

ONE_TO_TEN,

ELEVEN_TO_FIFTY,

FIFTY_ONE_TO_TWO_HUNDRED,

TWO_HUNDRED_AND_ONE_TO_FIVE_HUNDRED,

FIVE_HUNDRED_AND_ONE_TO_ONE_THOUSAND,

ONE_THOUSAND_AND_ONE_TO_FIVE_THOUSAND,

FIVE_THOUSAND_AND_ONE_TO_TEN_THOUSAND,

TEN_THOUSAND_PLUS

incorporationDate

string

required

Example:

"2020-01-01"

phoneNumber

string | null

required

Required string length: 1 - 255

Example:

"+447911123456"

taxId

string | null

required

Required string length: 1 - 255

Example:

"GB123456789"

website

string<uri> | null

required

Example:

"https://equals.money"

businessPromotionDescription

string | null

required

Required string length: 1 - 1000

Example:

"We send out leaflets in the post."

associatedPeople

(Applicant · object | Director · object | Ultimate Beneficial Owner · object)[]

required

Applicant
Director
Ultimate Beneficial Owner

Show child attributes

featureInformation

object

required

Show child attributes

addresses

object[]

required

Minimum array length: 1

Show child attributes

⌘I

Retrieve an onboarding application

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

import requests

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

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/{applicationId}', 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/{applicationId}",
  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/{applicationId}"

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

require 'uri'
require 'net/http'

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

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

{
  "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

Path Parameters

Response