Equals Money API

https://docs.equalsmoney.com/
Admin
Equals Money API allows developers to build financial products by leveraging their technology stack,...
Tokens:558,063
Snippets:2,057
Trust Score:9.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Retrieve an Onboarding Application

Source: https://docs.equalsmoney.com/api-reference/onboarding/retrieve-an-onboarding-application

Examples of how to perform a GET request to retrieve application details across various programming languages.

```python
import requests  
  
url = "https://api.equalsmoney.com/v2/applications/{applicationId}"  
  
headers = {"Authorization": "<api-key>"}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

```javascript
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
<?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;  
}
```

```go
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))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.equalsmoney.com/v2/applications/{applicationId}")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
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
```

--------------------------------

### BusinessApplication OpenAPI Example

Source: https://docs.equalsmoney.com/api-reference/onboarding/create-a-new-onboarding-application

Example JSON object representing a business onboarding application.

```json
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
```

--------------------------------

### Configuration ID Example

Source: https://docs.equalsmoney.com/api-reference/onboarding/retrieve-an-onboarding-application

Example of a configuration identifier string.

```text
"12345678901"
```

--------------------------------

### Parameter Examples

Source: https://docs.equalsmoney.com/openapi/em-cards/operation/createPhysicalCard

Examples for various request parameters used in the API.

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

```text
"F50091"
```

```text
"775596ae-2624-40af-a9dc-9756110a4a04"
```

```text
"1c480aec-406b-41fb-b03a-5656d8fc71cf"
```

```text
"1111"
```

```text
"care of xyz"
```

--------------------------------

### Budget ID Path Parameter Example

Source: https://docs.equalsmoney.com/api-reference/budgets/retrieve-budget-details

Example value for the required budgetId path parameter.

```text
"775596ae-2624-40af-a9dc-9756110a4a03"
```

--------------------------------

### Response Example

Source: https://docs.equalsmoney.com/api-reference/direct-debits/list-all-direct-debit-payment-requests

Example of a successful 200 OK response body.

```json
{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "rows": [
    {
      "id": "775596ae-2624-40af-a9dc-9756110a4a03",
      "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
      "reference": "fre4r5tg",
      "status": "PENDING",
      "amount": "100",
      "currency": "USD",
      "originator": {
        "id": "123456",
        "accountName": "Netflix Inc",
        "bankIdentifier": "string",
        "accountIdentifier": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "processedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
```

--------------------------------

### List Guided Identity Verification Sessions API Request

Source: https://docs.equalsmoney.com/api-reference/onboarding/list-guided-identity-verification-sessions

Examples of how to perform a GET request to retrieve identity verification sessions using various programming languages.

```bash
curl --request GET \
  --url 'https://api.equalsmoney.com/v2/applications/identity-verification-sessions?limit=100' \
  --header 'Authorization: <api-key>'
```

```python
import requests  
  
url = "https://api.equalsmoney.com/v2/applications/identity-verification-sessions?limit=100"  
  
headers = {"Authorization": "<api-key>"}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};  
  
fetch('https://api.equalsmoney.com/v2/applications/identity-verification-sessions?limit=100', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.equalsmoney.com/v2/applications/identity-verification-sessions?limit=100",  
  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;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.equalsmoney.com/v2/applications/identity-verification-sessions?limit=100"  
  
	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))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.equalsmoney.com/v2/applications/identity-verification-sessions?limit=100")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.equalsmoney.com/v2/applications/identity-verification-sessions?limit=100")  
  
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
```

--------------------------------

### GET /v2/applications/identity-verification-sessions

Source: https://docs.equalsmoney.com/api-reference/onboarding/list-guided-identity-verification-sessions

Retrieves a list of guided identity verification sessions.

```APIDOC
## GET /v2/applications/identity-verification-sessions

### Description
Retrieves a list of Guided identity verification sessions matching the query criteria.

### Method
GET

### Endpoint
https://api.equalsmoney.com/v2/applications/identity-verification-sessions

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of results to return. Default: 100. Range: 1-1000.
- **offset** (integer) - Optional - The number of items to skip before returning results. Default: 0.

### Response
#### Success Response (200)
- **count** (integer) - The total amount of records matching the querying when "limit" is ignored.
- **rows** (object[]) - List of Guided identity verification sessions matching the query criteria.
- **limit** (integer) - The limit applied to the request.
- **offset** (integer) - The offset applied to the request.

#### Response Example
{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "rows": [
    {
      "id": "5f8a2c14-3e6b-4d9f-a1b2-c3d4e5f60789",
      "applicationId": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
      "associatedPersonId": "d4c3b2a1-5678-4e9a-bcde-f01234567890",
      "correlationId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
      "actionUrl": "https://verify.example.com/session/abc123",
      "status": "completed",
      "result": "approved",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
```

--------------------------------

### GET /v2/activity/{accountId}

Source: https://docs.equalsmoney.com/pages/get-started/about-the-api

Example of using the search parameter to filter transaction activity by a specific term.

```APIDOC
## GET /v2/activity/{accountId}

### Description
Retrieve transaction activity for a specific account, optionally filtered by a search term.

### Method
GET

### Endpoint
https://api.equalsmoney.com/v2/activity/{accountId}

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The unique identifier of the account.

#### Query Parameters
- **search** (string) - Optional - A search term to filter the results (e.g., a name).

### Request Example
curl -i -X GET \
  'https://api.equalsmoney.com/v2/activity/{accountId}?search=Jane+Doe' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'
```

--------------------------------

### POST /onboarding/create-an-account

Source: https://docs.equalsmoney.com/api-reference/onboarding/create-an-account

Initiates the account onboarding process by submitting business and product configuration details.

```APIDOC
## POST /onboarding/create-an-account

### Description
Initiates the account onboarding process for a new business account.

### Method
POST

### Request Body
- **annualVolume** (string) - Required - Annual volume description (e.g., Less than £10,000)
- **numberOfPayments** (string) - Required - Number of payments description (e.g., More than 20 payments)
- **expectedCardUse** (string) - Required - Expected card usage category
- **averageLoad** (string) - Required - Average load range
- **numberOfCards** (string) - Required - Number of cards range
- **cardFourthLine** (string) - Required - Fourth line text for cards
- **employeeCards** (boolean) - Required - Whether employee cards are enabled
- **atmWithdrawals** (boolean) - Required - Whether ATM withdrawals are enabled
- **cardProducts** (object) - Required - Mapping of card product types to IDs
- **market** (string) - Required - Market license (e.g., UK)
- **features** (string) - Required - Account features enabled
- **preferredLanguage** (string) - Required - Preferred language code (e.g., EN)

### Response
#### Success Response (202)
- **ok** (boolean) - Indicates if the onboarding was successful.
- **correlationId** (string) - The unique identifier used to track and link events in the AccountActivated and AccountCreated webhooks.
- **account** (object) - Details of the created account structure.
```

--------------------------------

### Retrieve an Onboarding Application

Source: https://docs.equalsmoney.com/api-reference/onboarding/retrieve-an-onboarding-application

Examples for fetching application details across various programming languages using the required Authorization header.

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

```python
import requests  
  
url = "https://api.equalsmoney.com/v2/applications/{applicationId}"  
  
headers = {"Authorization": "<api-key>"}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

```javascript
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
<?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;  
}
```

```go
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))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.equalsmoney.com/v2/applications/{applicationId}")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
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
```

--------------------------------

### Get Trading Days API Requests

Source: https://docs.equalsmoney.com/api-reference/payments/get-trading-days-for-a-currency-pair

Examples of how to fetch trading days using various programming languages and tools.

```curl
curl --request GET \
  --url 'https://api.equalsmoney.com/v2/trading-days?accountId={{accountId}}&sourceCurrencyCode={{sourceCurrencyCode}}&destinationCurrencyCode={{destinationCurrencyCode}}' \
  --header 'Authorization: <api-key>'
```

```python
import requests  
  
url = "https://api.equalsmoney.com/v2/trading-days"  
  
headers = {"Authorization": "<api-key>"}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};  
  
fetch('https://api.equalsmoney.com/v2/trading-days', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.equalsmoney.com/v2/trading-days",  
  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;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.equalsmoney.com/v2/trading-days"  
  
	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))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.equalsmoney.com/v2/trading-days")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
require 'uri'
require 'net/http'
  
url = URI("https://api.equalsmoney.com/v2/trading-days")
  
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
```

--------------------------------

### Create Onboarding Document Request Examples

Source: https://docs.equalsmoney.com/api-reference/onboarding/create-a-new-onboarding-application-document

Examples of how to perform a POST request to upload a document to an onboarding application across various programming languages.

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.equalsmoney.com/v2/applications/{applicationId}/documents",  
  CURLOPT_RETURNTRANSFER => true,  
  CURLOPT_ENCODING => "",  
  CURLOPT_MAXREDIRS => 10,  
  CURLOPT_TIMEOUT => 30,  
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,  
  CURLOPT_CUSTOMREQUEST => "POST",  
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"purpose\"\r\n\r\nPROOF_OF_FORMATION\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\nnull\r\n-----011000010111000001101001--",  
  CURLOPT_HTTPHEADER => [  
    "Authorization: <api-key>",  
    "Content-Type: multipart/form-data"  
  ],  
]);  
  
$response = curl_exec($curl);  
$err = curl_error($curl);  
  
curl_close($curl);  
  
if ($err) {  
  echo "cURL Error #:" . $err;  
} else {  
  echo $response;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"strings"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.equalsmoney.com/v2/applications/{applicationId}/documents"  
  
	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"purpose\"\r\n\r\nPROOF_OF_FORMATION\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\nnull\r\n-----011000010111000001101001--")  
  
	req, _ := http.NewRequest("POST", url, payload)  
  
	req.Header.Add("Authorization", "<api-key>")  
  
	res, _ := http.DefaultClient.Do(req)  
  
	defer res.Body.Close()  
	body, _ := io.ReadAll(res.Body)  
  
	fmt.Println(string(body))  
  
}
```

```java
HttpResponse<String> response = Unirest.post("https://api.equalsmoney.com/v2/applications/{applicationId}/documents")  
  .header("Authorization", "<api-key>")  
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"purpose\"\r\n\r\nPROOF_OF_FORMATION\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\nnull\r\n-----011000010111000001101001--")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.equalsmoney.com/v2/applications/{applicationId}/documents")  
  
