Search applications and customers

curl --request GET \
  --url https://api.next.orenda.finance/applications/search \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.next.orenda.finance/applications/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.next.orenda.finance/applications/search"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "success": true,
  "result": {
    "total": 2,
    "data": [
      {
        "applicationId": "a1b2c3d4-0000-4a1b-9c2d-111122223333",
        "customerId": "c9f8e7d6-1111-4b2c-8d3e-444455556666",
        "email": "ada@example.com",
        "isCompany": false,
        "workflowStage": "CUSTOMER",
        "currentStep": "RISK_COMPLIANCE_REVIEW_RFI",
        "clientReference": "REF-00891",
        "createdDateTime": "2026-05-12T09:31:04.000Z"
      },
      {
        "applicationId": "b2c3d4e5-0000-4a1b-9c2d-777788889999",
        "customerId": "d0e1f2a3-2222-4c3d-9e4f-aaaabbbbcccc",
        "email": "compliance@acme-ltd.example",
        "isCompany": true,
        "workflowStage": "CUSTOMER",
        "currentStep": "COMPLETED",
        "clientReference": "REF-00892",
        "createdDateTime": "2026-05-13T14:02:55.000Z"
      }
    ]
  }
}

Search applications and customers

Search onboarding applications and customers. Required claim: transactions.view.

Applications versus customers are distinguished by workflowStage: customers are workflowStage=CUSTOMER with workflowStageExclude=false, while in-flight applications are workflowStage=CUSTOMER with workflowStageExclude=true.

Admin CSV exports (resultType=file) include onboarding columns (Current Step, Required Actions) and, when a compliance decision exists, Risk Compliance Action / Risk Compliance Reason. Current Step may be RISK_COMPLIANCE_REVIEW_RFI when compliance has requested information from the program.

All filters accept comma-separated values for multi-select.

GET

applications

Search applications and customers

curl --request GET \
  --url https://api.next.orenda.finance/applications/search \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.next.orenda.finance/applications/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.next.orenda.finance/applications/search"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "success": true,
  "result": {
    "total": 2,
    "data": [
      {
        "applicationId": "a1b2c3d4-0000-4a1b-9c2d-111122223333",
        "customerId": "c9f8e7d6-1111-4b2c-8d3e-444455556666",
        "email": "ada@example.com",
        "isCompany": false,
        "workflowStage": "CUSTOMER",
        "currentStep": "RISK_COMPLIANCE_REVIEW_RFI",
        "clientReference": "REF-00891",
        "createdDateTime": "2026-05-12T09:31:04.000Z"
      },
      {
        "applicationId": "b2c3d4e5-0000-4a1b-9c2d-777788889999",
        "customerId": "d0e1f2a3-2222-4c3d-9e4f-aaaabbbbcccc",
        "email": "compliance@acme-ltd.example",
        "isCompany": true,
        "workflowStage": "CUSTOMER",
        "currentStep": "COMPLETED",
        "clientReference": "REF-00892",
        "createdDateTime": "2026-05-13T14:02:55.000Z"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

programId

string

required

The program to scope results to. Required unless allPrograms=true is passed. Multi-program operators are bounded to their entitled programs.

customerId

string

Filter by customer ID. Comma-separated for multi-select.

keyword

string

Free-text search across indexed fields.

page

integer

default:1

1-based page number. Defaults to 1.

Required range: x >= 1

limit

integer

Maximum number of items per page.

Required range: x >= 1

allPrograms

enum<string>

When true, searches across all of the operator's entitled programs instead of a single programId.

Available options:

true,

false

resultType

enum<string>

default:json

Result format. json (default) returns inline results; file returns a presigned S3 CSV URL (valid 1 hour) in place of the data array.

Available options:

json,

file

filePrefix

string

Customises the filename of the exported CSV when resultType=file.

isCompany

enum<string>

Filter to company (true) or individual (false) applications.

Available options:

true,

false

workflowStage

string

Onboarding workflow stage to match, e.g. CUSTOMER. Comma-separated for multi-select.

workflowStageExclude

enum<string>

When true, the workflowStage filter is inverted (match everything except the given stage). Used to separate in-flight applications from completed customers.

Available options:

true,

false

customerType

string

Filter by customer type. Comma-separated for multi-select.

isRisk

enum<string>

When true, returns results in the risk-report format (risk/compliance-oriented columns).

Available options:

true,

false

clientReference

string

Filter by the program's client reference. Comma-separated for multi-select.

Response

Matching applications, or a presigned export URL when resultType=file.

Option 1
Option 2

Inline JSON results, or — when resultType=file — a presigned CSV export URL.

success

boolean

Example:

true

result

object

Show child attributes

Search accounts