For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Customer Application

Retrieves comprehensive customer application information including personal/business details, investment profiles, KYC data, and associated documents.

Returns either individual or corporate application data based on the customer type.

Endpoint

GET/v2/customer/{customerId}/application

Link

Request

Path Parameters

Parameter

Type

Description

Required

Example

customerId

string

Customer ID to retrieve application for.

Yes

"cust_12345"

Headers

Key

Value

Required

Authorization

123

Yes

Accept

application/json

Yes


Response (200 OK)

Returns either individual or corporate application data with comprehensive customer information.

Response Structure

The response contains either individual or corporate object based on customer type.


Individual Application Response

Individual Application Fields

1. Basic Information

Field

Type

Description

Example

firstName

string

Customer's first name.

"John"

middleName

string

Customer's middle name.

"Michael"

lastName

string

Customer's last name.

"Doe"

emailAddress

string

Contact email address.

"[email protected]"

telephoneNumber

string

Contact phone number.

"+1234567890"

taxReferenceNumber

string

Tax ID/SSN number.

"123-45-6789"

passportNumber

string

Passport number.

"A12345678"

nationality

string

Nationality/country.

"US"

dateOfBirth

string

Date of birth.

"1985-05-15T00:00:00Z"

2. Mailing Address

Field

Type

Description

Example

unitNumber

string

Unit/apartment number.

"5A"

addressLine1

string

Primary address.

"123 Main Street"

addressLine2

string

Secondary address.

"Suite 500"

city

string

City.

"New York"

stateIso

string

State code.

"NY"

postalCode

string

Postal code.

"10001"

countryIso

string

Country code.

"US"

3. Employment Information

Field

Type

Description

Allowed Values

Example

usResidencyStatus

string

US residency status.

RES_US_CITIZEN, RES_RESIDENT_ALIEN, RES_NON_RESIDENT_ALIEN

"RES_US_CITIZEN"

employmentStatus

string

Employment status.

EMP_EMPLOYEE, EMP_SELF_EMPLOYED, EMP_RETIRED, EMP_UNEMPLOYED, EMP_OTHER

"EMP_EMPLOYEE"

employmentDescription

string

Employment details.

-

"Software Engineer"

employerName

string

Employer name.

-

"Tech Solutions Inc."

occupation

string

Job title/occupation.

-

"Senior Developer"

4. Investment Profile

Field

Type

Description

Allowed Values

Example

primarySourceOfFunds

string

Main income source.

SFD_EMPLOYMENT, SFD_SAVINGS, SFD_INVESTMENT, etc.

"SFD_EMPLOYMENT"

totalAssets

string

Total asset value.

VLM_UPTO_10K to VLM_MORE_THAN_250M

"VLM_ONEHUNDREDK_TO_1M"

usdValueOfFiat

string

Fiat currency value.

VLM_UPTO_10K to VLM_MORE_THAN_250M

"VLM_TEN_TO_100K"

usdValueOfCrypto

string

Crypto asset value.

VLM_UPTO_10K to VLM_MORE_THAN_250M

"VLM_UPTO_10K"

monthlyDeposits

string

Monthly deposit count.

CLM_UPTO_5 to CLM_MORE_THAN_25

"CLM_UPTO_5"

monthlyInvestmentDeposit

string

Investment deposit amount.

ILM_UPTO_1K to ILM_MORE_THAN_5M

"ILM_ONE_TO_100K"

5. KYC Profile

Field

Type

Description

Example

fundsSendReceiveJurisdictions

array

Countries for fund transfers.

["US", "GB", "DE"]

engageInActivities

array

Business activities.

["ACT_NONE"]

vendorsAndCounterparties

array

Business relationships.

["VND_SELF", "VND_MERCHANTS_SUPPLIERS"]

6. Documents Array

Array of uploaded documents with metadata and verification status.

Example Individual Response:

json


Corporate Application Response

Corporate Application Fields

1. Company Information

Field

Type

Description

Example

registeredName

string

Legal company name.

"Tech Solutions Corporation"

tradingName

string

Trading/business name.

"Tech Solutions"

registeredNumber

string

Registration number.

"123456789"

emailAddress

string

Company email.

"[email protected]"

websiteAddress