http = Net::HTTP.new(url.host, url.port)  
http.use_ssl = true  
  
request = Net::HTTP::Post.new(url)  
request["Authorization"] = '<api-key>'  
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"purpose\"\r\n\r\nPROOF_OF_FORMATION\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\nnull\r\n-----011000010111000001101001--"  
  
response = http.request(request)  
puts response.read_body
```

--------------------------------

### GET /applications/identity-verification-sessions

Source: https://docs.equalsmoney.com/api-reference/onboarding/list-guided-identity-verification-sessions

Returns a paginated list of Guided identity verification sessions on your account. Results are sorted by createdAt descending.

```APIDOC
## GET /applications/identity-verification-sessions

### Description
Returns a paginated list of Guided identity verification sessions on your account. Results are sorted by createdAt descending (newest first). Filter by `applicationId` or `associatedPersonId` to narrow results.

### Method
GET

### Endpoint
https://api.equalsmoney.com/v2/applications/identity-verification-sessions

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of results to return. Default: 100. Range: 1-1000.
- **offset** (integer) - Optional - The number of items to skip before returning results. Default: 0.
- **applicationId** (string) - Optional - Filter sessions by application.
- **associatedPersonId** (string) - Optional - Filter sessions by associated person.

### Response
#### Success Response (200)
- **limit** (integer) - The limit applied to the request.
- **offset** (integer) - The offset applied to the request.
- **count** (integer) - The total number of items returned.
- **rows** (array) - List of identity verification session objects.

