Skip to main content
PATCH

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"

Body

application/json

Body

accountGroupIds
string<uuid>[] | null

The account groups the application belongs to. Scopes it to a partner or relationship-managed book, in addition to the product. Each must be an account group of the requesting product. The account is added to every one of them on activation.

The ID of an account group. Must be an account group of the requesting product.

configurationId
string | null

The configuration ID used for billing configuration. Links the account to a specific fee structure. Set when the account is created; afterwards modifiable by Equals staff only.

Maximum string length: 36
Example:

"12345678901"

market
enum<string>
Available options:
UK,
EU,
US,
UP
consents
object | null

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

preferredLanguage
enum<string> | null

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

Available options:
EN,
FR,
DE,
ES,
IT,
NL,
PT
type
enum<string>
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>
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

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
Example:

"Berlin"

registeredName
string
Required string length: 1 - 255
Example:

"Equals Money Plc"

registrationNumber
string | null
Required string length: 1 - 255
Example:

"05539698"

tradingNames
string[]
Required string length: 1 - 255
businessOverview
string
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
employeeCount
enum<string>
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
Example:

"2020-01-01"

phoneNumber
string | null
Required string length: 1 - 255
Example:

"+447911123456"

taxId
string | null
Required string length: 1 - 255
Example:

"GB123456789"

website
string<uri> | null
Example:

"https://equals.money"

businessPromotionDescription
string | null
Required string length: 1 - 1000
Example:

"We send out leaflets in the post."

associatedPeople
(Applicant · object | Director · object | Ultimate Beneficial Owner · object)[]
featureInformation
object
addresses
object[]
Minimum array length: 1

Response

200 - application/json

OK

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

accountGroupIds
string<uuid>[] | null
required

The account groups the application belongs to. Scopes it to a partner or relationship-managed book, in addition to the product. Each must be an account group of the requesting product. The account is added to every one of them on activation.

The ID of an account group. Must be an account group of the requesting product.

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; afterwards modifiable by Equals staff only.

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.

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
Example:

"Berlin"

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
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
featureInformation
object
required
addresses
object[]
required
Minimum array length: 1