Lookup

The Lookup API provides access to reference data used across various form fields. It enables developers to retrieve standardized lists of options for some dropdown menus, radio buttons, and other selection controls.

API Endpoint

GET {base_url}/ExtForm/lookups?formId={formId}&lookupSource={lookupSource}

Request Format

This endpoint accepts a GET request with query parameters.

Query Parameters

Parameter	Type	Required	Description
formId	string	Yes	Identifier for the form
lookupSource	string	Yes	The type of lookup data to retrieve (must be one of the allowed values)

Request Headers

Authorization: Bearer {token}

Response Format

{
  "statusCode": 200,
  "messages": ["Processed successfully"],
  "result": [
    {
      "id": "high-net-worth",
      "displayName": "High Net Worth Individual"
    },
    {
      "id": "retail",
      "displayName": "Retail Customer"
    },
    {
      "id": "corporate",
      "displayName": "Corporate Client"
    }
  ]
}

Response Fields

Field	Description
result	Array of lookup items
result[].id	Unique identifier for the lookup item
result[].displayName	Display name for the lookup item

Supported Lookup Sources

The following lookup sources are supported:

Lookup Source	Description	Used By
SourceOfWealthBusinessEnum	Source of wealth business types	Source of Wealth Answer
CustomerSegmentEnum	Customer segment categories	Customer Segment Answer
TransactionValuePerAnnumEnum	Annual transaction value ranges	Expected Transaction Amount Per Annum Answer
PepStatusEnum	Political exposure status options	PEP Status Answer
ResidentStatusEnum	Residency status options	Residency Status Answer
EmploymentStatusEnum	Employment status options	Employment Status Answer
ProfessionEnum	Profession categories	Profession Answer
NatureOfBusinessEnum	Business activity categories	Company Nature of Business Answer
IpAddressScanningMatchEnum	IP address scanning match results	IP Address Scanning Answer
ExpectedNumberofWalletsEnum	Expected number of wallets ranges	Expected Number of Wallets Answer
SignatoryMandateEnum	Signatory mandate options	Signatory Mandate Answer
InvestigationsCarriedLastYearEnum	Investigation status options	Investigations Carried Out Answer
StrFiledLastYearEnum	STR filing status options	STR Filed Last Year Answer
VirtualAssetKnowledgeEnum	Virtual asset knowledge levels	Knowledge of Customer on VA Answer
HighVolumeTansactionLastMonthEnum	High volume transaction status	High Volume Transaction Last Month Answer
TransactionWIthoutTravelInfoEnum	Transaction without travel info status	Transaction Without Travel Info Answer
ChangesInIdentificationInfoEnum	Identification changes status	Changes In Identification Info Answer
ProductEnum	Product types	Product Answer
ServiceEnum	Service types	Service Answer
RelationshipInitiationEnum	Relationship initiation methods	Relationship Initiation Method Answer
DeliveryMethodEnum	Service delivery methods	Service Delivery Method Answer
CustomerAgreeingToPayUnusuallyHigherValueForServicesEnum	Unusual payment agreement status	Customer Agreeing To Pay Unusually Higher Value For Services Answer
ModeOfPaymentEnum	Payment mode options	Mode of Payment Answer
CustomerOnboardingMethodEnum	Customer onboarding methods	Customer Onboarding Method Answer
InvolvementOfIntermediaryEnum	Intermediary involvement status	Involvement of Intermediary Answer
AdverseMediaAgainstUboEnum	Adverse media status for UBO	Adverse Media Against UBO Answer
WhetherAllUboIdentifiedEnum	UBO identification status	Whether All UBO Identified Answer
CustomerAssociatedWithDualOrUseGoodsEnum	Dual-use goods association status	Customer Associated With Dual Or Use Goods Answer
SystemToTrackCustomerProfileEnum	Customer profile tracking system status	System To Track Customer Profile Answer
AnyOtherRedFlagObservedEnum	Red flag observation status	Any Other Red Flag Observed Answer
EntityTypeEnum	Entity types	Entity Type Answer
OwnerShipStructureEnum	Ownership structure types	Ownership Structure Answer
SourceOfWealthOrFundOfBusiness	Business wealth or fund sources	Source of Wealth Business Answer
LengthOfIncorporationEnum	Incorporation length ranges	Length of Incorporation Answer
ScreeningMatchEnum	Screening match status	Sanctions Screening related fields

Example Usage

cURL Example

curl -X GET \
  '{base_url}/ExtForm/lookups?formId=72f65e49-24a9-4c12-be61-09fe51f51077&lookupSource=CustomerSegmentEnum' \
  -H 'Authorization: Bearer your_token_here'

Error Handling

Status Code	Description	Solution
400	Invalid request format	Check the structure of your request
400	Invalid lookup source	Ensure the lookupSource is one of the allowed values
400	Missing required field	Provide all required fields in the request
401	Unauthorized	Verify your authentication token
500	Internal server error	Contact support with the error details

Important Notes

1. The lookup data may be form-specific, so the same lookup source may return different results for different forms.
2. The lookup sources are case-sensitive and must match exactly as listed.
3. The lookup data is used to populate dropdown menus, radio buttons, and other selection controls in forms.