#### Response Example
{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "rows": [
    {
      "id": "5f8a2c14-3e6b-4d9f-a1b2-c3d4e5f60789",
      "applicationId": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
      "associatedPersonId": "d4c3b2a1-5678-4e9a-bcde-f01234567890",
      "correlationId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
      "actionUrl": "https://verify.example.com/session/abc123",
      "status": "completed",
      "result": "approved",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
```

--------------------------------

### POST /v2/onboarding

Source: https://docs.equalsmoney.com/pages/accounts/tutorial/create-accounts-for-cards

Submit details and start onboarding an account.

```APIDOC
## POST /v2/onboarding

### Description
Use this request to submit details and start onboarding an account.

### Method
POST

### Endpoint
/v2/onboarding

### Request Body
- **market** (string) - Optional - The market relating to the licence that the account operates under. Allowable values: UK, EU
- **features** (array) - Optional - The feature to enable on the account. Defaults to payments if not provided. Cannot be changed later. Allowable values: payments, cards
- **accountType** (string) - Required - The type of account you’re onboarding. Allowable values: business, personal
- **affiliateId** (string) - Optional - The affiliate ID. Allowable values: 36 characters
- **companyId** (string) - Optional - The company ID. Allowable values: 36 characters
- **contact** (object) - Required - Details about the contact (primary owner).
```

--------------------------------

### GET /applications

Source: https://docs.equalsmoney.com/api-reference/onboarding/list-onboarding-applications

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

```APIDOC
## GET /applications

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

### Method
GET

### Endpoint
/applications

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of results to return. Default: 100. Range: 1-1000.
- **offset** (integer) - Optional - The number of items to skip before returning results. Default: 0.
- **status** (string/array) - Optional - Filter by application status (DRAFT, SUBMITTED, APPROVED, REJECTED). Use commas to pass multiple values.
- **type** (string/array) - Optional - Filter by application type. Use commas to pass multiple values.
- **search** (string) - Optional - Search applications by registered name, registration number, first name, last name, or email.
- **isActionRequired** (string) - Optional - Filter applications by whether they are awaiting customer action ('true' or 'false').

### Response
#### Success Response (200)
- **limit** (integer) - The maximum number of results to return.
- **offset** (integer) - The number of items to skip before returning results.
```

--------------------------------

### List Guided identity verification sessions

Source: https://docs.equalsmoney.com/api-reference/onboarding/list-guided-identity-verification-sessions

Examples for retrieving identity verification sessions across various programming languages.

```bash
curl --request GET \
  --url 'https://api.equalsmoney.com/v2/applications/identity-verification-sessions?limit=100' \
  --header 'Authorization: <api-key>'
```

```python
import requests  
  
url = "https://api.equalsmoney.com/v2/applications/identity-verification-sessions?limit=100"  
  
headers = {"Authorization": "<api-key>"}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};  
  
fetch('https://api.equalsmoney.com/v2/applications/identity-verification-sessions?limit=100', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.equalsmoney.com/v2/applications/identity-verification-sessions?limit=100",  
  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;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.equalsmoney.com/v2/applications/identity-verification-sessions?limit=100"  
  
	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))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.equalsmoney.com/v2/applications/identity-verification-sessions?limit=100")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.equalsmoney.com/v2/applications/identity-verification-sessions?limit=100")  
  
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
```

--------------------------------

### List Onboarding Applications Response Example

Source: https://docs.equalsmoney.com/api-reference/onboarding/list-onboarding-applications

Example JSON response structure for a request to list onboarding applications, including pagination metadata and a list of application records.

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

--------------------------------

### Retrieve PIN API Requests

Source: https://docs.equalsmoney.com/api-reference/pin/retrieve-a-pin

Examples of how to perform a GET request to retrieve a card PIN across various programming languages.

```curl
curl --request GET \
  --url 'https://api.equalsmoney.com/v2/cards/{cardId}/pin?accountId={{accountId}}&personId={{personId}}&cardholderVerificationMethod={{cardholderVerificationMethod}}' \
  --header 'Authorization: <api-key>'
