References
This endpoint retrieves a collection of country options based on the provided address type. If the addressType parameter is not provided or is null, a default collection of country options will be returned. It provides country options based on specific address types, such as "Billing" or "Mailing".
Address type (Home, Work, etc.)
Correlation Id for the request
GET /api/demographics/v1/References/CountryOptions HTTP/1.1
Host: localhost:5000
Accept: */*
{
"content": [
{
"countryCode": 124,
"countryName": "Canada",
"isDisplayed": true,
"iso2": "ca",
"iso3": "can",
"stateOrProvinceIsRequired": true
}
]
}This endpoint retrieves a list of state options specific to the United States available in the database. The response includes a collection of states based on predefined configurations and criteria.
Correlation Id for the request
GET /api/demographics/v1/References/StateOptions HTTP/1.1
Host: localhost:5000
Accept: */*
{
"content": [
{
"stateCode": "AL",
"stateName": "Alabama",
"isDisplayed": true,
"countryCode": "US"
}
]
}This endpoint retrieves a list of MCC (Merchant Category Codes) available in the database. The response includes details such as the MCC code, group code, description, usage rank, and whether the MCC is supported. The data is sourced directly from the database and is useful for categorizing merchants based on their business types.
Correlation Id for the request
GET /api/demographics/v1/References/MccCodes HTTP/1.1
Host: localhost:5000
Accept: */*
{
"content": [
{
"mccCode": "0742",
"mccGroupCode": "Contract",
"mccDescription": "Veterinary Services",
"mccMostUsedRank": 1,
"mccIsSupported": true
}
]
}This endpoint retrieves a list of company types available in the database, which are filtered by a specific country code "US" (Default). Result includes CountryCode, Description, Type, etc. The response provides a structured collection of company types, which can be used for onboarding workflows, UI dropdowns, or other scenarios requiring a predefined set of company classifications.
Correlation Id for the request
GET /api/demographics/v1/References/CompanyTypes HTTP/1.1
Host: localhost:5000
Accept: */*
{
"content": [
{
"id": 4,
"type": "NP",
"legalIdentifiersRequired": true,
"description": "Non profit/tax exempt",
"countryCode": "US"
}
]
}This endpoint retrieves a list of active compensation types available in the database. The response includes details such as the compensation type ID and description. The data is fetched from the database for active compensation types only.
Correlation Id for the request
GET /api/demographics/v1/References/CompensationTypes HTTP/1.1
Host: localhost:5000
Accept: */*
{
"content": [
{
"id": 1,
"description": "All Residual"
}
]
}This endpoint retrieves a list of previous processors (competitors) available in the database. The data includes details such as the processor's ID and description (name). The list is returned for use in systems where competitors or previous processors are needed for further processing.
Correlation Id for the request
GET /api/demographics/v1/References/PreviousProcessors HTTP/1.1
Host: localhost:5000
Accept: */*
{
"content": [
{
"id": 1,
"description": "Bangor Savings Bank"
}
]
}This endpoint retrieves a list of businesses under the user's hierarchy, which can serve as the parent businesses for a new application. The response contains details about each business such as the DBA (Doing Business As) name and the hierarchy node key. The data can include both merchants and non-merchants (sales agents) This API is authorized and requires the user to have the necessary access roles to fetch the businesses. The request allows filtering by activeOnly to return only active businesses in the hierarchy.
falseCorrelation Id for the request
GET /api/demographics/v1/References/Parents HTTP/1.1
Host: localhost:5000
Accept: */*
{
"content": [
{
"hierarchyNodeKey": "6588000001264365",
"businessDBA": "Schedulicity Inc - ISV"
}
]
}This endpoint allows the user to search for businesses within their hierarchy based on a given search term if provided else fetch all businesses available. It retrieves a list of businesses either as merchants or non-merchants (sales agents) depending on the includeSalesAgents parameter. The search is limited to a predefined set of results per page (up to 35,000). The businesses are filtered based on the user's hierarchy node key. The response contains details for each business, including the DBA name and the hierarchy node key.
Represents a value used to search for Businesses.
Correlation Id for the request
GET /api/demographics/v1/References/SearchParents HTTP/1.1
Host: localhost:5000
Accept: */*
{
"content": [
{
"hierarchyNodeKey": "6588000001264365",
"businessDBA": "Schedulicity Inc - ISV"
}
]
}This endpoint allows the user to fetch a list of phone type codes, which includes details such as the phone type code, description, and display order. The response contains a collection of phone type codes, making it easy for the user to view available phone types.
Correlation Id for the request
GET /api/demographics/v1/References/PhoneTypes HTTP/1.1
Host: localhost:5000
Accept: */*
{
"content": [
{
"phoneTypeCodeID": 1,
"phoneTypeCode": "C",
"phoneTypeDescription": "Cell",
"displayOrder": 2
}
]
}This endpoint allows the user to retrieve a list of contact types from the system. The data includes various types of contacts that can be used for categorizing or filtering purposes. The contact types are fetched from the database and returned as a collection in the response.
Correlation Id for the request
GET /api/demographics/v1/References/ContactTypes HTTP/1.1
Host: localhost:5000
Accept: */*
{
"content": [
{
"contactTypeID": 2,
"contactTypeCode": "GeneralContact",
"contactTypeDescription": "General Contact"
}
]
}This endpoint retrieves a list of Merchant Acquisition Types available in the database. The result includes fields such as MerchantAcquisitionTypeID and MerchantAcquisitionType. These types are used to categorize how a merchant was acquired, providing insight into various acquisition methods or strategies used in the system.
Correlation Id for the request
GET /api/demographics/v1/References/MerchantAcquisitionTypes HTTP/1.1
Host: localhost:5000
Accept: */*
{
"content": [
{
"merchantAcquisitionTypeID": 1,
"merchantAcquisitionType": "Rep called merchant"
}
]
}This endpoint retrieves a list of document categories available in the database. The data includes fields such as DocumentCategoryID, DocumentCategoryName and DocumentCategoryDesc, which provide detailed information about each document category stored in the system. The result is ordered by the DocumentCategoryID in ascending order.
Correlation Id for the request
GET /api/demographics/v1/References/DocumentCategories HTTP/1.1
Host: localhost:5000
Accept: */*
{
"content": [
{
"documentCategoryID": 7,
"documentCategoryName": "Signed Application",
"documentCategoryDesc": "Signed Application"
}
]
}This endpoint retrieves a list of Signature Sections available in the database. It allows users to dynamically render or validate signature sections based on the retrieved metadata. Result includes fields such as SignatureSectionTypeId, SignatureSectionTypeName and SignatureSectionTypeDescription.
Correlation Id for the request
GET /api/demographics/v1/References/SignatureSections HTTP/1.1
Host: localhost:5000
Accept: */*
{
"content": [
{
"signatureSectionTypeId": 1,
"signatureSectionTypeName": "AgreementToSign",
"signatureSectionTypeDescription": "Indicates agreement to enter signatures electronically."
}
]
}This endpoint retrieves a list of Signature Source Types available in the database. It enables dynamic handling of signature workflows by providing detailed metadata about available source types. Result includes fields such as SignatureSourceTypeId, SignatureSourceTypeName and SignatureSourceTypeDescription.
Correlation Id for the request
GET /api/demographics/v1/References/SignatureSourceTypes HTTP/1.1
Host: localhost:5000
Accept: */*
{
"content": [
{
"signatureSourceTypeId": 1,
"signatureSourceTypeName": "OnlineForm",
"signatureSourceTypeDescription": "Agreement was provided online through an E-Signature system or by indicating on an approved html form."
}
]
}This endpoint retrieves a comprehensive list of site types stored in the database. Each site type includes a unique identifier and a description that provides context or explains the purpose of the site type. The site types can be used for categorizing or filtering data in various applications, such as onboarding workflows, or business logic implementations.
Correlation Id for the request
GET /api/demographics/v1/References/SiteTypes HTTP/1.1
Host: localhost:5000
Accept: */*
{
"content": [
{
"siteTypeID": 1,
"siteTypeDescription": "Tradeshow"
}
]
}Correlation Id for the request
GET /api/demographics/v1/References/FutureDeliveryTypes HTTP/1.1
Host: localhost:5000
Accept: */*
{
"content": [
{
"siteTypeID": 1,
"siteTypeDescription": "Tradeshow"
}
]
}Was this helpful?