string

Company website.

"https://techsolutions.com"

stateOfIncorporation

string

State of incorporation.

"Delaware"

countryOfIncorporation

string

Country of incorporation.

"US"

establishedOn

string

Incorporation date.

"2020-01-15T00:00:00Z"

2. Corporate Entity Type

Field

Type

Description

Allowed Values

Example

corporateEntityType

string

Business structure.

ETT_C_CORP_PRIVATE, ETT_LLC, ETT_S_CORP, etc.

"ETT_C_CORP_PRIVATE"

naics

string

Industry code.

-

"541511"

naicsDescription

string

Industry description.

-

"Custom Computer Programming Services"

3. Registered & Physical Address

Same structure as individual mailing address for both registered and physical locations.

4. Corporate Investment Profile

Field

Type

Description

Allowed Values

Example

totalAssets

string

Company total assets.

VLM_UPTO_10K to VLM_MORE_THAN_250M

"VLM_ONE_TO_10M"

totalInvestableAssets

string

Liquid/investable assets.

VLM_UPTO_10K to VLM_MORE_THAN_250M

"VLM_ONEHUNDREDK_TO_1M"

assetAllocationToCrypto

string

Crypto allocation.

VLM_UPTO_10K to VLM_MORE_THAN_250M

"VLM_UPTO_10K"

investmentExperienceCrypto

string

Crypto experience level.

INE_LITTLE, INE_MODERATE, INE_SIGNIFICANT

"INE_MODERATE"

tradesPerMonth

string

Monthly trade volume.

TRL_UPTO_20 to TRL_MORE_THAN_400

"TRL_UPTO_20"

5. Corporate KYC Profile

Field

Type

Description

Allowed Values

Example

primaryBusiness

string

Main business activity.

BSN_SOFTWARE, BSN_FINANCIAL, BSN_TRADING, etc.

"BSN_SOFTWARE"

regulatedStatus

string

Regulatory status.

RGS_REGULATED, RGS_LICENSED, RGS_NONE

"RGS_NONE"

businessJurisdictions

array

Operating countries.

-

["US", "CA", "GB"]

6. Individuals Array

Array of company representatives, officers, and beneficial owners.

Example Corporate Response:

json


Field Value Details

Employment Status Values

  • EMP_EMPLOYEE: Employed by another organization

  • EMP_SELF_EMPLOYED: Self-employed/contractor

  • EMP_RETIRED: Retired from employment

  • EMP_UNEMPLOYED: Currently unemployed

  • EMP_OTHER: Other employment situation

Asset Value Ranges

  • VLM_UPTO_10K: Up to $10,000

  • VLM_TEN_TO_100K: $10,000 - $100,000

  • VLM_ONEHUNDREDK_TO_1M: $100,000 - $1,000,000

  • VLM_ONE_TO_10M: $1,000,000 - $10,000,000

  • VLM_TEN_TO_50M: $10,000,000 - $50,000,000

  • VLM_FIFTY_TO_250M: $50,000,000 - $250,000,000

  • VLM_MORE_THAN_250M: Over $250,000,000

Transaction Frequency

  • FRQ_DAILY: Daily transactions

  • FRQ_WEEKLY: Weekly transactions

  • FRQ_MONTHLY: Monthly transactions

  • FRQ_QUARTERLY: Quarterly transactions

Business Types

  • BSN_SOFTWARE: Software/technology company

  • BSN_FINANCIAL: Financial services

  • BSN_TRADING: Trading/investment firm

  • BSN_CONSULTING: Professional services


Examples

Request

bash

High Net Worth Individual Example

Response:

json


Error Responses

  1. Customer Not Found:

    json

  2. Application Not Found:

    json

  3. Unauthorized:

    json


Notes

  • Customer Type: Response contains either individual or corporate object, not both

  • Document Status: All associated documents include current verification status

  • Compliance: Application data is used for KYC/AML regulatory compliance

  • Sensitive Data: Personal identification numbers are masked/encrypted

  • Verification: Application status reflects current compliance verification state

Common Use Cases:

  • Customer onboarding status verification

  • Compliance and regulatory reporting

  • Risk assessment and profiling

  • Document verification tracking

  • Customer relationship management

Last updated