```

```python
import requests  
  
url = "https://api.equalsmoney.com/v2/cards/{cardId}/pin"  
  
headers = {"Authorization": "<api-key>"}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};  
  
fetch('https://api.equalsmoney.com/v2/cards/{cardId}/pin', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.equalsmoney.com/v2/cards/{cardId}/pin",  
  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;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.equalsmoney.com/v2/cards/{cardId}/pin"  
  
	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))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.equalsmoney.com/v2/cards/{cardId}/pin")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.equalsmoney.com/v2/cards/{cardId}/pin")  
  
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
```

--------------------------------

### Create onboarding document

Source: https://docs.equalsmoney.com/api-reference/onboarding/create-a-new-onboarding-application-document

Examples of how to create a new onboarding application document using different programming languages and tools.

```cURL
curl --request POST \
  --url https://api.equalsmoney.com/v2/applications/{applicationId}/documents \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form purpose=PROOF_OF_FORMATION \
  --form file=null
```

```python
import requests  
  
url = "https://api.equalsmoney.com/v2/applications/{applicationId}/documents"  
  
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"purpose\"\r\n\r\nPROOF_OF_FORMATION\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\nnull\r\n-----011000010111000001101001--"  
headers = {  
    "Authorization": "<api-key>",  
    "Content-Type": "multipart/form-data"  
}  
  
