EQequalsmoney
Onboarding

List onboarding applications

Returns a paginated list of onboarding applications. Results are sorted by createdAt descending (newest first).

get/applications

Request

Query parameters

limitinteger

The maximum number of results to return.

Example:200
offsetinteger

The number of items to skip before returning results.

Example:100
'DRAFT' | 'SUBMITTED' | 'APPROVED' | 'REJECTED'
OR
string[]
'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'
OR
string[]
searchstring

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

Example:Equals Money
isActionRequired'true' | 'false'

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

Response

OK

limitinteger

The maximum number of results to return.

offsetinteger

The number of items to skip before returning results.

countinteger required

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

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.