References
Retrieve a collection of country options based on the provided addressType.
Specifies the address type (for example, Home, Work, Billing, or Mailing) to return the corresponding country options. If not provided or set to null, the default collection of country options is returned.
Returns a list of country options successfully.
Bad request: If Address type is not proper enum values
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/References/CountryOptions HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"countryCode": 124,
"countryName": "Canada",
"isDisplayed": true,
"iso2": "ca",
"iso3": "can",
"stateOrProvinceIsRequired": true
}
]
}Retrieve a list of state options specific to the United States from the database.
Returns a list of state types successfully.
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/References/StateOptions HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"stateCode": "AL",
"stateName": "Alabama",
"isDisplayed": true,
"countryCode": "US"
}
]
}Retrieve a list of Merchant Category Codes (MCC) available in the database.
Note: The response data is sourced directly from the database and is used to categorize merchants by business type.
Returns a list of MCC codes successfully.
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/References/MccCodes HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"mccCode": "0742",
"mccGroupCode": "Contract",
"mccDescription": "Veterinary Services",
"mccMostUsedRank": "1",
"mccIsSupported": true,
"isRestricted": true
}
]
}Retrieve a list of company types available in the database, filtered by the country code (default: US).
Note: The structured response collection of company types can be used in onboarding workflows, UI dropdowns, or other scenarios requiring predefined company classifications.
Returns a list of company types successfully.
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/References/CompanyTypes HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"id": 4,
"type": "NP",
"legalIdentifiersRequired": true,
"description": "Non profit/tax exempt",
"countryCode": "US"
}
]
}Retrieve a list of active compensation types available in the database.
Note: Only active compensation types are returned in the response.
Returns a list of compensation types successfully.
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/References/CompensationTypes HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"id": 1,
"description": "All Residual"
}
]
}Retrieve a list of previous processors (competitors) available in the database.
Note: The response data can be used in workflows or systems that require competitor or previous processor information for further processing.
Returns a list of potential previous processors successfully.
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/References/PreviousProcessors HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"id": 1,
"description": "Bangor Savings Bank"
}
]
}Retrieve a list of businesses under the user's hierarchy that can serve as parent businesses for a new application.
Note: It requires authorization and appropriate access roles. You can use the optional activeOnly filter to return only active businesses in the hierarchy. The response data include both merchants and non-merchants (such as sales agents).
Specifies whether to return only active businesses. Default: false
falseReturns a list of Business under the user that can be parents of the new application.
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/References/Parents HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"hierarchyNodeKey": "6588000001264365",
"businessDBA": "Schedulicity Inc - ISV"
}
]
}Search for the businesses within the user's hierarchy.
Note: If a search term is provided, it retrieves matching businesses; otherwise, it fetches all available businesses. The results can include both merchants and non-merchants (such as sales agents), depending on the includeSalesAgents parameter. The search is limited to a maximum of 35,000 results per page and businesses are filtered based on the user's hierarchy node key.
Specifies the value used to search for businesses
Returns a list of Businesses successfully based on the search term.
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/References/SearchParents?searchTerm=text HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"hierarchyNodeKey": "6588000001264365",
"businessDBA": "Schedulicity Inc - ISV"
}
]
}Retrieve a list of phone type codes available in the database.
Note: Response data makes easy for the user to view available phone types.
Returns a list of Phone Type Codes successfully.
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/References/PhoneTypes HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"phoneTypeCodeID": 1,
"phoneTypeCode": "C",
"phoneTypeDescription": "Cell",
"displayOrder": 2
}
]
}Retrieve a list of contact types available in the system.
Returns a list of Contact Types successfully
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/References/ContactTypes HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"contactTypeID": 2,
"contactTypeCode": "GeneralContact",
"contactTypeDescription": "General Contact"
}
]
}Retrieve a list of merchant acquisition types available in the database. Note: Response values are used to categorize how a merchant was acquired, providing insight into acquisition methods and strategies within the system.
Retrieves the available Merchant Acquisition Types.
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/References/MerchantAcquisitionTypes HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"merchantAcquisitionTypeID": 1,
"merchantAcquisitionType": "Rep called merchant"
}
]
}Retrieve a list of document categories available in the database.
Retrieves available document categories.
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/References/DocumentCategories HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"documentCategoryID": 7,
"documentCategoryName": "Signed Application",
"documentCategoryDesc": "Signed Application"
}
]
}Retrieve a list of signature sections available in the database. Note: The response fields can be used to dynamically render or validate signature sections in the system.
Retrieves available signature sections
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/References/SignatureSections HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"signatureSectionTypeId": 1,
"signatureSectionTypeName": "AgreementToSign",
"signatureSectionTypeDescription": "Indicates agreement to enter signatures electronically."
}
]
}Retrieve a list of signature source types available in the database. Note: The response data enables dynamic handling and validation of signature workflows.
Retrieves available Signature Source Types.
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/References/SignatureSourceTypes HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"signatureSourceTypeId": 1,
"signatureSourceTypeName": "OnlineForm",
"signatureSourceTypeDescription": "Agreement was provided online through an E-Signature system or by indicating on an approved html form."
}
]
}Retrieve a list of site types available in the database. Note: Each site type includes a unique identifier and a description, which can be used for categorizing or filtering data in applications such as onboarding workflows or business logic implementations.
Retrieves available site types.
Unauthorized: User does not have the required role or access.
Internal Server Error: This could be due to system errors. Please contact support for assistance
GET /api/demographics/v1/References/SiteTypes HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"siteTypeID": 1,
"siteTypeDescription": "Tradeshow"
}
]
}Retrieve a list of future delivery types available in the database.
Retrieves available future delivery types.
Error occurred while retrieving future delivery types.
GET /api/demographics/v1/References/FutureDeliveryTypes HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"siteTypeID": 1,
"siteTypeDescription": "Tradeshow"
}
]
}Was this helpful?