References

Get a List of Country Options

get

Retrieve a collection of country options based on the provided addressType.

Query parameters

addressTypestringOptional

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.

Responses

200

Returns a list of country options successfully.

application/json

400

Bad request: If Address type is not proper enum values

application/json

401

Unauthorized: User does not have the required role or access.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

get

/api/demographics/v1/References/CountryOptions

HTTPcURLJavaScriptPython

GET /api/demographics/v1/References/CountryOptions HTTP/1.1
Accept: */*

{
  "content": [
    {
      "countryCode": 124,
      "countryName": "Canada",
      "isDisplayed": true,
      "iso2": "ca",
      "iso3": "can",
      "stateOrProvinceIsRequired": true
    }
  ]
}

Get a List of State Options

get

Retrieve a list of state options specific to the United States from the database.

Responses

200

Returns a list of state types successfully.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

get

/api/demographics/v1/References/StateOptions

HTTPcURLJavaScriptPython

GET /api/demographics/v1/References/StateOptions HTTP/1.1
Accept: */*

{
  "content": [
    {
      "stateCode": "AL",
      "stateName": "Alabama",
      "isDisplayed": true,
      "countryCode": "US"
    }
  ]
}

Get a List of MCC Codes

get

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.

Responses

200

Returns a list of MCC codes successfully.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

get

/api/demographics/v1/References/MccCodes

HTTPcURLJavaScriptPython

GET /api/demographics/v1/References/MccCodes HTTP/1.1
Accept: */*

{
  "content": [
    {
      "mccCode": "0742",
      "mccGroupCode": "Contract",
      "mccDescription": "Veterinary Services",
      "mccMostUsedRank": "1",
      "mccIsSupported": true,
      "isRestricted": true
    }
  ]
}

Get a List of Company Types

get

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.

Responses

200

Returns a list of company types successfully.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

get

/api/demographics/v1/References/CompanyTypes

HTTPcURLJavaScriptPython

GET /api/demographics/v1/References/CompanyTypes HTTP/1.1
Accept: */*

{
  "content": [
    {
      "id": 4,
      "type": "NP",
      "legalIdentifiersRequired": true,
      "description": "Non profit/tax exempt",
      "countryCode": "US"
    }
  ]
}

Get a List of Compensation Types

get

Retrieve a list of active compensation types available in the database.

Note: Only active compensation types are returned in the response.

Responses

200

Returns a list of compensation types successfully.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

get

/api/demographics/v1/References/CompensationTypes

HTTPcURLJavaScriptPython

GET /api/demographics/v1/References/CompensationTypes HTTP/1.1
Accept: */*

{
  "content": [
    {
      "id": 1,
      "description": "All Residual"
    }
  ]
}

Get a List of Previous Processors

get

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.

Responses

200

Returns a list of potential previous processors successfully.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

get

/api/demographics/v1/References/PreviousProcessors

HTTPcURLJavaScriptPython

GET /api/demographics/v1/References/PreviousProcessors HTTP/1.1
Accept: */*

{
  "content": [
    {
      "id": 1,
      "description": "Bangor Savings Bank"
    }
  ]
}

Get a List of Businesses Under User

get

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).

Query parameters

activeOnlybooleanOptional

Specifies whether to return only active businesses.

Default: false

Responses

200

Returns a list of Business under the user that can be parents of the new application.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

get

/api/demographics/v1/References/Parents

HTTPcURLJavaScriptPython

GET /api/demographics/v1/References/Parents HTTP/1.1
Accept: */*

{
  "content": [
    {
      "hierarchyNodeKey": "6588000001264365",
      "businessDBA": "Schedulicity Inc - ISV"
    }
  ]
}

Search Businesses Under User

get

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.

Query parameters

searchTermstringRequired

Specifies the value used to search for businesses

Responses

200

Returns a list of Businesses successfully based on the search term.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

get

/api/demographics/v1/References/SearchParents

HTTPcURLJavaScriptPython

GET /api/demographics/v1/References/SearchParents?searchTerm=text HTTP/1.1
Accept: */*

{
  "content": [
    {
      "hierarchyNodeKey": "6588000001264365",
      "businessDBA": "Schedulicity Inc - ISV"
    }
  ]
}

Get a List of Phone Type Codes

get