response = requests.post(url, data=payload, headers=headers)  
  
print(response.text)
```

```javascript
const form = new FormData();  
form.append('purpose', 'PROOF_OF_FORMATION');  
form.append('file', 'null');  
  
const options = {method: 'POST', headers: {Authorization: '<api-key>'}};  
  
options.body = form;  
  
fetch('https://api.equalsmoney.com/v2/applications/{applicationId}/documents', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

--------------------------------

### Get Trading Days API Requests

Source: https://docs.equalsmoney.com/api-reference/payments/get-trading-days-for-a-currency-pair

Examples of how to query the trading days endpoint using various programming languages and tools.

```curl
curl --request GET \
  --url 'https://api.equalsmoney.com/v2/trading-days?accountId={{accountId}}&sourceCurrencyCode={{sourceCurrencyCode}}&destinationCurrencyCode={{destinationCurrencyCode}}' \
  --header 'Authorization: <api-key>'
```

```python
import requests  
  
url = "https://api.equalsmoney.com/v2/trading-days"  
  
headers = {"Authorization": "<api-key>"}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};  
  
fetch('https://api.equalsmoney.com/v2/trading-days', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.equalsmoney.com/v2/trading-days",  
  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;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.equalsmoney.com/v2/trading-days"  
  
	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))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.equalsmoney.com/v2/trading-days")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.equalsmoney.com/v2/trading-days")  
  
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
```

--------------------------------

### Validate a Payment Batch Request

Source: https://docs.equalsmoney.com/api-reference/payment-batches/validates-a-payment-batch

Examples of how to perform a GET request to validate a payment batch across various programming languages.

```curl
curl --request GET \
  --url 'https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/validate?accountId={{accountId}}' \
  --header 'Authorization: <api-key>'
```

```python
import requests  
  
url = "https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/validate"  
  
headers = {"Authorization": "<api-key>"}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};  
  
fetch('https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/validate', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/validate",  
  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;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/validate"  
  
	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))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/validate")  
  .header("Authorization", "<api-key>")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/validate")  
  
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
```

--------------------------------

### POST /onboarding

Source: https://docs.equalsmoney.com/api-reference/onboarding/create-an-account

Starts the process of onboarding an account. This endpoint can only be accessed by product-level permissions.

```APIDOC
## POST /onboarding

### Description
Starts the process of onboarding an account. This endpoint can only be accessed by product-level permissions.

### Method
POST

### Endpoint
/onboarding

### Parameters
#### Query Parameters
- **productId** (string) - Optional - The ID of the product to work with.

#### Request Body
- **accountType** (string) - Optional - The type of account that you want to onboard (business, personal).
- **affiliateId** (string) - Optional - The affiliate ID.
- **companyId** (string) - Optional - The company ID.
- **contact** (object) - Optional - The contact information.
  - **firstName** (string) - Optional - The contact's first name.
  - **lastName** (string) - Optional - The contact's last name.
  - **nationality** (string) - Optional - The contact's nationality (ISO country code).

### Request Example
{
  "accountType": "business",
  "affiliateId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
  "companyId": "420e4d3c-2d51-4cad-9caf-d7300258cefd",
  "contact": {
    "firstName": "John",
    "lastName": "Doe",
    "nationality": "GB"
  }
}
```
Tokens:
Raw