Retrieve a list of phone type codes available in the database.

Note: Response data makes easy for the user to view available phone types.

Responses

200

Returns a list of Phone Type Codes successfully.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

get

/api/demographics/v1/References/PhoneTypes

HTTPcURLJavaScriptPython

GET /api/demographics/v1/References/PhoneTypes HTTP/1.1
Accept: */*

{
  "content": [
    {
      "phoneTypeCodeID": 1,
      "phoneTypeCode": "C",
      "phoneTypeDescription": "Cell",
      "displayOrder": 2
    }
  ]
}

Get a List of Contact Types

get

Retrieve a list of contact types available in the system.

Responses

200

Returns a list of Contact Types successfully

application/json

401

Unauthorized: User does not have the required role or access.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

get

/api/demographics/v1/References/ContactTypes

HTTPcURLJavaScriptPython

GET /api/demographics/v1/References/ContactTypes HTTP/1.1
Accept: */*

{
  "content": [
    {
      "contactTypeID": 2,
      "contactTypeCode": "GeneralContact",
      "contactTypeDescription": "General Contact"
    }
  ]
}

Get a List of Merchant Acquisition Types

get

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.

Responses

200

Retrieves the available Merchant Acquisition Types.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

get

/api/demographics/v1/References/MerchantAcquisitionTypes

HTTPcURLJavaScriptPython

GET /api/demographics/v1/References/MerchantAcquisitionTypes HTTP/1.1
Accept: */*

{
  "content": [
    {
      "merchantAcquisitionTypeID": 1,
      "merchantAcquisitionType": "Rep called merchant"
    }
  ]
}

Get list of Document Categories

get

Retrieve a list of document categories available in the database.

Responses

200

Retrieves available document categories.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

get

/api/demographics/v1/References/DocumentCategories

HTTPcURLJavaScriptPython

GET /api/demographics/v1/References/DocumentCategories HTTP/1.1
Accept: */*

{
  "content": [
    {
      "documentCategoryID": 7,
      "documentCategoryName": "Signed Application",
      "documentCategoryDesc": "Signed Application"
    }
  ]
}

Get a List of Signature Sections

get

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.

Responses

200

Retrieves available signature sections

application/json

401

Unauthorized: User does not have the required role or access.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

get

/api/demographics/v1/References/SignatureSections

HTTPcURLJavaScriptPython

GET /api/demographics/v1/References/SignatureSections HTTP/1.1
Accept: */*

{
  "content": [
    {
      "signatureSectionTypeId": 1,
      "signatureSectionTypeName": "AgreementToSign",
      "signatureSectionTypeDescription": "Indicates agreement to enter signatures electronically."
    }
  ]
}

Get a list of Signature Source Types

get

Retrieve a list of signature source types available in the database.

Note: The response data enables dynamic handling and validation of signature workflows.

Responses

200

Retrieves available Signature Source Types.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

get

/api/demographics/v1/References/SignatureSourceTypes

HTTPcURLJavaScriptPython

GET /api/demographics/v1/References/SignatureSourceTypes HTTP/1.1
Accept: */*

{
  "content": [
    {
      "signatureSourceTypeId": 1,
      "signatureSourceTypeName": "OnlineForm",
      "signatureSourceTypeDescription": "Agreement was provided online through an E-Signature system or by indicating on an approved html form."
    }
  ]
}

Get a list of Site Types

get

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.

Responses

200

Retrieves available site types.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

get

/api/demographics/v1/References/SiteTypes

HTTPcURLJavaScriptPython

GET /api/demographics/v1/References/SiteTypes HTTP/1.1
Accept: */*

{
  "content": [
    {
      "siteTypeID": 1,
      "siteTypeDescription": "Tradeshow"
    }
  ]
}

Get a List of Future Delivery Types

get

Retrieve a list of future delivery types available in the database.

Responses

200

Retrieves available future delivery types.

application/json

500

Error occurred while retrieving future delivery types.

get

/api/demographics/v1/References/FutureDeliveryTypes

HTTPcURLJavaScriptPython

GET /api/demographics/v1/References/FutureDeliveryTypes HTTP/1.1
Accept: */*

{
  "content": [
    {
      "siteTypeID": 1,
      "siteTypeDescription": "Tradeshow"
    }
  ]
}